dt-bindings: i2c: Add FSI-attached I2C master dt binding documentation
authorEddie James <eajames@linux.vnet.ibm.com>
Tue, 17 Jul 2018 15:30:59 +0000 (10:30 -0500)
committerWolfram Sang <wsa@the-dreams.de>
Fri, 20 Jul 2018 22:07:03 +0000 (00:07 +0200)
Document the bindings.

Signed-off-by: Eddie James <eajames@linux.vnet.ibm.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
Documentation/devicetree/bindings/i2c/i2c-fsi.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/i2c/i2c-fsi.txt b/Documentation/devicetree/bindings/i2c/i2c-fsi.txt
new file mode 100644 (file)
index 0000000..b1be2ce
--- /dev/null
@@ -0,0 +1,40 @@
+Device-tree bindings for FSI-attached I2C master and busses
+-----------------------------------------------------------
+
+Required properties:
+ - compatible = "ibm,i2c-fsi";
+ - reg = < address size >;             : The FSI CFAM address and address
+                                         space size.
+ - #address-cells = <1>;               : Number of address cells in child
+                                         nodes.
+ - #size-cells = <0>;                  : Number of size cells in child nodes.
+ - child nodes                         : Nodes to describe busses off the I2C
+                                         master.
+
+Child node required properties:
+ - reg = < port number >               : The port number on the I2C master.
+
+Child node optional properties:
+ - child nodes                         : Nodes to describe devices on the I2C
+                                         bus.
+
+Examples:
+
+    i2c@1800 {
+        compatible = "ibm,i2c-fsi";
+        reg = < 0x1800 0x400 >;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        i2c-bus@0 {
+            reg = <0>;
+        };
+
+        i2c-bus@1 {
+            reg = <1>;
+
+            eeprom@50 {
+                compatible = "vendor,dev-name";
+            };
+        };
+    };