1* Renesas Pin Function Controller (GPIO and Pin Mux/Config)
2
3The Pin Function Controller (PFC) is a Pin Mux/Config controller. On SH73A0,
4R8A73A4 and R8A7740 it also acts as a GPIO controller.
5
6
7Pin Control
8-----------
9
10Required Properties:
11
12  - compatible: should be one of the following.
13    - "renesas,pfc-emev2": for EMEV2 (EMMA Mobile EV2) compatible pin-controller.
14    - "renesas,pfc-r8a73a4": for R8A73A4 (R-Mobile APE6) compatible pin-controller.
15    - "renesas,pfc-r8a7740": for R8A7740 (R-Mobile A1) compatible pin-controller.
16    - "renesas,pfc-r8a7778": for R8A7778 (R-Mobile M1) compatible pin-controller.
17    - "renesas,pfc-r8a7779": for R8A7779 (R-Car H1) compatible pin-controller.
18    - "renesas,pfc-r8a7790": for R8A7790 (R-Car H2) compatible pin-controller.
19    - "renesas,pfc-r8a7791": for R8A7791 (R-Car M2) compatible pin-controller.
20    - "renesas,pfc-sh73a0": for SH73A0 (SH-Mobile AG5) compatible pin-controller.
21
22  - reg: Base address and length of each memory resource used by the pin
23    controller hardware module.
24
25Optional properties:
26
27  - #gpio-range-cells: Mandatory when the PFC doesn't handle GPIO, forbidden
28    otherwise. Should be 3.
29
30  - interrupts-extended: Specify the interrupts associated with external
31    IRQ pins. This property is mandatory when the PFC handles GPIOs and
32    forbidden otherwise. When specified, it must contain one interrupt per
33    external IRQ, sorted by external IRQ number.
34
35The PFC node also acts as a container for pin configuration nodes. Please refer
36to pinctrl-bindings.txt in this directory for the definition of the term "pin
37configuration node" and for the common pinctrl bindings used by client devices.
38
39Each pin configuration node represents a desired configuration for a pin, a
40pin group, or a list of pins or pin groups. The configuration can include the
41function to select on those pin(s) and pin configuration parameters (such as
42pull-up and pull-down).
43
44Pin configuration nodes contain pin configuration properties, either directly
45or grouped in child subnodes. Both pin muxing and configuration parameters can
46be grouped in that way and referenced as a single pin configuration node by
47client devices.
48
49A configuration node or subnode must reference at least one pin (through the
50pins or pin groups properties) and contain at least a function or one
51configuration parameter. When the function is present only pin groups can be
52used to reference pins.
53
54All pin configuration nodes and subnodes names are ignored. All of those nodes
55are parsed through phandles and processed purely based on their content.
56
57Pin Configuration Node Properties:
58
59- renesas,pins : An array of strings, each string containing the name of a pin.
60- renesas,groups : An array of strings, each string containing the name of a pin
61  group.
62
63- renesas,function: A string containing the name of the function to mux to the
64  pin group(s) specified by the renesas,groups property
65
66  Valid values for pin, group and function names can be found in the group and
67  function arrays of the PFC data file corresponding to the SoC
68  (drivers/pinctrl/sh-pfc/pfc-*.c)
69
70The pin configuration parameters use the generic pinconf bindings defined in
71pinctrl-bindings.txt in this directory. The supported parameters are
72bias-disable, bias-pull-up and bias-pull-down.
73
74
75GPIO
76----
77
78On SH73A0, R8A73A4 and R8A7740 the PFC node is also a GPIO controller node.
79
80Required Properties:
81
82  - gpio-controller: Marks the device node as a gpio controller.
83
84  - #gpio-cells: Should be 2. The first cell is the GPIO number and the second
85    cell specifies GPIO flags, as defined in <dt-bindings/gpio/gpio.h>. Only the
86    GPIO_ACTIVE_HIGH and GPIO_ACTIVE_LOW flags are supported.
87
88The syntax of the gpio specifier used by client nodes should be the following
89with values derived from the SoC user manual.
90
91  <[phandle of the gpio controller node]
92   [pin number within the gpio controller]
93   [flags]>
94
95On other mach-shmobile platforms GPIO is handled by the gpio-rcar driver.
96Please refer to Documentation/devicetree/bindings/gpio/renesas,gpio-rcar.txt
97for documentation of the GPIO device tree bindings on those platforms.
98
99
100Examples
101--------
102
103Example 1: SH73A0 (SH-Mobile AG5) pin controller node
104
105	pfc: pfc@e6050000 {
106		compatible = "renesas,pfc-sh73a0";
107		reg = <0xe6050000 0x8000>,
108		      <0xe605801c 0x1c>;
109		gpio-controller;
110		#gpio-cells = <2>;
111		interrupts-extended =
112			<&irqpin0 0 0>, <&irqpin0 1 0>, <&irqpin0 2 0>, <&irqpin0 3 0>,
113			<&irqpin0 4 0>, <&irqpin0 5 0>, <&irqpin0 6 0>, <&irqpin0 7 0>,
114			<&irqpin1 0 0>, <&irqpin1 1 0>, <&irqpin1 2 0>, <&irqpin1 3 0>,
115			<&irqpin1 4 0>, <&irqpin1 5 0>, <&irqpin1 6 0>, <&irqpin1 7 0>,
116			<&irqpin2 0 0>, <&irqpin2 1 0>, <&irqpin2 2 0>, <&irqpin2 3 0>,
117			<&irqpin2 4 0>, <&irqpin2 5 0>, <&irqpin2 6 0>, <&irqpin2 7 0>,
118			<&irqpin3 0 0>, <&irqpin3 1 0>, <&irqpin3 2 0>, <&irqpin3 3 0>,
119			<&irqpin3 4 0>, <&irqpin3 5 0>, <&irqpin3 6 0>, <&irqpin3 7 0>;
120	};
121
122Example 2: A GPIO LED node that references a GPIO
123
124	#include <dt-bindings/gpio/gpio.h>
125
126	leds {
127		compatible = "gpio-leds";
128		led1 {
129			gpios = <&pfc 20 GPIO_ACTIVE_LOW>;
130		};
131	};
132
133Example 3: KZM-A9-GT (SH-Mobile AG5) default pin state hog and pin control maps
134           for the MMCIF and SCIFA4 devices
135
136	&pfc {
137		pinctrl-0 = <&scifa4_pins>;
138		pinctrl-names = "default";
139
140		mmcif_pins: mmcif {
141			mux {
142				renesas,groups = "mmc0_data8_0", "mmc0_ctrl_0";
143				renesas,function = "mmc0";
144			};
145			cfg {
146				renesas,groups = "mmc0_data8_0";
147				renesas,pins = "PORT279";
148				bias-pull-up;
149			};
150		};
151
152		scifa4_pins: scifa4 {
153			renesas,groups = "scifa4_data", "scifa4_ctrl";
154			renesas,function = "scifa4";
155		};
156	};
157
158Example 4: KZM-A9-GT (SH-Mobile AG5) default pin state for the MMCIF device
159
160	&mmcif {
161		pinctrl-0 = <&mmcif_pins>;
162		pinctrl-names = "default";
163
164		bus-width = <8>;
165		vmmc-supply = <&reg_1p8v>;
166		status = "okay";
167	};
168