Blame view

include/linux/gpio.h 5.67 KB
b24413180   Greg Kroah-Hartman   License cleanup: ...
1
  /* SPDX-License-Identifier: GPL-2.0 */
7560fa60f   David Brownell   gpio: <linux/gpio...
2
3
  #ifndef __LINUX_GPIO_H
  #define __LINUX_GPIO_H
7563bbf89   Mark Brown   gpiolib/arches: C...
4
  #include <linux/errno.h>
f7b370a34   Richard Genoud   gpio: update path...
5
  /* see Documentation/gpio/gpio-legacy.txt */
7560fa60f   David Brownell   gpio: <linux/gpio...
6

c001fb72a   Randy Dunlap   gpio: add GPIOF_ ...
7
8
9
10
11
12
13
14
15
16
  /* make these flag values available regardless of GPIO kconfig options */
  #define GPIOF_DIR_OUT	(0 << 0)
  #define GPIOF_DIR_IN	(1 << 0)
  
  #define GPIOF_INIT_LOW	(0 << 1)
  #define GPIOF_INIT_HIGH	(1 << 1)
  
  #define GPIOF_IN		(GPIOF_DIR_IN)
  #define GPIOF_OUT_INIT_LOW	(GPIOF_DIR_OUT | GPIOF_INIT_LOW)
  #define GPIOF_OUT_INIT_HIGH	(GPIOF_DIR_OUT | GPIOF_INIT_HIGH)
79a9becda   Alexandre Courbot   gpiolib: export d...
17
18
  /* Gpio pin is active-low */
  #define GPIOF_ACTIVE_LOW        (1 << 2)
aca5ce14e   Laxman Dewangan   gpio: gpiolib: Su...
19
  /* Gpio pin is open drain */
79a9becda   Alexandre Courbot   gpiolib: export d...
20
  #define GPIOF_OPEN_DRAIN	(1 << 3)
aca5ce14e   Laxman Dewangan   gpio: gpiolib: Su...
21

25553ff07   Laxman Dewangan   gpio: gpiolib: Su...
22
  /* Gpio pin is open source */
79a9becda   Alexandre Courbot   gpiolib: export d...
23
  #define GPIOF_OPEN_SOURCE	(1 << 4)
25553ff07   Laxman Dewangan   gpio: gpiolib: Su...
24

79a9becda   Alexandre Courbot   gpiolib: export d...
25
26
  #define GPIOF_EXPORT		(1 << 5)
  #define GPIOF_EXPORT_CHANGEABLE	(1 << 6)
fc3a1f04f   Wolfram Sang   gpio: add flags t...
27
28
  #define GPIOF_EXPORT_DIR_FIXED	(GPIOF_EXPORT)
  #define GPIOF_EXPORT_DIR_CHANGEABLE (GPIOF_EXPORT | GPIOF_EXPORT_CHANGEABLE)
feb836992   Mark Brown   gpiolib: Ensure s...
29
30
31
32
33
34
35
36
37
38
39
  /**
   * struct gpio - a structure describing a GPIO with configuration
   * @gpio:	the GPIO number
   * @flags:	GPIO configuration as specified by GPIOF_*
   * @label:	a literal description string of this GPIO
   */
  struct gpio {
  	unsigned	gpio;
  	unsigned long	flags;
  	const char	*label;
  };
76ec9d18b   Alexandre Courbot   Convert selectors...
40
  #ifdef CONFIG_GPIOLIB
7563bbf89   Mark Brown   gpiolib/arches: C...
41
42
  
  #ifdef CONFIG_ARCH_HAVE_CUSTOM_GPIO_H
7560fa60f   David Brownell   gpio: <linux/gpio...
43
  #include <asm/gpio.h>
7563bbf89   Mark Brown   gpiolib/arches: C...
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
  #else
  
  #include <asm-generic/gpio.h>
  
  static inline int gpio_get_value(unsigned int gpio)
  {
  	return __gpio_get_value(gpio);
  }
  
  static inline void gpio_set_value(unsigned int gpio, int value)
  {
  	__gpio_set_value(gpio, value);
  }
  
  static inline int gpio_cansleep(unsigned int gpio)
  {
  	return __gpio_cansleep(gpio);
  }
  
  static inline int gpio_to_irq(unsigned int gpio)
  {
  	return __gpio_to_irq(gpio);
  }
  
  static inline int irq_to_gpio(unsigned int irq)
  {
  	return -EINVAL;
  }
165adc9c1   Linus Walleij   gpiolib: fix up f...
72
  #endif /* ! CONFIG_ARCH_HAVE_CUSTOM_GPIO_H */
7560fa60f   David Brownell   gpio: <linux/gpio...
73

