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