Documentation: remove dynamic-resolution-notes reference to non-existent file
[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  - st,syscfg: Should be phandle/offset pair. The phandle to the syscon node
41    which includes IRQ mux selection register, and the offset of the IRQ mux
42    selection register.
43  - gpio-ranges: Define a dedicated mapping between a pin-controller and
44    a gpio controller. Format is <&phandle a b c> with:
45         -(phandle): phandle of pin-controller.
46         -(a): gpio base offset in range.
47         -(b): pin base offset in range.
48         -(c): gpio count in range
49    This entry has to be used either if there are holes inside a bank:
50         GPIOB0/B1/B2/B14/B15 (see example 2)
51    or if banks are not contiguous:
52         GPIOA/B/C/E...
53    NOTE: If "gpio-ranges" is used for a gpio controller, all gpio-controller
54    have to use a "gpio-ranges" entry.
55    More details in Documentation/devicetree/bindings/gpio/gpio.txt.
56
57 Example 1:
58 #include <dt-bindings/pinctrl/stm32f429-pinfunc.h>
59 ...
60
61         pin-controller {
62                 #address-cells = <1>;
63                 #size-cells = <1>;
64                 compatible = "st,stm32f429-pinctrl";
65                 ranges = <0 0x40020000 0x3000>;
66                 pins-are-numbered;
67
68                 gpioa: gpio@40020000 {
69                         gpio-controller;
70                         #gpio-cells = <2>;
71                         reg = <0x0 0x400>;
72                         resets = <&reset_ahb1 0>;
73                         st,bank-name = "GPIOA";
74                 };
75                 ...
76                 pin-functions nodes follow...
77         };
78
79 Example 2:
80 #include <dt-bindings/pinctrl/stm32f429-pinfunc.h>
81 ...
82
83         pinctrl: pin-controller {
84                 #address-cells = <1>;
85                 #size-cells = <1>;
86                 compatible = "st,stm32f429-pinctrl";
87                 ranges = <0 0x40020000 0x3000>;
88                 pins-are-numbered;
89
90                 gpioa: gpio@40020000 {
91                         gpio-controller;
92                         #gpio-cells = <2>;
93                         reg = <0x0 0x400>;
94                         resets = <&reset_ahb1 0>;
95                         st,bank-name = "GPIOA";
96                         gpio-ranges = <&pinctrl 0 0 16>;
97                 };
98
99                 gpiob: gpio@40020400 {
100                         gpio-controller;
101                         #gpio-cells = <2>;
102                         reg = <0x0 0x400>;
103                         resets = <&reset_ahb1 0>;
104                         st,bank-name = "GPIOB";
105                         ngpios = 4;
106                         gpio-ranges = <&pinctrl 0 16 3>,
107                                       <&pinctrl 14 30 2>;
108                 };
109
110
111                 ...
112                 pin-functions nodes follow...
113         };
114
115
116 Contents of function subnode node:
117 ----------------------------------
118 Subnode format
119 A pinctrl node should contain at least one subnode representing the
120 pinctrl group available on the machine. Each subnode will list the
121 pins it needs, and how they should be configured, with regard to muxer
122 configuration, pullups, drive, output high/low and output speed.
123
124     node {
125         pinmux = <PIN_NUMBER_PINMUX>;
126         GENERIC_PINCONFIG;
127     };
128
129 Required properties:
130 - pinmux: integer array, represents gpio pin number and mux setting.
131   Supported pin number and mux varies for different SoCs, and are defined in
132   dt-bindings/pinctrl/<soc>-pinfunc.h directly.
133   These defines are calculated as:
134     ((port * 16 + line) << 8) | function
135   With:
136     - port: The gpio port index (PA = 0, PB = 1, ..., PK = 11)
137     - line: The line offset within the port (PA0 = 0, PA1 = 1, ..., PA15 = 15)
138     - function: The function number, can be:
139       * 0 : GPIO
140       * 1 : Alternate Function 0
141       * 2 : Alternate Function 1
142       * 3 : Alternate Function 2
143       * ...
144       * 16 : Alternate Function 15
145       * 17 : Analog
146
147   To simplify the usage, macro is available to generate "pinmux" field.
148   This macro is available here:
149     - include/dt-bindings/pinctrl/stm32-pinfunc.h
150
151   Some examples of using macro:
152     /* GPIO A9 set as alernate function 2 */
153     ... {
154                 pinmux = <STM32_PINMUX('A', 9, AF2)>;
155     };
156     /* GPIO A9 set as GPIO  */
157     ... {
158                 pinmux = <STM32_PINMUX('A', 9, GPIO)>;
159     };
160     /* GPIO A9 set as analog */
161     ... {
162                 pinmux = <STM32_PINMUX('A', 9, ANALOG)>;
163     };
164
165 Optional properties:
166 - GENERIC_PINCONFIG: is the generic pinconfig options to use.
167   Available options are:
168    - bias-disable,
169    - bias-pull-down,
170    - bias-pull-up,
171    - drive-push-pull,
172    - drive-open-drain,
173    - output-low
174    - output-high
175    - slew-rate = <x>, with x being:
176        < 0 > : Low speed
177        < 1 > : Medium speed
178        < 2 > : Fast speed
179        < 3 > : High speed
180
181 Example:
182
183 pin-controller {
184 ...
185         usart1_pins_a: usart1@0 {
186                 pins1 {
187                         pinmux = <STM32_PINMUX('A', 9, AF7)>;
188                         bias-disable;
189                         drive-push-pull;
190                         slew-rate = <0>;
191                 };
192                 pins2 {
193                         pinmux = <STM32_PINMUX('A', 10, AF7)>;
194                         bias-disable;
195                 };
196         };
197 };
198
199 &usart1 {
200         pinctrl-0 = <&usart1_pins_a>;
201         pinctrl-names = "default";
202 };