GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / gpio / renesas,gpio-rcar.txt
1 * Renesas R-Car GPIO Controller
2
3 Required Properties:
4
5   - compatible: should contain one or more of the following:
6     - "renesas,gpio-r8a7743": for R8A7743 (RZ/G1M) compatible GPIO controller.
7     - "renesas,gpio-r8a7745": for R8A7745 (RZ/G1E) compatible GPIO controller.
8     - "renesas,gpio-r8a7778": for R8A7778 (R-Mobile M1) compatible GPIO controller.
9     - "renesas,gpio-r8a7779": for R8A7779 (R-Car H1) compatible GPIO controller.
10     - "renesas,gpio-r8a7790": for R8A7790 (R-Car H2) compatible GPIO controller.
11     - "renesas,gpio-r8a7791": for R8A7791 (R-Car M2-W) compatible GPIO controller.
12     - "renesas,gpio-r8a7792": for R8A7792 (R-Car V2H) compatible GPIO controller.
13     - "renesas,gpio-r8a7793": for R8A7793 (R-Car M2-N) compatible GPIO controller.
14     - "renesas,gpio-r8a7794": for R8A7794 (R-Car E2) compatible GPIO controller.
15     - "renesas,gpio-r8a7795": for R8A7795 (R-Car H3) compatible GPIO controller.
16     - "renesas,gpio-r8a7796": for R8A7796 (R-Car M3-W) compatible GPIO controller.
17     - "renesas,rcar-gen1-gpio": for a generic R-Car Gen1 GPIO controller.
18     - "renesas,rcar-gen2-gpio": for a generic R-Car Gen2 or RZ/G1 GPIO controller.
19     - "renesas,rcar-gen3-gpio": for a generic R-Car Gen3 GPIO controller.
20     - "renesas,gpio-rcar": deprecated.
21
22     When compatible with the generic version nodes must list the
23     SoC-specific version corresponding to the platform first followed by
24     the generic version.
25
26   - reg: Base address and length of each memory resource used by the GPIO
27     controller hardware module.
28
29   - interrupt-parent: phandle of the parent interrupt controller.
30   - interrupts: Interrupt specifier for the controllers interrupt.
31
32   - gpio-controller: Marks the device node as a gpio controller.
33   - #gpio-cells: Should be 2. The first cell is the GPIO number and the second
34     cell specifies GPIO flags, as defined in <dt-bindings/gpio/gpio.h>. Only the
35     GPIO_ACTIVE_HIGH and GPIO_ACTIVE_LOW flags are supported.
36   - gpio-ranges: Range of pins managed by the GPIO controller.
37
38 Optional properties:
39
40   - clocks: Must contain a reference to the functional clock.  The property is
41     mandatory if the hardware implements a controllable functional clock for
42     the GPIO instance.
43
44 Please refer to gpio.txt in this directory for details of gpio-ranges property
45 and the common GPIO bindings used by client devices.
46
47 The GPIO controller also acts as an interrupt controller. It uses the default
48 two cells specifier as described in Documentation/devicetree/bindings/
49 interrupt-controller/interrupts.txt.
50
51 Example: R8A7779 (R-Car H1) GPIO controller nodes
52
53         gpio0: gpio@ffc40000 {
54                 compatible = "renesas,gpio-r8a7779", "renesas,rcar-gen1-gpio";
55                 reg = <0xffc40000 0x2c>;
56                 interrupt-parent = <&gic>;
57                 interrupts = <0 141 0x4>;
58                 #gpio-cells = <2>;
59                 gpio-controller;
60                 gpio-ranges = <&pfc 0 0 32>;
61                 interrupt-controller;
62                 #interrupt-cells = <2>;
63         };
64         ...
65         gpio6: gpio@ffc46000 {
66                 compatible = "renesas,gpio-r8a7779", "renesas,rcar-gen1-gpio";
67                 reg = <0xffc46000 0x2c>;
68                 interrupt-parent = <&gic>;
69                 interrupts = <0 147 0x4>;
70                 #gpio-cells = <2>;
71                 gpio-controller;
72                 gpio-ranges = <&pfc 0 192 9>;
73                 interrupt-controller;
74                 #interrupt-cells = <2>;
75         };