blob: 13dfd24d01abc0d156e9cfa553f6b41aac96cb5f [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>
93#include <linux/errno.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050094#include <linux/bug.h>
Christian Ruppert586a87e2013-10-15 15:37:54 +020095#include <linux/pinctrl/pinctrl.h>
David Brownell6ea02052008-05-23 13:04:58 -070096
Jani Nikulaa4177ee2009-09-22 16:46:33 -070097struct device;
Anton Vorontsov4e4438b2010-09-01 08:55:24 -060098struct gpio_chip;
Jani Nikulaa4177ee2009-09-22 16:46:33 -070099
Joe Perches3474cb32011-05-10 16:23:07 -0700100static inline bool gpio_is_valid(int number)
David Brownell7560fa62008-03-04 14:28:27 -0800101{
Joe Perches3474cb32011-05-10 16:23:07 -0700102 return false;
David Brownell7560fa62008-03-04 14:28:27 -0800103}
104
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800105static inline int gpio_request(unsigned gpio, const char *label)
David Brownell7560fa62008-03-04 14:28:27 -0800106{
107 return -ENOSYS;
108}
109
Wolfram Sang323b7fe2011-01-14 09:34:29 +0100110static inline int gpio_request_one(unsigned gpio,
Wolfram Sang5f829e42011-01-12 17:00:24 -0800111 unsigned long flags, const char *label)
112{
113 return -ENOSYS;
114}
115
Lars-Peter Clausen7c295972011-05-25 16:20:31 -0700116static inline int gpio_request_array(const struct gpio *array, size_t num)
Wolfram Sang5f829e42011-01-12 17:00:24 -0800117{
118 return -ENOSYS;
119}
120
David Brownell7560fa62008-03-04 14:28:27 -0800121static inline void gpio_free(unsigned gpio)
122{
Uwe Kleine-König3d599d12008-10-15 22:03:12 -0700123 might_sleep();
124
David Brownell7560fa62008-03-04 14:28:27 -0800125 /* GPIO can never have been requested */
126 WARN_ON(1);
127}
128
Lars-Peter Clausen7c295972011-05-25 16:20:31 -0700129static inline void gpio_free_array(const struct gpio *array, size_t num)
Wolfram Sang5f829e42011-01-12 17:00:24 -0800130{
131 might_sleep();
132
133 /* GPIO can never have been requested */
134 WARN_ON(1);
135}
136
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800137static inline int gpio_direction_input(unsigned gpio)
David Brownell7560fa62008-03-04 14:28:27 -0800138{
139 return -ENOSYS;
140}
141
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800142static inline int gpio_direction_output(unsigned gpio, int value)
David Brownell7560fa62008-03-04 14:28:27 -0800143{
144 return -ENOSYS;
145}
146
Felipe Balbic4b5be92010-05-26 14:42:23 -0700147static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
148{
149 return -ENOSYS;
150}
151
David Brownell7560fa62008-03-04 14:28:27 -0800152static inline int gpio_get_value(unsigned gpio)
153{
154 /* GPIO can never have been requested or set as {in,out}put */
155 WARN_ON(1);
156 return 0;
157}
158
159static inline void gpio_set_value(unsigned gpio, int value)
160{
161 /* GPIO can never have been requested or set as output */
162 WARN_ON(1);
163}
164
165static inline int gpio_cansleep(unsigned gpio)
166{
167 /* GPIO can never have been requested or set as {in,out}put */
168 WARN_ON(1);
169 return 0;
170}
171
172static inline int gpio_get_value_cansleep(unsigned gpio)
173{
174 /* GPIO can never have been requested or set as {in,out}put */
175 WARN_ON(1);
176 return 0;
177}
178
179static inline void gpio_set_value_cansleep(unsigned gpio, int value)
180{
181 /* GPIO can never have been requested or set as output */
182 WARN_ON(1);
183}
184
David Brownelld8f388d82008-07-25 01:46:07 -0700185static inline int gpio_export(unsigned gpio, bool direction_may_change)
186{
187 /* GPIO can never have been requested or set as {in,out}put */
188 WARN_ON(1);
189 return -EINVAL;
190}
191
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700192static inline int gpio_export_link(struct device *dev, const char *name,
193 unsigned gpio)
194{
195 /* GPIO can never have been exported */
196 WARN_ON(1);
197 return -EINVAL;
198}
199
Jani Nikula07697462009-12-15 16:46:20 -0800200static inline int gpio_sysfs_set_active_low(unsigned gpio, int value)
201{
202 /* GPIO can never have been requested */
203 WARN_ON(1);
204 return -EINVAL;
205}
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700206
David Brownelld8f388d82008-07-25 01:46:07 -0700207static inline void gpio_unexport(unsigned gpio)
208{
209 /* GPIO can never have been exported */
210 WARN_ON(1);
211}
212
David Brownell7560fa62008-03-04 14:28:27 -0800213static inline int gpio_to_irq(unsigned gpio)
214{
215 /* GPIO can never have been requested or set as input */
216 WARN_ON(1);
217 return -EINVAL;
218}
219
Linus Walleijd468bf92013-09-24 11:54:38 +0200220static inline int gpio_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
221{
222 WARN_ON(1);
223 return -EINVAL;
224}
225
226static inline void gpio_unlock_as_irq(struct gpio_chip *chip,
227 unsigned int offset)
228{
229 WARN_ON(1);
230}
231
David Brownell7560fa62008-03-04 14:28:27 -0800232static inline int irq_to_gpio(unsigned irq)
233{
234 /* irq can never have been returned from gpio_to_irq() */
235 WARN_ON(1);
236 return -EINVAL;
237}
238
Linus Walleij1e63d7b2012-11-06 16:03:35 +0100239static inline int
Linus Walleij165adc92012-11-06 14:49:39 +0100240gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
Linus Walleij316511c2012-11-21 08:48:09 +0100241 unsigned int gpio_offset, unsigned int pin_offset,
Linus Walleij3f0f8672012-11-20 12:40:15 +0100242 unsigned int npins)
Linus Walleij165adc92012-11-06 14:49:39 +0100243{
Linus Walleij50309a92012-11-06 17:16:39 +0100244 WARN_ON(1);
245 return -EINVAL;
Linus Walleij165adc92012-11-06 14:49:39 +0100246}
247
Christian Ruppert586a87e2013-10-15 15:37:54 +0200248static inline int
249gpiochip_add_pingroup_range(struct gpio_chip *chip,
250 struct pinctrl_dev *pctldev,
251 unsigned int gpio_offset, const char *pin_group)
252{
253 WARN_ON(1);
254 return -EINVAL;
255}
256
Linus Walleij165adc92012-11-06 14:49:39 +0100257static inline void
258gpiochip_remove_pin_ranges(struct gpio_chip *chip)
259{
Linus Walleij50309a92012-11-06 17:16:39 +0100260 WARN_ON(1);
Linus Walleij165adc92012-11-06 14:49:39 +0100261}
262
Linus Walleij403c1d02013-10-25 12:59:05 +0200263static inline int devm_gpio_request(struct device *dev, unsigned gpio,
264 const char *label)
265{
266 WARN_ON(1);
267 return -EINVAL;
268}
269
270static inline int devm_gpio_request_one(struct device *dev, unsigned gpio,
271 unsigned long flags, const char *label)
272{
273 WARN_ON(1);
274 return -EINVAL;
275}
276
277static inline void devm_gpio_free(struct device *dev, unsigned int gpio)
278{
279 WARN_ON(1);
280}
281
Alexandre Courbot76ec9d12013-03-28 04:34:56 -0700282#endif /* ! CONFIG_GPIOLIB */
David Brownell7560fa62008-03-04 14:28:27 -0800283
David Brownell7560fa62008-03-04 14:28:27 -0800284#endif /* __LINUX_GPIO_H */