usb: uas: add support for more quirk flags
[platform/kernel/linux-rpi.git] / include / linux / gpio.h
1 /* SPDX-License-Identifier: GPL-2.0 */
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  */
12 #ifndef __LINUX_GPIO_H
13 #define __LINUX_GPIO_H
14
15 #include <linux/errno.h>
16
17 /* see Documentation/driver-api/gpio/legacy.rst */
18
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
30 /* Gpio pin is active-low */
31 #define GPIOF_ACTIVE_LOW        (1 << 2)
32
33 /* Gpio pin is open drain */
34 #define GPIOF_OPEN_DRAIN        (1 << 3)
35
36 /* Gpio pin is open source */
37 #define GPIOF_OPEN_SOURCE       (1 << 4)
38
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)
43
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
56 #ifdef CONFIG_GPIOLIB
57
58 #ifdef CONFIG_ARCH_HAVE_CUSTOM_GPIO_H
59 #include <asm/gpio.h>
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
89 #endif /* ! CONFIG_ARCH_HAVE_CUSTOM_GPIO_H */
90
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);
98 void devm_gpio_free(struct device *dev, unsigned int gpio);
99
100 #else /* ! CONFIG_GPIOLIB */
101
102 #include <linux/kernel.h>
103 #include <linux/types.h>
104 #include <linux/bug.h>
105 #include <linux/pinctrl/pinctrl.h>
106
107 struct device;
108 struct gpio_chip;
109
110 static inline bool gpio_is_valid(int number)
111 {
112         return false;
113 }
114
115 static inline int gpio_request(unsigned gpio, const char *label)
116 {
117         return -ENOSYS;
118 }
119
120 static inline int gpio_request_one(unsigned gpio,
121                                         unsigned long flags, const char *label)
122 {
123         return -ENOSYS;
124 }
125
126 static inline int gpio_request_array(const struct gpio *array, size_t num)
127 {
128         return -ENOSYS;
129 }
130
131 static inline void gpio_free(unsigned gpio)
132 {
133         might_sleep();
134
135         /* GPIO can never have been requested */
136         WARN_ON(1);
137 }
138
139 static inline void gpio_free_array(const struct gpio *array, size_t num)
140 {
141         might_sleep();
142
143         /* GPIO can never have been requested */
144         WARN_ON(1);
145 }
146
147 static inline int gpio_direction_input(unsigned gpio)
148 {
149         return -ENOSYS;
150 }
151
152 static inline int gpio_direction_output(unsigned gpio, int value)
153 {
154         return -ENOSYS;
155 }
156
157 static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
158 {
159         return -ENOSYS;
160 }
161
162 static inline int gpio_get_value(unsigned gpio)
163 {
164         /* GPIO can never have been requested or set as {in,out}put */
165         WARN_ON(1);
166         return 0;
167 }
168
169 static inline void gpio_set_value(unsigned gpio, int value)
170 {
171         /* GPIO can never have been requested or set as output */
172         WARN_ON(1);
173 }
174
175 static inline int gpio_cansleep(unsigned gpio)
176 {
177         /* GPIO can never have been requested or set as {in,out}put */
178         WARN_ON(1);
179         return 0;
180 }
181
182 static inline int gpio_get_value_cansleep(unsigned gpio)
183 {
184         /* GPIO can never have been requested or set as {in,out}put */
185         WARN_ON(1);
186         return 0;
187 }
188
189 static inline void gpio_set_value_cansleep(unsigned gpio, int value)
190 {
191         /* GPIO can never have been requested or set as output */
192         WARN_ON(1);
193 }
194
195 static inline int gpio_export(unsigned gpio, bool direction_may_change)
196 {
197         /* GPIO can never have been requested or set as {in,out}put */
198         WARN_ON(1);
199         return -EINVAL;
200 }
201
202 static inline int gpio_export_link(struct device *dev, const char *name,
203                                 unsigned gpio)
204 {
205         /* GPIO can never have been exported */
206         WARN_ON(1);
207         return -EINVAL;
208 }
209
210 static inline void gpio_unexport(unsigned gpio)
211 {
212         /* GPIO can never have been exported */
213         WARN_ON(1);
214 }
215
216 static inline int gpio_to_irq(unsigned gpio)
217 {
218         /* GPIO can never have been requested or set as input */
219         WARN_ON(1);
220         return -EINVAL;
221 }
222
223 static inline int gpiochip_lock_as_irq(struct gpio_chip *chip,
224                                        unsigned int offset)
225 {
226         WARN_ON(1);
227         return -EINVAL;
228 }
229
230 static inline void gpiochip_unlock_as_irq(struct gpio_chip *chip,
231                                           unsigned int offset)
232 {
233         WARN_ON(1);
234 }
235
236 static inline int irq_to_gpio(unsigned irq)
237 {
238         /* irq can never have been returned from gpio_to_irq() */
239         WARN_ON(1);
240         return -EINVAL;
241 }
242
243 static inline int
244 gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
245                        unsigned int gpio_offset, unsigned int pin_offset,
246                        unsigned int npins)
247 {
248         WARN_ON(1);
249         return -EINVAL;
250 }
251
252 static inline int
253 gpiochip_add_pingroup_range(struct gpio_chip *chip,
254                         struct pinctrl_dev *pctldev,
255                         unsigned int gpio_offset, const char *pin_group)
256 {
257         WARN_ON(1);
258         return -EINVAL;
259 }
260
261 static inline void
262 gpiochip_remove_pin_ranges(struct gpio_chip *chip)
263 {
264         WARN_ON(1);
265 }
266
267 static inline int devm_gpio_request(struct device *dev, unsigned gpio,
268                                     const char *label)
269 {
270         WARN_ON(1);
271         return -EINVAL;
272 }
273
274 static inline int devm_gpio_request_one(struct device *dev, unsigned gpio,
275                                         unsigned long flags, const char *label)
276 {
277         WARN_ON(1);
278         return -EINVAL;
279 }
280
281 static inline void devm_gpio_free(struct device *dev, unsigned int gpio)
282 {
283         WARN_ON(1);
284 }
285
286 #endif /* ! CONFIG_GPIOLIB */
287
288 #endif /* __LINUX_GPIO_H */