linux/gpio/driver.h

1 /* SPDX-License-Identifier: GPL-2.0 */
12 #include <linux/pinctrl/pinconf-generic.h>
48  * struct gpio_irq_chip - GPIO interrupt controller
61 	 * Interrupt translation domain; responsible for mapping between GPIO
78 	 * If non-NULL, will be set as the parent of this GPIO interrupt
79 	 * controller's IRQ domain to establish a hierarchical interrupt
81 	 * interrupt support.
88 	 * This callback translates a child hardware IRQ offset to a parent
89 	 * hardware IRQ offset on a hierarchical interrupt chip. The child
90 	 * hardware IRQs correspond to the GPIO index 0..ngpio-1 (see the
91 	 * ngpio field of struct gpio_chip) and the corresponding parent
97 	 * If some ranges of hardware IRQs do not have a corresponding parent
98 	 * HWIRQ, return -EINVAL, but also make sure to fill in @valid_mask and
112 	 * for the parent's IRQ domain. If this is not specified, then
113 	 * &gpiochip_populate_parent_fwspec_twocell will be used. A four-cell
177 	 * The interrupt handler for the GPIO chip's parent interrupts, may be
178 	 * NULL if the parent interrupts are nested rather than cascaded.
188 		 * parent interrupt.
197 		 * different data for each parent. This cannot be NULL if
206 	 * The number of interrupt parents of a GPIO chip.
213 	 * A list of interrupt parents of a GPIO chip. This is owned by the
221 	 * A list of interrupt parents for each line of a GPIO chip.
228 	 * True if set the interrupt handling uses nested threads.
236 	 * sized array to be used as parent data.
270 	 * bits from 0..(ngpios-1) set to "1" as in valid. The callback can
323  * struct gpio_chip - abstract a GPIO controller
325  *	number or the name of the SoC IP-block implementing it.
327  * @parent: optional parent device providing the GPIOs
330  * @request: optional hook for chip-specific activation, such as
332  * @free: optional hook for chip-specific deactivation, such as
337  *	function, even on input-only or output-only gpio chips.
339  *	or a negative error number. This can be omitted on input-only or
340  *	output-only gpio chips.
342  *	success or a negative error number. This can be omitted on input-only
343  *	or output-only gpio chips.
351  * @to_irq: optional hook supporting non-static gpiod_to_irq() mappings;
365  * @base: identifies the first GPIO number handled by this chip;
367  *	DEPRECATION: providing anything non-negative and nailing the base
368  *	offset of GPIO chips is deprecated. Please pass -1 as base to
369  *	let gpiolib select the chip base in all possible cases. We want to
372  *	handled is (base + ngpio - 1).
399  * @bgpio_lock: used to lock chip->bgpio_data. Also, this is needed to keep
413  * by "offset" values in the range 0..(@ngpio - 1).  When those signals
415  * is calculated by subtracting @base from the gpio number.
420 	struct device		*parent;  member
465 	int			base;  member
496 	 * Integrates interrupt chip functionality with the GPIO chip. Can be
526 	 * Callback to translate a device tree GPIO specifier into a chip-
553  * for_each_hwgpio - Iterates over all GPIOs for given chip.
561 	     *_data.i < _chip->ngpio; \
568  * for_each_requested_gpio_in_range - iterates over requested GPIOs in a given range
572  * @_size:	amount of GPIOs to check starting from @base
586 	for_each_requested_gpio_in_range(chip, i, 0, chip->ngpio, label)
594  * gpiochip_add_data() - register a gpio_chip
595  * @gc: the chip to register, with gc->base initialized
596  * @data: driver-private data associated with this chip
601  * can be freely used, the gc->parent device must be registered before
608  * If gc->base is negative, this requests dynamic assignment of
613  * gc->base is invalid or already associated with a different chip.
671 	girq->chip = (struct irq_chip *)chip;  in gpio_irq_chip_set_chip()
687 	int base;  member
728 	return -EINVAL;  in gpiochip_irqchip_add_domain()
738  * struct gpio_pin_range - pin range controlled by a gpio chip
819 	return ERR_PTR(-ENODEV);  in gpiod_to_chip()
825 	return ERR_PTR(-ENODEV);  in gpiod_to_gpio_device()
831 	return -ENODEV;  in gpio_device_get_base()
856 	return -EINVAL;  in gpiochip_lock_as_irq()
868 		if (!fwnode_property_present(child, "gpio-controller")) {} else