403c1d0be   Linus Walleij   gpio: provide stu...
74
75
76
77
78
79
80
81
  /* CONFIG_GPIOLIB: bindings for managed devices that want to request gpios */
  
  struct device;
  
  int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
  int devm_gpio_request_one(struct device *dev, unsigned gpio,
  			  unsigned long flags, const char *label);
  void devm_gpio_free(struct device *dev, unsigned int gpio);
76ec9d18b   Alexandre Courbot   Convert selectors...
82
  #else /* ! CONFIG_GPIOLIB */
7560fa60f   David Brownell   gpio: <linux/gpio...
83

3d599d1ca   Uwe Kleine-König   gpio_free might s...
84
  #include <linux/kernel.h>
6ea0205b5   David Brownell   gpio: build fixes
85
  #include <linux/types.h>
187f1882b   Paul Gortmaker   BUG: headers with...
86
  #include <linux/bug.h>
586a87e6e   Christian Ruppert   pinctrl/gpio: non...
87
  #include <linux/pinctrl/pinctrl.h>
6ea0205b5   David Brownell   gpio: build fixes
88

a4177ee7f   Jani Nikula   gpiolib: allow ex...
89
  struct device;
4e4438b86   Anton Vorontsov   gpiolib: Add 'str...
90
  struct gpio_chip;
a4177ee7f   Jani Nikula   gpiolib: allow ex...
91

3474cb3cc   Joe Perches   gpio: Convert gpi...
92
  static inline bool gpio_is_valid(int number)
7560fa60f   David Brownell   gpio: <linux/gpio...
93
  {
3474cb3cc   Joe Perches   gpio: Convert gpi...
94
  	return false;
7560fa60f   David Brownell   gpio: <linux/gpio...
95
  }
d8a3515e2   Linus Torvalds   Revert "gpiolib: ...
96
  static inline int gpio_request(unsigned gpio, const char *label)
7560fa60f   David Brownell   gpio: <linux/gpio...
97
98
99
  {
  	return -ENOSYS;
  }
323b7fe8f   Wolfram Sang   include/gpio.h: r...
100
  static inline int gpio_request_one(unsigned gpio,
5f829e405   Wolfram Sang   gpiolib: add miss...
101
102
103
104
  					unsigned long flags, const char *label)
  {
  	return -ENOSYS;
  }
