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