driver-api/gpio/consumer.rst

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.
10 Guidelines for GPIOs consumers
15 obtain and use GPIOs are available by including the following file:
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 All the functions that work with the descriptor-based GPIO interface are
40 Obtaining and Disposing GPIOs
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
52 If a function is implemented by using several GPIOs together (e.g. a simple LED
56 					  const char *con_id, unsigned int idx,
60 see Documentation/driver-api/gpio/board.rst
81 with IS_ERR() (they will never return a NULL pointer). -ENOENT will be returned
88 instead of -ENOENT if no GPIO has been assigned to the requested function::
96 						   unsigned int index,
102 -ENOSYS return codes.  System integrators should however be careful to enable
105 For a function using multiple GPIOs all of those can be obtained with one call::
117 		unsigned int ndescs;
121 The following function returns NULL instead of -ENOENT if no GPIOs have been
128 Device-managed variants of these functions are also defined::
135 					       unsigned int idx,
144 							unsigned int index,
159 For an array of GPIOs this function can be used::
167 The device-managed variants are, unsurprisingly::
174 Using GPIOs
178 -----------------
180 direction-setting flags have been given to gpiod_get*(), this is done by
183 	int gpiod_direction_input(struct gpio_desc *desc)
184 	int gpiod_direction_output(struct gpio_desc *desc, int value)
189 for spinlock-safe GPIOs it is OK to use them before tasking is enabled, as part
192 For output GPIOs, the value provided becomes the initial output value. This
197 	int gpiod_get_direction(const struct gpio_desc *desc)
201 Be aware that there is no default direction for GPIOs. Therefore, **using a GPIO
206 Spinlock-Safe GPIO Access
207 -------------------------
209 don't need to sleep, and can safely be done from inside hard (non-threaded) IRQ
212 Use the following calls to access GPIOs from an atomic context::
214 	int gpiod_get_value(const struct gpio_desc *desc);
215 	void gpiod_set_value(struct gpio_desc *desc, int value);
220 open-drain signaling and output latencies.
225 Also, using these calls for GPIOs that can't safely be accessed without sleeping
230 --------------------------
236 Platforms that support this type of GPIO distinguish them from other GPIOs by
239 	int gpiod_cansleep(const struct gpio_desc *desc)
241 To access such GPIOs, a different set of accessors is defined::
243 	int gpiod_get_value_cansleep(const struct gpio_desc *desc)
244 	void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
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
250 Other than the fact that these accessors might sleep, and will work on GPIOs
252 spinlock-safe calls.
256 ---------------------------------------
270 parameter "value" as "asserted" ("1") or "de-asserted" ("0"). The physical line
292 but it should be avoided as much as possible, especially by system-agnostic drivers
298 -------------------------
303 The following set of calls ignore the active-low or open drain property of a GPIO and
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)
314 	int gpiod_is_active_low(const struct gpio_desc *desc)
320 Access multiple GPIOs with a single function call
321 -------------------------------------------------
322 The following functions get or set the values of an array of GPIOs::
324 	int gpiod_get_array_value(unsigned int array_size,
328 	int gpiod_get_raw_array_value(unsigned int array_size,
332 	int gpiod_get_array_value_cansleep(unsigned int array_size,
336 	int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
341 	int gpiod_set_array_value(unsigned int array_size,
345 	int gpiod_set_raw_array_value(unsigned int array_size,
349 	int gpiod_set_array_value_cansleep(unsigned int array_size,
353 	int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
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
361 can be expected. If simultaneous access is not possible the GPIOs will be
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)
373 matches the desired group of GPIOs, those GPIOs can be accessed by simply using
377 	gpiod_set_array_value(my_gpio_descs->ndescs, my_gpio_descs->desc,
378 			      my_gpio_descs->info, my_gpio_value_bitmap);
386 Note that for optimal performance GPIOs belonging to the same chip should be
403 GPIOs mapped to IRQs
404 --------------------
408 	int gpiod_to_irq(const struct gpio_desc *desc)
416 Non-error values returned from gpiod_to_irq() can be passed to request_irq() or
418 by the board-specific initialization code. Note that IRQ trigger options are
423 GPIOs and ACPI
426 On ACPI systems, GPIOs are described by GpioIo()/GpioInt() resources listed by
428 connection IDs (names) for GPIOs, so it is necessary to use an additional
433 GPIOs described by the GpioIo()/GpioInt() resources in _CRS.  If that is the
438 For details refer to Documentation/firmware-guide/acpi/gpio-properties.rst
443 Many kernel subsystems still handle GPIOs using the legacy integer-based
445 descriptor-based API, the following two functions allow you to convert a GPIO
446 descriptor into the GPIO integer namespace and vice-versa::
448 	int desc_to_gpio(const struct gpio_desc *desc)