Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / Documentation / devicetree / bindings / i2c / i2c-sh_mobile.txt
diff --git a/kernel/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt b/kernel/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
new file mode 100644 (file)
index 0000000..2bfc6e7
--- /dev/null
@@ -0,0 +1,40 @@
+Device tree configuration for Renesas IIC (sh_mobile) driver
+
+Required properties:
+- compatible      : "renesas,iic-<soctype>". "renesas,rmobile-iic" as fallback
+                    Examples with soctypes are:
+                       - "renesas,iic-r8a73a4" (R-Mobile APE6)
+                       - "renesas,iic-r8a7740" (R-Mobile A1)
+                       - "renesas,iic-r8a7790" (R-Car H2)
+                       - "renesas,iic-r8a7791" (R-Car M2-W)
+                       - "renesas,iic-r8a7792" (R-Car V2H)
+                       - "renesas,iic-r8a7793" (R-Car M2-N)
+                       - "renesas,iic-r8a7794" (R-Car E2)
+                       - "renesas,iic-sh73a0" (SH-Mobile AG5)
+- reg             : address start and address range size of device
+- interrupts      : interrupt of device
+- clocks          : clock for device
+- #address-cells  : should be <1>
+- #size-cells     : should be <0>
+
+Optional properties:
+- clock-frequency : frequency of bus clock in Hz. Default 100kHz if unset.
+- dmas            : Must contain a list of two references to DMA
+                   specifiers, one for transmission, and one for
+                   reception.
+- dma-names       : Must contain a list of two DMA names, "tx" and "rx".
+
+
+Pinctrl properties might be needed, too. See there.
+
+Example:
+
+       iic0: i2c@e6500000 {
+               compatible = "renesas,iic-r8a7790", "renesas,rmobile-iic";
+               reg = <0 0xe6500000 0 0x425>;
+               interrupts = <0 174 IRQ_TYPE_LEVEL_HIGH>;
+               clocks = <&mstp3_clks R8A7790_CLK_IIC0>;
+               clock-frequency = <400000>;
+               #address-cells = <1>;
+               #size-cells = <0>;
+       };