include/linux/gpio/consumer.h

   1 #ifndef __LINUX_GPIO_CONSUMER_H
   2 #define __LINUX_GPIO_CONSUMER_H
   3
   4 #include <linux/bug.h>
   5 #include <linux/err.h>
   6 #include <linux/kernel.h>
   7
   8 struct device;
   9
  10 /**
  11  * Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are
  12  * preferable to the old integer-based handles.
  13  *
  14  * Contrary to integers, a pointer to a gpio_desc is guaranteed to be valid
  15  * until the GPIO is released.
  16  */
  17 struct gpio_desc;
  18
  19 #define GPIOD_FLAGS_BIT_DIR_SET         BIT(0)
  20 #define GPIOD_FLAGS_BIT_DIR_OUT         BIT(1)
  21 #define GPIOD_FLAGS_BIT_DIR_VAL         BIT(2)
  22
  23 /**
  24  * Optional flags that can be passed to one of gpiod_* to configure direction
  25  * and output value. These values cannot be OR'd.
  26  */
  27 enum gpiod_flags {
  28         GPIOD_ASIS      = 0,
  29         GPIOD_IN        = GPIOD_FLAGS_BIT_DIR_SET,
  30         GPIOD_OUT_LOW   = GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT,
  31         GPIOD_OUT_HIGH  = GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
  32                           GPIOD_FLAGS_BIT_DIR_VAL,
  33 };
  34
  35 #ifdef CONFIG_GPIOLIB
  36
  37 /* Acquire and dispose GPIOs */
  38 struct gpio_desc *__must_check __gpiod_get(struct device *dev,
  39                                          const char *con_id,
  40                                          enum gpiod_flags flags);
  41 struct gpio_desc *__must_check __gpiod_get_index(struct device *dev,
  42                                                const char *con_id,
  43                                                unsigned int idx,
  44                                                enum gpiod_flags flags);
  45 struct gpio_desc *__must_check __gpiod_get_optional(struct device *dev,
  46                                                   const char *con_id,
  47                                                   enum gpiod_flags flags);
  48 struct gpio_desc *__must_check __gpiod_get_index_optional(struct device *dev,
  49                                                         const char *con_id,
  50                                                         unsigned int index,
  51                                                         enum gpiod_flags flags);
  52 void gpiod_put(struct gpio_desc *desc);
  53
  54 struct gpio_desc *__must_check __devm_gpiod_get(struct device *dev,
  55                                               const char *con_id,
  56                                               enum gpiod_flags flags);
  57 struct gpio_desc *__must_check __devm_gpiod_get_index(struct device *dev,
  58                                                     const char *con_id,
  59                                                     unsigned int idx,
  60                                                     enum gpiod_flags flags);
  61 struct gpio_desc *__must_check __devm_gpiod_get_optional(struct device *dev,
  62                                                        const char *con_id,
  63                                                        enum gpiod_flags flags);
  64 struct gpio_desc *__must_check
  65 __devm_gpiod_get_index_optional(struct device *dev, const char *con_id,
  66                               unsigned int index, enum gpiod_flags flags);
  67 void devm_gpiod_put(struct device *dev, struct gpio_desc *desc);
  68
  69 int gpiod_get_direction(struct gpio_desc *desc);
  70 int gpiod_direction_input(struct gpio_desc *desc);
  71 int gpiod_direction_output(struct gpio_desc *desc, int value);
  72 int gpiod_direction_output_raw(struct gpio_desc *desc, int value);
  73
  74 /* Value get/set from non-sleeping context */
  75 int gpiod_get_value(const struct gpio_desc *desc);
  76 void gpiod_set_value(struct gpio_desc *desc, int value);
  77 void gpiod_set_array(unsigned int array_size,
  78                      struct gpio_desc **desc_array, int *value_array);
  79 int gpiod_get_raw_value(const struct gpio_desc *desc);
  80 void gpiod_set_raw_value(struct gpio_desc *desc, int value);
  81 void gpiod_set_raw_array(unsigned int array_size,
  82                          struct gpio_desc **desc_array, int *value_array);
  83
  84 /* Value get/set from sleeping context */
  85 int gpiod_get_value_cansleep(const struct gpio_desc *desc);
  86 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value);
  87 void gpiod_set_array_cansleep(unsigned int array_size,
  88                               struct gpio_desc **desc_array,
  89                               int *value_array);
  90 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc);
  91 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value);
  92 void gpiod_set_raw_array_cansleep(unsigned int array_size,
  93                                   struct gpio_desc **desc_array,
  94                                   int *value_array);
  95
  96 int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce);
  97
  98 int gpiod_is_active_low(const struct gpio_desc *desc);
  99 int gpiod_cansleep(const struct gpio_desc *desc);
 100
 101 int gpiod_to_irq(const struct gpio_desc *desc);
 102
 103 /* Convert between the old gpio_ and new gpiod_ interfaces */
 104 struct gpio_desc *gpio_to_desc(unsigned gpio);
 105 int desc_to_gpio(const struct gpio_desc *desc);
 106
 107 /* Child properties interface */
 108 struct fwnode_handle;
 109
 110 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
 111                                          const char *propname);
 112 struct gpio_desc *devm_get_gpiod_from_child(struct device *dev,
 113                                             struct fwnode_handle *child);
 114 #else /* CONFIG_GPIOLIB */
 115
 116 static inline struct gpio_desc *__must_check __gpiod_get(struct device *dev,
 117                                                 const char *con_id,
 118                                                 enum gpiod_flags flags)
 119 {
 120         return ERR_PTR(-ENOSYS);
 121 }
 122 static inline struct gpio_desc *__must_check
 123 __gpiod_get_index(struct device *dev,
 124                   const char *con_id,
 125                   unsigned int idx,
 126                   enum gpiod_flags flags)
 127 {
 128         return ERR_PTR(-ENOSYS);
 129 }
 130
 131 static inline struct gpio_desc *__must_check
 132 __gpiod_get_optional(struct device *dev, const char *con_id,
 133                      enum gpiod_flags flags)
 134 {
 135         return ERR_PTR(-ENOSYS);
 136 }
 137
 138 static inline struct gpio_desc *__must_check
 139 __gpiod_get_index_optional(struct device *dev, const char *con_id,
 140                            unsigned int index, enum gpiod_flags flags)
 141 {
 142         return ERR_PTR(-ENOSYS);
 143 }
 144
 145 static inline void gpiod_put(struct gpio_desc *desc)
 146 {
 147         might_sleep();
 148
 149         /* GPIO can never have been requested */
 150         WARN_ON(1);
 151 }
 152
 153 static inline struct gpio_desc *__must_check
 154 __devm_gpiod_get(struct device *dev,
 155                  const char *con_id,
 156                  enum gpiod_flags flags)
 157 {
 158         return ERR_PTR(-ENOSYS);
 159 }
 160 static inline
 161 struct gpio_desc *__must_check
 162 __devm_gpiod_get_index(struct device *dev,
 163                        const char *con_id,
 164                        unsigned int idx,
 165                        enum gpiod_flags flags)
 166 {
 167         return ERR_PTR(-ENOSYS);
 168 }
 169
 170 static inline struct gpio_desc *__must_check
 171 __devm_gpiod_get_optional(struct device *dev, const char *con_id,
 172                           enum gpiod_flags flags)
 173 {
 174         return ERR_PTR(-ENOSYS);
 175 }
 176
 177 static inline struct gpio_desc *__must_check
 178 __devm_gpiod_get_index_optional(struct device *dev, const char *con_id,
 179                                 unsigned int index, enum gpiod_flags flags)
 180 {
 181         return ERR_PTR(-ENOSYS);
 182 }
 183
 184 static inline void devm_gpiod_put(struct device *dev, struct gpio_desc *desc)
 185 {
 186         might_sleep();
 187
 188         /* GPIO can never have been requested */
 189         WARN_ON(1);
 190 }
 191
 192
 193 static inline int gpiod_get_direction(const struct gpio_desc *desc)
 194 {
 195         /* GPIO can never have been requested */
 196         WARN_ON(1);
 197         return -ENOSYS;
 198 }
 199 static inline int gpiod_direction_input(struct gpio_desc *desc)
 200 {
 201         /* GPIO can never have been requested */
 202         WARN_ON(1);
 203         return -ENOSYS;
 204 }
 205 static inline int gpiod_direction_output(struct gpio_desc *desc, int value)
 206 {
 207         /* GPIO can never have been requested */
 208         WARN_ON(1);
 209         return -ENOSYS;
 210 }
 211 static inline int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
 212 {
 213         /* GPIO can never have been requested */
 214         WARN_ON(1);
 215         return -ENOSYS;
 216 }
 217
 218
 219 static inline int gpiod_get_value(const struct gpio_desc *desc)
 220 {
 221         /* GPIO can never have been requested */
 222         WARN_ON(1);
 223         return 0;
 224 }
 225 static inline void gpiod_set_value(struct gpio_desc *desc, int value)
 226 {
 227         /* GPIO can never have been requested */
 228         WARN_ON(1);
 229 }
 230 static inline void gpiod_set_array(unsigned int array_size,
 231                                    struct gpio_desc **desc_array,
 232                                    int *value_array)
 233 {
 234         /* GPIO can never have been requested */
 235         WARN_ON(1);
 236 }
 237 static inline int gpiod_get_raw_value(const struct gpio_desc *desc)
 238 {
 239         /* GPIO can never have been requested */
 240         WARN_ON(1);
 241         return 0;
 242 }
 243 static inline void gpiod_set_raw_value(struct gpio_desc *desc, int value)
 244 {
 245         /* GPIO can never have been requested */
 246         WARN_ON(1);
 247 }
 248 static inline void gpiod_set_raw_array(unsigned int array_size,
 249                                        struct gpio_desc **desc_array,
 250                                        int *value_array)
 251 {
 252         /* GPIO can never have been requested */
 253         WARN_ON(1);
 254 }
 255
 256 static inline int gpiod_get_value_cansleep(const struct gpio_desc *desc)
 257 {
 258         /* GPIO can never have been requested */
 259         WARN_ON(1);
 260         return 0;
 261 }
 262 static inline void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
 263 {
 264         /* GPIO can never have been requested */
 265         WARN_ON(1);
 266 }
 267 static inline void gpiod_set_array_cansleep(unsigned int array_size,
 268                                             struct gpio_desc **desc_array,
 269                                             int *value_array)
 270 {
 271         /* GPIO can never have been requested */
 272         WARN_ON(1);
 273 }
 274 static inline int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
 275 {
 276         /* GPIO can never have been requested */
 277         WARN_ON(1);
 278         return 0;
 279 }
 280 static inline void gpiod_set_raw_value_cansleep(struct gpio_desc *desc,
 281                                                 int value)
 282 {
 283         /* GPIO can never have been requested */
 284         WARN_ON(1);
 285 }
 286 static inline void gpiod_set_raw_array_cansleep(unsigned int array_size,
 287                                                 struct gpio_desc **desc_array,
 288                                                 int *value_array)
 289 {
 290         /* GPIO can never have been requested */
 291         WARN_ON(1);
 292 }
 293
 294 static inline int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
 295 {
 296         /* GPIO can never have been requested */
 297         WARN_ON(1);
 298         return -ENOSYS;
 299 }
 300
 301 static inline int gpiod_is_active_low(const struct gpio_desc *desc)
 302 {
 303         /* GPIO can never have been requested */
 304         WARN_ON(1);
 305         return 0;
 306 }
 307 static inline int gpiod_cansleep(const struct gpio_desc *desc)
 308 {
 309         /* GPIO can never have been requested */
 310         WARN_ON(1);
 311         return 0;
 312 }
 313
 314 static inline int gpiod_to_irq(const struct gpio_desc *desc)
 315 {
 316         /* GPIO can never have been requested */
 317         WARN_ON(1);
 318         return -EINVAL;
 319 }
 320
 321 static inline struct gpio_desc *gpio_to_desc(unsigned gpio)
 322 {
 323         return ERR_PTR(-EINVAL);
 324 }
 325 static inline int desc_to_gpio(const struct gpio_desc *desc)
 326 {
 327         /* GPIO can never have been requested */
 328         WARN_ON(1);
 329         return -EINVAL;
 330 }
 331
 332 #endif /* CONFIG_GPIOLIB */
 333
 334 /*
 335  * Vararg-hacks! This is done to transition the kernel to always pass
 336  * the options flags argument to the below functions. During a transition
 337  * phase these vararg macros make both old-and-newstyle code compile,
 338  * but when all calls to the elder API are removed, these should go away
 339  * and the __gpiod_get() etc functions above be renamed just gpiod_get()
 340  * etc.
 341  */
 342 #define __gpiod_get(dev, con_id, flags, ...) __gpiod_get(dev, con_id, flags)
 343 #define gpiod_get(varargs...) __gpiod_get(varargs, GPIOD_ASIS)
 344 #define __gpiod_get_index(dev, con_id, index, flags, ...)               \
 345         __gpiod_get_index(dev, con_id, index, flags)
 346 #define gpiod_get_index(varargs...) __gpiod_get_index(varargs, GPIOD_ASIS)
 347 #define __gpiod_get_optional(dev, con_id, flags, ...)                   \
 348         __gpiod_get_optional(dev, con_id, flags)
 349 #define gpiod_get_optional(varargs...) __gpiod_get_optional(varargs, GPIOD_ASIS)
 350 #define __gpiod_get_index_optional(dev, con_id, index, flags, ...)      \
 351         __gpiod_get_index_optional(dev, con_id, index, flags)
 352 #define gpiod_get_index_optional(varargs...)                            \
 353         __gpiod_get_index_optional(varargs, GPIOD_ASIS)
 354 #define __devm_gpiod_get(dev, con_id, flags, ...)                       \
 355         __devm_gpiod_get(dev, con_id, flags)
 356 #define devm_gpiod_get(varargs...) __devm_gpiod_get(varargs, GPIOD_ASIS)
 357 #define __devm_gpiod_get_index(dev, con_id, index, flags, ...)          \
 358         __devm_gpiod_get_index(dev, con_id, index, flags)
 359 #define devm_gpiod_get_index(varargs...)                                \
 360         __devm_gpiod_get_index(varargs, GPIOD_ASIS)
 361 #define __devm_gpiod_get_optional(dev, con_id, flags, ...)              \
 362         __devm_gpiod_get_optional(dev, con_id, flags)
 363 #define devm_gpiod_get_optional(varargs...)                             \
 364         __devm_gpiod_get_optional(varargs, GPIOD_ASIS)
 365 #define __devm_gpiod_get_index_optional(dev, con_id, index, flags, ...) \
 366         __devm_gpiod_get_index_optional(dev, con_id, index, flags)
 367 #define devm_gpiod_get_index_optional(varargs...)                       \
 368         __devm_gpiod_get_index_optional(varargs, GPIOD_ASIS)
 369
 370 #if IS_ENABLED(CONFIG_GPIOLIB) && IS_ENABLED(CONFIG_GPIO_SYSFS)
 371
 372 int gpiod_export(struct gpio_desc *desc, bool direction_may_change);
 373 int gpiod_export_link(struct device *dev, const char *name,
 374                       struct gpio_desc *desc);
 375 int gpiod_sysfs_set_active_low(struct gpio_desc *desc, int value);
 376 void gpiod_unexport(struct gpio_desc *desc);
 377
 378 #else  /* CONFIG_GPIOLIB && CONFIG_GPIO_SYSFS */
 379
 380 static inline int gpiod_export(struct gpio_desc *desc,
 381                                bool direction_may_change)
 382 {
 383         return -ENOSYS;
 384 }
 385
 386 static inline int gpiod_export_link(struct device *dev, const char *name,
 387                                     struct gpio_desc *desc)
 388 {
 389         return -ENOSYS;
 390 }
 391
 392 static inline int gpiod_sysfs_set_active_low(struct gpio_desc *desc, int value)
 393 {
 394         return -ENOSYS;
 395 }
 396
 397 static inline void gpiod_unexport(struct gpio_desc *desc)
 398 {
 399 }
 400
 401 #endif /* CONFIG_GPIOLIB && CONFIG_GPIO_SYSFS */
 402
 403 #endif