drivers/gpio/gpiolib.c

   1 // SPDX-License-Identifier: GPL-2.0
   2
   3 #include <linux/bitmap.h>
   4 #include <linux/kernel.h>
   5 #include <linux/module.h>
   6 #include <linux/interrupt.h>
   7 #include <linux/irq.h>
   8 #include <linux/spinlock.h>
   9 #include <linux/list.h>
  10 #include <linux/device.h>
  11 #include <linux/err.h>
  12 #include <linux/debugfs.h>
  13 #include <linux/seq_file.h>
  14 #include <linux/gpio.h>
  15 #include <linux/idr.h>
  16 #include <linux/slab.h>
  17 #include <linux/acpi.h>
  18 #include <linux/gpio/driver.h>
  19 #include <linux/gpio/machine.h>
  20 #include <linux/pinctrl/consumer.h>
  21 #include <linux/fs.h>
  22 #include <linux/compat.h>
  23 #include <linux/file.h>
  24 #include <uapi/linux/gpio.h>
  25
  26 #include "gpiolib.h"
  27 #include "gpiolib-of.h"
  28 #include "gpiolib-acpi.h"
  29 #include "gpiolib-cdev.h"
  30 #include "gpiolib-sysfs.h"
  31
  32 #define CREATE_TRACE_POINTS
  33 #include <trace/events/gpio.h>
  34
  35 /* Implementation infrastructure for GPIO interfaces.
  36  *
  37  * The GPIO programming interface allows for inlining speed-critical
  38  * get/set operations for common cases, so that access to SOC-integrated
  39  * GPIOs can sometimes cost only an instruction or two per bit.
  40  */
  41
  42
  43 /* When debugging, extend minimal trust to callers and platform code.
  44  * Also emit diagnostic messages that may help initial bringup, when
  45  * board setup or driver bugs are most common.
  46  *
  47  * Otherwise, minimize overhead in what may be bitbanging codepaths.
  48  */
  49 #ifdef  DEBUG
  50 #define extra_checks    1
  51 #else
  52 #define extra_checks    0
  53 #endif
  54
  55 /* Device and char device-related information */
  56 static DEFINE_IDA(gpio_ida);
  57 static dev_t gpio_devt;
  58 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
  59 static int gpio_bus_match(struct device *dev, struct device_driver *drv);
  60 static struct bus_type gpio_bus_type = {
  61         .name = "gpio",
  62         .match = gpio_bus_match,
  63 };
  64
  65 /*
  66  * Number of GPIOs to use for the fast path in set array
  67  */
  68 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
  69
  70 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
  71  * While any GPIO is requested, its gpio_chip is not removable;
  72  * each GPIO's "requested" flag serves as a lock and refcount.
  73  */
  74 DEFINE_SPINLOCK(gpio_lock);
  75
  76 static DEFINE_MUTEX(gpio_lookup_lock);
  77 static LIST_HEAD(gpio_lookup_list);
  78 LIST_HEAD(gpio_devices);
  79
  80 static DEFINE_MUTEX(gpio_machine_hogs_mutex);
  81 static LIST_HEAD(gpio_machine_hogs);
  82
  83 static void gpiochip_free_hogs(struct gpio_chip *gc);
  84 static int gpiochip_add_irqchip(struct gpio_chip *gc,
  85                                 struct lock_class_key *lock_key,
  86                                 struct lock_class_key *request_key);
  87 static void gpiochip_irqchip_remove(struct gpio_chip *gc);
  88 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc);
  89 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc);
  90 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc);
  91
  92 static bool gpiolib_initialized;
  93
  94 static inline void desc_set_label(struct gpio_desc *d, const char *label)
  95 {
  96         d->label = label;
  97 }
  98
  99 /**
 100  * gpio_to_desc - Convert a GPIO number to its descriptor
 101  * @gpio: global GPIO number
 102  *
 103  * Returns:
 104  * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
 105  * with the given number exists in the system.
 106  */
 107 struct gpio_desc *gpio_to_desc(unsigned gpio)
 108 {
 109         struct gpio_device *gdev;
 110         unsigned long flags;
 111
 112         spin_lock_irqsave(&gpio_lock, flags);
 113
 114         list_for_each_entry(gdev, &gpio_devices, list) {
 115                 if (gdev->base <= gpio &&
 116                     gdev->base + gdev->ngpio > gpio) {
 117                         spin_unlock_irqrestore(&gpio_lock, flags);
 118                         return &gdev->descs[gpio - gdev->base];
 119                 }
 120         }
 121
 122         spin_unlock_irqrestore(&gpio_lock, flags);
 123
 124         if (!gpio_is_valid(gpio))
 125                 pr_warn("invalid GPIO %d\n", gpio);
 126
 127         return NULL;
 128 }
 129 EXPORT_SYMBOL_GPL(gpio_to_desc);
 130
 131 /**
 132  * gpiochip_get_desc - get the GPIO descriptor corresponding to the given
 133  *                     hardware number for this chip
 134  * @gc: GPIO chip
 135  * @hwnum: hardware number of the GPIO for this chip
 136  *
 137  * Returns:
 138  * A pointer to the GPIO descriptor or ``ERR_PTR(-EINVAL)`` if no GPIO exists
 139  * in the given chip for the specified hardware number.
 140  */
 141 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc,
 142                                     unsigned int hwnum)
 143 {
 144         struct gpio_device *gdev = gc->gpiodev;
 145
 146         if (hwnum >= gdev->ngpio)
 147                 return ERR_PTR(-EINVAL);
 148
 149         return &gdev->descs[hwnum];
 150 }
 151 EXPORT_SYMBOL_GPL(gpiochip_get_desc);
 152
 153 /**
 154  * desc_to_gpio - convert a GPIO descriptor to the integer namespace
 155  * @desc: GPIO descriptor
 156  *
 157  * This should disappear in the future but is needed since we still
 158  * use GPIO numbers for error messages and sysfs nodes.
 159  *
 160  * Returns:
 161  * The global GPIO number for the GPIO specified by its descriptor.
 162  */
 163 int desc_to_gpio(const struct gpio_desc *desc)
 164 {
 165         return desc->gdev->base + (desc - &desc->gdev->descs[0]);
 166 }
 167 EXPORT_SYMBOL_GPL(desc_to_gpio);
 168
 169
 170 /**
 171  * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
 172  * @desc:       descriptor to return the chip of
 173  */
 174 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
 175 {
 176         if (!desc || !desc->gdev)
 177                 return NULL;
 178         return desc->gdev->chip;
 179 }
 180 EXPORT_SYMBOL_GPL(gpiod_to_chip);
 181
 182 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
 183 static int gpiochip_find_base(int ngpio)
 184 {
 185         struct gpio_device *gdev;
 186         int base = ARCH_NR_GPIOS - ngpio;
 187
 188         list_for_each_entry_reverse(gdev, &gpio_devices, list) {
 189                 /* found a free space? */
 190                 if (gdev->base + gdev->ngpio <= base)
 191                         break;
 192                 /* nope, check the space right before the chip */
 193                 base = gdev->base - ngpio;
 194         }
 195
 196         if (gpio_is_valid(base)) {
 197                 pr_debug("%s: found new base at %d\n", __func__, base);
 198                 return base;
 199         } else {
 200                 pr_err("%s: cannot find free range\n", __func__);
 201                 return -ENOSPC;
 202         }
 203 }
 204
 205 /**
 206  * gpiod_get_direction - return the current direction of a GPIO
 207  * @desc:       GPIO to get the direction of
 208  *
 209  * Returns 0 for output, 1 for input, or an error code in case of error.
 210  *
 211  * This function may sleep if gpiod_cansleep() is true.
 212  */
 213 int gpiod_get_direction(struct gpio_desc *desc)
 214 {
 215         struct gpio_chip *gc;
 216         unsigned int offset;
 217         int ret;
 218
 219         gc = gpiod_to_chip(desc);
 220         offset = gpio_chip_hwgpio(desc);
 221
 222         /*
 223          * Open drain emulation using input mode may incorrectly report
 224          * input here, fix that up.
 225          */
 226         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) &&
 227             test_bit(FLAG_IS_OUT, &desc->flags))
 228                 return 0;
 229
 230         if (!gc->get_direction)
 231                 return -ENOTSUPP;
 232
 233         ret = gc->get_direction(gc, offset);
 234         if (ret < 0)
 235                 return ret;
 236
 237         /* GPIOF_DIR_IN or other positive, otherwise GPIOF_DIR_OUT */
 238         if (ret > 0)
 239                 ret = 1;
 240
 241         assign_bit(FLAG_IS_OUT, &desc->flags, !ret);
 242
 243         return ret;
 244 }
 245 EXPORT_SYMBOL_GPL(gpiod_get_direction);
 246
 247 /*
 248  * Add a new chip to the global chips list, keeping the list of chips sorted
 249  * by range(means [base, base + ngpio - 1]) order.
 250  *
 251  * Return -EBUSY if the new chip overlaps with some other chip's integer
 252  * space.
 253  */
 254 static int gpiodev_add_to_list(struct gpio_device *gdev)
 255 {
 256         struct gpio_device *prev, *next;
 257
 258         if (list_empty(&gpio_devices)) {
 259                 /* initial entry in list */
 260                 list_add_tail(&gdev->list, &gpio_devices);
 261                 return 0;
 262         }
 263
 264         next = list_first_entry(&gpio_devices, struct gpio_device, list);
 265         if (gdev->base + gdev->ngpio <= next->base) {
 266                 /* add before first entry */
 267                 list_add(&gdev->list, &gpio_devices);
 268                 return 0;
 269         }
 270
 271         prev = list_last_entry(&gpio_devices, struct gpio_device, list);
 272         if (prev->base + prev->ngpio <= gdev->base) {
 273                 /* add behind last entry */
 274                 list_add_tail(&gdev->list, &gpio_devices);
 275                 return 0;
 276         }
 277
 278         list_for_each_entry_safe(prev, next, &gpio_devices, list) {
 279                 /* at the end of the list */
 280                 if (&next->list == &gpio_devices)
 281                         break;
 282
 283                 /* add between prev and next */
 284                 if (prev->base + prev->ngpio <= gdev->base
 285                                 && gdev->base + gdev->ngpio <= next->base) {
 286                         list_add(&gdev->list, &prev->list);
 287                         return 0;
 288                 }
 289         }
 290
 291         return -EBUSY;
 292 }
 293
 294 /*
 295  * Convert a GPIO name to its descriptor
 296  * Note that there is no guarantee that GPIO names are globally unique!
 297  * Hence this function will return, if it exists, a reference to the first GPIO
 298  * line found that matches the given name.
 299  */
 300 static struct gpio_desc *gpio_name_to_desc(const char * const name)
 301 {
 302         struct gpio_device *gdev;
 303         unsigned long flags;
 304
 305         if (!name)
 306                 return NULL;
 307
 308         spin_lock_irqsave(&gpio_lock, flags);
 309
 310         list_for_each_entry(gdev, &gpio_devices, list) {
 311                 struct gpio_desc *desc;
 312
 313                 for_each_gpio_desc(gdev->chip, desc) {
 314                         if (desc->name && !strcmp(desc->name, name)) {
 315                                 spin_unlock_irqrestore(&gpio_lock, flags);
 316                                 return desc;
 317                         }
 318                 }
 319         }
 320
 321         spin_unlock_irqrestore(&gpio_lock, flags);
 322
 323         return NULL;
 324 }
 325
 326 /*
 327  * Take the names from gc->names and assign them to their GPIO descriptors.
 328  * Warn if a name is already used for a GPIO line on a different GPIO chip.
 329  *
 330  * Note that:
 331  *   1. Non-unique names are still accepted,
 332  *   2. Name collisions within the same GPIO chip are not reported.
 333  */
 334 static int gpiochip_set_desc_names(struct gpio_chip *gc)
 335 {
 336         struct gpio_device *gdev = gc->gpiodev;
 337         int i;
 338
 339         /* First check all names if they are unique */
 340         for (i = 0; i != gc->ngpio; ++i) {
 341                 struct gpio_desc *gpio;
 342
 343                 gpio = gpio_name_to_desc(gc->names[i]);
 344                 if (gpio)
 345                         dev_warn(&gdev->dev,
 346                                  "Detected name collision for GPIO name '%s'\n",
 347                                  gc->names[i]);
 348         }
 349
 350         /* Then add all names to the GPIO descriptors */
 351         for (i = 0; i != gc->ngpio; ++i)
 352                 gdev->descs[i].name = gc->names[i];
 353
 354         return 0;
 355 }
 356
 357 /*
 358  * devprop_gpiochip_set_names - Set GPIO line names using device properties
 359  * @chip: GPIO chip whose lines should be named, if possible
 360  *
 361  * Looks for device property "gpio-line-names" and if it exists assigns
 362  * GPIO line names for the chip. The memory allocated for the assigned
 363  * names belong to the underlying firmware node and should not be released
 364  * by the caller.
 365  */
 366 static int devprop_gpiochip_set_names(struct gpio_chip *chip)
 367 {
 368         struct gpio_device *gdev = chip->gpiodev;
 369         struct fwnode_handle *fwnode = dev_fwnode(&gdev->dev);
 370         const char **names;
 371         int ret, i;
 372         int count;
 373
 374         count = fwnode_property_string_array_count(fwnode, "gpio-line-names");
 375         if (count < 0)
 376                 return 0;
 377
 378         /*
 379          * When offset is set in the driver side we assume the driver internally
 380          * is using more than one gpiochip per the same device. We have to stop
 381          * setting friendly names if the specified ones with 'gpio-line-names'
 382          * are less than the offset in the device itself. This means all the
 383          * lines are not present for every single pin within all the internal
 384          * gpiochips.
 385          */
 386         if (count <= chip->offset) {
 387                 dev_warn(&gdev->dev, "gpio-line-names too short (length %d), cannot map names for the gpiochip at offset %u\n",
 388                          count, chip->offset);
 389                 return 0;
 390         }
 391
 392         names = kcalloc(count, sizeof(*names), GFP_KERNEL);
 393         if (!names)
 394                 return -ENOMEM;
 395
 396         ret = fwnode_property_read_string_array(fwnode, "gpio-line-names",
 397                                                 names, count);
 398         if (ret < 0) {
 399                 dev_warn(&gdev->dev, "failed to read GPIO line names\n");
 400                 kfree(names);
 401                 return ret;
 402         }
 403
 404         /*
 405          * When more that one gpiochip per device is used, 'count' can
 406          * contain at most number gpiochips x chip->ngpio. We have to
 407          * correctly distribute all defined lines taking into account
 408          * chip->offset as starting point from where we will assign
 409          * the names to pins from the 'names' array. Since property
 410          * 'gpio-line-names' cannot contains gaps, we have to be sure
 411          * we only assign those pins that really exists since chip->ngpio
 412          * can be different of the chip->offset.
 413          */
 414         count = (count > chip->offset) ? count - chip->offset : count;
 415         if (count > chip->ngpio)
 416                 count = chip->ngpio;
 417
 418         for (i = 0; i < count; i++) {
 419                 /*
 420                  * Allow overriding "fixed" names provided by the GPIO
 421                  * provider. The "fixed" names are more often than not
 422                  * generic and less informative than the names given in
 423                  * device properties.
 424                  */
 425                 if (names[chip->offset + i] && names[chip->offset + i][0])
 426                         gdev->descs[i].name = names[chip->offset + i];
 427         }
 428
 429         kfree(names);
 430
 431         return 0;
 432 }
 433
 434 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *gc)
 435 {
 436         unsigned long *p;
 437
 438         p = bitmap_alloc(gc->ngpio, GFP_KERNEL);
 439         if (!p)
 440                 return NULL;
 441
 442         /* Assume by default all GPIOs are valid */
 443         bitmap_fill(p, gc->ngpio);
 444
 445         return p;
 446 }
 447
 448 static int gpiochip_alloc_valid_mask(struct gpio_chip *gc)
 449 {
 450         if (!(of_gpio_need_valid_mask(gc) || gc->init_valid_mask))
 451                 return 0;
 452
 453         gc->valid_mask = gpiochip_allocate_mask(gc);
 454         if (!gc->valid_mask)
 455                 return -ENOMEM;
 456
 457         return 0;
 458 }
 459
 460 static int gpiochip_init_valid_mask(struct gpio_chip *gc)
 461 {
 462         if (gc->init_valid_mask)
 463                 return gc->init_valid_mask(gc,
 464                                            gc->valid_mask,
 465                                            gc->ngpio);
 466
 467         return 0;
 468 }
 469
 470 static void gpiochip_free_valid_mask(struct gpio_chip *gc)
 471 {
 472         bitmap_free(gc->valid_mask);
 473         gc->valid_mask = NULL;
 474 }
 475
 476 static int gpiochip_add_pin_ranges(struct gpio_chip *gc)
 477 {
 478         if (gc->add_pin_ranges)
 479                 return gc->add_pin_ranges(gc);
 480
 481         return 0;
 482 }
 483
 484 bool gpiochip_line_is_valid(const struct gpio_chip *gc,
 485                                 unsigned int offset)
 486 {
 487         /* No mask means all valid */
 488         if (likely(!gc->valid_mask))
 489                 return true;
 490         return test_bit(offset, gc->valid_mask);
 491 }
 492 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
 493
 494 static void gpiodevice_release(struct device *dev)
 495 {
 496         struct gpio_device *gdev = container_of(dev, struct gpio_device, dev);
 497         unsigned long flags;
 498
 499         spin_lock_irqsave(&gpio_lock, flags);
 500         list_del(&gdev->list);
 501         spin_unlock_irqrestore(&gpio_lock, flags);
 502
 503         ida_free(&gpio_ida, gdev->id);
 504         kfree_const(gdev->label);
 505         kfree(gdev->descs);
 506         kfree(gdev);
 507 }
 508
 509 #ifdef CONFIG_GPIO_CDEV
 510 #define gcdev_register(gdev, devt)      gpiolib_cdev_register((gdev), (devt))
 511 #define gcdev_unregister(gdev)          gpiolib_cdev_unregister((gdev))
 512 #else
 513 /*
 514  * gpiolib_cdev_register() indirectly calls device_add(), which is still
 515  * required even when cdev is not selected.
 516  */
 517 #define gcdev_register(gdev, devt)      device_add(&(gdev)->dev)
 518 #define gcdev_unregister(gdev)          device_del(&(gdev)->dev)
 519 #endif
 520
 521 static int gpiochip_setup_dev(struct gpio_device *gdev)
 522 {
 523         int ret;
 524
 525         ret = gcdev_register(gdev, gpio_devt);
 526         if (ret)
 527                 return ret;
 528
 529         ret = gpiochip_sysfs_register(gdev);
 530         if (ret)
 531                 goto err_remove_device;
 532
 533         /* From this point, the .release() function cleans up gpio_device */
 534         gdev->dev.release = gpiodevice_release;
 535         dev_dbg(&gdev->dev, "registered GPIOs %d to %d on %s\n", gdev->base,
 536                 gdev->base + gdev->ngpio - 1, gdev->chip->label ? : "generic");
 537
 538         return 0;
 539
 540 err_remove_device:
 541         gcdev_unregister(gdev);
 542         return ret;
 543 }
 544
 545 static void gpiochip_machine_hog(struct gpio_chip *gc, struct gpiod_hog *hog)
 546 {
 547         struct gpio_desc *desc;
 548         int rv;
 549
 550         desc = gpiochip_get_desc(gc, hog->chip_hwnum);
 551         if (IS_ERR(desc)) {
 552                 chip_err(gc, "%s: unable to get GPIO desc: %ld\n", __func__,
 553                          PTR_ERR(desc));
 554                 return;
 555         }
 556
 557         if (test_bit(FLAG_IS_HOGGED, &desc->flags))
 558                 return;
 559
 560         rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
 561         if (rv)
 562                 gpiod_err(desc, "%s: unable to hog GPIO line (%s:%u): %d\n",
 563                           __func__, gc->label, hog->chip_hwnum, rv);
 564 }
 565
 566 static void machine_gpiochip_add(struct gpio_chip *gc)
 567 {
 568         struct gpiod_hog *hog;
 569
 570         mutex_lock(&gpio_machine_hogs_mutex);
 571
 572         list_for_each_entry(hog, &gpio_machine_hogs, list) {
 573                 if (!strcmp(gc->label, hog->chip_label))
 574                         gpiochip_machine_hog(gc, hog);
 575         }
 576
 577         mutex_unlock(&gpio_machine_hogs_mutex);
 578 }
 579
 580 static void gpiochip_setup_devs(void)
 581 {
 582         struct gpio_device *gdev;
 583         int ret;
 584
 585         list_for_each_entry(gdev, &gpio_devices, list) {
 586                 ret = gpiochip_setup_dev(gdev);
 587                 if (ret)
 588                         dev_err(&gdev->dev,
 589                                 "Failed to initialize gpio device (%d)\n", ret);
 590         }
 591 }
 592
 593 int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 594                                struct lock_class_key *lock_key,
 595                                struct lock_class_key *request_key)
 596 {
 597         struct fwnode_handle *fwnode = NULL;
 598         struct gpio_device *gdev;
 599         unsigned long flags;
 600         int base = gc->base;
 601         unsigned int i;
 602         int ret = 0;
 603         u32 ngpios;
 604
 605         if (gc->fwnode)
 606                 fwnode = gc->fwnode;
 607         else if (gc->parent)
 608                 fwnode = dev_fwnode(gc->parent);
 609
 610         /*
 611          * First: allocate and populate the internal stat container, and
 612          * set up the struct device.
 613          */
 614         gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
 615         if (!gdev)
 616                 return -ENOMEM;
 617         gdev->dev.bus = &gpio_bus_type;
 618         gdev->dev.parent = gc->parent;
 619         gdev->chip = gc;
 620         gc->gpiodev = gdev;
 621
 622         of_gpio_dev_init(gc, gdev);
 623         acpi_gpio_dev_init(gc, gdev);
 624
 625         /*
 626          * Assign fwnode depending on the result of the previous calls,
 627          * if none of them succeed, assign it to the parent's one.
 628          */
 629         gdev->dev.fwnode = dev_fwnode(&gdev->dev) ?: fwnode;
 630
 631         gdev->id = ida_alloc(&gpio_ida, GFP_KERNEL);
 632         if (gdev->id < 0) {
 633                 ret = gdev->id;
 634                 goto err_free_gdev;
 635         }
 636
 637         ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
 638         if (ret)
 639                 goto err_free_ida;
 640
 641         device_initialize(&gdev->dev);
 642         if (gc->parent && gc->parent->driver)
 643                 gdev->owner = gc->parent->driver->owner;
 644         else if (gc->owner)
 645                 /* TODO: remove chip->owner */
 646                 gdev->owner = gc->owner;
 647         else
 648                 gdev->owner = THIS_MODULE;
 649
 650         gdev->descs = kcalloc(gc->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
 651         if (!gdev->descs) {
 652                 ret = -ENOMEM;
 653                 goto err_free_dev_name;
 654         }
 655
 656         /*
 657          * Try the device properties if the driver didn't supply the number
 658          * of GPIO lines.
 659          */
 660         if (gc->ngpio == 0) {
 661                 ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
 662                 if (ret == -ENODATA)
 663                         /*
 664                          * -ENODATA means that there is no property found and
 665                          * we want to issue the error message to the user.
 666                          * Besides that, we want to return different error code
 667                          * to state that supplied value is not valid.
 668                          */
 669                         ngpios = 0;
 670                 else if (ret)
 671                         goto err_free_descs;
 672
 673                 gc->ngpio = ngpios;
 674         }
 675
 676         if (gc->ngpio == 0) {
 677                 chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
 678                 ret = -EINVAL;
 679                 goto err_free_descs;
 680         }
 681
 682         if (gc->ngpio > FASTPATH_NGPIO)
 683                 chip_warn(gc, "line cnt %u is greater than fast path cnt %u\n",
 684                           gc->ngpio, FASTPATH_NGPIO);
 685
 686         gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
 687         if (!gdev->label) {
 688                 ret = -ENOMEM;
 689                 goto err_free_descs;
 690         }
 691
 692         gdev->ngpio = gc->ngpio;
 693         gdev->data = data;
 694
 695         spin_lock_irqsave(&gpio_lock, flags);
 696
 697         /*
 698          * TODO: this allocates a Linux GPIO number base in the global
 699          * GPIO numberspace for this chip. In the long run we want to
 700          * get *rid* of this numberspace and use only descriptors, but
 701          * it may be a pipe dream. It will not happen before we get rid
 702          * of the sysfs interface anyways.
 703          */
 704         if (base < 0) {
 705                 base = gpiochip_find_base(gc->ngpio);
 706                 if (base < 0) {
 707                         ret = base;
 708                         spin_unlock_irqrestore(&gpio_lock, flags);
 709                         goto err_free_label;
 710                 }
 711                 /*
 712                  * TODO: it should not be necessary to reflect the assigned
 713                  * base outside of the GPIO subsystem. Go over drivers and
 714                  * see if anyone makes use of this, else drop this and assign
 715                  * a poison instead.
 716                  */
 717                 gc->base = base;
 718         }
 719         gdev->base = base;
 720
 721         ret = gpiodev_add_to_list(gdev);
 722         if (ret) {
 723                 spin_unlock_irqrestore(&gpio_lock, flags);
 724                 chip_err(gc, "GPIO integer space overlap, cannot add chip\n");
 725                 goto err_free_label;
 726         }
 727
 728         for (i = 0; i < gc->ngpio; i++)
 729                 gdev->descs[i].gdev = gdev;
 730
 731         spin_unlock_irqrestore(&gpio_lock, flags);
 732
 733         BLOCKING_INIT_NOTIFIER_HEAD(&gdev->notifier);
 734
 735 #ifdef CONFIG_PINCTRL
 736         INIT_LIST_HEAD(&gdev->pin_ranges);
 737 #endif
 738
 739         if (gc->names) {
 740                 ret = gpiochip_set_desc_names(gc);
 741                 if (ret)
 742                         goto err_remove_from_list;
 743         }
 744         ret = devprop_gpiochip_set_names(gc);
 745         if (ret)
 746                 goto err_remove_from_list;
 747
 748         ret = gpiochip_alloc_valid_mask(gc);
 749         if (ret)
 750                 goto err_remove_from_list;
 751
 752         ret = of_gpiochip_add(gc);
 753         if (ret)
 754                 goto err_free_gpiochip_mask;
 755
 756         ret = gpiochip_init_valid_mask(gc);
 757         if (ret)
 758                 goto err_remove_of_chip;
 759
 760         for (i = 0; i < gc->ngpio; i++) {
 761                 struct gpio_desc *desc = &gdev->descs[i];
 762
 763                 if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
 764                         assign_bit(FLAG_IS_OUT,
 765                                    &desc->flags, !gc->get_direction(gc, i));
 766                 } else {
 767                         assign_bit(FLAG_IS_OUT,
 768                                    &desc->flags, !gc->direction_input);
 769                 }
 770         }
 771
 772         ret = gpiochip_add_pin_ranges(gc);
 773         if (ret)
 774                 goto err_remove_of_chip;
 775
 776         acpi_gpiochip_add(gc);
 777
 778         machine_gpiochip_add(gc);
 779
 780         ret = gpiochip_irqchip_init_valid_mask(gc);
 781         if (ret)
 782                 goto err_remove_acpi_chip;
 783
 784         ret = gpiochip_irqchip_init_hw(gc);
 785         if (ret)
 786                 goto err_remove_acpi_chip;
 787
 788         ret = gpiochip_add_irqchip(gc, lock_key, request_key);
 789         if (ret)
 790                 goto err_remove_irqchip_mask;
 791
 792         /*
 793          * By first adding the chardev, and then adding the device,
 794          * we get a device node entry in sysfs under
 795          * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
 796          * coldplug of device nodes and other udev business.
 797          * We can do this only if gpiolib has been initialized.
 798          * Otherwise, defer until later.
 799          */
 800         if (gpiolib_initialized) {
 801                 ret = gpiochip_setup_dev(gdev);
 802                 if (ret)
 803                         goto err_remove_irqchip;
 804         }
 805         return 0;
 806
 807 err_remove_irqchip:
 808         gpiochip_irqchip_remove(gc);
 809 err_remove_irqchip_mask:
 810         gpiochip_irqchip_free_valid_mask(gc);
 811 err_remove_acpi_chip:
 812         acpi_gpiochip_remove(gc);
 813 err_remove_of_chip:
 814         gpiochip_free_hogs(gc);
 815         of_gpiochip_remove(gc);
 816 err_free_gpiochip_mask:
 817         gpiochip_remove_pin_ranges(gc);
 818         gpiochip_free_valid_mask(gc);
 819 err_remove_from_list:
 820         spin_lock_irqsave(&gpio_lock, flags);
 821         list_del(&gdev->list);
 822         spin_unlock_irqrestore(&gpio_lock, flags);
 823 err_free_label:
 824         kfree_const(gdev->label);
 825 err_free_descs:
 826         kfree(gdev->descs);
 827 err_free_dev_name:
 828         kfree(dev_name(&gdev->dev));
 829 err_free_ida:
 830         ida_free(&gpio_ida, gdev->id);
 831 err_free_gdev:
 832         /* failures here can mean systems won't boot... */
 833         if (ret != -EPROBE_DEFER) {
 834                 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
 835                        gdev->base, gdev->base + gdev->ngpio - 1,
 836                        gc->label ? : "generic", ret);
 837         }
 838         kfree(gdev);
 839         return ret;
 840 }
 841 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
 842
 843 /**
 844  * gpiochip_get_data() - get per-subdriver data for the chip
 845  * @gc: GPIO chip
 846  *
 847  * Returns:
 848  * The per-subdriver data for the chip.
 849  */
 850 void *gpiochip_get_data(struct gpio_chip *gc)
 851 {
 852         return gc->gpiodev->data;
 853 }
 854 EXPORT_SYMBOL_GPL(gpiochip_get_data);
 855
 856 /**
 857  * gpiochip_remove() - unregister a gpio_chip
 858  * @gc: the chip to unregister
 859  *
 860  * A gpio_chip with any GPIOs still requested may not be removed.
 861  */
 862 void gpiochip_remove(struct gpio_chip *gc)
 863 {
 864         struct gpio_device *gdev = gc->gpiodev;
 865         unsigned long   flags;
 866         unsigned int    i;
 867
 868         /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
 869         gpiochip_sysfs_unregister(gdev);
 870         gpiochip_free_hogs(gc);
 871         /* Numb the device, cancelling all outstanding operations */
 872         gdev->chip = NULL;
 873         gpiochip_irqchip_remove(gc);
 874         acpi_gpiochip_remove(gc);
 875         of_gpiochip_remove(gc);
 876         gpiochip_remove_pin_ranges(gc);
 877         gpiochip_free_valid_mask(gc);
 878         /*
 879          * We accept no more calls into the driver from this point, so
 880          * NULL the driver data pointer
 881          */
 882         gdev->data = NULL;
 883
 884         spin_lock_irqsave(&gpio_lock, flags);
 885         for (i = 0; i < gdev->ngpio; i++) {
 886                 if (gpiochip_is_requested(gc, i))
 887                         break;
 888         }
 889         spin_unlock_irqrestore(&gpio_lock, flags);
 890
 891         if (i != gdev->ngpio)
 892                 dev_crit(&gdev->dev,
 893                          "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
 894
 895         /*
 896          * The gpiochip side puts its use of the device to rest here:
 897          * if there are no userspace clients, the chardev and device will
 898          * be removed, else it will be dangling until the last user is
 899          * gone.
 900          */
 901         gcdev_unregister(gdev);
 902         put_device(&gdev->dev);
 903 }
 904 EXPORT_SYMBOL_GPL(gpiochip_remove);
 905
 906 /**
 907  * gpiochip_find() - iterator for locating a specific gpio_chip
 908  * @data: data to pass to match function
 909  * @match: Callback function to check gpio_chip
 910  *
 911  * Similar to bus_find_device.  It returns a reference to a gpio_chip as
 912  * determined by a user supplied @match callback.  The callback should return
 913  * 0 if the device doesn't match and non-zero if it does.  If the callback is
 914  * non-zero, this function will return to the caller and not iterate over any
 915  * more gpio_chips.
 916  */
 917 struct gpio_chip *gpiochip_find(void *data,
 918                                 int (*match)(struct gpio_chip *gc,
 919                                              void *data))
 920 {
 921         struct gpio_device *gdev;
 922         struct gpio_chip *gc = NULL;
 923         unsigned long flags;
 924
 925         spin_lock_irqsave(&gpio_lock, flags);
 926         list_for_each_entry(gdev, &gpio_devices, list)
 927                 if (gdev->chip && match(gdev->chip, data)) {
 928                         gc = gdev->chip;
 929                         break;
 930                 }
 931
 932         spin_unlock_irqrestore(&gpio_lock, flags);
 933
 934         return gc;
 935 }
 936 EXPORT_SYMBOL_GPL(gpiochip_find);
 937
 938 static int gpiochip_match_name(struct gpio_chip *gc, void *data)
 939 {
 940         const char *name = data;
 941
 942         return !strcmp(gc->label, name);
 943 }
 944
 945 static struct gpio_chip *find_chip_by_name(const char *name)
 946 {
 947         return gpiochip_find((void *)name, gpiochip_match_name);
 948 }
 949
 950 #ifdef CONFIG_GPIOLIB_IRQCHIP
 951
 952 /*
 953  * The following is irqchip helper code for gpiochips.
 954  */
 955
 956 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
 957 {
 958         struct gpio_irq_chip *girq = &gc->irq;
 959
 960         if (!girq->init_hw)
 961                 return 0;
 962
 963         return girq->init_hw(gc);
 964 }
 965
 966 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
 967 {
 968         struct gpio_irq_chip *girq = &gc->irq;
 969
 970         if (!girq->init_valid_mask)
 971                 return 0;
 972
 973         girq->valid_mask = gpiochip_allocate_mask(gc);
 974         if (!girq->valid_mask)
 975                 return -ENOMEM;
 976
 977         girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
 978
 979         return 0;
 980 }
 981
 982 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
 983 {
 984         bitmap_free(gc->irq.valid_mask);
 985         gc->irq.valid_mask = NULL;
 986 }
 987
 988 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
 989                                 unsigned int offset)
 990 {
 991         if (!gpiochip_line_is_valid(gc, offset))
 992                 return false;
 993         /* No mask means all valid */
 994         if (likely(!gc->irq.valid_mask))
 995                 return true;
 996         return test_bit(offset, gc->irq.valid_mask);
 997 }
 998 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
 999
