include/asm-generic/gpio.h

   1 #ifndef _ASM_GENERIC_GPIO_H
   2 #define _ASM_GENERIC_GPIO_H
   3
   4 #include <linux/kernel.h>
   5 #include <linux/types.h>
   6 #include <linux/errno.h>
   7 #include <linux/of.h>
   8
   9 #ifdef CONFIG_GPIOLIB
  10
  11 #include <linux/compiler.h>
  12
  13 /* Platforms may implement their GPIO interface with library code,
  14  * at a small performance cost for non-inlined operations and some
  15  * extra memory (for code and for per-GPIO table entries).
  16  *
  17  * While the GPIO programming interface defines valid GPIO numbers
  18  * to be in the range 0..MAX_INT, this library restricts them to the
  19  * smaller range 0..ARCH_NR_GPIOS-1.
  20  *
  21  * ARCH_NR_GPIOS is somewhat arbitrary; it usually reflects the sum of
  22  * builtin/SoC GPIOs plus a number of GPIOs on expanders; the latter is
  23  * actually an estimate of a board-specific value.
  24  */
  25
  26 #ifndef ARCH_NR_GPIOS
  27 #define ARCH_NR_GPIOS           256
  28 #endif
  29
  30 /*
  31  * "valid" GPIO numbers are nonnegative and may be passed to
  32  * setup routines like gpio_request().  only some valid numbers
  33  * can successfully be requested and used.
  34  *
  35  * Invalid GPIO numbers are useful for indicating no-such-GPIO in
  36  * platform data and other tables.
  37  */
  38
  39 static inline bool gpio_is_valid(int number)
  40 {
  41         return number >= 0 && number < ARCH_NR_GPIOS;
  42 }
  43
  44 struct device;
  45 struct gpio;
  46 struct seq_file;
  47 struct module;
  48 struct device_node;
  49
  50 /**
  51  * struct gpio_chip - abstract a GPIO controller
  52  * @label: for diagnostics
  53  * @dev: optional device providing the GPIOs
  54  * @owner: helps prevent removal of modules exporting active GPIOs
  55  * @request: optional hook for chip-specific activation, such as
  56  *      enabling module power and clock; may sleep
  57  * @free: optional hook for chip-specific deactivation, such as
  58  *      disabling module power and clock; may sleep
  59  * @get_direction: returns direction for signal "offset", 0=out, 1=in,
  60  *      (same as GPIOF_DIR_XXX), or negative error
  61  * @direction_input: configures signal "offset" as input, or returns error
  62  * @get: returns value for signal "offset"; for output signals this
  63  *      returns either the value actually sensed, or zero
  64  * @direction_output: configures signal "offset" as output, or returns error
  65  * @set_debounce: optional hook for setting debounce time for specified gpio in
  66  *      interrupt triggered gpio chips
  67  * @set: assigns output value for signal "offset"
  68  * @to_irq: optional hook supporting non-static gpio_to_irq() mappings;
  69  *      implementation may not sleep
  70  * @dbg_show: optional routine to show contents in debugfs; default code
  71  *      will be used when this is omitted, but custom code can show extra
  72  *      state (such as pullup/pulldown configuration).
  73  * @base: identifies the first GPIO number handled by this chip; or, if
  74  *      negative during registration, requests dynamic ID allocation.
  75  * @ngpio: the number of GPIOs handled by this controller; the last GPIO
  76  *      handled is (base + ngpio - 1).
  77  * @can_sleep: flag must be set iff get()/set() methods sleep, as they
  78  *      must while accessing GPIO expander chips over I2C or SPI
  79  * @names: if set, must be an array of strings to use as alternative
  80  *      names for the GPIOs in this chip. Any entry in the array
  81  *      may be NULL if there is no alias for the GPIO, however the
  82  *      array must be @ngpio entries long.  A name can include a single printk
  83  *      format specifier for an unsigned int.  It is substituted by the actual
  84  *      number of the gpio.
  85  *
  86  * A gpio_chip can help platforms abstract various sources of GPIOs so
  87  * they can all be accessed through a common programing interface.
  88  * Example sources would be SOC controllers, FPGAs, multifunction
  89  * chips, dedicated GPIO expanders, and so on.
  90  *
  91  * Each chip controls a number of signals, identified in method calls
  92  * by "offset" values in the range 0..(@ngpio - 1).  When those signals
  93  * are referenced through calls like gpio_get_value(gpio), the offset
  94  * is calculated by subtracting @base from the gpio number.
  95  */
  96 struct gpio_chip {
  97         const char              *label;
  98         struct device           *dev;
  99         struct module           *owner;
 100
 101         int                     (*request)(struct gpio_chip *chip,
 102                                                 unsigned offset);
 103         void                    (*free)(struct gpio_chip *chip,
 104                                                 unsigned offset);
 105         int                     (*get_direction)(struct gpio_chip *chip,
 106                                                 unsigned offset);
 107         int                     (*direction_input)(struct gpio_chip *chip,
 108                                                 unsigned offset);
 109         int                     (*get)(struct gpio_chip *chip,
 110                                                 unsigned offset);
 111         int                     (*direction_output)(struct gpio_chip *chip,
 112                                                 unsigned offset, int value);
 113         int                     (*set_debounce)(struct gpio_chip *chip,
 114                                                 unsigned offset, unsigned debounce);
 115
 116         void                    (*set)(struct gpio_chip *chip,
 117                                                 unsigned offset, int value);
 118
 119         int                     (*to_irq)(struct gpio_chip *chip,
 120                                                 unsigned offset);
 121
 122         void                    (*dbg_show)(struct seq_file *s,
 123                                                 struct gpio_chip *chip);
 124         int                     base;
 125         u16                     ngpio;
 126         const char              *const *names;
 127         unsigned                can_sleep:1;
 128         unsigned                exported:1;
 129
 130 #if defined(CONFIG_OF_GPIO)
 131         /*
 132          * If CONFIG_OF is enabled, then all GPIO controllers described in the
 133          * device tree automatically may have an OF translation
 134          */
 135         struct device_node *of_node;
 136         int of_gpio_n_cells;
 137         int (*of_xlate)(struct gpio_chip *gc,
 138                         const struct of_phandle_args *gpiospec, u32 *flags);
 139 #endif
 140 };
 141
 142 extern const char *gpiochip_is_requested(struct gpio_chip *chip,
 143                         unsigned offset);
 144 extern struct gpio_chip *gpio_to_chip(unsigned gpio);
 145 extern int __must_check gpiochip_reserve(int start, int ngpio);
 146
 147 /* add/remove chips */
 148 extern int gpiochip_add(struct gpio_chip *chip);
 149 extern int __must_check gpiochip_remove(struct gpio_chip *chip);
 150 extern struct gpio_chip *gpiochip_find(void *data,
 151                                         int (*match)(struct gpio_chip *chip,
 152                                                      void *data));
 153
 154
 155 /* Always use the library code for GPIO management calls,
 156  * or when sleeping may be involved.
 157  */
 158 extern int gpio_request(unsigned gpio, const char *label);
 159 extern void gpio_free(unsigned gpio);
 160
 161 extern int gpio_direction_input(unsigned gpio);
 162 extern int gpio_direction_output(unsigned gpio, int value);
 163
 164 extern int gpio_set_debounce(unsigned gpio, unsigned debounce);
 165
 166 extern int gpio_get_value_cansleep(unsigned gpio);
 167 extern void gpio_set_value_cansleep(unsigned gpio, int value);
 168
 169
 170 /* A platform's <asm/gpio.h> code may want to inline the I/O calls when
 171  * the GPIO is constant and refers to some always-present controller,
 172  * giving direct access to chip registers and tight bitbanging loops.
 173  */
 174 extern int __gpio_get_value(unsigned gpio);
 175 extern void __gpio_set_value(unsigned gpio, int value);
 176
 177 extern int __gpio_cansleep(unsigned gpio);
 178
 179 extern int __gpio_to_irq(unsigned gpio);
 180
 181 extern int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
 182 extern int gpio_request_array(const struct gpio *array, size_t num);
 183 extern void gpio_free_array(const struct gpio *array, size_t num);
 184
 185 /* bindings for managed devices that want to request gpios */
 186 int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
 187 int devm_gpio_request_one(struct device *dev, unsigned gpio,
 188                           unsigned long flags, const char *label);
 189 void devm_gpio_free(struct device *dev, unsigned int gpio);
 190
 191 #ifdef CONFIG_GPIO_SYSFS
 192
 193 /*
 194  * A sysfs interface can be exported by individual drivers if they want,
 195  * but more typically is configured entirely from userspace.
 196  */
 197 extern int gpio_export(unsigned gpio, bool direction_may_change);
 198 extern int gpio_export_link(struct device *dev, const char *name,
 199                         unsigned gpio);
 200 extern int gpio_sysfs_set_active_low(unsigned gpio, int value);
 201 extern void gpio_unexport(unsigned gpio);
 202
 203 #endif  /* CONFIG_GPIO_SYSFS */
 204
 205 #else   /* !CONFIG_GPIOLIB */
 206
 207 static inline bool gpio_is_valid(int number)
 208 {
 209         /* only non-negative numbers are valid */
 210         return number >= 0;
 211 }
 212
 213 /* platforms that don't directly support access to GPIOs through I2C, SPI,
 214  * or other blocking infrastructure can use these wrappers.
 215  */
 216
 217 static inline int gpio_cansleep(unsigned gpio)
 218 {
 219         return 0;
 220 }
 221
 222 static inline int gpio_get_value_cansleep(unsigned gpio)
 223 {
 224         might_sleep();
 225         return __gpio_get_value(gpio);
 226 }
 227
 228 static inline void gpio_set_value_cansleep(unsigned gpio, int value)
 229 {
 230         might_sleep();
 231         __gpio_set_value(gpio, value);
 232 }
 233
 234 #endif /* !CONFIG_GPIOLIB */
 235
 236 #ifndef CONFIG_GPIO_SYSFS
 237
 238 struct device;
 239
 240 /* sysfs support is only available with gpiolib, where it's optional */
 241
 242 static inline int gpio_export(unsigned gpio, bool direction_may_change)
 243 {
 244         return -ENOSYS;
 245 }
 246
 247 static inline int gpio_export_link(struct device *dev, const char *name,
 248                                 unsigned gpio)
 249 {
 250         return -ENOSYS;
 251 }
 252
 253 static inline int gpio_sysfs_set_active_low(unsigned gpio, int value)
 254 {
 255         return -ENOSYS;
 256 }
 257
 258 static inline void gpio_unexport(unsigned gpio)
 259 {
 260 }
 261 #endif  /* CONFIG_GPIO_SYSFS */
 262
 263 #endif /* _ASM_GENERIC_GPIO_H */