drivers/gpio/gpiolib.c

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