Lines Matching +full:enum +full:- +full:as +full:- +full:flags
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.
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
31 be met with console warnings that may be perceived as intimidating.
33 All the functions that work with the descriptor-based GPIO interface are
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
50 enum gpiod_flags flags)
57 enum gpiod_flags flags)
60 see Documentation/driver-api/gpio/board.rst
62 The flags parameter is used to optionally specify a direction and initial value
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
72 * GPIOD_OUT_HIGH_OPEN_DRAIN same as GPIOD_OUT_HIGH but also enforce the line
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
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::
92 enum gpiod_flags flags)
97 enum gpiod_flags flags)
102 -ENOSYS return codes. System integrators should however be careful to enable
109 enum gpiod_flags flags)
121 The following function returns NULL instead of -ENOENT if no GPIOs have been
126 enum gpiod_flags flags)
128 Device-managed variants of these functions are also defined::
131 enum gpiod_flags flags)
136 enum gpiod_flags flags)
140 enum gpiod_flags flags)
145 enum gpiod_flags flags)
149 enum gpiod_flags flags)
153 enum gpiod_flags flags)
167 The device-managed variants are, unsurprisingly::
178 -----------------
180 direction-setting flags have been given to gpiod_get*(), this is done by
189 for spinlock-safe GPIOs it is OK to use them before tasking is enabled, as part
206 Spinlock-Safe GPIO Access
207 -------------------------
209 don't need to sleep, and can safely be done from inside hard (non-threaded) IRQ
220 open-drain signaling and output latencies.
230 --------------------------
247 IRQ handler, and those accessors must be used instead of spinlock-safe
251 that can't be accessed from hardIRQ handlers, these calls act the same as the
252 spinlock-safe calls.
256 ---------------------------------------
257 As a consumer should not have to care about the physical line level, all of the
270 parameter "value" as "asserted" ("1") or "de-asserted" ("0"). The physical line
273 As an example, if the active low property for a dedicated GPIO is set, and the
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
321 -------------------------------------------------
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
377 gpiod_set_array_value(my_gpio_descs->ndescs, my_gpio_descs->desc,
378 my_gpio_descs->info, my_gpio_value_bitmap);
395 banks as data I/O ports without much loss of performance.
400 values are stored in value_array rather than passed back as return value.
404 --------------------
405 GPIO lines can quite often be used as IRQs. You can get the IRQ number
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
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
419 part of the IRQ interface, e.g. IRQF_TRIGGER_FALLING, as are system wakeup
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::
451 The GPIO number returned by desc_to_gpio() can be safely used as long as the