From: Oliver O'Halloran <oohall@gmail.com>
To: linux-nvdimm@lists.01.org
Cc: devicetree@vger.kernel.org, linuxppc-dev@lists.ozlabs.org
Subject: [PATCH 6/6] doc/devicetree: NVDIMM region documentation
Date: Fri, 23 Mar 2018 19:12:09 +1100 [thread overview]
Message-ID: <20180323081209.31387-6-oohall@gmail.com> (raw)
In-Reply-To: <20180323081209.31387-1-oohall@gmail.com>
Add device-tree binding documentation for the nvdimm region driver.
Cc: devicetree@vger.kernel.org
Signed-off-by: Oliver O'Halloran <oohall@gmail.com>
---
.../devicetree/bindings/nvdimm/nvdimm-region.txt | 45 ++++++++++++++++++++++
1 file changed, 45 insertions(+)
create mode 100644 Documentation/devicetree/bindings/nvdimm/nvdimm-region.txt
diff --git a/Documentation/devicetree/bindings/nvdimm/nvdimm-region.txt b/Documentation/devicetree/bindings/nvdimm/nvdimm-region.txt
new file mode 100644
index 000000000000..02091117ff16
--- /dev/null
+++ b/Documentation/devicetree/bindings/nvdimm/nvdimm-region.txt
@@ -0,0 +1,45 @@
+Device-tree bindings for NVDIMM memory regions
+-----------------------------------------------------
+
+Non-volatile DIMMs are memory modules used to provide (cacheable) main memory
+that retains its contents across power cycles. In more practical terms, they
+are kind of storage device where the contents can be accessed by the CPU
+directly, rather than indirectly via a storage controller or similar. The an
+nvdimm-region specifies a physical address range that is hosted on an NVDIMM
+device.
+
+Bindings for the region nodes:
+-----------------------------
+
+Required properties:
+ - compatible = "nvdimm-region"
+
+ - reg = <base, size>;
+ The system physical address range of this nvdimm region.
+
+Optional properties:
+ - Any relevant NUMA assocativity properties for the target platform.
+ - A "volatile" property indicating that this region is actually in
+ normal DRAM and does not require cache flushes after each write.
+
+A complete example:
+--------------------
+
+/ {
+ #size-cells = <2>;
+ #address-cells = <2>;
+
+ platform {
+ region@5000 {
+ compatible = "nvdimm-region;
+ reg = <0x00000001 0x00000000 0x00000000 0x40000000>
+
+ };
+
+ region@6000 {
+ compatible = "nvdimm-region";
+ reg = <0x00000001 0x00000000 0x00000000 0x40000000>
+ volatile;
+ };
+ };
+};
--
2.9.5
_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm
next prev parent reply other threads:[~2018-03-23 8:06 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-23 8:12 [PATCH 1/6] libnvdimm: Add of_node to region and bus descriptors Oliver O'Halloran
2018-03-23 8:12 ` [PATCH 2/6] libnvdimm: Add nd_region_destroy() Oliver O'Halloran
2018-03-23 16:59 ` Dan Williams
2018-03-25 23:24 ` Balbir Singh
2018-03-23 8:12 ` [PATCH 3/6] libnvdimm: Add device-tree based driver Oliver O'Halloran
2018-03-23 17:07 ` Dan Williams
2018-03-26 1:07 ` Oliver
2018-03-25 2:51 ` kbuild test robot
2018-03-25 4:27 ` kbuild test robot
2018-03-25 4:28 ` [RFC PATCH] libnvdimm: bus_desc can be static kbuild test robot
2018-03-26 4:05 ` [PATCH 3/6] libnvdimm: Add device-tree based driver Balbir Singh
2018-03-23 8:12 ` [PATCH 4/6] libnvdimm/of: Symlink platform and region devices Oliver O'Halloran
2018-03-23 17:08 ` Dan Williams
2018-03-23 8:12 ` [PATCH 5/6] powerpc/powernv: Create platform devs for nvdimm buses Oliver O'Halloran
2018-03-23 8:12 ` Oliver O'Halloran [this message]
2018-03-26 22:24 ` [PATCH 6/6] doc/devicetree: NVDIMM region documentation Rob Herring
2018-03-27 14:53 ` Oliver
2018-03-28 17:06 ` Rob Herring
2018-03-28 17:25 ` Dan Williams
2018-03-29 3:10 ` Oliver
2018-03-25 23:16 ` [PATCH 1/6] libnvdimm: Add of_node to region and bus descriptors Balbir Singh
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180323081209.31387-6-oohall@gmail.com \
--to=oohall@gmail.com \
--cc=devicetree@vger.kernel.org \
--cc=linux-nvdimm@lists.01.org \
--cc=linuxppc-dev@lists.ozlabs.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).