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> |
David Brownell | 6ea0205 | 2008-05-23 13:04:58 -0700 | [diff] [blame] | 8 | |
Michael Buesch | 7444a72 | 2008-07-25 01:46:11 -0700 | [diff] [blame] | 9 | #ifdef CONFIG_GPIOLIB |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 10 | |
David Brownell | 6ea0205 | 2008-05-23 13:04:58 -0700 | [diff] [blame] | 11 | #include <linux/compiler.h> |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 12 | #include <linux/gpio/driver.h> |
| 13 | #include <linux/gpio/consumer.h> |
David Brownell | 6ea0205 | 2008-05-23 13:04:58 -0700 | [diff] [blame] | 14 | |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 15 | /* Platforms may implement their GPIO interface with library code, |
| 16 | * at a small performance cost for non-inlined operations and some |
| 17 | * extra memory (for code and for per-GPIO table entries). |
| 18 | * |
| 19 | * While the GPIO programming interface defines valid GPIO numbers |
| 20 | * 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] | 21 | * smaller range 0..ARCH_NR_GPIOS-1. |
David Brownell | c956126 | 2010-09-09 16:38:03 -0700 | [diff] [blame] | 22 | * |
| 23 | * ARCH_NR_GPIOS is somewhat arbitrary; it usually reflects the sum of |
| 24 | * builtin/SoC GPIOs plus a number of GPIOs on expanders; the latter is |
| 25 | * actually an estimate of a board-specific value. |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 26 | */ |
| 27 | |
| 28 | #ifndef ARCH_NR_GPIOS |
Arnd Bergmann | aa6aedb | 2016-02-16 16:40:38 +0100 | [diff] [blame] | 29 | #if defined(CONFIG_ARCH_NR_GPIO) && CONFIG_ARCH_NR_GPIO > 0 |
| 30 | #define ARCH_NR_GPIOS CONFIG_ARCH_NR_GPIO |
| 31 | #else |
Mika Westerberg | 7ca267f | 2014-09-15 17:09:44 +0300 | [diff] [blame] | 32 | #define ARCH_NR_GPIOS 512 |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 33 | #endif |
Arnd Bergmann | aa6aedb | 2016-02-16 16:40:38 +0100 | [diff] [blame] | 34 | #endif |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 35 | |
David Brownell | c956126 | 2010-09-09 16:38:03 -0700 | [diff] [blame] | 36 | /* |
| 37 | * "valid" GPIO numbers are nonnegative and may be passed to |
| 38 | * setup routines like gpio_request(). only some valid numbers |
| 39 | * can successfully be requested and used. |
| 40 | * |
| 41 | * Invalid GPIO numbers are useful for indicating no-such-GPIO in |
| 42 | * platform data and other tables. |
| 43 | */ |
| 44 | |
Joe Perches | 3474cb3 | 2011-05-10 16:23:07 -0700 | [diff] [blame] | 45 | static inline bool gpio_is_valid(int number) |
Guennadi Liakhovetski | e6de180 | 2008-04-28 02:14:46 -0700 | [diff] [blame] | 46 | { |
Joe Perches | 3474cb3 | 2011-05-10 16:23:07 -0700 | [diff] [blame] | 47 | return number >= 0 && number < ARCH_NR_GPIOS; |
Guennadi Liakhovetski | e6de180 | 2008-04-28 02:14:46 -0700 | [diff] [blame] | 48 | } |
| 49 | |
Mike Frysinger | 1f018c8 | 2009-12-09 06:53:39 -0500 | [diff] [blame] | 50 | struct device; |
Mark Brown | feb8369 | 2011-10-24 15:24:10 +0200 | [diff] [blame] | 51 | struct gpio; |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 52 | struct seq_file; |
Guennadi Liakhovetski | 438d890 | 2008-04-28 02:14:44 -0700 | [diff] [blame] | 53 | struct module; |
Anton Vorontsov | a19e3da | 2010-06-08 07:48:16 -0600 | [diff] [blame] | 54 | struct device_node; |
Alexandre Courbot | 6c0b4e6 | 2013-02-03 01:29:30 +0900 | [diff] [blame] | 55 | struct gpio_desc; |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 56 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 57 | /* caller holds gpio_lock *OR* gpio is marked as requested */ |
| 58 | static inline struct gpio_chip *gpio_to_chip(unsigned gpio) |
| 59 | { |
| 60 | return gpiod_to_chip(gpio_to_desc(gpio)); |
| 61 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 62 | |
| 63 | /* Always use the library code for GPIO management calls, |
| 64 | * or when sleeping may be involved. |
| 65 | */ |
Linus Torvalds | d8a3515 | 2011-01-13 17:26:46 -0800 | [diff] [blame] | 66 | extern int gpio_request(unsigned gpio, const char *label); |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 67 | extern void gpio_free(unsigned gpio); |
| 68 | |
Alexandre Courbot | c7caf86 | 2014-07-24 14:51:02 +0900 | [diff] [blame] | 69 | static inline int gpio_direction_input(unsigned gpio) |
| 70 | { |
| 71 | return gpiod_direction_input(gpio_to_desc(gpio)); |
| 72 | } |
| 73 | static inline int gpio_direction_output(unsigned gpio, int value) |
| 74 | { |
| 75 | return gpiod_direction_output_raw(gpio_to_desc(gpio), value); |
| 76 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 77 | |
Alexandre Courbot | c7caf86 | 2014-07-24 14:51:02 +0900 | [diff] [blame] | 78 | static inline int gpio_set_debounce(unsigned gpio, unsigned debounce) |
| 79 | { |
| 80 | return gpiod_set_debounce(gpio_to_desc(gpio), debounce); |
| 81 | } |
Felipe Balbi | c4b5be9 | 2010-05-26 14:42:23 -0700 | [diff] [blame] | 82 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 83 | static inline int gpio_get_value_cansleep(unsigned gpio) |
| 84 | { |
| 85 | return gpiod_get_raw_value_cansleep(gpio_to_desc(gpio)); |
| 86 | } |
| 87 | static inline void gpio_set_value_cansleep(unsigned gpio, int value) |
| 88 | { |
| 89 | return gpiod_set_raw_value_cansleep(gpio_to_desc(gpio), value); |
| 90 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 91 | |
| 92 | |
| 93 | /* A platform's <asm/gpio.h> code may want to inline the I/O calls when |
| 94 | * the GPIO is constant and refers to some always-present controller, |
| 95 | * giving direct access to chip registers and tight bitbanging loops. |
| 96 | */ |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 97 | static inline int __gpio_get_value(unsigned gpio) |
| 98 | { |
| 99 | return gpiod_get_raw_value(gpio_to_desc(gpio)); |
| 100 | } |
| 101 | static inline void __gpio_set_value(unsigned gpio, int value) |
| 102 | { |
| 103 | return gpiod_set_raw_value(gpio_to_desc(gpio), value); |
| 104 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 105 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 106 | static inline int __gpio_cansleep(unsigned gpio) |
| 107 | { |
| 108 | return gpiod_cansleep(gpio_to_desc(gpio)); |
| 109 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 110 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 111 | static inline int __gpio_to_irq(unsigned gpio) |
| 112 | { |
| 113 | return gpiod_to_irq(gpio_to_desc(gpio)); |
| 114 | } |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 115 | |
Linus Torvalds | d8a3515 | 2011-01-13 17:26:46 -0800 | [diff] [blame] | 116 | 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] | 117 | extern int gpio_request_array(const struct gpio *array, size_t num); |
| 118 | extern void gpio_free_array(const struct gpio *array, size_t num); |
Eric Miao | 3e45f1d | 2010-03-05 13:44:35 -0800 | [diff] [blame] | 119 | |
David Brownell | d8f388d | 2008-07-25 01:46:07 -0700 | [diff] [blame] | 120 | /* |
| 121 | * A sysfs interface can be exported by individual drivers if they want, |
| 122 | * but more typically is configured entirely from userspace. |
| 123 | */ |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 124 | static inline int gpio_export(unsigned gpio, bool direction_may_change) |
| 125 | { |
| 126 | return gpiod_export(gpio_to_desc(gpio), direction_may_change); |
| 127 | } |
David Brownell | d8f388d | 2008-07-25 01:46:07 -0700 | [diff] [blame] | 128 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 129 | static 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 | |
Alexandre Courbot | 79a9bec | 2013-10-17 10:21:36 -0700 | [diff] [blame] | 135 | static inline void gpio_unexport(unsigned gpio) |
| 136 | { |
| 137 | gpiod_unexport(gpio_to_desc(gpio)); |
| 138 | } |
David Brownell | d8f388d | 2008-07-25 01:46:07 -0700 | [diff] [blame] | 139 | |
Anton Vorontsov | 09cd952 | 2010-10-27 15:33:16 -0700 | [diff] [blame] | 140 | #else /* !CONFIG_GPIOLIB */ |
David Brownell | d2876d0 | 2008-02-04 22:28:20 -0800 | [diff] [blame] | 141 | |
Joe Perches | 3474cb3 | 2011-05-10 16:23:07 -0700 | [diff] [blame] | 142 | static inline bool gpio_is_valid(int number) |
Guennadi Liakhovetski | e6de180 | 2008-04-28 02:14:46 -0700 | [diff] [blame] | 143 | { |
| 144 | /* only non-negative numbers are valid */ |
| 145 | return number >= 0; |
| 146 | } |
| 147 | |
David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 148 | /* platforms that don't directly support access to GPIOs through I2C, SPI, |
| 149 | * or other blocking infrastructure can use these wrappers. |
| 150 | */ |
| 151 | |
| 152 | static inline int gpio_cansleep(unsigned gpio) |
| 153 | { |
| 154 | return 0; |
| 155 | } |
| 156 | |
| 157 | static inline int gpio_get_value_cansleep(unsigned gpio) |
| 158 | { |
| 159 | might_sleep(); |
Hamo | eb9ae7f | 2011-10-21 09:38:32 +0800 | [diff] [blame] | 160 | return __gpio_get_value(gpio); |
David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | static inline void gpio_set_value_cansleep(unsigned gpio, int value) |
| 164 | { |
| 165 | might_sleep(); |
Hamo | eb9ae7f | 2011-10-21 09:38:32 +0800 | [diff] [blame] | 166 | __gpio_set_value(gpio, value); |
David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 167 | } |
| 168 | |
Anton Vorontsov | 09cd952 | 2010-10-27 15:33:16 -0700 | [diff] [blame] | 169 | #endif /* !CONFIG_GPIOLIB */ |
David Brownell | d8f388d | 2008-07-25 01:46:07 -0700 | [diff] [blame] | 170 | |
David Brownell | 4c20386 | 2007-02-12 00:53:11 -0800 | [diff] [blame] | 171 | #endif /* _ASM_GENERIC_GPIO_H */ |