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 enum gpiod_flags;
  20 struct acpi_device;
  21
  22 /**
  23  * struct acpi_gpio_info - ACPI GPIO specific information
  24  * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
  25  * @active_low: in case of @gpioint, the pin is active low
  26  */
  27 struct acpi_gpio_info {
  28         bool gpioint;
  29         bool active_low;
  30 };
  31
  32 /* gpio suffixes used for ACPI and device tree lookup */
  33 static const char * const gpio_suffixes[] = { "gpios", "gpio" };
  34
  35 #ifdef CONFIG_ACPI
  36 void acpi_gpiochip_add(struct gpio_chip *chip);
  37 void acpi_gpiochip_remove(struct gpio_chip *chip);
  38
  39 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip);
  40 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip);
  41
  42 struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
  43                                           const char *propname, int index,
  44                                           struct acpi_gpio_info *info);
  45 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
  46                                       const char *propname, int index,
  47                                       struct acpi_gpio_info *info);
  48
  49 int acpi_gpio_count(struct device *dev, const char *con_id);
  50
  51 bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id);
  52 #else
  53 static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
  54 static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }
  55
  56 static inline void
  57 acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { }
  58
  59 static inline void
  60 acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { }
  61
  62 static inline struct gpio_desc *
  63 acpi_get_gpiod_by_index(struct acpi_device *adev, const char *propname,
  64                         int index, struct acpi_gpio_info *info)
  65 {
  66         return ERR_PTR(-ENOSYS);
  67 }
  68 static inline struct gpio_desc *
  69 acpi_node_get_gpiod(struct fwnode_handle *fwnode, const char *propname,
  70                     int index, struct acpi_gpio_info *info)
  71 {
  72         return ERR_PTR(-ENXIO);
  73 }
  74 static inline int acpi_gpio_count(struct device *dev, const char *con_id)
  75 {
  76         return -ENODEV;
  77 }
  78
  79 static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev,
  80                                             const char *con_id)
  81 {
  82         return false;
  83 }
  84 #endif
  85
  86 struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
  87                    const char *list_name, int index, enum of_gpio_flags *flags);
  88
  89 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum);
  90
  91 extern struct spinlock gpio_lock;
  92 extern struct list_head gpio_chips;
  93
  94 struct gpio_desc {
  95         struct gpio_chip        *chip;
  96         unsigned long           flags;
  97 /* flag symbols are bit numbers */
  98 #define FLAG_REQUESTED  0
  99 #define FLAG_IS_OUT     1
 100 #define FLAG_EXPORT     2       /* protected by sysfs_lock */
 101 #define FLAG_SYSFS      3       /* exported via /sys/class/gpio/control */
 102 #define FLAG_ACTIVE_LOW 6       /* value has active low */
 103 #define FLAG_OPEN_DRAIN 7       /* Gpio is open drain type */
 104 #define FLAG_OPEN_SOURCE 8      /* Gpio is open source type */
 105 #define FLAG_USED_AS_IRQ 9      /* GPIO is connected to an IRQ */
 106 #define FLAG_IS_HOGGED  11      /* GPIO is hogged */
 107
 108         /* Connection label */
 109         const char              *label;
 110         /* Name of the GPIO */
 111         const char              *name;
 112 };
 113
 114 int gpiod_request(struct gpio_desc *desc, const char *label);
 115 void gpiod_free(struct gpio_desc *desc);
 116 int gpiod_hog(struct gpio_desc *desc, const char *name,
 117                 unsigned long lflags, enum gpiod_flags dflags);
 118
 119 /*
 120  * Return the GPIO number of the passed descriptor relative to its chip
 121  */
 122 static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc)
 123 {
 124         return desc - &desc->chip->desc[0];
 125 }
 126
 127 /* With descriptor prefix */
 128
 129 #define gpiod_emerg(desc, fmt, ...)                                            \
 130         pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
 131                  ##__VA_ARGS__)
 132 #define gpiod_crit(desc, fmt, ...)                                             \
 133         pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 134                  ##__VA_ARGS__)
 135 #define gpiod_err(desc, fmt, ...)                                              \
 136         pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",  \
 137                  ##__VA_ARGS__)
 138 #define gpiod_warn(desc, fmt, ...)                                             \
 139         pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 140                  ##__VA_ARGS__)
 141 #define gpiod_info(desc, fmt, ...)                                             \
 142         pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 143                  ##__VA_ARGS__)
 144 #define gpiod_dbg(desc, fmt, ...)                                              \
 145         pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
 146                  ##__VA_ARGS__)
 147
 148 /* With chip prefix */
 149
 150 #define chip_emerg(chip, fmt, ...)                                      \
 151         pr_emerg("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 152 #define chip_crit(chip, fmt, ...)                                       \
 153         pr_crit("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 154 #define chip_err(chip, fmt, ...)                                        \
 155         pr_err("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 156 #define chip_warn(chip, fmt, ...)                                       \
 157         pr_warn("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 158 #define chip_info(chip, fmt, ...)                                       \
 159         pr_info("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 160 #define chip_dbg(chip, fmt, ...)                                        \
 161         pr_debug("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
 162
 163 #ifdef CONFIG_GPIO_SYSFS
 164
 165 int gpiochip_sysfs_register(struct gpio_chip *chip);
 166 void gpiochip_sysfs_unregister(struct gpio_chip *chip);
 167
 168 #else
 169
 170 static inline int gpiochip_sysfs_register(struct gpio_chip *chip)
 171 {
 172         return 0;
 173 }
 174
 175 static inline void gpiochip_sysfs_unregister(struct gpio_chip *chip)
 176 {
 177 }
 178
 179 #endif /* CONFIG_GPIO_SYSFS */
 180
 181 #endif /* GPIOLIB_H */