drivers/gpio/gpiolib.c

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