1000 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1001
1002 /**
1003  * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
1004  * to a gpiochip
1005  * @gc: the gpiochip to set the irqchip hierarchical handler to
1006  * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
1007  * will then percolate up to the parent
1008  */
1009 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
1010                                               struct irq_chip *irqchip)
1011 {
1012         /* DT will deal with mapping each IRQ as we go along */
1013         if (is_of_node(gc->irq.fwnode))
1014                 return;
1015
1016         /*
1017          * This is for legacy and boardfile "irqchip" fwnodes: allocate
1018          * irqs upfront instead of dynamically since we don't have the
1019          * dynamic type of allocation that hardware description languages
1020          * provide. Once all GPIO drivers using board files are gone from
1021          * the kernel we can delete this code, but for a transitional period
1022          * it is necessary to keep this around.
1023          */
1024         if (is_fwnode_irqchip(gc->irq.fwnode)) {
1025                 int i;
1026                 int ret;
1027
1028                 for (i = 0; i < gc->ngpio; i++) {
1029                         struct irq_fwspec fwspec;
1030                         unsigned int parent_hwirq;
1031                         unsigned int parent_type;
1032                         struct gpio_irq_chip *girq = &gc->irq;
1033
1034                         /*
1035                          * We call the child to parent translation function
1036                          * only to check if the child IRQ is valid or not.
1037                          * Just pick the rising edge type here as that is what
1038                          * we likely need to support.
1039                          */
1040                         ret = girq->child_to_parent_hwirq(gc, i,
1041                                                           IRQ_TYPE_EDGE_RISING,
1042                                                           &parent_hwirq,
1043                                                           &parent_type);
1044                         if (ret) {
1045                                 chip_err(gc, "skip set-up on hwirq %d\n",
1046                                          i);
1047                                 continue;
1048                         }
1049
1050                         fwspec.fwnode = gc->irq.fwnode;
1051                         /* This is the hwirq for the GPIO line side of things */
1052                         fwspec.param[0] = girq->child_offset_to_irq(gc, i);
1053                         /* Just pick something */
1054                         fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
1055                         fwspec.param_count = 2;
1056                         ret = __irq_domain_alloc_irqs(gc->irq.domain,
1057                                                       /* just pick something */
1058                                                       -1,
1059                                                       1,
1060                                                       NUMA_NO_NODE,
1061                                                       &fwspec,
1062                                                       false,
1063                                                       NULL);
1064                         if (ret < 0) {
1065                                 chip_err(gc,
1066                                          "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1067                                          i, parent_hwirq,
1068                                          ret);
1069                         }
1070                 }
1071         }
1072
1073         chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1074
1075         return;
1076 }
1077
1078 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1079                                                    struct irq_fwspec *fwspec,
1080                                                    unsigned long *hwirq,
1081                                                    unsigned int *type)
1082 {
1083         /* We support standard DT translation */
1084         if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1085                 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1086         }
1087
1088         /* This is for board files and others not using DT */
1089         if (is_fwnode_irqchip(fwspec->fwnode)) {
1090                 int ret;
1091
1092                 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1093                 if (ret)
1094                         return ret;
1095                 WARN_ON(*type == IRQ_TYPE_NONE);
1096                 return 0;
1097         }
1098         return -EINVAL;
1099 }
1100
1101 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1102                                                unsigned int irq,
1103                                                unsigned int nr_irqs,
1104                                                void *data)
1105 {
1106         struct gpio_chip *gc = d->host_data;
1107         irq_hw_number_t hwirq;
1108         unsigned int type = IRQ_TYPE_NONE;
1109         struct irq_fwspec *fwspec = data;
1110         union gpio_irq_fwspec gpio_parent_fwspec = {};
1111         unsigned int parent_hwirq;
1112         unsigned int parent_type;
1113         struct gpio_irq_chip *girq = &gc->irq;
1114         int ret;
1115
1116         /*
1117          * The nr_irqs parameter is always one except for PCI multi-MSI
1118          * so this should not happen.
1119          */
1120         WARN_ON(nr_irqs != 1);
1121
1122         ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1123         if (ret)
1124                 return ret;
1125
1126         chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq,  hwirq);
1127
1128         ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1129                                           &parent_hwirq, &parent_type);
1130         if (ret) {
1131                 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1132                 return ret;
1133         }
1134         chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);
1135
1136         /*
1137          * We set handle_bad_irq because the .set_type() should
1138          * always be invoked and set the right type of handler.
1139          */
1140         irq_domain_set_info(d,
1141                             irq,
1142                             hwirq,
1143                             gc->irq.chip,
1144                             gc,
1145                             girq->handler,
1146                             NULL, NULL);
1147         irq_set_probe(irq);
1148
1149         /* This parent only handles asserted level IRQs */
1150         ret = girq->populate_parent_alloc_arg(gc, &gpio_parent_fwspec,
1151                                               parent_hwirq, parent_type);
1152         if (ret)
1153                 return ret;
1154
1155         chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1156                   irq, parent_hwirq);
1157         irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1158         ret = irq_domain_alloc_irqs_parent(d, irq, 1, &gpio_parent_fwspec);
1159         /*
1160          * If the parent irqdomain is msi, the interrupts have already
1161          * been allocated, so the EEXIST is good.
1162          */
1163         if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
1164                 ret = 0;
1165         if (ret)
1166                 chip_err(gc,
1167                          "failed to allocate parent hwirq %d for hwirq %lu\n",
1168                          parent_hwirq, hwirq);
1169
1170         return ret;
1171 }
1172
1173 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
1174                                                       unsigned int offset)
1175 {
1176         return offset;
1177 }
1178
1179 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1180 {
1181         ops->activate = gpiochip_irq_domain_activate;
1182         ops->deactivate = gpiochip_irq_domain_deactivate;
1183         ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1184
1185         /*
1186          * We only allow overriding the translate() and free() functions for
1187          * hierarchical chips, and this should only be done if the user
1188          * really need something other than 1:1 translation for translate()
1189          * callback and free if user wants to free up any resources which
1190          * were allocated during callbacks, for example populate_parent_alloc_arg.
1191          */
1192         if (!ops->translate)
1193                 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1194         if (!ops->free)
1195                 ops->free = irq_domain_free_irqs_common;
1196 }
1197
1198 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1199 {
1200         if (!gc->irq.child_to_parent_hwirq ||
1201             !gc->irq.fwnode) {
1202                 chip_err(gc, "missing irqdomain vital data\n");
1203                 return -EINVAL;
1204         }
1205
1206         if (!gc->irq.child_offset_to_irq)
1207                 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1208
1209         if (!gc->irq.populate_parent_alloc_arg)
1210                 gc->irq.populate_parent_alloc_arg =
1211                         gpiochip_populate_parent_fwspec_twocell;
1212
1213         gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1214
1215         gc->irq.domain = irq_domain_create_hierarchy(
1216                 gc->irq.parent_domain,
1217                 0,
1218                 gc->ngpio,
1219                 gc->irq.fwnode,
1220                 &gc->irq.child_irq_domain_ops,
1221                 gc);
1222
1223         if (!gc->irq.domain)
1224                 return -ENOMEM;
1225
1226         gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1227
1228         return 0;
1229 }
1230
1231 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1232 {
1233         return !!gc->irq.parent_domain;
1234 }
1235
1236 int gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
1237                                             union gpio_irq_fwspec *gfwspec,
1238                                             unsigned int parent_hwirq,
1239                                             unsigned int parent_type)
1240 {
1241         struct irq_fwspec *fwspec = &gfwspec->fwspec;
1242
1243         fwspec->fwnode = gc->irq.parent_domain->fwnode;
1244         fwspec->param_count = 2;
1245         fwspec->param[0] = parent_hwirq;
1246         fwspec->param[1] = parent_type;
1247
1248         return 0;
1249 }
1250 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1251
1252 int gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
1253                                              union gpio_irq_fwspec *gfwspec,
1254                                              unsigned int parent_hwirq,
1255                                              unsigned int parent_type)
1256 {
1257         struct irq_fwspec *fwspec = &gfwspec->fwspec;
1258
1259         fwspec->fwnode = gc->irq.parent_domain->fwnode;
1260         fwspec->param_count = 4;
1261         fwspec->param[0] = 0;
1262         fwspec->param[1] = parent_hwirq;
1263         fwspec->param[2] = 0;
1264         fwspec->param[3] = parent_type;
1265
1266         return 0;
1267 }
1268 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1269
1270 #else
1271
1272 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1273 {
1274         return -EINVAL;
1275 }
1276
1277 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1278 {
1279         return false;
1280 }
1281
1282 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1283
1284 /**
1285  * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1286  * @d: the irqdomain used by this irqchip
1287  * @irq: the global irq number used by this GPIO irqchip irq
1288  * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1289  *
1290  * This function will set up the mapping for a certain IRQ line on a
1291  * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1292  * stored inside the gpiochip.
1293  */
1294 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1295                      irq_hw_number_t hwirq)
1296 {
1297         struct gpio_chip *gc = d->host_data;
1298         int ret = 0;
1299
1300         if (!gpiochip_irqchip_irq_valid(gc, hwirq))
1301                 return -ENXIO;
1302
1303         irq_set_chip_data(irq, gc);
1304         /*
1305          * This lock class tells lockdep that GPIO irqs are in a different
1306          * category than their parents, so it won't report false recursion.
1307          */
1308         irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1309         irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
1310         /* Chips that use nested thread handlers have them marked */
1311         if (gc->irq.threaded)
1312                 irq_set_nested_thread(irq, 1);
1313         irq_set_noprobe(irq);
1314
1315         if (gc->irq.num_parents == 1)
1316                 ret = irq_set_parent(irq, gc->irq.parents[0]);
1317         else if (gc->irq.map)
1318                 ret = irq_set_parent(irq, gc->irq.map[hwirq]);
1319
1320         if (ret < 0)
1321                 return ret;
1322
1323         /*
1324          * No set-up of the hardware will happen if IRQ_TYPE_NONE
1325          * is passed as default type.
1326          */
1327         if (gc->irq.default_type != IRQ_TYPE_NONE)
1328                 irq_set_irq_type(irq, gc->irq.default_type);
1329
1330         return 0;
1331 }
1332 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1333
1334 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1335 {
1336         struct gpio_chip *gc = d->host_data;
1337
1338         if (gc->irq.threaded)
1339                 irq_set_nested_thread(irq, 0);
1340         irq_set_chip_and_handler(irq, NULL, NULL);
1341         irq_set_chip_data(irq, NULL);
1342 }
1343 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1344
1345 static const struct irq_domain_ops gpiochip_domain_ops = {
1346         .map    = gpiochip_irq_map,
1347         .unmap  = gpiochip_irq_unmap,
1348         /* Virtually all GPIO irqchips are twocell:ed */
1349         .xlate  = irq_domain_xlate_twocell,
1350 };
1351
1352 /*
1353  * TODO: move these activate/deactivate in under the hierarchicial
1354  * irqchip implementation as static once SPMI and SSBI (all external
1355  * users) are phased over.
1356  */
1357 /**
1358  * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1359  * @domain: The IRQ domain used by this IRQ chip
1360  * @data: Outermost irq_data associated with the IRQ
1361  * @reserve: If set, only reserve an interrupt vector instead of assigning one
1362  *
1363  * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1364  * used as the activate function for the &struct irq_domain_ops. The host_data
1365  * for the IRQ domain must be the &struct gpio_chip.
1366  */
1367 int gpiochip_irq_domain_activate(struct irq_domain *domain,
1368                                  struct irq_data *data, bool reserve)
1369 {
1370         struct gpio_chip *gc = domain->host_data;
1371
1372         return gpiochip_lock_as_irq(gc, data->hwirq);
1373 }
1374 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
1375
1376 /**
1377  * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1378  * @domain: The IRQ domain used by this IRQ chip
1379  * @data: Outermost irq_data associated with the IRQ
1380  *
1381  * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1382  * be used as the deactivate function for the &struct irq_domain_ops. The
1383  * host_data for the IRQ domain must be the &struct gpio_chip.
1384  */
1385 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
1386                                     struct irq_data *data)
1387 {
1388         struct gpio_chip *gc = domain->host_data;
1389
1390         return gpiochip_unlock_as_irq(gc, data->hwirq);
1391 }
1392 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
1393
1394 static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
1395 {
1396         struct irq_domain *domain = gc->irq.domain;
1397
1398 #ifdef CONFIG_GPIOLIB_IRQCHIP
1399         /*
1400          * Avoid race condition with other code, which tries to lookup
1401          * an IRQ before the irqchip has been properly registered,
1402          * i.e. while gpiochip is still being brought up.
1403          */
1404         if (!gc->irq.initialized)
1405                 return -EPROBE_DEFER;
1406 #endif
1407
1408         if (!gpiochip_irqchip_irq_valid(gc, offset))
1409                 return -ENXIO;
1410
1411 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1412         if (irq_domain_is_hierarchy(domain)) {
1413                 struct irq_fwspec spec;
1414
1415                 spec.fwnode = domain->fwnode;
1416                 spec.param_count = 2;
1417                 spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
1418                 spec.param[1] = IRQ_TYPE_NONE;
1419
1420                 return irq_create_fwspec_mapping(&spec);
1421         }
1422 #endif
1423
1424         return irq_create_mapping(domain, offset);
1425 }
1426
1427 int gpiochip_irq_reqres(struct irq_data *d)
1428 {
1429         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1430
1431         return gpiochip_reqres_irq(gc, d->hwirq);
1432 }
1433 EXPORT_SYMBOL(gpiochip_irq_reqres);
1434
1435 void gpiochip_irq_relres(struct irq_data *d)
1436 {
1437         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1438
1439         gpiochip_relres_irq(gc, d->hwirq);
1440 }
1441 EXPORT_SYMBOL(gpiochip_irq_relres);
1442
1443 static void gpiochip_irq_mask(struct irq_data *d)
1444 {
1445         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1446
1447         if (gc->irq.irq_mask)
1448                 gc->irq.irq_mask(d);
1449         gpiochip_disable_irq(gc, d->hwirq);
1450 }
1451
1452 static void gpiochip_irq_unmask(struct irq_data *d)
1453 {
1454         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1455
1456         gpiochip_enable_irq(gc, d->hwirq);
1457         if (gc->irq.irq_unmask)
1458                 gc->irq.irq_unmask(d);
1459 }
1460
1461 static void gpiochip_irq_enable(struct irq_data *d)
1462 {
1463         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1464
1465         gpiochip_enable_irq(gc, d->hwirq);
1466         gc->irq.irq_enable(d);
1467 }
1468
1469 static void gpiochip_irq_disable(struct irq_data *d)
1470 {
1471         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1472
1473         gc->irq.irq_disable(d);
1474         gpiochip_disable_irq(gc, d->hwirq);
1475 }
1476
1477 static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
1478 {
1479         struct irq_chip *irqchip = gc->irq.chip;
1480
1481         if (irqchip->flags & IRQCHIP_IMMUTABLE)
1482                 return;
1483
1484         chip_warn(gc, "not an immutable chip, please consider fixing it!\n");
1485
1486         if (!irqchip->irq_request_resources &&
1487             !irqchip->irq_release_resources) {
1488                 irqchip->irq_request_resources = gpiochip_irq_reqres;
1489                 irqchip->irq_release_resources = gpiochip_irq_relres;
1490         }
1491         if (WARN_ON(gc->irq.irq_enable))
1492                 return;
1493         /* Check if the irqchip already has this hook... */
1494         if (irqchip->irq_enable == gpiochip_irq_enable ||
1495                 irqchip->irq_mask == gpiochip_irq_mask) {
1496                 /*
1497                  * ...and if so, give a gentle warning that this is bad
1498                  * practice.
1499                  */
1500                 chip_info(gc,
1501                           "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1502                 return;
1503         }
1504
1505         if (irqchip->irq_disable) {
1506                 gc->irq.irq_disable = irqchip->irq_disable;
1507                 irqchip->irq_disable = gpiochip_irq_disable;
1508         } else {
1509                 gc->irq.irq_mask = irqchip->irq_mask;
1510                 irqchip->irq_mask = gpiochip_irq_mask;
1511         }
1512
1513         if (irqchip->irq_enable) {
1514                 gc->irq.irq_enable = irqchip->irq_enable;
1515                 irqchip->irq_enable = gpiochip_irq_enable;
1516         } else {
1517                 gc->irq.irq_unmask = irqchip->irq_unmask;
1518                 irqchip->irq_unmask = gpiochip_irq_unmask;
1519         }
1520 }
1521
1522 /**
1523  * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1524  * @gc: the GPIO chip to add the IRQ chip to
1525  * @lock_key: lockdep class for IRQ lock
1526  * @request_key: lockdep class for IRQ request
1527  */
1528 static int gpiochip_add_irqchip(struct gpio_chip *gc,
1529                                 struct lock_class_key *lock_key,
1530                                 struct lock_class_key *request_key)
1531 {
1532         struct fwnode_handle *fwnode = dev_fwnode(&gc->gpiodev->dev);
1533         struct irq_chip *irqchip = gc->irq.chip;
1534         unsigned int type;
1535         unsigned int i;
1536
1537         if (!irqchip)
1538                 return 0;
1539
1540         if (gc->irq.parent_handler && gc->can_sleep) {
1541                 chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
1542                 return -EINVAL;
1543         }
1544
1545         type = gc->irq.default_type;
1546
1547         /*
1548          * Specifying a default trigger is a terrible idea if DT or ACPI is
1549          * used to configure the interrupts, as you may end up with
1550          * conflicting triggers. Tell the user, and reset to NONE.
1551          */
1552         if (WARN(fwnode && type != IRQ_TYPE_NONE,
1553                  "%pfw: Ignoring %u default trigger\n", fwnode, type))
1554                 type = IRQ_TYPE_NONE;
1555
1556         if (gc->to_irq)
1557                 chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);
1558
1559         gc->to_irq = gpiochip_to_irq;
1560         gc->irq.default_type = type;
1561         gc->irq.lock_key = lock_key;
1562         gc->irq.request_key = request_key;
1563
1564         /* If a parent irqdomain is provided, let's build a hierarchy */
1565         if (gpiochip_hierarchy_is_hierarchical(gc)) {
1566                 int ret = gpiochip_hierarchy_add_domain(gc);
1567                 if (ret)
1568                         return ret;
1569         } else {
1570                 /* Some drivers provide custom irqdomain ops */
1571                 gc->irq.domain = irq_domain_create_simple(fwnode,
1572                         gc->ngpio,
1573                         gc->irq.first,
1574                         gc->irq.domain_ops ?: &gpiochip_domain_ops,
1575                         gc);
1576                 if (!gc->irq.domain)
1577                         return -EINVAL;
1578         }
1579
1580         if (gc->irq.parent_handler) {
1581                 for (i = 0; i < gc->irq.num_parents; i++) {
1582                         void *data;
1583
1584                         if (gc->irq.per_parent_data)
1585                                 data = gc->irq.parent_handler_data_array[i];
1586                         else
1587                                 data = gc->irq.parent_handler_data ?: gc;
1588
1589                         /*
1590                          * The parent IRQ chip is already using the chip_data
1591                          * for this IRQ chip, so our callbacks simply use the
1592                          * handler_data.
1593                          */
1594                         irq_set_chained_handler_and_data(gc->irq.parents[i],
1595                                                          gc->irq.parent_handler,
1596                                                          data);
1597                 }
1598         }
1599
1600         gpiochip_set_irq_hooks(gc);
1601
1602         /*
1603          * Using barrier() here to prevent compiler from reordering
1604          * gc->irq.initialized before initialization of above
1605          * GPIO chip irq members.
1606          */
1607         barrier();
1608
1609         gc->irq.initialized = true;
1610
1611         acpi_gpiochip_request_interrupts(gc);
1612
1613         return 0;
1614 }
1615
1616 /**
1617  * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1618  * @gc: the gpiochip to remove the irqchip from
1619  *
1620  * This is called only from gpiochip_remove()
1621  */
1622 static void gpiochip_irqchip_remove(struct gpio_chip *gc)
1623 {
1624         struct irq_chip *irqchip = gc->irq.chip;
1625         unsigned int offset;
1626
1627         acpi_gpiochip_free_interrupts(gc);
1628
1629         if (irqchip && gc->irq.parent_handler) {
1630                 struct gpio_irq_chip *irq = &gc->irq;
1631                 unsigned int i;
1632
1633                 for (i = 0; i < irq->num_parents; i++)
1634                         irq_set_chained_handler_and_data(irq->parents[i],
1635                                                          NULL, NULL);
1636         }
1637
1638         /* Remove all IRQ mappings and delete the domain */
1639         if (gc->irq.domain) {
1640                 unsigned int irq;
1641
1642                 for (offset = 0; offset < gc->ngpio; offset++) {
1643                         if (!gpiochip_irqchip_irq_valid(gc, offset))
1644                                 continue;
1645
1646                         irq = irq_find_mapping(gc->irq.domain, offset);
1647                         irq_dispose_mapping(irq);
1648                 }
1649
1650                 irq_domain_remove(gc->irq.domain);
1651         }
1652
1653         if (irqchip && !(irqchip->flags & IRQCHIP_IMMUTABLE)) {
1654                 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
1655                         irqchip->irq_request_resources = NULL;
1656                         irqchip->irq_release_resources = NULL;
1657                 }
1658                 if (irqchip->irq_enable == gpiochip_irq_enable) {
1659                         irqchip->irq_enable = gc->irq.irq_enable;
1660                         irqchip->irq_disable = gc->irq.irq_disable;
1661                 }
1662         }
1663         gc->irq.irq_enable = NULL;
1664         gc->irq.irq_disable = NULL;
1665         gc->irq.chip = NULL;
1666
1667         gpiochip_irqchip_free_valid_mask(gc);
1668 }
1669
1670 /**
1671  * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1672  * @gc: the gpiochip to add the irqchip to
1673  * @domain: the irqdomain to add to the gpiochip
1674  *
1675  * This function adds an IRQ domain to the gpiochip.
1676  */
1677 int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
1678                                 struct irq_domain *domain)
1679 {
1680         if (!domain)
1681                 return -EINVAL;
1682
1683         gc->to_irq = gpiochip_to_irq;
1684         gc->irq.domain = domain;
1685
1686         return 0;
1687 }
1688 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
1689
1690 #else /* CONFIG_GPIOLIB_IRQCHIP */
1691
1692 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
1693                                        struct lock_class_key *lock_key,
1694                                        struct lock_class_key *request_key)
1695 {
1696         return 0;
1697 }
1698 static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}
1699
1700 static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1701 {
1702         return 0;
1703 }
1704
1705 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1706 {
1707         return 0;
1708 }
1709 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1710 { }
1711
1712 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1713
1714 /**
1715  * gpiochip_generic_request() - request the gpio function for a pin
1716  * @gc: the gpiochip owning the GPIO
1717  * @offset: the offset of the GPIO to request for GPIO function
1718  */
1719 int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
1720 {
1721 #ifdef CONFIG_PINCTRL
1722         if (list_empty(&gc->gpiodev->pin_ranges))
1723                 return 0;
1724 #endif
1725
1726         return pinctrl_gpio_request(gc->gpiodev->base + offset);
1727 }
1728 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1729
1730 /**
1731  * gpiochip_generic_free() - free the gpio function from a pin
1732  * @gc: the gpiochip to request the gpio function for
1733  * @offset: the offset of the GPIO to free from GPIO function
1734  */
1735 void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
1736 {
1737 #ifdef CONFIG_PINCTRL
1738         if (list_empty(&gc->gpiodev->pin_ranges))
1739                 return;
1740 #endif
1741
1742         pinctrl_gpio_free(gc->gpiodev->base + offset);
1743 }
1744 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1745
1746 /**
1747  * gpiochip_generic_config() - apply configuration for a pin
1748  * @gc: the gpiochip owning the GPIO
1749  * @offset: the offset of the GPIO to apply the configuration
1750  * @config: the configuration to be applied
1751  */
1752 int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
1753                             unsigned long config)
1754 {
1755         return pinctrl_gpio_set_config(gc->gpiodev->base + offset, config);
1756 }
1757 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
1758
1759 #ifdef CONFIG_PINCTRL
1760
1761 /**
1762  * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1763  * @gc: the gpiochip to add the range for
1764  * @pctldev: the pin controller to map to
1765  * @gpio_offset: the start offset in the current gpio_chip number space
1766  * @pin_group: name of the pin group inside the pin controller
1767  *
1768  * Calling this function directly from a DeviceTree-supported
1769  * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1770  * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1771  * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1772  */
1773 int gpiochip_add_pingroup_range(struct gpio_chip *gc,
1774                         struct pinctrl_dev *pctldev,
1775                         unsigned int gpio_offset, const char *pin_group)
1776 {
1777         struct gpio_pin_range *pin_range;
1778         struct gpio_device *gdev = gc->gpiodev;
1779         int ret;
1780
1781         pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1782         if (!pin_range) {
1783                 chip_err(gc, "failed to allocate pin ranges\n");
1784                 return -ENOMEM;
1785         }
1786
1787         /* Use local offset as range ID */
1788         pin_range->range.id = gpio_offset;
1789         pin_range->range.gc = gc;
1790         pin_range->range.name = gc->label;
1791         pin_range->range.base = gdev->base + gpio_offset;
1792         pin_range->pctldev = pctldev;
1793
1794         ret = pinctrl_get_group_pins(pctldev, pin_group,
1795                                         &pin_range->range.pins,
1796                                         &pin_range->range.npins);
1797         if (ret < 0) {
1798                 kfree(pin_range);
1799                 return ret;
1800         }
1801
1802         pinctrl_add_gpio_range(pctldev, &pin_range->range);
1803
1804         chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1805                  gpio_offset, gpio_offset + pin_range->range.npins - 1,
1806                  pinctrl_dev_get_devname(pctldev), pin_group);
1807
1808         list_add_tail(&pin_range->node, &gdev->pin_ranges);
1809
1810         return 0;
1811 }
1812 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1813
1814 /**
1815  * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1816  * @gc: the gpiochip to add the range for
1817  * @pinctl_name: the dev_name() of the pin controller to map to
1818  * @gpio_offset: the start offset in the current gpio_chip number space
1819  * @pin_offset: the start offset in the pin controller number space
1820  * @npins: the number of pins from the offset of each pin space (GPIO and
1821  *      pin controller) to accumulate in this range
1822  *
1823  * Returns:
1824  * 0 on success, or a negative error-code on failure.
1825  *
1826  * Calling this function directly from a DeviceTree-supported
1827  * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1828  * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1829  * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1830  */
1831 int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
1832                            unsigned int gpio_offset, unsigned int pin_offset,
1833                            unsigned int npins)
1834 {
1835         struct gpio_pin_range *pin_range;
1836         struct gpio_device *gdev = gc->gpiodev;
1837         int ret;
1838
1839         pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1840         if (!pin_range) {
1841                 chip_err(gc, "failed to allocate pin ranges\n");
1842                 return -ENOMEM;
1843         }
1844
1845         /* Use local offset as range ID */
1846         pin_range->range.id = gpio_offset;
1847         pin_range->range.gc = gc;
1848         pin_range->range.name = gc->label;
1849         pin_range->range.base = gdev->base + gpio_offset;
1850         pin_range->range.pin_base = pin_offset;
1851         pin_range->range.npins = npins;
1852         pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1853                         &pin_range->range);
1854         if (IS_ERR(pin_range->pctldev)) {
1855                 ret = PTR_ERR(pin_range->pctldev);
1856                 chip_err(gc, "could not create pin range\n");
1857                 kfree(pin_range);
1858                 return ret;
1859         }
1860         chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1861                  gpio_offset, gpio_offset + npins - 1,
1862                  pinctl_name,
1863                  pin_offset, pin_offset + npins - 1);
1864
1865         list_add_tail(&pin_range->node, &gdev->pin_ranges);
1866
1867         return 0;
1868 }
1869 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1870
1871 /**
1872  * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1873  * @gc: the chip to remove all the mappings for
1874  */
1875 void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
1876 {
1877         struct gpio_pin_range *pin_range, *tmp;
1878         struct gpio_device *gdev = gc->gpiodev;
1879
1880         list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1881                 list_del(&pin_range->node);
1882                 pinctrl_remove_gpio_range(pin_range->pctldev,
1883                                 &pin_range->range);
1884                 kfree(pin_range);
1885         }
1886 }
1887 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1888
1889 #endif /* CONFIG_PINCTRL */
1890
1891 /* These "optional" allocation calls help prevent drivers from stomping
1892  * on each other, and help provide better diagnostics in debugfs.
1893  * They're called even less than the "set direction" calls.
1894  */
1895 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
1896 {
1897         struct gpio_chip        *gc = desc->gdev->chip;
1898         int                     ret;
1899         unsigned long           flags;
1900         unsigned                offset;
1901
1902         if (label) {
1903                 label = kstrdup_const(label, GFP_KERNEL);
1904                 if (!label)
1905                         return -ENOMEM;
1906         }
1907
1908         spin_lock_irqsave(&gpio_lock, flags);
1909
1910         /* NOTE:  gpio_request() can be called in early boot,
1911          * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1912          */
1913
1914         if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1915                 desc_set_label(desc, label ? : "?");
1916         } else {
1917                 ret = -EBUSY;
1918                 goto out_free_unlock;
1919         }
1920
1921         if (gc->request) {
1922                 /* gc->request may sleep */
1923                 spin_unlock_irqrestore(&gpio_lock, flags);
1924                 offset = gpio_chip_hwgpio(desc);
1925                 if (gpiochip_line_is_valid(gc, offset))
1926                         ret = gc->request(gc, offset);
1927                 else
1928                         ret = -EINVAL;
1929                 spin_lock_irqsave(&gpio_lock, flags);
1930
1931                 if (ret) {
1932                         desc_set_label(desc, NULL);
1933                         clear_bit(FLAG_REQUESTED, &desc->flags);
1934                         goto out_free_unlock;
1935                 }
1936         }
1937         if (gc->get_direction) {
1938                 /* gc->get_direction may sleep */
1939                 spin_unlock_irqrestore(&gpio_lock, flags);
1940                 gpiod_get_direction(desc);
1941                 spin_lock_irqsave(&gpio_lock, flags);
1942         }
1943         spin_unlock_irqrestore(&gpio_lock, flags);
1944         return 0;
1945
1946 out_free_unlock:
1947         spin_unlock_irqrestore(&gpio_lock, flags);
1948         kfree_const(label);
1949         return ret;
1950 }
1951
1952 /*
1953  * This descriptor validation needs to be inserted verbatim into each
1954  * function taking a descriptor, so we need to use a preprocessor
1955  * macro to avoid endless duplication. If the desc is NULL it is an
1956  * optional GPIO and calls should just bail out.
1957  */
1958 static int validate_desc(const struct gpio_desc *desc, const char *func)
1959 {
1960         if (!desc)
1961                 return 0;
1962         if (IS_ERR(desc)) {
1963                 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
1964                 return PTR_ERR(desc);
1965         }
1966         if (!desc->gdev) {
1967                 pr_warn("%s: invalid GPIO (no device)\n", func);
1968                 return -EINVAL;
1969         }
1970         if (!desc->gdev->chip) {
1971                 dev_warn(&desc->gdev->dev,
1972                          "%s: backing chip is gone\n", func);
1973                 return 0;
1974         }
1975         return 1;
1976 }
1977
1978 #define VALIDATE_DESC(desc) do { \
1979         int __valid = validate_desc(desc, __func__); \
1980         if (__valid <= 0) \
1981                 return __valid; \
1982         } while (0)
1983
1984 #define VALIDATE_DESC_VOID(desc) do { \
1985         int __valid = validate_desc(desc, __func__); \
1986         if (__valid <= 0) \
1987                 return; \
1988         } while (0)
1989
1990 int gpiod_request(struct gpio_desc *desc, const char *label)
1991 {
1992         int ret = -EPROBE_DEFER;
1993         struct gpio_device *gdev;
1994
1995         VALIDATE_DESC(desc);
1996         gdev = desc->gdev;
1997
1998         if (try_module_get(gdev->owner)) {
1999                 ret = gpiod_request_commit(desc, label);
2000                 if (ret)
2001                         module_put(gdev->owner);
2002                 else
2003                         get_device(&gdev->dev);
2004         }
2005
2006         if (ret)
2007                 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
2008
2009         return ret;
2010 }
2011
2012 static bool gpiod_free_commit(struct gpio_desc *desc)
2013 {
2014         bool                    ret = false;
2015         unsigned long           flags;
2016         struct gpio_chip        *gc;
2017
2018         might_sleep();
2019
2020         gpiod_unexport(desc);
2021
2022         spin_lock_irqsave(&gpio_lock, flags);
2023
2024         gc = desc->gdev->chip;
2025         if (gc && test_bit(FLAG_REQUESTED, &desc->flags)) {
2026                 if (gc->free) {
2027                         spin_unlock_irqrestore(&gpio_lock, flags);
2028                         might_sleep_if(gc->can_sleep);
2029                         gc->free(gc, gpio_chip_hwgpio(desc));
2030                         spin_lock_irqsave(&gpio_lock, flags);
2031                 }
2032                 kfree_const(desc->label);
2033                 desc_set_label(desc, NULL);
2034                 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2035                 clear_bit(FLAG_REQUESTED, &desc->flags);
2036                 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2037                 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2038                 clear_bit(FLAG_PULL_UP, &desc->flags);
2039                 clear_bit(FLAG_PULL_DOWN, &desc->flags);
2040                 clear_bit(FLAG_BIAS_DISABLE, &desc->flags);
2041                 clear_bit(FLAG_EDGE_RISING, &desc->flags);
2042                 clear_bit(FLAG_EDGE_FALLING, &desc->flags);
2043                 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2044 #ifdef CONFIG_OF_DYNAMIC
2045                 desc->hog = NULL;
2046 #endif
2047 #ifdef CONFIG_GPIO_CDEV
2048                 WRITE_ONCE(desc->debounce_period_us, 0);
2049 #endif
2050                 ret = true;
2051         }
2052
2053         spin_unlock_irqrestore(&gpio_lock, flags);
2054         blocking_notifier_call_chain(&desc->gdev->notifier,
2055                                      GPIOLINE_CHANGED_RELEASED, desc);
2056
2057         return ret;
2058 }
2059
2060 void gpiod_free(struct gpio_desc *desc)
2061 {
2062         if (desc && desc->gdev && gpiod_free_commit(desc)) {
2063                 module_put(desc->gdev->owner);
2064                 put_device(&desc->gdev->dev);
2065         } else {
2066                 WARN_ON(extra_checks);
2067         }
2068 }
2069
2070 /**
2071  * gpiochip_is_requested - return string iff signal was requested
2072  * @gc: controller managing the signal
2073  * @offset: of signal within controller's 0..(ngpio - 1) range
2074  *
2075  * Returns NULL if the GPIO is not currently requested, else a string.
2076  * The string returned is the label passed to gpio_request(); if none has been
2077  * passed it is a meaningless, non-NULL constant.
2078  *
2079  * This function is for use by GPIO controller drivers.  The label can
2080  * help with diagnostics, and knowing that the signal is used as a GPIO
2081  * can help avoid accidentally multiplexing it to another controller.
2082  */
2083 const char *gpiochip_is_requested(struct gpio_chip *gc, unsigned int offset)
2084 {
2085         struct gpio_desc *desc;
2086
2087         desc = gpiochip_get_desc(gc, offset);
2088         if (IS_ERR(desc))
2089                 return NULL;
2090
2091         if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2092                 return NULL;
2093         return desc->label;
2094 }
2095 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2096
2097 /**
2098  * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2099  * @gc: GPIO chip
2100  * @hwnum: hardware number of the GPIO for which to request the descriptor
2101  * @label: label for the GPIO
2102  * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2103  * specify things like line inversion semantics with the machine flags
2104  * such as GPIO_OUT_LOW
2105  * @dflags: descriptor request flags for this GPIO or 0 if default, this
2106  * can be used to specify consumer semantics such as open drain
2107  *
2108  * Function allows GPIO chip drivers to request and use their own GPIO
2109  * descriptors via gpiolib API. Difference to gpiod_request() is that this
2110  * function will not increase reference count of the GPIO chip module. This
2111  * allows the GPIO chip module to be unloaded as needed (we assume that the
2112  * GPIO chip driver handles freeing the GPIOs it has requested).
2113  *
2114  * Returns:
2115  * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2116  * code on failure.
2117  */
2118 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,
2119                                             unsigned int hwnum,
2120                                             const char *label,
2121                                             enum gpio_lookup_flags lflags,
2122                                             enum gpiod_flags dflags)
2123 {
2124         struct gpio_desc *desc = gpiochip_get_desc(gc, hwnum);
2125         int ret;
2126
2127         if (IS_ERR(desc)) {
2128                 chip_err(gc, "failed to get GPIO descriptor\n");
2129                 return desc;
2130         }
2131
2132         ret = gpiod_request_commit(desc, label);
2133         if (ret < 0)
2134                 return ERR_PTR(ret);
2135
2136         ret = gpiod_configure_flags(desc, label, lflags, dflags);
2137         if (ret) {
2138                 chip_err(gc, "setup of own GPIO %s failed\n", label);
2139                 gpiod_free_commit(desc);
2140                 return ERR_PTR(ret);
2141         }
2142
2143         return desc;
2144 }
2145 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2146
2147 /**
2148  * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2149  * @desc: GPIO descriptor to free
2150  *
2151  * Function frees the given GPIO requested previously with
2152  * gpiochip_request_own_desc().
2153  */
2154 void gpiochip_free_own_desc(struct gpio_desc *desc)
2155 {
2156         if (desc)
2157                 gpiod_free_commit(desc);
2158 }
2159 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2160
2161 /*
2162  * Drivers MUST set GPIO direction before making get/set calls.  In
2163  * some cases this is done in early boot, before IRQs are enabled.
2164  *
2165  * As a rule these aren't called more than once (except for drivers
2166  * using the open-drain emulation idiom) so these are natural places
2167  * to accumulate extra debugging checks.  Note that we can't (yet)
2168  * rely on gpio_request() having been called beforehand.
2169  */
2170
2171 static int gpio_do_set_config(struct gpio_chip *gc, unsigned int offset,
2172                               unsigned long config)
2173 {
2174         if (!gc->set_config)
2175                 return -ENOTSUPP;
2176
2177         return gc->set_config(gc, offset, config);
2178 }
2179
2180 static int gpio_set_config_with_argument(struct gpio_desc *desc,
2181                                          enum pin_config_param mode,
2182                                          u32 argument)
2183 {
2184         struct gpio_chip *gc = desc->gdev->chip;
2185         unsigned long config;
2186
2187         config = pinconf_to_config_packed(mode, argument);
2188         return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2189 }
2190
2191 static int gpio_set_config_with_argument_optional(struct gpio_desc *desc,
2192                                                   enum pin_config_param mode,
2193                                                   u32 argument)
2194 {
2195         struct device *dev = &desc->gdev->dev;
2196         int gpio = gpio_chip_hwgpio(desc);
2197         int ret;
2198
2199         ret = gpio_set_config_with_argument(desc, mode, argument);
2200         if (ret != -ENOTSUPP)
2201                 return ret;
2202
2203         switch (mode) {
2204         case PIN_CONFIG_PERSIST_STATE:
2205                 dev_dbg(dev, "Persistence not supported for GPIO %d\n", gpio);
2206                 break;
2207         default:
2208                 break;
2209         }
2210
2211         return 0;
2212 }
2213
2214 static int gpio_set_config(struct gpio_desc *desc, enum pin_config_param mode)
2215 {
2216         return gpio_set_config_with_argument(desc, mode, 0);
2217 }
2218
2219 static int gpio_set_bias(struct gpio_desc *desc)
2220 {
2221         enum pin_config_param bias;
2222         unsigned int arg;
2223
2224         if (test_bit(FLAG_BIAS_DISABLE, &desc->flags))
2225                 bias = PIN_CONFIG_BIAS_DISABLE;
2226         else if (test_bit(FLAG_PULL_UP, &desc->flags))
2227                 bias = PIN_CONFIG_BIAS_PULL_UP;
2228         else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2229                 bias = PIN_CONFIG_BIAS_PULL_DOWN;
2230         else
2231                 return 0;
2232
2233         switch (bias) {
2234         case PIN_CONFIG_BIAS_PULL_DOWN:
2235         case PIN_CONFIG_BIAS_PULL_UP:
2236                 arg = 1;
2237                 break;
2238
2239         default:
2240                 arg = 0;
2241                 break;
2242         }
2243
2244         return gpio_set_config_with_argument_optional(desc, bias, arg);
2245 }
2246
2247 /**
2248  * gpio_set_debounce_timeout() - Set debounce timeout
2249  * @desc:       GPIO descriptor to set the debounce timeout
2250  * @debounce:   Debounce timeout in microseconds
2251  *
2252  * The function calls the certain GPIO driver to set debounce timeout
2253  * in the hardware.
2254  *
2255  * Returns 0 on success, or negative error code otherwise.
2256  */
2257 int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce)
2258 {
2259         return gpio_set_config_with_argument_optional(desc,
2260                                                       PIN_CONFIG_INPUT_DEBOUNCE,
2261                                                       debounce);
2262 }
2263
2264 /**
2265  * gpiod_direction_input - set the GPIO direction to input
2266  * @desc:       GPIO to set to input
2267  *
2268  * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2269  * be called safely on it.
2270  *
2271  * Return 0 in case of success, else an error code.
2272  */
2273 int gpiod_direction_input(struct gpio_desc *desc)
2274 {
2275         struct gpio_chip        *gc;
2276         int                     ret = 0;
2277
2278         VALIDATE_DESC(desc);
2279         gc = desc->gdev->chip;
2280
2281         /*
2282          * It is legal to have no .get() and .direction_input() specified if
2283          * the chip is output-only, but you can't specify .direction_input()
2284          * and not support the .get() operation, that doesn't make sense.
2285          */
2286         if (!gc->get && gc->direction_input) {
2287                 gpiod_warn(desc,
2288                            "%s: missing get() but have direction_input()\n",
2289                            __func__);
2290                 return -EIO;
2291         }
2292
2293         /*
2294          * If we have a .direction_input() callback, things are simple,
2295          * just call it. Else we are some input-only chip so try to check the
2296          * direction (if .get_direction() is supported) else we silently
2297          * assume we are in input mode after this.
2298          */
2299         if (gc->direction_input) {
2300                 ret = gc->direction_input(gc, gpio_chip_hwgpio(desc));
2301         } else if (gc->get_direction &&
2302                   (gc->get_direction(gc, gpio_chip_hwgpio(desc)) != 1)) {
2303                 gpiod_warn(desc,
2304                            "%s: missing direction_input() operation and line is output\n",
2305                            __func__);
2306                 return -EIO;
2307         }
2308         if (ret == 0) {
2309                 clear_bit(FLAG_IS_OUT, &desc->flags);
2310                 ret = gpio_set_bias(desc);
2311         }
2312
2313         trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2314
2315         return ret;
2316 }
2317 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2318
2319 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2320 {
2321         struct gpio_chip *gc = desc->gdev->chip;
2322         int val = !!value;
2323         int ret = 0;
2324
2325         /*
2326          * It's OK not to specify .direction_output() if the gpiochip is
2327          * output-only, but if there is then not even a .set() operation it
2328          * is pretty tricky to drive the output line.
2329          */
2330         if (!gc->set && !gc->direction_output) {
2331                 gpiod_warn(desc,
2332                            "%s: missing set() and direction_output() operations\n",
2333                            __func__);
2334                 return -EIO;
2335         }
2336
2337         if (gc->direction_output) {
2338                 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2339         } else {
2340                 /* Check that we are in output mode if we can */
2341                 if (gc->get_direction &&
2342                     gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2343                         gpiod_warn(desc,
2344                                 "%s: missing direction_output() operation\n",
2345                                 __func__);
2346                         return -EIO;
2347                 }
2348                 /*
2349                  * If we can't actively set the direction, we are some
2350                  * output-only chip, so just drive the output as desired.
2351                  */
2352                 gc->set(gc, gpio_chip_hwgpio(desc), val);
2353         }
2354
2355         if (!ret)
2356                 set_bit(FLAG_IS_OUT, &desc->flags);
2357         trace_gpio_value(desc_to_gpio(desc), 0, val);
2358         trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2359         return ret;
2360 }
2361
2362 /**
2363  * gpiod_direction_output_raw - set the GPIO direction to output
2364  * @desc:       GPIO to set to output
2365  * @value:      initial output value of the GPIO
2366  *
2367  * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2368  * be called safely on it. The initial value of the output must be specified
2369  * as raw value on the physical line without regard for the ACTIVE_LOW status.
2370  *
2371  * Return 0 in case of success, else an error code.
2372  */
2373 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2374 {
2375         VALIDATE_DESC(desc);
2376         return gpiod_direction_output_raw_commit(desc, value);
2377 }
2378 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2379
2380 /**
2381  * gpiod_direction_output - set the GPIO direction to output
2382  * @desc:       GPIO to set to output
2383  * @value:      initial output value of the GPIO
2384  *
2385  * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2386  * be called safely on it. The initial value of the output must be specified
2387  * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2388  * account.
2389  *
2390  * Return 0 in case of success, else an error code.
2391  */
2392 int gpiod_direction_output(struct gpio_desc *desc, int value)
2393 {
2394         int ret;
2395
2396         VALIDATE_DESC(desc);
2397         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2398                 value = !value;
2399         else
2400                 value = !!value;
2401
2402         /* GPIOs used for enabled IRQs shall not be set as output */
2403         if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
2404             test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
2405                 gpiod_err(desc,
2406                           "%s: tried to set a GPIO tied to an IRQ as output\n",
2407                           __func__);
2408                 return -EIO;
2409         }
2410
2411         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2412                 /* First see if we can enable open drain in hardware */
2413                 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_DRAIN);
2414                 if (!ret)
2415                         goto set_output_value;
2416                 /* Emulate open drain by not actively driving the line high */
2417                 if (value) {
2418                         ret = gpiod_direction_input(desc);
2419                         goto set_output_flag;
2420                 }
2421         } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2422                 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_SOURCE);
2423                 if (!ret)
2424                         goto set_output_value;
2425                 /* Emulate open source by not actively driving the line low */
2426                 if (!value) {
2427                         ret = gpiod_direction_input(desc);
2428                         goto set_output_flag;
2429                 }
2430         } else {
2431                 gpio_set_config(desc, PIN_CONFIG_DRIVE_PUSH_PULL);
2432         }
2433
2434 set_output_value:
2435         ret = gpio_set_bias(desc);
2436         if (ret)
2437                 return ret;
2438         return gpiod_direction_output_raw_commit(desc, value);
2439
2440 set_output_flag:
2441         /*
2442          * When emulating open-source or open-drain functionalities by not
2443          * actively driving the line (setting mode to input) we still need to
2444          * set the IS_OUT flag or otherwise we won't be able to set the line
2445          * value anymore.
2446          */
2447         if (ret == 0)
2448                 set_bit(FLAG_IS_OUT, &desc->flags);
2449         return ret;
2450 }
2451 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2452
2453 /**
2454  * gpiod_enable_hw_timestamp_ns - Enable hardware timestamp in nanoseconds.
2455  *
2456  * @desc: GPIO to enable.
2457  * @flags: Flags related to GPIO edge.
2458  *
2459  * Return 0 in case of success, else negative error code.
2460  */
2461 int gpiod_enable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags)
2462 {
2463         int ret = 0;
2464         struct gpio_chip *gc;
2465
2466         VALIDATE_DESC(desc);
2467
2468         gc = desc->gdev->chip;
2469         if (!gc->en_hw_timestamp) {
2470                 gpiod_warn(desc, "%s: hw ts not supported\n", __func__);
2471                 return -ENOTSUPP;
2472         }
2473
2474         ret = gc->en_hw_timestamp(gc, gpio_chip_hwgpio(desc), flags);
2475         if (ret)
2476                 gpiod_warn(desc, "%s: hw ts request failed\n", __func__);
2477
2478         return ret;
2479 }
2480 EXPORT_SYMBOL_GPL(gpiod_enable_hw_timestamp_ns);
2481
2482 /**
2483  * gpiod_disable_hw_timestamp_ns - Disable hardware timestamp.
2484  *
2485  * @desc: GPIO to disable.
2486  * @flags: Flags related to GPIO edge, same value as used during enable call.
2487  *
2488  * Return 0 in case of success, else negative error code.
2489  */
2490 int gpiod_disable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags)
2491 {
2492         int ret = 0;
2493         struct gpio_chip *gc;
2494
2495         VALIDATE_DESC(desc);
2496
2497         gc = desc->gdev->chip;
2498         if (!gc->dis_hw_timestamp) {
2499                 gpiod_warn(desc, "%s: hw ts not supported\n", __func__);
2500                 return -ENOTSUPP;
2501         }
2502
2503         ret = gc->dis_hw_timestamp(gc, gpio_chip_hwgpio(desc), flags);
2504         if (ret)
2505                 gpiod_warn(desc, "%s: hw ts release failed\n", __func__);
2506
2507         return ret;
2508 }
2509 EXPORT_SYMBOL_GPL(gpiod_disable_hw_timestamp_ns);
2510
2511 /**
2512  * gpiod_set_config - sets @config for a GPIO
2513  * @desc: descriptor of the GPIO for which to set the configuration
2514  * @config: Same packed config format as generic pinconf
2515  *
2516  * Returns:
2517  * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2518  * configuration.
2519  */
2520 int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
2521 {
2522         struct gpio_chip *gc;
2523
2524         VALIDATE_DESC(desc);
2525         gc = desc->gdev->chip;
2526
2527         return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2528 }
2529 EXPORT_SYMBOL_GPL(gpiod_set_config);
2530
2531 /**
2532  * gpiod_set_debounce - sets @debounce time for a GPIO
2533  * @desc: descriptor of the GPIO for which to set debounce time
2534  * @debounce: debounce time in microseconds
2535  *
2536  * Returns:
2537  * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2538  * debounce time.
2539  */
2540 int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce)
2541 {
2542         unsigned long config;
2543
2544         config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2545         return gpiod_set_config(desc, config);
2546 }
2547 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2548
2549 /**
2550  * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2551  * @desc: descriptor of the GPIO for which to configure persistence
2552  * @transitory: True to lose state on suspend or reset, false for persistence
2553  *
2554  * Returns:
2555  * 0 on success, otherwise a negative error code.
2556  */
2557 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2558 {
2559         VALIDATE_DESC(desc);
2560         /*
2561          * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2562          * persistence state.
2563          */
2564         assign_bit(FLAG_TRANSITORY, &desc->flags, transitory);
2565
2566         /* If the driver supports it, set the persistence state now */
2567         return gpio_set_config_with_argument_optional(desc,
2568                                                       PIN_CONFIG_PERSIST_STATE,
2569                                                       !transitory);
2570 }
2571 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2572
2573 /**
2574  * gpiod_is_active_low - test whether a GPIO is active-low or not
2575  * @desc: the gpio descriptor to test
2576  *
2577  * Returns 1 if the GPIO is active-low, 0 otherwise.
2578  */
2579 int gpiod_is_active_low(const struct gpio_desc *desc)
2580 {
2581         VALIDATE_DESC(desc);
2582         return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2583 }
2584 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2585
2586 /**
2587  * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2588  * @desc: the gpio descriptor to change
2589  */
2590 void gpiod_toggle_active_low(struct gpio_desc *desc)
2591 {
2592         VALIDATE_DESC_VOID(desc);
2593         change_bit(FLAG_ACTIVE_LOW, &desc->flags);
2594 }
2595 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low);
2596
2597 static int gpio_chip_get_value(struct gpio_chip *gc, const struct gpio_desc *desc)
2598 {
2599         return gc->get ? gc->get(gc, gpio_chip_hwgpio(desc)) : -EIO;
2600 }
2601
2602 /* I/O calls are only valid after configuration completed; the relevant
2603  * "is this a valid GPIO" error checks should already have been done.
2604  *
2605  * "Get" operations are often inlinable as reading a pin value register,
2606  * and masking the relevant bit in that register.
2607  *
2608  * When "set" operations are inlinable, they involve writing that mask to
2609  * one register to set a low value, or a different register to set it high.
2610  * Otherwise locking is needed, so there may be little value to inlining.
2611  *
2612  *------------------------------------------------------------------------
2613  *
2614  * IMPORTANT!!!  The hot paths -- get/set value -- assume that callers
2615  * have requested the GPIO.  That can include implicit requesting by
2616  * a direction setting call.  Marking a gpio as requested locks its chip
2617  * in memory, guaranteeing that these table lookups need no more locking
2618  * and that gpiochip_remove() will fail.
2619  *
2620  * REVISIT when debugging, consider adding some instrumentation to ensure
2621  * that the GPIO was actually requested.
2622  */
2623
2624 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2625 {
2626         struct gpio_chip        *gc;
2627         int value;
2628
2629         gc = desc->gdev->chip;
2630         value = gpio_chip_get_value(gc, desc);
2631         value = value < 0 ? value : !!value;
2632         trace_gpio_value(desc_to_gpio(desc), 1, value);
2633         return value;
2634 }
2635
2636 static int gpio_chip_get_multiple(struct gpio_chip *gc,
2637                                   unsigned long *mask, unsigned long *bits)
2638 {
2639         if (gc->get_multiple)
2640                 return gc->get_multiple(gc, mask, bits);
2641         if (gc->get) {
2642                 int i, value;
2643
2644                 for_each_set_bit(i, mask, gc->ngpio) {
2645                         value = gc->get(gc, i);
2646                         if (value < 0)
2647                                 return value;
2648                         __assign_bit(i, bits, value);
2649                 }
2650                 return 0;
2651         }
2652         return -EIO;
2653 }
2654
2655 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2656                                   unsigned int array_size,
2657                                   struct gpio_desc **desc_array,
2658                                   struct gpio_array *array_info,
2659                                   unsigned long *value_bitmap)
2660 {
2661         int ret, i = 0;
2662
2663         /*
2664          * Validate array_info against desc_array and its size.
2665          * It should immediately follow desc_array if both
2666          * have been obtained from the same gpiod_get_array() call.
2667          */
2668         if (array_info && array_info->desc == desc_array &&
2669             array_size <= array_info->size &&
2670             (void *)array_info == desc_array + array_info->size) {
2671                 if (!can_sleep)
2672                         WARN_ON(array_info->chip->can_sleep);
2673
2674                 ret = gpio_chip_get_multiple(array_info->chip,
2675                                              array_info->get_mask,
2676                                              value_bitmap);
2677                 if (ret)
2678                         return ret;
2679
2680                 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2681                         bitmap_xor(value_bitmap, value_bitmap,
2682                                    array_info->invert_mask, array_size);
2683
2684                 i = find_first_zero_bit(array_info->get_mask, array_size);
2685                 if (i == array_size)
2686                         return 0;
2687         } else {
2688                 array_info = NULL;
2689         }
2690
2691         while (i < array_size) {
2692                 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2693                 DECLARE_BITMAP(fastpath_mask, FASTPATH_NGPIO);
2694                 DECLARE_BITMAP(fastpath_bits, FASTPATH_NGPIO);
2695                 unsigned long *mask, *bits;
2696                 int first, j;
2697
2698                 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2699                         mask = fastpath_mask;
2700                         bits = fastpath_bits;
2701                 } else {
2702                         gfp_t flags = can_sleep ? GFP_KERNEL : GFP_ATOMIC;
2703
2704                         mask = bitmap_alloc(gc->ngpio, flags);
2705                         if (!mask)
2706                                 return -ENOMEM;
2707
2708                         bits = bitmap_alloc(gc->ngpio, flags);
2709                         if (!bits) {
2710                                 bitmap_free(mask);
2711                                 return -ENOMEM;
2712                         }
2713                 }
2714
2715                 bitmap_zero(mask, gc->ngpio);
2716
2717                 if (!can_sleep)
2718                         WARN_ON(gc->can_sleep);
2719
2720                 /* collect all inputs belonging to the same chip */
2721                 first = i;
2722                 do {
2723                         const struct gpio_desc *desc = desc_array[i];
2724                         int hwgpio = gpio_chip_hwgpio(desc);
2725
2726                         __set_bit(hwgpio, mask);
2727                         i++;
2728
2729                         if (array_info)
2730                                 i = find_next_zero_bit(array_info->get_mask,
2731                                                        array_size, i);
2732                 } while ((i < array_size) &&
2733                          (desc_array[i]->gdev->chip == gc));
2734
2735                 ret = gpio_chip_get_multiple(gc, mask, bits);
2736                 if (ret) {
2737                         if (mask != fastpath_mask)
2738                                 bitmap_free(mask);
2739                         if (bits != fastpath_bits)
2740                                 bitmap_free(bits);
2741                         return ret;
2742                 }
2743
2744                 for (j = first; j < i; ) {
2745                         const struct gpio_desc *desc = desc_array[j];
2746                         int hwgpio = gpio_chip_hwgpio(desc);
2747                         int value = test_bit(hwgpio, bits);
2748
2749                         if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2750                                 value = !value;
2751                         __assign_bit(j, value_bitmap, value);
2752                         trace_gpio_value(desc_to_gpio(desc), 1, value);
2753                         j++;
2754
2755                         if (array_info)
2756                                 j = find_next_zero_bit(array_info->get_mask, i,
2757                                                        j);
2758                 }
2759
2760                 if (mask != fastpath_mask)
2761                         bitmap_free(mask);
2762                 if (bits != fastpath_bits)
2763                         bitmap_free(bits);
2764         }
2765         return 0;
2766 }
2767
2768 /**
2769  * gpiod_get_raw_value() - return a gpio's raw value
2770  * @desc: gpio whose value will be returned
2771  *
2772  * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2773  * its ACTIVE_LOW status, or negative errno on failure.
2774  *
2775  * This function can be called from contexts where we cannot sleep, and will
2776  * complain if the GPIO chip functions potentially sleep.
2777  */
2778 int gpiod_get_raw_value(const struct gpio_desc *desc)
2779 {
2780         VALIDATE_DESC(desc);
2781         /* Should be using gpiod_get_raw_value_cansleep() */
2782         WARN_ON(desc->gdev->chip->can_sleep);
2783         return gpiod_get_raw_value_commit(desc);
2784 }
2785 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2786
2787 /**
2788  * gpiod_get_value() - return a gpio's value
2789  * @desc: gpio whose value will be returned
2790  *
2791  * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2792  * account, or negative errno on failure.
2793  *
2794  * This function can be called from contexts where we cannot sleep, and will
2795  * complain if the GPIO chip functions potentially sleep.
2796  */
2797 int gpiod_get_value(const struct gpio_desc *desc)
2798 {
2799         int value;
2800
2801         VALIDATE_DESC(desc);
2802         /* Should be using gpiod_get_value_cansleep() */
2803         WARN_ON(desc->gdev->chip->can_sleep);
2804
2805         value = gpiod_get_raw_value_commit(desc);
2806         if (value < 0)
2807                 return value;
2808
2809         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2810                 value = !value;
2811
2812         return value;
2813 }
2814 EXPORT_SYMBOL_GPL(gpiod_get_value);
2815
2816 /**
2817  * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2818  * @array_size: number of elements in the descriptor array / value bitmap
2819  * @desc_array: array of GPIO descriptors whose values will be read
2820  * @array_info: information on applicability of fast bitmap processing path
2821  * @value_bitmap: bitmap to store the read values
2822  *
2823  * Read the raw values of the GPIOs, i.e. the values of the physical lines
2824  * without regard for their ACTIVE_LOW status.  Return 0 in case of success,
2825  * else an error code.
2826  *
2827  * This function can be called from contexts where we cannot sleep,
2828  * and it will complain if the GPIO chip functions potentially sleep.
2829  */
2830 int gpiod_get_raw_array_value(unsigned int array_size,
2831                               struct gpio_desc **desc_array,
2832                               struct gpio_array *array_info,
2833                               unsigned long *value_bitmap)
2834 {
2835         if (!desc_array)
2836                 return -EINVAL;
2837         return gpiod_get_array_value_complex(true, false, array_size,
2838                                              desc_array, array_info,
2839                                              value_bitmap);
2840 }
2841 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2842
2843 /**
2844  * gpiod_get_array_value() - read values from an array of GPIOs
2845  * @array_size: number of elements in the descriptor array / value bitmap
2846  * @desc_array: array of GPIO descriptors whose values will be read
2847  * @array_info: information on applicability of fast bitmap processing path
2848  * @value_bitmap: bitmap to store the read values
2849  *
2850  * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2851  * into account.  Return 0 in case of success, else an error code.
2852  *
2853  * This function can be called from contexts where we cannot sleep,
2854  * and it will complain if the GPIO chip functions potentially sleep.
2855  */
2856 int gpiod_get_array_value(unsigned int array_size,
2857                           struct gpio_desc **desc_array,
2858                           struct gpio_array *array_info,
2859                           unsigned long *value_bitmap)
2860 {
2861         if (!desc_array)
2862                 return -EINVAL;
2863         return gpiod_get_array_value_complex(false, false, array_size,
2864                                              desc_array, array_info,
2865                                              value_bitmap);
2866 }
2867 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2868
2869 /*
2870  *  gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2871  * @desc: gpio descriptor whose state need to be set.
2872  * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2873  */
2874 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2875 {
2876         int ret = 0;
2877         struct gpio_chip *gc = desc->gdev->chip;
2878         int offset = gpio_chip_hwgpio(desc);
2879
2880         if (value) {
2881                 ret = gc->direction_input(gc, offset);
2882         } else {
2883                 ret = gc->direction_output(gc, offset, 0);
2884                 if (!ret)
2885                         set_bit(FLAG_IS_OUT, &desc->flags);
2886         }
2887         trace_gpio_direction(desc_to_gpio(desc), value, ret);
2888         if (ret < 0)
2889                 gpiod_err(desc,
2890                           "%s: Error in set_value for open drain err %d\n",
2891                           __func__, ret);
2892 }
2893
2894 /*
2895  *  _gpio_set_open_source_value() - Set the open source gpio's value.
2896  * @desc: gpio descriptor whose state need to be set.
2897  * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2898  */
2899 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2900 {
2901         int ret = 0;
2902         struct gpio_chip *gc = desc->gdev->chip;
2903         int offset = gpio_chip_hwgpio(desc);
2904
2905         if (value) {
2906                 ret = gc->direction_output(gc, offset, 1);
2907                 if (!ret)
2908                         set_bit(FLAG_IS_OUT, &desc->flags);
2909         } else {
2910                 ret = gc->direction_input(gc, offset);
2911         }
2912         trace_gpio_direction(desc_to_gpio(desc), !value, ret);
2913         if (ret < 0)
2914                 gpiod_err(desc,
2915                           "%s: Error in set_value for open source err %d\n",
2916                           __func__, ret);
2917 }
2918
2919 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2920 {
2921         struct gpio_chip        *gc;
2922
2923         gc = desc->gdev->chip;
2924         trace_gpio_value(desc_to_gpio(desc), 0, value);
2925         gc->set(gc, gpio_chip_hwgpio(desc), value);
2926 }
2927
2928 /*
2929  * set multiple outputs on the same chip;
2930  * use the chip's set_multiple function if available;
2931  * otherwise set the outputs sequentially;
2932  * @chip: the GPIO chip we operate on
2933  * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2934  *        defines which outputs are to be changed
2935  * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2936  *        defines the values the outputs specified by mask are to be set to
2937  */
2938 static void gpio_chip_set_multiple(struct gpio_chip *gc,
2939                                    unsigned long *mask, unsigned long *bits)
2940 {
2941         if (gc->set_multiple) {
2942                 gc->set_multiple(gc, mask, bits);
2943         } else {
2944                 unsigned int i;
2945
2946                 /* set outputs if the corresponding mask bit is set */
2947                 for_each_set_bit(i, mask, gc->ngpio)
2948                         gc->set(gc, i, test_bit(i, bits));
2949         }
2950 }
2951
2952 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
2953                                   unsigned int array_size,
2954                                   struct gpio_desc **desc_array,
2955                                   struct gpio_array *array_info,
2956                                   unsigned long *value_bitmap)
2957 {
2958         int i = 0;
2959
2960         /*
2961          * Validate array_info against desc_array and its size.
2962          * It should immediately follow desc_array if both
2963          * have been obtained from the same gpiod_get_array() call.
2964          */
2965         if (array_info && array_info->desc == desc_array &&
2966             array_size <= array_info->size &&
2967             (void *)array_info == desc_array + array_info->size) {
2968                 if (!can_sleep)
2969                         WARN_ON(array_info->chip->can_sleep);
2970
2971                 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2972                         bitmap_xor(value_bitmap, value_bitmap,
2973                                    array_info->invert_mask, array_size);
2974
2975                 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
2976                                        value_bitmap);
2977
2978                 i = find_first_zero_bit(array_info->set_mask, array_size);
2979                 if (i == array_size)
2980                         return 0;
2981         } else {
2982                 array_info = NULL;
2983         }
2984
2985         while (i < array_size) {
2986                 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2987                 DECLARE_BITMAP(fastpath_mask, FASTPATH_NGPIO);
2988                 DECLARE_BITMAP(fastpath_bits, FASTPATH_NGPIO);
2989                 unsigned long *mask, *bits;
2990                 int count = 0;
2991
2992                 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2993                         mask = fastpath_mask;
2994                         bits = fastpath_bits;
2995                 } else {
2996                         gfp_t flags = can_sleep ? GFP_KERNEL : GFP_ATOMIC;
2997
2998                         mask = bitmap_alloc(gc->ngpio, flags);
2999                         if (!mask)
3000                                 return -ENOMEM;
3001
3002                         bits = bitmap_alloc(gc->ngpio, flags);
3003                         if (!bits) {
3004                                 bitmap_free(mask);
3005                                 return -ENOMEM;
3006                         }
3007                 }
3008
3009                 bitmap_zero(mask, gc->ngpio);
3010
3011                 if (!can_sleep)
3012                         WARN_ON(gc->can_sleep);
3013
3014                 do {
3015                         struct gpio_desc *desc = desc_array[i];
3016                         int hwgpio = gpio_chip_hwgpio(desc);
3017                         int value = test_bit(i, value_bitmap);
3018
3019                         /*
3020                          * Pins applicable for fast input but not for
3021                          * fast output processing may have been already
3022                          * inverted inside the fast path, skip them.
3023                          */
3024                         if (!raw && !(array_info &&
3025                             test_bit(i, array_info->invert_mask)) &&
3026                             test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3027                                 value = !value;
3028                         trace_gpio_value(desc_to_gpio(desc), 0, value);
3029                         /*
3030                          * collect all normal outputs belonging to the same chip
3031                          * open drain and open source outputs are set individually
3032                          */
3033                         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
3034                                 gpio_set_open_drain_value_commit(desc, value);
3035                         } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
3036                                 gpio_set_open_source_value_commit(desc, value);
3037                         } else {
3038                                 __set_bit(hwgpio, mask);
3039                                 __assign_bit(hwgpio, bits, value);
3040                                 count++;
3041                         }
3042                         i++;
3043
3044                         if (array_info)
3045                                 i = find_next_zero_bit(array_info->set_mask,
3046                                                        array_size, i);
3047                 } while ((i < array_size) &&
3048                          (desc_array[i]->gdev->chip == gc));
3049                 /* push collected bits to outputs */
3050                 if (count != 0)
3051                         gpio_chip_set_multiple(gc, mask, bits);
3052
3053                 if (mask != fastpath_mask)
3054                         bitmap_free(mask);
3055                 if (bits != fastpath_bits)
3056                         bitmap_free(bits);
3057         }
3058         return 0;
3059 }
3060
3061 /**
3062  * gpiod_set_raw_value() - assign a gpio's raw value
3063  * @desc: gpio whose value will be assigned
3064  * @value: value to assign
3065  *
3066  * Set the raw value of the GPIO, i.e. the value of its physical line without
3067  * regard for its ACTIVE_LOW status.
3068  *
3069  * This function can be called from contexts where we cannot sleep, and will
3070  * complain if the GPIO chip functions potentially sleep.
3071  */
3072 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
3073 {
3074         VALIDATE_DESC_VOID(desc);
3075         /* Should be using gpiod_set_raw_value_cansleep() */
3076         WARN_ON(desc->gdev->chip->can_sleep);
3077         gpiod_set_raw_value_commit(desc, value);
3078 }
3079 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
3080
3081 /**
3082  * gpiod_set_value_nocheck() - set a GPIO line value without checking
3083  * @desc: the descriptor to set the value on
3084  * @value: value to set
3085  *
3086  * This sets the value of a GPIO line backing a descriptor, applying
3087  * different semantic quirks like active low and open drain/source
3088  * handling.
3089  */
3090 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
3091 {
3092         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3093                 value = !value;
3094         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
3095                 gpio_set_open_drain_value_commit(desc, value);
3096         else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
3097                 gpio_set_open_source_value_commit(desc, value);
3098         else
3099                 gpiod_set_raw_value_commit(desc, value);
3100 }
3101
3102 /**
3103  * gpiod_set_value() - assign a gpio's value
3104  * @desc: gpio whose value will be assigned
3105  * @value: value to assign
3106  *
3107  * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
3108  * OPEN_DRAIN and OPEN_SOURCE flags into account.
3109  *
3110  * This function can be called from contexts where we cannot sleep, and will
3111  * complain if the GPIO chip functions potentially sleep.
3112  */
3113 void gpiod_set_value(struct gpio_desc *desc, int value)
3114 {
3115         VALIDATE_DESC_VOID(desc);
3116         /* Should be using gpiod_set_value_cansleep() */
3117         WARN_ON(desc->gdev->chip->can_sleep);
3118         gpiod_set_value_nocheck(desc, value);
3119 }
3120 EXPORT_SYMBOL_GPL(gpiod_set_value);
3121
3122 /**
3123  * gpiod_set_raw_array_value() - assign values to an array of GPIOs
3124  * @array_size: number of elements in the descriptor array / value bitmap
3125  * @desc_array: array of GPIO descriptors whose values will be assigned
3126  * @array_info: information on applicability of fast bitmap processing path
3127  * @value_bitmap: bitmap of values to assign
3128  *
3129  * Set the raw values of the GPIOs, i.e. the values of the physical lines
3130  * without regard for their ACTIVE_LOW status.
3131  *
3132  * This function can be called from contexts where we cannot sleep, and will
3133  * complain if the GPIO chip functions potentially sleep.
3134  */
3135 int gpiod_set_raw_array_value(unsigned int array_size,
3136                               struct gpio_desc **desc_array,
3137                               struct gpio_array *array_info,
3138                               unsigned long *value_bitmap)
3139 {
3140         if (!desc_array)
3141                 return -EINVAL;
3142         return gpiod_set_array_value_complex(true, false, array_size,
3143                                         desc_array, array_info, value_bitmap);
3144 }
3145 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
3146
3147 /**
3148  * gpiod_set_array_value() - assign values to an array of GPIOs
3149  * @array_size: number of elements in the descriptor array / value bitmap
3150  * @desc_array: array of GPIO descriptors whose values will be assigned
3151  * @array_info: information on applicability of fast bitmap processing path
3152  * @value_bitmap: bitmap of values to assign
3153  *
3154  * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3155  * into account.
3156  *
3157  * This function can be called from contexts where we cannot sleep, and will
3158  * complain if the GPIO chip functions potentially sleep.
3159  */
3160 int gpiod_set_array_value(unsigned int array_size,
3161                           struct gpio_desc **desc_array,
3162                           struct gpio_array *array_info,
3163                           unsigned long *value_bitmap)
3164 {
3165         if (!desc_array)
3166                 return -EINVAL;
3167         return gpiod_set_array_value_complex(false, false, array_size,
3168                                              desc_array, array_info,
3169                                              value_bitmap);
3170 }
3171 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3172
3173 /**
3174  * gpiod_cansleep() - report whether gpio value access may sleep
3175  * @desc: gpio to check
3176  *
3177  */
3178 int gpiod_cansleep(const struct gpio_desc *desc)
3179 {
3180         VALIDATE_DESC(desc);
3181         return desc->gdev->chip->can_sleep;
3182 }
3183 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3184
3185 /**
3186  * gpiod_set_consumer_name() - set the consumer name for the descriptor
3187  * @desc: gpio to set the consumer name on
3188  * @name: the new consumer name
3189  */
3190 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3191 {
3192         VALIDATE_DESC(desc);
3193         if (name) {
3194                 name = kstrdup_const(name, GFP_KERNEL);
3195                 if (!name)
3196                         return -ENOMEM;
3197         }
3198
3199         kfree_const(desc->label);
3200         desc_set_label(desc, name);
3201
3202         return 0;
3203 }
3204 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3205
3206 /**
3207  * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3208  * @desc: gpio whose IRQ will be returned (already requested)
3209  *
3210  * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3211  * error.
3212  */
3213 int gpiod_to_irq(const struct gpio_desc *desc)
3214 {
3215         struct gpio_chip *gc;
3216         int offset;
3217
3218         /*
3219          * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3220          * requires this function to not return zero on an invalid descriptor
3221          * but rather a negative error number.
3222          */
3223         if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3224                 return -EINVAL;
3225
3226         gc = desc->gdev->chip;
3227         offset = gpio_chip_hwgpio(desc);
3228         if (gc->to_irq) {
3229                 int retirq = gc->to_irq(gc, offset);
3230
3231                 /* Zero means NO_IRQ */
3232                 if (!retirq)
3233                         return -ENXIO;
3234
3235                 return retirq;
3236         }
3237 #ifdef CONFIG_GPIOLIB_IRQCHIP
3238         if (gc->irq.chip) {
3239                 /*
3240                  * Avoid race condition with other code, which tries to lookup
3241                  * an IRQ before the irqchip has been properly registered,
3242                  * i.e. while gpiochip is still being brought up.
3243                  */
3244                 return -EPROBE_DEFER;
3245         }
3246 #endif
3247         return -ENXIO;
3248 }
3249 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3250
3251 /**
3252  * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3253  * @gc: the chip the GPIO to lock belongs to
3254  * @offset: the offset of the GPIO to lock as IRQ
3255  *
3256  * This is used directly by GPIO drivers that want to lock down
3257  * a certain GPIO line to be used for IRQs.
3258  */
3259 int gpiochip_lock_as_irq(struct gpio_chip *gc, unsigned int offset)
3260 {
3261         struct gpio_desc *desc;
3262
3263         desc = gpiochip_get_desc(gc, offset);
3264         if (IS_ERR(desc))
3265                 return PTR_ERR(desc);
3266
3267         /*
3268          * If it's fast: flush the direction setting if something changed
3269          * behind our back
3270          */
3271         if (!gc->can_sleep && gc->get_direction) {
3272                 int dir = gpiod_get_direction(desc);
3273
3274                 if (dir < 0) {
3275                         chip_err(gc, "%s: cannot get GPIO direction\n",
3276                                  __func__);
3277                         return dir;
3278                 }
3279         }
3280
3281         /* To be valid for IRQ the line needs to be input or open drain */
3282         if (test_bit(FLAG_IS_OUT, &desc->flags) &&
3283             !test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3284                 chip_err(gc,
3285                          "%s: tried to flag a GPIO set as output for IRQ\n",
3286                          __func__);
3287                 return -EIO;
3288         }
3289
3290         set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3291         set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3292
3293         /*
3294          * If the consumer has not set up a label (such as when the
3295          * IRQ is referenced from .to_irq()) we set up a label here
3296          * so it is clear this is used as an interrupt.
3297          */
3298         if (!desc->label)
3299                 desc_set_label(desc, "interrupt");
3300
3301         return 0;
3302 }
3303 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3304
3305 /**
3306  * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3307  * @gc: the chip the GPIO to lock belongs to
3308  * @offset: the offset of the GPIO to lock as IRQ
3309  *
3310  * This is used directly by GPIO drivers that want to indicate
3311  * that a certain GPIO is no longer used exclusively for IRQ.
3312  */
3313 void gpiochip_unlock_as_irq(struct gpio_chip *gc, unsigned int offset)
3314 {
3315         struct gpio_desc *desc;
3316
3317         desc = gpiochip_get_desc(gc, offset);
3318         if (IS_ERR(desc))
3319                 return;
3320
3321         clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3322         clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3323
3324         /* If we only had this marking, erase it */
3325         if (desc->label && !strcmp(desc->label, "interrupt"))
3326                 desc_set_label(desc, NULL);
3327 }
3328 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3329
3330 void gpiochip_disable_irq(struct gpio_chip *gc, unsigned int offset)
3331 {
3332         struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3333
3334         if (!IS_ERR(desc) &&
3335             !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3336                 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3337 }
3338 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3339
3340 void gpiochip_enable_irq(struct gpio_chip *gc, unsigned int offset)
3341 {
3342         struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3343
3344         if (!IS_ERR(desc) &&
3345             !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3346                 /*
3347                  * We must not be output when using IRQ UNLESS we are
3348                  * open drain.
3349                  */
3350                 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags) &&
3351                         !test_bit(FLAG_OPEN_DRAIN, &desc->flags));
3352                 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3353         }
3354 }
3355 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3356
3357 bool gpiochip_line_is_irq(struct gpio_chip *gc, unsigned int offset)
3358 {
3359         if (offset >= gc->ngpio)
3360                 return false;
3361
3362         return test_bit(FLAG_USED_AS_IRQ, &gc->gpiodev->descs[offset].flags);
3363 }
3364 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3365
3366 int gpiochip_reqres_irq(struct gpio_chip *gc, unsigned int offset)
3367 {
3368         int ret;
3369
3370         if (!try_module_get(gc->gpiodev->owner))
3371                 return -ENODEV;
3372
3373         ret = gpiochip_lock_as_irq(gc, offset);
3374         if (ret) {
3375                 chip_err(gc, "unable to lock HW IRQ %u for IRQ\n", offset);
3376                 module_put(gc->gpiodev->owner);
3377                 return ret;
3378         }
3379         return 0;
3380 }
3381 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3382
3383 void gpiochip_relres_irq(struct gpio_chip *gc, unsigned int offset)
3384 {
3385         gpiochip_unlock_as_irq(gc, offset);
3386         module_put(gc->gpiodev->owner);
3387 }
3388 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3389
3390 bool gpiochip_line_is_open_drain(struct gpio_chip *gc, unsigned int offset)
3391 {
3392         if (offset >= gc->ngpio)
3393                 return false;
3394
3395         return test_bit(FLAG_OPEN_DRAIN, &gc->gpiodev->descs[offset].flags);
3396 }
3397 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3398
3399 bool gpiochip_line_is_open_source(struct gpio_chip *gc, unsigned int offset)
3400 {
3401         if (offset >= gc->ngpio)
3402                 return false;
3403
3404         return test_bit(FLAG_OPEN_SOURCE, &gc->gpiodev->descs[offset].flags);
3405 }
3406 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3407
3408 bool gpiochip_line_is_persistent(struct gpio_chip *gc, unsigned int offset)
3409 {
3410         if (offset >= gc->ngpio)
3411                 return false;
3412
3413         return !test_bit(FLAG_TRANSITORY, &gc->gpiodev->descs[offset].flags);
3414 }
3415 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3416
3417 /**
3418  * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3419  * @desc: gpio whose value will be returned
3420  *
3421  * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3422  * its ACTIVE_LOW status, or negative errno on failure.
3423  *
3424  * This function is to be called from contexts that can sleep.
3425  */
3426 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3427 {
3428         might_sleep_if(extra_checks);
3429         VALIDATE_DESC(desc);
3430         return gpiod_get_raw_value_commit(desc);
3431 }
3432 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3433
3434 /**
3435  * gpiod_get_value_cansleep() - return a gpio's value
3436  * @desc: gpio whose value will be returned
3437  *
3438  * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3439  * account, or negative errno on failure.
3440  *
3441  * This function is to be called from contexts that can sleep.
3442  */
3443 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3444 {
3445         int value;
3446
3447         might_sleep_if(extra_checks);
3448         VALIDATE_DESC(desc);
3449         value = gpiod_get_raw_value_commit(desc);
3450         if (value < 0)
3451                 return value;
3452
3453         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3454                 value = !value;
3455
3456         return value;
3457 }
3458 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3459
3460 /**
3461  * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3462  * @array_size: number of elements in the descriptor array / value bitmap
3463  * @desc_array: array of GPIO descriptors whose values will be read
3464  * @array_info: information on applicability of fast bitmap processing path
3465  * @value_bitmap: bitmap to store the read values
3466  *
3467  * Read the raw values of the GPIOs, i.e. the values of the physical lines
3468  * without regard for their ACTIVE_LOW status.  Return 0 in case of success,
3469  * else an error code.
3470  *
3471  * This function is to be called from contexts that can sleep.
3472  */
3473 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3474                                        struct gpio_desc **desc_array,
3475                                        struct gpio_array *array_info,
3476                                        unsigned long *value_bitmap)
3477 {
3478         might_sleep_if(extra_checks);
3479         if (!desc_array)
3480                 return -EINVAL;
3481         return gpiod_get_array_value_complex(true, true, array_size,
3482                                              desc_array, array_info,
3483                                              value_bitmap);
3484 }
3485 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3486
3487 /**
3488  * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3489  * @array_size: number of elements in the descriptor array / value bitmap
3490  * @desc_array: array of GPIO descriptors whose values will be read
3491  * @array_info: information on applicability of fast bitmap processing path
3492  * @value_bitmap: bitmap to store the read values
3493  *
3494  * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3495  * into account.  Return 0 in case of success, else an error code.
3496  *
3497  * This function is to be called from contexts that can sleep.
3498  */
3499 int gpiod_get_array_value_cansleep(unsigned int array_size,
3500                                    struct gpio_desc **desc_array,
3501                                    struct gpio_array *array_info,
3502                                    unsigned long *value_bitmap)
3503 {
3504         might_sleep_if(extra_checks);
3505         if (!desc_array)
3506                 return -EINVAL;
3507         return gpiod_get_array_value_complex(false, true, array_size,
3508                                              desc_array, array_info,
3509                                              value_bitmap);
3510 }
3511 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3512
3513 /**
3514  * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3515  * @desc: gpio whose value will be assigned
3516  * @value: value to assign
3517  *
3518  * Set the raw value of the GPIO, i.e. the value of its physical line without
3519  * regard for its ACTIVE_LOW status.
3520  *
3521  * This function is to be called from contexts that can sleep.
3522  */
3523 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3524 {
3525         might_sleep_if(extra_checks);
3526         VALIDATE_DESC_VOID(desc);
3527         gpiod_set_raw_value_commit(desc, value);
3528 }
3529 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3530
3531 /**
3532  * gpiod_set_value_cansleep() - assign a gpio's value
3533  * @desc: gpio whose value will be assigned
3534  * @value: value to assign
3535  *
3536  * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3537  * account
3538  *
3539  * This function is to be called from contexts that can sleep.
3540  */
3541 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3542 {
3543         might_sleep_if(extra_checks);
3544         VALIDATE_DESC_VOID(desc);
3545         gpiod_set_value_nocheck(desc, value);
3546 }
3547 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3548
3549 /**
3550  * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3551  * @array_size: number of elements in the descriptor array / value bitmap
3552  * @desc_array: array of GPIO descriptors whose values will be assigned
3553  * @array_info: information on applicability of fast bitmap processing path
3554  * @value_bitmap: bitmap of values to assign
3555  *
3556  * Set the raw values of the GPIOs, i.e. the values of the physical lines
3557  * without regard for their ACTIVE_LOW status.
3558  *
3559  * This function is to be called from contexts that can sleep.
3560  */
3561 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3562                                        struct gpio_desc **desc_array,
3563                                        struct gpio_array *array_info,
3564                                        unsigned long *value_bitmap)
3565 {
3566         might_sleep_if(extra_checks);
3567         if (!desc_array)
3568                 return -EINVAL;
3569         return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3570                                       array_info, value_bitmap);
3571 }
3572 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3573
3574 /**
3575  * gpiod_add_lookup_tables() - register GPIO device consumers
3576  * @tables: list of tables of consumers to register
3577  * @n: number of tables in the list
3578  */
3579 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3580 {
3581         unsigned int i;
3582
3583         mutex_lock(&gpio_lookup_lock);
3584
3585         for (i = 0; i < n; i++)
3586                 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3587
3588         mutex_unlock(&gpio_lookup_lock);
3589 }
3590
3591 /**
3592  * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3593  * @array_size: number of elements in the descriptor array / value bitmap
3594  * @desc_array: array of GPIO descriptors whose values will be assigned
3595  * @array_info: information on applicability of fast bitmap processing path
3596  * @value_bitmap: bitmap of values to assign
3597  *
3598  * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3599  * into account.
3600  *
3601  * This function is to be called from contexts that can sleep.
3602  */
3603 int gpiod_set_array_value_cansleep(unsigned int array_size,
3604                                    struct gpio_desc **desc_array,
3605                                    struct gpio_array *array_info,
3606                                    unsigned long *value_bitmap)
3607 {
3608         might_sleep_if(extra_checks);
3609         if (!desc_array)
3610                 return -EINVAL;
3611         return gpiod_set_array_value_complex(false, true, array_size,
3612                                              desc_array, array_info,
3613                                              value_bitmap);
3614 }
3615 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3616
3617 /**
3618  * gpiod_add_lookup_table() - register GPIO device consumers
3619  * @table: table of consumers to register
3620  */
3621 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3622 {
3623         gpiod_add_lookup_tables(&table, 1);
3624 }
3625 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3626
3627 /**
3628  * gpiod_remove_lookup_table() - unregister GPIO device consumers
3629  * @table: table of consumers to unregister
3630  */
3631 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3632 {
3633         /* Nothing to remove */
3634         if (!table)
3635                 return;
3636
3637         mutex_lock(&gpio_lookup_lock);
3638
3639         list_del(&table->list);
3640
3641         mutex_unlock(&gpio_lookup_lock);
3642 }
3643 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3644
3645 /**
3646  * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3647  * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3648  */
3649 void gpiod_add_hogs(struct gpiod_hog *hogs)
3650 {
3651         struct gpio_chip *gc;
3652         struct gpiod_hog *hog;
3653
3654         mutex_lock(&gpio_machine_hogs_mutex);
3655
3656         for (hog = &hogs[0]; hog->chip_label; hog++) {
3657                 list_add_tail(&hog->list, &gpio_machine_hogs);
3658
3659                 /*
3660                  * The chip may have been registered earlier, so check if it
3661                  * exists and, if so, try to hog the line now.
3662                  */
3663                 gc = find_chip_by_name(hog->chip_label);
3664                 if (gc)
3665                         gpiochip_machine_hog(gc, hog);
3666         }
3667
3668         mutex_unlock(&gpio_machine_hogs_mutex);
3669 }
3670 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3671
3672 void gpiod_remove_hogs(struct gpiod_hog *hogs)
3673 {
3674         struct gpiod_hog *hog;
3675
3676         mutex_lock(&gpio_machine_hogs_mutex);
3677         for (hog = &hogs[0]; hog->chip_label; hog++)
3678                 list_del(&hog->list);
3679         mutex_unlock(&gpio_machine_hogs_mutex);
3680 }
3681 EXPORT_SYMBOL_GPL(gpiod_remove_hogs);
3682
3683 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3684 {
3685         const char *dev_id = dev ? dev_name(dev) : NULL;
3686         struct gpiod_lookup_table *table;
3687
3688         mutex_lock(&gpio_lookup_lock);
3689
3690         list_for_each_entry(table, &gpio_lookup_list, list) {
3691                 if (table->dev_id && dev_id) {
3692                         /*
3693                          * Valid strings on both ends, must be identical to have
3694                          * a match
3695                          */
3696                         if (!strcmp(table->dev_id, dev_id))
3697                                 goto found;
3698                 } else {
3699                         /*
3700                          * One of the pointers is NULL, so both must be to have
3701                          * a match
3702                          */
3703                         if (dev_id == table->dev_id)
3704                                 goto found;
3705                 }
3706         }
3707         table = NULL;
3708
3709 found:
3710         mutex_unlock(&gpio_lookup_lock);
3711         return table;
3712 }
3713
3714 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3715                                     unsigned int idx, unsigned long *flags)
3716 {
3717         struct gpio_desc *desc = ERR_PTR(-ENOENT);
3718         struct gpiod_lookup_table *table;
3719         struct gpiod_lookup *p;
3720
3721         table = gpiod_find_lookup_table(dev);
3722         if (!table)
3723                 return desc;
3724
3725         for (p = &table->table[0]; p->key; p++) {
3726                 struct gpio_chip *gc;
3727
3728                 /* idx must always match exactly */
3729                 if (p->idx != idx)
3730                         continue;
3731
3732                 /* If the lookup entry has a con_id, require exact match */
3733                 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3734                         continue;
3735
3736                 if (p->chip_hwnum == U16_MAX) {
3737                         desc = gpio_name_to_desc(p->key);
3738                         if (desc) {
3739                                 *flags = p->flags;
3740                                 return desc;
3741                         }
3742
3743                         dev_warn(dev, "cannot find GPIO line %s, deferring\n",
3744                                  p->key);
3745                         return ERR_PTR(-EPROBE_DEFER);
3746                 }
3747
3748                 gc = find_chip_by_name(p->key);
3749
3750                 if (!gc) {
3751                         /*
3752                          * As the lookup table indicates a chip with
3753                          * p->key should exist, assume it may
3754                          * still appear later and let the interested
3755                          * consumer be probed again or let the Deferred
3756                          * Probe infrastructure handle the error.
3757                          */
3758                         dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3759                                  p->key);
3760                         return ERR_PTR(-EPROBE_DEFER);
3761                 }
3762
3763                 if (gc->ngpio <= p->chip_hwnum) {
3764                         dev_err(dev,
3765                                 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
3766                                 idx, p->chip_hwnum, gc->ngpio - 1,
3767                                 gc->label);
3768                         return ERR_PTR(-EINVAL);
3769                 }
3770
3771                 desc = gpiochip_get_desc(gc, p->chip_hwnum);
3772                 *flags = p->flags;
3773
3774                 return desc;
3775         }
3776
3777         return desc;
3778 }
3779
3780 static int platform_gpio_count(struct device *dev, const char *con_id)
3781 {
3782         struct gpiod_lookup_table *table;
3783         struct gpiod_lookup *p;
3784         unsigned int count = 0;
3785
3786         table = gpiod_find_lookup_table(dev);
3787         if (!table)
3788                 return -ENOENT;
3789
3790         for (p = &table->table[0]; p->key; p++) {
3791                 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3792                     (!con_id && !p->con_id))
3793                         count++;
3794         }
3795         if (!count)
3796                 return -ENOENT;
3797
3798         return count;
3799 }
3800
3801 /**
3802  * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3803  * @fwnode:     handle of the firmware node
3804  * @propname:   name of the firmware property representing the GPIO
3805  * @index:      index of the GPIO to obtain for the consumer
3806  * @dflags:     GPIO initialization flags
3807  * @label:      label to attach to the requested GPIO
3808  *
3809  * This function can be used for drivers that get their configuration
3810  * from opaque firmware.
3811  *
3812  * The function properly finds the corresponding GPIO using whatever is the
3813  * underlying firmware interface and then makes sure that the GPIO
3814  * descriptor is requested before it is returned to the caller.
3815  *
3816  * Returns:
3817  * On successful request the GPIO pin is configured in accordance with
3818  * provided @dflags.
3819  *
3820  * In case of error an ERR_PTR() is returned.
3821  */
3822 static struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3823                                                 const char *propname, int index,
3824                                                 enum gpiod_flags dflags,
3825                                                 const char *label)
3826 {
3827         unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3828         struct gpio_desc *desc = ERR_PTR(-ENODEV);
3829         int ret;
3830
3831         if (is_of_node(fwnode)) {
3832                 desc = gpiod_get_from_of_node(to_of_node(fwnode),
3833                                               propname, index,
3834                                               dflags,
3835                                               label);
3836                 return desc;
3837         } else if (is_acpi_node(fwnode)) {
3838                 struct acpi_gpio_info info;
3839
3840                 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
3841                 if (IS_ERR(desc))
3842                         return desc;
3843
3844                 acpi_gpio_update_gpiod_flags(&dflags, &info);
3845                 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
3846         } else {
3847                 return ERR_PTR(-EINVAL);
3848         }
3849
3850         /* Currently only ACPI takes this path */
3851         ret = gpiod_request(desc, label);
3852         if (ret)
3853                 return ERR_PTR(ret);
3854
3855         ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3856         if (ret < 0) {
3857                 gpiod_put(desc);
3858                 return ERR_PTR(ret);
3859         }
3860
3861         blocking_notifier_call_chain(&desc->gdev->notifier,
3862                                      GPIOLINE_CHANGED_REQUESTED, desc);
3863
3864         return desc;
3865 }
3866
3867 /**
3868  * fwnode_gpiod_get_index - obtain a GPIO from firmware node
3869  * @fwnode:     handle of the firmware node
3870  * @con_id:     function within the GPIO consumer
3871  * @index:      index of the GPIO to obtain for the consumer
3872  * @flags:      GPIO initialization flags
3873  * @label:      label to attach to the requested GPIO
3874  *
3875  * This function can be used for drivers that get their configuration
3876  * from opaque firmware.
3877  *
3878  * The function properly finds the corresponding GPIO using whatever is the
3879  * underlying firmware interface and then makes sure that the GPIO
3880  * descriptor is requested before it is returned to the caller.
3881  *
3882  * Returns:
3883  * On successful request the GPIO pin is configured in accordance with
3884  * provided @flags.
3885  *
3886  * In case of error an ERR_PTR() is returned.
3887  */
3888 struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
3889                                          const char *con_id, int index,
3890                                          enum gpiod_flags flags,
3891                                          const char *label)
3892 {
3893         struct gpio_desc *desc;
3894         char prop_name[32]; /* 32 is max size of property name */
3895         unsigned int i;
3896
3897         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3898                 if (con_id)
3899                         snprintf(prop_name, sizeof(prop_name), "%s-%s",
3900                                             con_id, gpio_suffixes[i]);
3901                 else
3902                         snprintf(prop_name, sizeof(prop_name), "%s",
3903                                             gpio_suffixes[i]);
3904
3905                 desc = fwnode_get_named_gpiod(fwnode, prop_name, index, flags,
3906                                               label);
3907                 if (!gpiod_not_found(desc))
3908                         break;
3909         }
3910
3911         return desc;
3912 }
3913 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index);
3914
3915 /**
3916  * gpiod_count - return the number of GPIOs associated with a device / function
3917  *              or -ENOENT if no GPIO has been assigned to the requested function
3918  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3919  * @con_id:     function within the GPIO consumer
3920  */
3921 int gpiod_count(struct device *dev, const char *con_id)
3922 {
3923         const struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
3924         int count = -ENOENT;
3925
3926         if (is_of_node(fwnode))
3927                 count = of_gpio_get_count(dev, con_id);
3928         else if (is_acpi_node(fwnode))
3929                 count = acpi_gpio_count(dev, con_id);
3930
3931         if (count < 0)
3932                 count = platform_gpio_count(dev, con_id);
3933
3934         return count;
3935 }
3936 EXPORT_SYMBOL_GPL(gpiod_count);
3937
3938 /**
3939  * gpiod_get - obtain a GPIO for a given GPIO function
3940  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3941  * @con_id:     function within the GPIO consumer
3942  * @flags:      optional GPIO initialization flags
3943  *
3944  * Return the GPIO descriptor corresponding to the function con_id of device
3945  * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3946  * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3947  */
3948 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3949                                          enum gpiod_flags flags)
3950 {
3951         return gpiod_get_index(dev, con_id, 0, flags);
3952 }
3953 EXPORT_SYMBOL_GPL(gpiod_get);
3954
3955 /**
3956  * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3957  * @dev: GPIO consumer, can be NULL for system-global GPIOs
3958  * @con_id: function within the GPIO consumer
3959  * @flags: optional GPIO initialization flags
3960  *
3961  * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3962  * the requested function it will return NULL. This is convenient for drivers
3963  * that need to handle optional GPIOs.
3964  */
3965 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3966                                                   const char *con_id,
3967                                                   enum gpiod_flags flags)
3968 {
3969         return gpiod_get_index_optional(dev, con_id, 0, flags);
3970 }
3971 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3972
3973
3974 /**
3975  * gpiod_configure_flags - helper function to configure a given GPIO
3976  * @desc:       gpio whose value will be assigned
3977  * @con_id:     function within the GPIO consumer
3978  * @lflags:     bitmask of gpio_lookup_flags GPIO_* values - returned from
3979  *              of_find_gpio() or of_get_gpio_hog()
3980  * @dflags:     gpiod_flags - optional GPIO initialization flags
3981  *
3982  * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3983  * requested function and/or index, or another IS_ERR() code if an error
3984  * occurred while trying to acquire the GPIO.
3985  */
3986 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3987                 unsigned long lflags, enum gpiod_flags dflags)
3988 {
3989         int ret;
3990
3991         if (lflags & GPIO_ACTIVE_LOW)
3992                 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3993
3994         if (lflags & GPIO_OPEN_DRAIN)
3995                 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3996         else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
3997                 /*
3998                  * This enforces open drain mode from the consumer side.
3999                  * This is necessary for some busses like I2C, but the lookup
4000                  * should *REALLY* have specified them as open drain in the
4001                  * first place, so print a little warning here.
4002                  */
4003                 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
4004                 gpiod_warn(desc,
4005                            "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
4006         }
4007
4008         if (lflags & GPIO_OPEN_SOURCE)
4009                 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
4010
4011         if (((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) ||
4012             ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DISABLE)) ||
4013             ((lflags & GPIO_PULL_DOWN) && (lflags & GPIO_PULL_DISABLE))) {
4014                 gpiod_err(desc,
4015                           "multiple pull-up, pull-down or pull-disable enabled, invalid configuration\n");
4016                 return -EINVAL;
4017         }
4018
4019         if (lflags & GPIO_PULL_UP)
4020                 set_bit(FLAG_PULL_UP, &desc->flags);
4021         else if (lflags & GPIO_PULL_DOWN)
4022                 set_bit(FLAG_PULL_DOWN, &desc->flags);
4023         else if (lflags & GPIO_PULL_DISABLE)
4024                 set_bit(FLAG_BIAS_DISABLE, &desc->flags);
4025
4026         ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
4027         if (ret < 0)
4028                 return ret;
4029
4030         /* No particular flag request, return here... */
4031         if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
4032                 gpiod_dbg(desc, "no flags found for %s\n", con_id);
4033                 return 0;
4034         }
4035
4036         /* Process flags */
4037         if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
4038                 ret = gpiod_direction_output(desc,
4039                                 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
4040         else
4041                 ret = gpiod_direction_input(desc);
4042
4043         return ret;
4044 }
4045
4046 /**
4047  * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
4048  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
4049  * @con_id:     function within the GPIO consumer
4050  * @idx:        index of the GPIO to obtain in the consumer
4051  * @flags:      optional GPIO initialization flags
4052  *
4053  * This variant of gpiod_get() allows to access GPIOs other than the first
4054  * defined one for functions that define several GPIOs.
4055  *
4056  * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
4057  * requested function and/or index, or another IS_ERR() code if an error
4058  * occurred while trying to acquire the GPIO.
4059  */
4060 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
4061                                                const char *con_id,
4062                                                unsigned int idx,
4063                                                enum gpiod_flags flags)
4064 {
4065         unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
4066         struct gpio_desc *desc = NULL;
4067         int ret;
4068         /* Maybe we have a device name, maybe not */
4069         const char *devname = dev ? dev_name(dev) : "?";
4070         const struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
4071
4072         dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
4073
4074         /* Using device tree? */
4075         if (is_of_node(fwnode)) {
4076                 dev_dbg(dev, "using device tree for GPIO lookup\n");
4077                 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
4078         } else if (is_acpi_node(fwnode)) {
4079                 dev_dbg(dev, "using ACPI for GPIO lookup\n");
4080                 desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
4081         }
4082
4083         /*
4084          * Either we are not using DT or ACPI, or their lookup did not return
4085          * a result. In that case, use platform lookup as a fallback.
4086          */
4087         if (!desc || gpiod_not_found(desc)) {
4088                 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
4089                 desc = gpiod_find(dev, con_id, idx, &lookupflags);
4090         }
4091
4092         if (IS_ERR(desc)) {
4093                 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
4094                 return desc;
4095         }
4096
4097         /*
4098          * If a connection label was passed use that, else attempt to use
4099          * the device name as label
4100          */
4101         ret = gpiod_request(desc, con_id ?: devname);
4102         if (ret) {
4103                 if (!(ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE))
4104                         return ERR_PTR(ret);
4105
4106                 /*
4107                  * This happens when there are several consumers for
4108                  * the same GPIO line: we just return here without
4109                  * further initialization. It is a bit of a hack.
4110                  * This is necessary to support fixed regulators.
4111                  *
4112                  * FIXME: Make this more sane and safe.
4113                  */
4114                 dev_info(dev, "nonexclusive access to GPIO for %s\n", con_id ?: devname);
4115                 return desc;
4116         }
4117
4118         ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
4119         if (ret < 0) {
4120                 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
4121                 gpiod_put(desc);
4122                 return ERR_PTR(ret);
4123         }
4124
4125         blocking_notifier_call_chain(&desc->gdev->notifier,
4126                                      GPIOLINE_CHANGED_REQUESTED, desc);
4127
4128         return desc;
4129 }
4130 EXPORT_SYMBOL_GPL(gpiod_get_index);
4131
4132 /**
4133  * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
4134  *                            function
4135  * @dev: GPIO consumer, can be NULL for system-global GPIOs
4136  * @con_id: function within the GPIO consumer
4137  * @index: index of the GPIO to obtain in the consumer
4138  * @flags: optional GPIO initialization flags
4139  *
4140  * This is equivalent to gpiod_get_index(), except that when no GPIO with the
4141  * specified index was assigned to the requested function it will return NULL.
4142  * This is convenient for drivers that need to handle optional GPIOs.
4143  */
4144 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
4145                                                         const char *con_id,
4146                                                         unsigned int index,
4147                                                         enum gpiod_flags flags)
4148 {
4149         struct gpio_desc *desc;
4150
4151         desc = gpiod_get_index(dev, con_id, index, flags);
4152         if (gpiod_not_found(desc))
4153                 return NULL;
4154
4155         return desc;
4156 }
4157 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
4158
4159 /**
4160  * gpiod_hog - Hog the specified GPIO desc given the provided flags
4161  * @desc:       gpio whose value will be assigned
4162  * @name:       gpio line name
4163  * @lflags:     bitmask of gpio_lookup_flags GPIO_* values - returned from
4164  *              of_find_gpio() or of_get_gpio_hog()
4165  * @dflags:     gpiod_flags - optional GPIO initialization flags
4166  */
4167 int gpiod_hog(struct gpio_desc *desc, const char *name,
4168               unsigned long lflags, enum gpiod_flags dflags)
4169 {
4170         struct gpio_chip *gc;
4171         struct gpio_desc *local_desc;
4172         int hwnum;
4173         int ret;
4174
4175         gc = gpiod_to_chip(desc);
4176         hwnum = gpio_chip_hwgpio(desc);
4177
4178         local_desc = gpiochip_request_own_desc(gc, hwnum, name,
4179                                                lflags, dflags);
4180         if (IS_ERR(local_desc)) {
4181                 ret = PTR_ERR(local_desc);
4182                 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4183                        name, gc->label, hwnum, ret);
4184                 return ret;
4185         }
4186
4187         /* Mark GPIO as hogged so it can be identified and removed later */
4188         set_bit(FLAG_IS_HOGGED, &desc->flags);
4189
4190         gpiod_info(desc, "hogged as %s%s\n",
4191                 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4192                 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ?
4193                   (dflags & GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low" : "");
4194
4195         return 0;
4196 }
4197
4198 /**
4199  * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4200  * @gc: gpio chip to act on
4201  */
4202 static void gpiochip_free_hogs(struct gpio_chip *gc)
4203 {
4204         struct gpio_desc *desc;
4205
4206         for_each_gpio_desc_with_flag(gc, desc, FLAG_IS_HOGGED)
4207                 gpiochip_free_own_desc(desc);
4208 }
4209
4210 /**
4211  * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4212  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
4213  * @con_id:     function within the GPIO consumer
4214  * @flags:      optional GPIO initialization flags
4215  *
4216  * This function acquires all the GPIOs defined under a given function.
4217  *
4218  * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4219  * no GPIO has been assigned to the requested function, or another IS_ERR()
4220  * code if an error occurred while trying to acquire the GPIOs.
4221  */
4222 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4223                                                 const char *con_id,
4224                                                 enum gpiod_flags flags)
4225 {
4226         struct gpio_desc *desc;
4227         struct gpio_descs *descs;
4228         struct gpio_array *array_info = NULL;
4229         struct gpio_chip *gc;
4230         int count, bitmap_size;
4231
4232         count = gpiod_count(dev, con_id);
4233         if (count < 0)
4234                 return ERR_PTR(count);
4235
4236         descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4237         if (!descs)
4238                 return ERR_PTR(-ENOMEM);
4239
4240         for (descs->ndescs = 0; descs->ndescs < count; ) {
4241                 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4242                 if (IS_ERR(desc)) {
4243                         gpiod_put_array(descs);
4244                         return ERR_CAST(desc);
4245                 }
4246
4247                 descs->desc[descs->ndescs] = desc;
4248
4249                 gc = gpiod_to_chip(desc);
4250                 /*
4251                  * If pin hardware number of array member 0 is also 0, select
4252                  * its chip as a candidate for fast bitmap processing path.
4253                  */
4254                 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4255                         struct gpio_descs *array;
4256
4257                         bitmap_size = BITS_TO_LONGS(gc->ngpio > count ?
4258                                                     gc->ngpio : count);
4259
4260                         array = kzalloc(struct_size(descs, desc, count) +
4261                                         struct_size(array_info, invert_mask,
4262                                         3 * bitmap_size), GFP_KERNEL);
4263                         if (!array) {
4264                                 gpiod_put_array(descs);
4265                                 return ERR_PTR(-ENOMEM);
4266                         }
4267
4268                         memcpy(array, descs,
4269                                struct_size(descs, desc, descs->ndescs + 1));
4270                         kfree(descs);
4271
4272                         descs = array;
4273                         array_info = (void *)(descs->desc + count);
4274                         array_info->get_mask = array_info->invert_mask +
4275                                                   bitmap_size;
4276                         array_info->set_mask = array_info->get_mask +
4277                                                   bitmap_size;
4278
4279                         array_info->desc = descs->desc;
4280                         array_info->size = count;
4281                         array_info->chip = gc;
4282                         bitmap_set(array_info->get_mask, descs->ndescs,
4283                                    count - descs->ndescs);
4284                         bitmap_set(array_info->set_mask, descs->ndescs,
4285                                    count - descs->ndescs);
4286                         descs->info = array_info;
4287                 }
4288                 /* Unmark array members which don't belong to the 'fast' chip */
4289                 if (array_info && array_info->chip != gc) {
4290                         __clear_bit(descs->ndescs, array_info->get_mask);
4291                         __clear_bit(descs->ndescs, array_info->set_mask);
4292                 }
4293                 /*
4294                  * Detect array members which belong to the 'fast' chip
4295                  * but their pins are not in hardware order.
4296                  */
4297                 else if (array_info &&
4298                            gpio_chip_hwgpio(desc) != descs->ndescs) {
4299                         /*
4300                          * Don't use fast path if all array members processed so
4301                          * far belong to the same chip as this one but its pin
4302                          * hardware number is different from its array index.
4303                          */
4304                         if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4305                                 array_info = NULL;
4306                         } else {
4307                                 __clear_bit(descs->ndescs,
4308                                             array_info->get_mask);
4309                                 __clear_bit(descs->ndescs,
4310                                             array_info->set_mask);
4311                         }
4312                 } else if (array_info) {
4313                         /* Exclude open drain or open source from fast output */
4314                         if (gpiochip_line_is_open_drain(gc, descs->ndescs) ||
4315                             gpiochip_line_is_open_source(gc, descs->ndescs))
4316                                 __clear_bit(descs->ndescs,
4317                                             array_info->set_mask);
4318                         /* Identify 'fast' pins which require invertion */
4319                         if (gpiod_is_active_low(desc))
4320                                 __set_bit(descs->ndescs,
4321                                           array_info->invert_mask);
4322                 }
4323
4324                 descs->ndescs++;
4325         }
4326         if (array_info)
4327                 dev_dbg(dev,
4328                         "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4329                         array_info->chip->label, array_info->size,
4330                         *array_info->get_mask, *array_info->set_mask,
4331                         *array_info->invert_mask);
4332         return descs;
4333 }
4334 EXPORT_SYMBOL_GPL(gpiod_get_array);
4335
4336 /**
4337  * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4338  *                            function
4339  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
4340  * @con_id:     function within the GPIO consumer
4341  * @flags:      optional GPIO initialization flags
4342  *
4343  * This is equivalent to gpiod_get_array(), except that when no GPIO was
4344  * assigned to the requested function it will return NULL.
4345  */
4346 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4347                                                         const char *con_id,
4348                                                         enum gpiod_flags flags)
4349 {
4350         struct gpio_descs *descs;
4351
4352         descs = gpiod_get_array(dev, con_id, flags);
4353         if (gpiod_not_found(descs))
4354                 return NULL;
4355
4356         return descs;
4357 }
4358 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4359
4360 /**
4361  * gpiod_put - dispose of a GPIO descriptor
4362  * @desc:       GPIO descriptor to dispose of
4363  *
4364  * No descriptor can be used after gpiod_put() has been called on it.
4365  */
4366 void gpiod_put(struct gpio_desc *desc)
4367 {
4368         if (desc)
4369                 gpiod_free(desc);
4370 }
4371 EXPORT_SYMBOL_GPL(gpiod_put);
4372
4373 /**
4374  * gpiod_put_array - dispose of multiple GPIO descriptors
4375  * @descs:      struct gpio_descs containing an array of descriptors
4376  */
4377 void gpiod_put_array(struct gpio_descs *descs)
4378 {
4379         unsigned int i;
4380
4381         for (i = 0; i < descs->ndescs; i++)
4382                 gpiod_put(descs->desc[i]);
4383
4384         kfree(descs);
4385 }
4386 EXPORT_SYMBOL_GPL(gpiod_put_array);
4387
4388
4389 static int gpio_bus_match(struct device *dev, struct device_driver *drv)
4390 {
4391         struct fwnode_handle *fwnode = dev_fwnode(dev);
4392
4393         /*
4394          * Only match if the fwnode doesn't already have a proper struct device
4395          * created for it.
4396          */
4397         if (fwnode && fwnode->dev != dev)
4398                 return 0;
4399         return 1;
4400 }
4401
4402 static int gpio_stub_drv_probe(struct device *dev)
4403 {
4404         /*
4405          * The DT node of some GPIO chips have a "compatible" property, but
4406          * never have a struct device added and probed by a driver to register
4407          * the GPIO chip with gpiolib. In such cases, fw_devlink=on will cause
4408          * the consumers of the GPIO chip to get probe deferred forever because
4409          * they will be waiting for a device associated with the GPIO chip
4410          * firmware node to get added and bound to a driver.
4411          *
4412          * To allow these consumers to probe, we associate the struct
4413          * gpio_device of the GPIO chip with the firmware node and then simply
4414          * bind it to this stub driver.
4415          */
4416         return 0;
4417 }
4418
4419 static struct device_driver gpio_stub_drv = {
4420         .name = "gpio_stub_drv",
4421         .bus = &gpio_bus_type,
4422         .probe = gpio_stub_drv_probe,
4423 };
4424
4425 static int __init gpiolib_dev_init(void)
4426 {
4427         int ret;
4428
4429         /* Register GPIO sysfs bus */
4430         ret = bus_register(&gpio_bus_type);
4431         if (ret < 0) {
4432                 pr_err("gpiolib: could not register GPIO bus type\n");
4433                 return ret;
4434         }
4435
4436         ret = driver_register(&gpio_stub_drv);
4437         if (ret < 0) {
4438                 pr_err("gpiolib: could not register GPIO stub driver\n");
4439                 bus_unregister(&gpio_bus_type);
4440                 return ret;
4441         }
4442
4443         ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, GPIOCHIP_NAME);
4444         if (ret < 0) {
4445                 pr_err("gpiolib: failed to allocate char dev region\n");
4446                 driver_unregister(&gpio_stub_drv);
4447                 bus_unregister(&gpio_bus_type);
4448                 return ret;
4449         }
4450
4451         gpiolib_initialized = true;
4452         gpiochip_setup_devs();
4453
4454 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4455         WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier));
4456 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4457
4458         return ret;
4459 }
4460 core_initcall(gpiolib_dev_init);
4461
4462 #ifdef CONFIG_DEBUG_FS
4463
4464 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4465 {
4466         struct gpio_chip        *gc = gdev->chip;
4467         struct gpio_desc        *desc;
4468         unsigned                gpio = gdev->base;
4469         int                     value;
4470         bool                    is_out;
4471         bool                    is_irq;
4472         bool                    active_low;
4473
4474         for_each_gpio_desc(gc, desc) {
4475                 if (test_bit(FLAG_REQUESTED, &desc->flags)) {
4476                         gpiod_get_direction(desc);
4477                         is_out = test_bit(FLAG_IS_OUT, &desc->flags);
4478                         value = gpio_chip_get_value(gc, desc);
4479                         is_irq = test_bit(FLAG_USED_AS_IRQ, &desc->flags);
4480                         active_low = test_bit(FLAG_ACTIVE_LOW, &desc->flags);
4481                         seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s\n",
4482                                    gpio, desc->name ?: "", desc->label,
4483                                    is_out ? "out" : "in ",
4484                                    value >= 0 ? (value ? "hi" : "lo") : "?  ",
4485                                    is_irq ? "IRQ " : "",
4486                                    active_low ? "ACTIVE LOW" : "");
4487                 } else if (desc->name) {
4488                         seq_printf(s, " gpio-%-3d (%-20.20s)\n", gpio, desc->name);
4489                 }
4490
4491                 gpio++;
4492         }
4493 }
4494
4495 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4496 {
4497         unsigned long flags;
4498         struct gpio_device *gdev = NULL;
4499         loff_t index = *pos;
4500
4501         s->private = "";
4502
4503         spin_lock_irqsave(&gpio_lock, flags);
4504         list_for_each_entry(gdev, &gpio_devices, list)
4505                 if (index-- == 0) {
4506                         spin_unlock_irqrestore(&gpio_lock, flags);
4507                         return gdev;
4508                 }
4509         spin_unlock_irqrestore(&gpio_lock, flags);
4510
4511         return NULL;
4512 }
4513
4514 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4515 {
4516         unsigned long flags;
4517         struct gpio_device *gdev = v;
4518         void *ret = NULL;
4519
4520         spin_lock_irqsave(&gpio_lock, flags);
4521         if (list_is_last(&gdev->list, &gpio_devices))
4522                 ret = NULL;
4523         else
4524                 ret = list_first_entry(&gdev->list, struct gpio_device, list);
4525         spin_unlock_irqrestore(&gpio_lock, flags);
4526
4527         s->private = "\n";
4528         ++*pos;
4529
4530         return ret;
4531 }
4532
4533 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4534 {
4535 }
4536
4537 static int gpiolib_seq_show(struct seq_file *s, void *v)
4538 {
4539         struct gpio_device *gdev = v;
4540         struct gpio_chip *gc = gdev->chip;
4541         struct device *parent;
4542
4543         if (!gc) {
4544                 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4545                            dev_name(&gdev->dev));
4546                 return 0;
4547         }
4548
4549         seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4550                    dev_name(&gdev->dev),
4551                    gdev->base, gdev->base + gdev->ngpio - 1);
4552         parent = gc->parent;
4553         if (parent)
4554                 seq_printf(s, ", parent: %s/%s",
4555                            parent->bus ? parent->bus->name : "no-bus",
4556                            dev_name(parent));
4557         if (gc->label)
4558                 seq_printf(s, ", %s", gc->label);
4559         if (gc->can_sleep)
4560                 seq_printf(s, ", can sleep");
4561         seq_printf(s, ":\n");
4562
4563         if (gc->dbg_show)
4564                 gc->dbg_show(s, gc);
4565         else
4566                 gpiolib_dbg_show(s, gdev);
4567
4568         return 0;
4569 }
4570
4571 static const struct seq_operations gpiolib_sops = {
4572         .start = gpiolib_seq_start,
4573         .next = gpiolib_seq_next,
4574         .stop = gpiolib_seq_stop,
4575         .show = gpiolib_seq_show,
4576 };
4577 DEFINE_SEQ_ATTRIBUTE(gpiolib);
4578
4579 static int __init gpiolib_debugfs_init(void)
4580 {
4581         /* /sys/kernel/debug/gpio */
4582         debugfs_create_file("gpio", 0444, NULL, NULL, &gpiolib_fops);
4583         return 0;
4584 }
4585 subsys_initcall(gpiolib_debugfs_init);
4586
4587 #endif  /* DEBUG_FS */