drivers/gpio/gpiolib.c

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