drivers/gpio/gpiolib.h

   1 /*
   2  * Internal GPIO functions.
   3  *
   4  * Copyright (C) 2013, Intel Corporation
   5  * Author: Mika Westerberg <mika.westerberg@linux.intel.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11
  12 #ifndef GPIOLIB_H
  13 #define GPIOLIB_H
  14
  15 #include <linux/err.h>
  16 #include <linux/device.h>
  17
  18 enum of_gpio_flags;
  19
  20 /**
  21  * struct acpi_gpio_info - ACPI GPIO specific information
  22  * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
  23  * @active_low: in case of @gpioint, the pin is active low
  24  */
  25 struct acpi_gpio_info {
  26         bool gpioint;
  27         bool active_low;
  28 };
  29
  30 /* gpio suffixes used for ACPI and device tree lookup */
  31 static const char * const gpio_suffixes[] = { "gpios", "gpio" };
  32
  33 #ifdef CONFIG_ACPI
  34 void acpi_gpiochip_add(struct gpio_chip *chip);
  35 void acpi_gpiochip_remove(struct gpio_chip *chip);
  36
  37 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip);
  38 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip);
  39
  40 struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
  41                                           const char *propname, int index,
  42                                           struct acpi_gpio_info *info);
  43
  44 int acpi_gpio_count(struct device *dev, const char *con_id);
  45 #else
  46 static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
  47 static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }
  48
  49 static inline void
  50 acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { }
  51
  52 static inline void
  53 acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { }
  54
  55 static inline struct gpio_desc *
  56 acpi_get_gpiod_by_index(struct acpi_device *adev, const char *propname,
  57                         int index, struct acpi_gpio_info *info)
  58 {
  59         return ERR_PTR(-ENOSYS);
  60 }
  61
  62 static inline int acpi_gpio_count(struct device *dev, const char *con_id)
  63 {
  64         return -ENODEV;
  65 }
  66 #endif
  67
  68 struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
  69                    const char *list_name, int index, enum of_gpio_flags *flags);
  70
  71 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum);
  72
  73 extern struct spinlock gpio_lock;
  74 extern struct list_head gpio_chips;
  75
  76 struct gpio_desc {
  77         struct gpio_chip        *chip;
  78         unsigned long           flags;
  79 /* flag symbols are bit numbers */
  80 #define FLAG_REQUESTED  0
  81 #define FLAG_IS_OUT     1
  82 #define FLAG_EXPORT     2       /* protected by sysfs_lock */
  83 #define FLAG_SYSFS      3       /* exported via /sys/class/gpio/control */
  84 #define FLAG_TRIG_FALL  4       /* trigger on falling edge */
  85 #define FLAG_TRIG_RISE  5       /* trigger on rising edge */
  86 #define FLAG_ACTIVE_LOW 6       /* value has active low */
  87 #define FLAG_OPEN_DRAIN 7       /* Gpio is open drain type */
  88 #define FLAG_OPEN_SOURCE 8      /* Gpio is open source type */
  89 #define FLAG_USED_AS_IRQ 9      /* GPIO is connected to an IRQ */
  90 #define FLAG_SYSFS_DIR  10      /* show sysfs direction attribute */
  91 #define FLAG_IS_HOGGED  11      /* GPIO is hogged */
  92
  93 #define ID_SHIFT        16      /* add new flags before this one */
  94
  95 #define GPIO_FLAGS_MASK         ((1 << ID_SHIFT) - 1)
  96 #define GPIO_TRIGGER_MASK       (BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE))
  97
  98         const char              *label;
  99 };
 100
 101 int gpiod_request(struct gpio_desc *desc, const char *label);
 102 void gpiod_free(struct gpio_desc *desc);
 103 int gpiod_hog(struct gpio_desc *desc, const char *name,
 104                 unsigned long lflags, enum gpiod_flags dflags);
 105
 106 /*
 107  * Return the GPIO number of the passed descriptor relative to its chip
 108  */
 109 static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc)
 110 {
 111         return desc - &desc->chip->desc[0];
 112 }
 113
 114 /* With descriptor prefix */
 115
 116 #define gpiod_emerg(desc, fmt, ...)                                            \
 117         pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
 118                  ##__VA_ARGS__)
 119 #define gpiod_crit(desc, fmt, ...)                                             \
 120         pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 121                  ##__VA_ARGS__)
 122 #define gpiod_err(desc, fmt, ...)                                              \
 123         pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",  \
 124                  ##__VA_ARGS__)
 125 #define gpiod_warn(desc, fmt, ...)                                             \
 126         pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 127                  ##__VA_ARGS__)
 128 #define gpiod_info(desc, fmt, ...)                                             \
 129         pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 130                  ##__VA_ARGS__)
 131 #define gpiod_dbg(desc, fmt, ...)                                              \
 132         pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
 133                  ##__VA_ARGS__)
 134
 135 /* With chip prefix */
 136
 137 #define chip_emerg(chip, fmt, ...)                                      \
 138         pr_emerg("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 139 #define chip_crit(chip, fmt, ...)                                       \
 140         pr_crit("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 141 #define chip_err(chip, fmt, ...)                                        \
 142         pr_err("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 143 #define chip_warn(chip, fmt, ...)                                       \
 144         pr_warn("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 145 #define chip_info(chip, fmt, ...)                                       \
 146         pr_info("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 147 #define chip_dbg(chip, fmt, ...)                                        \
 148         pr_debug("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 149
 150 #ifdef CONFIG_GPIO_SYSFS
 151
 152 int gpiochip_export(struct gpio_chip *chip);
 153 void gpiochip_unexport(struct gpio_chip *chip);
 154
 155 #else
 156
 157 static inline int gpiochip_export(struct gpio_chip *chip)
 158 {
 159         return 0;
 160 }
 161
 162 static inline void gpiochip_unexport(struct gpio_chip *chip)
 163 {
 164 }
 165
 166 #endif /* CONFIG_GPIO_SYSFS */
 167
 168 #endif /* GPIOLIB_H */