Quelle  gpiolib.c   Sprache: C

// SPDX-License-Identifier: GPL-2.0

#include <linux/acpi.h>
#include <linux/array_size.h>
#include <linux/bitmap.h>
#include <linux/cleanup.h>
#include <linux/compat.h>
#include <linux/debugfs.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/errno.h>
#include <linux/file.h>
#include <linux/fs.h>
#include <linux/idr.h>
#include <linux/interrupt.h>
#include <linux/irq.h>
#include <linux/irqdesc.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/lockdep.h>
#include <linux/module.h>
#include <linux/nospec.h>
#include <linux/of.h>
#include <linux/pinctrl/consumer.h>
#include <linux/seq_file.h>
#include <linux/slab.h>
#include <linux/srcu.h>
#include <linux/string.h>
#include <linux/string_choices.h>

#include <linux/gpio.h>
#include <linux/gpio/driver.h>
#include <linux/gpio/machine.h>

#include <uapi/linux/gpio.h>

#include "gpiolib-acpi.h"
#include "gpiolib-cdev.h"
#include "gpiolib-of.h"
#include "gpiolib-swnode.h"
#include "gpiolib-sysfs.h"
#include "gpiolib.h"

#define CREATE_TRACE_POINTS
#include <trace/events/gpio.h>

/* Implementation infrastructure for GPIO interfaces.
 *
 * The GPIO programming interface allows for inlining speed-critical
 * get/set operations for common cases, so that access to SOC-integrated
 * GPIOs can sometimes cost only an instruction or two per bit.
 */

/* Device and char device-related information */
static DEFINE_IDA(gpio_ida);
static dev_t gpio_devt;
#define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */

static int gpio_bus_match(struct device *dev, const struct device_driver *drv)
{
 struct fwnode_handle *fwnode = dev_fwnode(dev);

 /*
 * Only match if the fwnode doesn't already have a proper struct device
 * created for it.
 */
 if (fwnode && fwnode->dev != dev)
  return 0;
 return 1;
}

static const struct bus_type gpio_bus_type = {
 .name = "gpio",
 .match = gpio_bus_match,
};

/*
 * At the end we want all GPIOs to be dynamically allocated from 0.
 * However, some legacy drivers still perform fixed allocation.
 * Until they are all fixed, leave 0-512 space for them.
 */
#define GPIO_DYNAMIC_BASE 512
/*
 * Define the maximum of the possible GPIO in the global numberspace.
 * While the GPIO base and numbers are positive, we limit it with signed
 * maximum as a lot of code is using negative values for special cases.
 */
#define GPIO_DYNAMIC_MAX INT_MAX

/*
 * Number of GPIOs to use for the fast path in set array
 */
#define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT

static DEFINE_MUTEX(gpio_lookup_lock);
static LIST_HEAD(gpio_lookup_list);

static LIST_HEAD(gpio_devices);
/* Protects the GPIO device list against concurrent modifications. */
static DEFINE_MUTEX(gpio_devices_lock);
/* Ensures coherence during read-only accesses to the list of GPIO devices. */
DEFINE_STATIC_SRCU(gpio_devices_srcu);

static DEFINE_MUTEX(gpio_machine_hogs_mutex);
static LIST_HEAD(gpio_machine_hogs);

const char *const gpio_suffixes[] = { "gpios", "gpio", NULL };

static void gpiochip_free_hogs(struct gpio_chip *gc);
static int gpiochip_add_irqchip(struct gpio_chip *gc,
    struct lock_class_key *lock_key,
    struct lock_class_key *request_key);
static void gpiochip_irqchip_remove(struct gpio_chip *gc);
static int gpiochip_irqchip_init_hw(struct gpio_chip *gc);
static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc);
static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc);

static bool gpiolib_initialized;

const char *gpiod_get_label(struct gpio_desc *desc)
{
 struct gpio_desc_label *label;
 unsigned long flags;

 flags = READ_ONCE(desc->flags);

 label = srcu_dereference_check(desc->label, &desc->gdev->desc_srcu,
    srcu_read_lock_held(&desc->gdev->desc_srcu));

 if (test_bit(FLAG_USED_AS_IRQ, &flags))
  return label ? label->str : "interrupt";

 if (!test_bit(FLAG_REQUESTED, &flags))
  return NULL;

 return label ? label->str : NULL;
}

static void desc_free_label(struct rcu_head *rh)
{
 kfree(container_of(rh, struct gpio_desc_label, rh));
}

static int desc_set_label(struct gpio_desc *desc, const char *label)
{
 struct gpio_desc_label *new = NULL, *old;

 if (label) {
  new = kzalloc(struct_size(new, str, strlen(label) + 1),
         GFP_KERNEL);
  if (!new)
   return -ENOMEM;

  strcpy(new->str, label);
 }

 old = rcu_replace_pointer(desc->label, new, 1);
 if (old)
  call_srcu(&desc->gdev->desc_srcu, &old->rh, desc_free_label);

 return 0;
}

/**
 * gpio_to_desc - Convert a GPIO number to its descriptor
 * @gpio: global GPIO number
 *
 * Returns:
 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
 * with the given number exists in the system.
 */
struct gpio_desc *gpio_to_desc(unsigned gpio)
{
 struct gpio_device *gdev;

 scoped_guard(srcu, &gpio_devices_srcu) {
  list_for_each_entry_srcu(gdev, &gpio_devices, list,
    srcu_read_lock_held(&gpio_devices_srcu)) {
   if (gdev->base <= gpio &&
       gdev->base + gdev->ngpio > gpio)
    return &gdev->descs[gpio - gdev->base];
  }
 }

 return NULL;
}
EXPORT_SYMBOL_GPL(gpio_to_desc);

/* This function is deprecated and will be removed soon, don't use. */
struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc,
        unsigned int hwnum)
{
 return gpio_device_get_desc(gc->gpiodev, hwnum);
}

/**
 * gpio_device_get_desc() - get the GPIO descriptor corresponding to the given
 *                          hardware number for this GPIO device
 * @gdev: GPIO device to get the descriptor from
 * @hwnum: hardware number of the GPIO for this chip
 *
 * Returns:
 * A pointer to the GPIO descriptor or %EINVAL if no GPIO exists in the given
 * chip for the specified hardware number or %ENODEV if the underlying chip
 * already vanished.
 *
 * The reference count of struct gpio_device is *NOT* increased like when the
 * GPIO is being requested for exclusive usage. It's up to the caller to make
 * sure the GPIO device will stay alive together with the descriptor returned
 * by this function.
 */
struct gpio_desc *
gpio_device_get_desc(struct gpio_device *gdev, unsigned int hwnum)
{
 if (hwnum >= gdev->ngpio)
  return ERR_PTR(-EINVAL);

 return &gdev->descs[array_index_nospec(hwnum, gdev->ngpio)];
}
EXPORT_SYMBOL_GPL(gpio_device_get_desc);

/**
 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
 * @desc: GPIO descriptor
 *
 * This should disappear in the future but is needed since we still
 * use GPIO numbers for error messages and sysfs nodes.
 *
 * Returns:
 * The global GPIO number for the GPIO specified by its descriptor.
 */
int desc_to_gpio(const struct gpio_desc *desc)
{
 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
}
EXPORT_SYMBOL_GPL(desc_to_gpio);


/**
 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
 * @desc: descriptor to return the chip of
 *
 * *DEPRECATED*
 * This function is unsafe and should not be used. Using the chip address
 * without taking the SRCU read lock may result in dereferencing a dangling
 * pointer.
 *
 * Returns:
 * Address of the GPIO chip backing this device.
 */
struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
{
 if (!desc)
  return NULL;

 return gpio_device_get_chip(desc->gdev);
}
EXPORT_SYMBOL_GPL(gpiod_to_chip);

/**
 * gpiod_to_gpio_device() - Return the GPIO device to which this descriptor
 *                          belongs.
 * @desc: Descriptor for which to return the GPIO device.
 *
 * This *DOES NOT* increase the reference count of the GPIO device as it's
 * expected that the descriptor is requested and the users already holds a
 * reference to the device.
 *
 * Returns:
 * Address of the GPIO device owning this descriptor.
 */
struct gpio_device *gpiod_to_gpio_device(struct gpio_desc *desc)
{
 if (!desc)
  return NULL;

 return desc->gdev;
}
EXPORT_SYMBOL_GPL(gpiod_to_gpio_device);

/**
 * gpio_device_get_base() - Get the base GPIO number allocated by this device
 * @gdev: GPIO device
 *
 * Returns:
 * First GPIO number in the global GPIO numberspace for this device.
 */
int gpio_device_get_base(struct gpio_device *gdev)
{
 return gdev->base;
}
EXPORT_SYMBOL_GPL(gpio_device_get_base);

/**
 * gpio_device_get_label() - Get the label of this GPIO device
 * @gdev: GPIO device
 *
 * Returns:
 * Pointer to the string containing the GPIO device label. The string's
 * lifetime is tied to that of the underlying GPIO device.
 */
