include/linux/gpio.h

   1 #ifndef __LINUX_GPIO_H
   2 #define __LINUX_GPIO_H
   3
   4 #include <linux/errno.h>
   5
   6 /* see Documentation/gpio.txt */
   7
   8 /* make these flag values available regardless of GPIO kconfig options */
   9 #define GPIOF_DIR_OUT   (0 << 0)
  10 #define GPIOF_DIR_IN    (1 << 0)
  11
  12 #define GPIOF_INIT_LOW  (0 << 1)
  13 #define GPIOF_INIT_HIGH (1 << 1)
  14
  15 #define GPIOF_IN                (GPIOF_DIR_IN)
  16 #define GPIOF_OUT_INIT_LOW      (GPIOF_DIR_OUT | GPIOF_INIT_LOW)
  17 #define GPIOF_OUT_INIT_HIGH     (GPIOF_DIR_OUT | GPIOF_INIT_HIGH)
  18
  19 /* Gpio pin is active-low */
  20 #define GPIOF_ACTIVE_LOW        (1 << 2)
  21
  22 /* Gpio pin is open drain */
  23 #define GPIOF_OPEN_DRAIN        (1 << 3)
  24
  25 /* Gpio pin is open source */
  26 #define GPIOF_OPEN_SOURCE       (1 << 4)
  27
  28 #define GPIOF_EXPORT            (1 << 5)
  29 #define GPIOF_EXPORT_CHANGEABLE (1 << 6)
  30 #define GPIOF_EXPORT_DIR_FIXED  (GPIOF_EXPORT)
  31 #define GPIOF_EXPORT_DIR_CHANGEABLE (GPIOF_EXPORT | GPIOF_EXPORT_CHANGEABLE)
  32
  33 /**
  34  * struct gpio - a structure describing a GPIO with configuration
  35  * @gpio:       the GPIO number
  36  * @flags:      GPIO configuration as specified by GPIOF_*
  37  * @label:      a literal description string of this GPIO
  38  */
  39 struct gpio {
  40         unsigned        gpio;
  41         unsigned long   flags;
  42         const char      *label;
  43 };
  44
  45 #ifdef CONFIG_GPIOLIB
  46
  47 #ifdef CONFIG_ARCH_HAVE_CUSTOM_GPIO_H
  48 #include <asm/gpio.h>
  49 #else
  50
  51 #include <asm-generic/gpio.h>
  52
  53 static inline int gpio_get_value(unsigned int gpio)
  54 {
  55         return __gpio_get_value(gpio);
  56 }
  57
  58 static inline void gpio_set_value(unsigned int gpio, int value)
  59 {
  60         __gpio_set_value(gpio, value);
  61 }
  62
  63 static inline int gpio_cansleep(unsigned int gpio)
  64 {
  65         return __gpio_cansleep(gpio);
  66 }
  67
  68 static inline int gpio_to_irq(unsigned int gpio)
  69 {
  70         return __gpio_to_irq(gpio);
  71 }
  72
  73 static inline int irq_to_gpio(unsigned int irq)
  74 {
  75         return -EINVAL;
  76 }
  77
  78 #endif /* ! CONFIG_ARCH_HAVE_CUSTOM_GPIO_H */
  79
  80 #else /* ! CONFIG_GPIOLIB */
  81
  82 #include <linux/kernel.h>
  83 #include <linux/types.h>
  84 #include <linux/errno.h>
  85 #include <linux/bug.h>
  86 #include <linux/pinctrl/pinctrl.h>
  87
  88 struct device;
  89 struct gpio_chip;
  90 struct pinctrl_dev;
  91
  92 static inline bool gpio_is_valid(int number)
  93 {
  94         return false;
  95 }
  96
  97 static inline int gpio_request(unsigned gpio, const char *label)
  98 {
  99         return -ENOSYS;
 100 }
 101
 102 static inline int gpio_request_one(unsigned gpio,
 103                                         unsigned long flags, const char *label)
 104 {
 105         return -ENOSYS;
 106 }
 107
 108 static inline int gpio_request_array(const struct gpio *array, size_t num)
 109 {
 110         return -ENOSYS;
 111 }
 112
 113 static inline void gpio_free(unsigned gpio)
 114 {
 115         might_sleep();
 116
 117         /* GPIO can never have been requested */
 118         WARN_ON(1);
 119 }
 120
 121 static inline void gpio_free_array(const struct gpio *array, size_t num)
 122 {
 123         might_sleep();
 124
 125         /* GPIO can never have been requested */
 126         WARN_ON(1);
 127 }
 128
 129 static inline int gpio_direction_input(unsigned gpio)
 130 {
 131         return -ENOSYS;
 132 }
 133
 134 static inline int gpio_direction_output(unsigned gpio, int value)
 135 {
 136         return -ENOSYS;
 137 }
 138
 139 static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
 140 {
 141         return -ENOSYS;
 142 }
 143
 144 static inline int gpio_get_value(unsigned gpio)
 145 {
 146         /* GPIO can never have been requested or set as {in,out}put */
 147         WARN_ON(1);
 148         return 0;
 149 }
 150
 151 static inline void gpio_set_value(unsigned gpio, int value)
 152 {
 153         /* GPIO can never have been requested or set as output */
 154         WARN_ON(1);
 155 }
 156
 157 static inline int gpio_cansleep(unsigned gpio)
 158 {
 159         /* GPIO can never have been requested or set as {in,out}put */
 160         WARN_ON(1);
 161         return 0;
 162 }
 163
 164 static inline int gpio_get_value_cansleep(unsigned gpio)
 165 {
 166         /* GPIO can never have been requested or set as {in,out}put */
 167         WARN_ON(1);
 168         return 0;
 169 }
 170
 171 static inline void gpio_set_value_cansleep(unsigned gpio, int value)
 172 {
 173         /* GPIO can never have been requested or set as output */
 174         WARN_ON(1);
 175 }
 176
 177 static inline int gpio_export(unsigned gpio, bool direction_may_change)
 178 {
 179         /* GPIO can never have been requested or set as {in,out}put */
 180         WARN_ON(1);
 181         return -EINVAL;
 182 }
 183
 184 static inline int gpio_export_link(struct device *dev, const char *name,
 185                                 unsigned gpio)
 186 {
 187         /* GPIO can never have been exported */
 188         WARN_ON(1);
 189         return -EINVAL;
 190 }
 191
 192 static inline int gpio_sysfs_set_active_low(unsigned gpio, int value)
 193 {
 194         /* GPIO can never have been requested */
 195         WARN_ON(1);
 196         return -EINVAL;
 197 }
 198
 199 static inline void gpio_unexport(unsigned gpio)
 200 {
 201         /* GPIO can never have been exported */
 202         WARN_ON(1);
 203 }
 204
 205 static inline int gpio_to_irq(unsigned gpio)
 206 {
 207         /* GPIO can never have been requested or set as input */
 208         WARN_ON(1);
 209         return -EINVAL;
 210 }
 211
 212 static inline int gpio_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
 213 {
 214         WARN_ON(1);
 215         return -EINVAL;
 216 }
 217
 218 static inline void gpio_unlock_as_irq(struct gpio_chip *chip,
 219                                       unsigned int offset)
 220 {
 221         WARN_ON(1);
 222 }
 223
 224 static inline int irq_to_gpio(unsigned irq)
 225 {
 226         /* irq can never have been returned from gpio_to_irq() */
 227         WARN_ON(1);
 228         return -EINVAL;
 229 }
 230
 231 static inline int
 232 gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
 233                        unsigned int gpio_offset, unsigned int pin_offset,
 234                        unsigned int npins)
 235 {
 236         WARN_ON(1);
 237         return -EINVAL;
 238 }
 239
 240 static inline int
 241 gpiochip_add_pingroup_range(struct gpio_chip *chip,
 242                         struct pinctrl_dev *pctldev,
 243                         unsigned int gpio_offset, const char *pin_group)
 244 {
 245         WARN_ON(1);
 246         return -EINVAL;
 247 }
 248
 249 static inline void
 250 gpiochip_remove_pin_ranges(struct gpio_chip *chip)
 251 {
 252         WARN_ON(1);
 253 }
 254
 255 #endif /* ! CONFIG_GPIOLIB */
 256
 257 struct device;
 258
 259 /* bindings for managed devices that want to request gpios */
 260 int devm_gpio_request(struct device *dev, unsigned gpio, const char *label);
 261 int devm_gpio_request_one(struct device *dev, unsigned gpio,
 262                           unsigned long flags, const char *label);
 263 void devm_gpio_free(struct device *dev, unsigned int gpio);
 264
 265 #endif /* __LINUX_GPIO_H */