drivers/gpio/gpiolib.c

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