const char *gpio_device_get_label(struct gpio_device *gdev)
{
 return gdev->label;
}
EXPORT_SYMBOL(gpio_device_get_label);

/**
 * gpio_device_get_chip() - Get the gpio_chip implementation of this GPIO device
 * @gdev: GPIO device
 *
 * Returns:
 * Address of the GPIO chip backing this device.
 *
 * *DEPRECATED*
 * Until we can get rid of all non-driver users of struct gpio_chip, we must
 * provide a way of retrieving the pointer to it from struct gpio_device. This
 * is *NOT* safe as the GPIO API is considered to be hot-unpluggable and the
 * chip can dissapear at any moment (unlike reference-counted struct
 * gpio_device).
 *
 * Use at your own risk.
 */
struct gpio_chip *gpio_device_get_chip(struct gpio_device *gdev)
{
 return rcu_dereference_check(gdev->chip, 1);
}
EXPORT_SYMBOL_GPL(gpio_device_get_chip);

/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base_unlocked(u16 ngpio)
{
 unsigned int base = GPIO_DYNAMIC_BASE;
 struct gpio_device *gdev;

 list_for_each_entry_srcu(gdev, &gpio_devices, list,
     lockdep_is_held(&gpio_devices_lock)) {
  /* found a free space? */
  if (gdev->base >= base + ngpio)
   break;
  /* nope, check the space right after the chip */
  base = gdev->base + gdev->ngpio;
  if (base < GPIO_DYNAMIC_BASE)
   base = GPIO_DYNAMIC_BASE;
  if (base > GPIO_DYNAMIC_MAX - ngpio)
   break;
 }

 if (base <= GPIO_DYNAMIC_MAX - ngpio) {
  pr_debug("%s: found new base at %d\n", __func__, base);
  return base;
 } else {
  pr_err("%s: cannot find free range\n", __func__);
  return -ENOSPC;
 }
}

/*
 * This descriptor validation needs to be inserted verbatim into each
 * function taking a descriptor, so we need to use a preprocessor
 * macro to avoid endless duplication. If the desc is NULL it is an
 * optional GPIO and calls should just bail out.
 */
static int validate_desc(const struct gpio_desc *desc, const char *func)
{
 if (!desc)
  return 0;

 if (IS_ERR(desc)) {
  pr_warn("%s: invalid GPIO (errorpointer: %pe)\n", func, desc);
  return PTR_ERR(desc);
 }

 return 1;
}

#define VALIDATE_DESC(desc) do { \
 int __valid = validate_desc(desc, __func__); \
 if (__valid <= 0) \
  return __valid; \
 } while (0)

#define VALIDATE_DESC_VOID(desc) do { \
 int __valid = validate_desc(desc, __func__); \
 if (__valid <= 0) \
  return; \
 } while (0)

/**
 * gpiod_is_equal() - Check if two GPIO descriptors refer to the same pin.
 * @desc: Descriptor to compare.
 * @other: The second descriptor to compare against.
 *
 * Returns:
 * True if the descriptors refer to the same physical pin. False otherwise.
 */
bool gpiod_is_equal(const struct gpio_desc *desc, const struct gpio_desc *other)
{
 return validate_desc(desc, __func__) > 0 &&
        !IS_ERR_OR_NULL(other) && desc == other;
}
EXPORT_SYMBOL_GPL(gpiod_is_equal);

static int gpiochip_get_direction(struct gpio_chip *gc, unsigned int offset)
{
 int ret;

 lockdep_assert_held(&gc->gpiodev->srcu);

 if (WARN_ON(!gc->get_direction))
  return -EOPNOTSUPP;

 ret = gc->get_direction(gc, offset);
 if (ret < 0)
  return ret;

 if (ret != GPIO_LINE_DIRECTION_OUT && ret != GPIO_LINE_DIRECTION_IN)
  ret = -EBADE;

 return ret;
}

/**
 * gpiod_get_direction - return the current direction of a GPIO
 * @desc: GPIO to get the direction of
 *
 * Returns:
 * 0 for output, 1 for input, or an error code in case of error.
 *
 * This function may sleep if gpiod_cansleep() is true.
 */
int gpiod_get_direction(struct gpio_desc *desc)
{
 unsigned long flags;
 unsigned int offset;
 int ret;

 ret = validate_desc(desc, __func__);
 if (ret <= 0)
  return -EINVAL;

 CLASS(gpio_chip_guard, guard)(desc);
 if (!guard.gc)
  return -ENODEV;

 offset = gpio_chip_hwgpio(desc);
 flags = READ_ONCE(desc->flags);

 /*
 * Open drain emulation using input mode may incorrectly report
 * input here, fix that up.
 */
 if (test_bit(FLAG_OPEN_DRAIN, &flags) &&
     test_bit(FLAG_IS_OUT, &flags))
  return 0;

 if (!guard.gc->get_direction)
  return -ENOTSUPP;

 ret = gpiochip_get_direction(guard.gc, offset);
 if (ret < 0)
  return ret;

 /*
 * GPIO_LINE_DIRECTION_IN or other positive,
 * otherwise GPIO_LINE_DIRECTION_OUT.
 */
 if (ret > 0)
  ret = 1;

 assign_bit(FLAG_IS_OUT, &flags, !ret);
 WRITE_ONCE(desc->flags, flags);

 return ret;
}
EXPORT_SYMBOL_GPL(gpiod_get_direction);

/*
 * Add a new chip to the global chips list, keeping the list of chips sorted
 * by range(means [base, base + ngpio - 1]) order.
 *
 * Returns:
 * -EBUSY if the new chip overlaps with some other chip's integer space.
 */
static int gpiodev_add_to_list_unlocked(struct gpio_device *gdev)
{
 struct gpio_device *prev, *next;

 lockdep_assert_held(&gpio_devices_lock);

 if (list_empty(&gpio_devices)) {
  /* initial entry in list */
  list_add_tail_rcu(&gdev->list, &gpio_devices);
  return 0;
 }

 next = list_first_entry(&gpio_devices, struct gpio_device, list);
 if (gdev->base + gdev->ngpio <= next->base) {
  /* add before first entry */
  list_add_rcu(&gdev->list, &gpio_devices);
  return 0;
 }

 prev = list_last_entry(&gpio_devices, struct gpio_device, list);
 if (prev->base + prev->ngpio <= gdev->base) {
  /* add behind last entry */
  list_add_tail_rcu(&gdev->list, &gpio_devices);
  return 0;
 }

 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
  /* at the end of the list */
  if (&next->list == &gpio_devices)
   break;

  /* add between prev and next */
  if (prev->base + prev->ngpio <= gdev->base
    && gdev->base + gdev->ngpio <= next->base) {
   list_add_rcu(&gdev->list, &prev->list);
   return 0;
  }
 }

 synchronize_srcu(&gpio_devices_srcu);

 return -EBUSY;
}

/*
 * Convert a GPIO name to its descriptor
 * Note that there is no guarantee that GPIO names are globally unique!
 * Hence this function will return, if it exists, a reference to the first GPIO
 * line found that matches the given name.
 */
static struct gpio_desc *gpio_name_to_desc(const char * const name)
{
 struct gpio_device *gdev;
 struct gpio_desc *desc;
 struct gpio_chip *gc;

 if (!name)
  return NULL;

 guard(srcu)(&gpio_devices_srcu);

 list_for_each_entry_srcu(gdev, &gpio_devices, list,
     srcu_read_lock_held(&gpio_devices_srcu)) {
  guard(srcu)(&gdev->srcu);

  gc = srcu_dereference(gdev->chip, &gdev->srcu);
  if (!gc)
   continue;

  for_each_gpio_desc(gc, desc) {
   if (desc->name && !strcmp(desc->name, name))
    return desc;
  }
 }

 return NULL;
}

/*
 * Take the names from gc->names and assign them to their GPIO descriptors.
 * Warn if a name is already used for a GPIO line on a different GPIO chip.
 *
 * Note that:
 *   1. Non-unique names are still accepted,
 *   2. Name collisions within the same GPIO chip are not reported.
 */
static void gpiochip_set_desc_names(struct gpio_chip *gc)
{
 struct gpio_device *gdev = gc->gpiodev;
 int i;

 /* First check all names if they are unique */
 for (i = 0; i != gc->ngpio; ++i) {
  struct gpio_desc *gpio;

  gpio = gpio_name_to_desc(gc->names[i]);
  if (gpio)
   dev_warn(&gdev->dev,
     "Detected name collision for GPIO name '%s'\n",
     gc->names[i]);
 }

 /* Then add all names to the GPIO descriptors */
 for (i = 0; i != gc->ngpio; ++i)
  gdev->descs[i].name = gc->names[i];
}

