Documentation/driver-api/gpio/consumer.rst

   1 ==================================
   2 GPIO Descriptor Consumer Interface
   3 ==================================
   4
   5 This document describes the consumer interface of the GPIO framework. Note that
   6 it describes the new descriptor-based interface. For a description of the
   7 deprecated integer-based GPIO interface please refer to gpio-legacy.txt.
   8
   9
  10 Guidelines for GPIOs consumers
  11 ==============================
  12
  13 Drivers that can't work without standard GPIO calls should have Kconfig entries
  14 that depend on GPIOLIB or select GPIOLIB. The functions that allow a driver to
  15 obtain and use GPIOs are available by including the following file:
  16
  17         #include <linux/gpio/consumer.h>
  18
  19 There are static inline stubs for all functions in the header file in the case
  20 where GPIOLIB is disabled. When these stubs are called they will emit
  21 warnings. These stubs are used for two use cases:
  22
  23 - Simple compile coverage with e.g. COMPILE_TEST - it does not matter that
  24   the current platform does not enable or select GPIOLIB because we are not
  25   going to execute the system anyway.
  26
  27 - Truly optional GPIOLIB support - where the driver does not really make use
  28   of the GPIOs on certain compile-time configurations for certain systems, but
  29   will use it under other compile-time configurations. In this case the
  30   consumer must make sure not to call into these functions, or the user will
  31   be met with console warnings that may be perceived as intimidating.
  32
  33 All the functions that work with the descriptor-based GPIO interface are
  34 prefixed with ``gpiod_``. The ``gpio_`` prefix is used for the legacy
  35 interface. No other function in the kernel should use these prefixes. The use
  36 of the legacy functions is strongly discouraged, new code should use
  37 <linux/gpio/consumer.h> and descriptors exclusively.
  38
  39
  40 Obtaining and Disposing GPIOs
  41 =============================
  42
  43 With the descriptor-based interface, GPIOs are identified with an opaque,
  44 non-forgeable handler that must be obtained through a call to one of the
  45 gpiod_get() functions. Like many other kernel subsystems, gpiod_get() takes the
  46 device that will use the GPIO and the function the requested GPIO is supposed to
  47 fulfill::
  48
  49         struct gpio_desc *gpiod_get(struct device *dev, const char *con_id,
  50                                     enum gpiod_flags flags)
  51
  52 If a function is implemented by using several GPIOs together (e.g. a simple LED
  53 device that displays digits), an additional index argument can be specified::
  54
  55         struct gpio_desc *gpiod_get_index(struct device *dev,
  56                                           const char *con_id, unsigned int idx,
  57                                           enum gpiod_flags flags)
  58
  59 For a more detailed description of the con_id parameter in the DeviceTree case
  60 see Documentation/driver-api/gpio/board.rst
  61
  62 The flags parameter is used to optionally specify a direction and initial value
  63 for the GPIO. Values can be:
  64
  65 * GPIOD_ASIS or 0 to not initialize the GPIO at all. The direction must be set
  66   later with one of the dedicated functions.
  67 * GPIOD_IN to initialize the GPIO as input.
  68 * GPIOD_OUT_LOW to initialize the GPIO as output with a value of 0.
  69 * GPIOD_OUT_HIGH to initialize the GPIO as output with a value of 1.
  70 * GPIOD_OUT_LOW_OPEN_DRAIN same as GPIOD_OUT_LOW but also enforce the line
  71   to be electrically used with open drain.
  72 * GPIOD_OUT_HIGH_OPEN_DRAIN same as GPIOD_OUT_HIGH but also enforce the line
  73   to be electrically used with open drain.
  74
  75 The two last flags are used for use cases where open drain is mandatory, such
  76 as I2C: if the line is not already configured as open drain in the mappings
  77 (see board.txt), then open drain will be enforced anyway and a warning will be
  78 printed that the board configuration needs to be updated to match the use case.
  79
  80 Both functions return either a valid GPIO descriptor, or an error code checkable
  81 with IS_ERR() (they will never return a NULL pointer). -ENOENT will be returned
  82 if and only if no GPIO has been assigned to the device/function/index triplet,
  83 other error codes are used for cases where a GPIO has been assigned but an error
  84 occurred while trying to acquire it. This is useful to discriminate between mere
  85 errors and an absence of GPIO for optional GPIO parameters. For the common
  86 pattern where a GPIO is optional, the gpiod_get_optional() and
  87 gpiod_get_index_optional() functions can be used. These functions return NULL
  88 instead of -ENOENT if no GPIO has been assigned to the requested function::
  89
  90         struct gpio_desc *gpiod_get_optional(struct device *dev,
  91                                              const char *con_id,
  92                                              enum gpiod_flags flags)
  93
  94         struct gpio_desc *gpiod_get_index_optional(struct device *dev,
  95                                                    const char *con_id,
  96                                                    unsigned int index,
  97                                                    enum gpiod_flags flags)
  98
  99 Note that gpio_get*_optional() functions (and their managed variants), unlike
 100 the rest of gpiolib API, also return NULL when gpiolib support is disabled.
 101 This is helpful to driver authors, since they do not need to special case
 102 -ENOSYS return codes.  System integrators should however be careful to enable
 103 gpiolib on systems that need it.
 104
 105 For a function using multiple GPIOs all of those can be obtained with one call::
 106
 107         struct gpio_descs *gpiod_get_array(struct device *dev,
 108                                            const char *con_id,
 109                                            enum gpiod_flags flags)
 110
 111 This function returns a struct gpio_descs which contains an array of
 112 descriptors.  It also contains a pointer to a gpiolib private structure which,
 113 if passed back to get/set array functions, may speed up I/O proocessing::
 114
 115         struct gpio_descs {
 116                 struct gpio_array *info;
 117                 unsigned int ndescs;
 118                 struct gpio_desc *desc[];
 119         }
 120
 121 The following function returns NULL instead of -ENOENT if no GPIOs have been
 122 assigned to the requested function::
 123
 124         struct gpio_descs *gpiod_get_array_optional(struct device *dev,
 125                                                     const char *con_id,
 126                                                     enum gpiod_flags flags)
 127
 128 Device-managed variants of these functions are also defined::
 129
 130         struct gpio_desc *devm_gpiod_get(struct device *dev, const char *con_id,
 131                                          enum gpiod_flags flags)
 132
 133         struct gpio_desc *devm_gpiod_get_index(struct device *dev,
 134                                                const char *con_id,
 135                                                unsigned int idx,
 136                                                enum gpiod_flags flags)
 137
 138         struct gpio_desc *devm_gpiod_get_optional(struct device *dev,
 139                                                   const char *con_id,
 140                                                   enum gpiod_flags flags)
 141
 142         struct gpio_desc *devm_gpiod_get_index_optional(struct device *dev,
 143                                                         const char *con_id,
 144                                                         unsigned int index,
 145                                                         enum gpiod_flags flags)
 146
 147         struct gpio_descs *devm_gpiod_get_array(struct device *dev,
 148                                                 const char *con_id,
 149                                                 enum gpiod_flags flags)
 150
 151         struct gpio_descs *devm_gpiod_get_array_optional(struct device *dev,
 152                                                          const char *con_id,
 153                                                          enum gpiod_flags flags)
 154
 155 A GPIO descriptor can be disposed of using the gpiod_put() function::
 156
 157         void gpiod_put(struct gpio_desc *desc)
 158
 159 For an array of GPIOs this function can be used::
 160
 161         void gpiod_put_array(struct gpio_descs *descs)
 162
 163 It is strictly forbidden to use a descriptor after calling these functions.
 164 It is also not allowed to individually release descriptors (using gpiod_put())
 165 from an array acquired with gpiod_get_array().
 166
 167 The device-managed variants are, unsurprisingly::
 168
 169         void devm_gpiod_put(struct device *dev, struct gpio_desc *desc)
 170
 171         void devm_gpiod_put_array(struct device *dev, struct gpio_descs *descs)
 172
 173
 174 Using GPIOs
 175 ===========
 176
 177 Setting Direction
 178 -----------------
 179 The first thing a driver must do with a GPIO is setting its direction. If no
 180 direction-setting flags have been given to gpiod_get*(), this is done by
 181 invoking one of the gpiod_direction_*() functions::
 182
 183         int gpiod_direction_input(struct gpio_desc *desc)
 184         int gpiod_direction_output(struct gpio_desc *desc, int value)
 185
 186 The return value is zero for success, else a negative errno. It should be
 187 checked, since the get/set calls don't return errors and since misconfiguration
 188 is possible. You should normally issue these calls from a task context. However,
 189 for spinlock-safe GPIOs it is OK to use them before tasking is enabled, as part
 190 of early board setup.
 191
 192 For output GPIOs, the value provided becomes the initial output value. This
 193 helps avoid signal glitching during system startup.
 194
 195 A driver can also query the current direction of a GPIO::
 196
 197         int gpiod_get_direction(const struct gpio_desc *desc)
 198
 199 This function returns 0 for output, 1 for input, or an error code in case of error.
 200
 201 Be aware that there is no default direction for GPIOs. Therefore, **using a GPIO
 202 without setting its direction first is illegal and will result in undefined
 203 behavior!**
 204
 205
 206 Spinlock-Safe GPIO Access
 207 -------------------------
 208 Most GPIO controllers can be accessed with memory read/write instructions. Those
 209 don't need to sleep, and can safely be done from inside hard (non-threaded) IRQ
 210 handlers and similar contexts.
 211
 212 Use the following calls to access GPIOs from an atomic context::
 213
 214         int gpiod_get_value(const struct gpio_desc *desc);
 215         void gpiod_set_value(struct gpio_desc *desc, int value);
 216
 217 The values are boolean, zero for low, nonzero for high. When reading the value
 218 of an output pin, the value returned should be what's seen on the pin. That
 219 won't always match the specified output value, because of issues including
 220 open-drain signaling and output latencies.
 221
 222 The get/set calls do not return errors because "invalid GPIO" should have been
 223 reported earlier from gpiod_direction_*(). However, note that not all platforms
 224 can read the value of output pins; those that can't should always return zero.
 225 Also, using these calls for GPIOs that can't safely be accessed without sleeping
 226 (see below) is an error.
 227
 228
 229 GPIO Access That May Sleep
 230 --------------------------
 231 Some GPIO controllers must be accessed using message based buses like I2C or
 232 SPI. Commands to read or write those GPIO values require waiting to get to the
 233 head of a queue to transmit a command and get its response. This requires
 234 sleeping, which can't be done from inside IRQ handlers.
 235
 236 Platforms that support this type of GPIO distinguish them from other GPIOs by
 237 returning nonzero from this call::
 238
 239         int gpiod_cansleep(const struct gpio_desc *desc)
 240
 241 To access such GPIOs, a different set of accessors is defined::
 242
 243         int gpiod_get_value_cansleep(const struct gpio_desc *desc)
 244         void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
 245
 246 Accessing such GPIOs requires a context which may sleep, for example a threaded
 247 IRQ handler, and those accessors must be used instead of spinlock-safe
 248 accessors without the cansleep() name suffix.
 249
 250 Other than the fact that these accessors might sleep, and will work on GPIOs
 251 that can't be accessed from hardIRQ handlers, these calls act the same as the
 252 spinlock-safe calls.
 253
 254
 255 The active low and open drain semantics
 256 ---------------------------------------
 257 As a consumer should not have to care about the physical line level, all of the
 258 gpiod_set_value_xxx() or gpiod_set_array_value_xxx() functions operate with
 259 the *logical* value. With this they take the active low property into account.
 260 This means that they check whether the GPIO is configured to be active low,
 261 and if so, they manipulate the passed value before the physical line level is
 262 driven.
 263
 264 The same is applicable for open drain or open source output lines: those do not
 265 actively drive their output high (open drain) or low (open source), they just
 266 switch their output to a high impedance value. The consumer should not need to
 267 care. (For details read about open drain in driver.txt.)
 268
 269 With this, all the gpiod_set_(array)_value_xxx() functions interpret the
 270 parameter "value" as "asserted" ("1") or "de-asserted" ("0"). The physical line
 271 level will be driven accordingly.
 272
 273 As an example, if the active low property for a dedicated GPIO is set, and the
 274 gpiod_set_(array)_value_xxx() passes "asserted" ("1"), the physical line level
 275 will be driven low.
 276
 277 To summarize::
 278
 279   Function (example)                 line property          physical line
 280   gpiod_set_raw_value(desc, 0);      don't care             low
 281   gpiod_set_raw_value(desc, 1);      don't care             high
 282   gpiod_set_value(desc, 0);          default (active high)  low
 283   gpiod_set_value(desc, 1);          default (active high)  high
 284   gpiod_set_value(desc, 0);          active low             high
 285   gpiod_set_value(desc, 1);          active low             low
 286   gpiod_set_value(desc, 0);          open drain             low
 287   gpiod_set_value(desc, 1);          open drain             high impedance
 288   gpiod_set_value(desc, 0);          open source            high impedance
 289   gpiod_set_value(desc, 1);          open source            high
 290
 291 It is possible to override these semantics using the set_raw/get_raw functions
 292 but it should be avoided as much as possible, especially by system-agnostic drivers
 293 which should not need to care about the actual physical line level and worry about
 294 the logical value instead.
 295
 296
 297 Accessing raw GPIO values
 298 -------------------------
 299 Consumers exist that need to manage the logical state of a GPIO line, i.e. the value
 300 their device will actually receive, no matter what lies between it and the GPIO
 301 line.
 302
 303 The following set of calls ignore the active-low or open drain property of a GPIO and
 304 work on the raw line value::
 305
 306         int gpiod_get_raw_value(const struct gpio_desc *desc)
 307         void gpiod_set_raw_value(struct gpio_desc *desc, int value)
 308         int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
 309         void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
 310         int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
 311
 312 The active low state of a GPIO can also be queried using the following call::
 313
 314         int gpiod_is_active_low(const struct gpio_desc *desc)
 315
 316 Note that these functions should only be used with great moderation; a driver
 317 should not have to care about the physical line level or open drain semantics.
 318
 319
 320 Access multiple GPIOs with a single function call
 321 -------------------------------------------------
 322 The following functions get or set the values of an array of GPIOs::
 323
 324         int gpiod_get_array_value(unsigned int array_size,
 325                                   struct gpio_desc **desc_array,
 326                                   struct gpio_array *array_info,
 327                                   unsigned long *value_bitmap);
 328         int gpiod_get_raw_array_value(unsigned int array_size,
 329                                       struct gpio_desc **desc_array,
 330                                       struct gpio_array *array_info,
 331                                       unsigned long *value_bitmap);
 332         int gpiod_get_array_value_cansleep(unsigned int array_size,
 333                                            struct gpio_desc **desc_array,
 334                                            struct gpio_array *array_info,
 335                                            unsigned long *value_bitmap);
 336         int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
 337                                            struct gpio_desc **desc_array,
 338                                            struct gpio_array *array_info,
 339                                            unsigned long *value_bitmap);
 340
 341         int gpiod_set_array_value(unsigned int array_size,
 342                                   struct gpio_desc **desc_array,
 343                                   struct gpio_array *array_info,
 344                                   unsigned long *value_bitmap)
 345         int gpiod_set_raw_array_value(unsigned int array_size,
 346                                       struct gpio_desc **desc_array,
 347                                       struct gpio_array *array_info,
 348                                       unsigned long *value_bitmap)
 349         int gpiod_set_array_value_cansleep(unsigned int array_size,
 350                                            struct gpio_desc **desc_array,
 351                                            struct gpio_array *array_info,
 352                                            unsigned long *value_bitmap)
 353         int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
 354                                                struct gpio_desc **desc_array,
 355                                                struct gpio_array *array_info,
 356                                                unsigned long *value_bitmap)
 357
 358 The array can be an arbitrary set of GPIOs. The functions will try to access
 359 GPIOs belonging to the same bank or chip simultaneously if supported by the
 360 corresponding chip driver. In that case a significantly improved performance
 361 can be expected. If simultaneous access is not possible the GPIOs will be
 362 accessed sequentially.
 363
 364 The functions take three arguments:
 365         * array_size    - the number of array elements
 366         * desc_array    - an array of GPIO descriptors
 367         * array_info    - optional information obtained from gpiod_get_array()
 368         * value_bitmap  - a bitmap to store the GPIOs' values (get) or
 369                           a bitmap of values to assign to the GPIOs (set)
 370
 371 The descriptor array can be obtained using the gpiod_get_array() function
 372 or one of its variants. If the group of descriptors returned by that function
 373 matches the desired group of GPIOs, those GPIOs can be accessed by simply using
 374 the struct gpio_descs returned by gpiod_get_array()::
 375
 376         struct gpio_descs *my_gpio_descs = gpiod_get_array(...);
 377         gpiod_set_array_value(my_gpio_descs->ndescs, my_gpio_descs->desc,
 378                               my_gpio_descs->info, my_gpio_value_bitmap);
 379
 380 It is also possible to access a completely arbitrary array of descriptors. The
 381 descriptors may be obtained using any combination of gpiod_get() and
 382 gpiod_get_array(). Afterwards the array of descriptors has to be setup
 383 manually before it can be passed to one of the above functions.  In that case,
 384 array_info should be set to NULL.
 385
 386 Note that for optimal performance GPIOs belonging to the same chip should be
 387 contiguous within the array of descriptors.
 388
 389 Still better performance may be achieved if array indexes of the descriptors
 390 match hardware pin numbers of a single chip.  If an array passed to a get/set
 391 array function matches the one obtained from gpiod_get_array() and array_info
 392 associated with the array is also passed, the function may take a fast bitmap
 393 processing path, passing the value_bitmap argument directly to the respective
 394 .get/set_multiple() callback of the chip.  That allows for utilization of GPIO
 395 banks as data I/O ports without much loss of performance.
 396
 397 The return value of gpiod_get_array_value() and its variants is 0 on success
 398 or negative on error. Note the difference to gpiod_get_value(), which returns
 399 0 or 1 on success to convey the GPIO value. With the array functions, the GPIO
 400 values are stored in value_array rather than passed back as return value.
 401
 402
 403 GPIOs mapped to IRQs
 404 --------------------
 405 GPIO lines can quite often be used as IRQs. You can get the IRQ number
 406 corresponding to a given GPIO using the following call::
 407
 408         int gpiod_to_irq(const struct gpio_desc *desc)
 409
 410 It will return an IRQ number, or a negative errno code if the mapping can't be
 411 done (most likely because that particular GPIO cannot be used as IRQ). It is an
 412 unchecked error to use a GPIO that wasn't set up as an input using
 413 gpiod_direction_input(), or to use an IRQ number that didn't originally come
 414 from gpiod_to_irq(). gpiod_to_irq() is not allowed to sleep.
 415
 416 Non-error values returned from gpiod_to_irq() can be passed to request_irq() or
 417 free_irq(). They will often be stored into IRQ resources for platform devices,
 418 by the board-specific initialization code. Note that IRQ trigger options are
 419 part of the IRQ interface, e.g. IRQF_TRIGGER_FALLING, as are system wakeup
 420 capabilities.
 421
 422
 423 GPIOs and ACPI
 424 ==============
 425
 426 On ACPI systems, GPIOs are described by GpioIo()/GpioInt() resources listed by
 427 the _CRS configuration objects of devices.  Those resources do not provide
 428 connection IDs (names) for GPIOs, so it is necessary to use an additional
 429 mechanism for this purpose.
 430
 431 Systems compliant with ACPI 5.1 or newer may provide a _DSD configuration object
 432 which, among other things, may be used to provide connection IDs for specific
 433 GPIOs described by the GpioIo()/GpioInt() resources in _CRS.  If that is the
 434 case, it will be handled by the GPIO subsystem automatically.  However, if the
 435 _DSD is not present, the mappings between GpioIo()/GpioInt() resources and GPIO
 436 connection IDs need to be provided by device drivers.
 437
 438 For details refer to Documentation/firmware-guide/acpi/gpio-properties.rst
 439
 440
 441 Interacting With the Legacy GPIO Subsystem
 442 ==========================================
 443 Many kernel subsystems and drivers still handle GPIOs using the legacy
 444 integer-based interface. It is strongly recommended to update these to the new
 445 gpiod interface. For cases where both interfaces need to be used, the following
 446 two functions allow to convert a GPIO descriptor into the GPIO integer namespace
 447 and vice-versa::
 448
 449         int desc_to_gpio(const struct gpio_desc *desc)
 450         struct gpio_desc *gpio_to_desc(unsigned gpio)
 451
 452 The GPIO number returned by desc_to_gpio() can safely be used as a parameter of
 453 the gpio\_*() functions for as long as the GPIO descriptor `desc` is not freed.
 454 All the same, a GPIO number passed to gpio_to_desc() must first be properly
 455 acquired using e.g. gpio_request_one(), and the returned GPIO descriptor is only
 456 considered valid until that GPIO number is released using gpio_free().
 457
 458 Freeing a GPIO obtained by one API with the other API is forbidden and an
 459 unchecked error.