dt-bindings: i3c: Document Cadence I3C master bindings
authorBoris Brezillon <boris.brezillon@bootlin.com>
Fri, 21 Jul 2017 10:22:23 +0000 (12:22 +0200)
committerBoris Brezillon <boris.brezillon@bootlin.com>
Wed, 5 Dec 2018 16:22:58 +0000 (17:22 +0100)
Document Cadence I3C master DT bindings.

Signed-off-by: Boris Brezillon <boris.brezillon@bootlin.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Reviewed-by: Arnd Bergmann <arnd@arndb.de>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/devicetree/bindings/i3c/cdns,i3c-master.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/i3c/cdns,i3c-master.txt b/Documentation/devicetree/bindings/i3c/cdns,i3c-master.txt
new file mode 100644 (file)
index 0000000..69da211
--- /dev/null
@@ -0,0 +1,43 @@
+Bindings for cadence I3C master block
+=====================================
+
+Required properties:
+--------------------
+- compatible: shall be "cdns,i3c-master"
+- clocks: shall reference the pclk and sysclk
+- clock-names: shall contain "pclk" and "sysclk"
+- interrupts: the interrupt line connected to this I3C master
+- reg: I3C master registers
+
+Mandatory properties defined by the generic binding (see
+Documentation/devicetree/bindings/i3c/i3c.txt for more details):
+
+- #address-cells: shall be set to 1
+- #size-cells: shall be set to 0
+
+Optional properties defined by the generic binding (see
+Documentation/devicetree/bindings/i3c/i3c.txt for more details):
+
+- i2c-scl-hz
+- i3c-scl-hz
+
+I3C device connected on the bus follow the generic description (see
+Documentation/devicetree/bindings/i3c/i3c.txt for more details).
+
+Example:
+
+       i3c-master@0d040000 {
+               compatible = "cdns,i3c-master";
+               clocks = <&coreclock>, <&i3csysclock>;
+               clock-names = "pclk", "sysclk";
+               interrupts = <3 0>;
+               reg = <0x0d040000 0x1000>;
+               #address-cells = <1>;
+               #size-cells = <0>;
+               i2c-scl-hz = <100000>;
+
+               nunchuk: nunchuk@52 {
+                       compatible = "nintendo,nunchuk";
+                       reg = <0x52 0x80000010 0>;
+               };
+       };