Add device-tree binding documentation for the nvdimm region driver.
Cc: devicet...@vger.kernel.org
Signed-off-by: Oliver O'Halloran <ooh...@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