7c295975a   Lars-Peter Clausen   gpio: make gpio_{...
105
  static inline int gpio_request_array(const struct gpio *array, size_t num)
5f829e405   Wolfram Sang   gpiolib: add miss...
106
107
108
  {
  	return -ENOSYS;
  }
7560fa60f   David Brownell   gpio: <linux/gpio...
109
110
  static inline void gpio_free(unsigned gpio)
  {
3d599d1ca   Uwe Kleine-König   gpio_free might s...
111
  	might_sleep();
7560fa60f   David Brownell   gpio: <linux/gpio...
112
  	/* GPIO can never have been requested */
2c96922ae   Mark Brown   gpiolib: Add !CON...
113
114
  	WARN_ON(1);
  }
7c295975a   Lars-Peter Clausen   gpio: make gpio_{...
115
  static inline void gpio_free_array(const struct gpio *array, size_t num)
5f829e405   Wolfram Sang   gpiolib: add miss...
116
117
118
119
120
121
  {
  	might_sleep();
  
  	/* GPIO can never have been requested */
  	WARN_ON(1);
  }
d8a3515e2   Linus Torvalds   Revert "gpiolib: ...
122
  static inline int gpio_direction_input(unsigned gpio)
7560fa60f   David Brownell   gpio: <linux/gpio...
123
124
125
  {
  	return -ENOSYS;
  }
d8a3515e2   Linus Torvalds   Revert "gpiolib: ...
126
  static inline int gpio_direction_output(unsigned gpio, int value)
7560fa60f   David Brownell   gpio: <linux/gpio...
127
128
129
  {
  	return -ENOSYS;
  }
c4b5be98f   Felipe Balbi   gpiolib: introduc...
130
131
132
133
  static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
  {
  	return -ENOSYS;
  }
7560fa60f   David Brownell   gpio: <linux/gpio...
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
  static inline int gpio_get_value(unsigned gpio)
  {
  	/* GPIO can never have been requested or set as {in,out}put */
  	WARN_ON(1);
  	return 0;
  }
  
  static inline void gpio_set_value(unsigned gpio, int value)
  {
  	/* GPIO can never have been requested or set as output */
  	WARN_ON(1);
  }
  
  static inline int gpio_cansleep(unsigned gpio)
  {
  	/* GPIO can never have been requested or set as {in,out}put */
  	WARN_ON(1);
  	return 0;
  }
  
  static inline int gpio_get_value_cansleep(unsigned gpio)
  {
  	/* GPIO can never have been requested or set as {in,out}put */
  	WARN_ON(1);
  	return 0;
  }
  
  static inline void gpio_set_value_cansleep(unsigned gpio, int value)
  {
  	/* GPIO can never have been requested or set as output */
  	WARN_ON(1);
  }
d8f388d8d   David Brownell   gpio: sysfs inter...
166
167
168
169
170
171
  static inline int gpio_export(unsigned gpio, bool direction_may_change)
  {
  	/* GPIO can never have been requested or set as {in,out}put */
  	WARN_ON(1);
  	return -EINVAL;
  }
a4177ee7f   Jani Nikula   gpiolib: allow ex...
172
173
174
175
176
177
178
  static inline int gpio_export_link(struct device *dev, const char *name,
  				unsigned gpio)
  {
  	/* GPIO can never have been exported */
  	WARN_ON(1);
  	return -EINVAL;
  }
d8f388d8d   David Brownell   gpio: sysfs inter...
179
180
181
182
183
  static inline void gpio_unexport(unsigned gpio)
  {
  	/* GPIO can never have been exported */
  	WARN_ON(1);
  }
7560fa60f   David Brownell   gpio: <linux/gpio...
184
185
186
187
188
189
  static inline int gpio_to_irq(unsigned gpio)
  {
  	/* GPIO can never have been requested or set as input */
  	WARN_ON(1);
  	return -EINVAL;
  }
e3a2e8789   Alexandre Courbot   gpio: rename gpio...
190
191
  static inline int gpiochip_lock_as_irq(struct gpio_chip *chip,
  				       unsigned int offset)
d468bf9ec   Linus Walleij   gpio: add API to ...
192
193
194
195
  {
  	WARN_ON(1);
  	return -EINVAL;
  }
e3a2e8789   Alexandre Courbot   gpio: rename gpio...
196
197
  static inline void gpiochip_unlock_as_irq(struct gpio_chip *chip,
  					  unsigned int offset)
d468bf9ec   Linus Walleij   gpio: add API to ...
198
199
200
  {
  	WARN_ON(1);
  }
7560fa60f   David Brownell   gpio: <linux/gpio...
201
202
203
204
205
206
  static inline int irq_to_gpio(unsigned irq)
  {
  	/* irq can never have been returned from gpio_to_irq() */
  	WARN_ON(1);
  	return -EINVAL;
  }
1e63d7b93   Linus Walleij   gpiolib: separati...
207
  static inline int
165adc9c1   Linus Walleij   gpiolib: fix up f...
208
  gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
316511c01   Linus Walleij   gpiolib: rename p...
209
  		       unsigned int gpio_offset, unsigned int pin_offset,
3f0f86706   Linus Walleij   gpiolib: let gpio...
210
  		       unsigned int npins)
165adc9c1   Linus Walleij   gpiolib: fix up f...
211
  {
50309a9c2   Linus Walleij   gpiolib: iron out...
212
213
  	WARN_ON(1);
  	return -EINVAL;
165adc9c1   Linus Walleij   gpiolib: fix up f...
214
  }
586a87e6e   Christian Ruppert   pinctrl/gpio: non...
215
216
217
218
219
220
221
222
  static inline int
  gpiochip_add_pingroup_range(struct gpio_chip *chip,
  			struct pinctrl_dev *pctldev,
  			unsigned int gpio_offset, const char *pin_group)
  {
  	WARN_ON(1);
  	return -EINVAL;
  }
165adc9c1   Linus Walleij   gpiolib: fix up f...
223
224
225
  static inline void
  gpiochip_remove_pin_ranges(struct gpio_chip *chip)
  {
50309a9c2   Linus Walleij   gpiolib: iron out...
226
  	WARN_ON(1);
165adc9c1   Linus Walleij   gpiolib: fix up f...
227
  }
403c1d0be   Linus Walleij   gpio: provide stu...
228
229
230
231
232
233
  static inline int devm_gpio_request(struct device *dev, unsigned gpio,
  				    const char *label)
  {
  	WARN_ON(1);
  	return -EINVAL;
  }
7560fa60f   David Brownell   gpio: <linux/gpio...
234

403c1d0be   Linus Walleij   gpio: provide stu...
235
236
237
238
239
240
  static inline int devm_gpio_request_one(struct device *dev, unsigned gpio,
  					unsigned long flags, const char *label)
  {
  	WARN_ON(1);
  	return -EINVAL;
  }
6a89a314a   Shawn Guo   gpio: devm_gpio_*...
241

403c1d0be   Linus Walleij   gpio: provide stu...
242
243
244
245
246
247
  static inline void devm_gpio_free(struct device *dev, unsigned int gpio)
  {
  	WARN_ON(1);
  }
  
  #endif /* ! CONFIG_GPIOLIB */
6a89a314a   Shawn Guo   gpio: devm_gpio_*...
248

7560fa60f   David Brownell   gpio: <linux/gpio...
249
  #endif /* __LINUX_GPIO_H */