blob: b581b13d29d95aef275b1b878927f5d94e2572e4 [file] [log] [blame]
David Brownell7560fa62008-03-04 14:28:27 -08001#ifndef __LINUX_GPIO_H
2#define __LINUX_GPIO_H
3
Mark Brown7563bbf2012-04-15 10:52:54 +01004#include <linux/errno.h>
5
David Brownell7560fa62008-03-04 14:28:27 -08006/* see Documentation/gpio.txt */
7
Randy Dunlapc001fb72011-06-14 17:05:11 -07008/* make these flag values available regardless of GPIO kconfig options */
9#define GPIOF_DIR_OUT (0 << 0)
10#define GPIOF_DIR_IN (1 << 0)
11
12#define GPIOF_INIT_LOW (0 << 1)
13#define GPIOF_INIT_HIGH (1 << 1)
14
15#define GPIOF_IN (GPIOF_DIR_IN)
16#define GPIOF_OUT_INIT_LOW (GPIOF_DIR_OUT | GPIOF_INIT_LOW)
17#define GPIOF_OUT_INIT_HIGH (GPIOF_DIR_OUT | GPIOF_INIT_HIGH)
18
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070019/* Gpio pin is active-low */
20#define GPIOF_ACTIVE_LOW (1 << 2)
21
Laxman Dewanganaca5ce12012-02-17 20:26:21 +053022/* Gpio pin is open drain */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070023#define GPIOF_OPEN_DRAIN (1 << 3)
Laxman Dewanganaca5ce12012-02-17 20:26:21 +053024
Laxman Dewangan25553ff2012-02-17 20:26:22 +053025/* Gpio pin is open source */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070026#define GPIOF_OPEN_SOURCE (1 << 4)
Laxman Dewangan25553ff2012-02-17 20:26:22 +053027
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070028#define GPIOF_EXPORT (1 << 5)
29#define GPIOF_EXPORT_CHANGEABLE (1 << 6)
Wolfram Sangfc3a1f02011-12-13 18:34:01 +010030#define GPIOF_EXPORT_DIR_FIXED (GPIOF_EXPORT)
31#define GPIOF_EXPORT_DIR_CHANGEABLE (GPIOF_EXPORT | GPIOF_EXPORT_CHANGEABLE)
32
Mark Brownfeb83692011-10-24 15:24:10 +020033/**
34 * struct gpio - a structure describing a GPIO with configuration
35 * @gpio: the GPIO number
36 * @flags: GPIO configuration as specified by GPIOF_*
37 * @label: a literal description string of this GPIO
38 */
39struct gpio {
40 unsigned gpio;
41 unsigned long flags;
42 const char *label;
43};
44
Alexandre Courbot76ec9d12013-03-28 04:34:56 -070045#ifdef CONFIG_GPIOLIB
Mark Brown7563bbf2012-04-15 10:52:54 +010046
47#ifdef CONFIG_ARCH_HAVE_CUSTOM_GPIO_H
David Brownell7560fa62008-03-04 14:28:27 -080048#include <asm/gpio.h>
Mark Brown7563bbf2012-04-15 10:52:54 +010049#else
50
51#include <asm-generic/gpio.h>
52
53static inline int gpio_get_value(unsigned int gpio)
54{
55 return __gpio_get_value(gpio);
56}
57
58static inline void gpio_set_value(unsigned int gpio, int value)
59{
60 __gpio_set_value(gpio, value);
61}
62
63static inline int gpio_cansleep(unsigned int gpio)
64{
65 return __gpio_cansleep(gpio);
66}
67
68static inline int gpio_to_irq(unsigned int gpio)
69{
70 return __gpio_to_irq(gpio);
71}
72
73static inline int irq_to_gpio(unsigned int irq)
74{
75 return -EINVAL;
76}
77
Linus Walleij165adc92012-11-06 14:49:39 +010078#endif /* ! CONFIG_ARCH_HAVE_CUSTOM_GPIO_H */
David Brownell7560fa62008-03-04 14:28:27 -080079
Linus Walleij403c1d02013-10-25 12:59:05 +020080/* CONFIG_GPIOLIB: bindings for managed devices that want to request gpios */
81
82struct device;
83
84int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
85int devm_gpio_request_one(struct device *dev, unsigned gpio,
86 unsigned long flags, const char *label);
87void devm_gpio_free(struct device *dev, unsigned int gpio);
88
Alexandre Courbot76ec9d12013-03-28 04:34:56 -070089#else /* ! CONFIG_GPIOLIB */
David Brownell7560fa62008-03-04 14:28:27 -080090
Uwe Kleine-König3d599d12008-10-15 22:03:12 -070091#include <linux/kernel.h>
David Brownell6ea02052008-05-23 13:04:58 -070092#include <linux/types.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050093#include <linux/bug.h>
Christian Ruppert586a87e2013-10-15 15:37:54 +020094#include <linux/pinctrl/pinctrl.h>
David Brownell6ea02052008-05-23 13:04:58 -070095
Jani Nikulaa4177ee2009-09-22 16:46:33 -070096struct device;
Anton Vorontsov4e4438b2010-09-01 08:55:24 -060097struct gpio_chip;
Jani Nikulaa4177ee2009-09-22 16:46:33 -070098
Joe Perches3474cb32011-05-10 16:23:07 -070099static inline bool gpio_is_valid(int number)
David Brownell7560fa62008-03-04 14:28:27 -0800100{
Joe Perches3474cb32011-05-10 16:23:07 -0700101 return false;
David Brownell7560fa62008-03-04 14:28:27 -0800102}
103
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800104static inline int gpio_request(unsigned gpio, const char *label)
David Brownell7560fa62008-03-04 14:28:27 -0800105{
106 return -ENOSYS;
107}
108
Wolfram Sang323b7fe2011-01-14 09:34:29 +0100109static inline int gpio_request_one(unsigned gpio,
Wolfram Sang5f829e42011-01-12 17:00:24 -0800110 unsigned long flags, const char *label)
111{
112 return -ENOSYS;
113}
114
Lars-Peter Clausen7c295972011-05-25 16:20:31 -0700115static inline int gpio_request_array(const struct gpio *array, size_t num)
Wolfram Sang5f829e42011-01-12 17:00:24 -0800116{
117 return -ENOSYS;
118}
119
David Brownell7560fa62008-03-04 14:28:27 -0800120static inline void gpio_free(unsigned gpio)
121{
Uwe Kleine-König3d599d12008-10-15 22:03:12 -0700122 might_sleep();
123
David Brownell7560fa62008-03-04 14:28:27 -0800124 /* GPIO can never have been requested */
125 WARN_ON(1);
126}
127
Lars-Peter Clausen7c295972011-05-25 16:20:31 -0700128static inline void gpio_free_array(const struct gpio *array, size_t num)
Wolfram Sang5f829e42011-01-12 17:00:24 -0800129{
130 might_sleep();
131
132 /* GPIO can never have been requested */
133 WARN_ON(1);
134}
135
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800136static inline int gpio_direction_input(unsigned gpio)
David Brownell7560fa62008-03-04 14:28:27 -0800137{
138 return -ENOSYS;
139}
140
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800141static inline int gpio_direction_output(unsigned gpio, int value)
David Brownell7560fa62008-03-04 14:28:27 -0800142{
143 return -ENOSYS;
144}
145
Felipe Balbic4b5be92010-05-26 14:42:23 -0700146static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
147{
148 return -ENOSYS;
149}
150
David Brownell7560fa62008-03-04 14:28:27 -0800151static inline int gpio_get_value(unsigned gpio)
152{
153 /* GPIO can never have been requested or set as {in,out}put */
154 WARN_ON(1);
155 return 0;
156}
157
158static inline void gpio_set_value(unsigned gpio, int value)
159{
160 /* GPIO can never have been requested or set as output */
161 WARN_ON(1);
162}
163
164static inline int gpio_cansleep(unsigned gpio)
165{
166 /* GPIO can never have been requested or set as {in,out}put */
167 WARN_ON(1);
168 return 0;
169}
170
171static inline int gpio_get_value_cansleep(unsigned gpio)
172{
173 /* GPIO can never have been requested or set as {in,out}put */
174 WARN_ON(1);
175 return 0;
176}
177
178static inline void gpio_set_value_cansleep(unsigned gpio, int value)
179{
180 /* GPIO can never have been requested or set as output */
181 WARN_ON(1);
182}
183
David Brownelld8f388d82008-07-25 01:46:07 -0700184static inline int gpio_export(unsigned gpio, bool direction_may_change)
185{
186 /* GPIO can never have been requested or set as {in,out}put */
187 WARN_ON(1);
188 return -EINVAL;
189}
190
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700191static inline int gpio_export_link(struct device *dev, const char *name,
192 unsigned gpio)
193{
194 /* GPIO can never have been exported */
195 WARN_ON(1);
196 return -EINVAL;
197}
198
Jani Nikula07697462009-12-15 16:46:20 -0800199static inline int gpio_sysfs_set_active_low(unsigned gpio, int value)
200{
201 /* GPIO can never have been requested */
202 WARN_ON(1);
203 return -EINVAL;
204}
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700205
David Brownelld8f388d82008-07-25 01:46:07 -0700206static inline void gpio_unexport(unsigned gpio)
207{
208 /* GPIO can never have been exported */
209 WARN_ON(1);
210}
211
David Brownell7560fa62008-03-04 14:28:27 -0800212static inline int gpio_to_irq(unsigned gpio)
213{
214 /* GPIO can never have been requested or set as input */
215 WARN_ON(1);
216 return -EINVAL;
217}
218
Linus Walleijd468bf92013-09-24 11:54:38 +0200219static inline int gpio_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
220{
221 WARN_ON(1);
222 return -EINVAL;
223}
224
225static inline void gpio_unlock_as_irq(struct gpio_chip *chip,
226 unsigned int offset)
227{
228 WARN_ON(1);
229}
230
David Brownell7560fa62008-03-04 14:28:27 -0800231static inline int irq_to_gpio(unsigned irq)
232{
233 /* irq can never have been returned from gpio_to_irq() */
234 WARN_ON(1);
235 return -EINVAL;
236}
237
Linus Walleij1e63d7b2012-11-06 16:03:35 +0100238static inline int
Linus Walleij165adc92012-11-06 14:49:39 +0100239gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
Linus Walleij316511c2012-11-21 08:48:09 +0100240 unsigned int gpio_offset, unsigned int pin_offset,
Linus Walleij3f0f8672012-11-20 12:40:15 +0100241 unsigned int npins)
Linus Walleij165adc92012-11-06 14:49:39 +0100242{
Linus Walleij50309a92012-11-06 17:16:39 +0100243 WARN_ON(1);
244 return -EINVAL;
Linus Walleij165adc92012-11-06 14:49:39 +0100245}
246
Christian Ruppert586a87e2013-10-15 15:37:54 +0200247static inline int
248gpiochip_add_pingroup_range(struct gpio_chip *chip,
249 struct pinctrl_dev *pctldev,
250 unsigned int gpio_offset, const char *pin_group)
251{
252 WARN_ON(1);
253 return -EINVAL;
254}
255
Linus Walleij165adc92012-11-06 14:49:39 +0100256static inline void
257gpiochip_remove_pin_ranges(struct gpio_chip *chip)
258{
Linus Walleij50309a92012-11-06 17:16:39 +0100259 WARN_ON(1);
Linus Walleij165adc92012-11-06 14:49:39 +0100260}
261
Linus Walleij403c1d02013-10-25 12:59:05 +0200262static inline int devm_gpio_request(struct device *dev, unsigned gpio,
263 const char *label)
264{
265 WARN_ON(1);
266 return -EINVAL;
267}
268
269static inline int devm_gpio_request_one(struct device *dev, unsigned gpio,
270 unsigned long flags, const char *label)
271{
272 WARN_ON(1);
273 return -EINVAL;
274}
275
276static inline void devm_gpio_free(struct device *dev, unsigned int gpio)
277{
278 WARN_ON(1);
279}
280
Alexandre Courbot76ec9d12013-03-28 04:34:56 -0700281#endif /* ! CONFIG_GPIOLIB */
David Brownell7560fa62008-03-04 14:28:27 -0800282
David Brownell7560fa62008-03-04 14:28:27 -0800283#endif /* __LINUX_GPIO_H */