Merge tag 'pinctrl-v4.19-1' of git://git.kernel.org/pub/scm/linux/kernel/git/linusw...
[muen/linux.git] / Documentation / devicetree / bindings / pinctrl / st,stm32-pinctrl.txt
1 * STM32 GPIO and Pin Mux/Config controller
2
3 STMicroelectronics's STM32 MCUs intregrate a GPIO and Pin mux/config hardware
4 controller. It controls the input/output settings on the available pins and
5 also provides ability to multiplex and configure the output of various on-chip
6 controllers onto these pads.
7
8 Pin controller node:
9 Required properies:
10  - compatible: value should be one of the following:
11    "st,stm32f429-pinctrl"
12    "st,stm32f469-pinctrl"
13    "st,stm32f746-pinctrl"
14    "st,stm32f769-pinctrl"
15    "st,stm32h743-pinctrl"
16    "st,stm32mp157-pinctrl"
17    "st,stm32mp157-z-pinctrl"
18  - #address-cells: The value of this property must be 1
19  - #size-cells  : The value of this property must be 1
20  - ranges       : defines mapping between pin controller node (parent) to
21    gpio-bank node (children).
22  - pins-are-numbered: Specify the subnodes are using numbered pinmux to
23    specify pins.
24
25 GPIO controller/bank node:
26 Required properties:
27  - gpio-controller : Indicates this device is a GPIO controller
28  - #gpio-cells    : Should be two.
29                         The first cell is the pin number
30                         The second one is the polarity:
31                                 - 0 for active high
32                                 - 1 for active low
33  - reg            : The gpio address range, relative to the pinctrl range
34  - clocks         : clock that drives this bank
35  - st,bank-name   : Should be a name string for this bank as specified in
36    the datasheet
37
38 Optional properties:
39  - reset:         : Reference to the reset controller
40  - interrupt-parent: phandle of the interrupt parent to which the external
41    GPIO interrupts are forwarded to.
42  - st,syscfg: Should be phandle/offset/mask.
43         -The phandle to the syscon node which includes IRQ mux selection register.
44         -The offset of the IRQ mux selection register
45         -The field mask of IRQ mux, needed if different of 0xf.
46  - gpio-ranges: Define a dedicated mapping between a pin-controller and
47    a gpio controller. Format is <&phandle a b c> with:
48         -(phandle): phandle of pin-controller.
49         -(a): gpio base offset in range.
50         -(b): pin base offset in range.
51         -(c): gpio count in range
52    This entry has to be used either if there are holes inside a bank:
53         GPIOB0/B1/B2/B14/B15 (see example 2)
54    or if banks are not contiguous:
55         GPIOA/B/C/E...
56    NOTE: If "gpio-ranges" is used for a gpio controller, all gpio-controller
57    have to use a "gpio-ranges" entry.
58    More details in Documentation/devicetree/bindings/gpio/gpio.txt.
59  - st,bank-ioport: should correspond to the EXTI IOport selection (EXTI line
60    used to select GPIOs as interrupts).
61
62 Example 1:
63 #include <dt-bindings/pinctrl/stm32f429-pinfunc.h>
64 ...
65
66         pin-controller {
67                 #address-cells = <1>;
68                 #size-cells = <1>;
69                 compatible = "st,stm32f429-pinctrl";
70                 ranges = <0 0x40020000 0x3000>;
71                 pins-are-numbered;
72
73                 gpioa: gpio@40020000 {
74                         gpio-controller;
75                         #gpio-cells = <2>;
76                         reg = <0x0 0x400>;
77                         resets = <&reset_ahb1 0>;
78                         st,bank-name = "GPIOA";
79                 };
80                 ...
81                 pin-functions nodes follow...
82         };
83
84 Example 2:
85 #include <dt-bindings/pinctrl/stm32f429-pinfunc.h>
86 ...
87
88         pinctrl: pin-controller {
89                 #address-cells = <1>;
90                 #size-cells = <1>;
91                 compatible = "st,stm32f429-pinctrl";
92                 ranges = <0 0x40020000 0x3000>;
93                 pins-are-numbered;
94
95                 gpioa: gpio@40020000 {
96                         gpio-controller;
97                         #gpio-cells = <2>;
98                         reg = <0x0 0x400>;
99                         resets = <&reset_ahb1 0>;
100                         st,bank-name = "GPIOA";
101                         gpio-ranges = <&pinctrl 0 0 16>;
102                 };
103
104                 gpiob: gpio@40020400 {
105                         gpio-controller;
106                         #gpio-cells = <2>;
107                         reg = <0x0 0x400>;
108                         resets = <&reset_ahb1 0>;
109                         st,bank-name = "GPIOB";
110                         ngpios = 4;
111                         gpio-ranges = <&pinctrl 0 16 3>,
112                                       <&pinctrl 14 30 2>;
113                 };
114
115
116                 ...
117                 pin-functions nodes follow...
118         };
119
120
121 Contents of function subnode node:
122 ----------------------------------
123 Subnode format
124 A pinctrl node should contain at least one subnode representing the
125 pinctrl group available on the machine. Each subnode will list the
126 pins it needs, and how they should be configured, with regard to muxer
127 configuration, pullups, drive, output high/low and output speed.
128
129     node {
130         pinmux = <PIN_NUMBER_PINMUX>;
131         GENERIC_PINCONFIG;
132     };
133
134 Required properties:
135 - pinmux: integer array, represents gpio pin number and mux setting.
136   Supported pin number and mux varies for different SoCs, and are defined in
137   dt-bindings/pinctrl/<soc>-pinfunc.h directly.
138   These defines are calculated as:
139     ((port * 16 + line) << 8) | function
140   With:
141     - port: The gpio port index (PA = 0, PB = 1, ..., PK = 11)
142     - line: The line offset within the port (PA0 = 0, PA1 = 1, ..., PA15 = 15)
143     - function: The function number, can be:
144       * 0 : GPIO
145       * 1 : Alternate Function 0
146       * 2 : Alternate Function 1
147       * 3 : Alternate Function 2
148       * ...
149       * 16 : Alternate Function 15
150       * 17 : Analog
151
152   To simplify the usage, macro is available to generate "pinmux" field.
153   This macro is available here:
154     - include/dt-bindings/pinctrl/stm32-pinfunc.h
155
156   Some examples of using macro:
157     /* GPIO A9 set as alernate function 2 */
158     ... {
159                 pinmux = <STM32_PINMUX('A', 9, AF2)>;
160     };
161     /* GPIO A9 set as GPIO  */
162     ... {
163                 pinmux = <STM32_PINMUX('A', 9, GPIO)>;
164     };
165     /* GPIO A9 set as analog */
166     ... {
167                 pinmux = <STM32_PINMUX('A', 9, ANALOG)>;
168     };
169
170 Optional properties:
171 - GENERIC_PINCONFIG: is the generic pinconfig options to use.
172   Available options are:
173    - bias-disable,
174    - bias-pull-down,
175    - bias-pull-up,
176    - drive-push-pull,
177    - drive-open-drain,
178    - output-low
179    - output-high
180    - slew-rate = <x>, with x being:
181        < 0 > : Low speed
182        < 1 > : Medium speed
183        < 2 > : Fast speed
184        < 3 > : High speed
185
186 Example:
187
188 pin-controller {
189 ...
190         usart1_pins_a: usart1@0 {
191                 pins1 {
192                         pinmux = <STM32_PINMUX('A', 9, AF7)>;
193                         bias-disable;
194                         drive-push-pull;
195                         slew-rate = <0>;
196                 };
197                 pins2 {
198                         pinmux = <STM32_PINMUX('A', 10, AF7)>;
199                         bias-disable;
200                 };
201         };
202 };
203
204 &usart1 {
205         pinctrl-0 = <&usart1_pins_a>;
206         pinctrl-names = "default";
207 };