drivers/gpio/gpiolib.c

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