driver-api/gpio/consumer.rst

2 GPIO Descriptor Consumer Interface
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 legacy.rst.
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
17 	#include <linux/gpio/consumer.h>
23 - Simple compile coverage with e.g. COMPILE_TEST - it does not matter that
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
33   ``[devm_]gpiod_get_optional()`` is a *bad idea*, and will result in weird
37 All the functions that work with the descriptor-based GPIO interface are
41 <linux/gpio/consumer.h> and descriptors exclusively.
47 With the descriptor-based interface, GPIOs are identified with an opaque,
48 non-forgeable handler that must be obtained through a call to one of the
50 device that will use the GPIO and the function the requested GPIO is supposed to
56 If a function is implemented by using several GPIOs together (e.g. a simple LED
63 For a more detailed description of the con_id parameter in the DeviceTree case
64 see Documentation/driver-api/gpio/board.rst
66 The flags parameter is used to optionally specify a direction and initial value
67 for the GPIO. Values can be:
69 * GPIOD_ASIS or 0 to not initialize the GPIO at all. The direction must be set
71 * GPIOD_IN to initialize the GPIO as input.
72 * GPIOD_OUT_LOW to initialize the GPIO as output with a value of 0.
73 * GPIOD_OUT_HIGH to initialize the GPIO as output with a value of 1.
85 (see board.rst), then open drain will be enforced anyway and a warning will be
88 Both functions return either a valid GPIO descriptor, or an error code checkable
89 with IS_ERR() (they will never return a NULL pointer). -ENOENT will be returned
90 if and only if no GPIO has been assigned to the device/function/index triplet,
91 other error codes are used for cases where a GPIO has been assigned but an error
93 errors and an absence of GPIO for optional GPIO parameters. For the common
94 pattern where a GPIO is optional, the gpiod_get_optional() and
96 instead of -ENOENT if no GPIO has been assigned to the requested function::
110 -ENOSYS return codes.  System integrators should however be careful to enable
113 For a function using multiple GPIOs all of those can be obtained with one call::
119 This function returns a struct gpio_descs which contains an array of
120 descriptors.  It also contains a pointer to a gpiolib private structure which,
129 The following function returns NULL instead of -ENOENT if no GPIOs have been
136 Device-managed variants of these functions are also defined::
163 A GPIO descriptor can be disposed of using the gpiod_put() function::
171 It is strictly forbidden to use a descriptor after calling these functions.
175 The device-managed variants are, unsurprisingly::
186 -----------------
187 The first thing a driver must do with a GPIO is setting its direction. If no
188 direction-setting flags have been given to gpiod_get*(), this is done by
194 The return value is zero for success, else a negative errno. It should be
196 is possible. You should normally issue these calls from a task context. However,
197 for spinlock-safe GPIOs it is OK to use them before tasking is enabled, as part
203 A driver can also query the current direction of a GPIO::
209 Be aware that there is no default direction for GPIOs. Therefore, **using a GPIO
214 Spinlock-Safe GPIO Access
215 -------------------------
216 Most GPIO controllers can be accessed with memory read/write instructions. Those
217 don't need to sleep, and can safely be done from inside hard (non-threaded) IRQ
228 open-drain signaling and output latencies.
230 The get/set calls do not return errors because "invalid GPIO" should have been
237 GPIO Access That May Sleep
238 --------------------------
239 Some GPIO controllers must be accessed using message based buses like I2C or
240 SPI. Commands to read or write those GPIO values require waiting to get to the
241 head of a queue to transmit a command and get its response. This requires
244 Platforms that support this type of GPIO distinguish them from other GPIOs by
249 To access such GPIOs, a different set of accessors is defined::
254 Accessing such GPIOs requires a context which may sleep, for example a threaded
255 IRQ handler, and those accessors must be used instead of spinlock-safe
260 spinlock-safe calls.
266 ---------------------------------------
267 As a consumer should not have to care about the physical line level, all of the
270 This means that they check whether the GPIO is configured to be active low,
276 switch their output to a high impedance value. The consumer should not need to
280 parameter "value" as "asserted" ("1") or "de-asserted" ("0"). The physical line
283 As an example, if the active low property for a dedicated GPIO is set, and the
302 but it should be avoided as much as possible, especially by system-agnostic drivers
307 Accessing raw GPIO values
308 -------------------------
309 Consumers exist that need to manage the logical state of a GPIO line, i.e. the value
310 their device will actually receive, no matter what lies between it and the GPIO
313 The following set of calls ignore the active-low or open drain property of a GPIO and
322 The active low state of a GPIO can also be queried and toggled using the
328 Note that these functions should only be used with great moderation; a driver
332 Access multiple GPIOs with a single function call
333 -------------------------------------------------
372 corresponding chip driver. In that case a significantly improved performance
378 	* array_size	- the number of array elements
379 	* desc_array	- an array of GPIO descriptors
380 	* array_info	- optional information obtained from gpiod_get_array()
381 	* value_bitmap	- a bitmap to store the GPIOs' values (get) or
382           a bitmap of values to assign to the GPIOs (set)
390 	gpiod_set_array_value(my_gpio_descs->ndescs, my_gpio_descs->desc,
391 			      my_gpio_descs->info, my_gpio_value_bitmap);
393 It is also possible to access a completely arbitrary array of descriptors. The
403 match hardware pin numbers of a single chip.  If an array passed to a get/set
405 associated with the array is also passed, the function may take a fast bitmap
407 .get/set_multiple() callback of the chip.  That allows for utilization of GPIO
412 0 or 1 on success to convey the GPIO value. With the array functions, the GPIO
417 --------------------
418 GPIO lines can quite often be used as IRQs. You can get the IRQ number
419 corresponding to a given GPIO using the following call::
423 It will return an IRQ number, or a negative errno code if the mapping can't be
424 done (most likely because that particular GPIO cannot be used as IRQ). It is an
425 unchecked error to use a GPIO that wasn't set up as an input using
429 Non-error values returned from gpiod_to_irq() can be passed to request_irq() or
431 by the board-specific initialization code. Note that IRQ trigger options are
444 Systems compliant with ACPI 5.1 or newer may provide a _DSD configuration object
447 case, it will be handled by the GPIO subsystem automatically.  However, if the
448 _DSD is not present, the mappings between GpioIo()/GpioInt() resources and GPIO
451 For details refer to Documentation/firmware-guide/acpi/gpio-properties.rst
454 Interacting With the Legacy GPIO Subsystem
457 integer-based interface. It is strongly recommended to update these to the new
459 two functions allow to convert a GPIO descriptor into the GPIO integer namespace
460 and vice-versa::
463 	struct gpio_desc *gpio_to_desc(unsigned gpio)
465 The GPIO number returned by desc_to_gpio() can safely be used as a parameter of
466 the gpio\_*() functions for as long as the GPIO descriptor `desc` is not freed.
467 All the same, a GPIO number passed to gpio_to_desc() must first be properly
468 acquired using e.g. gpio_request_one(), and the returned GPIO descriptor is only
469 considered valid until that GPIO number is released using gpio_free().
471 Freeing a GPIO obtained by one API with the other API is forbidden and an