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                 /* TODO: check if descriptors are really input */
 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;
 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 #endif
1266
1267         gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL);
1268         if (gdev->id < 0) {
1269                 status = gdev->id;
1270                 goto err_free_gdev;
1271         }
1272         dev_set_name(&gdev->dev, "gpiochip%d", gdev->id);
1273         device_initialize(&gdev->dev);
1274         dev_set_drvdata(&gdev->dev, gdev);
1275         if (chip->parent && chip->parent->driver)
1276                 gdev->owner = chip->parent->driver->owner;
1277         else if (chip->owner)
1278                 /* TODO: remove chip->owner */
1279                 gdev->owner = chip->owner;
1280         else
1281                 gdev->owner = THIS_MODULE;
1282
1283         gdev->descs = kcalloc(chip->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
1284         if (!gdev->descs) {
1285                 status = -ENOMEM;
1286                 goto err_free_gdev;
1287         }
1288
1289         if (chip->ngpio == 0) {
1290                 chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
1291                 status = -EINVAL;
1292                 goto err_free_descs;
1293         }
1294
1295         if (chip->ngpio > FASTPATH_NGPIO)
1296                 chip_warn(chip, "line cnt %u is greater than fast path cnt %u\n",
1297                 chip->ngpio, FASTPATH_NGPIO);
1298
1299         gdev->label = kstrdup_const(chip->label ?: "unknown", GFP_KERNEL);
1300         if (!gdev->label) {
1301                 status = -ENOMEM;
1302                 goto err_free_descs;
1303         }
1304
1305         gdev->ngpio = chip->ngpio;
1306         gdev->data = data;
1307
1308         spin_lock_irqsave(&gpio_lock, flags);
1309
1310         /*
1311          * TODO: this allocates a Linux GPIO number base in the global
1312          * GPIO numberspace for this chip. In the long run we want to
1313          * get *rid* of this numberspace and use only descriptors, but
1314          * it may be a pipe dream. It will not happen before we get rid
1315          * of the sysfs interface anyways.
1316          */
1317         if (base < 0) {
1318                 base = gpiochip_find_base(chip->ngpio);
1319                 if (base < 0) {
1320                         status = base;
1321                         spin_unlock_irqrestore(&gpio_lock, flags);
1322                         goto err_free_label;
1323                 }
1324                 /*
1325                  * TODO: it should not be necessary to reflect the assigned
1326                  * base outside of the GPIO subsystem. Go over drivers and
1327                  * see if anyone makes use of this, else drop this and assign
1328                  * a poison instead.
1329                  */
1330                 chip->base = base;
1331         }
1332         gdev->base = base;
1333
1334         status = gpiodev_add_to_list(gdev);
1335         if (status) {
1336                 spin_unlock_irqrestore(&gpio_lock, flags);
1337                 goto err_free_label;
1338         }
1339
1340         spin_unlock_irqrestore(&gpio_lock, flags);
1341
1342         for (i = 0; i < chip->ngpio; i++) {
1343                 struct gpio_desc *desc = &gdev->descs[i];
1344
1345                 desc->gdev = gdev;
1346
1347                 /* REVISIT: most hardware initializes GPIOs as inputs (often
1348                  * with pullups enabled) so power usage is minimized. Linux
1349                  * code should set the gpio direction first thing; but until
1350                  * it does, and in case chip->get_direction is not set, we may
1351                  * expose the wrong direction in sysfs.
1352                  */
1353                 desc->flags = !chip->direction_input ? (1 << FLAG_IS_OUT) : 0;
1354         }
1355
1356 #ifdef CONFIG_PINCTRL
1357         INIT_LIST_HEAD(&gdev->pin_ranges);
1358 #endif
1359
1360         status = gpiochip_set_desc_names(chip);
1361         if (status)
1362                 goto err_remove_from_list;
1363
1364         status = gpiochip_irqchip_init_valid_mask(chip);
1365         if (status)
1366                 goto err_remove_from_list;
1367
1368         status = gpiochip_init_valid_mask(chip);
1369         if (status)
1370                 goto err_remove_irqchip_mask;
1371
1372         status = gpiochip_add_irqchip(chip, lock_key, request_key);
1373         if (status)
1374                 goto err_remove_chip;
1375
1376         status = of_gpiochip_add(chip);
1377         if (status)
1378                 goto err_remove_chip;
1379
1380         acpi_gpiochip_add(chip);
1381
1382         machine_gpiochip_add(chip);
1383
1384         /*
1385          * By first adding the chardev, and then adding the device,
1386          * we get a device node entry in sysfs under
1387          * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
1388          * coldplug of device nodes and other udev business.
1389          * We can do this only if gpiolib has been initialized.
1390          * Otherwise, defer until later.
1391          */
1392         if (gpiolib_initialized) {
1393                 status = gpiochip_setup_dev(gdev);
1394                 if (status)
1395                         goto err_remove_chip;
1396         }
1397         return 0;
1398
1399 err_remove_chip:
1400         acpi_gpiochip_remove(chip);
1401         gpiochip_free_hogs(chip);
1402         of_gpiochip_remove(chip);
1403         gpiochip_free_valid_mask(chip);
1404 err_remove_irqchip_mask:
1405         gpiochip_irqchip_free_valid_mask(chip);
1406 err_remove_from_list:
1407         spin_lock_irqsave(&gpio_lock, flags);
1408         list_del(&gdev->list);
1409         spin_unlock_irqrestore(&gpio_lock, flags);
1410 err_free_label:
1411         kfree_const(gdev->label);
1412 err_free_descs:
1413         kfree(gdev->descs);
1414 err_free_gdev:
1415         ida_simple_remove(&gpio_ida, gdev->id);
1416         /* failures here can mean systems won't boot... */
1417         pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
1418                gdev->base, gdev->base + gdev->ngpio - 1,
1419                chip->label ? : "generic");
1420         kfree(gdev);
1421         return status;
1422 }
1423 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
1424
1425 /**
1426  * gpiochip_get_data() - get per-subdriver data for the chip
1427  * @chip: GPIO chip
1428  *
1429  * Returns:
1430  * The per-subdriver data for the chip.
1431  */
1432 void *gpiochip_get_data(struct gpio_chip *chip)
1433 {
1434         return chip->gpiodev->data;
1435 }
1436 EXPORT_SYMBOL_GPL(gpiochip_get_data);
1437
1438 /**
1439  * gpiochip_remove() - unregister a gpio_chip
1440  * @chip: the chip to unregister
1441  *
1442  * A gpio_chip with any GPIOs still requested may not be removed.
1443  */
1444 void gpiochip_remove(struct gpio_chip *chip)
1445 {
1446         struct gpio_device *gdev = chip->gpiodev;
1447         struct gpio_desc *desc;
1448         unsigned long   flags;
1449         unsigned        i;
1450         bool            requested = false;
1451
1452         /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
1453         gpiochip_sysfs_unregister(gdev);
1454         gpiochip_free_hogs(chip);
1455         /* Numb the device, cancelling all outstanding operations */
1456         gdev->chip = NULL;
1457         gpiochip_irqchip_remove(chip);
1458         acpi_gpiochip_remove(chip);
1459         gpiochip_remove_pin_ranges(chip);
1460         of_gpiochip_remove(chip);
1461         gpiochip_free_valid_mask(chip);
1462         /*
1463          * We accept no more calls into the driver from this point, so
1464          * NULL the driver data pointer
1465          */
1466         gdev->data = NULL;
1467
1468         spin_lock_irqsave(&gpio_lock, flags);
1469         for (i = 0; i < gdev->ngpio; i++) {
1470                 desc = &gdev->descs[i];
1471                 if (test_bit(FLAG_REQUESTED, &desc->flags))
1472                         requested = true;
1473         }
1474         spin_unlock_irqrestore(&gpio_lock, flags);
1475
1476         if (requested)
1477                 dev_crit(&gdev->dev,
1478                          "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
1479
1480         /*
1481          * The gpiochip side puts its use of the device to rest here:
1482          * if there are no userspace clients, the chardev and device will
1483          * be removed, else it will be dangling until the last user is
1484          * gone.
1485          */
1486         cdev_device_del(&gdev->chrdev, &gdev->dev);
1487         put_device(&gdev->dev);
1488 }
1489 EXPORT_SYMBOL_GPL(gpiochip_remove);
1490
1491 static void devm_gpio_chip_release(struct device *dev, void *res)
1492 {
1493         struct gpio_chip *chip = *(struct gpio_chip **)res;
1494
1495         gpiochip_remove(chip);
1496 }
1497
1498 static int devm_gpio_chip_match(struct device *dev, void *res, void *data)
1499
1500 {
1501         struct gpio_chip **r = res;
1502
1503         if (!r || !*r) {
1504                 WARN_ON(!r || !*r);
1505                 return 0;
1506         }
1507
1508         return *r == data;
1509 }
1510
1511 /**
1512  * devm_gpiochip_add_data() - Resource manager gpiochip_add_data()
1513  * @dev: the device pointer on which irq_chip belongs to.
1514  * @chip: the chip to register, with chip->base initialized
1515  * @data: driver-private data associated with this chip
1516  *
1517  * Context: potentially before irqs will work
1518  *
1519  * The gpio chip automatically be released when the device is unbound.
1520  *
1521  * Returns:
1522  * A negative errno if the chip can't be registered, such as because the
1523  * chip->base is invalid or already associated with a different chip.
1524  * Otherwise it returns zero as a success code.
1525  */
1526 int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
1527                            void *data)
1528 {
1529         struct gpio_chip **ptr;
1530         int ret;
1531
1532         ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr),
1533                              GFP_KERNEL);
1534         if (!ptr)
1535                 return -ENOMEM;
1536
1537         ret = gpiochip_add_data(chip, data);
1538         if (ret < 0) {
1539                 devres_free(ptr);
1540                 return ret;
1541         }
1542
1543         *ptr = chip;
1544         devres_add(dev, ptr);
1545
1546         return 0;
1547 }
1548 EXPORT_SYMBOL_GPL(devm_gpiochip_add_data);
1549
1550 /**
1551  * devm_gpiochip_remove() - Resource manager of gpiochip_remove()
1552  * @dev: device for which which resource was allocated
1553  * @chip: the chip to remove
1554  *
1555  * A gpio_chip with any GPIOs still requested may not be removed.
1556  */
1557 void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip)
1558 {
1559         int ret;
1560
1561         ret = devres_release(dev, devm_gpio_chip_release,
1562                              devm_gpio_chip_match, chip);
1563         WARN_ON(ret);
1564 }
1565 EXPORT_SYMBOL_GPL(devm_gpiochip_remove);
1566
1567 /**
1568  * gpiochip_find() - iterator for locating a specific gpio_chip
1569  * @data: data to pass to match function
1570  * @match: Callback function to check gpio_chip
1571  *
1572  * Similar to bus_find_device.  It returns a reference to a gpio_chip as
1573  * determined by a user supplied @match callback.  The callback should return
1574  * 0 if the device doesn't match and non-zero if it does.  If the callback is
1575  * non-zero, this function will return to the caller and not iterate over any
1576  * more gpio_chips.
1577  */
1578 struct gpio_chip *gpiochip_find(void *data,
1579                                 int (*match)(struct gpio_chip *chip,
1580                                              void *data))
1581 {
1582         struct gpio_device *gdev;
1583         struct gpio_chip *chip = NULL;
1584         unsigned long flags;
1585
1586         spin_lock_irqsave(&gpio_lock, flags);
1587         list_for_each_entry(gdev, &gpio_devices, list)
1588                 if (gdev->chip && match(gdev->chip, data)) {
1589                         chip = gdev->chip;
1590                         break;
1591                 }
1592
1593         spin_unlock_irqrestore(&gpio_lock, flags);
1594
1595         return chip;
1596 }
1597 EXPORT_SYMBOL_GPL(gpiochip_find);
1598
1599 static int gpiochip_match_name(struct gpio_chip *chip, void *data)
1600 {
1601         const char *name = data;
1602
1603         return !strcmp(chip->label, name);
1604 }
1605
1606 static struct gpio_chip *find_chip_by_name(const char *name)
1607 {
1608         return gpiochip_find((void *)name, gpiochip_match_name);
1609 }
1610
1611 #ifdef CONFIG_GPIOLIB_IRQCHIP
1612
1613 /*
1614  * The following is irqchip helper code for gpiochips.
1615  */
1616
1617 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
1618 {
1619         if (!gpiochip->irq.need_valid_mask)
1620                 return 0;
1621
1622         gpiochip->irq.valid_mask = gpiochip_allocate_mask(gpiochip);
1623         if (!gpiochip->irq.valid_mask)
1624                 return -ENOMEM;
1625
1626         return 0;
1627 }
1628
1629 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1630 {
1631         kfree(gpiochip->irq.valid_mask);
1632         gpiochip->irq.valid_mask = NULL;
1633 }
1634
1635 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip,
1636                                 unsigned int offset)
1637 {
1638         if (!gpiochip_line_is_valid(gpiochip, offset))
1639                 return false;
1640         /* No mask means all valid */
1641         if (likely(!gpiochip->irq.valid_mask))
1642                 return true;
1643         return test_bit(offset, gpiochip->irq.valid_mask);
1644 }
1645 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
1646
1647 /**
1648  * gpiochip_set_cascaded_irqchip() - connects a cascaded irqchip to a gpiochip
1649  * @gpiochip: the gpiochip to set the irqchip chain to
1650  * @irqchip: the irqchip to chain to the gpiochip
1651  * @parent_irq: the irq number corresponding to the parent IRQ for this
1652  * chained irqchip
1653  * @parent_handler: the parent interrupt handler for the accumulated IRQ
1654  * coming out of the gpiochip. If the interrupt is nested rather than
1655  * cascaded, pass NULL in this handler argument
1656  */
1657 static void gpiochip_set_cascaded_irqchip(struct gpio_chip *gpiochip,
1658                                           struct irq_chip *irqchip,
1659                                           unsigned int parent_irq,
1660                                           irq_flow_handler_t parent_handler)
1661 {
1662         unsigned int offset;
1663
1664         if (!gpiochip->irq.domain) {
1665                 chip_err(gpiochip, "called %s before setting up irqchip\n",
1666                          __func__);
1667                 return;
1668         }
1669
1670         if (parent_handler) {
1671                 if (gpiochip->can_sleep) {
1672                         chip_err(gpiochip,
1673                                  "you cannot have chained interrupts on a chip that may sleep\n");
1674                         return;
1675                 }
1676                 /*
1677                  * The parent irqchip is already using the chip_data for this
1678                  * irqchip, so our callbacks simply use the handler_data.
1679                  */
1680                 irq_set_chained_handler_and_data(parent_irq, parent_handler,
1681                                                  gpiochip);
1682
1683                 gpiochip->irq.parents = &parent_irq;
1684                 gpiochip->irq.num_parents = 1;
1685         }
1686
1687         /* Set the parent IRQ for all affected IRQs */
1688         for (offset = 0; offset < gpiochip->ngpio; offset++) {
1689                 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1690                         continue;
1691                 irq_set_parent(irq_find_mapping(gpiochip->irq.domain, offset),
1692                                parent_irq);
1693         }
1694 }
1695
1696 /**
1697  * gpiochip_set_chained_irqchip() - connects a chained irqchip to a gpiochip
1698  * @gpiochip: the gpiochip to set the irqchip chain to
1699  * @irqchip: the irqchip to chain to the gpiochip
1700  * @parent_irq: the irq number corresponding to the parent IRQ for this
1701  * chained irqchip
1702  * @parent_handler: the parent interrupt handler for the accumulated IRQ
1703  * coming out of the gpiochip. If the interrupt is nested rather than
1704  * cascaded, pass NULL in this handler argument
1705  */
1706 void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
1707                                   struct irq_chip *irqchip,
1708                                   unsigned int parent_irq,
1709                                   irq_flow_handler_t parent_handler)
1710 {
1711         if (gpiochip->irq.threaded) {
1712                 chip_err(gpiochip, "tried to chain a threaded gpiochip\n");
1713                 return;
1714         }
1715
1716         gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq,
1717                                       parent_handler);
1718 }
1719 EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
1720
1721 /**
1722  * gpiochip_set_nested_irqchip() - connects a nested irqchip to a gpiochip
1723  * @gpiochip: the gpiochip to set the irqchip nested handler to
1724  * @irqchip: the irqchip to nest to the gpiochip
1725  * @parent_irq: the irq number corresponding to the parent IRQ for this
1726  * nested irqchip
1727  */
1728 void gpiochip_set_nested_irqchip(struct gpio_chip *gpiochip,
1729                                  struct irq_chip *irqchip,
1730                                  unsigned int parent_irq)
1731 {
1732         gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq,
1733                                       NULL);
1734 }
1735 EXPORT_SYMBOL_GPL(gpiochip_set_nested_irqchip);
1736
1737 /**
1738  * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1739  * @d: the irqdomain used by this irqchip
1740  * @irq: the global irq number used by this GPIO irqchip irq
1741  * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1742  *
1743  * This function will set up the mapping for a certain IRQ line on a
1744  * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1745  * stored inside the gpiochip.
1746  */
1747 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1748                      irq_hw_number_t hwirq)
1749 {
1750         struct gpio_chip *chip = d->host_data;
1751         int err = 0;
1752
1753         if (!gpiochip_irqchip_irq_valid(chip, hwirq))
1754                 return -ENXIO;
1755
1756         irq_set_chip_data(irq, chip);
1757         /*
1758          * This lock class tells lockdep that GPIO irqs are in a different
1759          * category than their parents, so it won't report false recursion.
1760          */
1761         irq_set_lockdep_class(irq, chip->irq.lock_key, chip->irq.request_key);
1762         irq_set_chip_and_handler(irq, chip->irq.chip, chip->irq.handler);
1763         /* Chips that use nested thread handlers have them marked */
1764         if (chip->irq.threaded)
1765                 irq_set_nested_thread(irq, 1);
1766         irq_set_noprobe(irq);
1767
1768         if (chip->irq.num_parents == 1)
1769                 err = irq_set_parent(irq, chip->irq.parents[0]);
1770         else if (chip->irq.map)
1771                 err = irq_set_parent(irq, chip->irq.map[hwirq]);
1772
1773         if (err < 0)
1774                 return err;
1775
1776         /*
1777          * No set-up of the hardware will happen if IRQ_TYPE_NONE
1778          * is passed as default type.
1779          */
1780         if (chip->irq.default_type != IRQ_TYPE_NONE)
1781                 irq_set_irq_type(irq, chip->irq.default_type);
1782
1783         return 0;
1784 }
1785 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1786
1787 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1788 {
1789         struct gpio_chip *chip = d->host_data;
1790
1791         if (chip->irq.threaded)
1792                 irq_set_nested_thread(irq, 0);
1793         irq_set_chip_and_handler(irq, NULL, NULL);
1794         irq_set_chip_data(irq, NULL);
1795 }
1796 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1797
1798 static const struct irq_domain_ops gpiochip_domain_ops = {
1799         .map    = gpiochip_irq_map,
1800         .unmap  = gpiochip_irq_unmap,
1801         /* Virtually all GPIO irqchips are twocell:ed */
1802         .xlate  = irq_domain_xlate_twocell,
1803 };
1804
1805 static int gpiochip_irq_reqres(struct irq_data *d)
1806 {
1807         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1808
1809         if (!try_module_get(chip->gpiodev->owner))
1810                 return -ENODEV;
1811
1812         if (gpiochip_lock_as_irq(chip, d->hwirq)) {
1813                 chip_err(chip,
1814                         "unable to lock HW IRQ %lu for IRQ\n",
1815                         d->hwirq);
1816                 module_put(chip->gpiodev->owner);
1817                 return -EINVAL;
1818         }
1819         return 0;
1820 }
1821
1822 static void gpiochip_irq_relres(struct irq_data *d)
1823 {
1824         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1825
1826         gpiochip_unlock_as_irq(chip, d->hwirq);
1827         module_put(chip->gpiodev->owner);
1828 }
1829
1830 static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
1831 {
1832         if (!gpiochip_irqchip_irq_valid(chip, offset))
1833                 return -ENXIO;
1834
1835         return irq_create_mapping(chip->irq.domain, offset);
1836 }
1837
1838 /**
1839  * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1840  * @gpiochip: the GPIO chip to add the IRQ chip to
1841  * @lock_key: lockdep class for IRQ lock
1842  * @request_key: lockdep class for IRQ request
1843  */
1844 static int gpiochip_add_irqchip(struct gpio_chip *gpiochip,
1845                                 struct lock_class_key *lock_key,
1846                                 struct lock_class_key *request_key)
1847 {
1848         struct irq_chip *irqchip = gpiochip->irq.chip;
1849         const struct irq_domain_ops *ops;
1850         struct device_node *np;
1851         unsigned int type;
1852         unsigned int i;
1853
1854         if (!irqchip)
1855                 return 0;
1856
1857         if (gpiochip->irq.parent_handler && gpiochip->can_sleep) {
1858                 chip_err(gpiochip, "you cannot have chained interrupts on a chip that may sleep\n");
1859                 return -EINVAL;
1860         }
1861
1862         np = gpiochip->gpiodev->dev.of_node;
1863         type = gpiochip->irq.default_type;
1864
1865         /*
1866          * Specifying a default trigger is a terrible idea if DT or ACPI is
1867          * used to configure the interrupts, as you may end up with
1868          * conflicting triggers. Tell the user, and reset to NONE.
1869          */
1870         if (WARN(np && type != IRQ_TYPE_NONE,
1871                  "%s: Ignoring %u default trigger\n", np->full_name, type))
1872                 type = IRQ_TYPE_NONE;
1873
1874         if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
1875                 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
1876                                  "Ignoring %u default trigger\n", type);
1877                 type = IRQ_TYPE_NONE;
1878         }
1879
1880         gpiochip->to_irq = gpiochip_to_irq;
1881         gpiochip->irq.default_type = type;
1882         gpiochip->irq.lock_key = lock_key;
1883         gpiochip->irq.request_key = request_key;
1884
1885         if (gpiochip->irq.domain_ops)
1886                 ops = gpiochip->irq.domain_ops;
1887         else
1888                 ops = &gpiochip_domain_ops;
1889
1890         gpiochip->irq.domain = irq_domain_add_simple(np, gpiochip->ngpio,
1891                                                      gpiochip->irq.first,
1892                                                      ops, gpiochip);
1893         if (!gpiochip->irq.domain)
1894                 return -EINVAL;
1895
1896         /*
1897          * It is possible for a driver to override this, but only if the
1898          * alternative functions are both implemented.
1899          */
1900         if (!irqchip->irq_request_resources &&
1901             !irqchip->irq_release_resources) {
1902                 irqchip->irq_request_resources = gpiochip_irq_reqres;
1903                 irqchip->irq_release_resources = gpiochip_irq_relres;
1904         }
1905
1906         if (gpiochip->irq.parent_handler) {
1907                 void *data = gpiochip->irq.parent_handler_data ?: gpiochip;
1908
1909                 for (i = 0; i < gpiochip->irq.num_parents; i++) {
1910                         /*
1911                          * The parent IRQ chip is already using the chip_data
1912                          * for this IRQ chip, so our callbacks simply use the
1913                          * handler_data.
1914                          */
1915                         irq_set_chained_handler_and_data(gpiochip->irq.parents[i],
1916                                                          gpiochip->irq.parent_handler,
1917                                                          data);
1918                 }
1919         }
1920
1921         acpi_gpiochip_request_interrupts(gpiochip);
1922
1923         return 0;
1924 }
1925
1926 /**
1927  * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1928  * @gpiochip: the gpiochip to remove the irqchip from
1929  *
1930  * This is called only from gpiochip_remove()
1931  */
1932 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
1933 {
1934         unsigned int offset;
1935
1936         acpi_gpiochip_free_interrupts(gpiochip);
1937
1938         if (gpiochip->irq.chip && gpiochip->irq.parent_handler) {
1939                 struct gpio_irq_chip *irq = &gpiochip->irq;
1940                 unsigned int i;
1941
1942                 for (i = 0; i < irq->num_parents; i++)
1943                         irq_set_chained_handler_and_data(irq->parents[i],
1944                                                          NULL, NULL);
1945         }
1946
1947         /* Remove all IRQ mappings and delete the domain */
1948         if (gpiochip->irq.domain) {
1949                 unsigned int irq;
1950
1951                 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1952                         if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1953                                 continue;
1954
1955                         irq = irq_find_mapping(gpiochip->irq.domain, offset);
1956                         irq_dispose_mapping(irq);
1957                 }
1958
1959                 irq_domain_remove(gpiochip->irq.domain);
1960         }
1961
1962         if (gpiochip->irq.chip) {
1963                 gpiochip->irq.chip->irq_request_resources = NULL;
1964                 gpiochip->irq.chip->irq_release_resources = NULL;
1965                 gpiochip->irq.chip = NULL;
1966         }
1967
1968         gpiochip_irqchip_free_valid_mask(gpiochip);
1969 }
1970
1971 /**
1972  * gpiochip_irqchip_add_key() - adds an irqchip to a gpiochip
1973  * @gpiochip: the gpiochip to add the irqchip to
1974  * @irqchip: the irqchip to add to the gpiochip
1975  * @first_irq: if not dynamically assigned, the base (first) IRQ to
1976  * allocate gpiochip irqs from
1977  * @handler: the irq handler to use (often a predefined irq core function)
1978  * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
1979  * to have the core avoid setting up any default type in the hardware.
1980  * @threaded: whether this irqchip uses a nested thread handler
1981  * @lock_key: lockdep class for IRQ lock
1982  * @request_key: lockdep class for IRQ request
1983  *
1984  * This function closely associates a certain irqchip with a certain
1985  * gpiochip, providing an irq domain to translate the local IRQs to
1986  * global irqs in the gpiolib core, and making sure that the gpiochip
1987  * is passed as chip data to all related functions. Driver callbacks
1988  * need to use gpiochip_get_data() to get their local state containers back
1989  * from the gpiochip passed as chip data. An irqdomain will be stored
1990  * in the gpiochip that shall be used by the driver to handle IRQ number
1991  * translation. The gpiochip will need to be initialized and registered
1992  * before calling this function.
1993  *
1994  * This function will handle two cell:ed simple IRQs and assumes all
1995  * the pins on the gpiochip can generate a unique IRQ. Everything else
1996  * need to be open coded.
1997  */
1998 int gpiochip_irqchip_add_key(struct gpio_chip *gpiochip,
1999                              struct irq_chip *irqchip,
2000                              unsigned int first_irq,
2001                              irq_flow_handler_t handler,
2002                              unsigned int type,
2003                              bool threaded,
2004                              struct lock_class_key *lock_key,
2005                              struct lock_class_key *request_key)
2006 {
2007         struct device_node *of_node;
2008
2009         if (!gpiochip || !irqchip)
2010                 return -EINVAL;
2011
2012         if (!gpiochip->parent) {
2013                 pr_err("missing gpiochip .dev parent pointer\n");
2014                 return -EINVAL;
2015         }
2016         gpiochip->irq.threaded = threaded;
2017         of_node = gpiochip->parent->of_node;
2018 #ifdef CONFIG_OF_GPIO
2019         /*
2020          * If the gpiochip has an assigned OF node this takes precedence
2021          * FIXME: get rid of this and use gpiochip->parent->of_node
2022          * everywhere
2023          */
2024         if (gpiochip->of_node)
2025                 of_node = gpiochip->of_node;
2026 #endif
2027         /*
2028          * Specifying a default trigger is a terrible idea if DT or ACPI is
2029          * used to configure the interrupts, as you may end-up with
2030          * conflicting triggers. Tell the user, and reset to NONE.
2031          */
2032         if (WARN(of_node && type != IRQ_TYPE_NONE,
2033                  "%pOF: Ignoring %d default trigger\n", of_node, type))
2034                 type = IRQ_TYPE_NONE;
2035         if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
2036                 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
2037                                  "Ignoring %d default trigger\n", type);
2038                 type = IRQ_TYPE_NONE;
2039         }
2040
2041         gpiochip->irq.chip = irqchip;
2042         gpiochip->irq.handler = handler;
2043         gpiochip->irq.default_type = type;
2044         gpiochip->to_irq = gpiochip_to_irq;
2045         gpiochip->irq.lock_key = lock_key;
2046         gpiochip->irq.request_key = request_key;
2047         gpiochip->irq.domain = irq_domain_add_simple(of_node,
2048                                         gpiochip->ngpio, first_irq,
2049                                         &gpiochip_domain_ops, gpiochip);
2050         if (!gpiochip->irq.domain) {
2051                 gpiochip->irq.chip = NULL;
2052                 return -EINVAL;
2053         }
2054
2055         /*
2056          * It is possible for a driver to override this, but only if the
2057          * alternative functions are both implemented.
2058          */
2059         if (!irqchip->irq_request_resources &&
2060             !irqchip->irq_release_resources) {
2061                 irqchip->irq_request_resources = gpiochip_irq_reqres;
2062                 irqchip->irq_release_resources = gpiochip_irq_relres;
2063         }
2064
2065         acpi_gpiochip_request_interrupts(gpiochip);
2066
2067         return 0;
2068 }
2069 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_key);
2070
2071 #else /* CONFIG_GPIOLIB_IRQCHIP */
2072
2073 static inline int gpiochip_add_irqchip(struct gpio_chip *gpiochip,
2074                                        struct lock_class_key *lock_key,
2075                                        struct lock_class_key *request_key)
2076 {
2077         return 0;
2078 }
2079
2080 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
2081 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
2082 {
2083         return 0;
2084 }
2085 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
2086 { }
2087
2088 #endif /* CONFIG_GPIOLIB_IRQCHIP */
2089
2090 /**
2091  * gpiochip_generic_request() - request the gpio function for a pin
2092  * @chip: the gpiochip owning the GPIO
2093  * @offset: the offset of the GPIO to request for GPIO function
2094  */
2095 int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset)
2096 {
2097         return pinctrl_gpio_request(chip->gpiodev->base + offset);
2098 }
2099 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
2100
2101 /**
2102  * gpiochip_generic_free() - free the gpio function from a pin
2103  * @chip: the gpiochip to request the gpio function for
2104  * @offset: the offset of the GPIO to free from GPIO function
2105  */
2106 void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset)
2107 {
2108         pinctrl_gpio_free(chip->gpiodev->base + offset);
2109 }
2110 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
2111
2112 /**
2113  * gpiochip_generic_config() - apply configuration for a pin
2114  * @chip: the gpiochip owning the GPIO
2115  * @offset: the offset of the GPIO to apply the configuration
2116  * @config: the configuration to be applied
2117  */
2118 int gpiochip_generic_config(struct gpio_chip *chip, unsigned offset,
2119                             unsigned long config)
2120 {
2121         return pinctrl_gpio_set_config(chip->gpiodev->base + offset, config);
2122 }
2123 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
2124
2125 #ifdef CONFIG_PINCTRL
2126
2127 /**
2128  * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
2129  * @chip: the gpiochip to add the range for
2130  * @pctldev: the pin controller to map to
2131  * @gpio_offset: the start offset in the current gpio_chip number space
2132  * @pin_group: name of the pin group inside the pin controller
2133  *
2134  * Calling this function directly from a DeviceTree-supported
2135  * pinctrl driver is DEPRECATED. Please see Section 2.1 of
2136  * Documentation/devicetree/bindings/gpio/gpio.txt on how to
2137  * bind pinctrl and gpio drivers via the "gpio-ranges" property.
2138  */
2139 int gpiochip_add_pingroup_range(struct gpio_chip *chip,
2140                         struct pinctrl_dev *pctldev,
2141                         unsigned int gpio_offset, const char *pin_group)
2142 {
2143         struct gpio_pin_range *pin_range;
2144         struct gpio_device *gdev = chip->gpiodev;
2145         int ret;
2146
2147         pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
2148         if (!pin_range) {
2149                 chip_err(chip, "failed to allocate pin ranges\n");
2150                 return -ENOMEM;
2151         }
2152
2153         /* Use local offset as range ID */
2154         pin_range->range.id = gpio_offset;
2155         pin_range->range.gc = chip;
2156         pin_range->range.name = chip->label;
2157         pin_range->range.base = gdev->base + gpio_offset;
2158         pin_range->pctldev = pctldev;
2159
2160         ret = pinctrl_get_group_pins(pctldev, pin_group,
2161                                         &pin_range->range.pins,
2162                                         &pin_range->range.npins);
2163         if (ret < 0) {
2164                 kfree(pin_range);
2165                 return ret;
2166         }
2167
2168         pinctrl_add_gpio_range(pctldev, &pin_range->range);
2169
2170         chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
2171                  gpio_offset, gpio_offset + pin_range->range.npins - 1,
2172                  pinctrl_dev_get_devname(pctldev), pin_group);
2173
2174         list_add_tail(&pin_range->node, &gdev->pin_ranges);
2175
2176         return 0;
2177 }
2178 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
2179
2180 /**
2181  * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
2182  * @chip: the gpiochip to add the range for
2183  * @pinctl_name: the dev_name() of the pin controller to map to
2184  * @gpio_offset: the start offset in the current gpio_chip number space
2185  * @pin_offset: the start offset in the pin controller number space
2186  * @npins: the number of pins from the offset of each pin space (GPIO and
2187  *      pin controller) to accumulate in this range
2188  *
2189  * Returns:
2190  * 0 on success, or a negative error-code on failure.
2191  *
2192  * Calling this function directly from a DeviceTree-supported
2193  * pinctrl driver is DEPRECATED. Please see Section 2.1 of
2194  * Documentation/devicetree/bindings/gpio/gpio.txt on how to
2195  * bind pinctrl and gpio drivers via the "gpio-ranges" property.
2196  */
2197 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
2198                            unsigned int gpio_offset, unsigned int pin_offset,
2199                            unsigned int npins)
2200 {
2201         struct gpio_pin_range *pin_range;
2202         struct gpio_device *gdev = chip->gpiodev;
2203         int ret;
2204
2205         pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
2206         if (!pin_range) {
2207                 chip_err(chip, "failed to allocate pin ranges\n");
2208                 return -ENOMEM;
2209         }
2210
2211         /* Use local offset as range ID */
2212         pin_range->range.id = gpio_offset;
2213         pin_range->range.gc = chip;
2214         pin_range->range.name = chip->label;
2215         pin_range->range.base = gdev->base + gpio_offset;
2216         pin_range->range.pin_base = pin_offset;
2217         pin_range->range.npins = npins;
2218         pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
2219                         &pin_range->range);
2220         if (IS_ERR(pin_range->pctldev)) {
2221                 ret = PTR_ERR(pin_range->pctldev);
2222                 chip_err(chip, "could not create pin range\n");
2223                 kfree(pin_range);
2224                 return ret;
2225         }
2226         chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
2227                  gpio_offset, gpio_offset + npins - 1,
2228                  pinctl_name,
2229                  pin_offset, pin_offset + npins - 1);
2230
2231         list_add_tail(&pin_range->node, &gdev->pin_ranges);
2232
2233         return 0;
2234 }
2235 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
2236
2237 /**
2238  * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
2239  * @chip: the chip to remove all the mappings for
2240  */
2241 void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
2242 {
2243         struct gpio_pin_range *pin_range, *tmp;
2244         struct gpio_device *gdev = chip->gpiodev;
2245
2246         list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
2247                 list_del(&pin_range->node);
2248                 pinctrl_remove_gpio_range(pin_range->pctldev,
2249                                 &pin_range->range);
2250                 kfree(pin_range);
2251         }
2252 }
2253 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
2254
2255 #endif /* CONFIG_PINCTRL */
2256
2257 /* These "optional" allocation calls help prevent drivers from stomping
2258  * on each other, and help provide better diagnostics in debugfs.
2259  * They're called even less than the "set direction" calls.
2260  */
2261 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
2262 {
2263         struct gpio_chip        *chip = desc->gdev->chip;
2264         int                     status;
2265         unsigned long           flags;
2266
2267         spin_lock_irqsave(&gpio_lock, flags);
2268
2269         /* NOTE:  gpio_request() can be called in early boot,
2270          * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
2271          */
2272
2273         if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
2274                 desc_set_label(desc, label ? : "?");
2275                 status = 0;
2276         } else {
2277                 status = -EBUSY;
2278                 goto done;
2279         }
2280
2281         if (chip->request) {
2282                 /* chip->request may sleep */
2283                 spin_unlock_irqrestore(&gpio_lock, flags);
2284                 status = chip->request(chip, gpio_chip_hwgpio(desc));
2285                 spin_lock_irqsave(&gpio_lock, flags);
2286
2287                 if (status < 0) {
2288                         desc_set_label(desc, NULL);
2289                         clear_bit(FLAG_REQUESTED, &desc->flags);
2290                         goto done;
2291                 }
2292         }
2293         if (chip->get_direction) {
2294                 /* chip->get_direction may sleep */
2295                 spin_unlock_irqrestore(&gpio_lock, flags);
2296                 gpiod_get_direction(desc);
2297                 spin_lock_irqsave(&gpio_lock, flags);
2298         }
2299 done:
2300         spin_unlock_irqrestore(&gpio_lock, flags);
2301         return status;
2302 }
2303
2304 /*
2305  * This descriptor validation needs to be inserted verbatim into each
2306  * function taking a descriptor, so we need to use a preprocessor
2307  * macro to avoid endless duplication. If the desc is NULL it is an
2308  * optional GPIO and calls should just bail out.
2309  */
2310 static int validate_desc(const struct gpio_desc *desc, const char *func)
2311 {
2312         if (!desc)
2313                 return 0;
2314         if (IS_ERR(desc)) {
2315                 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
2316                 return PTR_ERR(desc);
2317         }
2318         if (!desc->gdev) {
2319                 pr_warn("%s: invalid GPIO (no device)\n", func);
2320                 return -EINVAL;
2321         }
2322         if (!desc->gdev->chip) {
2323                 dev_warn(&desc->gdev->dev,
2324                          "%s: backing chip is gone\n", func);
2325                 return 0;
2326         }
2327         return 1;
2328 }
2329
2330 #define VALIDATE_DESC(desc) do { \
2331         int __valid = validate_desc(desc, __func__); \
2332         if (__valid <= 0) \
2333                 return __valid; \
2334         } while (0)
2335
2336 #define VALIDATE_DESC_VOID(desc) do { \
2337         int __valid = validate_desc(desc, __func__); \
2338         if (__valid <= 0) \
2339                 return; \
2340         } while (0)
2341
2342 int gpiod_request(struct gpio_desc *desc, const char *label)
2343 {
2344         int status = -EPROBE_DEFER;
2345         struct gpio_device *gdev;
2346
2347         VALIDATE_DESC(desc);
2348         gdev = desc->gdev;
2349
2350         if (try_module_get(gdev->owner)) {
2351                 status = gpiod_request_commit(desc, label);
2352                 if (status < 0)
2353                         module_put(gdev->owner);
2354                 else
2355                         get_device(&gdev->dev);
2356         }
2357
2358         if (status)
2359                 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
2360
2361         return status;
2362 }
2363
2364 static bool gpiod_free_commit(struct gpio_desc *desc)
2365 {
2366         bool                    ret = false;
2367         unsigned long           flags;
2368         struct gpio_chip        *chip;
2369
2370         might_sleep();
2371
2372         gpiod_unexport(desc);
2373
2374         spin_lock_irqsave(&gpio_lock, flags);
2375
2376         chip = desc->gdev->chip;
2377         if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
2378                 if (chip->free) {
2379                         spin_unlock_irqrestore(&gpio_lock, flags);
2380                         might_sleep_if(chip->can_sleep);
2381                         chip->free(chip, gpio_chip_hwgpio(desc));
2382                         spin_lock_irqsave(&gpio_lock, flags);
2383                 }
2384                 desc_set_label(desc, NULL);
2385                 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2386                 clear_bit(FLAG_REQUESTED, &desc->flags);
2387                 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2388                 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2389                 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2390                 ret = true;
2391         }
2392
2393         spin_unlock_irqrestore(&gpio_lock, flags);
2394         return ret;
2395 }
2396
2397 void gpiod_free(struct gpio_desc *desc)
2398 {
2399         if (desc && desc->gdev && gpiod_free_commit(desc)) {
2400                 module_put(desc->gdev->owner);
2401                 put_device(&desc->gdev->dev);
2402         } else {
2403                 WARN_ON(extra_checks);
2404         }
2405 }
2406
2407 /**
2408  * gpiochip_is_requested - return string iff signal was requested
2409  * @chip: controller managing the signal
2410  * @offset: of signal within controller's 0..(ngpio - 1) range
2411  *
2412  * Returns NULL if the GPIO is not currently requested, else a string.
2413  * The string returned is the label passed to gpio_request(); if none has been
2414  * passed it is a meaningless, non-NULL constant.
2415  *
2416  * This function is for use by GPIO controller drivers.  The label can
2417  * help with diagnostics, and knowing that the signal is used as a GPIO
2418  * can help avoid accidentally multiplexing it to another controller.
2419  */
2420 const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
2421 {
2422         struct gpio_desc *desc;
2423
2424         if (offset >= chip->ngpio)
2425                 return NULL;
2426
2427         desc = &chip->gpiodev->descs[offset];
2428
2429         if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2430                 return NULL;
2431         return desc->label;
2432 }
2433 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2434
2435 /**
2436  * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2437  * @chip: GPIO chip
2438  * @hwnum: hardware number of the GPIO for which to request the descriptor
2439  * @label: label for the GPIO
2440  *
2441  * Function allows GPIO chip drivers to request and use their own GPIO
2442  * descriptors via gpiolib API. Difference to gpiod_request() is that this
2443  * function will not increase reference count of the GPIO chip module. This
2444  * allows the GPIO chip module to be unloaded as needed (we assume that the
2445  * GPIO chip driver handles freeing the GPIOs it has requested).
2446  *
2447  * Returns:
2448  * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2449  * code on failure.
2450  */
2451 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
2452                                             const char *label)
2453 {
2454         struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
2455         int err;
2456
2457         if (IS_ERR(desc)) {
2458                 chip_err(chip, "failed to get GPIO descriptor\n");
2459                 return desc;
2460         }
2461
2462         err = gpiod_request_commit(desc, label);
2463         if (err < 0)
2464                 return ERR_PTR(err);
2465
2466         return desc;
2467 }
2468 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2469
2470 /**
2471  * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2472  * @desc: GPIO descriptor to free
2473  *
2474  * Function frees the given GPIO requested previously with
2475  * gpiochip_request_own_desc().
2476  */
2477 void gpiochip_free_own_desc(struct gpio_desc *desc)
2478 {
2479         if (desc)
2480                 gpiod_free_commit(desc);
2481 }
2482 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2483
2484 /*
2485  * Drivers MUST set GPIO direction before making get/set calls.  In
2486  * some cases this is done in early boot, before IRQs are enabled.
2487  *
2488  * As a rule these aren't called more than once (except for drivers
2489  * using the open-drain emulation idiom) so these are natural places
2490  * to accumulate extra debugging checks.  Note that we can't (yet)
2491  * rely on gpio_request() having been called beforehand.
2492  */
2493
2494 /**
2495  * gpiod_direction_input - set the GPIO direction to input
2496  * @desc:       GPIO to set to input
2497  *
2498  * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2499  * be called safely on it.
2500  *
2501  * Return 0 in case of success, else an error code.
2502  */
2503 int gpiod_direction_input(struct gpio_desc *desc)
2504 {
2505         struct gpio_chip        *chip;
2506         int                     status = -EINVAL;
2507
2508         VALIDATE_DESC(desc);
2509         chip = desc->gdev->chip;
2510
2511         if (!chip->get || !chip->direction_input) {
2512                 gpiod_warn(desc,
2513                         "%s: missing get() or direction_input() operations\n",
2514                         __func__);
2515                 return -EIO;
2516         }
2517
2518         status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
2519         if (status == 0)
2520                 clear_bit(FLAG_IS_OUT, &desc->flags);
2521
2522         trace_gpio_direction(desc_to_gpio(desc), 1, status);
2523
2524         return status;
2525 }
2526 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2527
2528 static int gpio_set_drive_single_ended(struct gpio_chip *gc, unsigned offset,
2529                                        enum pin_config_param mode)
2530 {
2531         unsigned long config = { PIN_CONF_PACKED(mode, 0) };
2532
2533         return gc->set_config ? gc->set_config(gc, offset, config) : -ENOTSUPP;
2534 }
2535
2536 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2537 {
2538         struct gpio_chip *gc = desc->gdev->chip;
2539         int val = !!value;
2540         int ret;
2541
2542         if (!gc->set || !gc->direction_output) {
2543                 gpiod_warn(desc,
2544                        "%s: missing set() or direction_output() operations\n",
2545                        __func__);
2546                 return -EIO;
2547         }
2548
2549         ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2550         if (!ret)
2551                 set_bit(FLAG_IS_OUT, &desc->flags);
2552         trace_gpio_value(desc_to_gpio(desc), 0, val);
2553         trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2554         return ret;
2555 }
2556
2557 /**
2558  * gpiod_direction_output_raw - set the GPIO direction to output
2559  * @desc:       GPIO to set to output
2560  * @value:      initial output value of the GPIO
2561  *
2562  * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2563  * be called safely on it. The initial value of the output must be specified
2564  * as raw value on the physical line without regard for the ACTIVE_LOW status.
2565  *
2566  * Return 0 in case of success, else an error code.
2567  */
2568 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2569 {
2570         VALIDATE_DESC(desc);
2571         return gpiod_direction_output_raw_commit(desc, value);
2572 }
2573 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2574
2575 /**
2576  * gpiod_direction_output - set the GPIO direction to output
2577  * @desc:       GPIO to set to output
2578  * @value:      initial output value of the GPIO
2579  *
2580  * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2581  * be called safely on it. The initial value of the output must be specified
2582  * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2583  * account.
2584  *
2585  * Return 0 in case of success, else an error code.
2586  */
2587 int gpiod_direction_output(struct gpio_desc *desc, int value)
2588 {
2589         struct gpio_chip *gc;
2590         int ret;
2591
2592         VALIDATE_DESC(desc);
2593         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2594                 value = !value;
2595         else
2596                 value = !!value;
2597
2598         /* GPIOs used for IRQs shall not be set as output */
2599         if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
2600                 gpiod_err(desc,
2601                           "%s: tried to set a GPIO tied to an IRQ as output\n",
2602                           __func__);
2603                 return -EIO;
2604         }
2605
2606         gc = desc->gdev->chip;
2607         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2608                 /* First see if we can enable open drain in hardware */
2609                 ret = gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2610                                                   PIN_CONFIG_DRIVE_OPEN_DRAIN);
2611                 if (!ret)
2612                         goto set_output_value;
2613                 /* Emulate open drain by not actively driving the line high */
2614                 if (value)
2615                         return gpiod_direction_input(desc);
2616         }
2617         else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2618                 ret = gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2619                                                   PIN_CONFIG_DRIVE_OPEN_SOURCE);
2620                 if (!ret)
2621                         goto set_output_value;
2622                 /* Emulate open source by not actively driving the line low */
2623                 if (!value)
2624                         return gpiod_direction_input(desc);
2625         } else {
2626                 gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2627                                             PIN_CONFIG_DRIVE_PUSH_PULL);
2628         }
2629
2630 set_output_value:
2631         return gpiod_direction_output_raw_commit(desc, value);
2632 }
2633 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2634
2635 /**
2636  * gpiod_set_debounce - sets @debounce time for a GPIO
2637  * @desc: descriptor of the GPIO for which to set debounce time
2638  * @debounce: debounce time in microseconds
2639  *
2640  * Returns:
2641  * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2642  * debounce time.
2643  */
2644 int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
2645 {
2646         struct gpio_chip        *chip;
2647         unsigned long           config;
2648
2649         VALIDATE_DESC(desc);
2650         chip = desc->gdev->chip;
2651         if (!chip->set || !chip->set_config) {
2652                 gpiod_dbg(desc,
2653                           "%s: missing set() or set_config() operations\n",
2654                           __func__);
2655                 return -ENOTSUPP;
2656         }
2657
2658         config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2659         return chip->set_config(chip, gpio_chip_hwgpio(desc), config);
2660 }
2661 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2662
2663 /**
2664  * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2665  * @desc: descriptor of the GPIO for which to configure persistence
2666  * @transitory: True to lose state on suspend or reset, false for persistence
2667  *
2668  * Returns:
2669  * 0 on success, otherwise a negative error code.
2670  */
2671 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2672 {
2673         struct gpio_chip *chip;
2674         unsigned long packed;
2675         int gpio;
2676         int rc;
2677
2678         VALIDATE_DESC(desc);
2679         /*
2680          * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2681          * persistence state.
2682          */
2683         if (transitory)
2684                 set_bit(FLAG_TRANSITORY, &desc->flags);
2685         else
2686                 clear_bit(FLAG_TRANSITORY, &desc->flags);
2687
2688         /* If the driver supports it, set the persistence state now */
2689         chip = desc->gdev->chip;
2690         if (!chip->set_config)
2691                 return 0;
2692
2693         packed = pinconf_to_config_packed(PIN_CONFIG_PERSIST_STATE,
2694                                           !transitory);
2695         gpio = gpio_chip_hwgpio(desc);
2696         rc = chip->set_config(chip, gpio, packed);
2697         if (rc == -ENOTSUPP) {
2698                 dev_dbg(&desc->gdev->dev, "Persistence not supported for GPIO %d\n",
2699                                 gpio);
2700                 return 0;
2701         }
2702
2703         return rc;
2704 }
2705 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2706
2707 /**
2708  * gpiod_is_active_low - test whether a GPIO is active-low or not
2709  * @desc: the gpio descriptor to test
2710  *
2711  * Returns 1 if the GPIO is active-low, 0 otherwise.
2712  */
2713 int gpiod_is_active_low(const struct gpio_desc *desc)
2714 {
2715         VALIDATE_DESC(desc);
2716         return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2717 }
2718 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2719
2720 /* I/O calls are only valid after configuration completed; the relevant
2721  * "is this a valid GPIO" error checks should already have been done.
2722  *
2723  * "Get" operations are often inlinable as reading a pin value register,
2724  * and masking the relevant bit in that register.
2725  *
2726  * When "set" operations are inlinable, they involve writing that mask to
2727  * one register to set a low value, or a different register to set it high.
2728  * Otherwise locking is needed, so there may be little value to inlining.
2729  *
2730  *------------------------------------------------------------------------
2731  *
2732  * IMPORTANT!!!  The hot paths -- get/set value -- assume that callers
2733  * have requested the GPIO.  That can include implicit requesting by
2734  * a direction setting call.  Marking a gpio as requested locks its chip
2735  * in memory, guaranteeing that these table lookups need no more locking
2736  * and that gpiochip_remove() will fail.
2737  *
2738  * REVISIT when debugging, consider adding some instrumentation to ensure
2739  * that the GPIO was actually requested.
2740  */
2741
2742 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2743 {
2744         struct gpio_chip        *chip;
2745         int offset;
2746         int value;
2747
2748         chip = desc->gdev->chip;
2749         offset = gpio_chip_hwgpio(desc);
2750         value = chip->get ? chip->get(chip, offset) : -EIO;
2751         value = value < 0 ? value : !!value;
2752         trace_gpio_value(desc_to_gpio(desc), 1, value);
2753         return value;
2754 }
2755
2756 static int gpio_chip_get_multiple(struct gpio_chip *chip,
2757                                   unsigned long *mask, unsigned long *bits)
2758 {
2759         if (chip->get_multiple) {
2760                 return chip->get_multiple(chip, mask, bits);
2761         } else if (chip->get) {
2762                 int i, value;
2763
2764                 for_each_set_bit(i, mask, chip->ngpio) {
2765                         value = chip->get(chip, i);
2766                         if (value < 0)
2767                                 return value;
2768                         __assign_bit(i, bits, value);
2769                 }
2770                 return 0;
2771         }
2772         return -EIO;
2773 }
2774
2775 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2776                                   unsigned int array_size,
2777                                   struct gpio_desc **desc_array,
2778                                   int *value_array)
2779 {
2780         int i = 0;
2781
2782         while (i < array_size) {
2783                 struct gpio_chip *chip = desc_array[i]->gdev->chip;
2784                 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2785                 unsigned long *mask, *bits;
2786                 int first, j, ret;
2787
2788                 if (likely(chip->ngpio <= FASTPATH_NGPIO)) {
2789                         mask = fastpath;
2790                 } else {
2791                         mask = kmalloc_array(2 * BITS_TO_LONGS(chip->ngpio),
2792                                            sizeof(*mask),
2793                                            can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2794                         if (!mask)
2795                                 return -ENOMEM;
2796                 }
2797
2798                 bits = mask + BITS_TO_LONGS(chip->ngpio);
2799                 bitmap_zero(mask, chip->ngpio);
2800
2801                 if (!can_sleep)
2802                         WARN_ON(chip->can_sleep);
2803
2804                 /* collect all inputs belonging to the same chip */
2805                 first = i;
2806                 do {
2807                         const struct gpio_desc *desc = desc_array[i];
2808                         int hwgpio = gpio_chip_hwgpio(desc);
2809
2810                         __set_bit(hwgpio, mask);
2811                         i++;
2812                 } while ((i < array_size) &&
2813                          (desc_array[i]->gdev->chip == chip));
2814
2815                 ret = gpio_chip_get_multiple(chip, mask, bits);
2816                 if (ret) {
2817                         if (mask != fastpath)
2818                                 kfree(mask);
2819                         return ret;
2820                 }
2821
2822                 for (j = first; j < i; j++) {
2823                         const struct gpio_desc *desc = desc_array[j];
2824                         int hwgpio = gpio_chip_hwgpio(desc);
2825                         int value = test_bit(hwgpio, bits);
2826
2827                         if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2828                                 value = !value;
2829                         value_array[j] = value;
2830                         trace_gpio_value(desc_to_gpio(desc), 1, value);
2831                 }
2832
2833                 if (mask != fastpath)
2834                         kfree(mask);
2835         }
2836         return 0;
2837 }
2838
2839 /**
2840  * gpiod_get_raw_value() - return a gpio's raw value
2841  * @desc: gpio whose value will be returned
2842  *
2843  * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2844  * its ACTIVE_LOW status, or negative errno on failure.
2845  *
2846  * This function should be called from contexts where we cannot sleep, and will
2847  * complain if the GPIO chip functions potentially sleep.
2848  */
2849 int gpiod_get_raw_value(const struct gpio_desc *desc)
2850 {
2851         VALIDATE_DESC(desc);
2852         /* Should be using gpio_get_value_cansleep() */
2853         WARN_ON(desc->gdev->chip->can_sleep);
2854         return gpiod_get_raw_value_commit(desc);
2855 }
2856 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2857
2858 /**
2859  * gpiod_get_value() - return a gpio's value
2860  * @desc: gpio whose value will be returned
2861  *
2862  * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2863  * account, or negative errno on failure.
2864  *
2865  * This function should be called from contexts where we cannot sleep, and will
2866  * complain if the GPIO chip functions potentially sleep.
2867  */
2868 int gpiod_get_value(const struct gpio_desc *desc)
2869 {
2870         int value;
2871
2872         VALIDATE_DESC(desc);
2873         /* Should be using gpio_get_value_cansleep() */
2874         WARN_ON(desc->gdev->chip->can_sleep);
2875
2876         value = gpiod_get_raw_value_commit(desc);
2877         if (value < 0)
2878                 return value;
2879
2880         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2881                 value = !value;
2882
2883         return value;
2884 }
2885 EXPORT_SYMBOL_GPL(gpiod_get_value);
2886
2887 /**
2888  * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2889  * @array_size: number of elements in the descriptor / value arrays
2890  * @desc_array: array of GPIO descriptors whose values will be read
2891  * @value_array: array to store the read values
2892  *
2893  * Read the raw values of the GPIOs, i.e. the values of the physical lines
2894  * without regard for their ACTIVE_LOW status.  Return 0 in case of success,
2895  * else an error code.
2896  *
2897  * This function should be called from contexts where we cannot sleep,
2898  * and it will complain if the GPIO chip functions potentially sleep.
2899  */
2900 int gpiod_get_raw_array_value(unsigned int array_size,
2901                               struct gpio_desc **desc_array, int *value_array)
2902 {
2903         if (!desc_array)
2904                 return -EINVAL;
2905         return gpiod_get_array_value_complex(true, false, array_size,
2906                                              desc_array, value_array);
2907 }
2908 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2909
2910 /**
2911  * gpiod_get_array_value() - read values from an array of GPIOs
2912  * @array_size: number of elements in the descriptor / value arrays
2913  * @desc_array: array of GPIO descriptors whose values will be read
2914  * @value_array: array to store the read values
2915  *
2916  * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2917  * into account.  Return 0 in case of success, else an error code.
2918  *
2919  * This function should be called from contexts where we cannot sleep,
2920  * and it will complain if the GPIO chip functions potentially sleep.
2921  */
2922 int gpiod_get_array_value(unsigned int array_size,
2923                           struct gpio_desc **desc_array, int *value_array)
2924 {
2925         if (!desc_array)
2926                 return -EINVAL;
2927         return gpiod_get_array_value_complex(false, false, array_size,
2928                                              desc_array, value_array);
2929 }
2930 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2931
2932 /*
2933  *  gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2934  * @desc: gpio descriptor whose state need to be set.
2935  * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2936  */
2937 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2938 {
2939         int err = 0;
2940         struct gpio_chip *chip = desc->gdev->chip;
2941         int offset = gpio_chip_hwgpio(desc);
2942
2943         if (value) {
2944                 err = chip->direction_input(chip, offset);
2945                 if (!err)
2946                         clear_bit(FLAG_IS_OUT, &desc->flags);
2947         } else {
2948                 err = chip->direction_output(chip, offset, 0);
2949                 if (!err)
2950                         set_bit(FLAG_IS_OUT, &desc->flags);
2951         }
2952         trace_gpio_direction(desc_to_gpio(desc), value, err);
2953         if (err < 0)
2954                 gpiod_err(desc,
2955                           "%s: Error in set_value for open drain err %d\n",
2956                           __func__, err);
2957 }
2958
2959 /*
2960  *  _gpio_set_open_source_value() - Set the open source gpio's value.
2961  * @desc: gpio descriptor whose state need to be set.
2962  * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2963  */
2964 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2965 {
2966         int err = 0;
2967         struct gpio_chip *chip = desc->gdev->chip;
2968         int offset = gpio_chip_hwgpio(desc);
2969
2970         if (value) {
2971                 err = chip->direction_output(chip, offset, 1);
2972                 if (!err)
2973                         set_bit(FLAG_IS_OUT, &desc->flags);
2974         } else {
2975                 err = chip->direction_input(chip, offset);
2976                 if (!err)
2977                         clear_bit(FLAG_IS_OUT, &desc->flags);
2978         }
2979         trace_gpio_direction(desc_to_gpio(desc), !value, err);
2980         if (err < 0)
2981                 gpiod_err(desc,
2982                           "%s: Error in set_value for open source err %d\n",
2983                           __func__, err);
2984 }
2985
2986 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2987 {
2988         struct gpio_chip        *chip;
2989
2990         chip = desc->gdev->chip;
2991         trace_gpio_value(desc_to_gpio(desc), 0, value);
2992         chip->set(chip, gpio_chip_hwgpio(desc), value);
2993 }
2994
2995 /*
2996  * set multiple outputs on the same chip;
2997  * use the chip's set_multiple function if available;
2998  * otherwise set the outputs sequentially;
2999  * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
3000  *        defines which outputs are to be changed
3001  * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
3002  *        defines the values the outputs specified by mask are to be set to
3003  */
3004 static void gpio_chip_set_multiple(struct gpio_chip *chip,
3005                                    unsigned long *mask, unsigned long *bits)
3006 {
3007         if (chip->set_multiple) {
3008                 chip->set_multiple(chip, mask, bits);
3009         } else {
3010                 unsigned int i;
3011
3012                 /* set outputs if the corresponding mask bit is set */
3013                 for_each_set_bit(i, mask, chip->ngpio)
3014                         chip->set(chip, i, test_bit(i, bits));
3015         }
3016 }
3017
3018 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
3019                                    unsigned int array_size,
3020                                    struct gpio_desc **desc_array,
3021                                    int *value_array)
3022 {
3023         int i = 0;
3024
3025         while (i < array_size) {
3026                 struct gpio_chip *chip = desc_array[i]->gdev->chip;
3027                 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
3028                 unsigned long *mask, *bits;
3029                 int count = 0;
3030
3031                 if (likely(chip->ngpio <= FASTPATH_NGPIO)) {
3032                         mask = fastpath;
3033                 } else {
3034                         mask = kmalloc_array(2 * BITS_TO_LONGS(chip->ngpio),
3035                                            sizeof(*mask),
3036                                            can_sleep ? GFP_KERNEL : GFP_ATOMIC);
3037                         if (!mask)
3038                                 return -ENOMEM;
3039                 }
3040
3041                 bits = mask + BITS_TO_LONGS(chip->ngpio);
3042                 bitmap_zero(mask, chip->ngpio);
3043
3044                 if (!can_sleep)
3045                         WARN_ON(chip->can_sleep);
3046
3047                 do {
3048                         struct gpio_desc *desc = desc_array[i];
3049                         int hwgpio = gpio_chip_hwgpio(desc);
3050                         int value = value_array[i];
3051
3052                         if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3053                                 value = !value;
3054                         trace_gpio_value(desc_to_gpio(desc), 0, value);
3055                         /*
3056                          * collect all normal outputs belonging to the same chip
3057                          * open drain and open source outputs are set individually
3058                          */
3059                         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
3060                                 gpio_set_open_drain_value_commit(desc, value);
3061                         } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
3062                                 gpio_set_open_source_value_commit(desc, value);
3063                         } else {
3064                                 __set_bit(hwgpio, mask);
3065                                 if (value)
3066                                         __set_bit(hwgpio, bits);
3067                                 else
3068                                         __clear_bit(hwgpio, bits);
3069                                 count++;
3070                         }
3071                         i++;
3072                 } while ((i < array_size) &&
3073                          (desc_array[i]->gdev->chip == chip));
3074                 /* push collected bits to outputs */
3075                 if (count != 0)
3076                         gpio_chip_set_multiple(chip, mask, bits);
3077
3078                 if (mask != fastpath)
3079                         kfree(mask);
3080         }
3081         return 0;
3082 }
3083
3084 /**
3085  * gpiod_set_raw_value() - assign a gpio's raw value
3086  * @desc: gpio whose value will be assigned
3087  * @value: value to assign
3088  *
3089  * Set the raw value of the GPIO, i.e. the value of its physical line without
3090  * regard for its ACTIVE_LOW status.
3091  *
3092  * This function should be called from contexts where we cannot sleep, and will
3093  * complain if the GPIO chip functions potentially sleep.
3094  */
3095 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
3096 {
3097         VALIDATE_DESC_VOID(desc);
3098         /* Should be using gpiod_set_value_cansleep() */
3099         WARN_ON(desc->gdev->chip->can_sleep);
3100         gpiod_set_raw_value_commit(desc, value);
3101 }
3102 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
3103
3104 /**
3105  * gpiod_set_value_nocheck() - set a GPIO line value without checking
3106  * @desc: the descriptor to set the value on
3107  * @value: value to set
3108  *
3109  * This sets the value of a GPIO line backing a descriptor, applying
3110  * different semantic quirks like active low and open drain/source
3111  * handling.
3112  */
3113 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
3114 {
3115         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3116                 value = !value;
3117         if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
3118                 gpio_set_open_drain_value_commit(desc, value);
3119         else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
3120                 gpio_set_open_source_value_commit(desc, value);
3121         else
3122                 gpiod_set_raw_value_commit(desc, value);
3123 }
3124
3125 /**
3126  * gpiod_set_value() - assign a gpio's value
3127  * @desc: gpio whose value will be assigned
3128  * @value: value to assign
3129  *
3130  * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
3131  * OPEN_DRAIN and OPEN_SOURCE flags into account.
3132  *
3133  * This function should be called from contexts where we cannot sleep, and will
3134  * complain if the GPIO chip functions potentially sleep.
3135  */
3136 void gpiod_set_value(struct gpio_desc *desc, int value)
3137 {
3138         VALIDATE_DESC_VOID(desc);
3139         WARN_ON(desc->gdev->chip->can_sleep);
3140         gpiod_set_value_nocheck(desc, value);
3141 }
3142 EXPORT_SYMBOL_GPL(gpiod_set_value);
3143
3144 /**
3145  * gpiod_set_raw_array_value() - assign values to an array of GPIOs
3146  * @array_size: number of elements in the descriptor / value arrays
3147  * @desc_array: array of GPIO descriptors whose values will be assigned
3148  * @value_array: array of values to assign
3149  *
3150  * Set the raw values of the GPIOs, i.e. the values of the physical lines
3151  * without regard for their ACTIVE_LOW status.
3152  *
3153  * This function should be called from contexts where we cannot sleep, and will
3154  * complain if the GPIO chip functions potentially sleep.
3155  */
3156 int gpiod_set_raw_array_value(unsigned int array_size,
3157                          struct gpio_desc **desc_array, int *value_array)
3158 {
3159         if (!desc_array)
3160                 return -EINVAL;
3161         return gpiod_set_array_value_complex(true, false, array_size,
3162                                         desc_array, value_array);
3163 }
3164 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
3165
3166 /**
3167  * gpiod_set_array_value() - assign values to an array of GPIOs
3168  * @array_size: number of elements in the descriptor / value arrays
3169  * @desc_array: array of GPIO descriptors whose values will be assigned
3170  * @value_array: array of values to assign
3171  *
3172  * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3173  * into account.
3174  *
3175  * This function should be called from contexts where we cannot sleep, and will
3176  * complain if the GPIO chip functions potentially sleep.
3177  */
3178 void gpiod_set_array_value(unsigned int array_size,
3179                            struct gpio_desc **desc_array, int *value_array)
3180 {
3181         if (!desc_array)
3182                 return;
3183         gpiod_set_array_value_complex(false, false, array_size, desc_array,
3184                                       value_array);
3185 }
3186 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3187
3188 /**
3189  * gpiod_cansleep() - report whether gpio value access may sleep
3190  * @desc: gpio to check
3191  *
3192  */
3193 int gpiod_cansleep(const struct gpio_desc *desc)
3194 {
3195         VALIDATE_DESC(desc);
3196         return desc->gdev->chip->can_sleep;
3197 }
3198 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3199
3200 /**
3201  * gpiod_set_consumer_name() - set the consumer name for the descriptor
3202  * @desc: gpio to set the consumer name on
3203  * @name: the new consumer name
3204  */
3205 void gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3206 {
3207         VALIDATE_DESC_VOID(desc);
3208         /* Just overwrite whatever the previous name was */
3209         desc->label = name;
3210 }
3211 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3212
3213 /**
3214  * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3215  * @desc: gpio whose IRQ will be returned (already requested)
3216  *
3217  * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3218  * error.
3219  */
3220 int gpiod_to_irq(const struct gpio_desc *desc)
3221 {
3222         struct gpio_chip *chip;
3223         int offset;
3224
3225         /*
3226          * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3227          * requires this function to not return zero on an invalid descriptor
3228          * but rather a negative error number.
3229          */
3230         if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3231                 return -EINVAL;
3232
3233         chip = desc->gdev->chip;
3234         offset = gpio_chip_hwgpio(desc);
3235         if (chip->to_irq) {
3236                 int retirq = chip->to_irq(chip, offset);
3237
3238                 /* Zero means NO_IRQ */
3239                 if (!retirq)
3240                         return -ENXIO;
3241
3242                 return retirq;
3243         }
3244         return -ENXIO;
3245 }
3246 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3247
3248 /**
3249  * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3250  * @chip: the chip the GPIO to lock belongs to
3251  * @offset: the offset of the GPIO to lock as IRQ
3252  *
3253  * This is used directly by GPIO drivers that want to lock down
3254  * a certain GPIO line to be used for IRQs.
3255  */
3256 int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
3257 {
3258         struct gpio_desc *desc;
3259
3260         desc = gpiochip_get_desc(chip, offset);
3261         if (IS_ERR(desc))
3262                 return PTR_ERR(desc);
3263
3264         /*
3265          * If it's fast: flush the direction setting if something changed
3266          * behind our back
3267          */
3268         if (!chip->can_sleep && chip->get_direction) {
3269                 int dir = gpiod_get_direction(desc);
3270
3271                 if (dir < 0) {
3272                         chip_err(chip, "%s: cannot get GPIO direction\n",
3273                                  __func__);
3274                         return dir;
3275                 }
3276         }
3277
3278         if (test_bit(FLAG_IS_OUT, &desc->flags)) {
3279                 chip_err(chip,
3280                          "%s: tried to flag a GPIO set as output for IRQ\n",
3281                          __func__);
3282                 return -EIO;
3283         }
3284
3285         set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3286
3287         /*
3288          * If the consumer has not set up a label (such as when the
3289          * IRQ is referenced from .to_irq()) we set up a label here
3290          * so it is clear this is used as an interrupt.
3291          */
3292         if (!desc->label)
3293                 desc_set_label(desc, "interrupt");
3294
3295         return 0;
3296 }
3297 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3298
3299 /**
3300  * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3301  * @chip: the chip the GPIO to lock belongs to
3302  * @offset: the offset of the GPIO to lock as IRQ
3303  *
3304  * This is used directly by GPIO drivers that want to indicate
3305  * that a certain GPIO is no longer used exclusively for IRQ.
3306  */
3307 void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
3308 {
3309         struct gpio_desc *desc;
3310
3311         desc = gpiochip_get_desc(chip, offset);
3312         if (IS_ERR(desc))
3313                 return;
3314
3315         clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3316
3317         /* If we only had this marking, erase it */
3318         if (desc->label && !strcmp(desc->label, "interrupt"))
3319                 desc_set_label(desc, NULL);
3320 }
3321 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3322
3323 bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset)
3324 {
3325         if (offset >= chip->ngpio)
3326                 return false;
3327
3328         return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
3329 }
3330 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3331
3332 bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset)
3333 {
3334         if (offset >= chip->ngpio)
3335                 return false;
3336
3337         return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags);
3338 }
3339 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3340
3341 bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset)
3342 {
3343         if (offset >= chip->ngpio)
3344                 return false;
3345
3346         return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags);
3347 }
3348 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3349
3350 bool gpiochip_line_is_persistent(struct gpio_chip *chip, unsigned int offset)
3351 {
3352         if (offset >= chip->ngpio)
3353                 return false;
3354
3355         return !test_bit(FLAG_TRANSITORY, &chip->gpiodev->descs[offset].flags);
3356 }
3357 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3358
3359 /**
3360  * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3361  * @desc: gpio whose value will be returned
3362  *
3363  * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3364  * its ACTIVE_LOW status, or negative errno on failure.
3365  *
3366  * This function is to be called from contexts that can sleep.
3367  */
3368 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3369 {
3370         might_sleep_if(extra_checks);
3371         VALIDATE_DESC(desc);
3372         return gpiod_get_raw_value_commit(desc);
3373 }
3374 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3375
3376 /**
3377  * gpiod_get_value_cansleep() - return a gpio's value
3378  * @desc: gpio whose value will be returned
3379  *
3380  * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3381  * account, or negative errno on failure.
3382  *
3383  * This function is to be called from contexts that can sleep.
3384  */
3385 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3386 {
3387         int value;
3388
3389         might_sleep_if(extra_checks);
3390         VALIDATE_DESC(desc);
3391         value = gpiod_get_raw_value_commit(desc);
3392         if (value < 0)
3393                 return value;
3394
3395         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3396                 value = !value;
3397
3398         return value;
3399 }
3400 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3401
3402 /**
3403  * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3404  * @array_size: number of elements in the descriptor / value arrays
3405  * @desc_array: array of GPIO descriptors whose values will be read
3406  * @value_array: array to store the read values
3407  *
3408  * Read the raw values of the GPIOs, i.e. the values of the physical lines
3409  * without regard for their ACTIVE_LOW status.  Return 0 in case of success,
3410  * else an error code.
3411  *
3412  * This function is to be called from contexts that can sleep.
3413  */
3414 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3415                                        struct gpio_desc **desc_array,
3416                                        int *value_array)
3417 {
3418         might_sleep_if(extra_checks);
3419         if (!desc_array)
3420                 return -EINVAL;
3421         return gpiod_get_array_value_complex(true, true, array_size,
3422                                              desc_array, value_array);
3423 }
3424 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3425
3426 /**
3427  * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3428  * @array_size: number of elements in the descriptor / value arrays
3429  * @desc_array: array of GPIO descriptors whose values will be read
3430  * @value_array: array to store the read values
3431  *
3432  * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3433  * into account.  Return 0 in case of success, else an error code.
3434  *
3435  * This function is to be called from contexts that can sleep.
3436  */
3437 int gpiod_get_array_value_cansleep(unsigned int array_size,
3438                                    struct gpio_desc **desc_array,
3439                                    int *value_array)
3440 {
3441         might_sleep_if(extra_checks);
3442         if (!desc_array)
3443                 return -EINVAL;
3444         return gpiod_get_array_value_complex(false, true, array_size,
3445                                              desc_array, value_array);
3446 }
3447 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3448
3449 /**
3450  * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3451  * @desc: gpio whose value will be assigned
3452  * @value: value to assign
3453  *
3454  * Set the raw value of the GPIO, i.e. the value of its physical line without
3455  * regard for its ACTIVE_LOW status.
3456  *
3457  * This function is to be called from contexts that can sleep.
3458  */
3459 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3460 {
3461         might_sleep_if(extra_checks);
3462         VALIDATE_DESC_VOID(desc);
3463         gpiod_set_raw_value_commit(desc, value);
3464 }
3465 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3466
3467 /**
3468  * gpiod_set_value_cansleep() - assign a gpio's value
3469  * @desc: gpio whose value will be assigned
3470  * @value: value to assign
3471  *
3472  * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3473  * account
3474  *
3475  * This function is to be called from contexts that can sleep.
3476  */
3477 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3478 {
3479         might_sleep_if(extra_checks);
3480         VALIDATE_DESC_VOID(desc);
3481         gpiod_set_value_nocheck(desc, value);
3482 }
3483 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3484
3485 /**
3486  * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3487  * @array_size: number of elements in the descriptor / value arrays
3488  * @desc_array: array of GPIO descriptors whose values will be assigned
3489  * @value_array: array of values to assign
3490  *
3491  * Set the raw values of the GPIOs, i.e. the values of the physical lines
3492  * without regard for their ACTIVE_LOW status.
3493  *
3494  * This function is to be called from contexts that can sleep.
3495  */
3496 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3497                                         struct gpio_desc **desc_array,
3498                                         int *value_array)
3499 {
3500         might_sleep_if(extra_checks);
3501         if (!desc_array)
3502                 return -EINVAL;
3503         return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3504                                       value_array);
3505 }
3506 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3507
3508 /**
3509  * gpiod_add_lookup_tables() - register GPIO device consumers
3510  * @tables: list of tables of consumers to register
3511  * @n: number of tables in the list
3512  */
3513 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3514 {
3515         unsigned int i;
3516
3517         mutex_lock(&gpio_lookup_lock);
3518
3519         for (i = 0; i < n; i++)
3520                 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3521
3522         mutex_unlock(&gpio_lookup_lock);
3523 }
3524
3525 /**
3526  * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3527  * @array_size: number of elements in the descriptor / value arrays
3528  * @desc_array: array of GPIO descriptors whose values will be assigned
3529  * @value_array: array of values to assign
3530  *
3531  * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3532  * into account.
3533  *
3534  * This function is to be called from contexts that can sleep.
3535  */
3536 void gpiod_set_array_value_cansleep(unsigned int array_size,
3537                                     struct gpio_desc **desc_array,
3538                                     int *value_array)
3539 {
3540         might_sleep_if(extra_checks);
3541         if (!desc_array)
3542                 return;
3543         gpiod_set_array_value_complex(false, true, array_size, desc_array,
3544                                       value_array);
3545 }
3546 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3547
3548 /**
3549  * gpiod_add_lookup_table() - register GPIO device consumers
3550  * @table: table of consumers to register
3551  */
3552 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3553 {
3554         mutex_lock(&gpio_lookup_lock);
3555
3556         list_add_tail(&table->list, &gpio_lookup_list);
3557
3558         mutex_unlock(&gpio_lookup_lock);
3559 }
3560 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3561
3562 /**
3563  * gpiod_remove_lookup_table() - unregister GPIO device consumers
3564  * @table: table of consumers to unregister
3565  */
3566 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3567 {
3568         mutex_lock(&gpio_lookup_lock);
3569
3570         list_del(&table->list);
3571
3572         mutex_unlock(&gpio_lookup_lock);
3573 }
3574 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3575
3576 /**
3577  * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3578  * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3579  */
3580 void gpiod_add_hogs(struct gpiod_hog *hogs)
3581 {
3582         struct gpio_chip *chip;
3583         struct gpiod_hog *hog;
3584
3585         mutex_lock(&gpio_machine_hogs_mutex);
3586
3587         for (hog = &hogs[0]; hog->chip_label; hog++) {
3588                 list_add_tail(&hog->list, &gpio_machine_hogs);
3589
3590                 /*
3591                  * The chip may have been registered earlier, so check if it
3592                  * exists and, if so, try to hog the line now.
3593                  */
3594                 chip = find_chip_by_name(hog->chip_label);
3595                 if (chip)
3596                         gpiochip_machine_hog(chip, hog);
3597         }
3598
3599         mutex_unlock(&gpio_machine_hogs_mutex);
3600 }
3601 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3602
3603 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3604 {
3605         const char *dev_id = dev ? dev_name(dev) : NULL;
3606         struct gpiod_lookup_table *table;
3607
3608         mutex_lock(&gpio_lookup_lock);
3609
3610         list_for_each_entry(table, &gpio_lookup_list, list) {
3611                 if (table->dev_id && dev_id) {
3612                         /*
3613                          * Valid strings on both ends, must be identical to have
3614                          * a match
3615                          */
3616                         if (!strcmp(table->dev_id, dev_id))
3617                                 goto found;
3618                 } else {
3619                         /*
3620                          * One of the pointers is NULL, so both must be to have
3621                          * a match
3622                          */
3623                         if (dev_id == table->dev_id)
3624                                 goto found;
3625                 }
3626         }
3627         table = NULL;
3628
3629 found:
3630         mutex_unlock(&gpio_lookup_lock);
3631         return table;
3632 }
3633
3634 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3635                                     unsigned int idx,
3636                                     enum gpio_lookup_flags *flags)
3637 {
3638         struct gpio_desc *desc = ERR_PTR(-ENOENT);
3639         struct gpiod_lookup_table *table;
3640         struct gpiod_lookup *p;
3641
3642         table = gpiod_find_lookup_table(dev);
3643         if (!table)
3644                 return desc;
3645
3646         for (p = &table->table[0]; p->chip_label; p++) {
3647                 struct gpio_chip *chip;
3648
3649                 /* idx must always match exactly */
3650                 if (p->idx != idx)
3651                         continue;
3652
3653                 /* If the lookup entry has a con_id, require exact match */
3654                 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3655                         continue;
3656
3657                 chip = find_chip_by_name(p->chip_label);
3658
3659                 if (!chip) {
3660                         /*
3661                          * As the lookup table indicates a chip with
3662                          * p->chip_label should exist, assume it may
3663                          * still appear later and let the interested
3664                          * consumer be probed again or let the Deferred
3665                          * Probe infrastructure handle the error.
3666                          */
3667                         dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3668                                  p->chip_label);
3669                         return ERR_PTR(-EPROBE_DEFER);
3670                 }
3671
3672                 if (chip->ngpio <= p->chip_hwnum) {
3673                         dev_err(dev,
3674                                 "requested GPIO %d is out of range [0..%d] for chip %s\n",
3675                                 idx, chip->ngpio, chip->label);
3676                         return ERR_PTR(-EINVAL);
3677                 }
3678
3679                 desc = gpiochip_get_desc(chip, p->chip_hwnum);
3680                 *flags = p->flags;
3681
3682                 return desc;
3683         }
3684
3685         return desc;
3686 }
3687
3688 static int dt_gpio_count(struct device *dev, const char *con_id)
3689 {
3690         int ret;
3691         char propname[32];
3692         unsigned int i;
3693
3694         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3695                 if (con_id)
3696                         snprintf(propname, sizeof(propname), "%s-%s",
3697                                  con_id, gpio_suffixes[i]);
3698                 else
3699                         snprintf(propname, sizeof(propname), "%s",
3700                                  gpio_suffixes[i]);
3701
3702                 ret = of_gpio_named_count(dev->of_node, propname);
3703                 if (ret > 0)
3704                         break;
3705         }
3706         return ret ? ret : -ENOENT;
3707 }
3708
3709 static int platform_gpio_count(struct device *dev, const char *con_id)
3710 {
3711         struct gpiod_lookup_table *table;
3712         struct gpiod_lookup *p;
3713         unsigned int count = 0;
3714
3715         table = gpiod_find_lookup_table(dev);
3716         if (!table)
3717                 return -ENOENT;
3718
3719         for (p = &table->table[0]; p->chip_label; p++) {
3720                 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3721                     (!con_id && !p->con_id))
3722                         count++;
3723         }
3724         if (!count)
3725                 return -ENOENT;
3726
3727         return count;
3728 }
3729
3730 /**
3731  * gpiod_count - return the number of GPIOs associated with a device / function
3732  *              or -ENOENT if no GPIO has been assigned to the requested function
3733  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3734  * @con_id:     function within the GPIO consumer
3735  */
3736 int gpiod_count(struct device *dev, const char *con_id)
3737 {
3738         int count = -ENOENT;
3739
3740         if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
3741                 count = dt_gpio_count(dev, con_id);
3742         else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
3743                 count = acpi_gpio_count(dev, con_id);
3744
3745         if (count < 0)
3746                 count = platform_gpio_count(dev, con_id);
3747
3748         return count;
3749 }
3750 EXPORT_SYMBOL_GPL(gpiod_count);
3751
3752 /**
3753  * gpiod_get - obtain a GPIO for a given GPIO function
3754  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3755  * @con_id:     function within the GPIO consumer
3756  * @flags:      optional GPIO initialization flags
3757  *
3758  * Return the GPIO descriptor corresponding to the function con_id of device
3759  * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3760  * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3761  */
3762 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3763                                          enum gpiod_flags flags)
3764 {
3765         return gpiod_get_index(dev, con_id, 0, flags);
3766 }
3767 EXPORT_SYMBOL_GPL(gpiod_get);
3768
3769 /**
3770  * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3771  * @dev: GPIO consumer, can be NULL for system-global GPIOs
3772  * @con_id: function within the GPIO consumer
3773  * @flags: optional GPIO initialization flags
3774  *
3775  * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3776  * the requested function it will return NULL. This is convenient for drivers
3777  * that need to handle optional GPIOs.
3778  */
3779 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3780                                                   const char *con_id,
3781                                                   enum gpiod_flags flags)
3782 {
3783         return gpiod_get_index_optional(dev, con_id, 0, flags);
3784 }
3785 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3786
3787
3788 /**
3789  * gpiod_configure_flags - helper function to configure a given GPIO
3790  * @desc:       gpio whose value will be assigned
3791  * @con_id:     function within the GPIO consumer
3792  * @lflags:     gpio_lookup_flags - returned from of_find_gpio() or
3793  *              of_get_gpio_hog()
3794  * @dflags:     gpiod_flags - optional GPIO initialization flags
3795  *
3796  * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3797  * requested function and/or index, or another IS_ERR() code if an error
3798  * occurred while trying to acquire the GPIO.
3799  */
3800 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3801                 unsigned long lflags, enum gpiod_flags dflags)
3802 {
3803         int status;
3804
3805         if (lflags & GPIO_ACTIVE_LOW)
3806                 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3807
3808         if (lflags & GPIO_OPEN_DRAIN)
3809                 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3810         else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
3811                 /*
3812                  * This enforces open drain mode from the consumer side.
3813                  * This is necessary for some busses like I2C, but the lookup
3814                  * should *REALLY* have specified them as open drain in the
3815                  * first place, so print a little warning here.
3816                  */
3817                 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3818                 gpiod_warn(desc,
3819                            "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
3820         }
3821
3822         if (lflags & GPIO_OPEN_SOURCE)
3823                 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3824
3825         status = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
3826         if (status < 0)
3827                 return status;
3828
3829         /* No particular flag request, return here... */
3830         if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3831                 pr_debug("no flags found for %s\n", con_id);
3832                 return 0;
3833         }
3834
3835         /* Process flags */
3836         if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3837                 status = gpiod_direction_output(desc,
3838                                 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3839         else
3840                 status = gpiod_direction_input(desc);
3841
3842         return status;
3843 }
3844
3845 /**
3846  * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3847  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
3848  * @con_id:     function within the GPIO consumer
3849  * @idx:        index of the GPIO to obtain in the consumer
3850  * @flags:      optional GPIO initialization flags
3851  *
3852  * This variant of gpiod_get() allows to access GPIOs other than the first
3853  * defined one for functions that define several GPIOs.
3854  *
3855  * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3856  * requested function and/or index, or another IS_ERR() code if an error
3857  * occurred while trying to acquire the GPIO.
3858  */
3859 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3860                                                const char *con_id,
3861                                                unsigned int idx,
3862                                                enum gpiod_flags flags)
3863 {
3864         struct gpio_desc *desc = NULL;
3865         int status;
3866         enum gpio_lookup_flags lookupflags = 0;
3867         /* Maybe we have a device name, maybe not */
3868         const char *devname = dev ? dev_name(dev) : "?";
3869
3870         dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3871
3872         if (dev) {
3873                 /* Using device tree? */
3874                 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
3875                         dev_dbg(dev, "using device tree for GPIO lookup\n");
3876                         desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3877                 } else if (ACPI_COMPANION(dev)) {
3878                         dev_dbg(dev, "using ACPI for GPIO lookup\n");
3879                         desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
3880                 }
3881         }
3882
3883         /*
3884          * Either we are not using DT or ACPI, or their lookup did not return
3885          * a result. In that case, use platform lookup as a fallback.
3886          */
3887         if (!desc || desc == ERR_PTR(-ENOENT)) {
3888                 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3889                 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3890         }
3891
3892         if (IS_ERR(desc)) {
3893                 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
3894                 return desc;
3895         }
3896
3897         /*
3898          * If a connection label was passed use that, else attempt to use
3899          * the device name as label
3900          */
3901         status = gpiod_request(desc, con_id ? con_id : devname);
3902         if (status < 0)
3903                 return ERR_PTR(status);
3904
3905         status = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3906         if (status < 0) {
3907                 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3908                 gpiod_put(desc);
3909                 return ERR_PTR(status);
3910         }
3911
3912         return desc;
3913 }
3914 EXPORT_SYMBOL_GPL(gpiod_get_index);
3915
3916 /**
3917  * gpiod_get_from_of_node() - obtain a GPIO from an OF node
3918  * @node:       handle of the OF node
3919  * @propname:   name of the DT property representing the GPIO
3920  * @index:      index of the GPIO to obtain for the consumer
3921  * @dflags:     GPIO initialization flags
3922  * @label:      label to attach to the requested GPIO
3923  *
3924  * Returns:
3925  * On successful request the GPIO pin is configured in accordance with
3926  * provided @dflags. If the node does not have the requested GPIO
3927  * property, NULL is returned.
3928  *
3929  * In case of error an ERR_PTR() is returned.
3930  */
3931 struct gpio_desc *gpiod_get_from_of_node(struct device_node *node,
3932                                          const char *propname, int index,
3933                                          enum gpiod_flags dflags,
3934                                          const char *label)
3935 {
3936         struct gpio_desc *desc;
3937         unsigned long lflags = 0;
3938         enum of_gpio_flags flags;
3939         bool active_low = false;
3940         bool single_ended = false;
3941         bool open_drain = false;
3942         bool transitory = false;
3943         int ret;
3944
3945         desc = of_get_named_gpiod_flags(node, propname,
3946                                         index, &flags);
3947
3948         if (!desc || IS_ERR(desc)) {
3949                 /* If it is not there, just return NULL */
3950                 if (PTR_ERR(desc) == -ENOENT)
3951                         return NULL;
3952                 return desc;
3953         }
3954
3955         active_low = flags & OF_GPIO_ACTIVE_LOW;
3956         single_ended = flags & OF_GPIO_SINGLE_ENDED;
3957         open_drain = flags & OF_GPIO_OPEN_DRAIN;
3958         transitory = flags & OF_GPIO_TRANSITORY;
3959
3960         ret = gpiod_request(desc, label);
3961         if (ret)
3962                 return ERR_PTR(ret);
3963
3964         if (active_low)
3965                 lflags |= GPIO_ACTIVE_LOW;
3966
3967         if (single_ended) {
3968                 if (open_drain)
3969                         lflags |= GPIO_OPEN_DRAIN;
3970                 else
3971                         lflags |= GPIO_OPEN_SOURCE;
3972         }
3973
3974         if (transitory)
3975                 lflags |= GPIO_TRANSITORY;
3976
3977         ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3978         if (ret < 0) {
3979                 gpiod_put(desc);
3980                 return ERR_PTR(ret);
3981         }
3982
3983         return desc;
3984 }
3985 EXPORT_SYMBOL(gpiod_get_from_of_node);
3986
3987 /**
3988  * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3989  * @fwnode:     handle of the firmware node
3990  * @propname:   name of the firmware property representing the GPIO
3991  * @index:      index of the GPIO to obtain for the consumer
3992  * @dflags:     GPIO initialization flags
3993  * @label:      label to attach to the requested GPIO
3994  *
3995  * This function can be used for drivers that get their configuration
3996  * from opaque firmware.
3997  *
3998  * The function properly finds the corresponding GPIO using whatever is the
3999  * underlying firmware interface and then makes sure that the GPIO
4000  * descriptor is requested before it is returned to the caller.
4001  *
4002  * Returns:
4003  * On successful request the GPIO pin is configured in accordance with
4004  * provided @dflags.
4005  *
4006  * In case of error an ERR_PTR() is returned.
4007  */
4008 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
4009                                          const char *propname, int index,
4010                                          enum gpiod_flags dflags,
4011                                          const char *label)
4012 {
4013         struct gpio_desc *desc = ERR_PTR(-ENODEV);
4014         unsigned long lflags = 0;
4015         int ret;
4016
4017         if (!fwnode)
4018                 return ERR_PTR(-EINVAL);
4019
4020         if (is_of_node(fwnode)) {
4021                 desc = gpiod_get_from_of_node(to_of_node(fwnode),
4022                                               propname, index,
4023                                               dflags,
4024                                               label);
4025                 return desc;
4026         } else if (is_acpi_node(fwnode)) {
4027                 struct acpi_gpio_info info;
4028
4029                 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
4030                 if (IS_ERR(desc))
4031                         return desc;
4032
4033                 acpi_gpio_update_gpiod_flags(&dflags, &info);
4034
4035                 if (info.polarity == GPIO_ACTIVE_LOW)
4036                         lflags |= GPIO_ACTIVE_LOW;
4037         }
4038
4039         /* Currently only ACPI takes this path */
4040         ret = gpiod_request(desc, label);
4041         if (ret)
4042                 return ERR_PTR(ret);
4043
4044         ret = gpiod_configure_flags(desc, propname, lflags, dflags);
4045         if (ret < 0) {
4046                 gpiod_put(desc);
4047                 return ERR_PTR(ret);
4048         }
4049
4050         return desc;
4051 }
4052 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
4053
4054 /**
4055  * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
4056  *                            function
4057  * @dev: GPIO consumer, can be NULL for system-global GPIOs
4058  * @con_id: function within the GPIO consumer
4059  * @index: index of the GPIO to obtain in the consumer
4060  * @flags: optional GPIO initialization flags
4061  *
4062  * This is equivalent to gpiod_get_index(), except that when no GPIO with the
4063  * specified index was assigned to the requested function it will return NULL.
4064  * This is convenient for drivers that need to handle optional GPIOs.
4065  */
4066 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
4067                                                         const char *con_id,
4068                                                         unsigned int index,
4069                                                         enum gpiod_flags flags)
4070 {
4071         struct gpio_desc *desc;
4072
4073         desc = gpiod_get_index(dev, con_id, index, flags);
4074         if (IS_ERR(desc)) {
4075                 if (PTR_ERR(desc) == -ENOENT)
4076                         return NULL;
4077         }
4078
4079         return desc;
4080 }
4081 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
4082
4083 /**
4084  * gpiod_hog - Hog the specified GPIO desc given the provided flags
4085  * @desc:       gpio whose value will be assigned
4086  * @name:       gpio line name
4087  * @lflags:     gpio_lookup_flags - returned from of_find_gpio() or
4088  *              of_get_gpio_hog()
4089  * @dflags:     gpiod_flags - optional GPIO initialization flags
4090  */
4091 int gpiod_hog(struct gpio_desc *desc, const char *name,
4092               unsigned long lflags, enum gpiod_flags dflags)
4093 {
4094         struct gpio_chip *chip;
4095         struct gpio_desc *local_desc;
4096         int hwnum;
4097         int status;
4098
4099         chip = gpiod_to_chip(desc);
4100         hwnum = gpio_chip_hwgpio(desc);
4101
4102         local_desc = gpiochip_request_own_desc(chip, hwnum, name);
4103         if (IS_ERR(local_desc)) {
4104                 status = PTR_ERR(local_desc);
4105                 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4106                        name, chip->label, hwnum, status);
4107                 return status;
4108         }
4109
4110         status = gpiod_configure_flags(desc, name, lflags, dflags);
4111         if (status < 0) {
4112                 pr_err("setup of hog GPIO %s (chip %s, offset %d) failed, %d\n",
4113                        name, chip->label, hwnum, status);
4114                 gpiochip_free_own_desc(desc);
4115                 return status;
4116         }
4117
4118         /* Mark GPIO as hogged so it can be identified and removed later */
4119         set_bit(FLAG_IS_HOGGED, &desc->flags);
4120
4121         pr_info("GPIO line %d (%s) hogged as %s%s\n",
4122                 desc_to_gpio(desc), name,
4123                 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4124                 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
4125                   (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");
4126
4127         return 0;
4128 }
4129
4130 /**
4131  * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4132  * @chip:       gpio chip to act on
4133  *
4134  * This is only used by of_gpiochip_remove to free hogged gpios
4135  */
4136 static void gpiochip_free_hogs(struct gpio_chip *chip)
4137 {
4138         int id;
4139
4140         for (id = 0; id < chip->ngpio; id++) {
4141                 if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
4142                         gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
4143         }
4144 }
4145
4146 /**
4147  * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4148  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
4149  * @con_id:     function within the GPIO consumer
4150  * @flags:      optional GPIO initialization flags
4151  *
4152  * This function acquires all the GPIOs defined under a given function.
4153  *
4154  * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4155  * no GPIO has been assigned to the requested function, or another IS_ERR()
4156  * code if an error occurred while trying to acquire the GPIOs.
4157  */
4158 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4159                                                 const char *con_id,
4160                                                 enum gpiod_flags flags)
4161 {
4162         struct gpio_desc *desc;
4163         struct gpio_descs *descs;
4164         int count;
4165
4166         count = gpiod_count(dev, con_id);
4167         if (count < 0)
4168                 return ERR_PTR(count);
4169
4170         descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4171         if (!descs)
4172                 return ERR_PTR(-ENOMEM);
4173
4174         for (descs->ndescs = 0; descs->ndescs < count; ) {
4175                 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4176                 if (IS_ERR(desc)) {
4177                         gpiod_put_array(descs);
4178                         return ERR_CAST(desc);
4179                 }
4180                 descs->desc[descs->ndescs] = desc;
4181                 descs->ndescs++;
4182         }
4183         return descs;
4184 }
4185 EXPORT_SYMBOL_GPL(gpiod_get_array);
4186
4187 /**
4188  * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4189  *                            function
4190  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
4191  * @con_id:     function within the GPIO consumer
4192  * @flags:      optional GPIO initialization flags
4193  *
4194  * This is equivalent to gpiod_get_array(), except that when no GPIO was
4195  * assigned to the requested function it will return NULL.
4196  */
4197 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4198                                                         const char *con_id,
4199                                                         enum gpiod_flags flags)
4200 {
4201         struct gpio_descs *descs;
4202
4203         descs = gpiod_get_array(dev, con_id, flags);
4204         if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
4205                 return NULL;
4206
4207         return descs;
4208 }
4209 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4210
4211 /**
4212  * gpiod_put - dispose of a GPIO descriptor
4213  * @desc:       GPIO descriptor to dispose of
4214  *
4215  * No descriptor can be used after gpiod_put() has been called on it.
4216  */
4217 void gpiod_put(struct gpio_desc *desc)
4218 {
4219         gpiod_free(desc);
4220 }
4221 EXPORT_SYMBOL_GPL(gpiod_put);
4222
4223 /**
4224  * gpiod_put_array - dispose of multiple GPIO descriptors
4225  * @descs:      struct gpio_descs containing an array of descriptors
4226  */
4227 void gpiod_put_array(struct gpio_descs *descs)
4228 {
4229         unsigned int i;
4230
4231         for (i = 0; i < descs->ndescs; i++)
4232                 gpiod_put(descs->desc[i]);
4233
4234         kfree(descs);
4235 }
4236 EXPORT_SYMBOL_GPL(gpiod_put_array);
4237
4238 static int __init gpiolib_dev_init(void)
4239 {
4240         int ret;
4241
4242         /* Register GPIO sysfs bus */
4243         ret = bus_register(&gpio_bus_type);
4244         if (ret < 0) {
4245                 pr_err("gpiolib: could not register GPIO bus type\n");
4246                 return ret;
4247         }
4248
4249         ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
4250         if (ret < 0) {
4251                 pr_err("gpiolib: failed to allocate char dev region\n");
4252                 bus_unregister(&gpio_bus_type);
4253         } else {
4254                 gpiolib_initialized = true;
4255                 gpiochip_setup_devs();
4256         }
4257         return ret;
4258 }
4259 core_initcall(gpiolib_dev_init);
4260
4261 #ifdef CONFIG_DEBUG_FS
4262
4263 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4264 {
4265         unsigned                i;
4266         struct gpio_chip        *chip = gdev->chip;
4267         unsigned                gpio = gdev->base;
4268         struct gpio_desc        *gdesc = &gdev->descs[0];
4269         int                     is_out;
4270         int                     is_irq;
4271
4272         for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
4273                 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
4274                         if (gdesc->name) {
4275                                 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
4276                                            gpio, gdesc->name);
4277                         }
4278                         continue;
4279                 }
4280
4281                 gpiod_get_direction(gdesc);
4282                 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
4283                 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
4284                 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s",
4285                         gpio, gdesc->name ? gdesc->name : "", gdesc->label,
4286                         is_out ? "out" : "in ",
4287                         chip->get ? (chip->get(chip, i) ? "hi" : "lo") : "?  ",
4288                         is_irq ? "IRQ" : "   ");
4289                 seq_printf(s, "\n");
4290         }
4291 }
4292
4293 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4294 {
4295         unsigned long flags;
4296         struct gpio_device *gdev = NULL;
4297         loff_t index = *pos;
4298
4299         s->private = "";
4300
4301         spin_lock_irqsave(&gpio_lock, flags);
4302         list_for_each_entry(gdev, &gpio_devices, list)
4303                 if (index-- == 0) {
4304                         spin_unlock_irqrestore(&gpio_lock, flags);
4305                         return gdev;
4306                 }
4307         spin_unlock_irqrestore(&gpio_lock, flags);
4308
4309         return NULL;
4310 }
4311
4312 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4313 {
4314         unsigned long flags;
4315         struct gpio_device *gdev = v;
4316         void *ret = NULL;
4317
4318         spin_lock_irqsave(&gpio_lock, flags);
4319         if (list_is_last(&gdev->list, &gpio_devices))
4320                 ret = NULL;
4321         else
4322                 ret = list_entry(gdev->list.next, struct gpio_device, list);
4323         spin_unlock_irqrestore(&gpio_lock, flags);
4324
4325         s->private = "\n";
4326         ++*pos;
4327
4328         return ret;
4329 }
4330
4331 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4332 {
4333 }
4334
4335 static int gpiolib_seq_show(struct seq_file *s, void *v)
4336 {
4337         struct gpio_device *gdev = v;
4338         struct gpio_chip *chip = gdev->chip;
4339         struct device *parent;
4340
4341         if (!chip) {
4342                 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4343                            dev_name(&gdev->dev));
4344                 return 0;
4345         }
4346
4347         seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4348                    dev_name(&gdev->dev),
4349                    gdev->base, gdev->base + gdev->ngpio - 1);
4350         parent = chip->parent;
4351         if (parent)
4352                 seq_printf(s, ", parent: %s/%s",
4353                            parent->bus ? parent->bus->name : "no-bus",
4354                            dev_name(parent));
4355         if (chip->label)
4356                 seq_printf(s, ", %s", chip->label);
4357         if (chip->can_sleep)
4358                 seq_printf(s, ", can sleep");
4359         seq_printf(s, ":\n");
4360
4361         if (chip->dbg_show)
4362                 chip->dbg_show(s, chip);
4363         else
4364                 gpiolib_dbg_show(s, gdev);
4365
4366         return 0;
4367 }
4368
4369 static const struct seq_operations gpiolib_seq_ops = {
4370         .start = gpiolib_seq_start,
4371         .next = gpiolib_seq_next,
4372         .stop = gpiolib_seq_stop,
4373         .show = gpiolib_seq_show,
4374 };
4375
4376 static int gpiolib_open(struct inode *inode, struct file *file)
4377 {
4378         return seq_open(file, &gpiolib_seq_ops);
4379 }
4380
4381 static const struct file_operations gpiolib_operations = {
4382         .owner          = THIS_MODULE,
4383         .open           = gpiolib_open,
4384         .read           = seq_read,
4385         .llseek         = seq_lseek,
4386         .release        = seq_release,
4387 };
4388
4389 static int __init gpiolib_debugfs_init(void)
4390 {
4391         /* /sys/kernel/debug/gpio */
4392         (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
4393                                 NULL, NULL, &gpiolib_operations);
4394         return 0;
4395 }
4396 subsys_initcall(gpiolib_debugfs_init);
4397
4398 #endif  /* DEBUG_FS */