1 /* SPDX-License-Identifier: GPL-2.0 */
5 * This is the LEGACY GPIO bulk include file, including legacy APIs. It is
6 * used for GPIO drivers still referencing the global GPIO numberspace,
7 * and should not be included in new code.
9 * If you're implementing a GPIO driver, only include <linux/gpio/driver.h>
10 * If you're implementing a GPIO consumer, only include <linux/gpio/consumer.h>
12 #ifndef __LINUX_GPIO_H
13 #define __LINUX_GPIO_H
15 #include <linux/errno.h>
17 /* see Documentation/driver-api/gpio/legacy.rst */
19 /* make these flag values available regardless of GPIO kconfig options */
20 #define GPIOF_DIR_OUT (0 << 0)
21 #define GPIOF_DIR_IN (1 << 0)
23 #define GPIOF_INIT_LOW (0 << 1)
24 #define GPIOF_INIT_HIGH (1 << 1)
26 #define GPIOF_IN (GPIOF_DIR_IN)
27 #define GPIOF_OUT_INIT_LOW (GPIOF_DIR_OUT | GPIOF_INIT_LOW)
28 #define GPIOF_OUT_INIT_HIGH (GPIOF_DIR_OUT | GPIOF_INIT_HIGH)
30 /* Gpio pin is active-low */
31 #define GPIOF_ACTIVE_LOW (1 << 2)
33 /* Gpio pin is open drain */
34 #define GPIOF_OPEN_DRAIN (1 << 3)
36 /* Gpio pin is open source */
37 #define GPIOF_OPEN_SOURCE (1 << 4)
39 #define GPIOF_EXPORT (1 << 5)
40 #define GPIOF_EXPORT_CHANGEABLE (1 << 6)
41 #define GPIOF_EXPORT_DIR_FIXED (GPIOF_EXPORT)
42 #define GPIOF_EXPORT_DIR_CHANGEABLE (GPIOF_EXPORT | GPIOF_EXPORT_CHANGEABLE)
45 * struct gpio - a structure describing a GPIO with configuration
46 * @gpio: the GPIO number
47 * @flags: GPIO configuration as specified by GPIOF_*
48 * @label: a literal description string of this GPIO
58 #ifdef CONFIG_ARCH_HAVE_CUSTOM_GPIO_H
62 #include <asm-generic/gpio.h>
64 static inline int gpio_get_value(unsigned int gpio)
66 return __gpio_get_value(gpio);
69 static inline void gpio_set_value(unsigned int gpio, int value)
71 __gpio_set_value(gpio, value);
74 static inline int gpio_cansleep(unsigned int gpio)
76 return __gpio_cansleep(gpio);
79 static inline int gpio_to_irq(unsigned int gpio)
81 return __gpio_to_irq(gpio);
84 static inline int irq_to_gpio(unsigned int irq)
89 #endif /* ! CONFIG_ARCH_HAVE_CUSTOM_GPIO_H */
91 /* CONFIG_GPIOLIB: bindings for managed devices that want to request gpios */
95 int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
96 int devm_gpio_request_one(struct device *dev, unsigned gpio,
97 unsigned long flags, const char *label);
99 #else /* ! CONFIG_GPIOLIB */
101 #include <linux/kernel.h>
102 #include <linux/types.h>
103 #include <linux/bug.h>
108 static inline bool gpio_is_valid(int number)
113 static inline int gpio_request(unsigned gpio, const char *label)
118 static inline int gpio_request_one(unsigned gpio,
119 unsigned long flags, const char *label)
124 static inline int gpio_request_array(const struct gpio *array, size_t num)
129 static inline void gpio_free(unsigned gpio)
133 /* GPIO can never have been requested */
137 static inline void gpio_free_array(const struct gpio *array, size_t num)
141 /* GPIO can never have been requested */
145 static inline int gpio_direction_input(unsigned gpio)
150 static inline int gpio_direction_output(unsigned gpio, int value)
155 static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
160 static inline int gpio_get_value(unsigned gpio)
162 /* GPIO can never have been requested or set as {in,out}put */
167 static inline void gpio_set_value(unsigned gpio, int value)
169 /* GPIO can never have been requested or set as output */
173 static inline int gpio_cansleep(unsigned gpio)
175 /* GPIO can never have been requested or set as {in,out}put */
180 static inline int gpio_get_value_cansleep(unsigned gpio)
182 /* GPIO can never have been requested or set as {in,out}put */
187 static inline void gpio_set_value_cansleep(unsigned gpio, int value)
189 /* GPIO can never have been requested or set as output */
193 static inline int gpio_export(unsigned gpio, bool direction_may_change)
195 /* GPIO can never have been requested or set as {in,out}put */
200 static inline int gpio_export_link(struct device *dev, const char *name,
203 /* GPIO can never have been exported */
208 static inline void gpio_unexport(unsigned gpio)
210 /* GPIO can never have been exported */
214 static inline int gpio_to_irq(unsigned gpio)
216 /* GPIO can never have been requested or set as input */
221 static inline int irq_to_gpio(unsigned irq)
223 /* irq can never have been returned from gpio_to_irq() */
228 static inline int devm_gpio_request(struct device *dev, unsigned gpio,
235 static inline int devm_gpio_request_one(struct device *dev, unsigned gpio,
236 unsigned long flags, const char *label)
242 #endif /* ! CONFIG_GPIOLIB */
244 #endif /* __LINUX_GPIO_H */