/*
 * gpiochip_set_names - Set GPIO line names using device properties
 * @chip: GPIO chip whose lines should be named, if possible
 *
 * Looks for device property "gpio-line-names" and if it exists assigns
 * GPIO line names for the chip. The memory allocated for the assigned
 * names belong to the underlying firmware node and should not be released
 * by the caller.
 */
static int gpiochip_set_names(struct gpio_chip *chip)
{
 struct gpio_device *gdev = chip->gpiodev;
 struct device *dev = &gdev->dev;
 const char **names;
 int ret, i;
 int count;

 count = device_property_string_array_count(dev, "gpio-line-names");
 if (count < 0)
  return 0;

 /*
 * When offset is set in the driver side we assume the driver internally
 * is using more than one gpiochip per the same device. We have to stop
 * setting friendly names if the specified ones with 'gpio-line-names'
 * are less than the offset in the device itself. This means all the
 * lines are not present for every single pin within all the internal
 * gpiochips.
 */
 if (count <= chip->offset) {
  dev_warn(dev, "gpio-line-names too short (length %d), cannot map names for the gpiochip at offset %u\n",
    count, chip->offset);
  return 0;
 }

 names = kcalloc(count, sizeof(*names), GFP_KERNEL);
 if (!names)
  return -ENOMEM;

 ret = device_property_read_string_array(dev, "gpio-line-names",
      names, count);
 if (ret < 0) {
  dev_warn(dev, "failed to read GPIO line names\n");
  kfree(names);
  return ret;
 }

 /*
 * When more that one gpiochip per device is used, 'count' can
 * contain at most number gpiochips x chip->ngpio. We have to
 * correctly distribute all defined lines taking into account
 * chip->offset as starting point from where we will assign
 * the names to pins from the 'names' array. Since property
 * 'gpio-line-names' cannot contains gaps, we have to be sure
 * we only assign those pins that really exists since chip->ngpio
 * can be different of the chip->offset.
 */
 count = (count > chip->offset) ? count - chip->offset : count;
 if (count > chip->ngpio)
  count = chip->ngpio;

 for (i = 0; i < count; i++) {
  /*
 * Allow overriding "fixed" names provided by the GPIO
 * provider. The "fixed" names are more often than not
 * generic and less informative than the names given in
 * device properties.
 */
  if (names[chip->offset + i] && names[chip->offset + i][0])
   gdev->descs[i].name = names[chip->offset + i];
 }

 kfree(names);

 return 0;
}

static unsigned long *gpiochip_allocate_mask(struct gpio_chip *gc)
{
 unsigned long *p;

 p = bitmap_alloc(gc->ngpio, GFP_KERNEL);
 if (!p)
  return NULL;

 /* Assume by default all GPIOs are valid */
 bitmap_fill(p, gc->ngpio);

 return p;
}

static void gpiochip_free_mask(unsigned long **p)
{
 bitmap_free(*p);
 *p = NULL;
}

static unsigned int gpiochip_count_reserved_ranges(struct gpio_chip *gc)
{
 struct device *dev = &gc->gpiodev->dev;
 int size;

 /* Format is "start, count, ..." */
 size = device_property_count_u32(dev, "gpio-reserved-ranges");
 if (size > 0 && size % 2 == 0)
  return size;

 return 0;
}

static int gpiochip_apply_reserved_ranges(struct gpio_chip *gc)
{
 struct device *dev = &gc->gpiodev->dev;
 unsigned int size;
 u32 *ranges;
 int ret;

 size = gpiochip_count_reserved_ranges(gc);
 if (size == 0)
  return 0;

 ranges = kmalloc_array(size, sizeof(*ranges), GFP_KERNEL);
 if (!ranges)
  return -ENOMEM;

 ret = device_property_read_u32_array(dev, "gpio-reserved-ranges",
          ranges, size);
 if (ret) {
  kfree(ranges);
  return ret;
 }

 while (size) {
  u32 count = ranges[--size];
  u32 start = ranges[--size];

  if (start >= gc->ngpio || start + count > gc->ngpio)
   continue;

  bitmap_clear(gc->gpiodev->valid_mask, start, count);
 }

 kfree(ranges);
 return 0;
}

static int gpiochip_init_valid_mask(struct gpio_chip *gc)
{
 int ret;

 if (!(gpiochip_count_reserved_ranges(gc) || gc->init_valid_mask))
  return 0;

 gc->gpiodev->valid_mask = gpiochip_allocate_mask(gc);
 if (!gc->gpiodev->valid_mask)
  return -ENOMEM;

 ret = gpiochip_apply_reserved_ranges(gc);
 if (ret)
  return ret;

 if (gc->init_valid_mask)
  return gc->init_valid_mask(gc,
        gc->gpiodev->valid_mask,
        gc->ngpio);

 return 0;
}

static void gpiochip_free_valid_mask(struct gpio_chip *gc)
{
 gpiochip_free_mask(&gc->gpiodev->valid_mask);
}

static int gpiochip_add_pin_ranges(struct gpio_chip *gc)
{
 /*
 * Device Tree platforms are supposed to use "gpio-ranges"
 * property. This check ensures that the ->add_pin_ranges()
 * won't be called for them.
 */
 if (device_property_present(&gc->gpiodev->dev, "gpio-ranges"))
  return 0;

 if (gc->add_pin_ranges)
  return gc->add_pin_ranges(gc);

 return 0;
}

/**
 * gpiochip_query_valid_mask - return the GPIO validity information
 * @gc: gpio chip which validity information is queried
 *
 * Returns: bitmap representing valid GPIOs or NULL if all GPIOs are valid
 *
 * Some GPIO chips may support configurations where some of the pins aren't
 * available. These chips can have valid_mask set to represent the valid
 * GPIOs. This function can be used to retrieve this information.
 */
const unsigned long *gpiochip_query_valid_mask(const struct gpio_chip *gc)
{
 return gc->gpiodev->valid_mask;
}
EXPORT_SYMBOL_GPL(gpiochip_query_valid_mask);

bool gpiochip_line_is_valid(const struct gpio_chip *gc,
    unsigned int offset)
{
 /*
 * hog pins are requested before registering GPIO chip
 */
 if (!gc->gpiodev)
  return true;

 /* No mask means all valid */
 if (likely(!gc->gpiodev->valid_mask))
  return true;
 return test_bit(offset, gc->gpiodev->valid_mask);
}
EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);

static void gpiod_free_irqs(struct gpio_desc *desc)
{
 int irq = gpiod_to_irq(desc);
 struct irq_desc *irqd = irq_to_desc(irq);
 void *cookie;

 for (;;) {
  /*
 * Make sure the action doesn't go away while we're
 * dereferencing it. Retrieve and store the cookie value.
 * If the irq is freed after we release the lock, that's
 * alright - the underlying maple tree lookup will return NULL
 * and nothing will happen in free_irq().
 */
  scoped_guard(mutex, &irqd->request_mutex) {
   if (!irq_desc_has_action(irqd))
    return;

   cookie = irqd->action->dev_id;
  }

  free_irq(irq, cookie);
 }
}

/*
 * The chip is going away but there may be users who had requested interrupts
 * on its GPIO lines who have no idea about its removal and have no way of
 * being notified about it. We need to free any interrupts still in use here or
 * we'll leak memory and resources (like procfs files).
 */
static void gpiochip_free_remaining_irqs(struct gpio_chip *gc)
{
 struct gpio_desc *desc;

 for_each_gpio_desc_with_flag(gc, desc, FLAG_USED_AS_IRQ)
  gpiod_free_irqs(desc);
}

static void gpiodev_release(struct device *dev)
{
 struct gpio_device *gdev = to_gpio_device(dev);

 /* Call pending kfree()s for descriptor labels. */
 synchronize_srcu(&gdev->desc_srcu);
 cleanup_srcu_struct(&gdev->desc_srcu);

 ida_free(&gpio_ida, gdev->id);
 kfree_const(gdev->label);
 kfree(gdev->descs);
 cleanup_srcu_struct(&gdev->srcu);
 kfree(gdev);
}

static const struct device_type gpio_dev_type = {
 .name = "gpio_chip",
 .release = gpiodev_release,
};

#ifdef CONFIG_GPIO_CDEV
#define gcdev_register(gdev, devt) gpiolib_cdev_register((gdev), (devt))
#define gcdev_unregister(gdev)  gpiolib_cdev_unregister((gdev))
#else
/*
 * gpiolib_cdev_register() indirectly calls device_add(), which is still
 * required even when cdev is not selected.
 */
#define gcdev_register(gdev, devt) device_add(&(gdev)->dev)
#define gcdev_unregister(gdev)  device_del(&(gdev)->dev)
#endif

