linux/gpio/driver.h

1 /* SPDX-License-Identifier: GPL-2.0 */
7 #include <linux/irq.h>
12 #include <linux/pinctrl/pinconf-generic.h>
30  * struct gpio_irq_chip - GPIO interrupt controller
36 	 * GPIO IRQ chip implementation, provided by GPIO driver.
44 	 * hwirq number and Linux IRQ number.
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
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
81 	 * hardware IRQ and type (such as IRQ_TYPE_*) shall be returned by
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
114 	 * offset on the GPIO chip to an IRQ number for the GPIO to_irq()
124 	 * The IRQ domain operations that will be used for this GPIO IRQ
126 	 * be populated to setup the IRQ hierarchy. Some drivers need to
135 	 * The IRQ handler to use (often a predefined IRQ core function) for
143 	 * Default IRQ triggering type applied during GPIO driver
151 	 * Per GPIO IRQ chip lockdep class for IRQ lock.
158 	 * Per GPIO IRQ chip lockdep class for IRQ request.
209 	 * an IRQ chip will be added. This is quite useful when
210 	 * a particular driver wants to clear IRQ related registers
220 	 * bits from 0..(ngpios-1) set to "1" as in valid. The callback can
231 	 * If not %NULL holds bitmask of GPIOs which are valid to be included
232 	 * in IRQ domain of the chip.
239 	 * Required for static IRQ allocation. If set, irq_domain_add_simple()
274 	 * Flag to track GPIO chip irq member's initialization.
275 	 * This flag will make sure GPIO chip irq members are not used
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
288  * @owner: helps prevent removal of modules exporting active 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;
314  *	not all GPIOs are valid.
317  *	It is called after adding GPIO chip and before adding IRQ chip.
320  *	DEPRECATION: providing anything non-negative and nailing the base
321  *	offset of GPIO chips is deprecated. Please pass -1 as base to
324  * @ngpio: the number of GPIOs handled by this controller; the last GPIO
325  *	handled is (base + ngpio - 1).
327  *      names for the GPIOs in this chip. Any entry in the array
335  *	as the chip access may sleep when e.g. reading out the IRQ status
351  * @bgpio_lock: used to lock chip->bgpio_data. Also, this is needed to keep
359  * A gpio_chip can help platforms abstract various sources of GPIOs so
365  * by "offset" values in the range 0..(@ngpio - 1).  When those signals
438 	 * @irq:
443 	struct gpio_irq_chip irq;  member
449 	 * If not %NULL holds bitmask of GPIOs which are valid to be used
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
496  * @size:	amount of GPIOs to check starting from @base
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
519  * When gpiochip_add_data() is called very early during boot, so that GPIOs
520  * can be freely used, the gc->parent device must be registered before
522  * for GPIOs will fail rudely.
527  * If gc->base is negative, this requests dynamic assignment of
528  * a range of valid GPIOs.
532  * gc->base is invalid or already associated with a different chip.
629 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
631 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq);
662 	return -EINVAL;  in gpiochip_irqchip_add_domain()
730  * struct gpio_pin_range - pin range controlled by a gpio chip
784 /* lock/unlock as IRQ */
797 	return ERR_PTR(-ENODEV);  in gpiod_to_chip()
804 	return -EINVAL;  in gpiochip_lock_as_irq()