blob: f6c7ae3e223b53914eac6ae4941a977d03597636 [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
Laxman Dewanganaca5ce12012-02-17 20:26:21 +053019/* Gpio pin is open drain */
20#define GPIOF_OPEN_DRAIN (1 << 2)
21
Laxman Dewangan25553ff2012-02-17 20:26:22 +053022/* Gpio pin is open source */
23#define GPIOF_OPEN_SOURCE (1 << 3)
24
Laxman Dewanganf567fde2012-06-20 14:14:05 +053025#define GPIOF_EXPORT (1 << 4)
26#define GPIOF_EXPORT_CHANGEABLE (1 << 5)
Wolfram Sangfc3a1f02011-12-13 18:34:01 +010027#define GPIOF_EXPORT_DIR_FIXED (GPIOF_EXPORT)
28#define GPIOF_EXPORT_DIR_CHANGEABLE (GPIOF_EXPORT | GPIOF_EXPORT_CHANGEABLE)
29
Mark Brownfeb83692011-10-24 15:24:10 +020030/**
31 * struct gpio - a structure describing a GPIO with configuration
32 * @gpio: the GPIO number
33 * @flags: GPIO configuration as specified by GPIOF_*
34 * @label: a literal description string of this GPIO
35 */
36struct gpio {
37 unsigned gpio;
38 unsigned long flags;
39 const char *label;
40};
41
David Brownell7560fa62008-03-04 14:28:27 -080042#ifdef CONFIG_GENERIC_GPIO
Mark Brown7563bbf2012-04-15 10:52:54 +010043
44#ifdef CONFIG_ARCH_HAVE_CUSTOM_GPIO_H
David Brownell7560fa62008-03-04 14:28:27 -080045#include <asm/gpio.h>
Mark Brown7563bbf2012-04-15 10:52:54 +010046#else
47
48#include <asm-generic/gpio.h>
49
50static inline int gpio_get_value(unsigned int gpio)
51{
52 return __gpio_get_value(gpio);
53}
54
55static inline void gpio_set_value(unsigned int gpio, int value)
56{
57 __gpio_set_value(gpio, value);
58}
59
60static inline int gpio_cansleep(unsigned int gpio)
61{
62 return __gpio_cansleep(gpio);
63}
64
65static inline int gpio_to_irq(unsigned int gpio)
66{
67 return __gpio_to_irq(gpio);
68}
69
70static inline int irq_to_gpio(unsigned int irq)
71{
72 return -EINVAL;
73}
74
Linus Walleij165adc92012-11-06 14:49:39 +010075#endif /* ! CONFIG_ARCH_HAVE_CUSTOM_GPIO_H */
David Brownell7560fa62008-03-04 14:28:27 -080076
Linus Walleij165adc92012-11-06 14:49:39 +010077#else /* ! CONFIG_GENERIC_GPIO */
David Brownell7560fa62008-03-04 14:28:27 -080078
Uwe Kleine-König3d599d12008-10-15 22:03:12 -070079#include <linux/kernel.h>
David Brownell6ea02052008-05-23 13:04:58 -070080#include <linux/types.h>
81#include <linux/errno.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050082#include <linux/bug.h>
David Brownell6ea02052008-05-23 13:04:58 -070083
Jani Nikulaa4177ee2009-09-22 16:46:33 -070084struct device;
Anton Vorontsov4e4438b2010-09-01 08:55:24 -060085struct gpio_chip;
Jani Nikulaa4177ee2009-09-22 16:46:33 -070086
Joe Perches3474cb32011-05-10 16:23:07 -070087static inline bool gpio_is_valid(int number)
David Brownell7560fa62008-03-04 14:28:27 -080088{
Joe Perches3474cb32011-05-10 16:23:07 -070089 return false;
David Brownell7560fa62008-03-04 14:28:27 -080090}
91
Linus Torvaldsd8a35152011-01-13 17:26:46 -080092static inline int gpio_request(unsigned gpio, const char *label)
David Brownell7560fa62008-03-04 14:28:27 -080093{
94 return -ENOSYS;
95}
96
Wolfram Sang323b7fe2011-01-14 09:34:29 +010097static inline int gpio_request_one(unsigned gpio,
Wolfram Sang5f829e42011-01-12 17:00:24 -080098 unsigned long flags, const char *label)
99{
100 return -ENOSYS;
101}
102
Lars-Peter Clausen7c295972011-05-25 16:20:31 -0700103static inline int gpio_request_array(const struct gpio *array, size_t num)
Wolfram Sang5f829e42011-01-12 17:00:24 -0800104{
105 return -ENOSYS;
106}
107
David Brownell7560fa62008-03-04 14:28:27 -0800108static inline void gpio_free(unsigned gpio)
109{
Uwe Kleine-König3d599d12008-10-15 22:03:12 -0700110 might_sleep();
111
David Brownell7560fa62008-03-04 14:28:27 -0800112 /* GPIO can never have been requested */
113 WARN_ON(1);
114}
115
Lars-Peter Clausen7c295972011-05-25 16:20:31 -0700116static inline void gpio_free_array(const struct gpio *array, size_t num)
Wolfram Sang5f829e42011-01-12 17:00:24 -0800117{
118 might_sleep();
119
120 /* GPIO can never have been requested */
121 WARN_ON(1);
122}
123
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800124static inline int gpio_direction_input(unsigned gpio)
David Brownell7560fa62008-03-04 14:28:27 -0800125{
126 return -ENOSYS;
127}
128
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800129static inline int gpio_direction_output(unsigned gpio, int value)
David Brownell7560fa62008-03-04 14:28:27 -0800130{
131 return -ENOSYS;
132}
133
Felipe Balbic4b5be92010-05-26 14:42:23 -0700134static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
135{
136 return -ENOSYS;
137}
138
David Brownell7560fa62008-03-04 14:28:27 -0800139static inline int gpio_get_value(unsigned gpio)
140{
141 /* GPIO can never have been requested or set as {in,out}put */
142 WARN_ON(1);
143 return 0;
144}
145
146static inline void gpio_set_value(unsigned gpio, int value)
147{
148 /* GPIO can never have been requested or set as output */
149 WARN_ON(1);
150}
151
152static inline int gpio_cansleep(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 int gpio_get_value_cansleep(unsigned gpio)
160{
161 /* GPIO can never have been requested or set as {in,out}put */
162 WARN_ON(1);
163 return 0;
164}
165
166static inline void gpio_set_value_cansleep(unsigned gpio, int value)
167{
168 /* GPIO can never have been requested or set as output */
169 WARN_ON(1);
170}
171
David Brownelld8f388d2008-07-25 01:46:07 -0700172static inline int gpio_export(unsigned gpio, bool direction_may_change)
173{
174 /* GPIO can never have been requested or set as {in,out}put */
175 WARN_ON(1);
176 return -EINVAL;
177}
178
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700179static inline int gpio_export_link(struct device *dev, const char *name,
180 unsigned gpio)
181{
182 /* GPIO can never have been exported */
183 WARN_ON(1);
184 return -EINVAL;
185}
186
Jani Nikula07697462009-12-15 16:46:20 -0800187static inline int gpio_sysfs_set_active_low(unsigned gpio, int value)
188{
189 /* GPIO can never have been requested */
190 WARN_ON(1);
191 return -EINVAL;
192}
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700193
David Brownelld8f388d2008-07-25 01:46:07 -0700194static inline void gpio_unexport(unsigned gpio)
195{
196 /* GPIO can never have been exported */
197 WARN_ON(1);
198}
199
David Brownell7560fa62008-03-04 14:28:27 -0800200static inline int gpio_to_irq(unsigned gpio)
201{
202 /* GPIO can never have been requested or set as input */
203 WARN_ON(1);
204 return -EINVAL;
205}
206
207static inline int irq_to_gpio(unsigned irq)
208{
209 /* irq can never have been returned from gpio_to_irq() */
210 WARN_ON(1);
211 return -EINVAL;
212}
213
Linus Walleij1e63d7b2012-11-06 16:03:35 +0100214static inline int
Linus Walleij165adc92012-11-06 14:49:39 +0100215gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
Linus Walleij316511c2012-11-21 08:48:09 +0100216 unsigned int gpio_offset, unsigned int pin_offset,
Linus Walleij3f0f8672012-11-20 12:40:15 +0100217 unsigned int npins)
Linus Walleij165adc92012-11-06 14:49:39 +0100218{
Linus Walleij50309a92012-11-06 17:16:39 +0100219 WARN_ON(1);
220 return -EINVAL;
Linus Walleij165adc92012-11-06 14:49:39 +0100221}
222
223static inline void
224gpiochip_remove_pin_ranges(struct gpio_chip *chip)
225{
Linus Walleij50309a92012-11-06 17:16:39 +0100226 WARN_ON(1);
Linus Walleij165adc92012-11-06 14:49:39 +0100227}
228
Linus Walleij165adc92012-11-06 14:49:39 +0100229#endif /* ! CONFIG_GENERIC_GPIO */
David Brownell7560fa62008-03-04 14:28:27 -0800230
Shawn Guo6a89a312013-01-18 15:57:46 +0800231struct device;
232
233/* bindings for managed devices that want to request gpios */
234int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
235int devm_gpio_request_one(struct device *dev, unsigned gpio,
236 unsigned long flags, const char *label);
237void devm_gpio_free(struct device *dev, unsigned int gpio);
238
David Brownell7560fa62008-03-04 14:28:27 -0800239#endif /* __LINUX_GPIO_H */