static int gpiochip_setup_dev(struct gpio_device *gdev)
{
 struct fwnode_handle *fwnode = dev_fwnode(&gdev->dev);
 int ret;

 device_initialize(&gdev->dev);

 /*
 * If fwnode doesn't belong to another device, it's safe to clear its
 * initialized flag.
 */
 if (fwnode && !fwnode->dev)
  fwnode_dev_initialized(fwnode, false);

 ret = gcdev_register(gdev, gpio_devt);
 if (ret)
  return ret;

 ret = gpiochip_sysfs_register(gdev);
 if (ret)
  goto err_remove_device;

 dev_dbg(&gdev->dev, "registered GPIOs %u to %u on %s\n", gdev->base,
  gdev->base + gdev->ngpio - 1, gdev->label);

 return 0;

err_remove_device:
 gcdev_unregister(gdev);
 return ret;
}

static void gpiochip_machine_hog(struct gpio_chip *gc, struct gpiod_hog *hog)
{
 struct gpio_desc *desc;
 int rv;

 desc = gpiochip_get_desc(gc, hog->chip_hwnum);
 if (IS_ERR(desc)) {
  chip_err(gc, "%s: unable to get GPIO desc: %ld\n", __func__,
    PTR_ERR(desc));
  return;
 }

 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
 if (rv)
  gpiod_err(desc, "%s: unable to hog GPIO line (%s:%u): %d\n",
     __func__, gc->label, hog->chip_hwnum, rv);
}

static void machine_gpiochip_add(struct gpio_chip *gc)
{
 struct gpiod_hog *hog;

 guard(mutex)(&gpio_machine_hogs_mutex);

 list_for_each_entry(hog, &gpio_machine_hogs, list) {
  if (!strcmp(gc->label, hog->chip_label))
   gpiochip_machine_hog(gc, hog);
 }
}

static void gpiochip_setup_devs(void)
{
 struct gpio_device *gdev;
 int ret;

 guard(srcu)(&gpio_devices_srcu);

 list_for_each_entry_srcu(gdev, &gpio_devices, list,
     srcu_read_lock_held(&gpio_devices_srcu)) {
  ret = gpiochip_setup_dev(gdev);
  if (ret)
   dev_err(&gdev->dev,
    "Failed to initialize gpio device (%d)\n", ret);
 }
}

static void gpiochip_set_data(struct gpio_chip *gc, void *data)
{
 gc->gpiodev->data = data;
}

/**
 * gpiochip_get_data() - get per-subdriver data for the chip
 * @gc: GPIO chip
 *
 * Returns:
 * The per-subdriver data for the chip.
 */
void *gpiochip_get_data(struct gpio_chip *gc)
{
 return gc->gpiodev->data;
}
EXPORT_SYMBOL_GPL(gpiochip_get_data);

/*
 * If the calling driver provides the specific firmware node,
 * use it. Otherwise use the one from the parent device, if any.
 */
static struct fwnode_handle *gpiochip_choose_fwnode(struct gpio_chip *gc)
{
 if (gc->fwnode)
  return gc->fwnode;

 if (gc->parent)
  return dev_fwnode(gc->parent);

 return NULL;
}

int gpiochip_get_ngpios(struct gpio_chip *gc, struct device *dev)
{
 struct fwnode_handle *fwnode = gpiochip_choose_fwnode(gc);
 u32 ngpios = gc->ngpio;
 int ret;

 if (ngpios == 0) {
  ret = fwnode_property_read_u32(fwnode, "ngpios", &ngpios);
  if (ret == -ENODATA)
   /*
 * -ENODATA means that there is no property found and
 * we want to issue the error message to the user.
 * Besides that, we want to return different error code
 * to state that supplied value is not valid.
 */
   ngpios = 0;
  else if (ret)
   return ret;

  gc->ngpio = ngpios;
 }

 if (gc->ngpio == 0) {
  dev_err(dev, "tried to insert a GPIO chip with zero lines\n");
  return -EINVAL;
 }

 if (gc->ngpio > FASTPATH_NGPIO)
  dev_warn(dev, "line cnt %u is greater than fast path cnt %u\n",
    gc->ngpio, FASTPATH_NGPIO);

 return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_get_ngpios);

int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
          struct lock_class_key *lock_key,
          struct lock_class_key *request_key)
{
 struct gpio_device *gdev;
 unsigned int desc_index;
 int base = 0;
 int ret;

 /*
 * First: allocate and populate the internal stat container, and
 * set up the struct device.
 */
 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
 if (!gdev)
  return -ENOMEM;

 gdev->dev.type = &gpio_dev_type;
 gdev->dev.bus = &gpio_bus_type;
 gdev->dev.parent = gc->parent;
 rcu_assign_pointer(gdev->chip, gc);

 gc->gpiodev = gdev;
 gpiochip_set_data(gc, data);

 device_set_node(&gdev->dev, gpiochip_choose_fwnode(gc));

 ret = ida_alloc(&gpio_ida, GFP_KERNEL);
 if (ret < 0)
  goto err_free_gdev;
 gdev->id = ret;

 ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
 if (ret)
  goto err_free_ida;

 if (gc->parent && gc->parent->driver)
  gdev->owner = gc->parent->driver->owner;
 else if (gc->owner)
  /* TODO: remove chip->owner */
  gdev->owner = gc->owner;
 else
  gdev->owner = THIS_MODULE;

 ret = gpiochip_get_ngpios(gc, &gdev->dev);
 if (ret)
  goto err_free_dev_name;

 gdev->descs = kcalloc(gc->ngpio, sizeof(*gdev->descs), GFP_KERNEL);
 if (!gdev->descs) {
  ret = -ENOMEM;
  goto err_free_dev_name;
 }

 gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
 if (!gdev->label) {
  ret = -ENOMEM;
  goto err_free_descs;
 }

 gdev->ngpio = gc->ngpio;
 gdev->can_sleep = gc->can_sleep;

 scoped_guard(mutex, &gpio_devices_lock) {
  /*
 * TODO: this allocates a Linux GPIO number base in the global
 * GPIO numberspace for this chip. In the long run we want to
 * get *rid* of this numberspace and use only descriptors, but
 * it may be a pipe dream. It will not happen before we get rid
 * of the sysfs interface anyways.
 */
  base = gc->base;
  if (base < 0) {
   base = gpiochip_find_base_unlocked(gc->ngpio);
   if (base < 0) {
    ret = base;
    base = 0;
    goto err_free_label;
   }

   /*
 * TODO: it should not be necessary to reflect the
 * assigned base outside of the GPIO subsystem. Go over
 * drivers and see if anyone makes use of this, else
 * drop this and assign a poison instead.
 */
   gc->base = base;
  } else {
   dev_warn(&gdev->dev,
     "Static allocation of GPIO base is deprecated, use dynamic allocation.\n");
  }

  gdev->base = base;

  ret = gpiodev_add_to_list_unlocked(gdev);
  if (ret) {
   chip_err(gc, "GPIO integer space overlap, cannot add chip\n");
   goto err_free_label;
  }
 }

 rwlock_init(&gdev->line_state_lock);
 RAW_INIT_NOTIFIER_HEAD(&gdev->line_state_notifier);
 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->device_notifier);

 ret = init_srcu_struct(&gdev->srcu);
 if (ret)
  goto err_remove_from_list;

 ret = init_srcu_struct(&gdev->desc_srcu);
 if (ret)
  goto err_cleanup_gdev_srcu;

#ifdef CONFIG_PINCTRL
 INIT_LIST_HEAD(&gdev->pin_ranges);
#endif

 if (gc->names)
  gpiochip_set_desc_names(gc);

 ret = gpiochip_set_names(gc);
 if (ret)
  goto err_cleanup_desc_srcu;

 ret = gpiochip_init_valid_mask(gc);
 if (ret)
  goto err_cleanup_desc_srcu;

 for (desc_index = 0; desc_index < gc->ngpio; desc_index++) {
  struct gpio_desc *desc = &gdev->descs[desc_index];

  desc->gdev = gdev;

  /*
 * We would typically want to use gpiochip_get_direction() here
 * but we must not check the return value and bail-out as pin
 * controllers can have pins configured to alternate functions
 * and return -EINVAL. Also: there's no need to take the SRCU
 * lock here.
 */
  if (gc->get_direction && gpiochip_line_is_valid(gc, desc_index))
   assign_bit(FLAG_IS_OUT, &desc->flags,
       !gc->get_direction(gc, desc_index));
  else
   assign_bit(FLAG_IS_OUT,
       &desc->flags, !gc->direction_input);
 }

 ret = of_gpiochip_add(gc);
 if (ret)
  goto err_free_valid_mask;

 ret = gpiochip_add_pin_ranges(gc);
 if (ret)
  goto err_remove_of_chip;

 acpi_gpiochip_add(gc);

 machine_gpiochip_add(gc);

 ret = gpiochip_irqchip_init_valid_mask(gc);
 if (ret)
  goto err_free_hogs;

 ret = gpiochip_irqchip_init_hw(gc);
 if (ret)
  goto err_remove_irqchip_mask;

 ret = gpiochip_add_irqchip(gc, lock_key, request_key);
 if (ret)
  goto err_remove_irqchip_mask;

 /*
 * By first adding the chardev, and then adding the device,
 * we get a device node entry in sysfs under
 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
 * coldplug of device nodes and other udev business.
 * We can do this only if gpiolib has been initialized.
 * Otherwise, defer until later.
 */
 if (gpiolib_initialized) {
  ret = gpiochip_setup_dev(gdev);
  if (ret)
   goto err_remove_irqchip;
 }
 return 0;

