drivers/gpio/gpiolib.c

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