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 #include <linux/pinctrl/pinctrl.h>
   9
  10 #ifdef CONFIG_GPIOLIB
  11
  12 #include <linux/compiler.h>
  13
  14 /* 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
  20  * smaller range 0..ARCH_NR_GPIOS-1.
  21  *
  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.
  25  */
  26
  27 #ifndef ARCH_NR_GPIOS
  28 #define ARCH_NR_GPIOS           256
  29 #endif
  30
  31 /*
  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
  40 static inline bool gpio_is_valid(int number)
  41 {
  42         return number >= 0 && number < ARCH_NR_GPIOS;
  43 }
  44
  45 struct device;
  46 struct gpio;
  47 struct seq_file;
  48 struct module;
  49 struct device_node;
  50
  51 /**
  52  * struct gpio_chip - abstract a GPIO controller
  53  * @label: for diagnostics
  54  * @dev: optional device providing the GPIOs
  55  * @owner: helps prevent removal of modules exporting active GPIOs
  56  * @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
  60  * @direction_input: configures signal "offset" as input, or returns error
  61  * @get: returns value for signal "offset"; for output signals this
  62  *      returns either the value actually sensed, or zero
  63  * @direction_output: configures signal "offset" as output, or returns error
  64  * @set_debounce: optional hook for setting debounce time for specified gpio in
  65  *      interrupt triggered gpio chips
  66  * @set: assigns output value for signal "offset"
  67  * @to_irq: optional hook supporting non-static gpio_to_irq() mappings;
  68  *      implementation may not sleep
  69  * @dbg_show: optional routine to show contents in debugfs; default code
  70  *      will be used when this is omitted, but custom code can show extra
  71  *      state (such as pullup/pulldown configuration).
  72  * @base: identifies the first GPIO number handled by this chip; or, if
  73  *      negative during registration, requests dynamic ID allocation.
  74  * @ngpio: the number of GPIOs handled by this controller; the last GPIO
  75  *      handled is (base + ngpio - 1).
  76  * @can_sleep: flag must be set iff get()/set() methods sleep, as they
  77  *      must while accessing GPIO expander chips over I2C or SPI
  78  * @names: if set, must be an array of strings to use as alternative
  79  *      names for the GPIOs in this chip. Any entry in the array
  80  *      may be NULL if there is no alias for the GPIO, however the
  81  *      array must be @ngpio entries long.  A name can include a single printk
  82  *      format specifier for an unsigned int.  It is substituted by the actual
  83  *      number of the gpio.
  84  *
  85  * A gpio_chip can help platforms abstract various sources of GPIOs so
  86  * they can all be accessed through a common programing interface.
  87  * Example sources would be SOC controllers, FPGAs, multifunction
  88  * chips, dedicated GPIO expanders, and so on.
  89  *
  90  * Each chip controls a number of signals, identified in method calls
  91  * by "offset" values in the range 0..(@ngpio - 1).  When those signals
  92  * are referenced through calls like gpio_get_value(gpio), the offset
  93  * is calculated by subtracting @base from the gpio number.
  94  */
  95 struct gpio_chip {
  96         const char              *label;
  97         struct device           *dev;
  98         struct module           *owner;
  99
 100         int                     (*request)(struct gpio_chip *chip,
 101                                                 unsigned offset);
 102         void                    (*free)(struct gpio_chip *chip,
 103                                                 unsigned offset);
 104
 105         int                     (*direction_input)(struct gpio_chip *chip,
 106                                                 unsigned offset);
 107         int                     (*get)(struct gpio_chip *chip,
 108                                                 unsigned offset);
 109         int                     (*direction_output)(struct gpio_chip *chip,
 110                                                 unsigned offset, int value);
 111         int                     (*set_debounce)(struct gpio_chip *chip,
 112                                                 unsigned offset, unsigned debounce);
 113
 114         void                    (*set)(struct gpio_chip *chip,
 115                                                 unsigned offset, int value);
 116
 117         int                     (*to_irq)(struct gpio_chip *chip,
 118                                                 unsigned offset);
 119
 120         void                    (*dbg_show)(struct seq_file *s,
 121                                                 struct gpio_chip *chip);
 122         int                     base;
 123         u16                     ngpio;
 124         const char              *const *names;
 125         unsigned                can_sleep:1;
 126         unsigned                exported:1;
 127
 128 #if defined(CONFIG_OF_GPIO)
 129         /*
 130          * If CONFIG_OF is enabled, then all GPIO controllers described in the
 131          * device tree automatically may have an OF translation
 132          */
 133         struct device_node *of_node;
 134         int of_gpio_n_cells;
 135         int (*of_xlate)(struct gpio_chip *gc,
 136                         const struct of_phandle_args *gpiospec, u32 *flags);
 137 #endif
 138 #ifdef CONFIG_PINCTRL
 139         /*
 140          * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally
 141          * describe the actual pin range which they serve in an SoC. This
 142          * information would be used by pinctrl subsystem to configure
 143          * corresponding pins for gpio usage.
 144          */
 145         struct list_head pin_ranges;
 146 #endif
 147 };
 148
 149 extern const char *gpiochip_is_requested(struct gpio_chip *chip,
 150                         unsigned offset);
 151 extern struct gpio_chip *gpio_to_chip(unsigned gpio);
 152 extern int __must_check gpiochip_reserve(int start, int ngpio);
 153
 154 /* add/remove chips */
 155 extern int gpiochip_add(struct gpio_chip *chip);
 156 extern int __must_check gpiochip_remove(struct gpio_chip *chip);
 157 extern struct gpio_chip *gpiochip_find(void *data,
 158                                         int (*match)(struct gpio_chip *chip,
 159                                                      void *data));
 160
 161
 162 /* Always use the library code for GPIO management calls,
 163  * or when sleeping may be involved.
 164  */
 165 extern int gpio_request(unsigned gpio, const char *label);
 166 extern void gpio_free(unsigned gpio);
 167
 168 extern int gpio_direction_input(unsigned gpio);
 169 extern int gpio_direction_output(unsigned gpio, int value);
 170
 171 extern int gpio_set_debounce(unsigned gpio, unsigned debounce);
 172
 173 extern int gpio_get_value_cansleep(unsigned gpio);
 174 extern void gpio_set_value_cansleep(unsigned gpio, int value);
 175
 176
 177 /* A platform's <asm/gpio.h> code may want to inline the I/O calls when
 178  * the GPIO is constant and refers to some always-present controller,
 179  * giving direct access to chip registers and tight bitbanging loops.
 180  */
 181 extern int __gpio_get_value(unsigned gpio);
 182 extern void __gpio_set_value(unsigned gpio, int value);
 183
 184 extern int __gpio_cansleep(unsigned gpio);
 185
 186 extern int __gpio_to_irq(unsigned gpio);
 187
 188 extern int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
 189 extern int gpio_request_array(const struct gpio *array, size_t num);
 190 extern void gpio_free_array(const struct gpio *array, size_t num);
 191
 192 /* bindings for managed devices that want to request gpios */
 193 int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
 194 int devm_gpio_request_one(struct device *dev, unsigned gpio,
 195                           unsigned long flags, const char *label);
 196 void devm_gpio_free(struct device *dev, unsigned int gpio);
 197
 198 #ifdef CONFIG_GPIO_SYSFS
 199
 200 /*
 201  * A sysfs interface can be exported by individual drivers if they want,
 202  * but more typically is configured entirely from userspace.
 203  */
 204 extern int gpio_export(unsigned gpio, bool direction_may_change);
 205 extern int gpio_export_link(struct device *dev, const char *name,
 206                         unsigned gpio);
 207 extern int gpio_sysfs_set_active_low(unsigned gpio, int value);
 208 extern void gpio_unexport(unsigned gpio);
 209
 210 #endif  /* CONFIG_GPIO_SYSFS */
 211
 212 #else   /* !CONFIG_GPIOLIB */
 213
 214 static inline bool gpio_is_valid(int number)
 215 {
 216         /* only non-negative numbers are valid */
 217         return number >= 0;
 218 }
 219
 220 /* platforms that don't directly support access to GPIOs through I2C, SPI,
 221  * or other blocking infrastructure can use these wrappers.
 222  */
 223
 224 static inline int gpio_cansleep(unsigned gpio)
 225 {
 226         return 0;
 227 }
 228
 229 static inline int gpio_get_value_cansleep(unsigned gpio)
 230 {
 231         might_sleep();
 232         return __gpio_get_value(gpio);
 233 }
 234
 235 static inline void gpio_set_value_cansleep(unsigned gpio, int value)
 236 {
 237         might_sleep();
 238         __gpio_set_value(gpio, value);
 239 }
 240
 241 #endif /* !CONFIG_GPIOLIB */
 242
 243 #ifndef CONFIG_GPIO_SYSFS
 244
 245 struct device;
 246
 247 /* sysfs support is only available with gpiolib, where it's optional */
 248
 249 static inline int gpio_export(unsigned gpio, bool direction_may_change)
 250 {
 251         return -ENOSYS;
 252 }
 253
 254 static inline int gpio_export_link(struct device *dev, const char *name,
 255                                 unsigned gpio)
 256 {
 257         return -ENOSYS;
 258 }
 259
 260 static inline int gpio_sysfs_set_active_low(unsigned gpio, int value)
 261 {
 262         return -ENOSYS;
 263 }
 264
 265 static inline void gpio_unexport(unsigned gpio)
 266 {
 267 }
 268 #endif  /* CONFIG_GPIO_SYSFS */
 269
 270 #ifdef CONFIG_PINCTRL
 271
 272 /**
 273  * struct gpio_pin_range - pin range controlled by a gpio chip
 274  * @head: list for maintaining set of pin ranges, used internally
 275  * @pctldev: pinctrl device which handles corresponding pins
 276  * @range: actual range of pins controlled by a gpio controller
 277  */
 278
 279 struct gpio_pin_range {
 280         struct list_head node;
 281         struct pinctrl_dev *pctldev;
 282         struct pinctrl_gpio_range range;
 283 };
 284
 285 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
 286                            unsigned int gpio_offset, unsigned int pin_offset,
 287                            unsigned int npins);
 288 void gpiochip_remove_pin_ranges(struct gpio_chip *chip);
 289
 290 #else
 291
 292 static inline int
 293 gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
 294                        unsigned int gpio_offset, unsigned int pin_offset,
 295                        unsigned int npins)
 296 {
 297         return 0;
 298 }
 299
 300 static inline void
 301 gpiochip_remove_pin_ranges(struct gpio_chip *chip)
 302 {
 303 }
 304
 305 #endif /* CONFIG_PINCTRL */
 306
 307 #endif /* _ASM_GENERIC_GPIO_H */