Documentation/devicetree/bindings/gpio/gpio.txt

   1 Specifying GPIO information for devices
   2 ============================================
   3
   4 1) gpios property
   5 -----------------
   6
   7 Nodes that makes use of GPIOs should specify them using one or more
   8 properties, each containing a 'gpio-list':
   9
  10         gpio-list ::= <single-gpio> [gpio-list]
  11         single-gpio ::= <gpio-phandle> <gpio-specifier>
  12         gpio-phandle : phandle to gpio controller node
  13         gpio-specifier : Array of #gpio-cells specifying specific gpio
  14                          (controller specific)
  15
  16 GPIO properties should be named "[<name>-]gpios", with <name> being the purpose
  17 of this GPIO for the device. While a non-existent <name> is considered valid
  18 for compatibility reasons (resolving to the "gpios" property), it is not allowed
  19 for new bindings. Also, GPIO properties named "[<name>-]gpio" are valid and old
  20 bindings use it, but are only supported for compatibility reasons and should not
  21 be used for newer bindings since it has been deprecated.
  22
  23 GPIO properties can contain one or more GPIO phandles, but only in exceptional
  24 cases should they contain more than one. If your device uses several GPIOs with
  25 distinct functions, reference each of them under its own property, giving it a
  26 meaningful name. The only case where an array of GPIOs is accepted is when
  27 several GPIOs serve the same function (e.g. a parallel data line).
  28
  29 The exact purpose of each gpios property must be documented in the device tree
  30 binding of the device.
  31
  32 The following example could be used to describe GPIO pins used as device enable
  33 and bit-banged data signals:
  34
  35         gpio1: gpio1 {
  36                 gpio-controller
  37                  #gpio-cells = <2>;
  38         };
  39         gpio2: gpio2 {
  40                 gpio-controller
  41                  #gpio-cells = <1>;
  42         };
  43         [...]
  44
  45         enable-gpios = <&gpio2 2>;
  46         data-gpios = <&gpio1 12 0>,
  47                      <&gpio1 13 0>,
  48                      <&gpio1 14 0>,
  49                      <&gpio1 15 0>;
  50
  51 Note that gpio-specifier length is controller dependent.  In the
  52 above example, &gpio1 uses 2 cells to specify a gpio, while &gpio2
  53 only uses one.
  54
  55 gpio-specifier may encode: bank, pin position inside the bank,
  56 whether pin is open-drain and whether pin is logically inverted.
  57
  58 Exact meaning of each specifier cell is controller specific, and must
  59 be documented in the device tree binding for the device.
  60
  61 Most controllers are however specifying a generic flag bitfield
  62 in the last cell, so for these, use the macros defined in
  63 include/dt-bindings/gpio/gpio.h whenever possible:
  64
  65 Example of a node using GPIOs:
  66
  67         node {
  68                 enable-gpios = <&qe_pio_e 18 GPIO_ACTIVE_HIGH>;
  69         };
  70
  71 GPIO_ACTIVE_HIGH is 0, so in this example gpio-specifier is "18 0" and encodes
  72 GPIO pin number, and GPIO flags as accepted by the "qe_pio_e" gpio-controller.
  73
  74 Optional standard bitfield specifiers for the last cell:
  75
  76 - Bit 0: 0 means active high, 1 means active low
  77 - Bit 1: 1 means single-ended wiring, see:
  78            https://en.wikipedia.org/wiki/Single-ended_triode
  79            When used with active-low, this means open drain/collector, see:
  80            https://en.wikipedia.org/wiki/Open_collector
  81            When used with active-high, this means open source/emitter
  82
  83 1.1) GPIO specifier best practices
  84 ----------------------------------
  85
  86 A gpio-specifier should contain a flag indicating the GPIO polarity; active-
  87 high or active-low. If it does, the following best practices should be
  88 followed:
  89
  90 The gpio-specifier's polarity flag should represent the physical level at the
  91 GPIO controller that achieves (or represents, for inputs) a logically asserted
  92 value at the device. The exact definition of logically asserted should be
  93 defined by the binding for the device. If the board inverts the signal between
  94 the GPIO controller and the device, then the gpio-specifier will represent the
  95 opposite physical level than the signal at the device's pin.
  96
  97 When the device's signal polarity is configurable, the binding for the
  98 device must either:
  99
 100 a) Define a single static polarity for the signal, with the expectation that
 101 any software using that binding would statically program the device to use
 102 that signal polarity.
 103
 104 The static choice of polarity may be either:
 105
 106 a1) (Preferred) Dictated by a binding-specific DT property.
 107
 108 or:
 109
 110 a2) Defined statically by the DT binding itself.
 111
 112 In particular, the polarity cannot be derived from the gpio-specifier, since
 113 that would prevent the DT from separately representing the two orthogonal
 114 concepts of configurable signal polarity in the device, and possible board-
 115 level signal inversion.
 116
 117 or:
 118
 119 b) Pick a single option for device signal polarity, and document this choice
 120 in the binding. The gpio-specifier should represent the polarity of the signal
 121 (at the GPIO controller) assuming that the device is configured for this
 122 particular signal polarity choice. If software chooses to program the device
 123 to generate or receive a signal of the opposite polarity, software will be
 124 responsible for correctly interpreting (inverting) the GPIO signal at the GPIO
 125 controller.
 126
 127 2) gpio-controller nodes
 128 ------------------------
 129
 130 Every GPIO controller node must contain both an empty "gpio-controller"
 131 property, and a #gpio-cells integer property, which indicates the number of
 132 cells in a gpio-specifier.
 133
 134 Optionally, a GPIO controller may have a "ngpios" property. This property
 135 indicates the number of in-use slots of available slots for GPIOs. The
 136 typical example is something like this: the hardware register is 32 bits
 137 wide, but only 18 of the bits have a physical counterpart. The driver is
 138 generally written so that all 32 bits can be used, but the IP block is reused
 139 in a lot of designs, some using all 32 bits, some using 18 and some using
 140 12. In this case, setting "ngpios = <18>;" informs the driver that only the
 141 first 18 GPIOs, at local offset 0 .. 17, are in use.
 142
 143 If these GPIOs do not happen to be the first N GPIOs at offset 0...N-1, an
 144 additional bitmask is needed to specify which GPIOs are actually in use,
 145 and which are dummies. The bindings for this case has not yet been
 146 specified, but should be specified if/when such hardware appears.
 147
 148 Example:
 149
 150 gpio-controller@00000000 {
 151         compatible = "foo";
 152         reg = <0x00000000 0x1000>;
 153         gpio-controller;
 154         #gpio-cells = <2>;
 155         ngpios = <18>;
 156 }
 157
 158 The GPIO chip may contain GPIO hog definitions. GPIO hogging is a mechanism
 159 providing automatic GPIO request and configuration as part of the
 160 gpio-controller's driver probe function.
 161
 162 Each GPIO hog definition is represented as a child node of the GPIO controller.
 163 Required properties:
 164 - gpio-hog:   A property specifying that this child node represent a GPIO hog.
 165 - gpios:      Store the GPIO information (id, flags, ...). Shall contain the
 166               number of cells specified in its parent node (GPIO controller
 167               node).
 168 Only one of the following properties scanned in the order shown below.
 169 This means that when multiple properties are present they will be searched
 170 in the order presented below and the first match is taken as the intended
 171 configuration.
 172 - input:      A property specifying to set the GPIO direction as input.
 173 - output-low  A property specifying to set the GPIO direction as output with
 174               the value low.
 175 - output-high A property specifying to set the GPIO direction as output with
 176               the value high.
 177
 178 Optional properties:
 179 - line-name:  The GPIO label name. If not present the node name is used.
 180
 181 Example of two SOC GPIO banks defined as gpio-controller nodes:
 182
 183         qe_pio_a: gpio-controller@1400 {
 184                 compatible = "fsl,qe-pario-bank-a", "fsl,qe-pario-bank";
 185                 reg = <0x1400 0x18>;
 186                 gpio-controller;
 187                 #gpio-cells = <2>;
 188
 189                 line_b {
 190                         gpio-hog;
 191                         gpios = <6 0>;
 192                         output-low;
 193                         line-name = "foo-bar-gpio";
 194                 };
 195         };
 196
 197         qe_pio_e: gpio-controller@1460 {
 198                 compatible = "fsl,qe-pario-bank-e", "fsl,qe-pario-bank";
 199                 reg = <0x1460 0x18>;
 200                 gpio-controller;
 201                 #gpio-cells = <2>;
 202         };
 203
 204 2.1) gpio- and pin-controller interaction
 205 -----------------------------------------
 206
 207 Some or all of the GPIOs provided by a GPIO controller may be routed to pins
 208 on the package via a pin controller. This allows muxing those pins between
 209 GPIO and other functions.
 210
 211 It is useful to represent which GPIOs correspond to which pins on which pin
 212 controllers. The gpio-ranges property described below represents this, and
 213 contains information structures as follows:
 214
 215         gpio-range-list ::= <single-gpio-range> [gpio-range-list]
 216         single-gpio-range ::= <numeric-gpio-range> | <named-gpio-range>
 217         numeric-gpio-range ::=
 218                         <pinctrl-phandle> <gpio-base> <pinctrl-base> <count>
 219         named-gpio-range ::= <pinctrl-phandle> <gpio-base> '<0 0>'
 220         pinctrl-phandle : phandle to pin controller node
 221         gpio-base : Base GPIO ID in the GPIO controller
 222         pinctrl-base : Base pinctrl pin ID in the pin controller
 223         count : The number of GPIOs/pins in this range
 224
 225 The "pin controller node" mentioned above must conform to the bindings
 226 described in ../pinctrl/pinctrl-bindings.txt.
 227
 228 In case named gpio ranges are used (ranges with both <pinctrl-base> and
 229 <count> set to 0), the property gpio-ranges-group-names contains one string
 230 for every single-gpio-range in gpio-ranges:
 231         gpiorange-names-list ::= <gpiorange-name> [gpiorange-names-list]
 232         gpiorange-name : Name of the pingroup associated to the GPIO range in
 233                         the respective pin controller.
 234
 235 Elements of gpiorange-names-list corresponding to numeric ranges contain
 236 the empty string. Elements of gpiorange-names-list corresponding to named
 237 ranges contain the name of a pin group defined in the respective pin
 238 controller. The number of pins/GPIOs in the range is the number of pins in
 239 that pin group.
 240
 241 Previous versions of this binding required all pin controller nodes that
 242 were referenced by any gpio-ranges property to contain a property named
 243 #gpio-range-cells with value <3>. This requirement is now deprecated.
 244 However, that property may still exist in older device trees for
 245 compatibility reasons, and would still be required even in new device
 246 trees that need to be compatible with older software.
 247
 248 Example 1:
 249
 250         qe_pio_e: gpio-controller@1460 {
 251                 #gpio-cells = <2>;
 252                 compatible = "fsl,qe-pario-bank-e", "fsl,qe-pario-bank";
 253                 reg = <0x1460 0x18>;
 254                 gpio-controller;
 255                 gpio-ranges = <&pinctrl1 0 20 10>, <&pinctrl2 10 50 20>;
 256         };
 257
 258 Here, a single GPIO controller has GPIOs 0..9 routed to pin controller
 259 pinctrl1's pins 20..29, and GPIOs 10..19 routed to pin controller pinctrl2's
 260 pins 50..59.
 261
 262 Example 2:
 263
 264         gpio_pio_i: gpio-controller@14B0 {
 265                 #gpio-cells = <2>;
 266                 compatible = "fsl,qe-pario-bank-e", "fsl,qe-pario-bank";
 267                 reg = <0x1480 0x18>;
 268                 gpio-controller;
 269                 gpio-ranges =                   <&pinctrl1 0 20 10>,
 270                                                 <&pinctrl2 10 0 0>,
 271                                                 <&pinctrl1 15 0 10>,
 272                                                 <&pinctrl2 25 0 0>;
 273                 gpio-ranges-group-names =       "",
 274                                                 "foo",
 275                                                 "",
 276                                                 "bar";
 277         };
 278
 279 Here, three GPIO ranges are defined wrt. two pin controllers. pinctrl1 GPIO
 280 ranges are defined using pin numbers whereas the GPIO ranges wrt. pinctrl2
 281 are named "foo" and "bar".