David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 1 | #ifndef _ASM_GENERIC_GPIO_H |
| 2 | #define _ASM_GENERIC_GPIO_H |
| 3 | |
Mike Frysinger | b3db4a8 | 2009-10-01 15:43:56 -0700 | [diff] [blame] | 4 | #include <linux/kernel.h> |
David Brownell | 6ea0205 | 2008-05-23 13:04:58 -0700 | [diff] [blame] | 5 | #include <linux/types.h> |
Atsushi Nemoto | 25947d5 | 2008-07-28 15:46:38 -0700 | [diff] [blame] | 6 | #include <linux/errno.h> |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 7 | #include <linux/of.h> |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 8 | #include <linux/pinctrl/pinctrl.h> |
David Brownell | 6ea0205 | 2008-05-23 13:04:58 -0700 | [diff] [blame] | 9 | |
Michael Buesch | 7444a72 | 2008-07-25 01:46:11 -0700 | [diff] [blame] | 10 | #ifdef CONFIG_GPIOLIB |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 11 | |
David Brownell | 6ea0205 | 2008-05-23 13:04:58 -0700 | [diff] [blame] | 12 | #include <linux/compiler.h> |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 13 | #include <linux/gpio/driver.h> |
| 14 | #include <linux/gpio/consumer.h> |
David Brownell | 6ea0205 | 2008-05-23 13:04:58 -0700 | [diff] [blame] | 15 | |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 16 | /* 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 Buesch | 6a9436d | 2008-07-26 15:22:26 -0700 | [diff] [blame] | 22 | * smaller range 0..ARCH_NR_GPIOS-1. |
David Brownell | c956126 | 2010-09-09 16:38:03 -0700 | [diff] [blame] | 23 | * |
| 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 Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 27 | */ |
| 28 | |
| 29 | #ifndef ARCH_NR_GPIOS |
| 30 | #define ARCH_NR_GPIOS 256 |
| 31 | #endif |
| 32 | |
David Brownell | c956126 | 2010-09-09 16:38:03 -0700 | [diff] [blame] | 33 | /* |
| 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 Perches | 3474cb3 | 2011-05-10 16:23:07 -0700 | [diff] [blame] | 42 | static inline bool gpio_is_valid(int number) |
Guennadi Liakhovetski | e6de180 | 2008-04-28 02:14:46 -0700 | [diff] [blame] | 43 | { |
Joe Perches | 3474cb3 | 2011-05-10 16:23:07 -0700 | [diff] [blame] | 44 | return number >= 0 && number < ARCH_NR_GPIOS; |
Guennadi Liakhovetski | e6de180 | 2008-04-28 02:14:46 -0700 | [diff] [blame] | 45 | } |
| 46 | |
Mike Frysinger | 1f018c8 | 2009-12-09 06:53:39 -0500 | [diff] [blame] | 47 | struct device; |
Mark Brown | feb8369 | 2011-10-24 15:24:10 +0200 | [diff] [blame] | 48 | struct gpio; |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 49 | struct seq_file; |
Guennadi Liakhovetski | 438d890 | 2008-04-28 02:14:44 -0700 | [diff] [blame] | 50 | struct module; |
Anton Vorontsov | a19e3da | 2010-06-08 07:48:16 -0600 | [diff] [blame] | 51 | struct device_node; |
Alexandre Courbot | 6c0b4e6 | 2013-02-03 01:29:30 +0900 | [diff] [blame] | 52 | struct gpio_desc; |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 53 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 54 | /* caller holds gpio_lock *OR* gpio is marked as requested */ |
| 55 | static inline struct gpio_chip *gpio_to_chip(unsigned gpio) |
| 56 | { |
| 57 | return gpiod_to_chip(gpio_to_desc(gpio)); |
| 58 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 59 | |
| 60 | /* Always use the library code for GPIO management calls, |
| 61 | * or when sleeping may be involved. |
| 62 | */ |
Linus Torvalds | d8a3515 | 2011-01-13 17:26:46 -0800 | [diff] [blame] | 63 | extern int gpio_request(unsigned gpio, const char *label); |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 64 | extern void gpio_free(unsigned gpio); |
| 65 | |
Alexandre Courbot | c7caf86 | 2014-07-24 14:51:02 +0900 | [diff] [blame] | 66 | static inline int gpio_direction_input(unsigned gpio) |
| 67 | { |
| 68 | return gpiod_direction_input(gpio_to_desc(gpio)); |
| 69 | } |
| 70 | static inline int gpio_direction_output(unsigned gpio, int value) |
| 71 | { |
| 72 | return gpiod_direction_output_raw(gpio_to_desc(gpio), value); |
| 73 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 74 | |
Alexandre Courbot | c7caf86 | 2014-07-24 14:51:02 +0900 | [diff] [blame] | 75 | static inline int gpio_set_debounce(unsigned gpio, unsigned debounce) |
| 76 | { |
| 77 | return gpiod_set_debounce(gpio_to_desc(gpio), debounce); |
| 78 | } |
Felipe Balbi | c4b5be9 | 2010-05-26 14:42:23 -0700 | [diff] [blame] | 79 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 80 | static inline int gpio_get_value_cansleep(unsigned gpio) |
| 81 | { |
| 82 | return gpiod_get_raw_value_cansleep(gpio_to_desc(gpio)); |
| 83 | } |
| 84 | static 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 Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 88 | |
| 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 Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 94 | static inline int __gpio_get_value(unsigned gpio) |
| 95 | { |
| 96 | return gpiod_get_raw_value(gpio_to_desc(gpio)); |
| 97 | } |
| 98 | static inline void __gpio_set_value(unsigned gpio, int value) |
| 99 | { |
| 100 | return gpiod_set_raw_value(gpio_to_desc(gpio), value); |
| 101 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 102 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 103 | static inline int __gpio_cansleep(unsigned gpio) |
| 104 | { |
| 105 | return gpiod_cansleep(gpio_to_desc(gpio)); |
| 106 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 107 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 108 | static inline int __gpio_to_irq(unsigned gpio) |
| 109 | { |
| 110 | return gpiod_to_irq(gpio_to_desc(gpio)); |
| 111 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 112 | |
Linus Torvalds | d8a3515 | 2011-01-13 17:26:46 -0800 | [diff] [blame] | 113 | extern int gpio_request_one(unsigned gpio, unsigned long flags, const char *label); |
Lars-Peter Clausen | 7c29597 | 2011-05-25 16:20:31 -0700 | [diff] [blame] | 114 | extern int gpio_request_array(const struct gpio *array, size_t num); |
| 115 | extern void gpio_free_array(const struct gpio *array, size_t num); |
Eric Miao | 3e45f1d | 2010-03-05 13:44:35 -0800 | [diff] [blame] | 116 | |
David Brownell | d8f388d | 2008-07-25 01:46:07 -0700 | [diff] [blame] | 117 | /* |
| 118 | * A sysfs interface can be exported by individual drivers if they want, |
| 119 | * but more typically is configured entirely from userspace. |
| 120 | */ |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 121 | static inline int gpio_export(unsigned gpio, bool direction_may_change) |
| 122 | { |
| 123 | return gpiod_export(gpio_to_desc(gpio), direction_may_change); |
| 124 | } |
David Brownell | d8f388d | 2008-07-25 01:46:07 -0700 | [diff] [blame] | 125 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 126 | static inline int gpio_export_link(struct device *dev, const char *name, |
| 127 | unsigned gpio) |
| 128 | { |
| 129 | return gpiod_export_link(dev, name, gpio_to_desc(gpio)); |
| 130 | } |
| 131 | |
| 132 | static inline int gpio_sysfs_set_active_low(unsigned gpio, int value) |
| 133 | { |
| 134 | return gpiod_sysfs_set_active_low(gpio_to_desc(gpio), value); |
| 135 | } |
| 136 | |
| 137 | static inline void gpio_unexport(unsigned gpio) |
| 138 | { |
| 139 | gpiod_unexport(gpio_to_desc(gpio)); |
| 140 | } |
David Brownell | d8f388d | 2008-07-25 01:46:07 -0700 | [diff] [blame] | 141 | |
Shawn Guo | d59b4ea | 2013-01-17 22:03:22 +0800 | [diff] [blame] | 142 | #ifdef CONFIG_PINCTRL |
| 143 | |
| 144 | /** |
| 145 | * struct gpio_pin_range - pin range controlled by a gpio chip |
| 146 | * @head: list for maintaining set of pin ranges, used internally |
| 147 | * @pctldev: pinctrl device which handles corresponding pins |
| 148 | * @range: actual range of pins controlled by a gpio controller |
| 149 | */ |
| 150 | |
| 151 | struct gpio_pin_range { |
| 152 | struct list_head node; |
| 153 | struct pinctrl_dev *pctldev; |
| 154 | struct pinctrl_gpio_range range; |
| 155 | }; |
| 156 | |
| 157 | int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name, |
| 158 | unsigned int gpio_offset, unsigned int pin_offset, |
| 159 | unsigned int npins); |
Christian Ruppert | 586a87e | 2013-10-15 15:37:54 +0200 | [diff] [blame] | 160 | int gpiochip_add_pingroup_range(struct gpio_chip *chip, |
| 161 | struct pinctrl_dev *pctldev, |
| 162 | unsigned int gpio_offset, const char *pin_group); |
Shawn Guo | d59b4ea | 2013-01-17 22:03:22 +0800 | [diff] [blame] | 163 | void gpiochip_remove_pin_ranges(struct gpio_chip *chip); |
| 164 | |
| 165 | #else |
| 166 | |
| 167 | static inline int |
| 168 | gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name, |
| 169 | unsigned int gpio_offset, unsigned int pin_offset, |
| 170 | unsigned int npins) |
| 171 | { |
| 172 | return 0; |
| 173 | } |
Christian Ruppert | 586a87e | 2013-10-15 15:37:54 +0200 | [diff] [blame] | 174 | static inline int |
| 175 | gpiochip_add_pingroup_range(struct gpio_chip *chip, |
| 176 | struct pinctrl_dev *pctldev, |
| 177 | unsigned int gpio_offset, const char *pin_group) |
| 178 | { |
| 179 | return 0; |
| 180 | } |
Shawn Guo | d59b4ea | 2013-01-17 22:03:22 +0800 | [diff] [blame] | 181 | |
| 182 | static inline void |
| 183 | gpiochip_remove_pin_ranges(struct gpio_chip *chip) |
| 184 | { |
| 185 | } |
| 186 | |
| 187 | #endif /* CONFIG_PINCTRL */ |
| 188 | |
Anton Vorontsov | 09cd952 | 2010-10-27 15:33:16 -0700 | [diff] [blame] | 189 | #else /* !CONFIG_GPIOLIB */ |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 190 | |
Joe Perches | 3474cb3 | 2011-05-10 16:23:07 -0700 | [diff] [blame] | 191 | static inline bool gpio_is_valid(int number) |
Guennadi Liakhovetski | e6de180 | 2008-04-28 02:14:46 -0700 | [diff] [blame] | 192 | { |
| 193 | /* only non-negative numbers are valid */ |
| 194 | return number >= 0; |
| 195 | } |
| 196 | |
David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 197 | /* platforms that don't directly support access to GPIOs through I2C, SPI, |
| 198 | * or other blocking infrastructure can use these wrappers. |
| 199 | */ |
| 200 | |
| 201 | static inline int gpio_cansleep(unsigned gpio) |
| 202 | { |
| 203 | return 0; |
| 204 | } |
| 205 | |
| 206 | static inline int gpio_get_value_cansleep(unsigned gpio) |
| 207 | { |
| 208 | might_sleep(); |
Hamo | eb9ae7f | 2011-10-21 09:38:32 +0800 | [diff] [blame] | 209 | return __gpio_get_value(gpio); |
David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 210 | } |
| 211 | |
| 212 | static inline void gpio_set_value_cansleep(unsigned gpio, int value) |
| 213 | { |
| 214 | might_sleep(); |
Hamo | eb9ae7f | 2011-10-21 09:38:32 +0800 | [diff] [blame] | 215 | __gpio_set_value(gpio, value); |
David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 216 | } |
| 217 | |
Anton Vorontsov | 09cd952 | 2010-10-27 15:33:16 -0700 | [diff] [blame] | 218 | #endif /* !CONFIG_GPIOLIB */ |
David Brownell | d8f388d | 2008-07-25 01:46:07 -0700 | [diff] [blame] | 219 | |
David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 220 | #endif /* _ASM_GENERIC_GPIO_H */ |