drivers/gpio/gpiolib.c

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