drivers/gpio/gpiolib.c

   1 #include <linux/bitmap.h>
   2 #include <linux/kernel.h>
   3 #include <linux/module.h>
   4 #include <linux/interrupt.h>
   5 #include <linux/irq.h>
   6 #include <linux/spinlock.h>
   7 #include <linux/list.h>
   8 #include <linux/device.h>
   9 #include <linux/err.h>
  10 #include <linux/debugfs.h>
  11 #include <linux/seq_file.h>
  12 #include <linux/gpio.h>
  13 #include <linux/of_gpio.h>
  14 #include <linux/idr.h>
  15 #include <linux/slab.h>
  16 #include <linux/acpi.h>
  17 #include <linux/gpio/driver.h>
  18 #include <linux/gpio/machine.h>
  19 #include <linux/pinctrl/consumer.h>
  20 #include <linux/cdev.h>
  21 #include <linux/fs.h>
  22 #include <linux/uaccess.h>
  23 #include <linux/compat.h>
  24 #include <linux/anon_inodes.h>
  25 #include <linux/file.h>
  26 #include <linux/kfifo.h>
  27 #include <linux/poll.h>
  28 #include <linux/timekeeping.h>
  29 #include <uapi/linux/gpio.h>
  30
  31 #include "gpiolib.h"
  32
  33 #define CREATE_TRACE_POINTS
  34 #include <trace/events/gpio.h>
  35
  36 /* Implementation infrastructure for GPIO interfaces.
  37  *
  38  * The GPIO programming interface allows for inlining speed-critical
  39  * get/set operations for common cases, so that access to SOC-integrated
  40  * GPIOs can sometimes cost only an instruction or two per bit.
  41  */
  42
  43
  44 /* When debugging, extend minimal trust to callers and platform code.
  45  * Also emit diagnostic messages that may help initial bringup, when
  46  * board setup or driver bugs are most common.
  47  *
  48  * Otherwise, minimize overhead in what may be bitbanging codepaths.
  49  */
  50 #ifdef  DEBUG
  51 #define extra_checks    1
  52 #else
  53 #define extra_checks    0
  54 #endif
  55
  56 /* Device and char device-related information */
  57 static DEFINE_IDA(gpio_ida);
  58 static dev_t gpio_devt;
  59 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
  60 static struct bus_type gpio_bus_type = {
  61         .name = "gpio",
  62 };
  63
  64 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
  65  * While any GPIO is requested, its gpio_chip is not removable;
  66  * each GPIO's "requested" flag serves as a lock and refcount.
  67  */
  68 DEFINE_SPINLOCK(gpio_lock);
  69
  70 static DEFINE_MUTEX(gpio_lookup_lock);
  71 static LIST_HEAD(gpio_lookup_list);
  72 LIST_HEAD(gpio_devices);
  73
  74 static void gpiochip_free_hogs(struct gpio_chip *chip);
  75 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
  76 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip);
  77 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip);
  78
  79 static bool gpiolib_initialized;
  80
  81 static inline void desc_set_label(struct gpio_desc *d, const char *label)
  82 {
  83         d->label = label;
  84 }
  85
  86 /**
  87  * Convert a GPIO number to its descriptor
  88  */
  89 struct gpio_desc *gpio_to_desc(unsigned gpio)
  90 {
  91         struct gpio_device *gdev;
  92         unsigned long flags;
  93
  94         spin_lock_irqsave(&gpio_lock, flags);
  95
  96         list_for_each_entry(gdev, &gpio_devices, list) {
  97                 if (gdev->base <= gpio &&
  98                     gdev->base + gdev->ngpio > gpio) {
  99                         spin_unlock_irqrestore(&gpio_lock, flags);
 100                         return &gdev->descs[gpio - gdev->base];
 101                 }
 102         }
 103
 104         spin_unlock_irqrestore(&gpio_lock, flags);
 105
 106         if (!gpio_is_valid(gpio))
 107                 WARN(1, "invalid GPIO %d\n", gpio);
 108
 109         return NULL;
 110 }
 111 EXPORT_SYMBOL_GPL(gpio_to_desc);
 112
 113 /**
 114  * Get the GPIO descriptor corresponding to the given hw number for this chip.
 115  */
 116 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
 117                                     u16 hwnum)
 118 {
 119         struct gpio_device *gdev = chip->gpiodev;
 120
 121         if (hwnum >= gdev->ngpio)
 122                 return ERR_PTR(-EINVAL);
 123
 124         return &gdev->descs[hwnum];
 125 }
 126
 127 /**
 128  * Convert a GPIO descriptor to the integer namespace.
 129  * This should disappear in the future but is needed since we still
 130  * use GPIO numbers for error messages and sysfs nodes
 131  */
 132 int desc_to_gpio(const struct gpio_desc *desc)
 133 {
 134         return desc->gdev->base + (desc - &desc->gdev->descs[0]);
 135 }
 136 EXPORT_SYMBOL_GPL(desc_to_gpio);
 137
 138
 139 /**
 140  * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
 141  * @desc:       descriptor to return the chip of
 142  */
 143 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
 144 {
 145         if (!desc || !desc->gdev || !desc->gdev->chip)
 146                 return NULL;
 147         return desc->gdev->chip;
 148 }
 149 EXPORT_SYMBOL_GPL(gpiod_to_chip);
 150
 151 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
 152 static int gpiochip_find_base(int ngpio)
 153 {
 154         struct gpio_device *gdev;
 155         int base = ARCH_NR_GPIOS - ngpio;
 156
 157         list_for_each_entry_reverse(gdev, &gpio_devices, list) {
 158                 /* found a free space? */
 159                 if (gdev->base + gdev->ngpio <= base)
 160                         break;
 161                 else
 162                         /* nope, check the space right before the chip */
 163                         base = gdev->base - ngpio;
 164         }
 165
 166         if (gpio_is_valid(base)) {
 167                 pr_debug("%s: found new base at %d\n", __func__, base);
 168                 return base;
 169         } else {
 170                 pr_err("%s: cannot find free range\n", __func__);
 171                 return -ENOSPC;
 172         }
 173 }
 174
 175 /**
 176  * gpiod_get_direction - return the current direction of a GPIO
 177  * @desc:       GPIO to get the direction of
 178  *
 179  * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error.
 180  *
 181  * This function may sleep if gpiod_cansleep() is true.
 182  */
 183 int gpiod_get_direction(struct gpio_desc *desc)
 184 {
 185         struct gpio_chip        *chip;
 186         unsigned                offset;
 187         int                     status = -EINVAL;
 188
 189         chip = gpiod_to_chip(desc);
 190         offset = gpio_chip_hwgpio(desc);
 191
 192         if (!chip->get_direction)
 193                 return status;
 194
 195         status = chip->get_direction(chip, offset);
 196         if (status > 0) {
 197                 /* GPIOF_DIR_IN, or other positive */
 198                 status = 1;
 199                 clear_bit(FLAG_IS_OUT, &desc->flags);
 200         }
 201         if (status == 0) {
 202                 /* GPIOF_DIR_OUT */
 203                 set_bit(FLAG_IS_OUT, &desc->flags);
 204         }
 205         return status;
 206 }
 207 EXPORT_SYMBOL_GPL(gpiod_get_direction);
 208
 209 /*
 210  * Add a new chip to the global chips list, keeping the list of chips sorted
 211  * by range(means [base, base + ngpio - 1]) order.
 212  *
 213  * Return -EBUSY if the new chip overlaps with some other chip's integer
 214  * space.
 215  */
 216 static int gpiodev_add_to_list(struct gpio_device *gdev)
 217 {
 218         struct gpio_device *prev, *next;
 219
 220         if (list_empty(&gpio_devices)) {
 221                 /* initial entry in list */
 222                 list_add_tail(&gdev->list, &gpio_devices);
 223                 return 0;
 224         }
 225
 226         next = list_entry(gpio_devices.next, struct gpio_device, list);
 227         if (gdev->base + gdev->ngpio <= next->base) {
 228                 /* add before first entry */
 229                 list_add(&gdev->list, &gpio_devices);
 230                 return 0;
 231         }
 232
 233         prev = list_entry(gpio_devices.prev, struct gpio_device, list);
 234         if (prev->base + prev->ngpio <= gdev->base) {
 235                 /* add behind last entry */
 236                 list_add_tail(&gdev->list, &gpio_devices);
 237                 return 0;
 238         }
 239
 240         list_for_each_entry_safe(prev, next, &gpio_devices, list) {
 241                 /* at the end of the list */
 242                 if (&next->list == &gpio_devices)
 243                         break;
 244
 245                 /* add between prev and next */
 246                 if (prev->base + prev->ngpio <= gdev->base
 247                                 && gdev->base + gdev->ngpio <= next->base) {
 248                         list_add(&gdev->list, &prev->list);
 249                         return 0;
 250                 }
 251         }
 252
 253         dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
 254         return -EBUSY;
 255 }
 256
 257 /**
 258  * Convert a GPIO name to its descriptor
 259  */
 260 static struct gpio_desc *gpio_name_to_desc(const char * const name)
 261 {
 262         struct gpio_device *gdev;
 263         unsigned long flags;
 264
 265         spin_lock_irqsave(&gpio_lock, flags);
 266
 267         list_for_each_entry(gdev, &gpio_devices, list) {
 268                 int i;
 269
 270                 for (i = 0; i != gdev->ngpio; ++i) {
 271                         struct gpio_desc *desc = &gdev->descs[i];
 272
 273                         if (!desc->name || !name)
 274                                 continue;
 275
 276                         if (!strcmp(desc->name, name)) {
 277                                 spin_unlock_irqrestore(&gpio_lock, flags);
 278                                 return desc;
 279                         }
 280                 }
 281         }
 282
 283         spin_unlock_irqrestore(&gpio_lock, flags);
 284
 285         return NULL;
 286 }
 287
 288 /*
 289  * Takes the names from gc->names and checks if they are all unique. If they
 290  * are, they are assigned to their gpio descriptors.
 291  *
 292  * Warning if one of the names is already used for a different GPIO.
 293  */
 294 static int gpiochip_set_desc_names(struct gpio_chip *gc)
 295 {
 296         struct gpio_device *gdev = gc->gpiodev;
 297         int i;
 298
 299         if (!gc->names)
 300                 return 0;
 301
 302         /* First check all names if they are unique */
 303         for (i = 0; i != gc->ngpio; ++i) {
 304                 struct gpio_desc *gpio;
 305
 306                 gpio = gpio_name_to_desc(gc->names[i]);
 307                 if (gpio)
 308                         dev_warn(&gdev->dev,
 309                                  "Detected name collision for GPIO name '%s'\n",
 310                                  gc->names[i]);
 311         }
 312
 313         /* Then add all names to the GPIO descriptors */
 314         for (i = 0; i != gc->ngpio; ++i)
 315                 gdev->descs[i].name = gc->names[i];
 316
 317         return 0;
 318 }
 319
 320 /*
 321  * GPIO line handle management
 322  */
 323
 324 /**
 325  * struct linehandle_state - contains the state of a userspace handle
 326  * @gdev: the GPIO device the handle pertains to
 327  * @label: consumer label used to tag descriptors
 328  * @descs: the GPIO descriptors held by this handle
 329  * @numdescs: the number of descriptors held in the descs array
 330  */
 331 struct linehandle_state {
 332         struct gpio_device *gdev;
 333         const char *label;
 334         struct gpio_desc *descs[GPIOHANDLES_MAX];
 335         u32 numdescs;
 336 };
 337
 338 #define GPIOHANDLE_REQUEST_VALID_FLAGS \
 339         (GPIOHANDLE_REQUEST_INPUT | \
 340         GPIOHANDLE_REQUEST_OUTPUT | \
 341         GPIOHANDLE_REQUEST_ACTIVE_LOW | \
 342         GPIOHANDLE_REQUEST_OPEN_DRAIN | \
 343         GPIOHANDLE_REQUEST_OPEN_SOURCE)
 344
 345 static long linehandle_ioctl(struct file *filep, unsigned int cmd,
 346                              unsigned long arg)
 347 {
 348         struct linehandle_state *lh = filep->private_data;
 349         void __user *ip = (void __user *)arg;
 350         struct gpiohandle_data ghd;
 351         int i;
 352
 353         if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
 354                 int val;
 355
 356                 memset(&ghd, 0, sizeof(ghd));
 357
 358                 /* TODO: check if descriptors are really input */
 359                 for (i = 0; i < lh->numdescs; i++) {
 360                         val = gpiod_get_value_cansleep(lh->descs[i]);
 361                         if (val < 0)
 362                                 return val;
 363                         ghd.values[i] = val;
 364                 }
 365
 366                 if (copy_to_user(ip, &ghd, sizeof(ghd)))
 367                         return -EFAULT;
 368
 369                 return 0;
 370         } else if (cmd == GPIOHANDLE_SET_LINE_VALUES_IOCTL) {
 371                 int vals[GPIOHANDLES_MAX];
 372
 373                 /* TODO: check if descriptors are really output */
 374                 if (copy_from_user(&ghd, ip, sizeof(ghd)))
 375                         return -EFAULT;
 376
 377                 /* Clamp all values to [0,1] */
 378                 for (i = 0; i < lh->numdescs; i++)
 379                         vals[i] = !!ghd.values[i];
 380
 381                 /* Reuse the array setting function */
 382                 gpiod_set_array_value_complex(false,
 383                                               true,
 384                                               lh->numdescs,
 385                                               lh->descs,
 386                                               vals);
 387                 return 0;
 388         }
 389         return -EINVAL;
 390 }
 391
 392 #ifdef CONFIG_COMPAT
 393 static long linehandle_ioctl_compat(struct file *filep, unsigned int cmd,
 394                              unsigned long arg)
 395 {
 396         return linehandle_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
 397 }
 398 #endif
 399
 400 static int linehandle_release(struct inode *inode, struct file *filep)
 401 {
 402         struct linehandle_state *lh = filep->private_data;
 403         struct gpio_device *gdev = lh->gdev;
 404         int i;
 405
 406         for (i = 0; i < lh->numdescs; i++)
 407                 gpiod_free(lh->descs[i]);
 408         kfree(lh->label);
 409         kfree(lh);
 410         put_device(&gdev->dev);
 411         return 0;
 412 }
 413
 414 static const struct file_operations linehandle_fileops = {
 415         .release = linehandle_release,
 416         .owner = THIS_MODULE,
 417         .llseek = noop_llseek,
 418         .unlocked_ioctl = linehandle_ioctl,
 419 #ifdef CONFIG_COMPAT
 420         .compat_ioctl = linehandle_ioctl_compat,
 421 #endif
 422 };
 423
 424 static int linehandle_create(struct gpio_device *gdev, void __user *ip)
 425 {
 426         struct gpiohandle_request handlereq;
 427         struct linehandle_state *lh;
 428         struct file *file;
 429         int fd, i, ret;
 430
 431         if (copy_from_user(&handlereq, ip, sizeof(handlereq)))
 432                 return -EFAULT;
 433         if ((handlereq.lines == 0) || (handlereq.lines > GPIOHANDLES_MAX))
 434                 return -EINVAL;
 435
 436         lh = kzalloc(sizeof(*lh), GFP_KERNEL);
 437         if (!lh)
 438                 return -ENOMEM;
 439         lh->gdev = gdev;
 440         get_device(&gdev->dev);
 441
 442         /* Make sure this is terminated */
 443         handlereq.consumer_label[sizeof(handlereq.consumer_label)-1] = '\0';
 444         if (strlen(handlereq.consumer_label)) {
 445                 lh->label = kstrdup(handlereq.consumer_label,
 446                                     GFP_KERNEL);
 447                 if (!lh->label) {
 448                         ret = -ENOMEM;
 449                         goto out_free_lh;
 450                 }
 451         }
 452
 453         /* Request each GPIO */
 454         for (i = 0; i < handlereq.lines; i++) {
 455                 u32 offset = handlereq.lineoffsets[i];
 456                 u32 lflags = handlereq.flags;
 457                 struct gpio_desc *desc;
 458
 459                 if (offset >= gdev->ngpio) {
 460                         ret = -EINVAL;
 461                         goto out_free_descs;
 462                 }
 463
 464                 /* Return an error if a unknown flag is set */
 465                 if (lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS) {
 466                         ret = -EINVAL;
 467                         goto out_free_descs;
 468                 }
 469
 470                 desc = &gdev->descs[offset];
 471                 ret = gpiod_request(desc, lh->label);
 472                 if (ret)
 473                         goto out_free_descs;
 474                 lh->descs[i] = desc;
 475
 476                 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
 477                         set_bit(FLAG_ACTIVE_LOW, &desc->flags);
 478                 if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
 479                         set_bit(FLAG_OPEN_DRAIN, &desc->flags);
 480                 if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
 481                         set_bit(FLAG_OPEN_SOURCE, &desc->flags);
 482
 483                 /*
 484                  * Lines have to be requested explicitly for input
 485                  * or output, else the line will be treated "as is".
 486                  */
 487                 if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
 488                         int val = !!handlereq.default_values[i];
 489
 490                         ret = gpiod_direction_output(desc, val);
 491                         if (ret)
 492                                 goto out_free_descs;
 493                 } else if (lflags & GPIOHANDLE_REQUEST_INPUT) {
 494                         ret = gpiod_direction_input(desc);
 495                         if (ret)
 496                                 goto out_free_descs;
 497                 }
 498                 dev_dbg(&gdev->dev, "registered chardev handle for line %d\n",
 499                         offset);
 500         }
 501         /* Let i point at the last handle */
 502         i--;
 503         lh->numdescs = handlereq.lines;
 504
 505         fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC);
 506         if (fd < 0) {
 507                 ret = fd;
 508                 goto out_free_descs;
 509         }
 510
 511         file = anon_inode_getfile("gpio-linehandle",
 512                                   &linehandle_fileops,
 513                                   lh,
 514                                   O_RDONLY | O_CLOEXEC);
 515         if (IS_ERR(file)) {
 516                 ret = PTR_ERR(file);
 517                 goto out_put_unused_fd;
 518         }
 519
 520         handlereq.fd = fd;
 521         if (copy_to_user(ip, &handlereq, sizeof(handlereq))) {
 522                 /*
 523                  * fput() will trigger the release() callback, so do not go onto
 524                  * the regular error cleanup path here.
 525                  */
 526                 fput(file);
 527                 put_unused_fd(fd);
 528                 return -EFAULT;
 529         }
 530
 531         fd_install(fd, file);
 532
 533         dev_dbg(&gdev->dev, "registered chardev handle for %d lines\n",
 534                 lh->numdescs);
 535
 536         return 0;
 537
 538 out_put_unused_fd:
 539         put_unused_fd(fd);
 540 out_free_descs:
 541         for (; i >= 0; i--)
 542                 gpiod_free(lh->descs[i]);
 543         kfree(lh->label);
 544 out_free_lh:
 545         kfree(lh);
 546         put_device(&gdev->dev);
 547         return ret;
 548 }
 549
 550 /*
 551  * GPIO line event management
 552  */
 553
 554 /**
 555  * struct lineevent_state - contains the state of a userspace event
 556  * @gdev: the GPIO device the event pertains to
 557  * @label: consumer label used to tag descriptors
 558  * @desc: the GPIO descriptor held by this event
 559  * @eflags: the event flags this line was requested with
 560  * @irq: the interrupt that trigger in response to events on this GPIO
 561  * @wait: wait queue that handles blocking reads of events
 562  * @events: KFIFO for the GPIO events
 563  * @read_lock: mutex lock to protect reads from colliding with adding
 564  * new events to the FIFO
 565  */
 566 struct lineevent_state {
 567         struct gpio_device *gdev;
 568         const char *label;
 569         struct gpio_desc *desc;
 570         u32 eflags;
 571         int irq;
 572         wait_queue_head_t wait;
 573         DECLARE_KFIFO(events, struct gpioevent_data, 16);
 574         struct mutex read_lock;
 575 };
 576
 577 #define GPIOEVENT_REQUEST_VALID_FLAGS \
 578         (GPIOEVENT_REQUEST_RISING_EDGE | \
 579         GPIOEVENT_REQUEST_FALLING_EDGE)
 580
 581 static unsigned int lineevent_poll(struct file *filep,
 582                                    struct poll_table_struct *wait)
 583 {
 584         struct lineevent_state *le = filep->private_data;
 585         unsigned int events = 0;
 586
 587         poll_wait(filep, &le->wait, wait);
 588
 589         if (!kfifo_is_empty(&le->events))
 590                 events = POLLIN | POLLRDNORM;
 591
 592         return events;
 593 }
 594
 595
 596 static ssize_t lineevent_read(struct file *filep,
 597                               char __user *buf,
 598                               size_t count,
 599                               loff_t *f_ps)
 600 {
 601         struct lineevent_state *le = filep->private_data;
 602         unsigned int copied;
 603         int ret;
 604
 605         if (count < sizeof(struct gpioevent_data))
 606                 return -EINVAL;
 607
 608         do {
 609                 if (kfifo_is_empty(&le->events)) {
 610                         if (filep->f_flags & O_NONBLOCK)
 611                                 return -EAGAIN;
 612
 613                         ret = wait_event_interruptible(le->wait,
 614                                         !kfifo_is_empty(&le->events));
 615                         if (ret)
 616                                 return ret;
 617                 }
 618
 619                 if (mutex_lock_interruptible(&le->read_lock))
 620                         return -ERESTARTSYS;
 621                 ret = kfifo_to_user(&le->events, buf, count, &copied);
 622                 mutex_unlock(&le->read_lock);
 623
 624                 if (ret)
 625                         return ret;
 626
 627                 /*
 628                  * If we couldn't read anything from the fifo (a different
 629                  * thread might have been faster) we either return -EAGAIN if
 630                  * the file descriptor is non-blocking, otherwise we go back to
 631                  * sleep and wait for more data to arrive.
 632                  */
 633                 if (copied == 0 && (filep->f_flags & O_NONBLOCK))
 634                         return -EAGAIN;
 635
 636         } while (copied == 0);
 637
 638         return copied;
 639 }
 640
 641 static int lineevent_release(struct inode *inode, struct file *filep)
 642 {
 643         struct lineevent_state *le = filep->private_data;
 644         struct gpio_device *gdev = le->gdev;
 645
 646         free_irq(le->irq, le);
 647         gpiod_free(le->desc);
 648         kfree(le->label);
 649         kfree(le);
 650         put_device(&gdev->dev);
 651         return 0;
 652 }
 653
 654 static long lineevent_ioctl(struct file *filep, unsigned int cmd,
 655                             unsigned long arg)
 656 {
 657         struct lineevent_state *le = filep->private_data;
 658         void __user *ip = (void __user *)arg;
 659         struct gpiohandle_data ghd;
 660
 661         /*
 662          * We can get the value for an event line but not set it,
 663          * because it is input by definition.
 664          */
 665         if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
 666                 int val;
 667
 668                 memset(&ghd, 0, sizeof(ghd));
 669
 670                 val = gpiod_get_value_cansleep(le->desc);
 671                 if (val < 0)
 672                         return val;
 673                 ghd.values[0] = val;
 674
 675                 if (copy_to_user(ip, &ghd, sizeof(ghd)))
 676                         return -EFAULT;
 677
 678                 return 0;
 679         }
 680         return -EINVAL;
 681 }
 682
 683 #ifdef CONFIG_COMPAT
 684 static long lineevent_ioctl_compat(struct file *filep, unsigned int cmd,
 685                                    unsigned long arg)
 686 {
 687         return lineevent_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
 688 }
 689 #endif
 690
 691 static const struct file_operations lineevent_fileops = {
 692         .release = lineevent_release,
 693         .read = lineevent_read,
 694         .poll = lineevent_poll,
 695         .owner = THIS_MODULE,
 696         .llseek = noop_llseek,
 697         .unlocked_ioctl = lineevent_ioctl,
 698 #ifdef CONFIG_COMPAT
 699         .compat_ioctl = lineevent_ioctl_compat,
 700 #endif
 701 };
 702
 703 static irqreturn_t lineevent_irq_thread(int irq, void *p)
 704 {
 705         struct lineevent_state *le = p;
 706         struct gpioevent_data ge;
 707         int ret;
 708
 709         ge.timestamp = ktime_get_real_ns();
 710
 711         if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE
 712             && le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) {
 713                 int level = gpiod_get_value_cansleep(le->desc);
 714
 715                 if (level)
 716                         /* Emit low-to-high event */
 717                         ge.id = GPIOEVENT_EVENT_RISING_EDGE;
 718                 else
 719                         /* Emit high-to-low event */
 720                         ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
 721         } else if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE) {
 722                 /* Emit low-to-high event */
 723                 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
 724         } else if (le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) {
 725                 /* Emit high-to-low event */
 726                 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
 727         } else {
 728                 return IRQ_NONE;
 729         }
 730
 731         ret = kfifo_put(&le->events, ge);
 732         if (ret != 0)
 733                 wake_up_poll(&le->wait, POLLIN);
 734
 735         return IRQ_HANDLED;
 736 }
 737
 738 static int lineevent_create(struct gpio_device *gdev, void __user *ip)
 739 {
 740         struct gpioevent_request eventreq;
 741         struct lineevent_state *le;
 742         struct gpio_desc *desc;
 743         struct file *file;
 744         u32 offset;
 745         u32 lflags;
 746         u32 eflags;
 747         int fd;
 748         int ret;
 749         int irqflags = 0;
 750
 751         if (copy_from_user(&eventreq, ip, sizeof(eventreq)))
 752                 return -EFAULT;
 753
 754         le = kzalloc(sizeof(*le), GFP_KERNEL);
 755         if (!le)
 756                 return -ENOMEM;
 757         le->gdev = gdev;
 758         get_device(&gdev->dev);
 759
 760         /* Make sure this is terminated */
 761         eventreq.consumer_label[sizeof(eventreq.consumer_label)-1] = '\0';
 762         if (strlen(eventreq.consumer_label)) {
 763                 le->label = kstrdup(eventreq.consumer_label,
 764                                     GFP_KERNEL);
 765                 if (!le->label) {
 766                         ret = -ENOMEM;
 767                         goto out_free_le;
 768                 }
 769         }
 770
 771         offset = eventreq.lineoffset;
 772         lflags = eventreq.handleflags;
 773         eflags = eventreq.eventflags;
 774
 775         if (offset >= gdev->ngpio) {
 776                 ret = -EINVAL;
 777                 goto out_free_label;
 778         }
 779
 780         /* Return an error if a unknown flag is set */
 781         if ((lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS) ||
 782             (eflags & ~GPIOEVENT_REQUEST_VALID_FLAGS)) {
 783                 ret = -EINVAL;
 784                 goto out_free_label;
 785         }
 786
 787         /* This is just wrong: we don't look for events on output lines */
 788         if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
 789                 ret = -EINVAL;
 790                 goto out_free_label;
 791         }
 792
 793         desc = &gdev->descs[offset];
 794         ret = gpiod_request(desc, le->label);
 795         if (ret)
 796                 goto out_free_desc;
 797         le->desc = desc;
 798         le->eflags = eflags;
 799
 800         if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
 801                 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
 802         if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
 803                 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
 804         if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
 805                 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
 806
 807         ret = gpiod_direction_input(desc);
 808         if (ret)
 809                 goto out_free_desc;
 810
 811         le->irq = gpiod_to_irq(desc);
 812         if (le->irq <= 0) {
 813                 ret = -ENODEV;
 814                 goto out_free_desc;
 815         }
 816
 817         if (eflags & GPIOEVENT_REQUEST_RISING_EDGE)
 818                 irqflags |= IRQF_TRIGGER_RISING;
 819         if (eflags & GPIOEVENT_REQUEST_FALLING_EDGE)
 820                 irqflags |= IRQF_TRIGGER_FALLING;
 821         irqflags |= IRQF_ONESHOT;
 822         irqflags |= IRQF_SHARED;
 823
 824         INIT_KFIFO(le->events);
 825         init_waitqueue_head(&le->wait);
 826         mutex_init(&le->read_lock);
 827
 828         /* Request a thread to read the events */
 829         ret = request_threaded_irq(le->irq,
 830                         NULL,
 831                         lineevent_irq_thread,
 832                         irqflags,
 833                         le->label,
 834                         le);
 835         if (ret)
 836                 goto out_free_desc;
 837
 838         fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC);
 839         if (fd < 0) {
 840                 ret = fd;
 841                 goto out_free_irq;
 842         }
 843
 844         file = anon_inode_getfile("gpio-event",
 845                                   &lineevent_fileops,
 846                                   le,
 847                                   O_RDONLY | O_CLOEXEC);
 848         if (IS_ERR(file)) {
 849                 ret = PTR_ERR(file);
 850                 goto out_put_unused_fd;
 851         }
 852
 853         eventreq.fd = fd;
 854         if (copy_to_user(ip, &eventreq, sizeof(eventreq))) {
 855                 /*
 856                  * fput() will trigger the release() callback, so do not go onto
 857                  * the regular error cleanup path here.
 858                  */
 859                 fput(file);
 860                 put_unused_fd(fd);
 861                 return -EFAULT;
 862         }
 863
 864         fd_install(fd, file);
 865
 866         return 0;
 867
 868 out_put_unused_fd:
 869         put_unused_fd(fd);
 870 out_free_irq:
 871         free_irq(le->irq, le);
 872 out_free_desc:
 873         gpiod_free(le->desc);
 874 out_free_label:
 875         kfree(le->label);
 876 out_free_le:
 877         kfree(le);
 878         put_device(&gdev->dev);
 879         return ret;
 880 }
 881
 882 /**
 883  * gpio_ioctl() - ioctl handler for the GPIO chardev
 884  */
 885 static long gpio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
 886 {
 887         struct gpio_device *gdev = filp->private_data;
 888         struct gpio_chip *chip = gdev->chip;
 889         void __user *ip = (void __user *)arg;
 890
 891         /* We fail any subsequent ioctl():s when the chip is gone */
 892         if (!chip)
 893                 return -ENODEV;
 894
 895         /* Fill in the struct and pass to userspace */
 896         if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
 897                 struct gpiochip_info chipinfo;
 898
 899                 memset(&chipinfo, 0, sizeof(chipinfo));
 900
 901                 strncpy(chipinfo.name, dev_name(&gdev->dev),
 902                         sizeof(chipinfo.name));
 903                 chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
 904                 strncpy(chipinfo.label, gdev->label,
 905                         sizeof(chipinfo.label));
 906                 chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
 907                 chipinfo.lines = gdev->ngpio;
 908                 if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
 909                         return -EFAULT;
 910                 return 0;
 911         } else if (cmd == GPIO_GET_LINEINFO_IOCTL) {
 912                 struct gpioline_info lineinfo;
 913                 struct gpio_desc *desc;
 914
 915                 if (copy_from_user(&lineinfo, ip, sizeof(lineinfo)))
 916                         return -EFAULT;
 917                 if (lineinfo.line_offset >= gdev->ngpio)
 918                         return -EINVAL;
 919
 920                 desc = &gdev->descs[lineinfo.line_offset];
 921                 if (desc->name) {
 922                         strncpy(lineinfo.name, desc->name,
 923                                 sizeof(lineinfo.name));
 924                         lineinfo.name[sizeof(lineinfo.name)-1] = '\0';
 925                 } else {
 926                         lineinfo.name[0] = '\0';
 927                 }
 928                 if (desc->label) {
 929                         strncpy(lineinfo.consumer, desc->label,
 930                                 sizeof(lineinfo.consumer));
 931                         lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
 932                 } else {
 933                         lineinfo.consumer[0] = '\0';
 934                 }
 935
 936                 /*
 937                  * Userspace only need to know that the kernel is using
 938                  * this GPIO so it can't use it.
 939                  */
 940                 lineinfo.flags = 0;
 941                 if (test_bit(FLAG_REQUESTED, &desc->flags) ||
 942                     test_bit(FLAG_IS_HOGGED, &desc->flags) ||
 943                     test_bit(FLAG_USED_AS_IRQ, &desc->flags) ||
 944                     test_bit(FLAG_EXPORT, &desc->flags) ||
 945                     test_bit(FLAG_SYSFS, &desc->flags))
 946                         lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
 947                 if (test_bit(FLAG_IS_OUT, &desc->flags))
 948                         lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
 949                 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
 950                         lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
 951                 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
 952                         lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
 953                 if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
 954                         lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;
 955
 956                 if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
 957                         return -EFAULT;
 958                 return 0;
 959         } else if (cmd == GPIO_GET_LINEHANDLE_IOCTL) {
 960                 return linehandle_create(gdev, ip);
 961         } else if (cmd == GPIO_GET_LINEEVENT_IOCTL) {
 962                 return lineevent_create(gdev, ip);
 963         }
 964         return -EINVAL;
 965 }
 966
 967 #ifdef CONFIG_COMPAT
 968 static long gpio_ioctl_compat(struct file *filp, unsigned int cmd,
 969                               unsigned long arg)
 970 {
 971         return gpio_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
 972 }
 973 #endif
 974
 975 /**
 976  * gpio_chrdev_open() - open the chardev for ioctl operations
 977  * @inode: inode for this chardev
 978  * @filp: file struct for storing private data
 979  * Returns 0 on success
 980  */
 981 static int gpio_chrdev_open(struct inode *inode, struct file *filp)
 982 {
 983         struct gpio_device *gdev = container_of(inode->i_cdev,
 984                                               struct gpio_device, chrdev);
 985
 986         /* Fail on open if the backing gpiochip is gone */
 987         if (!gdev->chip)
 988                 return -ENODEV;
 989         get_device(&gdev->dev);
 990         filp->private_data = gdev;
 991
 992         return nonseekable_open(inode, filp);
 993 }
 994
 995 /**
 996  * gpio_chrdev_release() - close chardev after ioctl operations
 997  * @inode: inode for this chardev
 998  * @filp: file struct for storing private data
 999  * Returns 0 on success
1000  */
1001 static int gpio_chrdev_release(struct inode *inode, struct file *filp)
1002 {
1003         struct gpio_device *gdev = container_of(inode->i_cdev,
1004                                               struct gpio_device, chrdev);
1005
1006         put_device(&gdev->dev);
1007         return 0;
1008 }
1009
1010
1011 static const struct file_operations gpio_fileops = {
1012         .release = gpio_chrdev_release,
1013         .open = gpio_chrdev_open,
1014         .owner = THIS_MODULE,
1015         .llseek = no_llseek,
1016         .unlocked_ioctl = gpio_ioctl,
1017 #ifdef CONFIG_COMPAT
1018         .compat_ioctl = gpio_ioctl_compat,
1019 #endif
1020 };
1021
1022 static void gpiodevice_release(struct device *dev)
1023 {
1024         struct gpio_device *gdev = dev_get_drvdata(dev);
1025
1026         list_del(&gdev->list);
1027         ida_simple_remove(&gpio_ida, gdev->id);
1028         kfree(gdev->label);
1029         kfree(gdev->descs);
1030         kfree(gdev);
1031 }
1032
1033 static int gpiochip_setup_dev(struct gpio_device *gdev)
1034 {
1035         int status;
1036
1037         cdev_init(&gdev->chrdev, &gpio_fileops);
1038         gdev->chrdev.owner = THIS_MODULE;
1039         gdev->dev.devt = MKDEV(MAJOR(gpio_devt), gdev->id);
1040
1041         status = cdev_device_add(&gdev->chrdev, &gdev->dev);
1042         if (status)
1043                 return status;
1044
1045         chip_dbg(gdev->chip, "added GPIO chardev (%d:%d)\n",
1046                  MAJOR(gpio_devt), gdev->id);
1047
1048         status = gpiochip_sysfs_register(gdev);
1049         if (status)
1050                 goto err_remove_device;
1051
1052         /* From this point, the .release() function cleans up gpio_device */
1053         gdev->dev.release = gpiodevice_release;
1054         pr_debug("%s: registered GPIOs %d to %d on device: %s (%s)\n",
1055                  __func__, gdev->base, gdev->base + gdev->ngpio - 1,
1056                  dev_name(&gdev->dev), gdev->chip->label ? : "generic");
1057
1058         return 0;
1059
1060 err_remove_device:
1061         cdev_device_del(&gdev->chrdev, &gdev->dev);
1062         return status;
1063 }
1064
1065 static void gpiochip_setup_devs(void)
1066 {
1067         struct gpio_device *gdev;
1068         int err;
1069
1070         list_for_each_entry(gdev, &gpio_devices, list) {
1071                 err = gpiochip_setup_dev(gdev);
1072                 if (err)
1073                         pr_err("%s: Failed to initialize gpio device (%d)\n",
1074                                dev_name(&gdev->dev), err);
1075         }
1076 }
1077
1078 /**
1079  * gpiochip_add_data() - register a gpio_chip
1080  * @chip: the chip to register, with chip->base initialized
1081  * Context: potentially before irqs will work
1082  *
1083  * Returns a negative errno if the chip can't be registered, such as
1084  * because the chip->base is invalid or already associated with a
1085  * different chip.  Otherwise it returns zero as a success code.
1086  *
1087  * When gpiochip_add_data() is called very early during boot, so that GPIOs
1088  * can be freely used, the chip->parent device must be registered before
1089  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
1090  * for GPIOs will fail rudely.
1091  *
1092  * gpiochip_add_data() must only be called after gpiolib initialization,
1093  * ie after core_initcall().
1094  *
1095  * If chip->base is negative, this requests dynamic assignment of
1096  * a range of valid GPIOs.
1097  */
1098 int gpiochip_add_data(struct gpio_chip *chip, void *data)
1099 {
1100         unsigned long   flags;
1101         int             status = 0;
1102         unsigned        i;
1103         int             base = chip->base;
1104         struct gpio_device *gdev;
1105
1106         /*
1107          * First: allocate and populate the internal stat container, and
1108          * set up the struct device.
1109          */
1110         gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
1111         if (!gdev)
1112                 return -ENOMEM;
1113         gdev->dev.bus = &gpio_bus_type;
1114         gdev->chip = chip;
1115         chip->gpiodev = gdev;
1116         if (chip->parent) {
1117                 gdev->dev.parent = chip->parent;
1118                 gdev->dev.of_node = chip->parent->of_node;
1119         }
1120
1121 #ifdef CONFIG_OF_GPIO
1122         /* If the gpiochip has an assigned OF node this takes precedence */
1123         if (chip->of_node)
1124                 gdev->dev.of_node = chip->of_node;
1125 #endif
1126
1127         gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL);
1128         if (gdev->id < 0) {
1129                 status = gdev->id;
1130                 goto err_free_gdev;
1131         }
1132         dev_set_name(&gdev->dev, "gpiochip%d", gdev->id);
1133         device_initialize(&gdev->dev);
1134         dev_set_drvdata(&gdev->dev, gdev);
1135         if (chip->parent && chip->parent->driver)
1136                 gdev->owner = chip->parent->driver->owner;
1137         else if (chip->owner)
1138                 /* TODO: remove chip->owner */
1139                 gdev->owner = chip->owner;
1140         else
1141                 gdev->owner = THIS_MODULE;
1142
1143         gdev->descs = kcalloc(chip->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
1144         if (!gdev->descs) {
1145                 status = -ENOMEM;
1146                 goto err_free_gdev;
1147         }
1148
1149         if (chip->ngpio == 0) {
1150                 chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
1151                 status = -EINVAL;
1152                 goto err_free_descs;
1153         }
1154
1155         if (chip->label)
1156                 gdev->label = kstrdup(chip->label, GFP_KERNEL);
1157         else
1158                 gdev->label = kstrdup("unknown", GFP_KERNEL);
1159         if (!gdev->label) {
1160                 status = -ENOMEM;
1161                 goto err_free_descs;
1162         }
1163
1164         gdev->ngpio = chip->ngpio;
1165         gdev->data = data;
1166
1167         spin_lock_irqsave(&gpio_lock, flags);
1168
1169         /*
1170          * TODO: this allocates a Linux GPIO number base in the global
1171          * GPIO numberspace for this chip. In the long run we want to
1172          * get *rid* of this numberspace and use only descriptors, but
1173          * it may be a pipe dream. It will not happen before we get rid
1174          * of the sysfs interface anyways.
1175          */
1176         if (base < 0) {
1177                 base = gpiochip_find_base(chip->ngpio);
1178                 if (base < 0) {
1179                         status = base;
1180                         spin_unlock_irqrestore(&gpio_lock, flags);
1181                         goto err_free_label;
1182                 }
1183                 /*
1184                  * TODO: it should not be necessary to reflect the assigned
1185                  * base outside of the GPIO subsystem. Go over drivers and
1186                  * see if anyone makes use of this, else drop this and assign
1187                  * a poison instead.
1188                  */
1189                 chip->base = base;
1190         }
1191         gdev->base = base;
1192
1193         status = gpiodev_add_to_list(gdev);
1194         if (status) {
1195                 spin_unlock_irqrestore(&gpio_lock, flags);
1196                 goto err_free_label;
1197         }
1198
1199         spin_unlock_irqrestore(&gpio_lock, flags);
1200
1201         for (i = 0; i < chip->ngpio; i++) {
1202                 struct gpio_desc *desc = &gdev->descs[i];
1203
1204                 desc->gdev = gdev;
1205                 /*
1206                  * REVISIT: most hardware initializes GPIOs as inputs
1207                  * (often with pullups enabled) so power usage is
1208                  * minimized. Linux code should set the gpio direction
1209                  * first thing; but until it does, and in case
1210                  * chip->get_direction is not set, we may expose the
1211                  * wrong direction in sysfs.
1212                  */
1213
1214                 if (chip->get_direction) {
1215                         /*
1216                          * If we have .get_direction, set up the initial
1217                          * direction flag from the hardware.
1218                          */
1219                         int dir = chip->get_direction(chip, i);
1220
1221                         if (!dir)
1222                                 set_bit(FLAG_IS_OUT, &desc->flags);
1223                 } else if (!chip->direction_input) {
1224                         /*
1225                          * If the chip lacks the .direction_input callback
1226                          * we logically assume all lines are outputs.
1227                          */
1228                         set_bit(FLAG_IS_OUT, &desc->flags);
1229                 }
1230         }
1231
1232 #ifdef CONFIG_PINCTRL
1233         INIT_LIST_HEAD(&gdev->pin_ranges);
1234 #endif
1235
1236         status = gpiochip_set_desc_names(chip);
1237         if (status)
1238                 goto err_remove_from_list;
1239
1240         status = gpiochip_irqchip_init_valid_mask(chip);
1241         if (status)
1242                 goto err_remove_from_list;
1243
1244         status = of_gpiochip_add(chip);
1245         if (status)
1246                 goto err_remove_chip;
1247
1248         acpi_gpiochip_add(chip);
1249
1250         /*
1251          * By first adding the chardev, and then adding the device,
1252          * we get a device node entry in sysfs under
1253          * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
1254          * coldplug of device nodes and other udev business.
1255          * We can do this only if gpiolib has been initialized.
1256          * Otherwise, defer until later.
1257          */
1258         if (gpiolib_initialized) {
1259                 status = gpiochip_setup_dev(gdev);
1260                 if (status)
1261                         goto err_remove_chip;
1262         }
1263         return 0;
1264
1265 err_remove_chip:
1266         acpi_gpiochip_remove(chip);
1267         gpiochip_free_hogs(chip);
1268         of_gpiochip_remove(chip);
1269         gpiochip_irqchip_free_valid_mask(chip);
1270 err_remove_from_list:
1271         spin_lock_irqsave(&gpio_lock, flags);
1272         list_del(&gdev->list);
1273         spin_unlock_irqrestore(&gpio_lock, flags);
1274 err_free_label:
1275         kfree(gdev->label);
1276 err_free_descs:
1277         kfree(gdev->descs);
1278 err_free_gdev:
1279         ida_simple_remove(&gpio_ida, gdev->id);
1280         /* failures here can mean systems won't boot... */
1281         pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
1282                gdev->base, gdev->base + gdev->ngpio - 1,
1283                chip->label ? : "generic");
1284         kfree(gdev);
1285         return status;
1286 }
1287 EXPORT_SYMBOL_GPL(gpiochip_add_data);
1288
1289 /**
1290  * gpiochip_get_data() - get per-subdriver data for the chip
1291  */
1292 void *gpiochip_get_data(struct gpio_chip *chip)
1293 {
1294         return chip->gpiodev->data;
1295 }
1296 EXPORT_SYMBOL_GPL(gpiochip_get_data);
1297
1298 /**
1299  * gpiochip_remove() - unregister a gpio_chip
1300  * @chip: the chip to unregister
1301  *
1302  * A gpio_chip with any GPIOs still requested may not be removed.
1303  */
1304 void gpiochip_remove(struct gpio_chip *chip)
1305 {
1306         struct gpio_device *gdev = chip->gpiodev;
1307         struct gpio_desc *desc;
1308         unsigned long   flags;
1309         unsigned        i;
1310         bool            requested = false;
1311
1312         /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
1313         gpiochip_sysfs_unregister(gdev);
1314         gpiochip_free_hogs(chip);
1315         /* Numb the device, cancelling all outstanding operations */
1316         gdev->chip = NULL;
1317         gpiochip_irqchip_remove(chip);
1318         acpi_gpiochip_remove(chip);
1319         gpiochip_remove_pin_ranges(chip);
1320         of_gpiochip_remove(chip);
1321         /*
1322          * We accept no more calls into the driver from this point, so
1323          * NULL the driver data pointer
1324          */
1325         gdev->data = NULL;
1326
1327         spin_lock_irqsave(&gpio_lock, flags);
1328         for (i = 0; i < gdev->ngpio; i++) {
1329                 desc = &gdev->descs[i];
1330                 if (test_bit(FLAG_REQUESTED, &desc->flags))
1331                         requested = true;
1332         }
1333         spin_unlock_irqrestore(&gpio_lock, flags);
1334
1335         if (requested)
1336                 dev_crit(&gdev->dev,
1337                          "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
1338
1339         /*
1340          * The gpiochip side puts its use of the device to rest here:
1341          * if there are no userspace clients, the chardev and device will
1342          * be removed, else it will be dangling until the last user is
1343          * gone.
1344          */
1345         cdev_device_del(&gdev->chrdev, &gdev->dev);
1346         put_device(&gdev->dev);
1347 }
1348 EXPORT_SYMBOL_GPL(gpiochip_remove);
1349
1350 static void devm_gpio_chip_release(struct device *dev, void *res)
1351 {
1352         struct gpio_chip *chip = *(struct gpio_chip **)res;
1353
1354         gpiochip_remove(chip);
1355 }
1356
1357 static int devm_gpio_chip_match(struct device *dev, void *res, void *data)
1358
1359 {
1360         struct gpio_chip **r = res;
1361
1362         if (!r || !*r) {
1363                 WARN_ON(!r || !*r);
1364                 return 0;
1365         }
1366
1367         return *r == data;
1368 }
1369
1370 /**
1371  * devm_gpiochip_add_data() - Resource manager piochip_add_data()
1372  * @dev: the device pointer on which irq_chip belongs to.
1373  * @chip: the chip to register, with chip->base initialized
1374  * Context: potentially before irqs will work
1375  *
1376  * Returns a negative errno if the chip can't be registered, such as
1377  * because the chip->base is invalid or already associated with a
1378  * different chip.  Otherwise it returns zero as a success code.
1379  *
1380  * The gpio chip automatically be released when the device is unbound.
1381  */
1382 int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
1383                            void *data)
1384 {
1385         struct gpio_chip **ptr;
1386         int ret;
1387
1388         ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr),
1389                              GFP_KERNEL);
1390         if (!ptr)
1391                 return -ENOMEM;
1392
1393         ret = gpiochip_add_data(chip, data);
1394         if (ret < 0) {
1395                 devres_free(ptr);
1396                 return ret;
1397         }
1398
1399         *ptr = chip;
1400         devres_add(dev, ptr);
1401
1402         return 0;
1403 }
1404 EXPORT_SYMBOL_GPL(devm_gpiochip_add_data);
1405
1406 /**
1407  * devm_gpiochip_remove() - Resource manager of gpiochip_remove()
1408  * @dev: device for which which resource was allocated
1409  * @chip: the chip to remove
1410  *
1411  * A gpio_chip with any GPIOs still requested may not be removed.
1412  */
1413 void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip)
1414 {
1415         int ret;
1416
1417         ret = devres_release(dev, devm_gpio_chip_release,
1418                              devm_gpio_chip_match, chip);
1419         WARN_ON(ret);
1420 }
1421 EXPORT_SYMBOL_GPL(devm_gpiochip_remove);
1422
1423 /**
1424  * gpiochip_find() - iterator for locating a specific gpio_chip
1425  * @data: data to pass to match function
1426  * @callback: Callback function to check gpio_chip
1427  *
1428  * Similar to bus_find_device.  It returns a reference to a gpio_chip as
1429  * determined by a user supplied @match callback.  The callback should return
1430  * 0 if the device doesn't match and non-zero if it does.  If the callback is
1431  * non-zero, this function will return to the caller and not iterate over any
1432  * more gpio_chips.
1433  */
1434 struct gpio_chip *gpiochip_find(void *data,
1435                                 int (*match)(struct gpio_chip *chip,
1436                                              void *data))
1437 {
1438         struct gpio_device *gdev;
1439         struct gpio_chip *chip = NULL;
1440         unsigned long flags;
1441
1442         spin_lock_irqsave(&gpio_lock, flags);
1443         list_for_each_entry(gdev, &gpio_devices, list)
1444                 if (gdev->chip && match(gdev->chip, data)) {
1445                         chip = gdev->chip;
1446                         break;
1447                 }
1448
1449         spin_unlock_irqrestore(&gpio_lock, flags);
1450
1451         return chip;
1452 }
1453 EXPORT_SYMBOL_GPL(gpiochip_find);
1454
1455 static int gpiochip_match_name(struct gpio_chip *chip, void *data)
1456 {
1457         const char *name = data;
1458
1459         return !strcmp(chip->label, name);
1460 }
1461
1462 static struct gpio_chip *find_chip_by_name(const char *name)
1463 {
1464         return gpiochip_find((void *)name, gpiochip_match_name);
1465 }
1466
1467 #ifdef CONFIG_GPIOLIB_IRQCHIP
1468
1469 /*
1470  * The following is irqchip helper code for gpiochips.
1471  */
1472
1473 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
1474 {
1475         if (!gpiochip->irq_need_valid_mask)
1476                 return 0;
1477
1478         gpiochip->irq_valid_mask = kcalloc(BITS_TO_LONGS(gpiochip->ngpio),
1479                                            sizeof(long), GFP_KERNEL);
1480         if (!gpiochip->irq_valid_mask)
1481                 return -ENOMEM;
1482
1483         /* Assume by default all GPIOs are valid */
1484         bitmap_fill(gpiochip->irq_valid_mask, gpiochip->ngpio);
1485
1486         return 0;
1487 }
1488
1489 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1490 {
1491         kfree(gpiochip->irq_valid_mask);
1492         gpiochip->irq_valid_mask = NULL;
1493 }
1494
1495 static bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip,
1496                                        unsigned int offset)
1497 {
1498         /* No mask means all valid */
1499         if (likely(!gpiochip->irq_valid_mask))
1500                 return true;
1501         return test_bit(offset, gpiochip->irq_valid_mask);
1502 }
1503
1504 /**
1505  * gpiochip_set_cascaded_irqchip() - connects a cascaded irqchip to a gpiochip
1506  * @gpiochip: the gpiochip to set the irqchip chain to
1507  * @irqchip: the irqchip to chain to the gpiochip
1508  * @parent_irq: the irq number corresponding to the parent IRQ for this
1509  * chained irqchip
1510  * @parent_handler: the parent interrupt handler for the accumulated IRQ
1511  * coming out of the gpiochip. If the interrupt is nested rather than
1512  * cascaded, pass NULL in this handler argument
1513  */
1514 static void gpiochip_set_cascaded_irqchip(struct gpio_chip *gpiochip,
1515                                           struct irq_chip *irqchip,
1516                                           unsigned int parent_irq,
1517                                           irq_flow_handler_t parent_handler)
1518 {
1519         unsigned int offset;
1520
1521         if (!gpiochip->irqdomain) {
1522                 chip_err(gpiochip, "called %s before setting up irqchip\n",
1523                          __func__);
1524                 return;
1525         }
1526
1527         if (parent_handler) {
1528                 if (gpiochip->can_sleep) {
1529                         chip_err(gpiochip,
1530                                  "you cannot have chained interrupts on a "
1531                                  "chip that may sleep\n");
1532                         return;
1533                 }
1534                 /*
1535                  * The parent irqchip is already using the chip_data for this
1536                  * irqchip, so our callbacks simply use the handler_data.
1537                  */
1538                 irq_set_chained_handler_and_data(parent_irq, parent_handler,
1539                                                  gpiochip);
1540
1541                 gpiochip->irq_chained_parent = parent_irq;
1542         }
1543
1544         /* Set the parent IRQ for all affected IRQs */
1545         for (offset = 0; offset < gpiochip->ngpio; offset++) {
1546                 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1547                         continue;
1548                 irq_set_parent(irq_find_mapping(gpiochip->irqdomain, offset),
1549                                parent_irq);
1550         }
1551 }
1552
1553 /**
1554  * gpiochip_set_chained_irqchip() - connects a chained irqchip to a gpiochip
1555  * @gpiochip: the gpiochip to set the irqchip chain to
1556  * @irqchip: the irqchip to chain to the gpiochip
1557  * @parent_irq: the irq number corresponding to the parent IRQ for this
1558  * chained irqchip
1559  * @parent_handler: the parent interrupt handler for the accumulated IRQ
1560  * coming out of the gpiochip. If the interrupt is nested rather than
1561  * cascaded, pass NULL in this handler argument
1562  */
1563 void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
1564                                   struct irq_chip *irqchip,
1565                                   unsigned int parent_irq,
1566                                   irq_flow_handler_t parent_handler)
1567 {
1568         gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq,
1569                                       parent_handler);
1570 }
1571 EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
1572
1573 /**
1574  * gpiochip_set_nested_irqchip() - connects a nested irqchip to a gpiochip
1575  * @gpiochip: the gpiochip to set the irqchip nested handler to
1576  * @irqchip: the irqchip to nest to the gpiochip
1577  * @parent_irq: the irq number corresponding to the parent IRQ for this
1578  * nested irqchip
1579  */
1580 void gpiochip_set_nested_irqchip(struct gpio_chip *gpiochip,
1581                                  struct irq_chip *irqchip,
1582                                  unsigned int parent_irq)
1583 {
1584         if (!gpiochip->irq_nested) {
1585                 chip_err(gpiochip, "tried to nest a chained gpiochip\n");
1586                 return;
1587         }
1588         gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq,
1589                                       NULL);
1590 }
1591 EXPORT_SYMBOL_GPL(gpiochip_set_nested_irqchip);
1592
1593 /**
1594  * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1595  * @d: the irqdomain used by this irqchip
1596  * @irq: the global irq number used by this GPIO irqchip irq
1597  * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1598  *
1599  * This function will set up the mapping for a certain IRQ line on a
1600  * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1601  * stored inside the gpiochip.
1602  */
1603 static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1604                             irq_hw_number_t hwirq)
1605 {
1606         struct gpio_chip *chip = d->host_data;
1607
1608         irq_set_chip_data(irq, chip);
1609         /*
1610          * This lock class tells lockdep that GPIO irqs are in a different
1611          * category than their parents, so it won't report false recursion.
1612          */
1613         irq_set_lockdep_class(irq, chip->lock_key);
1614         irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
1615         /* Chips that use nested thread handlers have them marked */
1616         if (chip->irq_nested)
1617                 irq_set_nested_thread(irq, 1);
1618         irq_set_noprobe(irq);
1619
1620         /*
1621          * No set-up of the hardware will happen if IRQ_TYPE_NONE
1622          * is passed as default type.
1623          */
1624         if (chip->irq_default_type != IRQ_TYPE_NONE)
1625                 irq_set_irq_type(irq, chip->irq_default_type);
1626
1627         return 0;
1628 }
1629
1630 static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1631 {
1632         struct gpio_chip *chip = d->host_data;
1633
1634         if (chip->irq_nested)
1635                 irq_set_nested_thread(irq, 0);
1636         irq_set_chip_and_handler(irq, NULL, NULL);
1637         irq_set_chip_data(irq, NULL);
1638 }
1639
1640 static const struct irq_domain_ops gpiochip_domain_ops = {
1641         .map    = gpiochip_irq_map,
1642         .unmap  = gpiochip_irq_unmap,
1643         /* Virtually all GPIO irqchips are twocell:ed */
1644         .xlate  = irq_domain_xlate_twocell,
1645 };
1646
1647 static int gpiochip_irq_reqres(struct irq_data *d)
1648 {
1649         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1650
1651         if (!try_module_get(chip->gpiodev->owner))
1652                 return -ENODEV;
1653
1654         if (gpiochip_lock_as_irq(chip, d->hwirq)) {
1655                 chip_err(chip,
1656                         "unable to lock HW IRQ %lu for IRQ\n",
1657                         d->hwirq);
1658                 module_put(chip->gpiodev->owner);
1659                 return -EINVAL;
1660         }
1661         return 0;
1662 }
1663
1664 static void gpiochip_irq_relres(struct irq_data *d)
1665 {
1666         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1667
1668         gpiochip_unlock_as_irq(chip, d->hwirq);
1669         module_put(chip->gpiodev->owner);
1670 }
1671
1672 static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
1673 {
1674         return irq_find_mapping(chip->irqdomain, offset);
1675 }
1676
1677 /**
1678  * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1679  * @gpiochip: the gpiochip to remove the irqchip from
1680  *
1681  * This is called only from gpiochip_remove()
1682  */
1683 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
1684 {
1685         unsigned int offset;
1686
1687         acpi_gpiochip_free_interrupts(gpiochip);
1688
1689         if (gpiochip->irq_chained_parent) {
1690                 irq_set_chained_handler(gpiochip->irq_chained_parent, NULL);
1691                 irq_set_handler_data(gpiochip->irq_chained_parent, NULL);
1692         }
1693
1694         /* Remove all IRQ mappings and delete the domain */
1695         if (gpiochip->irqdomain) {
1696                 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1697                         if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1698                                 continue;
1699                         irq_dispose_mapping(
1700                                 irq_find_mapping(gpiochip->irqdomain, offset));
1701                 }
1702                 irq_domain_remove(gpiochip->irqdomain);
1703         }
1704
1705         if (gpiochip->irqchip) {
1706                 gpiochip->irqchip->irq_request_resources = NULL;
1707                 gpiochip->irqchip->irq_release_resources = NULL;
1708                 gpiochip->irqchip = NULL;
1709         }
1710
1711         gpiochip_irqchip_free_valid_mask(gpiochip);
1712 }
1713
1714 /**
1715  * gpiochip_irqchip_add_key() - adds an irqchip to a gpiochip
1716  * @gpiochip: the gpiochip to add the irqchip to
1717  * @irqchip: the irqchip to add to the gpiochip
1718  * @first_irq: if not dynamically assigned, the base (first) IRQ to
1719  * allocate gpiochip irqs from
1720  * @handler: the irq handler to use (often a predefined irq core function)
1721  * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
1722  * to have the core avoid setting up any default type in the hardware.
1723  * @nested: whether this is a nested irqchip calling handle_nested_irq()
1724  * in its IRQ handler
1725  * @lock_key: lockdep class
1726  *
1727  * This function closely associates a certain irqchip with a certain
1728  * gpiochip, providing an irq domain to translate the local IRQs to
1729  * global irqs in the gpiolib core, and making sure that the gpiochip
1730  * is passed as chip data to all related functions. Driver callbacks
1731  * need to use gpiochip_get_data() to get their local state containers back
1732  * from the gpiochip passed as chip data. An irqdomain will be stored
1733  * in the gpiochip that shall be used by the driver to handle IRQ number
1734  * translation. The gpiochip will need to be initialized and registered
1735  * before calling this function.
1736  *
1737  * This function will handle two cell:ed simple IRQs and assumes all
1738  * the pins on the gpiochip can generate a unique IRQ. Everything else
1739  * need to be open coded.
1740  */
1741 int gpiochip_irqchip_add_key(struct gpio_chip *gpiochip,
1742                              struct irq_chip *irqchip,
1743                              unsigned int first_irq,
1744                              irq_flow_handler_t handler,
1745                              unsigned int type,
1746                              bool nested,
1747                              struct lock_class_key *lock_key)
1748 {
1749         struct device_node *of_node;
1750         bool irq_base_set = false;
1751         unsigned int offset;
1752         unsigned irq_base = 0;
1753
1754         if (!gpiochip || !irqchip)
1755                 return -EINVAL;
1756
1757         if (!gpiochip->parent) {
1758                 pr_err("missing gpiochip .dev parent pointer\n");
1759                 return -EINVAL;
1760         }
1761         gpiochip->irq_nested = nested;
1762         of_node = gpiochip->parent->of_node;
1763 #ifdef CONFIG_OF_GPIO
1764         /*
1765          * If the gpiochip has an assigned OF node this takes precedence
1766          * FIXME: get rid of this and use gpiochip->parent->of_node
1767          * everywhere
1768          */
1769         if (gpiochip->of_node)
1770                 of_node = gpiochip->of_node;
1771 #endif
1772         /*
1773          * Specifying a default trigger is a terrible idea if DT or ACPI is
1774          * used to configure the interrupts, as you may end-up with
1775          * conflicting triggers. Tell the user, and reset to NONE.
1776          */
1777         if (WARN(of_node && type != IRQ_TYPE_NONE,
1778                  "%s: Ignoring %d default trigger\n", of_node->full_name, type))
1779                 type = IRQ_TYPE_NONE;
1780         if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
1781                 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
1782                                  "Ignoring %d default trigger\n", type);
1783                 type = IRQ_TYPE_NONE;
1784         }
1785
1786         gpiochip->irqchip = irqchip;
1787         gpiochip->irq_handler = handler;
1788         gpiochip->irq_default_type = type;
1789         gpiochip->to_irq = gpiochip_to_irq;
1790         gpiochip->lock_key = lock_key;
1791         gpiochip->irqdomain = irq_domain_add_simple(of_node,
1792                                         gpiochip->ngpio, first_irq,
1793                                         &gpiochip_domain_ops, gpiochip);
1794         if (!gpiochip->irqdomain) {
1795                 gpiochip->irqchip = NULL;
1796                 return -EINVAL;
1797         }
1798
1799         /*
1800          * It is possible for a driver to override this, but only if the
1801          * alternative functions are both implemented.
1802          */
1803         if (!irqchip->irq_request_resources &&
1804             !irqchip->irq_release_resources) {
1805                 irqchip->irq_request_resources = gpiochip_irq_reqres;
1806                 irqchip->irq_release_resources = gpiochip_irq_relres;
1807         }
1808
1809         /*
1810          * Prepare the mapping since the irqchip shall be orthogonal to
1811          * any gpiochip calls. If the first_irq was zero, this is
1812          * necessary to allocate descriptors for all IRQs.
1813          */
1814         for (offset = 0; offset < gpiochip->ngpio; offset++) {
1815                 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1816                         continue;
1817                 irq_base = irq_create_mapping(gpiochip->irqdomain, offset);
1818                 if (!irq_base_set) {
1819                         /*
1820                          * Store the base into the gpiochip to be used when
1821                          * unmapping the irqs.
1822                          */
1823                         gpiochip->irq_base = irq_base;
1824                         irq_base_set = true;
1825                 }
1826         }
1827
1828         acpi_gpiochip_request_interrupts(gpiochip);
1829
1830         return 0;
1831 }
1832 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_key);
1833
1834 #else /* CONFIG_GPIOLIB_IRQCHIP */
1835
1836 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
1837 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
1838 {
1839         return 0;
1840 }
1841 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1842 { }
1843
1844 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1845
1846 /**
1847  * gpiochip_generic_request() - request the gpio function for a pin
1848  * @chip: the gpiochip owning the GPIO
1849  * @offset: the offset of the GPIO to request for GPIO function
1850  */
1851 int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset)
1852 {
1853         return pinctrl_request_gpio(chip->gpiodev->base + offset);
1854 }
1855 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1856
1857 /**
1858  * gpiochip_generic_free() - free the gpio function from a pin
1859  * @chip: the gpiochip to request the gpio function for
1860  * @offset: the offset of the GPIO to free from GPIO function
1861  */
1862 void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset)
1863 {
1864         pinctrl_free_gpio(chip->gpiodev->base + offset);
1865 }
1866 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1867
1868 /**
1869  * gpiochip_generic_config() - apply configuration for a pin
1870  * @chip: the gpiochip owning the GPIO
1871  * @offset: the offset of the GPIO to apply the configuration
1872  * @config: the configuration to be applied
1873  */
1874 int gpiochip_generic_config(struct gpio_chip *chip, unsigned offset,
1875                             unsigned long config)
1876 {
1877         return pinctrl_gpio_set_config(chip->gpiodev->base + offset, config);
1878 }
1879 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
1880
1881 #ifdef CONFIG_PINCTRL
1882
1883 /**
1884  * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1885  * @chip: the gpiochip to add the range for
1886  * @pctldev: the pin controller to map to
1887  * @gpio_offset: the start offset in the current gpio_chip number space
1888  * @pin_group: name of the pin group inside the pin controller
1889  */
1890 int gpiochip_add_pingroup_range(struct gpio_chip *chip,
1891                         struct pinctrl_dev *pctldev,
1892                         unsigned int gpio_offset, const char *pin_group)
1893 {
1894         struct gpio_pin_range *pin_range;
1895         struct gpio_device *gdev = chip->gpiodev;
1896         int ret;
1897
1898         pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1899         if (!pin_range) {
1900                 chip_err(chip, "failed to allocate pin ranges\n");
1901                 return -ENOMEM;
1902         }
1903
1904         /* Use local offset as range ID */
1905         pin_range->range.id = gpio_offset;
1906         pin_range->range.gc = chip;
1907         pin_range->range.name = chip->label;
1908         pin_range->range.base = gdev->base + gpio_offset;
1909         pin_range->pctldev = pctldev;
1910
1911         ret = pinctrl_get_group_pins(pctldev, pin_group,
1912                                         &pin_range->range.pins,
1913                                         &pin_range->range.npins);
1914         if (ret < 0) {
1915                 kfree(pin_range);
1916                 return ret;
1917         }
1918
1919         pinctrl_add_gpio_range(pctldev, &pin_range->range);
1920
1921         chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1922                  gpio_offset, gpio_offset + pin_range->range.npins - 1,
1923                  pinctrl_dev_get_devname(pctldev), pin_group);
1924
1925         list_add_tail(&pin_range->node, &gdev->pin_ranges);
1926
1927         return 0;
1928 }
1929 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1930
1931 /**
1932  * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1933  * @chip: the gpiochip to add the range for
1934  * @pinctrl_name: the dev_name() of the pin controller to map to
1935  * @gpio_offset: the start offset in the current gpio_chip number space
1936  * @pin_offset: the start offset in the pin controller number space
1937  * @npins: the number of pins from the offset of each pin space (GPIO and
1938  *      pin controller) to accumulate in this range
1939  */
1940 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
1941                            unsigned int gpio_offset, unsigned int pin_offset,
1942                            unsigned int npins)
1943 {
1944         struct gpio_pin_range *pin_range;
1945         struct gpio_device *gdev = chip->gpiodev;
1946         int ret;
1947
1948         pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1949         if (!pin_range) {
1950                 chip_err(chip, "failed to allocate pin ranges\n");
1951                 return -ENOMEM;
1952         }
1953
1954         /* Use local offset as range ID */
1955         pin_range->range.id = gpio_offset;
1956         pin_range->range.gc = chip;
1957         pin_range->range.name = chip->label;
1958         pin_range->range.base = gdev->base + gpio_offset;
1959         pin_range->range.pin_base = pin_offset;
1960         pin_range->range.npins = npins;
1961         pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1962                         &pin_range->range);
1963         if (IS_ERR(pin_range->pctldev)) {
1964                 ret = PTR_ERR(pin_range->pctldev);
1965                 chip_err(chip, "could not create pin range\n");
1966                 kfree(pin_range);
1967                 return ret;
1968         }
1969         chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1970                  gpio_offset, gpio_offset + npins - 1,
1971                  pinctl_name,
1972                  pin_offset, pin_offset + npins - 1);
1973
1974         list_add_tail(&pin_range->node, &gdev->pin_ranges);
1975
1976         return 0;
1977 }
1978 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1979
1980 /**
1981  * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1982  * @chip: the chip to remove all the mappings for
1983  */
1984 void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
1985 {
1986         struct gpio_pin_range *pin_range, *tmp;
1987         struct gpio_device *gdev = chip->gpiodev;
1988
1989         list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1990                 list_del(&pin_range->node);
1991                 pinctrl_remove_gpio_range(pin_range->pctldev,
1992                                 &pin_range->range);
1993                 kfree(pin_range);
1994         }
1995 }
1996 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1997
1998 #endif /* CONFIG_PINCTRL */
1999
2000 /* These "optional" allocation calls help prevent drivers from stomping
2001  * on each other, and help provide better diagnostics in debugfs.
2002  * They're called even less than the "set direction" calls.
2003  */
2004 static int __gpiod_request(struct gpio_desc *desc, const char *label)
2005 {
2006         struct gpio_chip        *chip = desc->gdev->chip;
2007         int                     status;
2008         unsigned long           flags;
2009
2010         spin_lock_irqsave(&gpio_lock, flags);
2011
2012         /* NOTE:  gpio_request() can be called in early boot,
2013          * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
2014          */
2015
2016         if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
2017                 desc_set_label(desc, label ? : "?");
2018                 status = 0;
2019         } else {
2020                 status = -EBUSY;
2021                 goto done;
2022         }
2023
2024         if (chip->request) {
2025                 /* chip->request may sleep */
2026                 spin_unlock_irqrestore(&gpio_lock, flags);
2027                 status = chip->request(chip, gpio_chip_hwgpio(desc));
2028                 spin_lock_irqsave(&gpio_lock, flags);
2029
2030                 if (status < 0) {
2031                         desc_set_label(desc, NULL);
2032                         clear_bit(FLAG_REQUESTED, &desc->flags);
2033                         goto done;
2034                 }
2035         }
2036         if (chip->get_direction) {
2037                 /* chip->get_direction may sleep */
2038                 spin_unlock_irqrestore(&gpio_lock, flags);
2039                 gpiod_get_direction(desc);
2040                 spin_lock_irqsave(&gpio_lock, flags);
2041         }
2042 done:
2043         spin_unlock_irqrestore(&gpio_lock, flags);
2044         return status;
2045 }
2046
2047 /*
2048  * This descriptor validation needs to be inserted verbatim into each
2049  * function taking a descriptor, so we need to use a preprocessor
2050  * macro to avoid endless duplication. If the desc is NULL it is an
2051  * optional GPIO and calls should just bail out.
2052  */
2053 #define VALIDATE_DESC(desc) do { \
2054         if (!desc) \
2055                 return 0; \
2056         if (IS_ERR(desc)) {                                             \
2057                 pr_warn("%s: invalid GPIO (errorpointer)\n", __func__); \
2058                 return PTR_ERR(desc); \
2059         } \
2060         if (!desc->gdev) { \
2061                 pr_warn("%s: invalid GPIO (no device)\n", __func__); \
2062                 return -EINVAL; \
2063         } \
2064         if ( !desc->gdev->chip ) { \
2065                 dev_warn(&desc->gdev->dev, \
2066                          "%s: backing chip is gone\n", __func__); \
2067                 return 0; \
2068         } } while (0)
2069
2070 #define VALIDATE_DESC_VOID(desc) do { \
2071         if (!desc) \
2072                 return; \
2073         if (IS_ERR(desc)) {                                             \
2074                 pr_warn("%s: invalid GPIO (errorpointer)\n", __func__); \
2075                 return; \
2076         } \
2077         if (!desc->gdev) { \
2078                 pr_warn("%s: invalid GPIO (no device)\n", __func__); \
2079                 return; \
2080         } \
2081         if (!desc->gdev->chip) { \
2082                 dev_warn(&desc->gdev->dev, \
2083                          "%s: backing chip is gone\n", __func__); \
2084                 return; \
2085         } } while (0)
2086
2087
2088 int gpiod_request(struct gpio_desc *desc, const char *label)
2089 {
2090         int status = -EPROBE_DEFER;
2091         struct gpio_device *gdev;
2092
2093         VALIDATE_DESC(desc);
2094         gdev = desc->gdev;
2095
2096         if (try_module_get(gdev->owner)) {
2097                 status = __gpiod_request(desc, label);
2098                 if (status < 0)
2099                         module_put(gdev->owner);
2100                 else
2101                         get_device(&gdev->dev);
2102         }
2103
2104         if (status)
2105                 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
2106
2107         return status;
2108 }
2109
2110 static bool __gpiod_free(struct gpio_desc *desc)
2111 {
2112         bool                    ret = false;
2113         unsigned long           flags;
2114         struct gpio_chip        *chip;
2115
2116         might_sleep();
2117
2118         gpiod_unexport(desc);
2119
2120         spin_lock_irqsave(&gpio_lock, flags);
2121
2122         chip = desc->gdev->chip;
2123         if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
2124                 if (chip->free) {
2125                         spin_unlock_irqrestore(&gpio_lock, flags);
2126                         might_sleep_if(chip->can_sleep);
2127                         chip->free(chip, gpio_chip_hwgpio(desc));
2128                         spin_lock_irqsave(&gpio_lock, flags);
2129                 }
2130                 desc_set_label(desc, NULL);
2131                 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2132                 clear_bit(FLAG_REQUESTED, &desc->flags);
2133                 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2134                 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2135                 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2136                 ret = true;
2137         }
2138
2139         spin_unlock_irqrestore(&gpio_lock, flags);
2140         return ret;
2141 }
2142
2143 void gpiod_free(struct gpio_desc *desc)
2144 {
2145         if (desc && desc->gdev && __gpiod_free(desc)) {
2146                 module_put(desc->gdev->owner);
2147                 put_device(&desc->gdev->dev);
2148         } else {
2149                 WARN_ON(extra_checks);
2150         }
2151 }
2152
2153 /**
2154  * gpiochip_is_requested - return string iff signal was requested
2155  * @chip: controller managing the signal
2156  * @offset: of signal within controller's 0..(ngpio - 1) range
2157  *
2158  * Returns NULL if the GPIO is not currently requested, else a string.
2159  * The string returned is the label passed to gpio_request(); if none has been
2160  * passed it is a meaningless, non-NULL constant.
2161  *
2162  * This function is for use by GPIO controller drivers.  The label can
2163  * help with diagnostics, and knowing that the signal is used as a GPIO
2164  * can help avoid accidentally multiplexing it to another controller.
2165  */
2166 const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
2167 {
2168         struct gpio_desc *desc;
2169
2170         if (offset >= chip->ngpio)
2171                 return NULL;
2172
2173         desc = &chip->gpiodev->descs[offset];
2174
2175         if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2176                 return NULL;
2177         return desc->label;
2178 }
2179 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2180
2181 /**
2182  * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2183  * @desc: GPIO descriptor to request
2184  * @label: label for the GPIO
2185  *
2186  * Function allows GPIO chip drivers to request and use their own GPIO
2187  * descriptors via gpiolib API. Difference to gpiod_request() is that this
2188  * function will not increase reference count of the GPIO chip module. This
2189  * allows the GPIO chip module to be unloaded as needed (we assume that the
2190  * GPIO chip driver handles freeing the GPIOs it has requested).
2191  */
2192 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
2193                                             const char *label)
2194 {
2195         struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
2196         int err;
2197
2198         if (IS_ERR(desc)) {
2199                 chip_err(chip, "failed to get GPIO descriptor\n");
2200                 return desc;
2201         }
2202
2203         err = __gpiod_request(desc, label);
2204         if (err < 0)
2205                 return ERR_PTR(err);
2206
2207         return desc;
2208 }
2209 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2210
2211 /**
2212  * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2213  * @desc: GPIO descriptor to free
2214  *
2215  * Function frees the given GPIO requested previously with
2216  * gpiochip_request_own_desc().
2217  */
2218 void gpiochip_free_own_desc(struct gpio_desc *desc)
2219 {
2220         if (desc)
2221                 __gpiod_free(desc);
2222 }
2223 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2224
2225 /*
2226  * Drivers MUST set GPIO direction before making get/set calls.  In
2227  * some cases this is done in early boot, before IRQs are enabled.
2228  *
2229  * As a rule these aren't called more than once (except for drivers
2230  * using the open-drain emulation idiom) so these are natural places
2231  * to accumulate extra debugging checks.  Note that we can't (yet)
2232  * rely on gpio_request() having been called beforehand.
2233  */
2234
2235 /**
2236  * gpiod_direction_input - set the GPIO direction to input
2237  * @desc:       GPIO to set to input
2238  *
2239  * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2240  * be called safely on it.
2241  *
2242  * Return 0 in case of success, else an error code.
2243  */
2244 int gpiod_direction_input(struct gpio_desc *desc)
2245 {
2246         struct gpio_chip        *chip;
2247         int                     status = -EINVAL;
2248
2249         VALIDATE_DESC(desc);
2250         chip = desc->gdev->chip;
2251
2252         if (!chip->get || !chip->direction_input) {
2253                 gpiod_warn(desc,
2254                         "%s: missing get() or direction_input() operations\n",
2255                         __func__);
2256                 return -EIO;
2257         }
2258
2259         status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
2260         if (status == 0)
2261                 clear_bit(FLAG_IS_OUT, &desc->flags);
2262
2263         trace_gpio_direction(desc_to_gpio(desc), 1, status);
2264
2265         return status;
2266 }
2267 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2268
2269 static int gpio_set_drive_single_ended(struct gpio_chip *gc, unsigned offset,
2270                                        enum pin_config_param mode)
2271 {
2272         unsigned long config = { PIN_CONF_PACKED(mode, 0) };
2273
2274         return gc->set_config ? gc->set_config(gc, offset, config) : -ENOTSUPP;
2275 }
2276
2277 static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2278 {
2279         struct gpio_chip *gc = desc->gdev->chip;
2280         int val = !!value;
2281         int ret;
2282
2283         /* GPIOs used for IRQs shall not be set as output */
2284         if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
2285                 gpiod_err(desc,
2286                           "%s: tried to set a GPIO tied to an IRQ as output\n",
2287                           __func__);
2288                 return -EIO;
2289         }
2290
2291         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2292                 /* First see if we can enable open drain in hardware */
2293                 ret = gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2294                                                   PIN_CONFIG_DRIVE_OPEN_DRAIN);
2295                 if (!ret)
2296                         goto set_output_value;
2297                 /* Emulate open drain by not actively driving the line high */
2298                 if (val)
2299                         return gpiod_direction_input(desc);
2300         }
2301         else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2302                 ret = gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2303                                                   PIN_CONFIG_DRIVE_OPEN_SOURCE);
2304                 if (!ret)
2305                         goto set_output_value;
2306                 /* Emulate open source by not actively driving the line low */
2307                 if (!val)
2308                         return gpiod_direction_input(desc);
2309         } else {
2310                 gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2311                                             PIN_CONFIG_DRIVE_PUSH_PULL);
2312         }
2313
2314 set_output_value:
2315         if (!gc->set || !gc->direction_output) {
2316                 gpiod_warn(desc,
2317                        "%s: missing set() or direction_output() operations\n",
2318                        __func__);
2319                 return -EIO;
2320         }
2321
2322         ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2323         if (!ret)
2324                 set_bit(FLAG_IS_OUT, &desc->flags);
2325         trace_gpio_value(desc_to_gpio(desc), 0, val);
2326         trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2327         return ret;
2328 }
2329
2330 /**
2331  * gpiod_direction_output_raw - set the GPIO direction to output
2332  * @desc:       GPIO to set to output
2333  * @value:      initial output value of the GPIO
2334  *
2335  * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2336  * be called safely on it. The initial value of the output must be specified
2337  * as raw value on the physical line without regard for the ACTIVE_LOW status.
2338  *
2339  * Return 0 in case of success, else an error code.
2340  */
2341 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2342 {
2343         VALIDATE_DESC(desc);
2344         return _gpiod_direction_output_raw(desc, value);
2345 }
2346 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2347
2348 /**
2349  * gpiod_direction_output - set the GPIO direction to output
2350  * @desc:       GPIO to set to output
2351  * @value:      initial output value of the GPIO
2352  *
2353  * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2354  * be called safely on it. The initial value of the output must be specified
2355  * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2356  * account.
2357  *
2358  * Return 0 in case of success, else an error code.
2359  */
2360 int gpiod_direction_output(struct gpio_desc *desc, int value)
2361 {
2362         VALIDATE_DESC(desc);
2363         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2364                 value = !value;
2365         else
2366                 value = !!value;
2367         return _gpiod_direction_output_raw(desc, value);
2368 }
2369 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2370
2371 /**
2372  * gpiod_set_debounce - sets @debounce time for a @gpio
2373  * @gpio: the gpio to set debounce time
2374  * @debounce: debounce time is microseconds
2375  *
2376  * returns -ENOTSUPP if the controller does not support setting
2377  * debounce.
2378  */
2379 int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
2380 {
2381         struct gpio_chip        *chip;
2382         unsigned long           config;
2383
2384         VALIDATE_DESC(desc);
2385         chip = desc->gdev->chip;
2386         if (!chip->set || !chip->set_config) {
2387                 gpiod_dbg(desc,
2388                           "%s: missing set() or set_config() operations\n",
2389                           __func__);
2390                 return -ENOTSUPP;
2391         }
2392
2393         config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2394         return chip->set_config(chip, gpio_chip_hwgpio(desc), config);
2395 }
2396 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2397
2398 /**
2399  * gpiod_is_active_low - test whether a GPIO is active-low or not
2400  * @desc: the gpio descriptor to test
2401  *
2402  * Returns 1 if the GPIO is active-low, 0 otherwise.
2403  */
2404 int gpiod_is_active_low(const struct gpio_desc *desc)
2405 {
2406         VALIDATE_DESC(desc);
2407         return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2408 }
2409 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2410
2411 /* I/O calls are only valid after configuration completed; the relevant
2412  * "is this a valid GPIO" error checks should already have been done.
2413  *
2414  * "Get" operations are often inlinable as reading a pin value register,
2415  * and masking the relevant bit in that register.
2416  *
2417  * When "set" operations are inlinable, they involve writing that mask to
2418  * one register to set a low value, or a different register to set it high.
2419  * Otherwise locking is needed, so there may be little value to inlining.
2420  *
2421  *------------------------------------------------------------------------
2422  *
2423  * IMPORTANT!!!  The hot paths -- get/set value -- assume that callers
2424  * have requested the GPIO.  That can include implicit requesting by
2425  * a direction setting call.  Marking a gpio as requested locks its chip
2426  * in memory, guaranteeing that these table lookups need no more locking
2427  * and that gpiochip_remove() will fail.
2428  *
2429  * REVISIT when debugging, consider adding some instrumentation to ensure
2430  * that the GPIO was actually requested.
2431  */
2432
2433 static int _gpiod_get_raw_value(const struct gpio_desc *desc)
2434 {
2435         struct gpio_chip        *chip;
2436         int offset;
2437         int value;
2438
2439         chip = desc->gdev->chip;
2440         offset = gpio_chip_hwgpio(desc);
2441         value = chip->get ? chip->get(chip, offset) : -EIO;
2442         value = value < 0 ? value : !!value;
2443         trace_gpio_value(desc_to_gpio(desc), 1, value);
2444         return value;
2445 }
2446
2447 /**
2448  * gpiod_get_raw_value() - return a gpio's raw value
2449  * @desc: gpio whose value will be returned
2450  *
2451  * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2452  * its ACTIVE_LOW status, or negative errno on failure.
2453  *
2454  * This function should be called from contexts where we cannot sleep, and will
2455  * complain if the GPIO chip functions potentially sleep.
2456  */
2457 int gpiod_get_raw_value(const struct gpio_desc *desc)
2458 {
2459         VALIDATE_DESC(desc);
2460         /* Should be using gpio_get_value_cansleep() */
2461         WARN_ON(desc->gdev->chip->can_sleep);
2462         return _gpiod_get_raw_value(desc);
2463 }
2464 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2465
2466 /**
2467  * gpiod_get_value() - return a gpio's value
2468  * @desc: gpio whose value will be returned
2469  *
2470  * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2471  * account, or negative errno on failure.
2472  *
2473  * This function should be called from contexts where we cannot sleep, and will
2474  * complain if the GPIO chip functions potentially sleep.
2475  */
2476 int gpiod_get_value(const struct gpio_desc *desc)
2477 {
2478         int value;
2479
2480         VALIDATE_DESC(desc);
2481         /* Should be using gpio_get_value_cansleep() */
2482         WARN_ON(desc->gdev->chip->can_sleep);
2483
2484         value = _gpiod_get_raw_value(desc);
2485         if (value < 0)
2486                 return value;
2487
2488         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2489                 value = !value;
2490
2491         return value;
2492 }
2493 EXPORT_SYMBOL_GPL(gpiod_get_value);
2494
2495 /*
2496  *  _gpio_set_open_drain_value() - Set the open drain gpio's value.
2497  * @desc: gpio descriptor whose state need to be set.
2498  * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2499  */
2500 static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value)
2501 {
2502         int err = 0;
2503         struct gpio_chip *chip = desc->gdev->chip;
2504         int offset = gpio_chip_hwgpio(desc);
2505
2506         if (value) {
2507                 err = chip->direction_input(chip, offset);
2508                 if (!err)
2509                         clear_bit(FLAG_IS_OUT, &desc->flags);
2510         } else {
2511                 err = chip->direction_output(chip, offset, 0);
2512                 if (!err)
2513                         set_bit(FLAG_IS_OUT, &desc->flags);
2514         }
2515         trace_gpio_direction(desc_to_gpio(desc), value, err);
2516         if (err < 0)
2517                 gpiod_err(desc,
2518                           "%s: Error in set_value for open drain err %d\n",
2519                           __func__, err);
2520 }
2521
2522 /*
2523  *  _gpio_set_open_source_value() - Set the open source gpio's value.
2524  * @desc: gpio descriptor whose state need to be set.
2525  * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2526  */
2527 static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value)
2528 {
2529         int err = 0;
2530         struct gpio_chip *chip = desc->gdev->chip;
2531         int offset = gpio_chip_hwgpio(desc);
2532
2533         if (value) {
2534                 err = chip->direction_output(chip, offset, 1);
2535                 if (!err)
2536                         set_bit(FLAG_IS_OUT, &desc->flags);
2537         } else {
2538                 err = chip->direction_input(chip, offset);
2539                 if (!err)
2540                         clear_bit(FLAG_IS_OUT, &desc->flags);
2541         }
2542         trace_gpio_direction(desc_to_gpio(desc), !value, err);
2543         if (err < 0)
2544                 gpiod_err(desc,
2545                           "%s: Error in set_value for open source err %d\n",
2546                           __func__, err);
2547 }
2548
2549 static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value)
2550 {
2551         struct gpio_chip        *chip;
2552
2553         chip = desc->gdev->chip;
2554         trace_gpio_value(desc_to_gpio(desc), 0, value);
2555         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2556                 _gpio_set_open_drain_value(desc, value);
2557         else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2558                 _gpio_set_open_source_value(desc, value);
2559         else
2560                 chip->set(chip, gpio_chip_hwgpio(desc), value);
2561 }
2562
2563 /*
2564  * set multiple outputs on the same chip;
2565  * use the chip's set_multiple function if available;
2566  * otherwise set the outputs sequentially;
2567  * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2568  *        defines which outputs are to be changed
2569  * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2570  *        defines the values the outputs specified by mask are to be set to
2571  */
2572 static void gpio_chip_set_multiple(struct gpio_chip *chip,
2573                                    unsigned long *mask, unsigned long *bits)
2574 {
2575         if (chip->set_multiple) {
2576                 chip->set_multiple(chip, mask, bits);
2577         } else {
2578                 unsigned int i;
2579
2580                 /* set outputs if the corresponding mask bit is set */
2581                 for_each_set_bit(i, mask, chip->ngpio)
2582                         chip->set(chip, i, test_bit(i, bits));
2583         }
2584 }
2585
2586 void gpiod_set_array_value_complex(bool raw, bool can_sleep,
2587                                    unsigned int array_size,
2588                                    struct gpio_desc **desc_array,
2589                                    int *value_array)
2590 {
2591         int i = 0;
2592
2593         while (i < array_size) {
2594                 struct gpio_chip *chip = desc_array[i]->gdev->chip;
2595                 unsigned long mask[BITS_TO_LONGS(chip->ngpio)];
2596                 unsigned long bits[BITS_TO_LONGS(chip->ngpio)];
2597                 int count = 0;
2598
2599                 if (!can_sleep)
2600                         WARN_ON(chip->can_sleep);
2601
2602                 memset(mask, 0, sizeof(mask));
2603                 do {
2604                         struct gpio_desc *desc = desc_array[i];
2605                         int hwgpio = gpio_chip_hwgpio(desc);
2606                         int value = value_array[i];
2607
2608                         if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2609                                 value = !value;
2610                         trace_gpio_value(desc_to_gpio(desc), 0, value);
2611                         /*
2612                          * collect all normal outputs belonging to the same chip
2613                          * open drain and open source outputs are set individually
2614                          */
2615                         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2616                                 _gpio_set_open_drain_value(desc, value);
2617                         } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2618                                 _gpio_set_open_source_value(desc, value);
2619                         } else {
2620                                 __set_bit(hwgpio, mask);
2621                                 if (value)
2622                                         __set_bit(hwgpio, bits);
2623                                 else
2624                                         __clear_bit(hwgpio, bits);
2625                                 count++;
2626                         }
2627                         i++;
2628                 } while ((i < array_size) &&
2629                          (desc_array[i]->gdev->chip == chip));
2630                 /* push collected bits to outputs */
2631                 if (count != 0)
2632                         gpio_chip_set_multiple(chip, mask, bits);
2633         }
2634 }
2635
2636 /**
2637  * gpiod_set_raw_value() - assign a gpio's raw value
2638  * @desc: gpio whose value will be assigned
2639  * @value: value to assign
2640  *
2641  * Set the raw value of the GPIO, i.e. the value of its physical line without
2642  * regard for its ACTIVE_LOW status.
2643  *
2644  * This function should be called from contexts where we cannot sleep, and will
2645  * complain if the GPIO chip functions potentially sleep.
2646  */
2647 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
2648 {
2649         VALIDATE_DESC_VOID(desc);
2650         /* Should be using gpiod_set_value_cansleep() */
2651         WARN_ON(desc->gdev->chip->can_sleep);
2652         _gpiod_set_raw_value(desc, value);
2653 }
2654 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
2655
2656 /**
2657  * gpiod_set_value() - assign a gpio's value
2658  * @desc: gpio whose value will be assigned
2659  * @value: value to assign
2660  *
2661  * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2662  * account
2663  *
2664  * This function should be called from contexts where we cannot sleep, and will
2665  * complain if the GPIO chip functions potentially sleep.
2666  */
2667 void gpiod_set_value(struct gpio_desc *desc, int value)
2668 {
2669         VALIDATE_DESC_VOID(desc);
2670         /* Should be using gpiod_set_value_cansleep() */
2671         WARN_ON(desc->gdev->chip->can_sleep);
2672         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2673                 value = !value;
2674         _gpiod_set_raw_value(desc, value);
2675 }
2676 EXPORT_SYMBOL_GPL(gpiod_set_value);
2677
2678 /**
2679  * gpiod_set_raw_array_value() - assign values to an array of GPIOs
2680  * @array_size: number of elements in the descriptor / value arrays
2681  * @desc_array: array of GPIO descriptors whose values will be assigned
2682  * @value_array: array of values to assign
2683  *
2684  * Set the raw values of the GPIOs, i.e. the values of the physical lines
2685  * without regard for their ACTIVE_LOW status.
2686  *
2687  * This function should be called from contexts where we cannot sleep, and will
2688  * complain if the GPIO chip functions potentially sleep.
2689  */
2690 void gpiod_set_raw_array_value(unsigned int array_size,
2691                          struct gpio_desc **desc_array, int *value_array)
2692 {
2693         if (!desc_array)
2694                 return;
2695         gpiod_set_array_value_complex(true, false, array_size, desc_array,
2696                                       value_array);
2697 }
2698 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
2699
2700 /**
2701  * gpiod_set_array_value() - assign values to an array of GPIOs
2702  * @array_size: number of elements in the descriptor / value arrays
2703  * @desc_array: array of GPIO descriptors whose values will be assigned
2704  * @value_array: array of values to assign
2705  *
2706  * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2707  * into account.
2708  *
2709  * This function should be called from contexts where we cannot sleep, and will
2710  * complain if the GPIO chip functions potentially sleep.
2711  */
2712 void gpiod_set_array_value(unsigned int array_size,
2713                            struct gpio_desc **desc_array, int *value_array)
2714 {
2715         if (!desc_array)
2716                 return;
2717         gpiod_set_array_value_complex(false, false, array_size, desc_array,
2718                                       value_array);
2719 }
2720 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
2721
2722 /**
2723  * gpiod_cansleep() - report whether gpio value access may sleep
2724  * @desc: gpio to check
2725  *
2726  */
2727 int gpiod_cansleep(const struct gpio_desc *desc)
2728 {
2729         VALIDATE_DESC(desc);
2730         return desc->gdev->chip->can_sleep;
2731 }
2732 EXPORT_SYMBOL_GPL(gpiod_cansleep);
2733
2734 /**
2735  * gpiod_to_irq() - return the IRQ corresponding to a GPIO
2736  * @desc: gpio whose IRQ will be returned (already requested)
2737  *
2738  * Return the IRQ corresponding to the passed GPIO, or an error code in case of
2739  * error.
2740  */
2741 int gpiod_to_irq(const struct gpio_desc *desc)
2742 {
2743         struct gpio_chip *chip;
2744         int offset;
2745
2746         /*
2747          * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
2748          * requires this function to not return zero on an invalid descriptor
2749          * but rather a negative error number.
2750          */
2751         if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
2752                 return -EINVAL;
2753
2754         chip = desc->gdev->chip;
2755         offset = gpio_chip_hwgpio(desc);
2756         if (chip->to_irq) {
2757                 int retirq = chip->to_irq(chip, offset);
2758
2759                 /* Zero means NO_IRQ */
2760                 if (!retirq)
2761                         return -ENXIO;
2762
2763                 return retirq;
2764         }
2765         return -ENXIO;
2766 }
2767 EXPORT_SYMBOL_GPL(gpiod_to_irq);
2768
2769 /**
2770  * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
2771  * @chip: the chip the GPIO to lock belongs to
2772  * @offset: the offset of the GPIO to lock as IRQ
2773  *
2774  * This is used directly by GPIO drivers that want to lock down
2775  * a certain GPIO line to be used for IRQs.
2776  */
2777 int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
2778 {
2779         struct gpio_desc *desc;
2780
2781         desc = gpiochip_get_desc(chip, offset);
2782         if (IS_ERR(desc))
2783                 return PTR_ERR(desc);
2784
2785         /*
2786          * If it's fast: flush the direction setting if something changed
2787          * behind our back
2788          */
2789         if (!chip->can_sleep && chip->get_direction) {
2790                 int dir = chip->get_direction(chip, offset);
2791
2792                 if (dir)
2793                         clear_bit(FLAG_IS_OUT, &desc->flags);
2794                 else
2795                         set_bit(FLAG_IS_OUT, &desc->flags);
2796         }
2797
2798         if (test_bit(FLAG_IS_OUT, &desc->flags)) {
2799                 chip_err(chip,
2800                           "%s: tried to flag a GPIO set as output for IRQ\n",
2801                           __func__);
2802                 return -EIO;
2803         }
2804
2805         set_bit(FLAG_USED_AS_IRQ, &desc->flags);
2806
2807         /*
2808          * If the consumer has not set up a label (such as when the
2809          * IRQ is referenced from .to_irq()) we set up a label here
2810          * so it is clear this is used as an interrupt.
2811          */
2812         if (!desc->label)
2813                 desc_set_label(desc, "interrupt");
2814
2815         return 0;
2816 }
2817 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
2818
2819 /**
2820  * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
2821  * @chip: the chip the GPIO to lock belongs to
2822  * @offset: the offset of the GPIO to lock as IRQ
2823  *
2824  * This is used directly by GPIO drivers that want to indicate
2825  * that a certain GPIO is no longer used exclusively for IRQ.
2826  */
2827 void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
2828 {
2829         struct gpio_desc *desc;
2830
2831         desc = gpiochip_get_desc(chip, offset);
2832         if (IS_ERR(desc))
2833                 return;
2834
2835         clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
2836
2837         /* If we only had this marking, erase it */
2838         if (desc->label && !strcmp(desc->label, "interrupt"))
2839                 desc_set_label(desc, NULL);
2840 }
2841 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
2842
2843 bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset)
2844 {
2845         if (offset >= chip->ngpio)
2846                 return false;
2847
2848         return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
2849 }
2850 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
2851
2852 bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset)
2853 {
2854         if (offset >= chip->ngpio)
2855                 return false;
2856
2857         return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags);
2858 }
2859 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
2860
2861 bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset)
2862 {
2863         if (offset >= chip->ngpio)
2864                 return false;
2865
2866         return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags);
2867 }
2868 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
2869
2870 bool gpiochip_line_is_persistent(struct gpio_chip *chip, unsigned int offset)
2871 {
2872         if (offset >= chip->ngpio)
2873                 return false;
2874
2875         return !test_bit(FLAG_SLEEP_MAY_LOOSE_VALUE,
2876                          &chip->gpiodev->descs[offset].flags);
2877 }
2878 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
2879
2880 /**
2881  * gpiod_get_raw_value_cansleep() - return a gpio's raw value
2882  * @desc: gpio whose value will be returned
2883  *
2884  * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2885  * its ACTIVE_LOW status, or negative errno on failure.
2886  *
2887  * This function is to be called from contexts that can sleep.
2888  */
2889 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
2890 {
2891         might_sleep_if(extra_checks);
2892         VALIDATE_DESC(desc);
2893         return _gpiod_get_raw_value(desc);
2894 }
2895 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
2896
2897 /**
2898  * gpiod_get_value_cansleep() - return a gpio's value
2899  * @desc: gpio whose value will be returned
2900  *
2901  * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2902  * account, or negative errno on failure.
2903  *
2904  * This function is to be called from contexts that can sleep.
2905  */
2906 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
2907 {
2908         int value;
2909
2910         might_sleep_if(extra_checks);
2911         VALIDATE_DESC(desc);
2912         value = _gpiod_get_raw_value(desc);
2913         if (value < 0)
2914                 return value;
2915
2916         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2917                 value = !value;
2918
2919         return value;
2920 }
2921 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
2922
2923 /**
2924  * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
2925  * @desc: gpio whose value will be assigned
2926  * @value: value to assign
2927  *
2928  * Set the raw value of the GPIO, i.e. the value of its physical line without
2929  * regard for its ACTIVE_LOW status.
2930  *
2931  * This function is to be called from contexts that can sleep.
2932  */
2933 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
2934 {
2935         might_sleep_if(extra_checks);
2936         VALIDATE_DESC_VOID(desc);
2937         _gpiod_set_raw_value(desc, value);
2938 }
2939 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
2940
2941 /**
2942  * gpiod_set_value_cansleep() - assign a gpio's value
2943  * @desc: gpio whose value will be assigned
2944  * @value: value to assign
2945  *
2946  * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2947  * account
2948  *
2949  * This function is to be called from contexts that can sleep.
2950  */
2951 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
2952 {
2953         might_sleep_if(extra_checks);
2954         VALIDATE_DESC_VOID(desc);
2955         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2956                 value = !value;
2957         _gpiod_set_raw_value(desc, value);
2958 }
2959 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
2960
2961 /**
2962  * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
2963  * @array_size: number of elements in the descriptor / value arrays
2964  * @desc_array: array of GPIO descriptors whose values will be assigned
2965  * @value_array: array of values to assign
2966  *
2967  * Set the raw values of the GPIOs, i.e. the values of the physical lines
2968  * without regard for their ACTIVE_LOW status.
2969  *
2970  * This function is to be called from contexts that can sleep.
2971  */
2972 void gpiod_set_raw_array_value_cansleep(unsigned int array_size,
2973                                         struct gpio_desc **desc_array,
2974                                         int *value_array)
2975 {
2976         might_sleep_if(extra_checks);
2977         if (!desc_array)
2978                 return;
2979         gpiod_set_array_value_complex(true, true, array_size, desc_array,
2980                                       value_array);
2981 }
2982 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
2983
2984 /**
2985  * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
2986  * @array_size: number of elements in the descriptor / value arrays
2987  * @desc_array: array of GPIO descriptors whose values will be assigned
2988  * @value_array: array of values to assign
2989  *
2990  * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2991  * into account.
2992  *
2993  * This function is to be called from contexts that can sleep.
2994  */
2995 void gpiod_set_array_value_cansleep(unsigned int array_size,
2996                                     struct gpio_desc **desc_array,
2997                                     int *value_array)
2998 {
2999         might_sleep_if(extra_checks);
3000         if (!desc_array)
3001                 return;
3002         gpiod_set_array_value_complex(false, true, array_size, desc_array,
3003                                       value_array);
3004 }
3005 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3006
3007 /**
3008  * gpiod_add_lookup_table() - register GPIO device consumers
3009  * @table: table of consumers to register
3010  */
3011 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3012 {
3013         mutex_lock(&gpio_lookup_lock);
3014
3015         list_add_tail(&table->list, &gpio_lookup_list);
3016
3017         mutex_unlock(&gpio_lookup_lock);
3018 }
3019 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3020
3021 /**
3022  * gpiod_remove_lookup_table() - unregister GPIO device consumers
3023  * @table: table of consumers to unregister
3024  */
3025 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3026 {
3027         mutex_lock(&gpio_lookup_lock);
3028
3029         list_del(&table->list);
3030
3031         mutex_unlock(&gpio_lookup_lock);
3032 }
3033 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3034
3035 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3036 {
3037         const char *dev_id = dev ? dev_name(dev) : NULL;
3038         struct gpiod_lookup_table *table;
3039
3040         mutex_lock(&gpio_lookup_lock);
3041
3042         list_for_each_entry(table, &gpio_lookup_list, list) {
3043                 if (table->dev_id && dev_id) {
3044                         /*
3045                          * Valid strings on both ends, must be identical to have
3046                          * a match
3047                          */
3048                         if (!strcmp(table->dev_id, dev_id))
3049                                 goto found;
3050                 } else {
3051                         /*
3052                          * One of the pointers is NULL, so both must be to have
3053                          * a match
3054                          */
3055                         if (dev_id == table->dev_id)
3056                                 goto found;
3057                 }
3058         }
3059         table = NULL;
3060
3061 found:
3062         mutex_unlock(&gpio_lookup_lock);
3063         return table;
3064 }
3065
3066 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3067                                     unsigned int idx,
3068                                     enum gpio_lookup_flags *flags)
3069 {
3070         struct gpio_desc *desc = ERR_PTR(-ENOENT);
3071         struct gpiod_lookup_table *table;
3072         struct gpiod_lookup *p;
3073
3074         table = gpiod_find_lookup_table(dev);
3075         if (!table)
3076                 return desc;
3077
3078         for (p = &table->table[0]; p->chip_label; p++) {
3079                 struct gpio_chip *chip;
3080
3081                 /* idx must always match exactly */
3082                 if (p->idx != idx)
3083                         continue;
3084
3085                 /* If the lookup entry has a con_id, require exact match */
3086                 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3087                         continue;
3088
3089                 chip = find_chip_by_name(p->chip_label);
3090
3091                 if (!chip) {
3092                         dev_err(dev, "cannot find GPIO chip %s\n",
3093                                 p->chip_label);
3094                         return ERR_PTR(-ENODEV);
3095                 }
3096
3097                 if (chip->ngpio <= p->chip_hwnum) {
3098                         dev_err(dev,
3099                                 "requested GPIO %d is out of range [0..%d] for chip %s\n",
3100                                 idx, chip->ngpio, chip->label);
3101                         return ERR_PTR(-EINVAL);
3102                 }
3103
3104                 desc = gpiochip_get_desc(chip, p->chip_hwnum);
3105                 *flags = p->flags;
3106
3107                 return desc;
3108         }
3109
3110         return desc;
3111 }
3112
3113 static int dt_gpio_count(struct device *dev, const char *con_id)
3114 {
3115         int ret;
3116         char propname[32];
3117         unsigned int i;
3118
3119         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3120                 if (con_id)
3121                         snprintf(propname, sizeof(propname), "%s-%s",
3122                                  con_id, gpio_suffixes[i]);
3123                 else
3124                         snprintf(propname, sizeof(propname), "%s",
3125                                  gpio_suffixes[i]);
3126
3127                 ret = of_gpio_named_count(dev->of_node, propname);
3128                 if (ret > 0)
3129                         break;
3130         }
3131         return ret ? ret : -ENOENT;
3132 }
3133
3134 static int platform_gpio_count(struct device *dev, const char *con_id)
3135 {
3136         struct gpiod_lookup_table *table;
3137         struct gpiod_lookup *p;
3138         unsigned int count = 0;
3139
3140         table = gpiod_find_lookup_table(dev);
3141         if (!table)
3142                 return -ENOENT;
3143
3144         for (p = &table->table[0]; p->chip_label; p++) {
3145                 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3146                     (!con_id && !p->con_id))
3147                         count++;
3148         }
3149         if (!count)
3150                 return -ENOENT;
3151
3152         return count;
3153 }
3154
3155 /**
3156  * gpiod_count - return the number of GPIOs associated with a device / function
3157  *              or -ENOENT if no GPIO has been assigned to the requested function
3158  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3159  * @con_id:     function within the GPIO consumer
3160  */
3161 int gpiod_count(struct device *dev, const char *con_id)
3162 {
3163         int count = -ENOENT;
3164
3165         if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
3166                 count = dt_gpio_count(dev, con_id);
3167         else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
3168                 count = acpi_gpio_count(dev, con_id);
3169
3170         if (count < 0)
3171                 count = platform_gpio_count(dev, con_id);
3172
3173         return count;
3174 }
3175 EXPORT_SYMBOL_GPL(gpiod_count);
3176
3177 /**
3178  * gpiod_get - obtain a GPIO for a given GPIO function
3179  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3180  * @con_id:     function within the GPIO consumer
3181  * @flags:      optional GPIO initialization flags
3182  *
3183  * Return the GPIO descriptor corresponding to the function con_id of device
3184  * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3185  * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3186  */
3187 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3188                                          enum gpiod_flags flags)
3189 {
3190         return gpiod_get_index(dev, con_id, 0, flags);
3191 }
3192 EXPORT_SYMBOL_GPL(gpiod_get);
3193
3194 /**
3195  * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3196  * @dev: GPIO consumer, can be NULL for system-global GPIOs
3197  * @con_id: function within the GPIO consumer
3198  * @flags: optional GPIO initialization flags
3199  *
3200  * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3201  * the requested function it will return NULL. This is convenient for drivers
3202  * that need to handle optional GPIOs.
3203  */
3204 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3205                                                   const char *con_id,
3206                                                   enum gpiod_flags flags)
3207 {
3208         return gpiod_get_index_optional(dev, con_id, 0, flags);
3209 }
3210 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3211
3212
3213 /**
3214  * gpiod_configure_flags - helper function to configure a given GPIO
3215  * @desc:       gpio whose value will be assigned
3216  * @con_id:     function within the GPIO consumer
3217  * @lflags:     gpio_lookup_flags - returned from of_find_gpio() or
3218  *              of_get_gpio_hog()
3219  * @dflags:     gpiod_flags - optional GPIO initialization flags
3220  *
3221  * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3222  * requested function and/or index, or another IS_ERR() code if an error
3223  * occurred while trying to acquire the GPIO.
3224  */
3225 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3226                 unsigned long lflags, enum gpiod_flags dflags)
3227 {
3228         int status;
3229
3230         if (lflags & GPIO_ACTIVE_LOW)
3231                 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3232         if (lflags & GPIO_OPEN_DRAIN)
3233                 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3234         if (lflags & GPIO_OPEN_SOURCE)
3235                 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3236         if (lflags & GPIO_SLEEP_MAY_LOOSE_VALUE)
3237                 set_bit(FLAG_SLEEP_MAY_LOOSE_VALUE, &desc->flags);
3238
3239         /* No particular flag request, return here... */
3240         if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3241                 pr_debug("no flags found for %s\n", con_id);
3242                 return 0;
3243         }
3244
3245         /* Process flags */
3246         if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3247                 status = gpiod_direction_output(desc,
3248                                 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3249         else
3250                 status = gpiod_direction_input(desc);
3251
3252         return status;
3253 }
3254
3255 /**
3256  * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3257  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3258  * @con_id:     function within the GPIO consumer
3259  * @idx:        index of the GPIO to obtain in the consumer
3260  * @flags:      optional GPIO initialization flags
3261  *
3262  * This variant of gpiod_get() allows to access GPIOs other than the first
3263  * defined one for functions that define several GPIOs.
3264  *
3265  * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3266  * requested function and/or index, or another IS_ERR() code if an error
3267  * occurred while trying to acquire the GPIO.
3268  */
3269 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3270                                                const char *con_id,
3271                                                unsigned int idx,
3272                                                enum gpiod_flags flags)
3273 {
3274         struct gpio_desc *desc = NULL;
3275         int status;
3276         enum gpio_lookup_flags lookupflags = 0;
3277
3278         dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3279
3280         if (dev) {
3281                 /* Using device tree? */
3282                 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
3283                         dev_dbg(dev, "using device tree for GPIO lookup\n");
3284                         desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3285                 } else if (ACPI_COMPANION(dev)) {
3286                         dev_dbg(dev, "using ACPI for GPIO lookup\n");
3287                         desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
3288                 }
3289         }
3290
3291         /*
3292          * Either we are not using DT or ACPI, or their lookup did not return
3293          * a result. In that case, use platform lookup as a fallback.
3294          */
3295         if (!desc || desc == ERR_PTR(-ENOENT)) {
3296                 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3297                 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3298         }
3299
3300         if (IS_ERR(desc)) {
3301                 dev_dbg(dev, "lookup for GPIO %s failed\n", con_id);
3302                 return desc;
3303         }
3304
3305         status = gpiod_request(desc, con_id);
3306         if (status < 0)
3307                 return ERR_PTR(status);
3308
3309         status = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3310         if (status < 0) {
3311                 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3312                 gpiod_put(desc);
3313                 return ERR_PTR(status);
3314         }
3315
3316         return desc;
3317 }
3318 EXPORT_SYMBOL_GPL(gpiod_get_index);
3319
3320 /**
3321  * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3322  * @fwnode:     handle of the firmware node
3323  * @propname:   name of the firmware property representing the GPIO
3324  * @index:      index of the GPIO to obtain in the consumer
3325  * @dflags:     GPIO initialization flags
3326  *
3327  * This function can be used for drivers that get their configuration
3328  * from firmware.
3329  *
3330  * Function properly finds the corresponding GPIO using whatever is the
3331  * underlying firmware interface and then makes sure that the GPIO
3332  * descriptor is requested before it is returned to the caller.
3333  *
3334  * On successful request the GPIO pin is configured in accordance with
3335  * provided @dflags.
3336  *
3337  * In case of error an ERR_PTR() is returned.
3338  */
3339 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3340                                          const char *propname, int index,
3341                                          enum gpiod_flags dflags,
3342                                          const char *label)
3343 {
3344         struct gpio_desc *desc = ERR_PTR(-ENODEV);
3345         unsigned long lflags = 0;
3346         bool active_low = false;
3347         bool single_ended = false;
3348         bool open_drain = false;
3349         int ret;
3350
3351         if (!fwnode)
3352                 return ERR_PTR(-EINVAL);
3353
3354         if (is_of_node(fwnode)) {
3355                 enum of_gpio_flags flags;
3356
3357                 desc = of_get_named_gpiod_flags(to_of_node(fwnode), propname,
3358                                                 index, &flags);
3359                 if (!IS_ERR(desc)) {
3360                         active_low = flags & OF_GPIO_ACTIVE_LOW;
3361                         single_ended = flags & OF_GPIO_SINGLE_ENDED;
3362                         open_drain = flags & OF_GPIO_OPEN_DRAIN;
3363                 }
3364         } else if (is_acpi_node(fwnode)) {
3365                 struct acpi_gpio_info info;
3366
3367                 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
3368                 if (!IS_ERR(desc)) {
3369                         active_low = info.polarity == GPIO_ACTIVE_LOW;
3370                         ret = acpi_gpio_update_gpiod_flags(&dflags, info.flags);
3371                         if (ret)
3372                                 pr_debug("Override GPIO initialization flags\n");
3373                 }
3374         }
3375
3376         if (IS_ERR(desc))
3377                 return desc;
3378
3379         ret = gpiod_request(desc, label);
3380         if (ret)
3381                 return ERR_PTR(ret);
3382
3383         if (active_low)
3384                 lflags |= GPIO_ACTIVE_LOW;
3385
3386         if (single_ended) {
3387                 if (open_drain)
3388                         lflags |= GPIO_OPEN_DRAIN;
3389                 else
3390                         lflags |= GPIO_OPEN_SOURCE;
3391         }
3392
3393         ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3394         if (ret < 0) {
3395                 gpiod_put(desc);
3396                 return ERR_PTR(ret);
3397         }
3398
3399         return desc;
3400 }
3401 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
3402
3403 /**
3404  * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3405  *                            function
3406  * @dev: GPIO consumer, can be NULL for system-global GPIOs
3407  * @con_id: function within the GPIO consumer
3408  * @index: index of the GPIO to obtain in the consumer
3409  * @flags: optional GPIO initialization flags
3410  *
3411  * This is equivalent to gpiod_get_index(), except that when no GPIO with the
3412  * specified index was assigned to the requested function it will return NULL.
3413  * This is convenient for drivers that need to handle optional GPIOs.
3414  */
3415 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
3416                                                         const char *con_id,
3417                                                         unsigned int index,
3418                                                         enum gpiod_flags flags)
3419 {
3420         struct gpio_desc *desc;
3421
3422         desc = gpiod_get_index(dev, con_id, index, flags);
3423         if (IS_ERR(desc)) {
3424                 if (PTR_ERR(desc) == -ENOENT)
3425                         return NULL;
3426         }
3427
3428         return desc;
3429 }
3430 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
3431
3432 /**
3433  * gpiod_hog - Hog the specified GPIO desc given the provided flags
3434  * @desc:       gpio whose value will be assigned
3435  * @name:       gpio line name
3436  * @lflags:     gpio_lookup_flags - returned from of_find_gpio() or
3437  *              of_get_gpio_hog()
3438  * @dflags:     gpiod_flags - optional GPIO initialization flags
3439  */
3440 int gpiod_hog(struct gpio_desc *desc, const char *name,
3441               unsigned long lflags, enum gpiod_flags dflags)
3442 {
3443         struct gpio_chip *chip;
3444         struct gpio_desc *local_desc;
3445         int hwnum;
3446         int status;
3447
3448         chip = gpiod_to_chip(desc);
3449         hwnum = gpio_chip_hwgpio(desc);
3450
3451         local_desc = gpiochip_request_own_desc(chip, hwnum, name);
3452         if (IS_ERR(local_desc)) {
3453                 status = PTR_ERR(local_desc);
3454                 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
3455                        name, chip->label, hwnum, status);
3456                 return status;
3457         }
3458
3459         status = gpiod_configure_flags(desc, name, lflags, dflags);
3460         if (status < 0) {
3461                 pr_err("setup of hog GPIO %s (chip %s, offset %d) failed, %d\n",
3462                        name, chip->label, hwnum, status);
3463                 gpiochip_free_own_desc(desc);
3464                 return status;
3465         }
3466
3467         /* Mark GPIO as hogged so it can be identified and removed later */
3468         set_bit(FLAG_IS_HOGGED, &desc->flags);
3469
3470         pr_info("GPIO line %d (%s) hogged as %s%s\n",
3471                 desc_to_gpio(desc), name,
3472                 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
3473                 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
3474                   (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");
3475
3476         return 0;
3477 }
3478
3479 /**
3480  * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
3481  * @chip:       gpio chip to act on
3482  *
3483  * This is only used by of_gpiochip_remove to free hogged gpios
3484  */
3485 static void gpiochip_free_hogs(struct gpio_chip *chip)
3486 {
3487         int id;
3488
3489         for (id = 0; id < chip->ngpio; id++) {
3490                 if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
3491                         gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
3492         }
3493 }
3494
3495 /**
3496  * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
3497  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3498  * @con_id:     function within the GPIO consumer
3499  * @flags:      optional GPIO initialization flags
3500  *
3501  * This function acquires all the GPIOs defined under a given function.
3502  *
3503  * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
3504  * no GPIO has been assigned to the requested function, or another IS_ERR()
3505  * code if an error occurred while trying to acquire the GPIOs.
3506  */
3507 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
3508                                                 const char *con_id,
3509                                                 enum gpiod_flags flags)
3510 {
3511         struct gpio_desc *desc;
3512         struct gpio_descs *descs;
3513         int count;
3514
3515         count = gpiod_count(dev, con_id);
3516         if (count < 0)
3517                 return ERR_PTR(count);
3518
3519         descs = kzalloc(sizeof(*descs) + sizeof(descs->desc[0]) * count,
3520                         GFP_KERNEL);
3521         if (!descs)
3522                 return ERR_PTR(-ENOMEM);
3523
3524         for (descs->ndescs = 0; descs->ndescs < count; ) {
3525                 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
3526                 if (IS_ERR(desc)) {
3527                         gpiod_put_array(descs);
3528                         return ERR_CAST(desc);
3529                 }
3530                 descs->desc[descs->ndescs] = desc;
3531                 descs->ndescs++;
3532         }
3533         return descs;
3534 }
3535 EXPORT_SYMBOL_GPL(gpiod_get_array);
3536
3537 /**
3538  * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
3539  *                            function
3540  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3541  * @con_id:     function within the GPIO consumer
3542  * @flags:      optional GPIO initialization flags
3543  *
3544  * This is equivalent to gpiod_get_array(), except that when no GPIO was
3545  * assigned to the requested function it will return NULL.
3546  */
3547 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
3548                                                         const char *con_id,
3549                                                         enum gpiod_flags flags)
3550 {
3551         struct gpio_descs *descs;
3552
3553         descs = gpiod_get_array(dev, con_id, flags);
3554         if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
3555                 return NULL;
3556
3557         return descs;
3558 }
3559 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
3560
3561 /**
3562  * gpiod_put - dispose of a GPIO descriptor
3563  * @desc:       GPIO descriptor to dispose of
3564  *
3565  * No descriptor can be used after gpiod_put() has been called on it.
3566  */
3567 void gpiod_put(struct gpio_desc *desc)
3568 {
3569         gpiod_free(desc);
3570 }
3571 EXPORT_SYMBOL_GPL(gpiod_put);
3572
3573 /**
3574  * gpiod_put_array - dispose of multiple GPIO descriptors
3575  * @descs:      struct gpio_descs containing an array of descriptors
3576  */
3577 void gpiod_put_array(struct gpio_descs *descs)
3578 {
3579         unsigned int i;
3580
3581         for (i = 0; i < descs->ndescs; i++)
3582                 gpiod_put(descs->desc[i]);
3583
3584         kfree(descs);
3585 }
3586 EXPORT_SYMBOL_GPL(gpiod_put_array);
3587
3588 static int __init gpiolib_dev_init(void)
3589 {
3590         int ret;
3591
3592         /* Register GPIO sysfs bus */
3593         ret  = bus_register(&gpio_bus_type);
3594         if (ret < 0) {
3595                 pr_err("gpiolib: could not register GPIO bus type\n");
3596                 return ret;
3597         }
3598
3599         ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
3600         if (ret < 0) {
3601                 pr_err("gpiolib: failed to allocate char dev region\n");
3602                 bus_unregister(&gpio_bus_type);
3603         } else {
3604                 gpiolib_initialized = true;
3605                 gpiochip_setup_devs();
3606         }
3607         return ret;
3608 }
3609 core_initcall(gpiolib_dev_init);
3610
3611 #ifdef CONFIG_DEBUG_FS
3612
3613 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
3614 {
3615         unsigned                i;
3616         struct gpio_chip        *chip = gdev->chip;
3617         unsigned                gpio = gdev->base;
3618         struct gpio_desc        *gdesc = &gdev->descs[0];
3619         int                     is_out;
3620         int                     is_irq;
3621
3622         for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
3623                 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
3624                         if (gdesc->name) {
3625                                 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
3626                                            gpio, gdesc->name);
3627                         }
3628                         continue;
3629                 }
3630
3631                 gpiod_get_direction(gdesc);
3632                 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
3633                 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
3634                 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s",
3635                         gpio, gdesc->name ? gdesc->name : "", gdesc->label,
3636                         is_out ? "out" : "in ",
3637                         chip->get
3638                                 ? (chip->get(chip, i) ? "hi" : "lo")
3639                                 : "?  ",
3640                         is_irq ? "IRQ" : "   ");
3641                 seq_printf(s, "\n");
3642         }
3643 }
3644
3645 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
3646 {
3647         unsigned long flags;
3648         struct gpio_device *gdev = NULL;
3649         loff_t index = *pos;
3650
3651         s->private = "";
3652
3653         spin_lock_irqsave(&gpio_lock, flags);
3654         list_for_each_entry(gdev, &gpio_devices, list)
3655                 if (index-- == 0) {
3656                         spin_unlock_irqrestore(&gpio_lock, flags);
3657                         return gdev;
3658                 }
3659         spin_unlock_irqrestore(&gpio_lock, flags);
3660
3661         return NULL;
3662 }
3663
3664 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
3665 {
3666         unsigned long flags;
3667         struct gpio_device *gdev = v;
3668         void *ret = NULL;
3669
3670         spin_lock_irqsave(&gpio_lock, flags);
3671         if (list_is_last(&gdev->list, &gpio_devices))
3672                 ret = NULL;
3673         else
3674                 ret = list_entry(gdev->list.next, struct gpio_device, list);
3675         spin_unlock_irqrestore(&gpio_lock, flags);
3676
3677         s->private = "\n";
3678         ++*pos;
3679
3680         return ret;
3681 }
3682
3683 static void gpiolib_seq_stop(struct seq_file *s, void *v)
3684 {
3685 }
3686
3687 static int gpiolib_seq_show(struct seq_file *s, void *v)
3688 {
3689         struct gpio_device *gdev = v;
3690         struct gpio_chip *chip = gdev->chip;
3691         struct device *parent;
3692
3693         if (!chip) {
3694                 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
3695                            dev_name(&gdev->dev));
3696                 return 0;
3697         }
3698
3699         seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
3700                    dev_name(&gdev->dev),
3701                    gdev->base, gdev->base + gdev->ngpio - 1);
3702         parent = chip->parent;
3703         if (parent)
3704                 seq_printf(s, ", parent: %s/%s",
3705                            parent->bus ? parent->bus->name : "no-bus",
3706                            dev_name(parent));
3707         if (chip->label)
3708                 seq_printf(s, ", %s", chip->label);
3709         if (chip->can_sleep)
3710                 seq_printf(s, ", can sleep");
3711         seq_printf(s, ":\n");
3712
3713         if (chip->dbg_show)
3714                 chip->dbg_show(s, chip);
3715         else
3716                 gpiolib_dbg_show(s, gdev);
3717
3718         return 0;
3719 }
3720
3721 static const struct seq_operations gpiolib_seq_ops = {
3722         .start = gpiolib_seq_start,
3723         .next = gpiolib_seq_next,
3724         .stop = gpiolib_seq_stop,
3725         .show = gpiolib_seq_show,
3726 };
3727
3728 static int gpiolib_open(struct inode *inode, struct file *file)
3729 {
3730         return seq_open(file, &gpiolib_seq_ops);
3731 }
3732
3733 static const struct file_operations gpiolib_operations = {
3734         .owner          = THIS_MODULE,
3735         .open           = gpiolib_open,
3736         .read           = seq_read,
3737         .llseek         = seq_lseek,
3738         .release        = seq_release,
3739 };
3740
3741 static int __init gpiolib_debugfs_init(void)
3742 {
3743         /* /sys/kernel/debug/gpio */
3744         (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
3745                                 NULL, NULL, &gpiolib_operations);
3746         return 0;
3747 }
3748 subsys_initcall(gpiolib_debugfs_init);
3749
3750 #endif  /* DEBUG_FS */