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