LXR linux/drivers/gpio/gpiolib.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2/*
   3 * Internal GPIO functions.
   4 *
   5 * Copyright (C) 2013, Intel Corporation
   6 * Author: Mika Westerberg <mika.westerberg@linux.intel.com>
   7 */
   8
   9#ifndef GPIOLIB_H
  10#define GPIOLIB_H
  11
  12#include <linux/gpio/driver.h>
  13#include <linux/gpio/consumer.h> /* for enum gpiod_flags */
  14#include <linux/err.h>
  15#include <linux/device.h>
  16#include <linux/module.h>
  17#include <linux/cdev.h>
  18
  19#define GPIOCHIP_NAME   "gpiochip"
  20
  21/**
  22 * struct gpio_device - internal state container for GPIO devices
  23 * @id: numerical ID number for the GPIO chip
  24 * @dev: the GPIO device struct
  25 * @chrdev: character device for the GPIO device
  26 * @mockdev: class device used by the deprecated sysfs interface (may be
  27 * NULL)
  28 * @owner: helps prevent removal of modules exporting active GPIOs
  29 * @chip: pointer to the corresponding gpiochip, holding static
  30 * data for this device
  31 * @descs: array of ngpio descriptors.
  32 * @ngpio: the number of GPIO lines on this GPIO device, equal to the size
  33 * of the @descs array.
  34 * @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned
  35 * at device creation time.
  36 * @label: a descriptive name for the GPIO device, such as the part number
  37 * or name of the IP component in a System on Chip.
  38 * @data: per-instance data assigned by the driver
  39 * @list: links gpio_device:s together for traversal
  40 *
  41 * This state container holds most of the runtime variable data
  42 * for a GPIO device and can hold references and live on after the
  43 * GPIO chip has been removed, if it is still being used from
  44 * userspace.
  45 */
  46struct gpio_device {
  47        int                     id;
  48        struct device           dev;
  49        struct cdev             chrdev;
  50        struct device           *mockdev;
  51        struct module           *owner;
  52        struct gpio_chip        *chip;
  53        struct gpio_desc        *descs;
  54        int                     base;
  55        u16                     ngpio;
  56        const char              *label;
  57        void                    *data;
  58        struct list_head        list;
  59
  60#ifdef CONFIG_PINCTRL
  61        /*
  62         * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally
  63         * describe the actual pin range which they serve in an SoC. This
  64         * information would be used by pinctrl subsystem to configure
  65         * corresponding pins for gpio usage.
  66         */
  67        struct list_head pin_ranges;
  68#endif
  69};
  70
  71/* gpio suffixes used for ACPI and device tree lookup */
  72static __maybe_unused const char * const gpio_suffixes[] = { "gpios", "gpio" };
  73
  74struct gpio_array {
  75        struct gpio_desc        **desc;
  76        unsigned int            size;
  77        struct gpio_chip        *chip;
  78        unsigned long           *get_mask;
  79        unsigned long           *set_mask;
  80        unsigned long           invert_mask[];
  81};
  82
  83struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc, unsigned int hwnum);
  84int gpiod_get_array_value_complex(bool raw, bool can_sleep,
  85                                  unsigned int array_size,
  86                                  struct gpio_desc **desc_array,
  87                                  struct gpio_array *array_info,
  88                                  unsigned long *value_bitmap);
  89int gpiod_set_array_value_complex(bool raw, bool can_sleep,
  90                                  unsigned int array_size,
  91                                  struct gpio_desc **desc_array,
  92                                  struct gpio_array *array_info,
  93                                  unsigned long *value_bitmap);
  94
  95extern spinlock_t gpio_lock;
  96extern struct list_head gpio_devices;
  97
  98struct gpio_desc {
  99        struct gpio_device      *gdev;
 100        unsigned long           flags;
 101/* flag symbols are bit numbers */
 102#define FLAG_REQUESTED  0
 103#define FLAG_IS_OUT     1
 104#define FLAG_EXPORT     2       /* protected by sysfs_lock */
 105#define FLAG_SYSFS      3       /* exported via /sys/class/gpio/control */
 106#define FLAG_ACTIVE_LOW 6       /* value has active low */
 107#define FLAG_OPEN_DRAIN 7       /* Gpio is open drain type */
 108#define FLAG_OPEN_SOURCE 8      /* Gpio is open source type */
 109#define FLAG_USED_AS_IRQ 9      /* GPIO is connected to an IRQ */
 110#define FLAG_IRQ_IS_ENABLED 10  /* GPIO is connected to an enabled IRQ */
 111#define FLAG_IS_HOGGED  11      /* GPIO is hogged */
 112#define FLAG_TRANSITORY 12      /* GPIO may lose value in sleep or reset */
 113#define FLAG_PULL_UP    13      /* GPIO has pull up enabled */
 114#define FLAG_PULL_DOWN  14      /* GPIO has pull down enabled */
 115#define FLAG_BIAS_DISABLE    15 /* GPIO has pull disabled */
 116
 117        /* Connection label */
 118        const char              *label;
 119        /* Name of the GPIO */
 120        const char              *name;
 121};
 122
 123#define gpiod_not_found(desc)           (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT)
 124
 125int gpiod_request(struct gpio_desc *desc, const char *label);
 126void gpiod_free(struct gpio_desc *desc);
 127int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
 128                unsigned long lflags, enum gpiod_flags dflags);
 129int gpiod_hog(struct gpio_desc *desc, const char *name,
 130                unsigned long lflags, enum gpiod_flags dflags);
 131
 132/*
 133 * Return the GPIO number of the passed descriptor relative to its chip
 134 */
 135static inline int gpio_chip_hwgpio(const struct gpio_desc *desc)
 136{
 137        return desc - &desc->gdev->descs[0];
 138}
 139
 140/* With descriptor prefix */
 141
 142#define gpiod_emerg(desc, fmt, ...)                                            \
 143        pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
 144                 ##__VA_ARGS__)
 145#define gpiod_crit(desc, fmt, ...)                                             \
 146        pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 147                 ##__VA_ARGS__)
 148#define gpiod_err(desc, fmt, ...)                                              \
 149        pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",  \
 150                 ##__VA_ARGS__)
 151#define gpiod_warn(desc, fmt, ...)                                             \
 152        pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 153                 ##__VA_ARGS__)
 154#define gpiod_info(desc, fmt, ...)                                             \
 155        pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
 156                 ##__VA_ARGS__)
 157#define gpiod_dbg(desc, fmt, ...)                                              \
 158        pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
 159                 ##__VA_ARGS__)
 160
 161/* With chip prefix */
 162
 163#define chip_emerg(gc, fmt, ...)                                        \
 164        dev_emerg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
 165#define chip_crit(gc, fmt, ...)                                 \
 166        dev_crit(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
 167#define chip_err(gc, fmt, ...)                                  \
 168        dev_err(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
 169#define chip_warn(gc, fmt, ...)                                 \
 170        dev_warn(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
 171#define chip_info(gc, fmt, ...)                                 \
 172        dev_info(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
 173#define chip_dbg(gc, fmt, ...)                                  \
 174        dev_dbg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
 175
 176#ifdef CONFIG_GPIO_SYSFS
 177
 178int gpiochip_sysfs_register(struct gpio_device *gdev);
 179void gpiochip_sysfs_unregister(struct gpio_device *gdev);
 180
 181#else
 182
 183static inline int gpiochip_sysfs_register(struct gpio_device *gdev)
 184{
 185        return 0;
 186}
 187
 188static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev)
 189{
 190}
 191
 192#endif /* CONFIG_GPIO_SYSFS */
 193
 194#endif /* GPIOLIB_H */
 195