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