err_remove_irqchip:
 gpiochip_irqchip_remove(gc);
err_remove_irqchip_mask:
 gpiochip_irqchip_free_valid_mask(gc);
err_free_hogs:
 gpiochip_free_hogs(gc);
 acpi_gpiochip_remove(gc);
 gpiochip_remove_pin_ranges(gc);
err_remove_of_chip:
 of_gpiochip_remove(gc);
err_free_valid_mask:
 gpiochip_free_valid_mask(gc);
err_cleanup_desc_srcu:
 cleanup_srcu_struct(&gdev->desc_srcu);
err_cleanup_gdev_srcu:
 cleanup_srcu_struct(&gdev->srcu);
err_remove_from_list:
 scoped_guard(mutex, &gpio_devices_lock)
  list_del_rcu(&gdev->list);
 synchronize_srcu(&gpio_devices_srcu);
 if (gdev->dev.release) {
  /* release() has been registered by gpiochip_setup_dev() */
  gpio_device_put(gdev);
  goto err_print_message;
 }
err_free_label:
 kfree_const(gdev->label);
err_free_descs:
 kfree(gdev->descs);
err_free_dev_name:
 kfree(dev_name(&gdev->dev));
err_free_ida:
 ida_free(&gpio_ida, gdev->id);
err_free_gdev:
 kfree(gdev);
err_print_message:
 /* failures here can mean systems won't boot... */
 if (ret != -EPROBE_DEFER) {
  pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
         base, base + (int)gc->ngpio - 1,
         gc->label ? : "generic", ret);
 }
 return ret;
}
EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);

/**
 * gpiochip_remove() - unregister a gpio_chip
 * @gc: the chip to unregister
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
void gpiochip_remove(struct gpio_chip *gc)
{
 struct gpio_device *gdev = gc->gpiodev;

 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
 gpiochip_sysfs_unregister(gdev);
 gpiochip_free_hogs(gc);
 gpiochip_free_remaining_irqs(gc);

 scoped_guard(mutex, &gpio_devices_lock)
  list_del_rcu(&gdev->list);
 synchronize_srcu(&gpio_devices_srcu);

 /* Numb the device, cancelling all outstanding operations */
 rcu_assign_pointer(gdev->chip, NULL);
 synchronize_srcu(&gdev->srcu);
 gpiochip_irqchip_remove(gc);
 acpi_gpiochip_remove(gc);
 of_gpiochip_remove(gc);
 gpiochip_remove_pin_ranges(gc);
 gpiochip_free_valid_mask(gc);
 /*
 * We accept no more calls into the driver from this point, so
 * NULL the driver data pointer.
 */
 gpiochip_set_data(gc, NULL);

 /*
 * The gpiochip side puts its use of the device to rest here:
 * if there are no userspace clients, the chardev and device will
 * be removed, else it will be dangling until the last user is
 * gone.
 */
 gcdev_unregister(gdev);
 gpio_device_put(gdev);
}
EXPORT_SYMBOL_GPL(gpiochip_remove);

/**
 * gpio_device_find() - find a specific GPIO device
 * @data: data to pass to match function
 * @match: Callback function to check gpio_chip
 *
 * Returns:
 * New reference to struct gpio_device.
 *
 * Similar to bus_find_device(). It returns a reference to a gpio_device as
 * determined by a user supplied @match callback. The callback should return
 * 0 if the device doesn't match and non-zero if it does. If the callback
 * returns non-zero, this function will return to the caller and not iterate
 * over any more gpio_devices.
 *
 * The callback takes the GPIO chip structure as argument. During the execution
 * of the callback function the chip is protected from being freed. TODO: This
 * actually has yet to be implemented.
 *
 * If the function returns non-NULL, the returned reference must be freed by
 * the caller using gpio_device_put().
 */
struct gpio_device *gpio_device_find(const void *data,
         int (*match)(struct gpio_chip *gc,
        const void *data))
{
 struct gpio_device *gdev;
 struct gpio_chip *gc;

 might_sleep();

 guard(srcu)(&gpio_devices_srcu);

 list_for_each_entry_srcu(gdev, &gpio_devices, list,
     srcu_read_lock_held(&gpio_devices_srcu)) {
  if (!device_is_registered(&gdev->dev))
   continue;

  guard(srcu)(&gdev->srcu);

  gc = srcu_dereference(gdev->chip, &gdev->srcu);

  if (gc && match(gc, data))
   return gpio_device_get(gdev);
 }

 return NULL;
}
EXPORT_SYMBOL_GPL(gpio_device_find);

static int gpio_chip_match_by_label(struct gpio_chip *gc, const void *label)
{
 return gc->label && !strcmp(gc->label, label);
}

/**
 * gpio_device_find_by_label() - wrapper around gpio_device_find() finding the
 *                               GPIO device by its backing chip's label
 * @label: Label to lookup
 *
 * Returns:
 * Reference to the GPIO device or NULL. Reference must be released with
 * gpio_device_put().
 */
struct gpio_device *gpio_device_find_by_label(const char *label)
{
 return gpio_device_find((void *)label, gpio_chip_match_by_label);
}
EXPORT_SYMBOL_GPL(gpio_device_find_by_label);

static int gpio_chip_match_by_fwnode(struct gpio_chip *gc, const void *fwnode)
{
 return device_match_fwnode(&gc->gpiodev->dev, fwnode);
}

/**
 * gpio_device_find_by_fwnode() - wrapper around gpio_device_find() finding
 *                                the GPIO device by its fwnode
 * @fwnode: Firmware node to lookup
 *
 * Returns:
 * Reference to the GPIO device or NULL. Reference must be released with
 * gpio_device_put().
 */
struct gpio_device *gpio_device_find_by_fwnode(const struct fwnode_handle *fwnode)
{
 return gpio_device_find((void *)fwnode, gpio_chip_match_by_fwnode);
}
EXPORT_SYMBOL_GPL(gpio_device_find_by_fwnode);

/**
 * gpio_device_get() - Increase the reference count of this GPIO device
 * @gdev: GPIO device to increase the refcount for
 *
 * Returns:
 * Pointer to @gdev.
 */
struct gpio_device *gpio_device_get(struct gpio_device *gdev)
{
 return to_gpio_device(get_device(&gdev->dev));
}
EXPORT_SYMBOL_GPL(gpio_device_get);

/**
 * gpio_device_put() - Decrease the reference count of this GPIO device and
 *                     possibly free all resources associated with it.
 * @gdev: GPIO device to decrease the reference count for
 */
void gpio_device_put(struct gpio_device *gdev)
{
 put_device(&gdev->dev);
}
EXPORT_SYMBOL_GPL(gpio_device_put);

/**
 * gpio_device_to_device() - Retrieve the address of the underlying struct
 *                           device.
 * @gdev: GPIO device for which to return the address.
 *
 * This does not increase the reference count of the GPIO device nor the
 * underlying struct device.
 *
 * Returns:
 * Address of struct device backing this GPIO device.
 */
struct device *gpio_device_to_device(struct gpio_device *gdev)
{
 return &gdev->dev;
}
EXPORT_SYMBOL_GPL(gpio_device_to_device);

#ifdef CONFIG_GPIOLIB_IRQCHIP

/*
 * The following is irqchip helper code for gpiochips.
 */

static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
{
 struct gpio_irq_chip *girq = &gc->irq;

 if (!girq->init_hw)
  return 0;

 return girq->init_hw(gc);
}

static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
{
 struct gpio_irq_chip *girq = &gc->irq;

 if (!girq->init_valid_mask)
  return 0;

 girq->valid_mask = gpiochip_allocate_mask(gc);
 if (!girq->valid_mask)
  return -ENOMEM;

 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);

 return 0;
}

static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
{
 gpiochip_free_mask(&gc->irq.valid_mask);
}

static bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
           unsigned int offset)
{
 if (!gpiochip_line_is_valid(gc, offset))
  return false;
 /* No mask means all valid */
 if (likely(!gc->irq.valid_mask))
  return true;
 return test_bit(offset, gc->irq.valid_mask);
}

#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY

/**
 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
 * to a gpiochip
 * @gc: the gpiochip to set the irqchip hierarchical handler to
 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
 * will then percolate up to the parent
 */
static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
           struct irq_chip *irqchip)
{
 /* DT will deal with mapping each IRQ as we go along */
 if (is_of_node(gc->irq.fwnode))
  return;

