xref: /openbmc/linux/include/linux/gpio/driver.h (revision ae0755b5)
1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
279a9becdSAlexandre Courbot #ifndef __LINUX_GPIO_DRIVER_H
379a9becdSAlexandre Courbot #define __LINUX_GPIO_DRIVER_H
479a9becdSAlexandre Courbot 
5ff2b1359SLinus Walleij #include <linux/device.h>
679a9becdSAlexandre Courbot #include <linux/types.h>
714250520SLinus Walleij #include <linux/irq.h>
814250520SLinus Walleij #include <linux/irqchip/chained_irq.h>
914250520SLinus Walleij #include <linux/irqdomain.h>
10a0a8bcf4SGrygorii Strashko #include <linux/lockdep.h>
11964cb341SLinus Walleij #include <linux/pinctrl/pinctrl.h>
122956b5d9SMika Westerberg #include <linux/pinctrl/pinconf-generic.h>
1379a9becdSAlexandre Courbot 
1479a9becdSAlexandre Courbot struct gpio_desc;
15c9a9972bSAlexandre Courbot struct of_phandle_args;
16c9a9972bSAlexandre Courbot struct device_node;
17f3ed0b66SStephen Rothwell struct seq_file;
18ff2b1359SLinus Walleij struct gpio_device;
19d47529b2SPaul Gortmaker struct module;
2021abf103SLinus Walleij enum gpiod_flags;
215923ea6cSLinus Walleij enum gpio_lookup_flags;
2279a9becdSAlexandre Courbot 
23fdd61a01SLinus Walleij struct gpio_chip;
24fdd61a01SLinus Walleij 
25c44eafd7SThierry Reding /**
26c44eafd7SThierry Reding  * struct gpio_irq_chip - GPIO interrupt controller
27c44eafd7SThierry Reding  */
28c44eafd7SThierry Reding struct gpio_irq_chip {
29c44eafd7SThierry Reding 	/**
30da80ff81SThierry Reding 	 * @chip:
31da80ff81SThierry Reding 	 *
32da80ff81SThierry Reding 	 * GPIO IRQ chip implementation, provided by GPIO driver.
33da80ff81SThierry Reding 	 */
34da80ff81SThierry Reding 	struct irq_chip *chip;
35da80ff81SThierry Reding 
36da80ff81SThierry Reding 	/**
37f0fbe7bcSThierry Reding 	 * @domain:
38f0fbe7bcSThierry Reding 	 *
39f0fbe7bcSThierry Reding 	 * Interrupt translation domain; responsible for mapping between GPIO
40f0fbe7bcSThierry Reding 	 * hwirq number and Linux IRQ number.
41f0fbe7bcSThierry Reding 	 */
42f0fbe7bcSThierry Reding 	struct irq_domain *domain;
43f0fbe7bcSThierry Reding 
44f0fbe7bcSThierry Reding 	/**
45c44eafd7SThierry Reding 	 * @domain_ops:
46c44eafd7SThierry Reding 	 *
47c44eafd7SThierry Reding 	 * Table of interrupt domain operations for this IRQ chip.
48c44eafd7SThierry Reding 	 */
49c44eafd7SThierry Reding 	const struct irq_domain_ops *domain_ops;
50c44eafd7SThierry Reding 
51fdd61a01SLinus Walleij #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
52fdd61a01SLinus Walleij 	/**
53fdd61a01SLinus Walleij 	 * @fwnode:
54fdd61a01SLinus Walleij 	 *
55fdd61a01SLinus Walleij 	 * Firmware node corresponding to this gpiochip/irqchip, necessary
56fdd61a01SLinus Walleij 	 * for hierarchical irqdomain support.
57fdd61a01SLinus Walleij 	 */
58fdd61a01SLinus Walleij 	struct fwnode_handle *fwnode;
59fdd61a01SLinus Walleij 
60fdd61a01SLinus Walleij 	/**
61fdd61a01SLinus Walleij 	 * @parent_domain:
62fdd61a01SLinus Walleij 	 *
63fdd61a01SLinus Walleij 	 * If non-NULL, will be set as the parent of this GPIO interrupt
64fdd61a01SLinus Walleij 	 * controller's IRQ domain to establish a hierarchical interrupt
65fdd61a01SLinus Walleij 	 * domain. The presence of this will activate the hierarchical
66fdd61a01SLinus Walleij 	 * interrupt support.
67fdd61a01SLinus Walleij 	 */
68fdd61a01SLinus Walleij 	struct irq_domain *parent_domain;
69fdd61a01SLinus Walleij 
70fdd61a01SLinus Walleij 	/**
71fdd61a01SLinus Walleij 	 * @child_to_parent_hwirq:
72fdd61a01SLinus Walleij 	 *
73fdd61a01SLinus Walleij 	 * This callback translates a child hardware IRQ offset to a parent
74fdd61a01SLinus Walleij 	 * hardware IRQ offset on a hierarchical interrupt chip. The child
75fdd61a01SLinus Walleij 	 * hardware IRQs correspond to the GPIO index 0..ngpio-1 (see the
76fdd61a01SLinus Walleij 	 * ngpio field of struct gpio_chip) and the corresponding parent
77fdd61a01SLinus Walleij 	 * hardware IRQ and type (such as IRQ_TYPE_*) shall be returned by
78fdd61a01SLinus Walleij 	 * the driver. The driver can calculate this from an offset or using
79fdd61a01SLinus Walleij 	 * a lookup table or whatever method is best for this chip. Return
80fdd61a01SLinus Walleij 	 * 0 on successful translation in the driver.
81fdd61a01SLinus Walleij 	 *
82fdd61a01SLinus Walleij 	 * If some ranges of hardware IRQs do not have a corresponding parent
83fdd61a01SLinus Walleij 	 * HWIRQ, return -EINVAL, but also make sure to fill in @valid_mask and
84fdd61a01SLinus Walleij 	 * @need_valid_mask to make these GPIO lines unavailable for
85fdd61a01SLinus Walleij 	 * translation.
86fdd61a01SLinus Walleij 	 */
87fdd61a01SLinus Walleij 	int (*child_to_parent_hwirq)(struct gpio_chip *chip,
88fdd61a01SLinus Walleij 				     unsigned int child_hwirq,
89fdd61a01SLinus Walleij 				     unsigned int child_type,
90fdd61a01SLinus Walleij 				     unsigned int *parent_hwirq,
91fdd61a01SLinus Walleij 				     unsigned int *parent_type);
92fdd61a01SLinus Walleij 
93fdd61a01SLinus Walleij 	/**
94fdd61a01SLinus Walleij 	 * @populate_parent_fwspec:
95fdd61a01SLinus Walleij 	 *
96fdd61a01SLinus Walleij 	 * This optional callback populates the &struct irq_fwspec for the
97fdd61a01SLinus Walleij 	 * parent's IRQ domain. If this is not specified, then
98fdd61a01SLinus Walleij 	 * &gpiochip_populate_parent_fwspec_twocell will be used. A four-cell
99fdd61a01SLinus Walleij 	 * variant named &gpiochip_populate_parent_fwspec_fourcell is also
100fdd61a01SLinus Walleij 	 * available.
101fdd61a01SLinus Walleij 	 */
102fdd61a01SLinus Walleij 	void (*populate_parent_fwspec)(struct gpio_chip *chip,
103fdd61a01SLinus Walleij 				       struct irq_fwspec *fwspec,
104fdd61a01SLinus Walleij 				       unsigned int parent_hwirq,
105fdd61a01SLinus Walleij 				       unsigned int parent_type);
106fdd61a01SLinus Walleij 
107fdd61a01SLinus Walleij 	/**
108fdd61a01SLinus Walleij 	 * @child_offset_to_irq:
109fdd61a01SLinus Walleij 	 *
110fdd61a01SLinus Walleij 	 * This optional callback is used to translate the child's GPIO line
111fdd61a01SLinus Walleij 	 * offset on the GPIO chip to an IRQ number for the GPIO to_irq()
112fdd61a01SLinus Walleij 	 * callback. If this is not specified, then a default callback will be
113fdd61a01SLinus Walleij 	 * provided that returns the line offset.
114fdd61a01SLinus Walleij 	 */
115fdd61a01SLinus Walleij 	unsigned int (*child_offset_to_irq)(struct gpio_chip *chip,
116fdd61a01SLinus Walleij 					    unsigned int pin);
117fdd61a01SLinus Walleij 
118fdd61a01SLinus Walleij 	/**
119fdd61a01SLinus Walleij 	 * @child_irq_domain_ops:
120fdd61a01SLinus Walleij 	 *
121fdd61a01SLinus Walleij 	 * The IRQ domain operations that will be used for this GPIO IRQ
122fdd61a01SLinus Walleij 	 * chip. If no operations are provided, then default callbacks will
123fdd61a01SLinus Walleij 	 * be populated to setup the IRQ hierarchy. Some drivers need to
124fdd61a01SLinus Walleij 	 * supply their own translate function.
125fdd61a01SLinus Walleij 	 */
126fdd61a01SLinus Walleij 	struct irq_domain_ops child_irq_domain_ops;
127fdd61a01SLinus Walleij #endif
128fdd61a01SLinus Walleij 
129c44eafd7SThierry Reding 	/**
130c7a0aa59SThierry Reding 	 * @handler:
131c7a0aa59SThierry Reding 	 *
132c7a0aa59SThierry Reding 	 * The IRQ handler to use (often a predefined IRQ core function) for
133c7a0aa59SThierry Reding 	 * GPIO IRQs, provided by GPIO driver.
134c7a0aa59SThierry Reding 	 */
135c7a0aa59SThierry Reding 	irq_flow_handler_t handler;
136c7a0aa59SThierry Reding 
137c7a0aa59SThierry Reding 	/**
1383634eeb0SThierry Reding 	 * @default_type:
1393634eeb0SThierry Reding 	 *
1403634eeb0SThierry Reding 	 * Default IRQ triggering type applied during GPIO driver
1413634eeb0SThierry Reding 	 * initialization, provided by GPIO driver.
1423634eeb0SThierry Reding 	 */
1433634eeb0SThierry Reding 	unsigned int default_type;
1443634eeb0SThierry Reding 
1453634eeb0SThierry Reding 	/**
146ca9df053SThierry Reding 	 * @lock_key:
147ca9df053SThierry Reding 	 *
14802ad0437SRandy Dunlap 	 * Per GPIO IRQ chip lockdep class for IRQ lock.
149ca9df053SThierry Reding 	 */
150ca9df053SThierry Reding 	struct lock_class_key *lock_key;
15102ad0437SRandy Dunlap 
15202ad0437SRandy Dunlap 	/**
15302ad0437SRandy Dunlap 	 * @request_key:
15402ad0437SRandy Dunlap 	 *
15502ad0437SRandy Dunlap 	 * Per GPIO IRQ chip lockdep class for IRQ request.
15602ad0437SRandy Dunlap 	 */
15739c3fd58SAndrew Lunn 	struct lock_class_key *request_key;
158ca9df053SThierry Reding 
159ca9df053SThierry Reding 	/**
160c44eafd7SThierry Reding 	 * @parent_handler:
161c44eafd7SThierry Reding 	 *
162c44eafd7SThierry Reding 	 * The interrupt handler for the GPIO chip's parent interrupts, may be
163c44eafd7SThierry Reding 	 * NULL if the parent interrupts are nested rather than cascaded.
164c44eafd7SThierry Reding 	 */
165c44eafd7SThierry Reding 	irq_flow_handler_t parent_handler;
166c44eafd7SThierry Reding 
167c44eafd7SThierry Reding 	/**
168c44eafd7SThierry Reding 	 * @parent_handler_data:
169c44eafd7SThierry Reding 	 *
170c44eafd7SThierry Reding 	 * Data associated, and passed to, the handler for the parent
171c44eafd7SThierry Reding 	 * interrupt.
172c44eafd7SThierry Reding 	 */
173c44eafd7SThierry Reding 	void *parent_handler_data;
17439e5f096SThierry Reding 
17539e5f096SThierry Reding 	/**
17639e5f096SThierry Reding 	 * @num_parents:
17739e5f096SThierry Reding 	 *
17839e5f096SThierry Reding 	 * The number of interrupt parents of a GPIO chip.
17939e5f096SThierry Reding 	 */
18039e5f096SThierry Reding 	unsigned int num_parents;
18139e5f096SThierry Reding 
18239e5f096SThierry Reding 	/**
18339e5f096SThierry Reding 	 * @parents:
18439e5f096SThierry Reding 	 *
18539e5f096SThierry Reding 	 * A list of interrupt parents of a GPIO chip. This is owned by the
18639e5f096SThierry Reding 	 * driver, so the core will only reference this list, not modify it.
18739e5f096SThierry Reding 	 */
18839e5f096SThierry Reding 	unsigned int *parents;
189dc6bafeeSThierry Reding 
190dc6bafeeSThierry Reding 	/**
191e0d89728SThierry Reding 	 * @map:
192e0d89728SThierry Reding 	 *
193e0d89728SThierry Reding 	 * A list of interrupt parents for each line of a GPIO chip.
194e0d89728SThierry Reding 	 */
195e0d89728SThierry Reding 	unsigned int *map;
196e0d89728SThierry Reding 
197e0d89728SThierry Reding 	/**
19860ed54caSThierry Reding 	 * @threaded:
199dc6bafeeSThierry Reding 	 *
20060ed54caSThierry Reding 	 * True if set the interrupt handling uses nested threads.
201dc6bafeeSThierry Reding 	 */
20260ed54caSThierry Reding 	bool threaded;
203dc7b0387SThierry Reding 
204dc7b0387SThierry Reding 	/**
205dc7b0387SThierry Reding 	 * @need_valid_mask:
206dc7b0387SThierry Reding 	 *
207dc7b0387SThierry Reding 	 * If set core allocates @valid_mask with all bits set to one.
208dc7b0387SThierry Reding 	 */
209dc7b0387SThierry Reding 	bool need_valid_mask;
210dc7b0387SThierry Reding 
211dc7b0387SThierry Reding 	/**
212dc7b0387SThierry Reding 	 * @valid_mask:
213dc7b0387SThierry Reding 	 *
214dc7b0387SThierry Reding 	 * If not %NULL holds bitmask of GPIOs which are valid to be included
215dc7b0387SThierry Reding 	 * in IRQ domain of the chip.
216dc7b0387SThierry Reding 	 */
217dc7b0387SThierry Reding 	unsigned long *valid_mask;
2188302cf58SThierry Reding 
2198302cf58SThierry Reding 	/**
2208302cf58SThierry Reding 	 * @first:
2218302cf58SThierry Reding 	 *
2228302cf58SThierry Reding 	 * Required for static IRQ allocation. If set, irq_domain_add_simple()
2238302cf58SThierry Reding 	 * will allocate and map all IRQs during initialization.
2248302cf58SThierry Reding 	 */
2258302cf58SThierry Reding 	unsigned int first;
226461c1a7dSHans Verkuil 
227461c1a7dSHans Verkuil 	/**
228461c1a7dSHans Verkuil 	 * @irq_enable:
229461c1a7dSHans Verkuil 	 *
230461c1a7dSHans Verkuil 	 * Store old irq_chip irq_enable callback
231461c1a7dSHans Verkuil 	 */
232461c1a7dSHans Verkuil 	void		(*irq_enable)(struct irq_data *data);
233461c1a7dSHans Verkuil 
234461c1a7dSHans Verkuil 	/**
235461c1a7dSHans Verkuil 	 * @irq_disable:
236461c1a7dSHans Verkuil 	 *
237461c1a7dSHans Verkuil 	 * Store old irq_chip irq_disable callback
238461c1a7dSHans Verkuil 	 */
239461c1a7dSHans Verkuil 	void		(*irq_disable)(struct irq_data *data);
240c44eafd7SThierry Reding };
241c44eafd7SThierry Reding 
24279a9becdSAlexandre Courbot /**
24379a9becdSAlexandre Courbot  * struct gpio_chip - abstract a GPIO controller
244df4878e9SLinus Walleij  * @label: a functional name for the GPIO device, such as a part
245df4878e9SLinus Walleij  *	number or the name of the SoC IP-block implementing it.
246ff2b1359SLinus Walleij  * @gpiodev: the internal state holder, opaque struct
24758383c78SLinus Walleij  * @parent: optional parent device providing the GPIOs
24879a9becdSAlexandre Courbot  * @owner: helps prevent removal of modules exporting active GPIOs
24979a9becdSAlexandre Courbot  * @request: optional hook for chip-specific activation, such as
25079a9becdSAlexandre Courbot  *	enabling module power and clock; may sleep
25179a9becdSAlexandre Courbot  * @free: optional hook for chip-specific deactivation, such as
25279a9becdSAlexandre Courbot  *	disabling module power and clock; may sleep
25379a9becdSAlexandre Courbot  * @get_direction: returns direction for signal "offset", 0=out, 1=in,
254e48d194dSLinus Walleij  *	(same as GPIOF_DIR_XXX), or negative error.
255e48d194dSLinus Walleij  *	It is recommended to always implement this function, even on
256e48d194dSLinus Walleij  *	input-only or output-only gpio chips.
25779a9becdSAlexandre Courbot  * @direction_input: configures signal "offset" as input, or returns error
258e48d194dSLinus Walleij  *	This can be omitted on input-only or output-only gpio chips.
25979a9becdSAlexandre Courbot  * @direction_output: configures signal "offset" as output, or returns error
260e48d194dSLinus Walleij  *	This can be omitted on input-only or output-only gpio chips.
26160befd2eSVladimir Zapolskiy  * @get: returns value for signal "offset", 0=low, 1=high, or negative error
262eec1d566SLukas Wunner  * @get_multiple: reads values for multiple signals defined by "mask" and
263eec1d566SLukas Wunner  *	stores them in "bits", returns 0 on success or negative error
26479a9becdSAlexandre Courbot  * @set: assigns output value for signal "offset"
2655f424243SRojhalat Ibrahim  * @set_multiple: assigns output values for multiple signals defined by "mask"
2662956b5d9SMika Westerberg  * @set_config: optional hook for all kinds of settings. Uses the same
2672956b5d9SMika Westerberg  *	packed config format as generic pinconf.
26879a9becdSAlexandre Courbot  * @to_irq: optional hook supporting non-static gpio_to_irq() mappings;
26979a9becdSAlexandre Courbot  *	implementation may not sleep
27079a9becdSAlexandre Courbot  * @dbg_show: optional routine to show contents in debugfs; default code
27179a9becdSAlexandre Courbot  *	will be used when this is omitted, but custom code can show extra
27279a9becdSAlexandre Courbot  *	state (such as pullup/pulldown configuration).
273f99d479bSGeert Uytterhoeven  * @init_valid_mask: optional routine to initialize @valid_mask, to be used if
274f99d479bSGeert Uytterhoeven  *	not all GPIOs are valid.
275af6c235dSLinus Walleij  * @base: identifies the first GPIO number handled by this chip;
276af6c235dSLinus Walleij  *	or, if negative during registration, requests dynamic ID allocation.
277af6c235dSLinus Walleij  *	DEPRECATION: providing anything non-negative and nailing the base
27830bb6fb3SGeert Uytterhoeven  *	offset of GPIO chips is deprecated. Please pass -1 as base to
279af6c235dSLinus Walleij  *	let gpiolib select the chip base in all possible cases. We want to
280af6c235dSLinus Walleij  *	get rid of the static GPIO number space in the long run.
28179a9becdSAlexandre Courbot  * @ngpio: the number of GPIOs handled by this controller; the last GPIO
28279a9becdSAlexandre Courbot  *	handled is (base + ngpio - 1).
28379a9becdSAlexandre Courbot  * @names: if set, must be an array of strings to use as alternative
28479a9becdSAlexandre Courbot  *      names for the GPIOs in this chip. Any entry in the array
28579a9becdSAlexandre Courbot  *      may be NULL if there is no alias for the GPIO, however the
28679a9becdSAlexandre Courbot  *      array must be @ngpio entries long.  A name can include a single printk
28779a9becdSAlexandre Courbot  *      format specifier for an unsigned int.  It is substituted by the actual
28879a9becdSAlexandre Courbot  *      number of the gpio.
2899fb1f39eSLinus Walleij  * @can_sleep: flag must be set iff get()/set() methods sleep, as they
2901c8732bbSLinus Walleij  *	must while accessing GPIO expander chips over I2C or SPI. This
2911c8732bbSLinus Walleij  *	implies that if the chip supports IRQs, these IRQs need to be threaded
2921c8732bbSLinus Walleij  *	as the chip access may sleep when e.g. reading out the IRQ status
2931c8732bbSLinus Walleij  *	registers.
2940f4630f3SLinus Walleij  * @read_reg: reader function for generic GPIO
2950f4630f3SLinus Walleij  * @write_reg: writer function for generic GPIO
29624efd94bSLinus Walleij  * @be_bits: if the generic GPIO has big endian bit order (bit 31 is representing
29724efd94bSLinus Walleij  *	line 0, bit 30 is line 1 ... bit 0 is line 31) this is set to true by the
29824efd94bSLinus Walleij  *	generic GPIO core. It is for internal housekeeping only.
2990f4630f3SLinus Walleij  * @reg_dat: data (in) register for generic GPIO
3000f4630f3SLinus Walleij  * @reg_set: output set register (out=high) for generic GPIO
30108bcd3edSAnthony Best  * @reg_clr: output clear register (out=low) for generic GPIO
302f69e00bdSLinus Walleij  * @reg_dir_out: direction out setting register for generic GPIO
303f69e00bdSLinus Walleij  * @reg_dir_in: direction in setting register for generic GPIO
304f69e00bdSLinus Walleij  * @bgpio_dir_unreadable: indicates that the direction register(s) cannot
305f69e00bdSLinus Walleij  *	be read and we need to rely on out internal state tracking.
3060f4630f3SLinus Walleij  * @bgpio_bits: number of register bits used for a generic GPIO i.e.
3070f4630f3SLinus Walleij  *	<register width> * 8
3080f4630f3SLinus Walleij  * @bgpio_lock: used to lock chip->bgpio_data. Also, this is needed to keep
3090f4630f3SLinus Walleij  *	shadowed and real data registers writes together.
3100f4630f3SLinus Walleij  * @bgpio_data:	shadowed data register for generic GPIO to clear/set bits
3110f4630f3SLinus Walleij  *	safely.
3120f4630f3SLinus Walleij  * @bgpio_dir: shadowed direction register for generic GPIO to clear/set
313f69e00bdSLinus Walleij  *	direction safely. A "1" in this word means the line is set as
314f69e00bdSLinus Walleij  *	output.
31579a9becdSAlexandre Courbot  *
31679a9becdSAlexandre Courbot  * A gpio_chip can help platforms abstract various sources of GPIOs so
31779a9becdSAlexandre Courbot  * they can all be accessed through a common programing interface.
31879a9becdSAlexandre Courbot  * Example sources would be SOC controllers, FPGAs, multifunction
31979a9becdSAlexandre Courbot  * chips, dedicated GPIO expanders, and so on.
32079a9becdSAlexandre Courbot  *
32179a9becdSAlexandre Courbot  * Each chip controls a number of signals, identified in method calls
32279a9becdSAlexandre Courbot  * by "offset" values in the range 0..(@ngpio - 1).  When those signals
32379a9becdSAlexandre Courbot  * are referenced through calls like gpio_get_value(gpio), the offset
32479a9becdSAlexandre Courbot  * is calculated by subtracting @base from the gpio number.
32579a9becdSAlexandre Courbot  */
32679a9becdSAlexandre Courbot struct gpio_chip {
32779a9becdSAlexandre Courbot 	const char		*label;
328ff2b1359SLinus Walleij 	struct gpio_device	*gpiodev;
32958383c78SLinus Walleij 	struct device		*parent;
33079a9becdSAlexandre Courbot 	struct module		*owner;
33179a9becdSAlexandre Courbot 
33279a9becdSAlexandre Courbot 	int			(*request)(struct gpio_chip *chip,
33379a9becdSAlexandre Courbot 						unsigned offset);
33479a9becdSAlexandre Courbot 	void			(*free)(struct gpio_chip *chip,
33579a9becdSAlexandre Courbot 						unsigned offset);
33679a9becdSAlexandre Courbot 	int			(*get_direction)(struct gpio_chip *chip,
33779a9becdSAlexandre Courbot 						unsigned offset);
33879a9becdSAlexandre Courbot 	int			(*direction_input)(struct gpio_chip *chip,
33979a9becdSAlexandre Courbot 						unsigned offset);
34079a9becdSAlexandre Courbot 	int			(*direction_output)(struct gpio_chip *chip,
34179a9becdSAlexandre Courbot 						unsigned offset, int value);
34279a9becdSAlexandre Courbot 	int			(*get)(struct gpio_chip *chip,
34379a9becdSAlexandre Courbot 						unsigned offset);
344eec1d566SLukas Wunner 	int			(*get_multiple)(struct gpio_chip *chip,
345eec1d566SLukas Wunner 						unsigned long *mask,
346eec1d566SLukas Wunner 						unsigned long *bits);
34779a9becdSAlexandre Courbot 	void			(*set)(struct gpio_chip *chip,
34879a9becdSAlexandre Courbot 						unsigned offset, int value);
3495f424243SRojhalat Ibrahim 	void			(*set_multiple)(struct gpio_chip *chip,
3505f424243SRojhalat Ibrahim 						unsigned long *mask,
3515f424243SRojhalat Ibrahim 						unsigned long *bits);
3522956b5d9SMika Westerberg 	int			(*set_config)(struct gpio_chip *chip,
35379a9becdSAlexandre Courbot 					      unsigned offset,
3542956b5d9SMika Westerberg 					      unsigned long config);
35579a9becdSAlexandre Courbot 	int			(*to_irq)(struct gpio_chip *chip,
35679a9becdSAlexandre Courbot 						unsigned offset);
35779a9becdSAlexandre Courbot 
35879a9becdSAlexandre Courbot 	void			(*dbg_show)(struct seq_file *s,
35979a9becdSAlexandre Courbot 						struct gpio_chip *chip);
360f8ec92a9SRicardo Ribalda Delgado 
361c9fc5affSLinus Walleij 	int			(*init_valid_mask)(struct gpio_chip *chip,
362c9fc5affSLinus Walleij 						   unsigned long *valid_mask,
363c9fc5affSLinus Walleij 						   unsigned int ngpios);
364f8ec92a9SRicardo Ribalda Delgado 
36579a9becdSAlexandre Courbot 	int			base;
36679a9becdSAlexandre Courbot 	u16			ngpio;
36779a9becdSAlexandre Courbot 	const char		*const *names;
3689fb1f39eSLinus Walleij 	bool			can_sleep;
36979a9becdSAlexandre Courbot 
3700f4630f3SLinus Walleij #if IS_ENABLED(CONFIG_GPIO_GENERIC)
3710f4630f3SLinus Walleij 	unsigned long (*read_reg)(void __iomem *reg);
3720f4630f3SLinus Walleij 	void (*write_reg)(void __iomem *reg, unsigned long data);
37324efd94bSLinus Walleij 	bool be_bits;
3740f4630f3SLinus Walleij 	void __iomem *reg_dat;
3750f4630f3SLinus Walleij 	void __iomem *reg_set;
3760f4630f3SLinus Walleij 	void __iomem *reg_clr;
377f69e00bdSLinus Walleij 	void __iomem *reg_dir_out;
378f69e00bdSLinus Walleij 	void __iomem *reg_dir_in;
379f69e00bdSLinus Walleij 	bool bgpio_dir_unreadable;
3800f4630f3SLinus Walleij 	int bgpio_bits;
3810f4630f3SLinus Walleij 	spinlock_t bgpio_lock;
3820f4630f3SLinus Walleij 	unsigned long bgpio_data;
3830f4630f3SLinus Walleij 	unsigned long bgpio_dir;
384f310f2efSEnrico Weigelt #endif /* CONFIG_GPIO_GENERIC */
3850f4630f3SLinus Walleij 
38614250520SLinus Walleij #ifdef CONFIG_GPIOLIB_IRQCHIP
38714250520SLinus Walleij 	/*
3887d75a871SPaul Bolle 	 * With CONFIG_GPIOLIB_IRQCHIP we get an irqchip inside the gpiolib
38914250520SLinus Walleij 	 * to handle IRQs for most practical cases.
39014250520SLinus Walleij 	 */
391c44eafd7SThierry Reding 
392c44eafd7SThierry Reding 	/**
393c44eafd7SThierry Reding 	 * @irq:
394c44eafd7SThierry Reding 	 *
395c44eafd7SThierry Reding 	 * Integrates interrupt chip functionality with the GPIO chip. Can be
396c44eafd7SThierry Reding 	 * used to handle IRQs for most practical cases.
397c44eafd7SThierry Reding 	 */
398c44eafd7SThierry Reding 	struct gpio_irq_chip irq;
399f310f2efSEnrico Weigelt #endif /* CONFIG_GPIOLIB_IRQCHIP */
40014250520SLinus Walleij 
401726cb3baSStephen Boyd 	/**
402726cb3baSStephen Boyd 	 * @valid_mask:
403726cb3baSStephen Boyd 	 *
404726cb3baSStephen Boyd 	 * If not %NULL holds bitmask of GPIOs which are valid to be used
405726cb3baSStephen Boyd 	 * from the chip.
406726cb3baSStephen Boyd 	 */
407726cb3baSStephen Boyd 	unsigned long *valid_mask;
408726cb3baSStephen Boyd 
40979a9becdSAlexandre Courbot #if defined(CONFIG_OF_GPIO)
41079a9becdSAlexandre Courbot 	/*
41179a9becdSAlexandre Courbot 	 * If CONFIG_OF is enabled, then all GPIO controllers described in the
41279a9becdSAlexandre Courbot 	 * device tree automatically may have an OF translation
41379a9becdSAlexandre Courbot 	 */
41467049c50SThierry Reding 
41567049c50SThierry Reding 	/**
41667049c50SThierry Reding 	 * @of_node:
41767049c50SThierry Reding 	 *
41867049c50SThierry Reding 	 * Pointer to a device tree node representing this GPIO controller.
41967049c50SThierry Reding 	 */
42079a9becdSAlexandre Courbot 	struct device_node *of_node;
42167049c50SThierry Reding 
42267049c50SThierry Reding 	/**
42367049c50SThierry Reding 	 * @of_gpio_n_cells:
42467049c50SThierry Reding 	 *
42567049c50SThierry Reding 	 * Number of cells used to form the GPIO specifier.
42667049c50SThierry Reding 	 */
427e3b445d7SThierry Reding 	unsigned int of_gpio_n_cells;
42867049c50SThierry Reding 
42967049c50SThierry Reding 	/**
43067049c50SThierry Reding 	 * @of_xlate:
43167049c50SThierry Reding 	 *
43267049c50SThierry Reding 	 * Callback to translate a device tree GPIO specifier into a chip-
43367049c50SThierry Reding 	 * relative GPIO number and flags.
43467049c50SThierry Reding 	 */
43579a9becdSAlexandre Courbot 	int (*of_xlate)(struct gpio_chip *gc,
43679a9becdSAlexandre Courbot 			const struct of_phandle_args *gpiospec, u32 *flags);
437f310f2efSEnrico Weigelt #endif /* CONFIG_OF_GPIO */
43879a9becdSAlexandre Courbot };
43979a9becdSAlexandre Courbot 
44079a9becdSAlexandre Courbot extern const char *gpiochip_is_requested(struct gpio_chip *chip,
44179a9becdSAlexandre Courbot 			unsigned offset);
44279a9becdSAlexandre Courbot 
44379a9becdSAlexandre Courbot /* add/remove chips */
444959bc7b2SThierry Reding extern int gpiochip_add_data_with_key(struct gpio_chip *chip, void *data,
44539c3fd58SAndrew Lunn 				      struct lock_class_key *lock_key,
44639c3fd58SAndrew Lunn 				      struct lock_class_key *request_key);
447959bc7b2SThierry Reding 
448959bc7b2SThierry Reding /**
449959bc7b2SThierry Reding  * gpiochip_add_data() - register a gpio_chip
450959bc7b2SThierry Reding  * @chip: the chip to register, with chip->base initialized
451959bc7b2SThierry Reding  * @data: driver-private data associated with this chip
452959bc7b2SThierry Reding  *
453959bc7b2SThierry Reding  * Context: potentially before irqs will work
454959bc7b2SThierry Reding  *
455959bc7b2SThierry Reding  * When gpiochip_add_data() is called very early during boot, so that GPIOs
456959bc7b2SThierry Reding  * can be freely used, the chip->parent device must be registered before
457959bc7b2SThierry Reding  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
458959bc7b2SThierry Reding  * for GPIOs will fail rudely.
459959bc7b2SThierry Reding  *
460959bc7b2SThierry Reding  * gpiochip_add_data() must only be called after gpiolib initialization,
461959bc7b2SThierry Reding  * ie after core_initcall().
462959bc7b2SThierry Reding  *
463959bc7b2SThierry Reding  * If chip->base is negative, this requests dynamic assignment of
464959bc7b2SThierry Reding  * a range of valid GPIOs.
465959bc7b2SThierry Reding  *
466959bc7b2SThierry Reding  * Returns:
467959bc7b2SThierry Reding  * A negative errno if the chip can't be registered, such as because the
468959bc7b2SThierry Reding  * chip->base is invalid or already associated with a different chip.
469959bc7b2SThierry Reding  * Otherwise it returns zero as a success code.
470959bc7b2SThierry Reding  */
471959bc7b2SThierry Reding #ifdef CONFIG_LOCKDEP
472959bc7b2SThierry Reding #define gpiochip_add_data(chip, data) ({		\
47339c3fd58SAndrew Lunn 		static struct lock_class_key lock_key;	\
47439c3fd58SAndrew Lunn 		static struct lock_class_key request_key;	  \
47539c3fd58SAndrew Lunn 		gpiochip_add_data_with_key(chip, data, &lock_key, \
47639c3fd58SAndrew Lunn 					   &request_key);	  \
477959bc7b2SThierry Reding 	})
478959bc7b2SThierry Reding #else
47939c3fd58SAndrew Lunn #define gpiochip_add_data(chip, data) gpiochip_add_data_with_key(chip, data, NULL, NULL)
480f310f2efSEnrico Weigelt #endif /* CONFIG_LOCKDEP */
481959bc7b2SThierry Reding 
482b08ea35aSLinus Walleij static inline int gpiochip_add(struct gpio_chip *chip)
483b08ea35aSLinus Walleij {
484b08ea35aSLinus Walleij 	return gpiochip_add_data(chip, NULL);
485b08ea35aSLinus Walleij }
486e1db1706Sabdoulaye berthe extern void gpiochip_remove(struct gpio_chip *chip);
4870cf3292cSLaxman Dewangan extern int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
4880cf3292cSLaxman Dewangan 				  void *data);
4890cf3292cSLaxman Dewangan 
49079a9becdSAlexandre Courbot extern struct gpio_chip *gpiochip_find(void *data,
49179a9becdSAlexandre Courbot 			      int (*match)(struct gpio_chip *chip, void *data));
49279a9becdSAlexandre Courbot 
4936cee3821SLinus Walleij bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset);
4944e6b8238SHans Verkuil int gpiochip_reqres_irq(struct gpio_chip *chip, unsigned int offset);
4954e6b8238SHans Verkuil void gpiochip_relres_irq(struct gpio_chip *chip, unsigned int offset);
4964e9439ddSHans Verkuil void gpiochip_disable_irq(struct gpio_chip *chip, unsigned int offset);
4974e9439ddSHans Verkuil void gpiochip_enable_irq(struct gpio_chip *chip, unsigned int offset);
49879a9becdSAlexandre Courbot 
499143b65d6SLinus Walleij /* Line status inquiry for drivers */
500143b65d6SLinus Walleij bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset);
501143b65d6SLinus Walleij bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset);
502143b65d6SLinus Walleij 
50305f479bfSCharles Keepax /* Sleep persistence inquiry for drivers */
50405f479bfSCharles Keepax bool gpiochip_line_is_persistent(struct gpio_chip *chip, unsigned int offset);
505726cb3baSStephen Boyd bool gpiochip_line_is_valid(const struct gpio_chip *chip, unsigned int offset);
50605f479bfSCharles Keepax 
507b08ea35aSLinus Walleij /* get driver data */
50843c54ecaSLinus Walleij void *gpiochip_get_data(struct gpio_chip *chip);
509b08ea35aSLinus Walleij 
5100f4630f3SLinus Walleij struct bgpio_pdata {
5110f4630f3SLinus Walleij 	const char *label;
5120f4630f3SLinus Walleij 	int base;
5130f4630f3SLinus Walleij 	int ngpio;
5140f4630f3SLinus Walleij };
5150f4630f3SLinus Walleij 
516fdd61a01SLinus Walleij #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
517fdd61a01SLinus Walleij 
518fdd61a01SLinus Walleij void gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *chip,
519fdd61a01SLinus Walleij 					     struct irq_fwspec *fwspec,
520fdd61a01SLinus Walleij 					     unsigned int parent_hwirq,
521fdd61a01SLinus Walleij 					     unsigned int parent_type);
522fdd61a01SLinus Walleij void gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *chip,
523fdd61a01SLinus Walleij 					      struct irq_fwspec *fwspec,
524fdd61a01SLinus Walleij 					      unsigned int parent_hwirq,
525fdd61a01SLinus Walleij 					      unsigned int parent_type);
526fdd61a01SLinus Walleij 
527fdd61a01SLinus Walleij #else
528fdd61a01SLinus Walleij 
529f52a0c7bSStephen Rothwell static inline void gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *chip,
530fdd61a01SLinus Walleij 						    struct irq_fwspec *fwspec,
531fdd61a01SLinus Walleij 						    unsigned int parent_hwirq,
532fdd61a01SLinus Walleij 						    unsigned int parent_type)
533fdd61a01SLinus Walleij {
534fdd61a01SLinus Walleij }
535fdd61a01SLinus Walleij 
536f52a0c7bSStephen Rothwell static inline void gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *chip,
537fdd61a01SLinus Walleij 						     struct irq_fwspec *fwspec,
538fdd61a01SLinus Walleij 						     unsigned int parent_hwirq,
539fdd61a01SLinus Walleij 						     unsigned int parent_type)
540fdd61a01SLinus Walleij {
541fdd61a01SLinus Walleij }
542fdd61a01SLinus Walleij 
543fdd61a01SLinus Walleij #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
544fdd61a01SLinus Walleij 
5450f4630f3SLinus Walleij int bgpio_init(struct gpio_chip *gc, struct device *dev,
5460f4630f3SLinus Walleij 	       unsigned long sz, void __iomem *dat, void __iomem *set,
5470f4630f3SLinus Walleij 	       void __iomem *clr, void __iomem *dirout, void __iomem *dirin,
5480f4630f3SLinus Walleij 	       unsigned long flags);
5490f4630f3SLinus Walleij 
5500f4630f3SLinus Walleij #define BGPIOF_BIG_ENDIAN		BIT(0)
5510f4630f3SLinus Walleij #define BGPIOF_UNREADABLE_REG_SET	BIT(1) /* reg_set is unreadable */
5520f4630f3SLinus Walleij #define BGPIOF_UNREADABLE_REG_DIR	BIT(2) /* reg_dir is unreadable */
5530f4630f3SLinus Walleij #define BGPIOF_BIG_ENDIAN_BYTE_ORDER	BIT(3)
5540f4630f3SLinus Walleij #define BGPIOF_READ_OUTPUT_REG_SET	BIT(4) /* reg_set stores output value */
5550f4630f3SLinus Walleij #define BGPIOF_NO_OUTPUT		BIT(5) /* only input */
5560f4630f3SLinus Walleij 
5571b95b4ebSThierry Reding int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
5581b95b4ebSThierry Reding 		     irq_hw_number_t hwirq);
5591b95b4ebSThierry Reding void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq);
5601b95b4ebSThierry Reding 
561ef74f70eSBrian Masney int gpiochip_irq_domain_activate(struct irq_domain *domain,
562ef74f70eSBrian Masney 				 struct irq_data *data, bool reserve);
563ef74f70eSBrian Masney void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
564ef74f70eSBrian Masney 				    struct irq_data *data);
565ef74f70eSBrian Masney 
56614250520SLinus Walleij void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
56714250520SLinus Walleij 		struct irq_chip *irqchip,
5686f79309aSThierry Reding 		unsigned int parent_irq,
56914250520SLinus Walleij 		irq_flow_handler_t parent_handler);
57014250520SLinus Walleij 
571d245b3f9SLinus Walleij void gpiochip_set_nested_irqchip(struct gpio_chip *gpiochip,
572d245b3f9SLinus Walleij 		struct irq_chip *irqchip,
5736f79309aSThierry Reding 		unsigned int parent_irq);
574d245b3f9SLinus Walleij 
575739e6f59SLinus Walleij int gpiochip_irqchip_add_key(struct gpio_chip *gpiochip,
57614250520SLinus Walleij 			     struct irq_chip *irqchip,
57714250520SLinus Walleij 			     unsigned int first_irq,
57814250520SLinus Walleij 			     irq_flow_handler_t handler,
579a0a8bcf4SGrygorii Strashko 			     unsigned int type,
58060ed54caSThierry Reding 			     bool threaded,
58139c3fd58SAndrew Lunn 			     struct lock_class_key *lock_key,
58239c3fd58SAndrew Lunn 			     struct lock_class_key *request_key);
583a0a8bcf4SGrygorii Strashko 
58464ff2c8eSStephen Boyd bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip,
58564ff2c8eSStephen Boyd 				unsigned int offset);
58664ff2c8eSStephen Boyd 
587739e6f59SLinus Walleij #ifdef CONFIG_LOCKDEP
588739e6f59SLinus Walleij 
589739e6f59SLinus Walleij /*
590739e6f59SLinus Walleij  * Lockdep requires that each irqchip instance be created with a
591739e6f59SLinus Walleij  * unique key so as to avoid unnecessary warnings. This upfront
592739e6f59SLinus Walleij  * boilerplate static inlines provides such a key for each
593739e6f59SLinus Walleij  * unique instance.
594739e6f59SLinus Walleij  */
595739e6f59SLinus Walleij static inline int gpiochip_irqchip_add(struct gpio_chip *gpiochip,
596739e6f59SLinus Walleij 				       struct irq_chip *irqchip,
597739e6f59SLinus Walleij 				       unsigned int first_irq,
598739e6f59SLinus Walleij 				       irq_flow_handler_t handler,
599739e6f59SLinus Walleij 				       unsigned int type)
600739e6f59SLinus Walleij {
60139c3fd58SAndrew Lunn 	static struct lock_class_key lock_key;
60239c3fd58SAndrew Lunn 	static struct lock_class_key request_key;
603739e6f59SLinus Walleij 
604739e6f59SLinus Walleij 	return gpiochip_irqchip_add_key(gpiochip, irqchip, first_irq,
60539c3fd58SAndrew Lunn 					handler, type, false,
60639c3fd58SAndrew Lunn 					&lock_key, &request_key);
607739e6f59SLinus Walleij }
608739e6f59SLinus Walleij 
609d245b3f9SLinus Walleij static inline int gpiochip_irqchip_add_nested(struct gpio_chip *gpiochip,
610d245b3f9SLinus Walleij 			  struct irq_chip *irqchip,
611d245b3f9SLinus Walleij 			  unsigned int first_irq,
612d245b3f9SLinus Walleij 			  irq_flow_handler_t handler,
613d245b3f9SLinus Walleij 			  unsigned int type)
614d245b3f9SLinus Walleij {
615739e6f59SLinus Walleij 
61639c3fd58SAndrew Lunn 	static struct lock_class_key lock_key;
61739c3fd58SAndrew Lunn 	static struct lock_class_key request_key;
618739e6f59SLinus Walleij 
619739e6f59SLinus Walleij 	return gpiochip_irqchip_add_key(gpiochip, irqchip, first_irq,
62039c3fd58SAndrew Lunn 					handler, type, true,
62139c3fd58SAndrew Lunn 					&lock_key, &request_key);
622739e6f59SLinus Walleij }
623f310f2efSEnrico Weigelt #else /* ! CONFIG_LOCKDEP */
624739e6f59SLinus Walleij static inline int gpiochip_irqchip_add(struct gpio_chip *gpiochip,
625739e6f59SLinus Walleij 				       struct irq_chip *irqchip,
626739e6f59SLinus Walleij 				       unsigned int first_irq,
627739e6f59SLinus Walleij 				       irq_flow_handler_t handler,
628739e6f59SLinus Walleij 				       unsigned int type)
629739e6f59SLinus Walleij {
630739e6f59SLinus Walleij 	return gpiochip_irqchip_add_key(gpiochip, irqchip, first_irq,
63139c3fd58SAndrew Lunn 					handler, type, false, NULL, NULL);
632d245b3f9SLinus Walleij }
633d245b3f9SLinus Walleij 
634739e6f59SLinus Walleij static inline int gpiochip_irqchip_add_nested(struct gpio_chip *gpiochip,
635739e6f59SLinus Walleij 			  struct irq_chip *irqchip,
636739e6f59SLinus Walleij 			  unsigned int first_irq,
637739e6f59SLinus Walleij 			  irq_flow_handler_t handler,
638739e6f59SLinus Walleij 			  unsigned int type)
639739e6f59SLinus Walleij {
640739e6f59SLinus Walleij 	return gpiochip_irqchip_add_key(gpiochip, irqchip, first_irq,
64139c3fd58SAndrew Lunn 					handler, type, true, NULL, NULL);
642739e6f59SLinus Walleij }
643739e6f59SLinus Walleij #endif /* CONFIG_LOCKDEP */
64414250520SLinus Walleij 
645c771c2f4SJonas Gorski int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset);
646c771c2f4SJonas Gorski void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset);
6472956b5d9SMika Westerberg int gpiochip_generic_config(struct gpio_chip *chip, unsigned offset,
6482956b5d9SMika Westerberg 			    unsigned long config);
649c771c2f4SJonas Gorski 
650964cb341SLinus Walleij /**
651964cb341SLinus Walleij  * struct gpio_pin_range - pin range controlled by a gpio chip
652950d55f5SThierry Reding  * @node: list for maintaining set of pin ranges, used internally
653964cb341SLinus Walleij  * @pctldev: pinctrl device which handles corresponding pins
654964cb341SLinus Walleij  * @range: actual range of pins controlled by a gpio controller
655964cb341SLinus Walleij  */
656964cb341SLinus Walleij struct gpio_pin_range {
657964cb341SLinus Walleij 	struct list_head node;
658964cb341SLinus Walleij 	struct pinctrl_dev *pctldev;
659964cb341SLinus Walleij 	struct pinctrl_gpio_range range;
660964cb341SLinus Walleij };
661964cb341SLinus Walleij 
6629091373aSMasahiro Yamada #ifdef CONFIG_PINCTRL
6639091373aSMasahiro Yamada 
664964cb341SLinus Walleij int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
665964cb341SLinus Walleij 			   unsigned int gpio_offset, unsigned int pin_offset,
666964cb341SLinus Walleij 			   unsigned int npins);
667964cb341SLinus Walleij int gpiochip_add_pingroup_range(struct gpio_chip *chip,
668964cb341SLinus Walleij 			struct pinctrl_dev *pctldev,
669964cb341SLinus Walleij 			unsigned int gpio_offset, const char *pin_group);
670964cb341SLinus Walleij void gpiochip_remove_pin_ranges(struct gpio_chip *chip);
671964cb341SLinus Walleij 
672f310f2efSEnrico Weigelt #else /* ! CONFIG_PINCTRL */
673964cb341SLinus Walleij 
674964cb341SLinus Walleij static inline int
675964cb341SLinus Walleij gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
676964cb341SLinus Walleij 		       unsigned int gpio_offset, unsigned int pin_offset,
677964cb341SLinus Walleij 		       unsigned int npins)
678964cb341SLinus Walleij {
679964cb341SLinus Walleij 	return 0;
680964cb341SLinus Walleij }
681964cb341SLinus Walleij static inline int
682964cb341SLinus Walleij gpiochip_add_pingroup_range(struct gpio_chip *chip,
683964cb341SLinus Walleij 			struct pinctrl_dev *pctldev,
684964cb341SLinus Walleij 			unsigned int gpio_offset, const char *pin_group)
685964cb341SLinus Walleij {
686964cb341SLinus Walleij 	return 0;
687964cb341SLinus Walleij }
688964cb341SLinus Walleij 
689964cb341SLinus Walleij static inline void
690964cb341SLinus Walleij gpiochip_remove_pin_ranges(struct gpio_chip *chip)
691964cb341SLinus Walleij {
692964cb341SLinus Walleij }
693964cb341SLinus Walleij 
694964cb341SLinus Walleij #endif /* CONFIG_PINCTRL */
695964cb341SLinus Walleij 
696abdc08a3SAlexandre Courbot struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
69721abf103SLinus Walleij 					    const char *label,
6985923ea6cSLinus Walleij 					    enum gpio_lookup_flags lflags,
6995923ea6cSLinus Walleij 					    enum gpiod_flags dflags);
700f7d4ad98SGuenter Roeck void gpiochip_free_own_desc(struct gpio_desc *desc);
701f7d4ad98SGuenter Roeck 
70264ebde5bSJan Kundrát void devprop_gpiochip_set_names(struct gpio_chip *chip,
70364ebde5bSJan Kundrát 				const struct fwnode_handle *fwnode);
70464ebde5bSJan Kundrát 
705ae0755b5SLinus Walleij #ifdef CONFIG_GPIOLIB
706ae0755b5SLinus Walleij 
707c7663fa2SYueHaibing /* lock/unlock as IRQ */
708c7663fa2SYueHaibing int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset);
709c7663fa2SYueHaibing void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset);
710c7663fa2SYueHaibing 
7119091373aSMasahiro Yamada 
7129091373aSMasahiro Yamada struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc);
7139091373aSMasahiro Yamada 
714bb1e88ccSAlexandre Courbot #else /* CONFIG_GPIOLIB */
715bb1e88ccSAlexandre Courbot 
716bb1e88ccSAlexandre Courbot static inline struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
717bb1e88ccSAlexandre Courbot {
718bb1e88ccSAlexandre Courbot 	/* GPIO can never have been requested */
719bb1e88ccSAlexandre Courbot 	WARN_ON(1);
720bb1e88ccSAlexandre Courbot 	return ERR_PTR(-ENODEV);
721bb1e88ccSAlexandre Courbot }
722bb1e88ccSAlexandre Courbot 
723c7663fa2SYueHaibing static inline int gpiochip_lock_as_irq(struct gpio_chip *chip,
724c7663fa2SYueHaibing 				       unsigned int offset)
725c7663fa2SYueHaibing {
726c7663fa2SYueHaibing 	WARN_ON(1);
727c7663fa2SYueHaibing 	return -EINVAL;
728c7663fa2SYueHaibing }
729c7663fa2SYueHaibing 
730c7663fa2SYueHaibing static inline void gpiochip_unlock_as_irq(struct gpio_chip *chip,
731c7663fa2SYueHaibing 					  unsigned int offset)
732c7663fa2SYueHaibing {
733c7663fa2SYueHaibing 	WARN_ON(1);
734c7663fa2SYueHaibing }
735bb1e88ccSAlexandre Courbot #endif /* CONFIG_GPIOLIB */
736bb1e88ccSAlexandre Courbot 
7379091373aSMasahiro Yamada #endif /* __LINUX_GPIO_DRIVER_H */
738