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/types.h>
19 /* see Documentation/driver-api/gpio/legacy.rst */
21 /* make these flag values available regardless of GPIO kconfig options */
22 #define GPIOF_DIR_OUT (0 << 0)
23 #define GPIOF_DIR_IN (1 << 0)
25 #define GPIOF_INIT_LOW (0 << 1)
26 #define GPIOF_INIT_HIGH (1 << 1)
28 #define GPIOF_IN (GPIOF_DIR_IN)
29 #define GPIOF_OUT_INIT_LOW (GPIOF_DIR_OUT | GPIOF_INIT_LOW)
30 #define GPIOF_OUT_INIT_HIGH (GPIOF_DIR_OUT | GPIOF_INIT_HIGH)
32 /* Gpio pin is active-low */
33 #define GPIOF_ACTIVE_LOW (1 << 2)
35 /* Gpio pin is open drain */
36 #define GPIOF_OPEN_DRAIN (1 << 3)
38 /* Gpio pin is open source */
39 #define GPIOF_OPEN_SOURCE (1 << 4)
41 #define GPIOF_EXPORT (1 << 5)
42 #define GPIOF_EXPORT_CHANGEABLE (1 << 6)
43 #define GPIOF_EXPORT_DIR_FIXED (GPIOF_EXPORT)
44 #define GPIOF_EXPORT_DIR_CHANGEABLE (GPIOF_EXPORT | GPIOF_EXPORT_CHANGEABLE)
47 * struct gpio - a structure describing a GPIO with configuration
48 * @gpio: the GPIO number
49 * @flags: GPIO configuration as specified by GPIOF_*
50 * @label: a literal description string of this GPIO
60 #include <linux/gpio/consumer.h>
63 * "valid" GPIO numbers are nonnegative and may be passed to
64 * setup routines like gpio_request(). Only some valid numbers
65 * can successfully be requested and used.
67 * Invalid GPIO numbers are useful for indicating no-such-GPIO in
68 * platform data and other tables.
70 static inline bool gpio_is_valid(int number)
72 /* only non-negative numbers are valid */
77 * Platforms may implement their GPIO interface with library code,
78 * at a small performance cost for non-inlined operations and some
79 * extra memory (for code and for per-GPIO table entries).
83 * At the end we want all GPIOs to be dynamically allocated from 0.
84 * However, some legacy drivers still perform fixed allocation.
85 * Until they are all fixed, leave 0-512 space for them.
87 #define GPIO_DYNAMIC_BASE 512
89 /* Always use the library code for GPIO management calls,
90 * or when sleeping may be involved.
92 int gpio_request(unsigned gpio, const char *label);
93 void gpio_free(unsigned gpio);
95 static inline int gpio_direction_input(unsigned gpio)
97 return gpiod_direction_input(gpio_to_desc(gpio));
99 static inline int gpio_direction_output(unsigned gpio, int value)
101 return gpiod_direction_output_raw(gpio_to_desc(gpio), value);
104 static inline int gpio_get_value_cansleep(unsigned gpio)
106 return gpiod_get_raw_value_cansleep(gpio_to_desc(gpio));
108 static inline void gpio_set_value_cansleep(unsigned gpio, int value)
110 return gpiod_set_raw_value_cansleep(gpio_to_desc(gpio), value);
113 static inline int gpio_get_value(unsigned gpio)
115 return gpiod_get_raw_value(gpio_to_desc(gpio));
117 static inline void gpio_set_value(unsigned gpio, int value)
119 return gpiod_set_raw_value(gpio_to_desc(gpio), value);
122 static inline int gpio_cansleep(unsigned gpio)
124 return gpiod_cansleep(gpio_to_desc(gpio));
127 static inline int gpio_to_irq(unsigned gpio)
129 return gpiod_to_irq(gpio_to_desc(gpio));
132 int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
133 int gpio_request_array(const struct gpio *array, size_t num);
134 void gpio_free_array(const struct gpio *array, size_t num);
136 /* CONFIG_GPIOLIB: bindings for managed devices that want to request gpios */
138 int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
139 int devm_gpio_request_one(struct device *dev, unsigned gpio,
140 unsigned long flags, const char *label);
142 #else /* ! CONFIG_GPIOLIB */
144 #include <linux/kernel.h>
147 #include <asm/errno.h>
149 static inline bool gpio_is_valid(int number)
154 static inline int gpio_request(unsigned gpio, const char *label)
159 static inline int gpio_request_one(unsigned gpio,
160 unsigned long flags, const char *label)
165 static inline int gpio_request_array(const struct gpio *array, size_t num)
170 static inline void gpio_free(unsigned gpio)
174 /* GPIO can never have been requested */
178 static inline void gpio_free_array(const struct gpio *array, size_t num)
182 /* GPIO can never have been requested */
186 static inline int gpio_direction_input(unsigned gpio)
191 static inline int gpio_direction_output(unsigned gpio, int value)
196 static inline int gpio_get_value(unsigned gpio)
198 /* GPIO can never have been requested or set as {in,out}put */
203 static inline void gpio_set_value(unsigned gpio, int value)
205 /* GPIO can never have been requested or set as output */
209 static inline int gpio_cansleep(unsigned gpio)
211 /* GPIO can never have been requested or set as {in,out}put */
216 static inline int gpio_get_value_cansleep(unsigned gpio)
218 /* GPIO can never have been requested or set as {in,out}put */
223 static inline void gpio_set_value_cansleep(unsigned gpio, int value)
225 /* GPIO can never have been requested or set as output */
229 static inline int gpio_to_irq(unsigned gpio)
231 /* GPIO can never have been requested or set as input */
236 static inline int devm_gpio_request(struct device *dev, unsigned gpio,
243 static inline int devm_gpio_request_one(struct device *dev, unsigned gpio,
244 unsigned long flags, const char *label)
250 #endif /* ! CONFIG_GPIOLIB */
252 #endif /* __LINUX_GPIO_H */