blob: 20ca7663975f04244a794f2a43655adbdd262699 [file] [log] [blame]
David Brownell4c203862007-02-12 00:53:11 -08001#ifndef _ASM_GENERIC_GPIO_H
2#define _ASM_GENERIC_GPIO_H
3
Mike Frysingerb3db4a82009-10-01 15:43:56 -07004#include <linux/kernel.h>
David Brownell6ea02052008-05-23 13:04:58 -07005#include <linux/types.h>
Atsushi Nemoto25947d52008-07-28 15:46:38 -07006#include <linux/errno.h>
Grant Likely15c9a0a2011-12-12 09:25:57 -07007#include <linux/of.h>
Shiraz Hashimf23f1512012-10-27 15:21:36 +05308#include <linux/pinctrl/pinctrl.h>
David Brownell6ea02052008-05-23 13:04:58 -07009
Michael Buesch7444a722008-07-25 01:46:11 -070010#ifdef CONFIG_GPIOLIB
David Brownelld2876d02008-02-04 22:28:20 -080011
David Brownell6ea02052008-05-23 13:04:58 -070012#include <linux/compiler.h>
13
David Brownelld2876d02008-02-04 22:28:20 -080014/* Platforms may implement their GPIO interface with library code,
15 * at a small performance cost for non-inlined operations and some
16 * extra memory (for code and for per-GPIO table entries).
17 *
18 * While the GPIO programming interface defines valid GPIO numbers
19 * to be in the range 0..MAX_INT, this library restricts them to the
Michael Buesch6a9436d2008-07-26 15:22:26 -070020 * smaller range 0..ARCH_NR_GPIOS-1.
David Brownellc9561262010-09-09 16:38:03 -070021 *
22 * ARCH_NR_GPIOS is somewhat arbitrary; it usually reflects the sum of
23 * builtin/SoC GPIOs plus a number of GPIOs on expanders; the latter is
24 * actually an estimate of a board-specific value.
David Brownelld2876d02008-02-04 22:28:20 -080025 */
26
27#ifndef ARCH_NR_GPIOS
28#define ARCH_NR_GPIOS 256
29#endif
30
David Brownellc9561262010-09-09 16:38:03 -070031/*
32 * "valid" GPIO numbers are nonnegative and may be passed to
33 * setup routines like gpio_request(). only some valid numbers
34 * can successfully be requested and used.
35 *
36 * Invalid GPIO numbers are useful for indicating no-such-GPIO in
37 * platform data and other tables.
38 */
39
Joe Perches3474cb32011-05-10 16:23:07 -070040static inline bool gpio_is_valid(int number)
Guennadi Liakhovetskie6de1802008-04-28 02:14:46 -070041{
Joe Perches3474cb32011-05-10 16:23:07 -070042 return number >= 0 && number < ARCH_NR_GPIOS;
Guennadi Liakhovetskie6de1802008-04-28 02:14:46 -070043}
44
Mike Frysinger1f018c82009-12-09 06:53:39 -050045struct device;
Mark Brownfeb83692011-10-24 15:24:10 +020046struct gpio;
David Brownelld2876d02008-02-04 22:28:20 -080047struct seq_file;
Guennadi Liakhovetski438d8902008-04-28 02:14:44 -070048struct module;
Anton Vorontsova19e3da2010-06-08 07:48:16 -060049struct device_node;
David Brownelld2876d02008-02-04 22:28:20 -080050
51/**
52 * struct gpio_chip - abstract a GPIO controller
53 * @label: for diagnostics
David Brownelld8f388d82008-07-25 01:46:07 -070054 * @dev: optional device providing the GPIOs
55 * @owner: helps prevent removal of modules exporting active GPIOs
David Brownell35e8bb52008-10-15 22:03:16 -070056 * @request: optional hook for chip-specific activation, such as
57 * enabling module power and clock; may sleep
58 * @free: optional hook for chip-specific deactivation, such as
59 * disabling module power and clock; may sleep
Mathias Nyman80b0a602012-10-24 17:25:27 +030060 * @get_direction: returns direction for signal "offset", 0=out, 1=in,
61 * (same as GPIOF_DIR_XXX), or negative error
David Brownelld2876d02008-02-04 22:28:20 -080062 * @direction_input: configures signal "offset" as input, or returns error
63 * @get: returns value for signal "offset"; for output signals this
64 * returns either the value actually sensed, or zero
65 * @direction_output: configures signal "offset" as output, or returns error
Roland Stigge1ae96312012-09-25 09:56:14 +020066 * @set_debounce: optional hook for setting debounce time for specified gpio in
67 * interrupt triggered gpio chips
David Brownelld2876d02008-02-04 22:28:20 -080068 * @set: assigns output value for signal "offset"
David Brownell0f6d5042008-10-15 22:03:14 -070069 * @to_irq: optional hook supporting non-static gpio_to_irq() mappings;
70 * implementation may not sleep
David Brownelld2876d02008-02-04 22:28:20 -080071 * @dbg_show: optional routine to show contents in debugfs; default code
72 * will be used when this is omitted, but custom code can show extra
73 * state (such as pullup/pulldown configuration).
74 * @base: identifies the first GPIO number handled by this chip; or, if
75 * negative during registration, requests dynamic ID allocation.
76 * @ngpio: the number of GPIOs handled by this controller; the last GPIO
77 * handled is (base + ngpio - 1).
78 * @can_sleep: flag must be set iff get()/set() methods sleep, as they
79 * must while accessing GPIO expander chips over I2C or SPI
Daniel Silverstone926b6632009-04-02 16:57:05 -070080 * @names: if set, must be an array of strings to use as alternative
81 * names for the GPIOs in this chip. Any entry in the array
82 * may be NULL if there is no alias for the GPIO, however the
Uwe Kleine-König7839ec72010-05-26 14:42:18 -070083 * array must be @ngpio entries long. A name can include a single printk
84 * format specifier for an unsigned int. It is substituted by the actual
85 * number of the gpio.
David Brownelld2876d02008-02-04 22:28:20 -080086 *
87 * A gpio_chip can help platforms abstract various sources of GPIOs so
88 * they can all be accessed through a common programing interface.
89 * Example sources would be SOC controllers, FPGAs, multifunction
90 * chips, dedicated GPIO expanders, and so on.
91 *
92 * Each chip controls a number of signals, identified in method calls
93 * by "offset" values in the range 0..(@ngpio - 1). When those signals
94 * are referenced through calls like gpio_get_value(gpio), the offset
95 * is calculated by subtracting @base from the gpio number.
96 */
97struct gpio_chip {
Dmitry Baryshkov4fd54632008-10-15 22:03:10 -070098 const char *label;
David Brownelld8f388d82008-07-25 01:46:07 -070099 struct device *dev;
Guennadi Liakhovetski438d8902008-04-28 02:14:44 -0700100 struct module *owner;
David Brownelld2876d02008-02-04 22:28:20 -0800101
David Brownell35e8bb52008-10-15 22:03:16 -0700102 int (*request)(struct gpio_chip *chip,
103 unsigned offset);
104 void (*free)(struct gpio_chip *chip,
105 unsigned offset);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300106 int (*get_direction)(struct gpio_chip *chip,
107 unsigned offset);
David Brownelld2876d02008-02-04 22:28:20 -0800108 int (*direction_input)(struct gpio_chip *chip,
109 unsigned offset);
110 int (*get)(struct gpio_chip *chip,
111 unsigned offset);
112 int (*direction_output)(struct gpio_chip *chip,
113 unsigned offset, int value);
Felipe Balbic4b5be92010-05-26 14:42:23 -0700114 int (*set_debounce)(struct gpio_chip *chip,
115 unsigned offset, unsigned debounce);
116
David Brownelld2876d02008-02-04 22:28:20 -0800117 void (*set)(struct gpio_chip *chip,
118 unsigned offset, int value);
David Brownell0f6d5042008-10-15 22:03:14 -0700119
120 int (*to_irq)(struct gpio_chip *chip,
121 unsigned offset);
122
David Brownelld2876d02008-02-04 22:28:20 -0800123 void (*dbg_show)(struct seq_file *s,
124 struct gpio_chip *chip);
125 int base;
126 u16 ngpio;
Uwe Kleine-König62154992010-05-26 14:42:17 -0700127 const char *const *names;
David Brownelld2876d02008-02-04 22:28:20 -0800128 unsigned can_sleep:1;
David Brownelld8f388d82008-07-25 01:46:07 -0700129 unsigned exported:1;
Anton Vorontsova19e3da2010-06-08 07:48:16 -0600130
131#if defined(CONFIG_OF_GPIO)
132 /*
133 * If CONFIG_OF is enabled, then all GPIO controllers described in the
134 * device tree automatically may have an OF translation
135 */
136 struct device_node *of_node;
137 int of_gpio_n_cells;
Grant Likely15c9a0a2011-12-12 09:25:57 -0700138 int (*of_xlate)(struct gpio_chip *gc,
139 const struct of_phandle_args *gpiospec, u32 *flags);
Anton Vorontsova19e3da2010-06-08 07:48:16 -0600140#endif
Shiraz Hashimf23f1512012-10-27 15:21:36 +0530141#ifdef CONFIG_PINCTRL
142 /*
143 * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally
144 * describe the actual pin range which they serve in an SoC. This
145 * information would be used by pinctrl subsystem to configure
146 * corresponding pins for gpio usage.
147 */
148 struct list_head pin_ranges;
149#endif
David Brownelld2876d02008-02-04 22:28:20 -0800150};
151
152extern const char *gpiochip_is_requested(struct gpio_chip *chip,
153 unsigned offset);
Grant Likely1a2d3972011-12-12 09:25:57 -0700154extern struct gpio_chip *gpio_to_chip(unsigned gpio);
David Brownell6ea02052008-05-23 13:04:58 -0700155extern int __must_check gpiochip_reserve(int start, int ngpio);
David Brownelld2876d02008-02-04 22:28:20 -0800156
157/* add/remove chips */
158extern int gpiochip_add(struct gpio_chip *chip);
159extern int __must_check gpiochip_remove(struct gpio_chip *chip);
Grant Likely07ce8ec2012-05-18 23:01:05 -0600160extern struct gpio_chip *gpiochip_find(void *data,
Grant Likely594fa262010-06-08 07:48:16 -0600161 int (*match)(struct gpio_chip *chip,
Grant Likely3d0f7cf2012-05-17 13:54:40 -0600162 void *data));
David Brownelld2876d02008-02-04 22:28:20 -0800163
164
165/* Always use the library code for GPIO management calls,
166 * or when sleeping may be involved.
167 */
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800168extern int gpio_request(unsigned gpio, const char *label);
David Brownelld2876d02008-02-04 22:28:20 -0800169extern void gpio_free(unsigned gpio);
170
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800171extern int gpio_direction_input(unsigned gpio);
172extern int gpio_direction_output(unsigned gpio, int value);
David Brownelld2876d02008-02-04 22:28:20 -0800173
Felipe Balbic4b5be92010-05-26 14:42:23 -0700174extern int gpio_set_debounce(unsigned gpio, unsigned debounce);
175
David Brownelld2876d02008-02-04 22:28:20 -0800176extern int gpio_get_value_cansleep(unsigned gpio);
177extern void gpio_set_value_cansleep(unsigned gpio, int value);
178
179
180/* A platform's <asm/gpio.h> code may want to inline the I/O calls when
181 * the GPIO is constant and refers to some always-present controller,
182 * giving direct access to chip registers and tight bitbanging loops.
183 */
184extern int __gpio_get_value(unsigned gpio);
185extern void __gpio_set_value(unsigned gpio, int value);
186
187extern int __gpio_cansleep(unsigned gpio);
188
David Brownell0f6d5042008-10-15 22:03:14 -0700189extern int __gpio_to_irq(unsigned gpio);
David Brownelld2876d02008-02-04 22:28:20 -0800190
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800191extern int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
Lars-Peter Clausen7c295972011-05-25 16:20:31 -0700192extern int gpio_request_array(const struct gpio *array, size_t num);
193extern void gpio_free_array(const struct gpio *array, size_t num);
Eric Miao3e45f1d2010-03-05 13:44:35 -0800194
John Crispin1a0703e2011-12-20 21:40:21 +0100195/* bindings for managed devices that want to request gpios */
196int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
Mark Brown09d71ff2012-05-02 12:46:46 +0100197int devm_gpio_request_one(struct device *dev, unsigned gpio,
198 unsigned long flags, const char *label);
John Crispin1a0703e2011-12-20 21:40:21 +0100199void devm_gpio_free(struct device *dev, unsigned int gpio);
200
David Brownelld8f388d82008-07-25 01:46:07 -0700201#ifdef CONFIG_GPIO_SYSFS
202
203/*
204 * A sysfs interface can be exported by individual drivers if they want,
205 * but more typically is configured entirely from userspace.
206 */
207extern int gpio_export(unsigned gpio, bool direction_may_change);
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700208extern int gpio_export_link(struct device *dev, const char *name,
209 unsigned gpio);
Jani Nikula07697462009-12-15 16:46:20 -0800210extern int gpio_sysfs_set_active_low(unsigned gpio, int value);
David Brownelld8f388d82008-07-25 01:46:07 -0700211extern void gpio_unexport(unsigned gpio);
212
213#endif /* CONFIG_GPIO_SYSFS */
214
Anton Vorontsov09cd9522010-10-27 15:33:16 -0700215#else /* !CONFIG_GPIOLIB */
David Brownelld2876d02008-02-04 22:28:20 -0800216
Joe Perches3474cb32011-05-10 16:23:07 -0700217static inline bool gpio_is_valid(int number)
Guennadi Liakhovetskie6de1802008-04-28 02:14:46 -0700218{
219 /* only non-negative numbers are valid */
220 return number >= 0;
221}
222
David Brownell4c203862007-02-12 00:53:11 -0800223/* platforms that don't directly support access to GPIOs through I2C, SPI,
224 * or other blocking infrastructure can use these wrappers.
225 */
226
227static inline int gpio_cansleep(unsigned gpio)
228{
229 return 0;
230}
231
232static inline int gpio_get_value_cansleep(unsigned gpio)
233{
234 might_sleep();
Hamoeb9ae7f2011-10-21 09:38:32 +0800235 return __gpio_get_value(gpio);
David Brownell4c203862007-02-12 00:53:11 -0800236}
237
238static inline void gpio_set_value_cansleep(unsigned gpio, int value)
239{
240 might_sleep();
Hamoeb9ae7f2011-10-21 09:38:32 +0800241 __gpio_set_value(gpio, value);
David Brownell4c203862007-02-12 00:53:11 -0800242}
243
Anton Vorontsov09cd9522010-10-27 15:33:16 -0700244#endif /* !CONFIG_GPIOLIB */
David Brownelld8f388d82008-07-25 01:46:07 -0700245
246#ifndef CONFIG_GPIO_SYSFS
247
Mike Frysinger1f018c82009-12-09 06:53:39 -0500248struct device;
249
David Brownelld8f388d82008-07-25 01:46:07 -0700250/* sysfs support is only available with gpiolib, where it's optional */
251
252static inline int gpio_export(unsigned gpio, bool direction_may_change)
253{
254 return -ENOSYS;
255}
256
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700257static inline int gpio_export_link(struct device *dev, const char *name,
258 unsigned gpio)
259{
260 return -ENOSYS;
261}
262
Jani Nikula07697462009-12-15 16:46:20 -0800263static inline int gpio_sysfs_set_active_low(unsigned gpio, int value)
264{
265 return -ENOSYS;
266}
267
David Brownelld8f388d82008-07-25 01:46:07 -0700268static inline void gpio_unexport(unsigned gpio)
269{
270}
271#endif /* CONFIG_GPIO_SYSFS */
David Brownelld2876d02008-02-04 22:28:20 -0800272
Linus Walleij50309a92012-11-06 17:16:39 +0100273#ifdef CONFIG_PINCTRL
274
275/**
276 * struct gpio_pin_range - pin range controlled by a gpio chip
277 * @head: list for maintaining set of pin ranges, used internally
278 * @pctldev: pinctrl device which handles corresponding pins
279 * @range: actual range of pins controlled by a gpio controller
280 */
281
282struct gpio_pin_range {
283 struct list_head node;
284 struct pinctrl_dev *pctldev;
285 struct pinctrl_gpio_range range;
286};
287
288int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
Linus Walleij316511c2012-11-21 08:48:09 +0100289 unsigned int gpio_offset, unsigned int pin_offset,
Linus Walleij3f0f8672012-11-20 12:40:15 +0100290 unsigned int npins);
Linus Walleij50309a92012-11-06 17:16:39 +0100291void gpiochip_remove_pin_ranges(struct gpio_chip *chip);
292
293#else
294
295static inline int
296gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
Linus Walleij316511c2012-11-21 08:48:09 +0100297 unsigned int gpio_offset, unsigned int pin_offset,
Linus Walleij3f0f8672012-11-20 12:40:15 +0100298 unsigned int npins)
Linus Walleij50309a92012-11-06 17:16:39 +0100299{
300 return 0;
301}
302
303static inline void
304gpiochip_remove_pin_ranges(struct gpio_chip *chip)
305{
306}
307
308#endif /* CONFIG_PINCTRL */
309
David Brownell4c203862007-02-12 00:53:11 -0800310#endif /* _ASM_GENERIC_GPIO_H */