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