 /*
 * This is for legacy and boardfile "irqchip" fwnodes: allocate
 * irqs upfront instead of dynamically since we don't have the
 * dynamic type of allocation that hardware description languages
 * provide. Once all GPIO drivers using board files are gone from
 * the kernel we can delete this code, but for a transitional period
 * it is necessary to keep this around.
 */
 if (is_fwnode_irqchip(gc->irq.fwnode)) {
  int i;
  int ret;

  for (i = 0; i < gc->ngpio; i++) {
   struct irq_fwspec fwspec;
   unsigned int parent_hwirq;
   unsigned int parent_type;
   struct gpio_irq_chip *girq = &gc->irq;

   /*
 * We call the child to parent translation function
 * only to check if the child IRQ is valid or not.
 * Just pick the rising edge type here as that is what
 * we likely need to support.
 */
   ret = girq->child_to_parent_hwirq(gc, i,
         IRQ_TYPE_EDGE_RISING,
         &parent_hwirq,
         &parent_type);
   if (ret) {
    chip_err(gc, "skip set-up on hwirq %d\n",
      i);
    continue;
   }

   fwspec.fwnode = gc->irq.fwnode;
   /* This is the hwirq for the GPIO line side of things */
   fwspec.param[0] = girq->child_offset_to_irq(gc, i);
   /* Just pick something */
   fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
   fwspec.param_count = 2;
   ret = irq_domain_alloc_irqs(gc->irq.domain, 1,
          NUMA_NO_NODE, &fwspec);
   if (ret < 0) {
    chip_err(gc,
      "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
      i, parent_hwirq,
      ret);
   }
  }
 }

 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);

 return;
}

static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
         struct irq_fwspec *fwspec,
         unsigned long *hwirq,
         unsigned int *type)
{
 /* We support standard DT translation */
 if (is_of_node(fwspec->fwnode))
  return irq_domain_translate_twothreecell(d, fwspec, hwirq, type);

 /* This is for board files and others not using DT */
 if (is_fwnode_irqchip(fwspec->fwnode)) {
  int ret;

  ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
  if (ret)
   return ret;
  WARN_ON(*type == IRQ_TYPE_NONE);
  return 0;
 }
 return -EINVAL;
}

static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
            unsigned int irq,
            unsigned int nr_irqs,
            void *data)
{
 struct gpio_chip *gc = d->host_data;
 irq_hw_number_t hwirq;
 unsigned int type = IRQ_TYPE_NONE;
 struct irq_fwspec *fwspec = data;
 union gpio_irq_fwspec gpio_parent_fwspec = {};
 unsigned int parent_hwirq;
 unsigned int parent_type;
 struct gpio_irq_chip *girq = &gc->irq;
 int ret;

 /*
 * The nr_irqs parameter is always one except for PCI multi-MSI
 * so this should not happen.
 */
 WARN_ON(nr_irqs != 1);

 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
 if (ret)
  return ret;

 chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);

 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
       &parent_hwirq, &parent_type);
 if (ret) {
  chip_err(gc, "can't look up hwirq %lu\n", hwirq);
  return ret;
 }
 chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);

 /*
 * We set handle_bad_irq because the .set_type() should
 * always be invoked and set the right type of handler.
 */
 irq_domain_set_info(d,
       irq,
       hwirq,
       gc->irq.chip,
       gc,
       girq->handler,
       NULL, NULL);
 irq_set_probe(irq);

 /* This parent only handles asserted level IRQs */
 ret = girq->populate_parent_alloc_arg(gc, &gpio_parent_fwspec,
           parent_hwirq, parent_type);
 if (ret)
  return ret;

 chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
    irq, parent_hwirq);
 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
 ret = irq_domain_alloc_irqs_parent(d, irq, 1, &gpio_parent_fwspec);
 /*
 * If the parent irqdomain is msi, the interrupts have already
 * been allocated, so the EEXIST is good.
 */
 if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
  ret = 0;
 if (ret)
  chip_err(gc,
    "failed to allocate parent hwirq %d for hwirq %lu\n",
    parent_hwirq, hwirq);

 return ret;
}

static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
            unsigned int offset)
{
 return offset;
}

/**
 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
 * @domain: The IRQ domain used by this IRQ chip
 * @data: Outermost irq_data associated with the IRQ
 * @reserve: If set, only reserve an interrupt vector instead of assigning one
 *
 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
 * used as the activate function for the &struct irq_domain_ops. The host_data
 * for the IRQ domain must be the &struct gpio_chip.
 *
 * Returns:
 * 0 on success, or negative errno on failure.
 */
static int gpiochip_irq_domain_activate(struct irq_domain *domain,
     struct irq_data *data, bool reserve)
{
 struct gpio_chip *gc = domain->host_data;
 unsigned int hwirq = irqd_to_hwirq(data);

 return gpiochip_lock_as_irq(gc, hwirq);
}

/**
 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
 * @domain: The IRQ domain used by this IRQ chip
 * @data: Outermost irq_data associated with the IRQ
 *
 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
 * be used as the deactivate function for the &struct irq_domain_ops. The
 * host_data for the IRQ domain must be the &struct gpio_chip.
 */
static void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
        struct irq_data *data)
{
 struct gpio_chip *gc = domain->host_data;
 unsigned int hwirq = irqd_to_hwirq(data);

 return gpiochip_unlock_as_irq(gc, hwirq);
}

static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
{
 ops->activate = gpiochip_irq_domain_activate;
 ops->deactivate = gpiochip_irq_domain_deactivate;
 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;

 /*
 * We only allow overriding the translate() and free() functions for
 * hierarchical chips, and this should only be done if the user
 * really need something other than 1:1 translation for translate()
 * callback and free if user wants to free up any resources which
 * were allocated during callbacks, for example populate_parent_alloc_arg.
 */
 if (!ops->translate)
  ops->translate = gpiochip_hierarchy_irq_domain_translate;
 if (!ops->free)
  ops->free = irq_domain_free_irqs_common;
}

static struct irq_domain *gpiochip_hierarchy_create_domain(struct gpio_chip *gc)
{
 struct irq_domain *domain;

 if (!gc->irq.child_to_parent_hwirq ||
     !gc->irq.fwnode) {
  chip_err(gc, "missing irqdomain vital data\n");
  return ERR_PTR(-EINVAL);
 }

 if (!gc->irq.child_offset_to_irq)
  gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;

 if (!gc->irq.populate_parent_alloc_arg)
  gc->irq.populate_parent_alloc_arg =
   gpiochip_populate_parent_fwspec_twocell;

 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);

 domain = irq_domain_create_hierarchy(
  gc->irq.parent_domain,
  0,
  gc->ngpio,
  gc->irq.fwnode,
  &gc->irq.child_irq_domain_ops,
  gc);

 if (!domain)
  return ERR_PTR(-ENOMEM);

 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);

 return domain;
}

static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
{
 return !!gc->irq.parent_domain;
}

int gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
         union gpio_irq_fwspec *gfwspec,
         unsigned int parent_hwirq,
         unsigned int parent_type)
{
 struct irq_fwspec *fwspec = &gfwspec->fwspec;

 fwspec->fwnode = gc->irq.parent_domain->fwnode;
 fwspec->param_count = 2;
 fwspec->param[0] = parent_hwirq;
 fwspec->param[1] = parent_type;

 return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);

int gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
          union gpio_irq_fwspec *gfwspec,
          unsigned int parent_hwirq,
          unsigned int parent_type)
{
 struct irq_fwspec *fwspec = &gfwspec->fwspec;

 fwspec->fwnode = gc->irq.parent_domain->fwnode;
 fwspec->param_count = 4;
 fwspec->param[0] = 0;
 fwspec->param[1] = parent_hwirq;
 fwspec->param[2] = 0;
 fwspec->param[3] = parent_type;

 return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);

#else

static struct irq_domain *gpiochip_hierarchy_create_domain(struct gpio_chip *gc)
{
 return ERR_PTR(-EINVAL);
}

static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
{
 return false;
}

#endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */

/**
 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
 * @d: the irqdomain used by this irqchip
 * @irq: the global irq number used by this GPIO irqchip irq
 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
 *
 * This function will set up the mapping for a certain IRQ line on a
 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
 * stored inside the gpiochip.
 *
 * Returns:
 * 0 on success, or negative errno on failure.
 */
static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
       irq_hw_number_t hwirq)
{
 struct gpio_chip *gc = d->host_data;
 int ret = 0;

 if (!gpiochip_irqchip_irq_valid(gc, hwirq))
  return -ENXIO;

 irq_set_chip_data(irq, gc);
 /*
 * This lock class tells lockdep that GPIO irqs are in a different
 * category than their parents, so it won't report false recursion.
 */
 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
 irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
 /* Chips that use nested thread handlers have them marked */
 if (gc->irq.threaded)
  irq_set_nested_thread(irq, 1);
 irq_set_noprobe(irq);

 if (gc->irq.num_parents == 1)
  ret = irq_set_parent(irq, gc->irq.parents[0]);
 else if (gc->irq.map)
  ret = irq_set_parent(irq, gc->irq.map[hwirq]);

 if (ret < 0)
  return ret;

 /*
 * No set-up of the hardware will happen if IRQ_TYPE_NONE
 * is passed as default type.
 */
 if (gc->irq.default_type != IRQ_TYPE_NONE)
  irq_set_irq_type(irq, gc->irq.default_type);

 return 0;
}

