blob: a5f56a0213a7e59ad3315fe8a8ddbaae1a402290 [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>
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070013#include <linux/gpio/driver.h>
14#include <linux/gpio/consumer.h>
David Brownell6ea02052008-05-23 13:04:58 -070015
David Brownelld2876d02008-02-04 22:28:20 -080016/* Platforms may implement their GPIO interface with library code,
17 * at a small performance cost for non-inlined operations and some
18 * extra memory (for code and for per-GPIO table entries).
19 *
20 * While the GPIO programming interface defines valid GPIO numbers
21 * to be in the range 0..MAX_INT, this library restricts them to the
Michael Buesch6a9436d2008-07-26 15:22:26 -070022 * smaller range 0..ARCH_NR_GPIOS-1.
David Brownellc9561262010-09-09 16:38:03 -070023 *
24 * ARCH_NR_GPIOS is somewhat arbitrary; it usually reflects the sum of
25 * builtin/SoC GPIOs plus a number of GPIOs on expanders; the latter is
26 * actually an estimate of a board-specific value.
David Brownelld2876d02008-02-04 22:28:20 -080027 */
28
29#ifndef ARCH_NR_GPIOS
30#define ARCH_NR_GPIOS 256
31#endif
32
David Brownellc9561262010-09-09 16:38:03 -070033/*
34 * "valid" GPIO numbers are nonnegative and may be passed to
35 * setup routines like gpio_request(). only some valid numbers
36 * can successfully be requested and used.
37 *
38 * Invalid GPIO numbers are useful for indicating no-such-GPIO in
39 * platform data and other tables.
40 */
41
Joe Perches3474cb32011-05-10 16:23:07 -070042static inline bool gpio_is_valid(int number)
Guennadi Liakhovetskie6de1802008-04-28 02:14:46 -070043{
Joe Perches3474cb32011-05-10 16:23:07 -070044 return number >= 0 && number < ARCH_NR_GPIOS;
Guennadi Liakhovetskie6de1802008-04-28 02:14:46 -070045}
46
Mike Frysinger1f018c82009-12-09 06:53:39 -050047struct device;
Mark Brownfeb83692011-10-24 15:24:10 +020048struct gpio;
David Brownelld2876d02008-02-04 22:28:20 -080049struct seq_file;
Guennadi Liakhovetski438d8902008-04-28 02:14:44 -070050struct module;
Anton Vorontsova19e3da2010-06-08 07:48:16 -060051struct device_node;
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +090052struct gpio_desc;
David Brownelld2876d02008-02-04 22:28:20 -080053
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070054/* caller holds gpio_lock *OR* gpio is marked as requested */
55static inline struct gpio_chip *gpio_to_chip(unsigned gpio)
56{
57 return gpiod_to_chip(gpio_to_desc(gpio));
58}
David Brownelld2876d02008-02-04 22:28:20 -080059
60/* Always use the library code for GPIO management calls,
61 * or when sleeping may be involved.
62 */
Linus Torvaldsd8a35152011-01-13 17:26:46 -080063extern int gpio_request(unsigned gpio, const char *label);
David Brownelld2876d02008-02-04 22:28:20 -080064extern void gpio_free(unsigned gpio);
65
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070066static inline int gpio_direction_input(unsigned gpio)
67{
68 return gpiod_direction_input(gpio_to_desc(gpio));
69}
70static inline int gpio_direction_output(unsigned gpio, int value)
71{
72 return gpiod_direction_output(gpio_to_desc(gpio), value);
73}
David Brownelld2876d02008-02-04 22:28:20 -080074
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070075static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
76{
77 return gpiod_set_debounce(gpio_to_desc(gpio), debounce);
78}
Felipe Balbic4b5be92010-05-26 14:42:23 -070079
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070080static inline int gpio_get_value_cansleep(unsigned gpio)
81{
82 return gpiod_get_raw_value_cansleep(gpio_to_desc(gpio));
83}
84static inline void gpio_set_value_cansleep(unsigned gpio, int value)
85{
86 return gpiod_set_raw_value_cansleep(gpio_to_desc(gpio), value);
87}
David Brownelld2876d02008-02-04 22:28:20 -080088
89
90/* A platform's <asm/gpio.h> code may want to inline the I/O calls when
91 * the GPIO is constant and refers to some always-present controller,
92 * giving direct access to chip registers and tight bitbanging loops.
93 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070094static inline int __gpio_get_value(unsigned gpio)
95{
96 return gpiod_get_raw_value(gpio_to_desc(gpio));
97}
98static inline void __gpio_set_value(unsigned gpio, int value)
99{
100 return gpiod_set_raw_value(gpio_to_desc(gpio), value);
101}
David Brownelld2876d02008-02-04 22:28:20 -0800102
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700103static inline int __gpio_cansleep(unsigned gpio)
104{
105 return gpiod_cansleep(gpio_to_desc(gpio));
106}
David Brownelld2876d02008-02-04 22:28:20 -0800107
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700108static inline int __gpio_to_irq(unsigned gpio)
109{
110 return gpiod_to_irq(gpio_to_desc(gpio));
111}
David Brownelld2876d02008-02-04 22:28:20 -0800112
Linus Walleijd468bf92013-09-24 11:54:38 +0200113extern int gpio_lock_as_irq(struct gpio_chip *chip, unsigned int offset);
114extern void gpio_unlock_as_irq(struct gpio_chip *chip, unsigned int offset);
David Brownelld2876d02008-02-04 22:28:20 -0800115
Linus Torvaldsd8a35152011-01-13 17:26:46 -0800116extern int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
Lars-Peter Clausen7c295972011-05-25 16:20:31 -0700117extern int gpio_request_array(const struct gpio *array, size_t num);
118extern void gpio_free_array(const struct gpio *array, size_t num);
Eric Miao3e45f1d2010-03-05 13:44:35 -0800119
David Brownelld8f388d2008-07-25 01:46:07 -0700120/*
121 * A sysfs interface can be exported by individual drivers if they want,
122 * but more typically is configured entirely from userspace.
123 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700124static inline int gpio_export(unsigned gpio, bool direction_may_change)
125{
126 return gpiod_export(gpio_to_desc(gpio), direction_may_change);
127}
David Brownelld8f388d2008-07-25 01:46:07 -0700128
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700129static inline int gpio_export_link(struct device *dev, const char *name,
130 unsigned gpio)
131{
132 return gpiod_export_link(dev, name, gpio_to_desc(gpio));
133}
134
135static inline int gpio_sysfs_set_active_low(unsigned gpio, int value)
136{
137 return gpiod_sysfs_set_active_low(gpio_to_desc(gpio), value);
138}
139
140static inline void gpio_unexport(unsigned gpio)
141{
142 gpiod_unexport(gpio_to_desc(gpio));
143}
David Brownelld8f388d2008-07-25 01:46:07 -0700144
Shawn Guod59b4ea2013-01-17 22:03:22 +0800145#ifdef CONFIG_PINCTRL
146
147/**
148 * struct gpio_pin_range - pin range controlled by a gpio chip
149 * @head: list for maintaining set of pin ranges, used internally
150 * @pctldev: pinctrl device which handles corresponding pins
151 * @range: actual range of pins controlled by a gpio controller
152 */
153
154struct gpio_pin_range {
155 struct list_head node;
156 struct pinctrl_dev *pctldev;
157 struct pinctrl_gpio_range range;
158};
159
160int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
161 unsigned int gpio_offset, unsigned int pin_offset,
162 unsigned int npins);
Christian Ruppert586a87e2013-10-15 15:37:54 +0200163int gpiochip_add_pingroup_range(struct gpio_chip *chip,
164 struct pinctrl_dev *pctldev,
165 unsigned int gpio_offset, const char *pin_group);
Shawn Guod59b4ea2013-01-17 22:03:22 +0800166void gpiochip_remove_pin_ranges(struct gpio_chip *chip);
167
168#else
169
170static inline int
171gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
172 unsigned int gpio_offset, unsigned int pin_offset,
173 unsigned int npins)
174{
175 return 0;
176}
Christian Ruppert586a87e2013-10-15 15:37:54 +0200177static inline int
178gpiochip_add_pingroup_range(struct gpio_chip *chip,
179 struct pinctrl_dev *pctldev,
180 unsigned int gpio_offset, const char *pin_group)
181{
182 return 0;
183}
Shawn Guod59b4ea2013-01-17 22:03:22 +0800184
185static inline void
186gpiochip_remove_pin_ranges(struct gpio_chip *chip)
187{
188}
189
190#endif /* CONFIG_PINCTRL */
191
Anton Vorontsov09cd9522010-10-27 15:33:16 -0700192#else /* !CONFIG_GPIOLIB */
David Brownelld2876d02008-02-04 22:28:20 -0800193
Joe Perches3474cb32011-05-10 16:23:07 -0700194static inline bool gpio_is_valid(int number)
Guennadi Liakhovetskie6de1802008-04-28 02:14:46 -0700195{
196 /* only non-negative numbers are valid */
197 return number >= 0;
198}
199
David Brownell4c203862007-02-12 00:53:11 -0800200/* platforms that don't directly support access to GPIOs through I2C, SPI,
201 * or other blocking infrastructure can use these wrappers.
202 */
203
204static inline int gpio_cansleep(unsigned gpio)
205{
206 return 0;
207}
208
209static inline int gpio_get_value_cansleep(unsigned gpio)
210{
211 might_sleep();
Hamoeb9ae7f2011-10-21 09:38:32 +0800212 return __gpio_get_value(gpio);
David Brownell4c203862007-02-12 00:53:11 -0800213}
214
215static inline void gpio_set_value_cansleep(unsigned gpio, int value)
216{
217 might_sleep();
Hamoeb9ae7f2011-10-21 09:38:32 +0800218 __gpio_set_value(gpio, value);
David Brownell4c203862007-02-12 00:53:11 -0800219}
220
Anton Vorontsov09cd9522010-10-27 15:33:16 -0700221#endif /* !CONFIG_GPIOLIB */
David Brownelld8f388d2008-07-25 01:46:07 -0700222
David Brownell4c203862007-02-12 00:53:11 -0800223#endif /* _ASM_GENERIC_GPIO_H */