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