Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
56a46b61 LW |
2 | /* |
3 | * <linux/gpio.h> | |
4 | * | |
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. | |
8 | * | |
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> | |
11 | */ | |
7560fa60 DB |
12 | #ifndef __LINUX_GPIO_H |
13 | #define __LINUX_GPIO_H | |
14 | ||
7563bbf8 MB |
15 | #include <linux/errno.h> |
16 | ||
60a86668 | 17 | /* see Documentation/driver-api/gpio/legacy.rst */ |
7560fa60 | 18 | |
c001fb72 RD |
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) | |
22 | ||
23 | #define GPIOF_INIT_LOW (0 << 1) | |
24 | #define GPIOF_INIT_HIGH (1 << 1) | |
25 | ||
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) | |
29 | ||
79a9becd AC |
30 | /* Gpio pin is active-low */ |
31 | #define GPIOF_ACTIVE_LOW (1 << 2) | |
32 | ||
aca5ce14 | 33 | /* Gpio pin is open drain */ |
79a9becd | 34 | #define GPIOF_OPEN_DRAIN (1 << 3) |
aca5ce14 | 35 | |
25553ff0 | 36 | /* Gpio pin is open source */ |
79a9becd | 37 | #define GPIOF_OPEN_SOURCE (1 << 4) |
25553ff0 | 38 | |
79a9becd AC |
39 | #define GPIOF_EXPORT (1 << 5) |
40 | #define GPIOF_EXPORT_CHANGEABLE (1 << 6) | |
fc3a1f04 WS |
41 | #define GPIOF_EXPORT_DIR_FIXED (GPIOF_EXPORT) |
42 | #define GPIOF_EXPORT_DIR_CHANGEABLE (GPIOF_EXPORT | GPIOF_EXPORT_CHANGEABLE) | |
43 | ||
feb83699 MB |
44 | /** |
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 | |
49 | */ | |
50 | struct gpio { | |
51 | unsigned gpio; | |
52 | unsigned long flags; | |
53 | const char *label; | |
54 | }; | |
55 | ||
76ec9d18 | 56 | #ifdef CONFIG_GPIOLIB |
7563bbf8 MB |
57 | |
58 | #ifdef CONFIG_ARCH_HAVE_CUSTOM_GPIO_H | |
7560fa60 | 59 | #include <asm/gpio.h> |
7563bbf8 MB |
60 | #else |
61 | ||
62 | #include <asm-generic/gpio.h> | |
63 | ||
64 | static inline int gpio_get_value(unsigned int gpio) | |
65 | { | |
66 | return __gpio_get_value(gpio); | |
67 | } | |
68 | ||
69 | static inline void gpio_set_value(unsigned int gpio, int value) | |
70 | { | |
71 | __gpio_set_value(gpio, value); | |
72 | } | |
73 | ||
74 | static inline int gpio_cansleep(unsigned int gpio) | |
75 | { | |
76 | return __gpio_cansleep(gpio); | |
77 | } | |
78 | ||
79 | static inline int gpio_to_irq(unsigned int gpio) | |
80 | { | |
81 | return __gpio_to_irq(gpio); | |
82 | } | |
83 | ||
84 | static inline int irq_to_gpio(unsigned int irq) | |
85 | { | |
86 | return -EINVAL; | |
87 | } | |
88 | ||
165adc9c | 89 | #endif /* ! CONFIG_ARCH_HAVE_CUSTOM_GPIO_H */ |
7560fa60 | 90 | |
403c1d0b LW |
91 | /* CONFIG_GPIOLIB: bindings for managed devices that want to request gpios */ |
92 | ||
93 | struct device; | |
94 | ||
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); | |
403c1d0b | 98 | |
76ec9d18 | 99 | #else /* ! CONFIG_GPIOLIB */ |
7560fa60 | 100 | |
3d599d1c | 101 | #include <linux/kernel.h> |
6ea0205b | 102 | #include <linux/types.h> |
187f1882 | 103 | #include <linux/bug.h> |
6ea0205b | 104 | |
a4177ee7 | 105 | struct device; |
4e4438b8 | 106 | struct gpio_chip; |
a4177ee7 | 107 | |
3474cb3c | 108 | static inline bool gpio_is_valid(int number) |
7560fa60 | 109 | { |
3474cb3c | 110 | return false; |
7560fa60 DB |
111 | } |
112 | ||
d8a3515e | 113 | static inline int gpio_request(unsigned gpio, const char *label) |
7560fa60 DB |
114 | { |
115 | return -ENOSYS; | |
116 | } | |
117 | ||
323b7fe8 | 118 | static inline int gpio_request_one(unsigned gpio, |
5f829e40 WS |
119 | unsigned long flags, const char *label) |
120 | { | |
121 | return -ENOSYS; | |
122 | } | |
123 | ||
7c295975 | 124 | static inline int gpio_request_array(const struct gpio *array, size_t num) |
5f829e40 WS |
125 | { |
126 | return -ENOSYS; | |
127 | } | |
128 | ||
7560fa60 DB |
129 | static inline void gpio_free(unsigned gpio) |
130 | { | |
3d599d1c UKK |
131 | might_sleep(); |
132 | ||
7560fa60 | 133 | /* GPIO can never have been requested */ |
2c96922a MB |
134 | WARN_ON(1); |
135 | } | |
136 | ||
7c295975 | 137 | static inline void gpio_free_array(const struct gpio *array, size_t num) |
5f829e40 WS |
138 | { |
139 | might_sleep(); | |
140 | ||
141 | /* GPIO can never have been requested */ | |
142 | WARN_ON(1); | |
143 | } | |
144 | ||
d8a3515e | 145 | static inline int gpio_direction_input(unsigned gpio) |
7560fa60 DB |
146 | { |
147 | return -ENOSYS; | |
148 | } | |
149 | ||
d8a3515e | 150 | static inline int gpio_direction_output(unsigned gpio, int value) |
7560fa60 DB |
151 | { |
152 | return -ENOSYS; | |
153 | } | |
154 | ||
c4b5be98 FB |
155 | static inline int gpio_set_debounce(unsigned gpio, unsigned debounce) |
156 | { | |
157 | return -ENOSYS; | |
158 | } | |
159 | ||
7560fa60 DB |
160 | static inline int gpio_get_value(unsigned gpio) |
161 | { | |
162 | /* GPIO can never have been requested or set as {in,out}put */ | |
163 | WARN_ON(1); | |
164 | return 0; | |
165 | } | |
166 | ||
167 | static inline void gpio_set_value(unsigned gpio, int value) | |
168 | { | |
169 | /* GPIO can never have been requested or set as output */ | |
170 | WARN_ON(1); | |
171 | } | |
172 | ||
173 | static inline int gpio_cansleep(unsigned gpio) | |
174 | { | |
175 | /* GPIO can never have been requested or set as {in,out}put */ | |
176 | WARN_ON(1); | |
177 | return 0; | |
178 | } | |
179 | ||
180 | static inline int gpio_get_value_cansleep(unsigned gpio) | |
181 | { | |
182 | /* GPIO can never have been requested or set as {in,out}put */ | |
183 | WARN_ON(1); | |
184 | return 0; | |
185 | } | |
186 | ||
187 | static inline void gpio_set_value_cansleep(unsigned gpio, int value) | |
188 | { | |
189 | /* GPIO can never have been requested or set as output */ | |
190 | WARN_ON(1); | |
191 | } | |
192 | ||
d8f388d8 DB |
193 | static inline int gpio_export(unsigned gpio, bool direction_may_change) |
194 | { | |
195 | /* GPIO can never have been requested or set as {in,out}put */ | |
196 | WARN_ON(1); | |
197 | return -EINVAL; | |
198 | } | |
199 | ||
a4177ee7 JN |
200 | static inline int gpio_export_link(struct device *dev, const char *name, |
201 | unsigned gpio) | |
202 | { | |
203 | /* GPIO can never have been exported */ | |
204 | WARN_ON(1); | |
205 | return -EINVAL; | |
206 | } | |
207 | ||
d8f388d8 DB |
208 | static inline void gpio_unexport(unsigned gpio) |
209 | { | |
210 | /* GPIO can never have been exported */ | |
211 | WARN_ON(1); | |
212 | } | |
213 | ||
7560fa60 DB |
214 | static inline int gpio_to_irq(unsigned gpio) |
215 | { | |
216 | /* GPIO can never have been requested or set as input */ | |
217 | WARN_ON(1); | |
218 | return -EINVAL; | |
219 | } | |
220 | ||
221 | static inline int irq_to_gpio(unsigned irq) | |
222 | { | |
223 | /* irq can never have been returned from gpio_to_irq() */ | |
224 | WARN_ON(1); | |
225 | return -EINVAL; | |
226 | } | |
227 | ||
403c1d0b LW |
228 | static inline int devm_gpio_request(struct device *dev, unsigned gpio, |
229 | const char *label) | |
230 | { | |
231 | WARN_ON(1); | |
232 | return -EINVAL; | |
233 | } | |
7560fa60 | 234 | |
403c1d0b LW |
235 | static inline int devm_gpio_request_one(struct device *dev, unsigned gpio, |
236 | unsigned long flags, const char *label) | |
237 | { | |
238 | WARN_ON(1); | |
239 | return -EINVAL; | |
240 | } | |
6a89a314 | 241 | |
403c1d0b | 242 | #endif /* ! CONFIG_GPIOLIB */ |
6a89a314 | 243 | |
7560fa60 | 244 | #endif /* __LINUX_GPIO_H */ |