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
67 	 * If non-NULL, will be set as the parent of this GPIO interrupt
79 	 * hardware IRQs correspond to the GPIO index 0..ngpio-1 (see the
87 	 * HWIRQ, return -EINVAL, but also make sure to fill in @valid_mask and
102 	 * &gpiochip_populate_parent_fwspec_twocell will be used. A four-cell
173 	 * Data associated, and passed to, the handler for the parent
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
237 	 * @first:
242 	unsigned int first;  member
249 	void		(*irq_enable)(struct irq_data *data);
256 	void		(*irq_disable)(struct irq_data *data);
262 	void		(*irq_unmask)(struct irq_data *data);
269 	void		(*irq_mask)(struct irq_data *data);
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.
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
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
342  * @reg_dat: data (in) register for generic GPIO
351  * @bgpio_lock: used to lock chip->bgpio_data. Also, this is needed to keep
352  *	shadowed and real data registers writes together.
353  * @bgpio_data:	shadowed data register for generic GPIO to clear/set bits
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
417 	void (*write_reg)(void __iomem *reg, unsigned long data);
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
495  * @base:	first GPIO in the range
496  * @size:	amount of GPIOs to check starting from @base
505 	for_each_requested_gpio_in_range(chip, i, 0, chip->ngpio, label)
508 extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
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.
536 #define gpiochip_add_data(gc, data) ({		\  argument
539 		gpiochip_add_data_with_key(gc, data, &lock_key, \
542 #define devm_gpiochip_add_data(dev, gc, data) ({ \  argument
545 		devm_gpiochip_add_data_with_key(dev, gc, data, &lock_key, \
549 #define gpiochip_add_data(gc, data) gpiochip_add_data_with_key(gc, data, NULL, NULL)  argument
550 #define devm_gpiochip_add_data(dev, gc, data) \  argument
551 	devm_gpiochip_add_data_with_key(dev, gc, data, NULL, NULL)
559 extern int devm_gpiochip_add_data_with_key(struct device *dev, struct gpio_chip *gc, void *data,
563 extern struct gpio_chip *gpiochip_find(void *data,
564 			      int (*match)(struct gpio_chip *gc, void *data));
580 /* get driver data */
634 				 struct irq_data *data, bool reserve);
636 				    struct irq_data *data);
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()