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/gpio/driver.h>
  16 #include <linux/err.h>
  17 #include <linux/device.h>
  18 #include <linux/module.h>
  19 #include <linux/cdev.h>
  20
  21 enum of_gpio_flags;
  22 enum gpiod_flags;
  23 struct acpi_device;
  24
  25 /**
  26  * struct gpio_device - internal state container for GPIO devices
  27  * @id: numerical ID number for the GPIO chip
  28  * @dev: the GPIO device struct
  29  * @chrdev: character device for the GPIO device
  30  * @mockdev: class device used by the deprecated sysfs interface (may be
  31  * NULL)
  32  * @owner: helps prevent removal of modules exporting active GPIOs
  33  * @chip: pointer to the corresponding gpiochip, holding static
  34  * data for this device
  35  * @descs: array of ngpio descriptors.
  36  * @ngpio: the number of GPIO lines on this GPIO device, equal to the size
  37  * of the @descs array.
  38  * @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned
  39  * at device creation time.
  40  * @list: links gpio_device:s together for traversal
  41  *
  42  * This state container holds most of the runtime variable data
  43  * for a GPIO device and can hold references and live on after the
  44  * GPIO chip has been removed, if it is still being used from
  45  * userspace.
  46  */
  47 struct gpio_device {
  48         int                     id;
  49         struct device           dev;
  50         struct cdev             chrdev;
  51         struct device           *mockdev;
  52         struct module           *owner;
  53         struct gpio_chip        *chip;
  54         struct gpio_desc        *descs;
  55         int                     base;
  56         u16                     ngpio;
  57         struct list_head        list;
  58
  59 #ifdef CONFIG_PINCTRL
  60         /*
  61          * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally
  62          * describe the actual pin range which they serve in an SoC. This
  63          * information would be used by pinctrl subsystem to configure
  64          * corresponding pins for gpio usage.
  65          */
  66         struct list_head pin_ranges;
  67 #endif
  68 };
  69
  70 /**
  71  * struct acpi_gpio_info - ACPI GPIO specific information
  72  * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
  73  * @active_low: in case of @gpioint, the pin is active low
  74  */
  75 struct acpi_gpio_info {
  76         bool gpioint;
  77         int polarity;
  78         int triggering;
  79 };
  80
  81 /* gpio suffixes used for ACPI and device tree lookup */
  82 static const char * const gpio_suffixes[] = { "gpios", "gpio" };
  83
  84 #ifdef CONFIG_ACPI
  85 void acpi_gpiochip_add(struct gpio_chip *chip);
  86 void acpi_gpiochip_remove(struct gpio_chip *chip);
  87
  88 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip);
  89 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip);
  90
  91 struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
  92                                           const char *propname, int index,
  93                                           struct acpi_gpio_info *info);
  94 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
  95                                       const char *propname, int index,
  96                                       struct acpi_gpio_info *info);
  97
  98 int acpi_gpio_count(struct device *dev, const char *con_id);
  99
 100 bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id);
 101 #else
 102 static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
 103 static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }
 104
 105 static inline void
 106 acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { }
 107
 108 static inline void
 109 acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { }
 110
 111 static inline struct gpio_desc *
 112 acpi_get_gpiod_by_index(struct acpi_device *adev, const char *propname,
 113                         int index, struct acpi_gpio_info *info)
 114 {
 115         return ERR_PTR(-ENOSYS);
 116 }
 117 static inline struct gpio_desc *
 118 acpi_node_get_gpiod(struct fwnode_handle *fwnode, const char *propname,
 119                     int index, struct acpi_gpio_info *info)
 120 {
 121         return ERR_PTR(-ENXIO);
 122 }
 123 static inline int acpi_gpio_count(struct device *dev, const char *con_id)
 124 {
 125         return -ENODEV;
 126 }
 127
 128 static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev,
 129                                             const char *con_id)
 130 {
 131         return false;
 132 }
 133 #endif
 134
 135 struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
 136                    const char *list_name, int index, enum of_gpio_flags *flags);
 137
 138 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum);
 139
 140 extern struct spinlock gpio_lock;
 141 extern struct list_head gpio_devices;
 142
 143 struct gpio_desc {
 144         struct gpio_device      *gdev;
 145         unsigned long           flags;
 146 /* flag symbols are bit numbers */
 147 #define FLAG_REQUESTED  0
 148 #define FLAG_IS_OUT     1
 149 #define FLAG_EXPORT     2       /* protected by sysfs_lock */
 150 #define FLAG_SYSFS      3       /* exported via /sys/class/gpio/control */
 151 #define FLAG_ACTIVE_LOW 6       /* value has active low */
 152 #define FLAG_OPEN_DRAIN 7       /* Gpio is open drain type */
 153 #define FLAG_OPEN_SOURCE 8      /* Gpio is open source type */
 154 #define FLAG_USED_AS_IRQ 9      /* GPIO is connected to an IRQ */
 155 #define FLAG_IS_HOGGED  11      /* GPIO is hogged */
 156
 157         /* Connection label */
 158         const char              *label;
 159         /* Name of the GPIO */
 160         const char              *name;
 161 };
 162
 163 int gpiod_request(struct gpio_desc *desc, const char *label);
 164 void gpiod_free(struct gpio_desc *desc);
 165 int gpiod_hog(struct gpio_desc *desc, const char *name,
 166                 unsigned long lflags, enum gpiod_flags dflags);
 167
 168 /*
 169  * Return the GPIO number of the passed descriptor relative to its chip
 170  */
 171 static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc)
 172 {
 173         return desc - &desc->gdev->descs[0];
 174 }
 175
 176 /* With descriptor prefix */
 177
 178 #define gpiod_emerg(desc, fmt, ...)                                            \
 179         pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
 180                  ##__VA_ARGS__)
 181 #define gpiod_crit(desc, fmt, ...)                                             \
 182         pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 183                  ##__VA_ARGS__)
 184 #define gpiod_err(desc, fmt, ...)                                              \
 185         pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",  \
 186                  ##__VA_ARGS__)
 187 #define gpiod_warn(desc, fmt, ...)                                             \
 188         pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 189                  ##__VA_ARGS__)
 190 #define gpiod_info(desc, fmt, ...)                                             \
 191         pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 192                  ##__VA_ARGS__)
 193 #define gpiod_dbg(desc, fmt, ...)                                              \
 194         pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
 195                  ##__VA_ARGS__)
 196
 197 /* With chip prefix */
 198
 199 #define chip_emerg(chip, fmt, ...)                                      \
 200         dev_emerg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
 201 #define chip_crit(chip, fmt, ...)                                       \
 202         dev_crit(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
 203 #define chip_err(chip, fmt, ...)                                        \
 204         dev_err(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
 205 #define chip_warn(chip, fmt, ...)                                       \
 206         dev_warn(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
 207 #define chip_info(chip, fmt, ...)                                       \
 208         dev_info(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
 209 #define chip_dbg(chip, fmt, ...)                                        \
 210         dev_dbg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
 211
 212 #ifdef CONFIG_GPIO_SYSFS
 213
 214 int gpiochip_sysfs_register(struct gpio_device *gdev);
 215 void gpiochip_sysfs_unregister(struct gpio_device *gdev);
 216
 217 #else
 218
 219 static inline int gpiochip_sysfs_register(struct gpio_device *gdev)
 220 {
 221         return 0;
 222 }
 223
 224 static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev)
 225 {
 226 }
 227
 228 #endif /* CONFIG_GPIO_SYSFS */
 229
 230 #endif /* GPIOLIB_H */