drivers/gpio/gpiolib.c

   1 #include <linux/kernel.h>
   2 #include <linux/module.h>
   3 #include <linux/interrupt.h>
   4 #include <linux/irq.h>
   5 #include <linux/spinlock.h>
   6 #include <linux/device.h>
   7 #include <linux/err.h>
   8 #include <linux/debugfs.h>
   9 #include <linux/seq_file.h>
  10 #include <linux/gpio.h>
  11 #include <linux/of_gpio.h>
  12 #include <linux/idr.h>
  13 #include <linux/slab.h>
  14
  15 #define CREATE_TRACE_POINTS
  16 #include <trace/events/gpio.h>
  17
  18 /* Optional implementation infrastructure for GPIO interfaces.
  19  *
  20  * Platforms may want to use this if they tend to use very many GPIOs
  21  * that aren't part of a System-On-Chip core; or across I2C/SPI/etc.
  22  *
  23  * When kernel footprint or instruction count is an issue, simpler
  24  * implementations may be preferred.  The GPIO programming interface
  25  * allows for inlining speed-critical get/set operations for common
  26  * cases, so that access to SOC-integrated GPIOs can sometimes cost
  27  * only an instruction or two per bit.
  28  */
  29
  30
  31 /* When debugging, extend minimal trust to callers and platform code.
  32  * Also emit diagnostic messages that may help initial bringup, when
  33  * board setup or driver bugs are most common.
  34  *
  35  * Otherwise, minimize overhead in what may be bitbanging codepaths.
  36  */
  37 #ifdef  DEBUG
  38 #define extra_checks    1
  39 #else
  40 #define extra_checks    0
  41 #endif
  42
  43 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
  44  * While any GPIO is requested, its gpio_chip is not removable;
  45  * each GPIO's "requested" flag serves as a lock and refcount.
  46  */
  47 static DEFINE_SPINLOCK(gpio_lock);
  48
  49 struct gpio_desc {
  50         struct gpio_chip        *chip;
  51         unsigned long           flags;
  52 /* flag symbols are bit numbers */
  53 #define FLAG_REQUESTED  0
  54 #define FLAG_IS_OUT     1
  55 #define FLAG_RESERVED   2
  56 #define FLAG_EXPORT     3       /* protected by sysfs_lock */
  57 #define FLAG_SYSFS      4       /* exported via /sys/class/gpio/control */
  58 #define FLAG_TRIG_FALL  5       /* trigger on falling edge */
  59 #define FLAG_TRIG_RISE  6       /* trigger on rising edge */
  60 #define FLAG_ACTIVE_LOW 7       /* sysfs value has active low */
  61 #define FLAG_OPEN_DRAIN 8       /* Gpio is open drain type */
  62 #define FLAG_OPEN_SOURCE 9      /* Gpio is open source type */
  63
  64 #define ID_SHIFT        16      /* add new flags before this one */
  65
  66 #define GPIO_FLAGS_MASK         ((1 << ID_SHIFT) - 1)
  67 #define GPIO_TRIGGER_MASK       (BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE))
  68
  69 #ifdef CONFIG_DEBUG_FS
  70         const char              *label;
  71 #endif
  72 };
  73 static struct gpio_desc gpio_desc[ARCH_NR_GPIOS];
  74
  75 #ifdef CONFIG_GPIO_SYSFS
  76 static DEFINE_IDR(dirent_idr);
  77 #endif
  78
  79 static inline void desc_set_label(struct gpio_desc *d, const char *label)
  80 {
  81 #ifdef CONFIG_DEBUG_FS
  82         d->label = label;
  83 #endif
  84 }
  85
  86 /* Warn when drivers omit gpio_request() calls -- legal but ill-advised
  87  * when setting direction, and otherwise illegal.  Until board setup code
  88  * and drivers use explicit requests everywhere (which won't happen when
  89  * those calls have no teeth) we can't avoid autorequesting.  This nag
  90  * message should motivate switching to explicit requests... so should
  91  * the weaker cleanup after faults, compared to gpio_request().
  92  *
  93  * NOTE: the autorequest mechanism is going away; at this point it's
  94  * only "legal" in the sense that (old) code using it won't break yet,
  95  * but instead only triggers a WARN() stack dump.
  96  */
  97 static int gpio_ensure_requested(struct gpio_desc *desc, unsigned offset)
  98 {
  99         const struct gpio_chip *chip = desc->chip;
 100         const int gpio = chip->base + offset;
 101
 102         if (WARN(test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0,
 103                         "autorequest GPIO-%d\n", gpio)) {
 104                 if (!try_module_get(chip->owner)) {
 105                         pr_err("GPIO-%d: module can't be gotten \n", gpio);
 106                         clear_bit(FLAG_REQUESTED, &desc->flags);
 107                         /* lose */
 108                         return -EIO;
 109                 }
 110                 desc_set_label(desc, "[auto]");
 111                 /* caller must chip->request() w/o spinlock */
 112                 if (chip->request)
 113                         return 1;
 114         }
 115         return 0;
 116 }
 117
 118 /* caller holds gpio_lock *OR* gpio is marked as requested */
 119 struct gpio_chip *gpio_to_chip(unsigned gpio)
 120 {
 121         return gpio_desc[gpio].chip;
 122 }
 123
 124 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
 125 static int gpiochip_find_base(int ngpio)
 126 {
 127         int i;
 128         int spare = 0;
 129         int base = -ENOSPC;
 130
 131         for (i = ARCH_NR_GPIOS - 1; i >= 0 ; i--) {
 132                 struct gpio_desc *desc = &gpio_desc[i];
 133                 struct gpio_chip *chip = desc->chip;
 134
 135                 if (!chip && !test_bit(FLAG_RESERVED, &desc->flags)) {
 136                         spare++;
 137                         if (spare == ngpio) {
 138                                 base = i;
 139                                 break;
 140                         }
 141                 } else {
 142                         spare = 0;
 143                         if (chip)
 144                                 i -= chip->ngpio - 1;
 145                 }
 146         }
 147
 148         if (gpio_is_valid(base))
 149                 pr_debug("%s: found new base at %d\n", __func__, base);
 150         return base;
 151 }
 152
 153 /**
 154  * gpiochip_reserve() - reserve range of gpios to use with platform code only
 155  * @start: starting gpio number
 156  * @ngpio: number of gpios to reserve
 157  * Context: platform init, potentially before irqs or kmalloc will work
 158  *
 159  * Returns a negative errno if any gpio within the range is already reserved
 160  * or registered, else returns zero as a success code.  Use this function
 161  * to mark a range of gpios as unavailable for dynamic gpio number allocation,
 162  * for example because its driver support is not yet loaded.
 163  */
 164 int __init gpiochip_reserve(int start, int ngpio)
 165 {
 166         int ret = 0;
 167         unsigned long flags;
 168         int i;
 169
 170         if (!gpio_is_valid(start) || !gpio_is_valid(start + ngpio - 1))
 171                 return -EINVAL;
 172
 173         spin_lock_irqsave(&gpio_lock, flags);
 174
 175         for (i = start; i < start + ngpio; i++) {
 176                 struct gpio_desc *desc = &gpio_desc[i];
 177
 178                 if (desc->chip || test_bit(FLAG_RESERVED, &desc->flags)) {
 179                         ret = -EBUSY;
 180                         goto err;
 181                 }
 182
 183                 set_bit(FLAG_RESERVED, &desc->flags);
 184         }
 185
 186         pr_debug("%s: reserved gpios from %d to %d\n",
 187                  __func__, start, start + ngpio - 1);
 188 err:
 189         spin_unlock_irqrestore(&gpio_lock, flags);
 190
 191         return ret;
 192 }
 193
 194 #ifdef CONFIG_GPIO_SYSFS
 195
 196 /* lock protects against unexport_gpio() being called while
 197  * sysfs files are active.
 198  */
 199 static DEFINE_MUTEX(sysfs_lock);
 200
 201 /*
 202  * /sys/class/gpio/gpioN... only for GPIOs that are exported
 203  *   /direction
 204  *      * MAY BE OMITTED if kernel won't allow direction changes
 205  *      * is read/write as "in" or "out"
 206  *      * may also be written as "high" or "low", initializing
 207  *        output value as specified ("out" implies "low")
 208  *   /value
 209  *      * always readable, subject to hardware behavior
 210  *      * may be writable, as zero/nonzero
 211  *   /edge
 212  *      * configures behavior of poll(2) on /value
 213  *      * available only if pin can generate IRQs on input
 214  *      * is read/write as "none", "falling", "rising", or "both"
 215  *   /active_low
 216  *      * configures polarity of /value
 217  *      * is read/write as zero/nonzero
 218  *      * also affects existing and subsequent "falling" and "rising"
 219  *        /edge configuration
 220  */
 221
 222 static ssize_t gpio_direction_show(struct device *dev,
 223                 struct device_attribute *attr, char *buf)
 224 {
 225         const struct gpio_desc  *desc = dev_get_drvdata(dev);
 226         ssize_t                 status;
 227
 228         mutex_lock(&sysfs_lock);
 229
 230         if (!test_bit(FLAG_EXPORT, &desc->flags))
 231                 status = -EIO;
 232         else
 233                 status = sprintf(buf, "%s\n",
 234                         test_bit(FLAG_IS_OUT, &desc->flags)
 235                                 ? "out" : "in");
 236
 237         mutex_unlock(&sysfs_lock);
 238         return status;
 239 }
 240
 241 static ssize_t gpio_direction_store(struct device *dev,
 242                 struct device_attribute *attr, const char *buf, size_t size)
 243 {
 244         const struct gpio_desc  *desc = dev_get_drvdata(dev);
 245         unsigned                gpio = desc - gpio_desc;
 246         ssize_t                 status;
 247
 248         mutex_lock(&sysfs_lock);
 249
 250         if (!test_bit(FLAG_EXPORT, &desc->flags))
 251                 status = -EIO;
 252         else if (sysfs_streq(buf, "high"))
 253                 status = gpio_direction_output(gpio, 1);
 254         else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
 255                 status = gpio_direction_output(gpio, 0);
 256         else if (sysfs_streq(buf, "in"))
 257                 status = gpio_direction_input(gpio);
 258         else
 259                 status = -EINVAL;
 260
 261         mutex_unlock(&sysfs_lock);
 262         return status ? : size;
 263 }
 264
 265 static /* const */ DEVICE_ATTR(direction, 0644,
 266                 gpio_direction_show, gpio_direction_store);
 267
 268 static ssize_t gpio_value_show(struct device *dev,
 269                 struct device_attribute *attr, char *buf)
 270 {
 271         const struct gpio_desc  *desc = dev_get_drvdata(dev);
 272         unsigned                gpio = desc - gpio_desc;
 273         ssize_t                 status;
 274
 275         mutex_lock(&sysfs_lock);
 276
 277         if (!test_bit(FLAG_EXPORT, &desc->flags)) {
 278                 status = -EIO;
 279         } else {
 280                 int value;
 281
 282                 value = !!gpio_get_value_cansleep(gpio);
 283                 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
 284                         value = !value;
 285
 286                 status = sprintf(buf, "%d\n", value);
 287         }
 288
 289         mutex_unlock(&sysfs_lock);
 290         return status;
 291 }
 292
 293 static ssize_t gpio_value_store(struct device *dev,
 294                 struct device_attribute *attr, const char *buf, size_t size)
 295 {
 296         const struct gpio_desc  *desc = dev_get_drvdata(dev);
 297         unsigned                gpio = desc - gpio_desc;
 298         ssize_t                 status;
 299
 300         mutex_lock(&sysfs_lock);
 301
 302         if (!test_bit(FLAG_EXPORT, &desc->flags))
 303                 status = -EIO;
 304         else if (!test_bit(FLAG_IS_OUT, &desc->flags))
 305                 status = -EPERM;
 306         else {
 307                 long            value;
 308
 309                 status = strict_strtol(buf, 0, &value);
 310                 if (status == 0) {
 311                         if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
 312                                 value = !value;
 313                         gpio_set_value_cansleep(gpio, value != 0);
 314                         status = size;
 315                 }
 316         }
 317
 318         mutex_unlock(&sysfs_lock);
 319         return status;
 320 }
 321
 322 static const DEVICE_ATTR(value, 0644,
 323                 gpio_value_show, gpio_value_store);
 324
 325 static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
 326 {
 327         struct sysfs_dirent     *value_sd = priv;
 328
 329         sysfs_notify_dirent(value_sd);
 330         return IRQ_HANDLED;
 331 }
 332
 333 static int gpio_setup_irq(struct gpio_desc *desc, struct device *dev,
 334                 unsigned long gpio_flags)
 335 {
 336         struct sysfs_dirent     *value_sd;
 337         unsigned long           irq_flags;
 338         int                     ret, irq, id;
 339
 340         if ((desc->flags & GPIO_TRIGGER_MASK) == gpio_flags)
 341                 return 0;
 342
 343         irq = gpio_to_irq(desc - gpio_desc);
 344         if (irq < 0)
 345                 return -EIO;
 346
 347         id = desc->flags >> ID_SHIFT;
 348         value_sd = idr_find(&dirent_idr, id);
 349         if (value_sd)
 350                 free_irq(irq, value_sd);
 351
 352         desc->flags &= ~GPIO_TRIGGER_MASK;
 353
 354         if (!gpio_flags) {
 355                 ret = 0;
 356                 goto free_id;
 357         }
 358
 359         irq_flags = IRQF_SHARED;
 360         if (test_bit(FLAG_TRIG_FALL, &gpio_flags))
 361                 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
 362                         IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
 363         if (test_bit(FLAG_TRIG_RISE, &gpio_flags))
 364                 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
 365                         IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
 366
 367         if (!value_sd) {
 368                 value_sd = sysfs_get_dirent(dev->kobj.sd, NULL, "value");
 369                 if (!value_sd) {
 370                         ret = -ENODEV;
 371                         goto err_out;
 372                 }
 373
 374                 do {
 375                         ret = -ENOMEM;
 376                         if (idr_pre_get(&dirent_idr, GFP_KERNEL))
 377                                 ret = idr_get_new_above(&dirent_idr, value_sd,
 378                                                         1, &id);
 379                 } while (ret == -EAGAIN);
 380
 381                 if (ret)
 382                         goto free_sd;
 383
 384                 desc->flags &= GPIO_FLAGS_MASK;
 385                 desc->flags |= (unsigned long)id << ID_SHIFT;
 386
 387                 if (desc->flags >> ID_SHIFT != id) {
 388                         ret = -ERANGE;
 389                         goto free_id;
 390                 }
 391         }
 392
 393         ret = request_any_context_irq(irq, gpio_sysfs_irq, irq_flags,
 394                                 "gpiolib", value_sd);
 395         if (ret < 0)
 396                 goto free_id;
 397
 398         desc->flags |= gpio_flags;
 399         return 0;
 400
 401 free_id:
 402         idr_remove(&dirent_idr, id);
 403         desc->flags &= GPIO_FLAGS_MASK;
 404 free_sd:
 405         if (value_sd)
 406                 sysfs_put(value_sd);
 407 err_out:
 408         return ret;
 409 }
 410
 411 static const struct {
 412         const char *name;
 413         unsigned long flags;
 414 } trigger_types[] = {
 415         { "none",    0 },
 416         { "falling", BIT(FLAG_TRIG_FALL) },
 417         { "rising",  BIT(FLAG_TRIG_RISE) },
 418         { "both",    BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE) },
 419 };
 420
 421 static ssize_t gpio_edge_show(struct device *dev,
 422                 struct device_attribute *attr, char *buf)
 423 {
 424         const struct gpio_desc  *desc = dev_get_drvdata(dev);
 425         ssize_t                 status;
 426
 427         mutex_lock(&sysfs_lock);
 428
 429         if (!test_bit(FLAG_EXPORT, &desc->flags))
 430                 status = -EIO;
 431         else {
 432                 int i;
 433
 434                 status = 0;
 435                 for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
 436                         if ((desc->flags & GPIO_TRIGGER_MASK)
 437                                         == trigger_types[i].flags) {
 438                                 status = sprintf(buf, "%s\n",
 439                                                  trigger_types[i].name);
 440                                 break;
 441                         }
 442         }
 443
 444         mutex_unlock(&sysfs_lock);
 445         return status;
 446 }
 447
 448 static ssize_t gpio_edge_store(struct device *dev,
 449                 struct device_attribute *attr, const char *buf, size_t size)
 450 {
 451         struct gpio_desc        *desc = dev_get_drvdata(dev);
 452         ssize_t                 status;
 453         int                     i;
 454
 455         for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
 456                 if (sysfs_streq(trigger_types[i].name, buf))
 457                         goto found;
 458         return -EINVAL;
 459
 460 found:
 461         mutex_lock(&sysfs_lock);
 462
 463         if (!test_bit(FLAG_EXPORT, &desc->flags))
 464                 status = -EIO;
 465         else {
 466                 status = gpio_setup_irq(desc, dev, trigger_types[i].flags);
 467                 if (!status)
 468                         status = size;
 469         }
 470
 471         mutex_unlock(&sysfs_lock);
 472
 473         return status;
 474 }
 475
 476 static DEVICE_ATTR(edge, 0644, gpio_edge_show, gpio_edge_store);
 477
 478 static int sysfs_set_active_low(struct gpio_desc *desc, struct device *dev,
 479                                 int value)
 480 {
 481         int                     status = 0;
 482
 483         if (!!test_bit(FLAG_ACTIVE_LOW, &desc->flags) == !!value)
 484                 return 0;
 485
 486         if (value)
 487                 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
 488         else
 489                 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
 490
 491         /* reconfigure poll(2) support if enabled on one edge only */
 492         if (dev != NULL && (!!test_bit(FLAG_TRIG_RISE, &desc->flags) ^
 493                                 !!test_bit(FLAG_TRIG_FALL, &desc->flags))) {
 494                 unsigned long trigger_flags = desc->flags & GPIO_TRIGGER_MASK;
 495
 496                 gpio_setup_irq(desc, dev, 0);
 497                 status = gpio_setup_irq(desc, dev, trigger_flags);
 498         }
 499
 500         return status;
 501 }
 502
 503 static ssize_t gpio_active_low_show(struct device *dev,
 504                 struct device_attribute *attr, char *buf)
 505 {
 506         const struct gpio_desc  *desc = dev_get_drvdata(dev);
 507         ssize_t                 status;
 508
 509         mutex_lock(&sysfs_lock);
 510
 511         if (!test_bit(FLAG_EXPORT, &desc->flags))
 512                 status = -EIO;
 513         else
 514                 status = sprintf(buf, "%d\n",
 515                                 !!test_bit(FLAG_ACTIVE_LOW, &desc->flags));
 516
 517         mutex_unlock(&sysfs_lock);
 518
 519         return status;
 520 }
 521
 522 static ssize_t gpio_active_low_store(struct device *dev,
 523                 struct device_attribute *attr, const char *buf, size_t size)
 524 {
 525         struct gpio_desc        *desc = dev_get_drvdata(dev);
 526         ssize_t                 status;
 527
 528         mutex_lock(&sysfs_lock);
 529
 530         if (!test_bit(FLAG_EXPORT, &desc->flags)) {
 531                 status = -EIO;
 532         } else {
 533                 long            value;
 534
 535                 status = strict_strtol(buf, 0, &value);
 536                 if (status == 0)
 537                         status = sysfs_set_active_low(desc, dev, value != 0);
 538         }
 539
 540         mutex_unlock(&sysfs_lock);
 541
 542         return status ? : size;
 543 }
 544
 545 static const DEVICE_ATTR(active_low, 0644,
 546                 gpio_active_low_show, gpio_active_low_store);
 547
 548 static const struct attribute *gpio_attrs[] = {
 549         &dev_attr_value.attr,
 550         &dev_attr_active_low.attr,
 551         NULL,
 552 };
 553
 554 static const struct attribute_group gpio_attr_group = {
 555         .attrs = (struct attribute **) gpio_attrs,
 556 };
 557
 558 /*
 559  * /sys/class/gpio/gpiochipN/
 560  *   /base ... matching gpio_chip.base (N)
 561  *   /label ... matching gpio_chip.label
 562  *   /ngpio ... matching gpio_chip.ngpio
 563  */
 564
 565 static ssize_t chip_base_show(struct device *dev,
 566                                struct device_attribute *attr, char *buf)
 567 {
 568         const struct gpio_chip  *chip = dev_get_drvdata(dev);
 569
 570         return sprintf(buf, "%d\n", chip->base);
 571 }
 572 static DEVICE_ATTR(base, 0444, chip_base_show, NULL);
 573
 574 static ssize_t chip_label_show(struct device *dev,
 575                                struct device_attribute *attr, char *buf)
 576 {
 577         const struct gpio_chip  *chip = dev_get_drvdata(dev);
 578
 579         return sprintf(buf, "%s\n", chip->label ? : "");
 580 }
 581 static DEVICE_ATTR(label, 0444, chip_label_show, NULL);
 582
 583 static ssize_t chip_ngpio_show(struct device *dev,
 584                                struct device_attribute *attr, char *buf)
 585 {
 586         const struct gpio_chip  *chip = dev_get_drvdata(dev);
 587
 588         return sprintf(buf, "%u\n", chip->ngpio);
 589 }
 590 static DEVICE_ATTR(ngpio, 0444, chip_ngpio_show, NULL);
 591
 592 static const struct attribute *gpiochip_attrs[] = {
 593         &dev_attr_base.attr,
 594         &dev_attr_label.attr,
 595         &dev_attr_ngpio.attr,
 596         NULL,
 597 };
 598
 599 static const struct attribute_group gpiochip_attr_group = {
 600         .attrs = (struct attribute **) gpiochip_attrs,
 601 };
 602
 603 /*
 604  * /sys/class/gpio/export ... write-only
 605  *      integer N ... number of GPIO to export (full access)
 606  * /sys/class/gpio/unexport ... write-only
 607  *      integer N ... number of GPIO to unexport
 608  */
 609 static ssize_t export_store(struct class *class,
 610                                 struct class_attribute *attr,
 611                                 const char *buf, size_t len)
 612 {
 613         long    gpio;
 614         int     status;
 615
 616         status = strict_strtol(buf, 0, &gpio);
 617         if (status < 0)
 618                 goto done;
 619
 620         /* No extra locking here; FLAG_SYSFS just signifies that the
 621          * request and export were done by on behalf of userspace, so
 622          * they may be undone on its behalf too.
 623          */
 624
 625         status = gpio_request(gpio, "sysfs");
 626         if (status < 0) {
 627                 if (status == -EPROBE_DEFER)
 628                         status = -ENODEV;
 629                 goto done;
 630         }
 631         status = gpio_export(gpio, true);
 632         if (status < 0)
 633                 gpio_free(gpio);
 634         else
 635                 set_bit(FLAG_SYSFS, &gpio_desc[gpio].flags);
 636
 637 done:
 638         if (status)
 639                 pr_debug("%s: status %d\n", __func__, status);
 640         return status ? : len;
 641 }
 642
 643 static ssize_t unexport_store(struct class *class,
 644                                 struct class_attribute *attr,
 645                                 const char *buf, size_t len)
 646 {
 647         long    gpio;
 648         int     status;
 649
 650         status = strict_strtol(buf, 0, &gpio);
 651         if (status < 0)
 652                 goto done;
 653
 654         status = -EINVAL;
 655
 656         /* reject bogus commands (gpio_unexport ignores them) */
 657         if (!gpio_is_valid(gpio))
 658                 goto done;
 659
 660         /* No extra locking here; FLAG_SYSFS just signifies that the
 661          * request and export were done by on behalf of userspace, so
 662          * they may be undone on its behalf too.
 663          */
 664         if (test_and_clear_bit(FLAG_SYSFS, &gpio_desc[gpio].flags)) {
 665                 status = 0;
 666                 gpio_free(gpio);
 667         }
 668 done:
 669         if (status)
 670                 pr_debug("%s: status %d\n", __func__, status);
 671         return status ? : len;
 672 }
 673
 674 static struct class_attribute gpio_class_attrs[] = {
 675         __ATTR(export, 0200, NULL, export_store),
 676         __ATTR(unexport, 0200, NULL, unexport_store),
 677         __ATTR_NULL,
 678 };
 679
 680 static struct class gpio_class = {
 681         .name =         "gpio",
 682         .owner =        THIS_MODULE,
 683
 684         .class_attrs =  gpio_class_attrs,
 685 };
 686
 687
 688 /**
 689  * gpio_export - export a GPIO through sysfs
 690  * @gpio: gpio to make available, already requested
 691  * @direction_may_change: true if userspace may change gpio direction
 692  * Context: arch_initcall or later
 693  *
 694  * When drivers want to make a GPIO accessible to userspace after they
 695  * have requested it -- perhaps while debugging, or as part of their
 696  * public interface -- they may use this routine.  If the GPIO can
 697  * change direction (some can't) and the caller allows it, userspace
 698  * will see "direction" sysfs attribute which may be used to change
 699  * the gpio's direction.  A "value" attribute will always be provided.
 700  *
 701  * Returns zero on success, else an error.
 702  */
 703 int gpio_export(unsigned gpio, bool direction_may_change)
 704 {
 705         unsigned long           flags;
 706         struct gpio_desc        *desc;
 707         int                     status = -EINVAL;
 708         const char              *ioname = NULL;
 709
 710         /* can't export until sysfs is available ... */
 711         if (!gpio_class.p) {
 712                 pr_debug("%s: called too early!\n", __func__);
 713                 return -ENOENT;
 714         }
 715
 716         if (!gpio_is_valid(gpio))
 717                 goto done;
 718
 719         mutex_lock(&sysfs_lock);
 720
 721         spin_lock_irqsave(&gpio_lock, flags);
 722         desc = &gpio_desc[gpio];
 723         if (test_bit(FLAG_REQUESTED, &desc->flags)
 724                         && !test_bit(FLAG_EXPORT, &desc->flags)) {
 725                 status = 0;
 726                 if (!desc->chip->direction_input
 727                                 || !desc->chip->direction_output)
 728                         direction_may_change = false;
 729         }
 730         spin_unlock_irqrestore(&gpio_lock, flags);
 731
 732         if (desc->chip->names && desc->chip->names[gpio - desc->chip->base])
 733                 ioname = desc->chip->names[gpio - desc->chip->base];
 734
 735         if (status == 0) {
 736                 struct device   *dev;
 737
 738                 dev = device_create(&gpio_class, desc->chip->dev, MKDEV(0, 0),
 739                                 desc, ioname ? ioname : "gpio%u", gpio);
 740                 if (!IS_ERR(dev)) {
 741                         status = sysfs_create_group(&dev->kobj,
 742                                                 &gpio_attr_group);
 743
 744                         if (!status && direction_may_change)
 745                                 status = device_create_file(dev,
 746                                                 &dev_attr_direction);
 747
 748                         if (!status && gpio_to_irq(gpio) >= 0
 749                                         && (direction_may_change
 750                                                 || !test_bit(FLAG_IS_OUT,
 751                                                         &desc->flags)))
 752                                 status = device_create_file(dev,
 753                                                 &dev_attr_edge);
 754
 755                         if (status != 0)
 756                                 device_unregister(dev);
 757                 } else
 758                         status = PTR_ERR(dev);
 759                 if (status == 0)
 760                         set_bit(FLAG_EXPORT, &desc->flags);
 761         }
 762
 763         mutex_unlock(&sysfs_lock);
 764
 765 done:
 766         if (status)
 767                 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
 768
 769         return status;
 770 }
 771 EXPORT_SYMBOL_GPL(gpio_export);
 772
 773 static int match_export(struct device *dev, void *data)
 774 {
 775         return dev_get_drvdata(dev) == data;
 776 }
 777
 778 /**
 779  * gpio_export_link - create a sysfs link to an exported GPIO node
 780  * @dev: device under which to create symlink
 781  * @name: name of the symlink
 782  * @gpio: gpio to create symlink to, already exported
 783  *
 784  * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
 785  * node. Caller is responsible for unlinking.
 786  *
 787  * Returns zero on success, else an error.
 788  */
 789 int gpio_export_link(struct device *dev, const char *name, unsigned gpio)
 790 {
 791         struct gpio_desc        *desc;
 792         int                     status = -EINVAL;
 793
 794         if (!gpio_is_valid(gpio))
 795                 goto done;
 796
 797         mutex_lock(&sysfs_lock);
 798
 799         desc = &gpio_desc[gpio];
 800
 801         if (test_bit(FLAG_EXPORT, &desc->flags)) {
 802                 struct device *tdev;
 803
 804                 tdev = class_find_device(&gpio_class, NULL, desc, match_export);
 805                 if (tdev != NULL) {
 806                         status = sysfs_create_link(&dev->kobj, &tdev->kobj,
 807                                                 name);
 808                 } else {
 809                         status = -ENODEV;
 810                 }
 811         }
 812
 813         mutex_unlock(&sysfs_lock);
 814
 815 done:
 816         if (status)
 817                 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
 818
 819         return status;
 820 }
 821 EXPORT_SYMBOL_GPL(gpio_export_link);
 822
 823
 824 /**
 825  * gpio_sysfs_set_active_low - set the polarity of gpio sysfs value
 826  * @gpio: gpio to change
 827  * @value: non-zero to use active low, i.e. inverted values
 828  *
 829  * Set the polarity of /sys/class/gpio/gpioN/value sysfs attribute.
 830  * The GPIO does not have to be exported yet.  If poll(2) support has
 831  * been enabled for either rising or falling edge, it will be
 832  * reconfigured to follow the new polarity.
 833  *
 834  * Returns zero on success, else an error.
 835  */
 836 int gpio_sysfs_set_active_low(unsigned gpio, int value)
 837 {
 838         struct gpio_desc        *desc;
 839         struct device           *dev = NULL;
 840         int                     status = -EINVAL;
 841
 842         if (!gpio_is_valid(gpio))
 843                 goto done;
 844
 845         mutex_lock(&sysfs_lock);
 846
 847         desc = &gpio_desc[gpio];
 848
 849         if (test_bit(FLAG_EXPORT, &desc->flags)) {
 850                 dev = class_find_device(&gpio_class, NULL, desc, match_export);
 851                 if (dev == NULL) {
 852                         status = -ENODEV;
 853                         goto unlock;
 854                 }
 855         }
 856
 857         status = sysfs_set_active_low(desc, dev, value);
 858
 859 unlock:
 860         mutex_unlock(&sysfs_lock);
 861
 862 done:
 863         if (status)
 864                 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
 865
 866         return status;
 867 }
 868 EXPORT_SYMBOL_GPL(gpio_sysfs_set_active_low);
 869
 870 /**
 871  * gpio_unexport - reverse effect of gpio_export()
 872  * @gpio: gpio to make unavailable
 873  *
 874  * This is implicit on gpio_free().
 875  */
 876 void gpio_unexport(unsigned gpio)
 877 {
 878         struct gpio_desc        *desc;
 879         int                     status = 0;
 880         struct device           *dev = NULL;
 881
 882         if (!gpio_is_valid(gpio)) {
 883                 status = -EINVAL;
 884                 goto done;
 885         }
 886
 887         mutex_lock(&sysfs_lock);
 888
 889         desc = &gpio_desc[gpio];
 890
 891         if (test_bit(FLAG_EXPORT, &desc->flags)) {
 892
 893                 dev = class_find_device(&gpio_class, NULL, desc, match_export);
 894                 if (dev) {
 895                         gpio_setup_irq(desc, dev, 0);
 896                         clear_bit(FLAG_EXPORT, &desc->flags);
 897                 } else
 898                         status = -ENODEV;
 899         }
 900
 901         mutex_unlock(&sysfs_lock);
 902         if (dev) {
 903                 device_unregister(dev);
 904                 put_device(dev);
 905         }
 906 done:
 907         if (status)
 908                 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
 909 }
 910 EXPORT_SYMBOL_GPL(gpio_unexport);
 911
 912 static int gpiochip_export(struct gpio_chip *chip)
 913 {
 914         int             status;
 915         struct device   *dev;
 916
 917         /* Many systems register gpio chips for SOC support very early,
 918          * before driver model support is available.  In those cases we
 919          * export this later, in gpiolib_sysfs_init() ... here we just
 920          * verify that _some_ field of gpio_class got initialized.
 921          */
 922         if (!gpio_class.p)
 923                 return 0;
 924
 925         /* use chip->base for the ID; it's already known to be unique */
 926         mutex_lock(&sysfs_lock);
 927         dev = device_create(&gpio_class, chip->dev, MKDEV(0, 0), chip,
 928                                 "gpiochip%d", chip->base);
 929         if (!IS_ERR(dev)) {
 930                 status = sysfs_create_group(&dev->kobj,
 931                                 &gpiochip_attr_group);
 932         } else
 933                 status = PTR_ERR(dev);
 934         chip->exported = (status == 0);
 935         mutex_unlock(&sysfs_lock);
 936
 937         if (status) {
 938                 unsigned long   flags;
 939                 unsigned        gpio;
 940
 941                 spin_lock_irqsave(&gpio_lock, flags);
 942                 gpio = chip->base;
 943                 while (gpio_desc[gpio].chip == chip)
 944                         gpio_desc[gpio++].chip = NULL;
 945                 spin_unlock_irqrestore(&gpio_lock, flags);
 946
 947                 pr_debug("%s: chip %s status %d\n", __func__,
 948                                 chip->label, status);
 949         }
 950
 951         return status;
 952 }
 953
 954 static void gpiochip_unexport(struct gpio_chip *chip)
 955 {
 956         int                     status;
 957         struct device           *dev;
 958
 959         mutex_lock(&sysfs_lock);
 960         dev = class_find_device(&gpio_class, NULL, chip, match_export);
 961         if (dev) {
 962                 put_device(dev);
 963                 device_unregister(dev);
 964                 chip->exported = 0;
 965                 status = 0;
 966         } else
 967                 status = -ENODEV;
 968         mutex_unlock(&sysfs_lock);
 969
 970         if (status)
 971                 pr_debug("%s: chip %s status %d\n", __func__,
 972                                 chip->label, status);
 973 }
 974
 975 static int __init gpiolib_sysfs_init(void)
 976 {
 977         int             status;
 978         unsigned long   flags;
 979         unsigned        gpio;
 980
 981         status = class_register(&gpio_class);
 982         if (status < 0)
 983                 return status;
 984
 985         /* Scan and register the gpio_chips which registered very
 986          * early (e.g. before the class_register above was called).
 987          *
 988          * We run before arch_initcall() so chip->dev nodes can have
 989          * registered, and so arch_initcall() can always gpio_export().
 990          */
 991         spin_lock_irqsave(&gpio_lock, flags);
 992         for (gpio = 0; gpio < ARCH_NR_GPIOS; gpio++) {
 993                 struct gpio_chip        *chip;
 994
 995                 chip = gpio_desc[gpio].chip;
 996                 if (!chip || chip->exported)
 997                         continue;
 998
 999                 spin_unlock_irqrestore(&gpio_lock, flags);
1000                 status = gpiochip_export(chip);
1001                 spin_lock_irqsave(&gpio_lock, flags);
1002         }
1003         spin_unlock_irqrestore(&gpio_lock, flags);
1004
1005
1006         return status;
1007 }
1008 postcore_initcall(gpiolib_sysfs_init);
1009
1010 #else
1011 static inline int gpiochip_export(struct gpio_chip *chip)
1012 {
1013         return 0;
1014 }
1015
1016 static inline void gpiochip_unexport(struct gpio_chip *chip)
1017 {
1018 }
1019
1020 #endif /* CONFIG_GPIO_SYSFS */
1021
1022 /**
1023  * gpiochip_add() - register a gpio_chip
1024  * @chip: the chip to register, with chip->base initialized
1025  * Context: potentially before irqs or kmalloc will work
1026  *
1027  * Returns a negative errno if the chip can't be registered, such as
1028  * because the chip->base is invalid or already associated with a
1029  * different chip.  Otherwise it returns zero as a success code.
1030  *
1031  * When gpiochip_add() is called very early during boot, so that GPIOs
1032  * can be freely used, the chip->dev device must be registered before
1033  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
1034  * for GPIOs will fail rudely.
1035  *
1036  * If chip->base is negative, this requests dynamic assignment of
1037  * a range of valid GPIOs.
1038  */
1039 int gpiochip_add(struct gpio_chip *chip)
1040 {
1041         unsigned long   flags;
1042         int             status = 0;
1043         unsigned        id;
1044         int             base = chip->base;
1045
1046         if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
1047                         && base >= 0) {
1048                 status = -EINVAL;
1049                 goto fail;
1050         }
1051
1052         spin_lock_irqsave(&gpio_lock, flags);
1053
1054         if (base < 0) {
1055                 base = gpiochip_find_base(chip->ngpio);
1056                 if (base < 0) {
1057                         status = base;
1058                         goto unlock;
1059                 }
1060                 chip->base = base;
1061         }
1062
1063         /* these GPIO numbers must not be managed by another gpio_chip */
1064         for (id = base; id < base + chip->ngpio; id++) {
1065                 if (gpio_desc[id].chip != NULL) {
1066                         status = -EBUSY;
1067                         break;
1068                 }
1069         }
1070         if (status == 0) {
1071                 for (id = base; id < base + chip->ngpio; id++) {
1072                         gpio_desc[id].chip = chip;
1073
1074                         /* REVISIT:  most hardware initializes GPIOs as
1075                          * inputs (often with pullups enabled) so power
1076                          * usage is minimized.  Linux code should set the
1077                          * gpio direction first thing; but until it does,
1078                          * we may expose the wrong direction in sysfs.
1079                          */
1080                         gpio_desc[id].flags = !chip->direction_input
1081                                 ? (1 << FLAG_IS_OUT)
1082                                 : 0;
1083                 }
1084         }
1085
1086 #ifdef CONFIG_PINCTRL
1087         INIT_LIST_HEAD(&chip->pin_ranges);
1088 #endif
1089
1090         of_gpiochip_add(chip);
1091
1092 unlock:
1093         spin_unlock_irqrestore(&gpio_lock, flags);
1094
1095         if (status)
1096                 goto fail;
1097
1098         status = gpiochip_export(chip);
1099         if (status)
1100                 goto fail;
1101
1102         pr_debug("gpiochip_add: registered GPIOs %d to %d on device: %s\n",
1103                 chip->base, chip->base + chip->ngpio - 1,
1104                 chip->label ? : "generic");
1105
1106         return 0;
1107 fail:
1108         /* failures here can mean systems won't boot... */
1109         pr_err("gpiochip_add: gpios %d..%d (%s) failed to register\n",
1110                 chip->base, chip->base + chip->ngpio - 1,
1111                 chip->label ? : "generic");
1112         return status;
1113 }
1114 EXPORT_SYMBOL_GPL(gpiochip_add);
1115
1116 /**
1117  * gpiochip_remove() - unregister a gpio_chip
1118  * @chip: the chip to unregister
1119  *
1120  * A gpio_chip with any GPIOs still requested may not be removed.
1121  */
1122 int gpiochip_remove(struct gpio_chip *chip)
1123 {
1124         unsigned long   flags;
1125         int             status = 0;
1126         unsigned        id;
1127
1128         spin_lock_irqsave(&gpio_lock, flags);
1129
1130         gpiochip_remove_pin_ranges(chip);
1131         of_gpiochip_remove(chip);
1132
1133         for (id = chip->base; id < chip->base + chip->ngpio; id++) {
1134                 if (test_bit(FLAG_REQUESTED, &gpio_desc[id].flags)) {
1135                         status = -EBUSY;
1136                         break;
1137                 }
1138         }
1139         if (status == 0) {
1140                 for (id = chip->base; id < chip->base + chip->ngpio; id++)
1141                         gpio_desc[id].chip = NULL;
1142         }
1143
1144         spin_unlock_irqrestore(&gpio_lock, flags);
1145
1146         if (status == 0)
1147                 gpiochip_unexport(chip);
1148
1149         return status;
1150 }
1151 EXPORT_SYMBOL_GPL(gpiochip_remove);
1152
1153 /**
1154  * gpiochip_find() - iterator for locating a specific gpio_chip
1155  * @data: data to pass to match function
1156  * @callback: Callback function to check gpio_chip
1157  *
1158  * Similar to bus_find_device.  It returns a reference to a gpio_chip as
1159  * determined by a user supplied @match callback.  The callback should return
1160  * 0 if the device doesn't match and non-zero if it does.  If the callback is
1161  * non-zero, this function will return to the caller and not iterate over any
1162  * more gpio_chips.
1163  */
1164 struct gpio_chip *gpiochip_find(void *data,
1165                                 int (*match)(struct gpio_chip *chip,
1166                                              void *data))
1167 {
1168         struct gpio_chip *chip = NULL;
1169         unsigned long flags;
1170         int i;
1171
1172         spin_lock_irqsave(&gpio_lock, flags);
1173         for (i = 0; i < ARCH_NR_GPIOS; i++) {
1174                 if (!gpio_desc[i].chip)
1175                         continue;
1176
1177                 if (match(gpio_desc[i].chip, data)) {
1178                         chip = gpio_desc[i].chip;
1179                         break;
1180                 }
1181         }
1182         spin_unlock_irqrestore(&gpio_lock, flags);
1183
1184         return chip;
1185 }
1186 EXPORT_SYMBOL_GPL(gpiochip_find);
1187
1188 #ifdef CONFIG_PINCTRL
1189
1190 /**
1191  * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1192  * @chip: the gpiochip to add the range for
1193  * @pinctrl_name: the dev_name() of the pin controller to map to
1194  * @gpio_offset: the start offset in the current gpio_chip number space
1195  * @pin_offset: the start offset in the pin controller number space
1196  * @npins: the number of pins from the offset of each pin space (GPIO and
1197  *      pin controller) to accumulate in this range
1198  */
1199 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
1200                            unsigned int gpio_offset, unsigned int pin_offset,
1201                            unsigned int npins)
1202 {
1203         struct gpio_pin_range *pin_range;
1204         int ret;
1205
1206         pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1207         if (!pin_range) {
1208                 pr_err("%s: GPIO chip: failed to allocate pin ranges\n",
1209                                 chip->label);
1210                 return -ENOMEM;
1211         }
1212
1213         /* Use local offset as range ID */
1214         pin_range->range.id = gpio_offset;
1215         pin_range->range.gc = chip;
1216         pin_range->range.name = chip->label;
1217         pin_range->range.base = chip->base + gpio_offset;
1218         pin_range->range.pin_base = pin_offset;
1219         pin_range->range.npins = npins;
1220         pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1221                         &pin_range->range);
1222         if (IS_ERR(pin_range->pctldev)) {
1223                 ret = PTR_ERR(pin_range->pctldev);
1224                 pr_err("%s: GPIO chip: could not create pin range\n",
1225                        chip->label);
1226                 kfree(pin_range);
1227                 return ret;
1228         }
1229         pr_debug("GPIO chip %s: created GPIO range %d->%d ==> %s PIN %d->%d\n",
1230                  chip->label, gpio_offset, gpio_offset + npins - 1,
1231                  pinctl_name,
1232                  pin_offset, pin_offset + npins - 1);
1233
1234         list_add_tail(&pin_range->node, &chip->pin_ranges);
1235
1236         return 0;
1237 }
1238 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1239
1240 /**
1241  * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1242  * @chip: the chip to remove all the mappings for
1243  */
1244 void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
1245 {
1246         struct gpio_pin_range *pin_range, *tmp;
1247
1248         list_for_each_entry_safe(pin_range, tmp, &chip->pin_ranges, node) {
1249                 list_del(&pin_range->node);
1250                 pinctrl_remove_gpio_range(pin_range->pctldev,
1251                                 &pin_range->range);
1252                 kfree(pin_range);
1253         }
1254 }
1255 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1256
1257 #endif /* CONFIG_PINCTRL */
1258
1259 /* These "optional" allocation calls help prevent drivers from stomping
1260  * on each other, and help provide better diagnostics in debugfs.
1261  * They're called even less than the "set direction" calls.
1262  */
1263 int gpio_request(unsigned gpio, const char *label)
1264 {
1265         struct gpio_desc        *desc;
1266         struct gpio_chip        *chip;
1267         int                     status = -EPROBE_DEFER;
1268         unsigned long           flags;
1269
1270         spin_lock_irqsave(&gpio_lock, flags);
1271
1272         if (!gpio_is_valid(gpio)) {
1273                 status = -EINVAL;
1274                 goto done;
1275         }
1276         desc = &gpio_desc[gpio];
1277         chip = desc->chip;
1278         if (chip == NULL)
1279                 goto done;
1280
1281         if (!try_module_get(chip->owner))
1282                 goto done;
1283
1284         /* NOTE:  gpio_request() can be called in early boot,
1285          * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1286          */
1287
1288         if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1289                 desc_set_label(desc, label ? : "?");
1290                 status = 0;
1291         } else {
1292                 status = -EBUSY;
1293                 module_put(chip->owner);
1294                 goto done;
1295         }
1296
1297         if (chip->request) {
1298                 /* chip->request may sleep */
1299                 spin_unlock_irqrestore(&gpio_lock, flags);
1300                 status = chip->request(chip, gpio - chip->base);
1301                 spin_lock_irqsave(&gpio_lock, flags);
1302
1303                 if (status < 0) {
1304                         desc_set_label(desc, NULL);
1305                         module_put(chip->owner);
1306                         clear_bit(FLAG_REQUESTED, &desc->flags);
1307                 }
1308         }
1309
1310 done:
1311         if (status)
1312                 pr_debug("gpio_request: gpio-%d (%s) status %d\n",
1313                         gpio, label ? : "?", status);
1314         spin_unlock_irqrestore(&gpio_lock, flags);
1315         return status;
1316 }
1317 EXPORT_SYMBOL_GPL(gpio_request);
1318
1319 void gpio_free(unsigned gpio)
1320 {
1321         unsigned long           flags;
1322         struct gpio_desc        *desc;
1323         struct gpio_chip        *chip;
1324
1325         might_sleep();
1326
1327         if (!gpio_is_valid(gpio)) {
1328                 WARN_ON(extra_checks);
1329                 return;
1330         }
1331
1332         gpio_unexport(gpio);
1333
1334         spin_lock_irqsave(&gpio_lock, flags);
1335
1336         desc = &gpio_desc[gpio];
1337         chip = desc->chip;
1338         if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
1339                 if (chip->free) {
1340                         spin_unlock_irqrestore(&gpio_lock, flags);
1341                         might_sleep_if(chip->can_sleep);
1342                         chip->free(chip, gpio - chip->base);
1343                         spin_lock_irqsave(&gpio_lock, flags);
1344                 }
1345                 desc_set_label(desc, NULL);
1346                 module_put(desc->chip->owner);
1347                 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1348                 clear_bit(FLAG_REQUESTED, &desc->flags);
1349                 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1350                 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1351         } else
1352                 WARN_ON(extra_checks);
1353
1354         spin_unlock_irqrestore(&gpio_lock, flags);
1355 }
1356 EXPORT_SYMBOL_GPL(gpio_free);
1357
1358 /**
1359  * gpio_request_one - request a single GPIO with initial configuration
1360  * @gpio:       the GPIO number
1361  * @flags:      GPIO configuration as specified by GPIOF_*
1362  * @label:      a literal description string of this GPIO
1363  */
1364 int gpio_request_one(unsigned gpio, unsigned long flags, const char *label)
1365 {
1366         int err;
1367
1368         err = gpio_request(gpio, label);
1369         if (err)
1370                 return err;
1371
1372         if (flags & GPIOF_OPEN_DRAIN)
1373                 set_bit(FLAG_OPEN_DRAIN, &gpio_desc[gpio].flags);
1374
1375         if (flags & GPIOF_OPEN_SOURCE)
1376                 set_bit(FLAG_OPEN_SOURCE, &gpio_desc[gpio].flags);
1377
1378         if (flags & GPIOF_DIR_IN)
1379                 err = gpio_direction_input(gpio);
1380         else
1381                 err = gpio_direction_output(gpio,
1382                                 (flags & GPIOF_INIT_HIGH) ? 1 : 0);
1383
1384         if (err)
1385                 goto free_gpio;
1386
1387         if (flags & GPIOF_EXPORT) {
1388                 err = gpio_export(gpio, flags & GPIOF_EXPORT_CHANGEABLE);
1389                 if (err)
1390                         goto free_gpio;
1391         }
1392
1393         return 0;
1394
1395  free_gpio:
1396         gpio_free(gpio);
1397         return err;
1398 }
1399 EXPORT_SYMBOL_GPL(gpio_request_one);
1400
1401 /**
1402  * gpio_request_array - request multiple GPIOs in a single call
1403  * @array:      array of the 'struct gpio'
1404  * @num:        how many GPIOs in the array
1405  */
1406 int gpio_request_array(const struct gpio *array, size_t num)
1407 {
1408         int i, err;
1409
1410         for (i = 0; i < num; i++, array++) {
1411                 err = gpio_request_one(array->gpio, array->flags, array->label);
1412                 if (err)
1413                         goto err_free;
1414         }
1415         return 0;
1416
1417 err_free:
1418         while (i--)
1419                 gpio_free((--array)->gpio);
1420         return err;
1421 }
1422 EXPORT_SYMBOL_GPL(gpio_request_array);
1423
1424 /**
1425  * gpio_free_array - release multiple GPIOs in a single call
1426  * @array:      array of the 'struct gpio'
1427  * @num:        how many GPIOs in the array
1428  */
1429 void gpio_free_array(const struct gpio *array, size_t num)
1430 {
1431         while (num--)
1432                 gpio_free((array++)->gpio);
1433 }
1434 EXPORT_SYMBOL_GPL(gpio_free_array);
1435
1436 /**
1437  * gpiochip_is_requested - return string iff signal was requested
1438  * @chip: controller managing the signal
1439  * @offset: of signal within controller's 0..(ngpio - 1) range
1440  *
1441  * Returns NULL if the GPIO is not currently requested, else a string.
1442  * If debugfs support is enabled, the string returned is the label passed
1443  * to gpio_request(); otherwise it is a meaningless constant.
1444  *
1445  * This function is for use by GPIO controller drivers.  The label can
1446  * help with diagnostics, and knowing that the signal is used as a GPIO
1447  * can help avoid accidentally multiplexing it to another controller.
1448  */
1449 const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
1450 {
1451         unsigned gpio = chip->base + offset;
1452
1453         if (!gpio_is_valid(gpio) || gpio_desc[gpio].chip != chip)
1454                 return NULL;
1455         if (test_bit(FLAG_REQUESTED, &gpio_desc[gpio].flags) == 0)
1456                 return NULL;
1457 #ifdef CONFIG_DEBUG_FS
1458         return gpio_desc[gpio].label;
1459 #else
1460         return "?";
1461 #endif
1462 }
1463 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
1464
1465
1466 /* Drivers MUST set GPIO direction before making get/set calls.  In
1467  * some cases this is done in early boot, before IRQs are enabled.
1468  *
1469  * As a rule these aren't called more than once (except for drivers
1470  * using the open-drain emulation idiom) so these are natural places
1471  * to accumulate extra debugging checks.  Note that we can't (yet)
1472  * rely on gpio_request() having been called beforehand.
1473  */
1474
1475 int gpio_direction_input(unsigned gpio)
1476 {
1477         unsigned long           flags;
1478         struct gpio_chip        *chip;
1479         struct gpio_desc        *desc = &gpio_desc[gpio];
1480         int                     status = -EINVAL;
1481
1482         spin_lock_irqsave(&gpio_lock, flags);
1483
1484         if (!gpio_is_valid(gpio))
1485                 goto fail;
1486         chip = desc->chip;
1487         if (!chip || !chip->get || !chip->direction_input)
1488                 goto fail;
1489         gpio -= chip->base;
1490         if (gpio >= chip->ngpio)
1491                 goto fail;
1492         status = gpio_ensure_requested(desc, gpio);
1493         if (status < 0)
1494                 goto fail;
1495
1496         /* now we know the gpio is valid and chip won't vanish */
1497
1498         spin_unlock_irqrestore(&gpio_lock, flags);
1499
1500         might_sleep_if(chip->can_sleep);
1501
1502         if (status) {
1503                 status = chip->request(chip, gpio);
1504                 if (status < 0) {
1505                         pr_debug("GPIO-%d: chip request fail, %d\n",
1506                                 chip->base + gpio, status);
1507                         /* and it's not available to anyone else ...
1508                          * gpio_request() is the fully clean solution.
1509                          */
1510                         goto lose;
1511                 }
1512         }
1513
1514         status = chip->direction_input(chip, gpio);
1515         if (status == 0)
1516                 clear_bit(FLAG_IS_OUT, &desc->flags);
1517
1518         trace_gpio_direction(chip->base + gpio, 1, status);
1519 lose:
1520         return status;
1521 fail:
1522         spin_unlock_irqrestore(&gpio_lock, flags);
1523         if (status)
1524                 pr_debug("%s: gpio-%d status %d\n",
1525                         __func__, gpio, status);
1526         return status;
1527 }
1528 EXPORT_SYMBOL_GPL(gpio_direction_input);
1529
1530 int gpio_direction_output(unsigned gpio, int value)
1531 {
1532         unsigned long           flags;
1533         struct gpio_chip        *chip;
1534         struct gpio_desc        *desc = &gpio_desc[gpio];
1535         int                     status = -EINVAL;
1536
1537         /* Open drain pin should not be driven to 1 */
1538         if (value && test_bit(FLAG_OPEN_DRAIN,  &desc->flags))
1539                 return gpio_direction_input(gpio);
1540
1541         /* Open source pin should not be driven to 0 */
1542         if (!value && test_bit(FLAG_OPEN_SOURCE,  &desc->flags))
1543                 return gpio_direction_input(gpio);
1544
1545         spin_lock_irqsave(&gpio_lock, flags);
1546
1547         if (!gpio_is_valid(gpio))
1548                 goto fail;
1549         chip = desc->chip;
1550         if (!chip || !chip->set || !chip->direction_output)
1551                 goto fail;
1552         gpio -= chip->base;
1553         if (gpio >= chip->ngpio)
1554                 goto fail;
1555         status = gpio_ensure_requested(desc, gpio);
1556         if (status < 0)
1557                 goto fail;
1558
1559         /* now we know the gpio is valid and chip won't vanish */
1560
1561         spin_unlock_irqrestore(&gpio_lock, flags);
1562
1563         might_sleep_if(chip->can_sleep);
1564
1565         if (status) {
1566                 status = chip->request(chip, gpio);
1567                 if (status < 0) {
1568                         pr_debug("GPIO-%d: chip request fail, %d\n",
1569                                 chip->base + gpio, status);
1570                         /* and it's not available to anyone else ...
1571                          * gpio_request() is the fully clean solution.
1572                          */
1573                         goto lose;
1574                 }
1575         }
1576
1577         status = chip->direction_output(chip, gpio, value);
1578         if (status == 0)
1579                 set_bit(FLAG_IS_OUT, &desc->flags);
1580         trace_gpio_value(chip->base + gpio, 0, value);
1581         trace_gpio_direction(chip->base + gpio, 0, status);
1582 lose:
1583         return status;
1584 fail:
1585         spin_unlock_irqrestore(&gpio_lock, flags);
1586         if (status)
1587                 pr_debug("%s: gpio-%d status %d\n",
1588                         __func__, gpio, status);
1589         return status;
1590 }
1591 EXPORT_SYMBOL_GPL(gpio_direction_output);
1592
1593 /**
1594  * gpio_set_debounce - sets @debounce time for a @gpio
1595  * @gpio: the gpio to set debounce time
1596  * @debounce: debounce time is microseconds
1597  */
1598 int gpio_set_debounce(unsigned gpio, unsigned debounce)
1599 {
1600         unsigned long           flags;
1601         struct gpio_chip        *chip;
1602         struct gpio_desc        *desc = &gpio_desc[gpio];
1603         int                     status = -EINVAL;
1604
1605         spin_lock_irqsave(&gpio_lock, flags);
1606
1607         if (!gpio_is_valid(gpio))
1608                 goto fail;
1609         chip = desc->chip;
1610         if (!chip || !chip->set || !chip->set_debounce)
1611                 goto fail;
1612         gpio -= chip->base;
1613         if (gpio >= chip->ngpio)
1614                 goto fail;
1615         status = gpio_ensure_requested(desc, gpio);
1616         if (status < 0)
1617                 goto fail;
1618
1619         /* now we know the gpio is valid and chip won't vanish */
1620
1621         spin_unlock_irqrestore(&gpio_lock, flags);
1622
1623         might_sleep_if(chip->can_sleep);
1624
1625         return chip->set_debounce(chip, gpio, debounce);
1626
1627 fail:
1628         spin_unlock_irqrestore(&gpio_lock, flags);
1629         if (status)
1630                 pr_debug("%s: gpio-%d status %d\n",
1631                         __func__, gpio, status);
1632
1633         return status;
1634 }
1635 EXPORT_SYMBOL_GPL(gpio_set_debounce);
1636
1637 /* I/O calls are only valid after configuration completed; the relevant
1638  * "is this a valid GPIO" error checks should already have been done.
1639  *
1640  * "Get" operations are often inlinable as reading a pin value register,
1641  * and masking the relevant bit in that register.
1642  *
1643  * When "set" operations are inlinable, they involve writing that mask to
1644  * one register to set a low value, or a different register to set it high.
1645  * Otherwise locking is needed, so there may be little value to inlining.
1646  *
1647  *------------------------------------------------------------------------
1648  *
1649  * IMPORTANT!!!  The hot paths -- get/set value -- assume that callers
1650  * have requested the GPIO.  That can include implicit requesting by
1651  * a direction setting call.  Marking a gpio as requested locks its chip
1652  * in memory, guaranteeing that these table lookups need no more locking
1653  * and that gpiochip_remove() will fail.
1654  *
1655  * REVISIT when debugging, consider adding some instrumentation to ensure
1656  * that the GPIO was actually requested.
1657  */
1658
1659 /**
1660  * __gpio_get_value() - return a gpio's value
1661  * @gpio: gpio whose value will be returned
1662  * Context: any
1663  *
1664  * This is used directly or indirectly to implement gpio_get_value().
1665  * It returns the zero or nonzero value provided by the associated
1666  * gpio_chip.get() method; or zero if no such method is provided.
1667  */
1668 int __gpio_get_value(unsigned gpio)
1669 {
1670         struct gpio_chip        *chip;
1671         int value;
1672
1673         chip = gpio_to_chip(gpio);
1674         /* Should be using gpio_get_value_cansleep() */
1675         WARN_ON(chip->can_sleep);
1676         value = chip->get ? chip->get(chip, gpio - chip->base) : 0;
1677         trace_gpio_value(gpio, 1, value);
1678         return value;
1679 }
1680 EXPORT_SYMBOL_GPL(__gpio_get_value);
1681
1682 /*
1683  *  _gpio_set_open_drain_value() - Set the open drain gpio's value.
1684  * @gpio: Gpio whose state need to be set.
1685  * @chip: Gpio chip.
1686  * @value: Non-zero for setting it HIGH otherise it will set to LOW.
1687  */
1688 static void _gpio_set_open_drain_value(unsigned gpio,
1689                         struct gpio_chip *chip, int value)
1690 {
1691         int err = 0;
1692         if (value) {
1693                 err = chip->direction_input(chip, gpio - chip->base);
1694                 if (!err)
1695                         clear_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
1696         } else {
1697                 err = chip->direction_output(chip, gpio - chip->base, 0);
1698                 if (!err)
1699                         set_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
1700         }
1701         trace_gpio_direction(gpio, value, err);
1702         if (err < 0)
1703                 pr_err("%s: Error in set_value for open drain gpio%d err %d\n",
1704                                         __func__, gpio, err);
1705 }
1706
1707 /*
1708  *  _gpio_set_open_source() - Set the open source gpio's value.
1709  * @gpio: Gpio whose state need to be set.
1710  * @chip: Gpio chip.
1711  * @value: Non-zero for setting it HIGH otherise it will set to LOW.
1712  */
1713 static void _gpio_set_open_source_value(unsigned gpio,
1714                         struct gpio_chip *chip, int value)
1715 {
1716         int err = 0;
1717         if (value) {
1718                 err = chip->direction_output(chip, gpio - chip->base, 1);
1719                 if (!err)
1720                         set_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
1721         } else {
1722                 err = chip->direction_input(chip, gpio - chip->base);
1723                 if (!err)
1724                         clear_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
1725         }
1726         trace_gpio_direction(gpio, !value, err);
1727         if (err < 0)
1728                 pr_err("%s: Error in set_value for open source gpio%d err %d\n",
1729                                         __func__, gpio, err);
1730 }
1731
1732
1733 /**
1734  * __gpio_set_value() - assign a gpio's value
1735  * @gpio: gpio whose value will be assigned
1736  * @value: value to assign
1737  * Context: any
1738  *
1739  * This is used directly or indirectly to implement gpio_set_value().
1740  * It invokes the associated gpio_chip.set() method.
1741  */
1742 void __gpio_set_value(unsigned gpio, int value)
1743 {
1744         struct gpio_chip        *chip;
1745
1746         chip = gpio_to_chip(gpio);
1747         /* Should be using gpio_set_value_cansleep() */
1748         WARN_ON(chip->can_sleep);
1749         trace_gpio_value(gpio, 0, value);
1750         if (test_bit(FLAG_OPEN_DRAIN,  &gpio_desc[gpio].flags))
1751                 _gpio_set_open_drain_value(gpio, chip, value);
1752         else if (test_bit(FLAG_OPEN_SOURCE,  &gpio_desc[gpio].flags))
1753                 _gpio_set_open_source_value(gpio, chip, value);
1754         else
1755                 chip->set(chip, gpio - chip->base, value);
1756 }
1757 EXPORT_SYMBOL_GPL(__gpio_set_value);
1758
1759 /**
1760  * __gpio_cansleep() - report whether gpio value access will sleep
1761  * @gpio: gpio in question
1762  * Context: any
1763  *
1764  * This is used directly or indirectly to implement gpio_cansleep().  It
1765  * returns nonzero if access reading or writing the GPIO value can sleep.
1766  */
1767 int __gpio_cansleep(unsigned gpio)
1768 {
1769         struct gpio_chip        *chip;
1770
1771         /* only call this on GPIOs that are valid! */
1772         chip = gpio_to_chip(gpio);
1773
1774         return chip->can_sleep;
1775 }
1776 EXPORT_SYMBOL_GPL(__gpio_cansleep);
1777
1778 /**
1779  * __gpio_to_irq() - return the IRQ corresponding to a GPIO
1780  * @gpio: gpio whose IRQ will be returned (already requested)
1781  * Context: any
1782  *
1783  * This is used directly or indirectly to implement gpio_to_irq().
1784  * It returns the number of the IRQ signaled by this (input) GPIO,
1785  * or a negative errno.
1786  */
1787 int __gpio_to_irq(unsigned gpio)
1788 {
1789         struct gpio_chip        *chip;
1790
1791         chip = gpio_to_chip(gpio);
1792         return chip->to_irq ? chip->to_irq(chip, gpio - chip->base) : -ENXIO;
1793 }
1794 EXPORT_SYMBOL_GPL(__gpio_to_irq);
1795
1796
1797
1798 /* There's no value in making it easy to inline GPIO calls that may sleep.
1799  * Common examples include ones connected to I2C or SPI chips.
1800  */
1801
1802 int gpio_get_value_cansleep(unsigned gpio)
1803 {
1804         struct gpio_chip        *chip;
1805         int value;
1806
1807         might_sleep_if(extra_checks);
1808         chip = gpio_to_chip(gpio);
1809         value = chip->get ? chip->get(chip, gpio - chip->base) : 0;
1810         trace_gpio_value(gpio, 1, value);
1811         return value;
1812 }
1813 EXPORT_SYMBOL_GPL(gpio_get_value_cansleep);
1814
1815 void gpio_set_value_cansleep(unsigned gpio, int value)
1816 {
1817         struct gpio_chip        *chip;
1818
1819         might_sleep_if(extra_checks);
1820         chip = gpio_to_chip(gpio);
1821         trace_gpio_value(gpio, 0, value);
1822         if (test_bit(FLAG_OPEN_DRAIN,  &gpio_desc[gpio].flags))
1823                 _gpio_set_open_drain_value(gpio, chip, value);
1824         else if (test_bit(FLAG_OPEN_SOURCE,  &gpio_desc[gpio].flags))
1825                 _gpio_set_open_source_value(gpio, chip, value);
1826         else
1827                 chip->set(chip, gpio - chip->base, value);
1828 }
1829 EXPORT_SYMBOL_GPL(gpio_set_value_cansleep);
1830
1831
1832 #ifdef CONFIG_DEBUG_FS
1833
1834 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_chip *chip)
1835 {
1836         unsigned                i;
1837         unsigned                gpio = chip->base;
1838         struct gpio_desc        *gdesc = &gpio_desc[gpio];
1839         int                     is_out;
1840
1841         for (i = 0; i < chip->ngpio; i++, gpio++, gdesc++) {
1842                 if (!test_bit(FLAG_REQUESTED, &gdesc->flags))
1843                         continue;
1844
1845                 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
1846                 seq_printf(s, " gpio-%-3d (%-20.20s) %s %s",
1847                         gpio, gdesc->label,
1848                         is_out ? "out" : "in ",
1849                         chip->get
1850                                 ? (chip->get(chip, i) ? "hi" : "lo")
1851                                 : "?  ");
1852                 seq_printf(s, "\n");
1853         }
1854 }
1855
1856 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
1857 {
1858         struct gpio_chip *chip = NULL;
1859         unsigned int gpio;
1860         void *ret = NULL;
1861         loff_t index = 0;
1862
1863         /* REVISIT this isn't locked against gpio_chip removal ... */
1864
1865         for (gpio = 0; gpio_is_valid(gpio); gpio++) {
1866                 if (gpio_desc[gpio].chip == chip)
1867                         continue;
1868
1869                 chip = gpio_desc[gpio].chip;
1870                 if (!chip)
1871                         continue;
1872
1873                 if (index++ >= *pos) {
1874                         ret = chip;
1875                         break;
1876                 }
1877         }
1878
1879         s->private = "";
1880
1881         return ret;
1882 }
1883
1884 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
1885 {
1886         struct gpio_chip *chip = v;
1887         unsigned int gpio;
1888         void *ret = NULL;
1889
1890         /* skip GPIOs provided by the current chip */
1891         for (gpio = chip->base + chip->ngpio; gpio_is_valid(gpio); gpio++) {
1892                 chip = gpio_desc[gpio].chip;
1893                 if (chip) {
1894                         ret = chip;
1895                         break;
1896                 }
1897         }
1898
1899         s->private = "\n";
1900         ++*pos;
1901
1902         return ret;
1903 }
1904
1905 static void gpiolib_seq_stop(struct seq_file *s, void *v)
1906 {
1907 }
1908
1909 static int gpiolib_seq_show(struct seq_file *s, void *v)
1910 {
1911         struct gpio_chip *chip = v;
1912         struct device *dev;
1913
1914         seq_printf(s, "%sGPIOs %d-%d", (char *)s->private,
1915                         chip->base, chip->base + chip->ngpio - 1);
1916         dev = chip->dev;
1917         if (dev)
1918                 seq_printf(s, ", %s/%s", dev->bus ? dev->bus->name : "no-bus",
1919                         dev_name(dev));
1920         if (chip->label)
1921                 seq_printf(s, ", %s", chip->label);
1922         if (chip->can_sleep)
1923                 seq_printf(s, ", can sleep");
1924         seq_printf(s, ":\n");
1925
1926         if (chip->dbg_show)
1927                 chip->dbg_show(s, chip);
1928         else
1929                 gpiolib_dbg_show(s, chip);
1930
1931         return 0;
1932 }
1933
1934 static const struct seq_operations gpiolib_seq_ops = {
1935         .start = gpiolib_seq_start,
1936         .next = gpiolib_seq_next,
1937         .stop = gpiolib_seq_stop,
1938         .show = gpiolib_seq_show,
1939 };
1940
1941 static int gpiolib_open(struct inode *inode, struct file *file)
1942 {
1943         return seq_open(file, &gpiolib_seq_ops);
1944 }
1945
1946 static const struct file_operations gpiolib_operations = {
1947         .owner          = THIS_MODULE,
1948         .open           = gpiolib_open,
1949         .read           = seq_read,
1950         .llseek         = seq_lseek,
1951         .release        = seq_release,
1952 };
1953
1954 static int __init gpiolib_debugfs_init(void)
1955 {
1956         /* /sys/kernel/debug/gpio */
1957         (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
1958                                 NULL, NULL, &gpiolib_operations);
1959         return 0;
1960 }
1961 subsys_initcall(gpiolib_debugfs_init);
1962
1963 #endif  /* DEBUG_FS */