treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / devicetree / bindings / i2c / renesas,iic.txt
blob64d11ffb07c4762107f7b9592fd6ef529cc4de56
1 Device tree configuration for Renesas IIC (sh_mobile) driver
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-r8a774b1" (RZ/G2N)
12                         - "renesas,iic-r8a774c0" (RZ/G2E)
13                         - "renesas,iic-r8a7790" (R-Car H2)
14                         - "renesas,iic-r8a7791" (R-Car M2-W)
15                         - "renesas,iic-r8a7792" (R-Car V2H)
16                         - "renesas,iic-r8a7793" (R-Car M2-N)
17                         - "renesas,iic-r8a7794" (R-Car E2)
18                         - "renesas,iic-r8a7795" (R-Car H3)
19                         - "renesas,iic-r8a7796" (R-Car M3-W)
20                         - "renesas,iic-r8a77965" (R-Car M3-N)
21                         - "renesas,iic-r8a77990" (R-Car E3)
22                         - "renesas,iic-sh73a0" (SH-Mobile AG5)
23                         - "renesas,rcar-gen2-iic" (generic R-Car Gen2 or RZ/G1
24                                                         compatible device)
25                         - "renesas,rcar-gen3-iic" (generic R-Car Gen3 or RZ/G2
26                                                         compatible device)
27                         - "renesas,rmobile-iic" (generic device)
29                         When compatible with a generic R-Car version, nodes
30                         must list the SoC-specific version corresponding to
31                         the platform first followed by the generic R-Car
32                         version.
34                         When compatible with "renesas,rmobile-iic" it should
35                         be the last compatibility string listed.
37                         The r8a77990 (R-Car E3) and r8a774c0 (RZ/G2E)
38                         controllers are not considered compatible with
39                         "renesas,rcar-gen3-iic" or "renesas,rmobile-iic"
40                         due to the absence of automatic transmission registers.
42 - reg             : address start and address range size of device
43 - interrupts      : interrupt of device
44 - clocks          : clock for device
45 - #address-cells  : should be <1>
46 - #size-cells     : should be <0>
48 Optional properties:
49 - clock-frequency : frequency of bus clock in Hz. Default 100kHz if unset.
50 - dmas            : Must contain a list of two references to DMA
51                     specifiers, one for transmission, and one for
52                     reception.
53 - dma-names       : Must contain a list of two DMA names, "tx" and "rx".
56 Pinctrl properties might be needed, too. See there.
58 Example:
60         iic0: i2c@e6500000 {
61                 compatible = "renesas,iic-r8a7790", "renesas,rcar-gen2-iic",
62                              "renesas,rmobile-iic";
63                 reg = <0 0xe6500000 0 0x425>;
64                 interrupts = <0 174 IRQ_TYPE_LEVEL_HIGH>;
65                 clocks = <&mstp3_clks R8A7790_CLK_IIC0>;
66                 clock-frequency = <400000>;
67                 #address-cells = <1>;
68                 #size-cells = <0>;
69         };