static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
{
 struct gpio_chip *gc = d->host_data;

 if (gc->irq.threaded)
  irq_set_nested_thread(irq, 0);
 irq_set_chip_and_handler(irq, NULL, NULL);
 irq_set_chip_data(irq, NULL);
}

static int gpiochip_irq_select(struct irq_domain *d, struct irq_fwspec *fwspec,
          enum irq_domain_bus_token bus_token)
{
 struct fwnode_handle *fwnode = fwspec->fwnode;
 struct gpio_chip *gc = d->host_data;
 unsigned int index = fwspec->param[0];

 if (fwspec->param_count == 3 && is_of_node(fwnode))
  return of_gpiochip_instance_match(gc, index);

 /* Fallback for twocells */
 return (fwnode && (d->fwnode == fwnode) && (d->bus_token == bus_token));
}

static const struct irq_domain_ops gpiochip_domain_ops = {
 .map = gpiochip_irq_map,
 .unmap = gpiochip_irq_unmap,
 .select = gpiochip_irq_select,
 /* Virtually all GPIO irqchips are twocell:ed */
 .xlate = irq_domain_xlate_twothreecell,
};

static struct irq_domain *gpiochip_simple_create_domain(struct gpio_chip *gc)
{
 struct fwnode_handle *fwnode = dev_fwnode(&gc->gpiodev->dev);
 struct irq_domain *domain;

 domain = irq_domain_create_simple(fwnode, gc->ngpio, gc->irq.first,
       &gpiochip_domain_ops, gc);
 if (!domain)
  return ERR_PTR(-EINVAL);

 return domain;
}

static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
{
 struct irq_domain *domain = gc->irq.domain;

 /*
 * Avoid race condition with other code, which tries to lookup
 * an IRQ before the irqchip has been properly registered,
 * i.e. while gpiochip is still being brought up.
 */
 if (!gc->irq.initialized)
  return -EPROBE_DEFER;

 if (!gpiochip_irqchip_irq_valid(gc, offset))
  return -ENXIO;

#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
 if (irq_domain_is_hierarchy(domain)) {
  struct irq_fwspec spec;

  spec.fwnode = domain->fwnode;
  spec.param_count = 2;
  spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
  spec.param[1] = IRQ_TYPE_NONE;

  return irq_create_fwspec_mapping(&spec);
 }
#endif

 return irq_create_mapping(domain, offset);
}

int gpiochip_irq_reqres(struct irq_data *d)
{
 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 unsigned int hwirq = irqd_to_hwirq(d);

 return gpiochip_reqres_irq(gc, hwirq);
}
EXPORT_SYMBOL(gpiochip_irq_reqres);

void gpiochip_irq_relres(struct irq_data *d)
{
 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 unsigned int hwirq = irqd_to_hwirq(d);

 gpiochip_relres_irq(gc, hwirq);
}
EXPORT_SYMBOL(gpiochip_irq_relres);

static void gpiochip_irq_mask(struct irq_data *d)
{
 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 unsigned int hwirq = irqd_to_hwirq(d);

 if (gc->irq.irq_mask)
  gc->irq.irq_mask(d);
 gpiochip_disable_irq(gc, hwirq);
}

static void gpiochip_irq_unmask(struct irq_data *d)
{
 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 unsigned int hwirq = irqd_to_hwirq(d);

 gpiochip_enable_irq(gc, hwirq);
 if (gc->irq.irq_unmask)
  gc->irq.irq_unmask(d);
}

static void gpiochip_irq_enable(struct irq_data *d)
{
 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 unsigned int hwirq = irqd_to_hwirq(d);

 gpiochip_enable_irq(gc, hwirq);
 gc->irq.irq_enable(d);
}

static void gpiochip_irq_disable(struct irq_data *d)
{
 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 unsigned int hwirq = irqd_to_hwirq(d);

 gc->irq.irq_disable(d);
 gpiochip_disable_irq(gc, hwirq);
}

static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
{
 struct irq_chip *irqchip = gc->irq.chip;

 if (irqchip->flags & IRQCHIP_IMMUTABLE)
  return;

 chip_warn(gc, "not an immutable chip, please consider fixing it!\n");

 if (!irqchip->irq_request_resources &&
     !irqchip->irq_release_resources) {
  irqchip->irq_request_resources = gpiochip_irq_reqres;
  irqchip->irq_release_resources = gpiochip_irq_relres;
 }
 if (WARN_ON(gc->irq.irq_enable))
  return;
 /* Check if the irqchip already has this hook... */
 if (irqchip->irq_enable == gpiochip_irq_enable ||
  irqchip->irq_mask == gpiochip_irq_mask) {
  /*
 * ...and if so, give a gentle warning that this is bad
 * practice.
 */
  chip_info(gc,
     "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
  return;
 }

 if (irqchip->irq_disable) {
  gc->irq.irq_disable = irqchip->irq_disable;
  irqchip->irq_disable = gpiochip_irq_disable;
 } else {
  gc->irq.irq_mask = irqchip->irq_mask;
  irqchip->irq_mask = gpiochip_irq_mask;
 }

 if (irqchip->irq_enable) {
  gc->irq.irq_enable = irqchip->irq_enable;
  irqchip->irq_enable = gpiochip_irq_enable;
 } else {
  gc->irq.irq_unmask = irqchip->irq_unmask;
  irqchip->irq_unmask = gpiochip_irq_unmask;
 }
}

static int gpiochip_irqchip_add_allocated_domain(struct gpio_chip *gc,
       struct irq_domain *domain,
       bool allocated_externally)
{
 if (!domain)
  return -EINVAL;

 if (gc->to_irq)
  chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);

 gc->to_irq = gpiochip_to_irq;
 gc->irq.domain = domain;
 gc->irq.domain_is_allocated_externally = allocated_externally;

 /*
 * Using barrier() here to prevent compiler from reordering
 * gc->irq.initialized before adding irqdomain.
 */
 barrier();

 gc->irq.initialized = true;

 return 0;
}

/**
 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
 * @gc: the GPIO chip to add the IRQ chip to
 * @lock_key: lockdep class for IRQ lock
 * @request_key: lockdep class for IRQ request
 *
 * Returns:
 * 0 on success, or a negative errno on failure.
 */
static int gpiochip_add_irqchip(struct gpio_chip *gc,
    struct lock_class_key *lock_key,
    struct lock_class_key *request_key)
{
 struct fwnode_handle *fwnode = dev_fwnode(&gc->gpiodev->dev);
 struct irq_chip *irqchip = gc->irq.chip;
 struct irq_domain *domain;
 unsigned int type;
 unsigned int i;
 int ret;

 if (!irqchip)
  return 0;

 if (gc->irq.parent_handler && gc->can_sleep) {
  chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
  return -EINVAL;
 }

 type = gc->irq.default_type;

 /*
 * Specifying a default trigger is a terrible idea if DT or ACPI is
 * used to configure the interrupts, as you may end up with
 * conflicting triggers. Tell the user, and reset to NONE.
 */
 if (WARN(fwnode && type != IRQ_TYPE_NONE,
   "%pfw: Ignoring %u default trigger\n", fwnode, type))
  type = IRQ_TYPE_NONE;

 gc->irq.default_type = type;
 gc->irq.lock_key = lock_key;
 gc->irq.request_key = request_key;

 /* If a parent irqdomain is provided, let's build a hierarchy */
 if (gpiochip_hierarchy_is_hierarchical(gc)) {
  domain = gpiochip_hierarchy_create_domain(gc);
 } else {
  domain = gpiochip_simple_create_domain(gc);
 }
 if (IS_ERR(domain))
  return PTR_ERR(domain);

 if (gc->irq.parent_handler) {
  for (i = 0; i < gc->irq.num_parents; i++) {
   void *data;

   if (gc->irq.per_parent_data)
    data = gc->irq.parent_handler_data_array[i];
   else
    data = gc->irq.parent_handler_data ?: gc;

   /*
 * The parent IRQ chip is already using the chip_data
 * for this IRQ chip, so our callbacks simply use the
 * handler_data.
 */
   irq_set_chained_handler_and_data(gc->irq.parents[i],
        gc->irq.parent_handler,
        data);
  }
 }

 gpiochip_set_irq_hooks(gc);

 ret = gpiochip_irqchip_add_allocated_domain(gc, domain, false);
 if (ret)
  return ret;

 acpi_gpiochip_request_interrupts(gc);

