GNU Linux-libre 4.19.264-gnu1
[releases.git] / Documentation / devicetree / bindings / i2c / i2c-sh_mobile.txt
1 Device tree configuration for Renesas IIC (sh_mobile) driver
2
3 Required properties:
4 - compatible      :
5                         - "renesas,iic-r8a73a4" (R-Mobile APE6)
6                         - "renesas,iic-r8a7740" (R-Mobile A1)
7                         - "renesas,iic-r8a7743" (RZ/G1M)
8                         - "renesas,iic-r8a7745" (RZ/G1E)
9                         - "renesas,iic-r8a774a1" (RZ/G2M)
10                         - "renesas,iic-r8a7790" (R-Car H2)
11                         - "renesas,iic-r8a7791" (R-Car M2-W)
12                         - "renesas,iic-r8a7792" (R-Car V2H)
13                         - "renesas,iic-r8a7793" (R-Car M2-N)
14                         - "renesas,iic-r8a7794" (R-Car E2)
15                         - "renesas,iic-r8a7795" (R-Car H3)
16                         - "renesas,iic-r8a7796" (R-Car M3-W)
17                         - "renesas,iic-r8a77965" (R-Car M3-N)
18                         - "renesas,iic-sh73a0" (SH-Mobile AG5)
19                         - "renesas,rcar-gen2-iic" (generic R-Car Gen2 or RZ/G1
20                                                         compatible device)
21                         - "renesas,rcar-gen3-iic" (generic R-Car Gen3 or RZ/G2
22                                                         compatible device)
23                         - "renesas,rmobile-iic" (generic device)
24
25                         When compatible with a generic R-Car version, nodes
26                         must list the SoC-specific version corresponding to
27                         the platform first followed by the generic R-Car
28                         version.
29
30                         renesas,rmobile-iic must always follow.
31
32 - reg             : address start and address range size of device
33 - interrupts      : interrupt of device
34 - clocks          : clock for device
35 - #address-cells  : should be <1>
36 - #size-cells     : should be <0>
37
38 Optional properties:
39 - clock-frequency : frequency of bus clock in Hz. Default 100kHz if unset.
40 - dmas            : Must contain a list of two references to DMA
41                     specifiers, one for transmission, and one for
42                     reception.
43 - dma-names       : Must contain a list of two DMA names, "tx" and "rx".
44
45
46 Pinctrl properties might be needed, too. See there.
47
48 Example:
49
50         iic0: i2c@e6500000 {
51                 compatible = "renesas,iic-r8a7790", "renesas,rcar-gen2-iic",
52                              "renesas,rmobile-iic";
53                 reg = <0 0xe6500000 0 0x425>;
54                 interrupts = <0 174 IRQ_TYPE_LEVEL_HIGH>;
55                 clocks = <&mstp3_clks R8A7790_CLK_IIC0>;
56                 clock-frequency = <400000>;
57                 #address-cells = <1>;
58                 #size-cells = <0>;
59         };