linux/gpio/driver.h

1 /* SPDX-License-Identifier: GPL-2.0 */
12 #include <linux/pinctrl/pinconf-generic.h>
30  * struct gpio_irq_chip - GPIO interrupt controller
43 	 * Interrupt translation domain; responsible for mapping between GPIO
51 	 * Table of interrupt domain operations for this IRQ chip.
67 	 * If non-NULL, will be set as the parent of this GPIO interrupt
68 	 * controller's IRQ domain to establish a hierarchical interrupt
70 	 * interrupt support.
77 	 * This callback translates a child hardware IRQ offset to a parent
78 	 * hardware IRQ offset on a hierarchical interrupt chip. The child
79 	 * hardware IRQs correspond to the GPIO index 0..ngpio-1 (see the
80 	 * ngpio field of struct gpio_chip) and the corresponding parent
86 	 * If some ranges of hardware IRQs do not have a corresponding parent
87 	 * HWIRQ, return -EINVAL, but also make sure to fill in @valid_mask and
101 	 * for the parent's IRQ domain. If this is not specified, then
102 	 * &gpiochip_populate_parent_fwspec_twocell will be used. A four-cell
165 	 * The interrupt handler for the GPIO chip's parent interrupts, may be
166 	 * NULL if the parent interrupts are nested rather than cascaded.
173 	 * Data associated, and passed to, the handler for the parent
174 	 * interrupt.
181 	 * The number of interrupt parents of a GPIO chip.
188 	 * A list of interrupt parents of a GPIO chip. This is owned by the
196 	 * A list of interrupt parents for each line of a GPIO chip.
203 	 * True if set the interrupt handling uses nested threads.
220 	 * bits from 0..(ngpios-1) set to "1" as in valid. The callback can
283  * struct gpio_chip - abstract a GPIO controller
285  *	number or the name of the SoC IP-block implementing it.
287  * @parent: optional parent device providing the GPIOs
289  * @request: optional hook for chip-specific activation, such as
291  * @free: optional hook for chip-specific deactivation, such as
296  *	function, even on input-only or output-only gpio chips.
298  *	This can be omitted on input-only or output-only gpio chips.
300  *	This can be omitted on input-only or output-only gpio chips.
308  * @to_irq: optional hook supporting non-static gpio_to_irq() mappings;
318  * @base: identifies the first GPIO number handled by this chip;
320  *	DEPRECATION: providing anything non-negative and nailing the base
321  *	offset of GPIO chips is deprecated. Please pass -1 as base to
322  *	let gpiolib select the chip base in all possible cases. We want to
325  *	handled is (base + ngpio - 1).
351  * @bgpio_lock: used to lock chip->bgpio_data. Also, this is needed to keep
365  * by "offset" values in the range 0..(@ngpio - 1).  When those signals
367  * is calculated by subtracting @base from the gpio number.
372 	struct device		*parent;  member
410 	int			base;  member
440 	 * Integrates interrupt chip functionality with the GPIO chip. Can be
477 	 * Callback to translate a device tree GPIO specifier into a chip-
492  * for_each_requested_gpio_in_range - iterates over requested GPIOs in a given range
495  * @base:	first GPIO in the range
496  * @size:	amount of GPIOs to check starting from @base
499 #define for_each_requested_gpio_in_range(chip, i, base, size, label)			\  argument
501 		if ((label = gpiochip_is_requested(chip, base + i)) == NULL) {} else
505 	for_each_requested_gpio_in_range(chip, i, 0, chip->ngpio, label)
513  * gpiochip_add_data() - register a gpio_chip
514  * @gc: the chip to register, with gc->base initialized
515  * @data: driver-private data associated with this chip
520  * can be freely used, the gc->parent device must be registered before
527  * If gc->base is negative, this requests dynamic assignment of
532  * gc->base is invalid or already associated with a different chip.
585 	int base;  member
662 	return -EINVAL;  in gpiochip_irqchip_add_domain()
730  * struct gpio_pin_range - pin range controlled by a gpio chip
797 	return ERR_PTR(-ENODEV);  in gpiod_to_chip()
804 	return -EINVAL;  in gpiochip_lock_as_irq()