 return 0;
}

/**
 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
 * @gc: the gpiochip to remove the irqchip from
 *
 * This is called only from gpiochip_remove()
 */
static void gpiochip_irqchip_remove(struct gpio_chip *gc)
{
 struct irq_chip *irqchip = gc->irq.chip;
 unsigned int offset;

 acpi_gpiochip_free_interrupts(gc);

 if (irqchip && gc->irq.parent_handler) {
  struct gpio_irq_chip *irq = &gc->irq;
  unsigned int i;

  for (i = 0; i < irq->num_parents; i++)
   irq_set_chained_handler_and_data(irq->parents[i],
        NULL, NULL);
 }

 /* Remove all IRQ mappings and delete the domain */
 if (!gc->irq.domain_is_allocated_externally && gc->irq.domain) {
  unsigned int irq;

  for (offset = 0; offset < gc->ngpio; offset++) {
   if (!gpiochip_irqchip_irq_valid(gc, offset))
    continue;

   irq = irq_find_mapping(gc->irq.domain, offset);
   irq_dispose_mapping(irq);
  }

  irq_domain_remove(gc->irq.domain);
 }

 if (irqchip && !(irqchip->flags & IRQCHIP_IMMUTABLE)) {
  if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
   irqchip->irq_request_resources = NULL;
   irqchip->irq_release_resources = NULL;
  }
  if (irqchip->irq_enable == gpiochip_irq_enable) {
   irqchip->irq_enable = gc->irq.irq_enable;
   irqchip->irq_disable = gc->irq.irq_disable;
  }
 }
 gc->irq.irq_enable = NULL;
 gc->irq.irq_disable = NULL;
 gc->irq.chip = NULL;

 gpiochip_irqchip_free_valid_mask(gc);
}

/**
 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
 * @gc: the gpiochip to add the irqchip to
 * @domain: the irqdomain to add to the gpiochip
 *
 * This function adds an IRQ domain to the gpiochip.
 *
 * Returns:
 * 0 on success, or negative errno on failure.
 */
int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
    struct irq_domain *domain)
{
 return gpiochip_irqchip_add_allocated_domain(gc, domain, true);
}
EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);

#else /* CONFIG_GPIOLIB_IRQCHIP */

static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
           struct lock_class_key *lock_key,
           struct lock_class_key *request_key)
{
 return 0;
}
static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}

static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
{
 return 0;
}

static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
{
 return 0;
}
static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
{ }

#endif /* CONFIG_GPIOLIB_IRQCHIP */

/**
 * gpiochip_generic_request() - request the gpio function for a pin
 * @gc: the gpiochip owning the GPIO
 * @offset: the offset of the GPIO to request for GPIO function
 *
 * Returns:
 * 0 on success, or negative errno on failure.
 */
int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
{
#ifdef CONFIG_PINCTRL
 if (list_empty(&gc->gpiodev->pin_ranges))
  return 0;
#endif

 return pinctrl_gpio_request(gc, offset);
}
EXPORT_SYMBOL_GPL(gpiochip_generic_request);

/**
 * gpiochip_generic_free() - free the gpio function from a pin
 * @gc: the gpiochip to request the gpio function for
 * @offset: the offset of the GPIO to free from GPIO function
 */
void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
{
#ifdef CONFIG_PINCTRL
 if (list_empty(&gc->gpiodev->pin_ranges))
  return;
#endif

 pinctrl_gpio_free(gc, offset);
}
EXPORT_SYMBOL_GPL(gpiochip_generic_free);

/**
 * gpiochip_generic_config() - apply configuration for a pin
 * @gc: the gpiochip owning the GPIO
 * @offset: the offset of the GPIO to apply the configuration
 * @config: the configuration to be applied
 *
 * Returns:
 * 0 on success, or negative errno on failure.
 */
int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
       unsigned long config)
{
#ifdef CONFIG_PINCTRL
 if (list_empty(&gc->gpiodev->pin_ranges))
  return -ENOTSUPP;
#endif

 return pinctrl_gpio_set_config(gc, offset, config);
}
EXPORT_SYMBOL_GPL(gpiochip_generic_config);

#ifdef CONFIG_PINCTRL

/**
 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
 * @gc: the gpiochip to add the range for
 * @pctldev: the pin controller to map to
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_group: name of the pin group inside the pin controller
 *
 * Calling this function directly from a DeviceTree-supported
 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
 *
 * Returns:
 * 0 on success, or negative errno on failure.
 */
int gpiochip_add_pingroup_range(struct gpio_chip *gc,
   struct pinctrl_dev *pctldev,
   unsigned int gpio_offset, const char *pin_group)
{
 struct gpio_pin_range *pin_range;
 struct gpio_device *gdev = gc->gpiodev;
 int ret;

 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
 if (!pin_range) {
  chip_err(gc, "failed to allocate pin ranges\n");
  return -ENOMEM;
 }

 /* Use local offset as range ID */
 pin_range->range.id = gpio_offset;
 pin_range->range.gc = gc;
 pin_range->range.name = gc->label;
 pin_range->range.base = gdev->base + gpio_offset;
 pin_range->pctldev = pctldev;

 ret = pinctrl_get_group_pins(pctldev, pin_group,
     &pin_range->range.pins,
     &pin_range->range.npins);
 if (ret < 0) {
  kfree(pin_range);
  return ret;
 }

 pinctrl_add_gpio_range(pctldev, &pin_range->range);

 chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
   gpio_offset, gpio_offset + pin_range->range.npins - 1,
   pinctrl_dev_get_devname(pctldev), pin_group);

 list_add_tail(&pin_range->node, &gdev->pin_ranges);

 return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);

/**
 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
 * @gc: the gpiochip to add the range for
 * @pinctl_name: the dev_name() of the pin controller to map to
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_offset: the start offset in the pin controller number space
 * @npins: the number of pins from the offset of each pin space (GPIO and
 * pin controller) to accumulate in this range
 *
 * Calling this function directly from a DeviceTree-supported
 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
 *
 * Returns:
 * 0 on success, or a negative errno on failure.
 */
int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
      unsigned int gpio_offset, unsigned int pin_offset,
      unsigned int npins)
{
 struct gpio_pin_range *pin_range;
 struct gpio_device *gdev = gc->gpiodev;
 int ret;

 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
 if (!pin_range) {
  chip_err(gc, "failed to allocate pin ranges\n");
  return -ENOMEM;
 }

 /* Use local offset as range ID */
 pin_range->range.id = gpio_offset;
 pin_range->range.gc = gc;
 pin_range->range.name = gc->label;
 pin_range->range.base = gdev->base + gpio_offset;
 pin_range->range.pin_base = pin_offset;
 pin_range->range.npins = npins;
 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
   &pin_range->range);
 if (IS_ERR(pin_range->pctldev)) {
  ret = PTR_ERR(pin_range->pctldev);
  chip_err(gc, "could not create pin range\n");
  kfree(pin_range);
  return ret;
 }
 chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
   gpio_offset, gpio_offset + npins - 1,
   pinctl_name,
   pin_offset, pin_offset + npins - 1);

 list_add_tail(&pin_range->node, &gdev->pin_ranges);

 return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);

/**
 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
 * @gc: the chip to remove all the mappings for
 */
void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
{
 struct gpio_pin_range *pin_range, *tmp;
 struct gpio_device *gdev = gc->gpiodev;

 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
  list_del(&pin_range->node);
  pinctrl_remove_gpio_range(pin_range->pctldev,
    &pin_range->range);
  kfree(pin_range);
 }
}
EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);

#endif /* CONFIG_PINCTRL */

/* These "optional" allocation calls help prevent drivers from stomping
 * on each other, and help provide better diagnostics in debugfs.
 * They're called even less than the "set direction" calls.
 */
static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
{
 unsigned int offset;
 int ret;

 CLASS(gpio_chip_guard, guard)(desc);
 if (!guard.gc)
  return -ENODEV;

 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags))
  return -EBUSY;

 offset = gpio_chip_hwgpio(desc);
 if (!gpiochip_line_is_valid(guard.gc, offset))
  return -EINVAL;

 /* NOTE:  gpio_request() can be called in early boot,
 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
 */

 if (guard.gc->request) {
  ret = guard.gc->request(guard.gc, offset);
  if (ret > 0)
   ret = -EBADE;
  if (ret)
   goto out_clear_bit;
 }

 if (guard.gc->get_direction)
  gpiod_get_direction(desc);

 ret = desc_set_label(desc, label ? : "?");
 if (ret)
  goto out_clear_bit;

 return 0;

out_clear_bit:
 clear_bit(FLAG_REQUESTED, &desc->flags);
 return ret;
}

int gpiod_request(struct gpio_desc *desc, const char *label)
{
 int ret = -EPROBE_DEFER;

 VALIDATE_DESC(desc);

--> --------------------

--> maximum size reached

--> --------------------