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