i2c: sh_mobile: document support for r8a77990 (R-Car E3)
[platform/kernel/linux-rpi.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-r8a7744" (RZ/G1N)
9                         - "renesas,iic-r8a7745" (RZ/G1E)
10                         - "renesas,iic-r8a774a1" (RZ/G2M)
11                         - "renesas,iic-r8a7790" (R-Car H2)
12                         - "renesas,iic-r8a7791" (R-Car M2-W)
13                         - "renesas,iic-r8a7792" (R-Car V2H)
14                         - "renesas,iic-r8a7793" (R-Car M2-N)
15                         - "renesas,iic-r8a7794" (R-Car E2)
16                         - "renesas,iic-r8a7795" (R-Car H3)
17                         - "renesas,iic-r8a7796" (R-Car M3-W)
18                         - "renesas,iic-r8a77965" (R-Car M3-N)
19                         - "renesas,iic-r8a77990" (R-Car E3)
20                         - "renesas,iic-sh73a0" (SH-Mobile AG5)
21                         - "renesas,rcar-gen2-iic" (generic R-Car Gen2 or RZ/G1
22                                                         compatible device)
23                         - "renesas,rcar-gen3-iic" (generic R-Car Gen3 or RZ/G2
24                                                         compatible device)
25                         - "renesas,rmobile-iic" (generic device)
26
27                         When compatible with a generic R-Car version, nodes
28                         must list the SoC-specific version corresponding to
29                         the platform first followed by the generic R-Car
30                         version.
31
32                         When compatible with "renesas,rmobile-iic" it should
33                         be the last compatibility string listed.
34
35                         The r8a77990 (R-Car E3) controller is not
36                         considered compatible with "renesas,rcar-gen3-iic"
37                         or "renesas,rmobile-iic" due to the absence of
38                         automatic transmission registers.
39
40 - reg             : address start and address range size of device
41 - interrupts      : interrupt of device
42 - clocks          : clock for device
43 - #address-cells  : should be <1>
44 - #size-cells     : should be <0>
45
46 Optional properties:
47 - clock-frequency : frequency of bus clock in Hz. Default 100kHz if unset.
48 - dmas            : Must contain a list of two references to DMA
49                     specifiers, one for transmission, and one for
50                     reception.
51 - dma-names       : Must contain a list of two DMA names, "tx" and "rx".
52
53
54 Pinctrl properties might be needed, too. See there.
55
56 Example:
57
58         iic0: i2c@e6500000 {
59                 compatible = "renesas,iic-r8a7790", "renesas,rcar-gen2-iic",
60                              "renesas,rmobile-iic";
61                 reg = <0 0xe6500000 0 0x425>;
62                 interrupts = <0 174 IRQ_TYPE_LEVEL_HIGH>;
63                 clocks = <&mstp3_clks R8A7790_CLK_IIC0>;
64                 clock-frequency = <400000>;
65                 #address-cells = <1>;
66                 #size-cells = <0>;
67         };