64e19505fc7252a87ab2b69f014beab6eced8531
[pandora-kernel.git] / 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 const 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 const DEVICE_ATTR(active_low, 0644,
544                 gpio_active_low_show, gpio_active_low_store);
545
546 static const struct attribute *gpio_attrs[] = {
547         &dev_attr_value.attr,
548         &dev_attr_active_low.attr,
549         NULL,
550 };
551
552 static const struct attribute_group gpio_attr_group = {
553         .attrs = (struct attribute **) gpio_attrs,
554 };
555
556 /*
557  * /sys/class/gpio/gpiochipN/
558  *   /base ... matching gpio_chip.base (N)
559  *   /label ... matching gpio_chip.label
560  *   /ngpio ... matching gpio_chip.ngpio
561  */
562
563 static ssize_t chip_base_show(struct device *dev,
564                                struct device_attribute *attr, char *buf)
565 {
566         const struct gpio_chip  *chip = dev_get_drvdata(dev);
567
568         return sprintf(buf, "%d\n", chip->base);
569 }
570 static DEVICE_ATTR(base, 0444, chip_base_show, NULL);
571
572 static ssize_t chip_label_show(struct device *dev,
573                                struct device_attribute *attr, char *buf)
574 {
575         const struct gpio_chip  *chip = dev_get_drvdata(dev);
576
577         return sprintf(buf, "%s\n", chip->label ? : "");
578 }
579 static DEVICE_ATTR(label, 0444, chip_label_show, NULL);
580
581 static ssize_t chip_ngpio_show(struct device *dev,
582                                struct device_attribute *attr, char *buf)
583 {
584         const struct gpio_chip  *chip = dev_get_drvdata(dev);
585
586         return sprintf(buf, "%u\n", chip->ngpio);
587 }
588 static DEVICE_ATTR(ngpio, 0444, chip_ngpio_show, NULL);
589
590 static struct attribute *gpiochip_attrs[] = {
591         &dev_attr_base.attr,
592         &dev_attr_label.attr,
593         &dev_attr_ngpio.attr,
594         NULL,
595 };
596 ATTRIBUTE_GROUPS(gpiochip);
597
598 /*
599  * /sys/class/gpio/export ... write-only
600  *      integer N ... number of GPIO to export (full access)
601  * /sys/class/gpio/unexport ... write-only
602  *      integer N ... number of GPIO to unexport
603  */
604 static ssize_t export_store(struct class *class,
605                                 struct class_attribute *attr,
606                                 const char *buf, size_t len)
607 {
608         long    gpio;
609         int     status;
610
611         status = strict_strtol(buf, 0, &gpio);
612         if (status < 0)
613                 goto done;
614
615         /* No extra locking here; FLAG_SYSFS just signifies that the
616          * request and export were done by on behalf of userspace, so
617          * they may be undone on its behalf too.
618          */
619
620         status = gpio_request(gpio, "sysfs");
621         if (status < 0)
622                 goto done;
623
624         status = gpio_export(gpio, true);
625         if (status < 0)
626                 gpio_free(gpio);
627         else
628                 set_bit(FLAG_SYSFS, &gpio_desc[gpio].flags);
629
630 done:
631         if (status)
632                 pr_debug("%s: status %d\n", __func__, status);
633         return status ? : len;
634 }
635
636 static ssize_t unexport_store(struct class *class,
637                                 struct class_attribute *attr,
638                                 const char *buf, size_t len)
639 {
640         long    gpio;
641         int     status;
642
643         status = strict_strtol(buf, 0, &gpio);
644         if (status < 0)
645                 goto done;
646
647         status = -EINVAL;
648
649         /* reject bogus commands (gpio_unexport ignores them) */
650         if (!gpio_is_valid(gpio))
651                 goto done;
652
653         /* No extra locking here; FLAG_SYSFS just signifies that the
654          * request and export were done by on behalf of userspace, so
655          * they may be undone on its behalf too.
656          */
657         if (test_and_clear_bit(FLAG_SYSFS, &gpio_desc[gpio].flags)) {
658                 status = 0;
659                 gpio_free(gpio);
660         }
661 done:
662         if (status)
663                 pr_debug("%s: status %d\n", __func__, status);
664         return status ? : len;
665 }
666
667 static struct class_attribute gpio_class_attrs[] = {
668         __ATTR(export, 0200, NULL, export_store),
669         __ATTR(unexport, 0200, NULL, unexport_store),
670         __ATTR_NULL,
671 };
672
673 static struct class gpio_class = {
674         .name =         "gpio",
675         .owner =        THIS_MODULE,
676
677         .class_attrs =  gpio_class_attrs,
678 };
679
680
681 /**
682  * gpio_export - export a GPIO through sysfs
683  * @gpio: gpio to make available, already requested
684  * @direction_may_change: true if userspace may change gpio direction
685  * Context: arch_initcall or later
686  *
687  * When drivers want to make a GPIO accessible to userspace after they
688  * have requested it -- perhaps while debugging, or as part of their
689  * public interface -- they may use this routine.  If the GPIO can
690  * change direction (some can't) and the caller allows it, userspace
691  * will see "direction" sysfs attribute which may be used to change
692  * the gpio's direction.  A "value" attribute will always be provided.
693  *
694  * Returns zero on success, else an error.
695  */
696 int gpio_export(unsigned gpio, bool direction_may_change)
697 {
698         unsigned long           flags;
699         struct gpio_desc        *desc;
700         int                     status;
701         const char              *ioname = NULL;
702         struct device           *dev;
703
704         /* can't export until sysfs is available ... */
705         if (!gpio_class.p) {
706                 pr_debug("%s: called too early!\n", __func__);
707                 return -ENOENT;
708         }
709
710         if (!gpio_is_valid(gpio)) {
711                 pr_debug("%s: gpio %d is not valid\n", __func__, gpio);
712                 return -EINVAL;
713         }
714
715         mutex_lock(&sysfs_lock);
716
717         spin_lock_irqsave(&gpio_lock, flags);
718         desc = &gpio_desc[gpio];
719         if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
720              test_bit(FLAG_EXPORT, &desc->flags)) {
721                 spin_unlock_irqrestore(&gpio_lock, flags);
722                 pr_debug("%s: gpio %d unavailable (requested=%d, exported=%d)\n",
723                                 __func__, gpio,
724                                 test_bit(FLAG_REQUESTED, &desc->flags),
725                                 test_bit(FLAG_EXPORT, &desc->flags));
726                 return -EPERM;
727         }
728
729         if (!desc->chip->direction_input || !desc->chip->direction_output)
730                 direction_may_change = false;
731         spin_unlock_irqrestore(&gpio_lock, flags);
732
733         if (desc->chip->names && desc->chip->names[gpio - desc->chip->base])
734                 ioname = desc->chip->names[gpio - desc->chip->base];
735
736         dev = device_create(&gpio_class, desc->chip->dev, MKDEV(0, 0),
737                             desc, ioname ? ioname : "gpio%u", gpio);
738         if (IS_ERR(dev)) {
739                 status = PTR_ERR(dev);
740                 goto fail_unlock;
741         }
742
743         status = sysfs_create_group(&dev->kobj, &gpio_attr_group);
744         if (status)
745                 goto fail_unregister_device;
746
747         if (direction_may_change) {
748                 status = device_create_file(dev, &dev_attr_direction);
749                 if (status)
750                         goto fail_unregister_device;
751         }
752
753         if (gpio_to_irq(gpio) >= 0 && (direction_may_change ||
754                                        !test_bit(FLAG_IS_OUT, &desc->flags))) {
755                 status = device_create_file(dev, &dev_attr_edge);
756                 if (status)
757                         goto fail_unregister_device;
758         }
759
760         set_bit(FLAG_EXPORT, &desc->flags);
761         mutex_unlock(&sysfs_lock);
762         return 0;
763
764 fail_unregister_device:
765         device_unregister(dev);
766 fail_unlock:
767         mutex_unlock(&sysfs_lock);
768         pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
769         return status;
770 }
771 EXPORT_SYMBOL_GPL(gpio_export);
772
773 static int match_export(struct device *dev, void *data)
774 {
775         return dev_get_drvdata(dev) == data;
776 }
777
778 /**
779  * gpio_export_link - create a sysfs link to an exported GPIO node
780  * @dev: device under which to create symlink
781  * @name: name of the symlink
782  * @gpio: gpio to create symlink to, already exported
783  *
784  * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
785  * node. Caller is responsible for unlinking.
786  *
787  * Returns zero on success, else an error.
788  */
789 int gpio_export_link(struct device *dev, const char *name, unsigned gpio)
790 {
791         struct gpio_desc        *desc;
792         int                     status = -EINVAL;
793
794         if (!gpio_is_valid(gpio))
795                 goto done;
796
797         mutex_lock(&sysfs_lock);
798
799         desc = &gpio_desc[gpio];
800
801         if (test_bit(FLAG_EXPORT, &desc->flags)) {
802                 struct device *tdev;
803
804                 tdev = class_find_device(&gpio_class, NULL, desc, match_export);
805                 if (tdev != NULL) {
806                         status = sysfs_create_link(&dev->kobj, &tdev->kobj,
807                                                 name);
808                 } else {
809                         status = -ENODEV;
810                 }
811         }
812
813         mutex_unlock(&sysfs_lock);
814
815 done:
816         if (status)
817                 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
818
819         return status;
820 }
821 EXPORT_SYMBOL_GPL(gpio_export_link);
822
823
824 /**
825  * gpio_sysfs_set_active_low - set the polarity of gpio sysfs value
826  * @gpio: gpio to change
827  * @value: non-zero to use active low, i.e. inverted values
828  *
829  * Set the polarity of /sys/class/gpio/gpioN/value sysfs attribute.
830  * The GPIO does not have to be exported yet.  If poll(2) support has
831  * been enabled for either rising or falling edge, it will be
832  * reconfigured to follow the new polarity.
833  *
834  * Returns zero on success, else an error.
835  */
836 int gpio_sysfs_set_active_low(unsigned gpio, int value)
837 {
838         struct gpio_desc        *desc;
839         struct device           *dev = NULL;
840         int                     status = -EINVAL;
841
842         if (!gpio_is_valid(gpio))
843                 goto done;
844
845         mutex_lock(&sysfs_lock);
846
847         desc = &gpio_desc[gpio];
848
849         if (test_bit(FLAG_EXPORT, &desc->flags)) {
850                 dev = class_find_device(&gpio_class, NULL, desc, match_export);
851                 if (dev == NULL) {
852                         status = -ENODEV;
853                         goto unlock;
854                 }
855         }
856
857         status = sysfs_set_active_low(desc, dev, value);
858
859 unlock:
860         mutex_unlock(&sysfs_lock);
861
862 done:
863         if (status)
864                 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
865
866         return status;
867 }
868 EXPORT_SYMBOL_GPL(gpio_sysfs_set_active_low);
869
870 /**
871  * gpio_unexport - reverse effect of gpio_export()
872  * @gpio: gpio to make unavailable
873  *
874  * This is implicit on gpio_free().
875  */
876 void gpio_unexport(unsigned gpio)
877 {
878         struct gpio_desc        *desc;
879         int                     status = 0;
880         struct device           *dev = NULL;
881
882         if (!gpio_is_valid(gpio)) {
883                 status = -EINVAL;
884                 goto done;
885         }
886
887         mutex_lock(&sysfs_lock);
888
889         desc = &gpio_desc[gpio];
890
891         if (test_bit(FLAG_EXPORT, &desc->flags)) {
892
893                 dev = class_find_device(&gpio_class, NULL, desc, match_export);
894                 if (dev) {
895                         gpio_setup_irq(desc, dev, 0);
896                         clear_bit(FLAG_EXPORT, &desc->flags);
897                 } else
898                         status = -ENODEV;
899         }
900
901         mutex_unlock(&sysfs_lock);
902         if (dev) {
903                 device_unregister(dev);
904                 put_device(dev);
905         }
906 done:
907         if (status)
908                 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
909 }
910 EXPORT_SYMBOL_GPL(gpio_unexport);
911
912 static int gpiochip_export(struct gpio_chip *chip)
913 {
914         int             status;
915         struct device   *dev;
916
917         /* Many systems register gpio chips for SOC support very early,
918          * before driver model support is available.  In those cases we
919          * export this later, in gpiolib_sysfs_init() ... here we just
920          * verify that _some_ field of gpio_class got initialized.
921          */
922         if (!gpio_class.p)
923                 return 0;
924
925         /* use chip->base for the ID; it's already known to be unique */
926         mutex_lock(&sysfs_lock);
927         dev = device_create_with_groups(&gpio_class, chip->dev, MKDEV(0, 0),
928                                         chip, gpiochip_groups,
929                                         "gpiochip%d", chip->base);
930         if (IS_ERR(dev))
931                 status = PTR_ERR(dev);
932         else
933                 status = 0;
934         chip->exported = (status == 0);
935         mutex_unlock(&sysfs_lock);
936
937         if (status) {
938                 unsigned long   flags;
939                 unsigned        gpio;
940
941                 spin_lock_irqsave(&gpio_lock, flags);
942                 gpio = chip->base;
943                 while (gpio_desc[gpio].chip == chip)
944                         gpio_desc[gpio++].chip = NULL;
945                 spin_unlock_irqrestore(&gpio_lock, flags);
946
947                 pr_debug("%s: chip %s status %d\n", __func__,
948                                 chip->label, status);
949         }
950
951         return status;
952 }
953
954 static void gpiochip_unexport(struct gpio_chip *chip)
955 {
956         int                     status;
957         struct device           *dev;
958
959         mutex_lock(&sysfs_lock);
960         dev = class_find_device(&gpio_class, NULL, chip, match_export);
961         if (dev) {
962                 put_device(dev);
963                 device_unregister(dev);
964                 chip->exported = 0;
965                 status = 0;
966         } else
967                 status = -ENODEV;
968         mutex_unlock(&sysfs_lock);
969
970         if (status)
971                 pr_debug("%s: chip %s status %d\n", __func__,
972                                 chip->label, status);
973 }
974
975 static int __init gpiolib_sysfs_init(void)
976 {
977         int             status;
978         unsigned long   flags;
979         unsigned        gpio;
980
981         status = class_register(&gpio_class);
982         if (status < 0)
983                 return status;
984
985         /* Scan and register the gpio_chips which registered very
986          * early (e.g. before the class_register above was called).
987          *
988          * We run before arch_initcall() so chip->dev nodes can have
989          * registered, and so arch_initcall() can always gpio_export().
990          */
991         spin_lock_irqsave(&gpio_lock, flags);
992         for (gpio = 0; gpio < ARCH_NR_GPIOS; gpio++) {
993                 struct gpio_chip        *chip;
994
995                 chip = gpio_desc[gpio].chip;
996                 if (!chip || chip->exported)
997                         continue;
998
999                 spin_unlock_irqrestore(&gpio_lock, flags);
1000                 status = gpiochip_export(chip);
1001                 spin_lock_irqsave(&gpio_lock, flags);
1002         }
1003         spin_unlock_irqrestore(&gpio_lock, flags);
1004
1005
1006         return status;
1007 }
1008 postcore_initcall(gpiolib_sysfs_init);
1009
1010 #else
1011 static inline int gpiochip_export(struct gpio_chip *chip)
1012 {
1013         return 0;
1014 }
1015
1016 static inline void gpiochip_unexport(struct gpio_chip *chip)
1017 {
1018 }
1019
1020 #endif /* CONFIG_GPIO_SYSFS */
1021
1022 /**
1023  * gpiochip_add() - register a gpio_chip
1024  * @chip: the chip to register, with chip->base initialized
1025  * Context: potentially before irqs or kmalloc will work
1026  *
1027  * Returns a negative errno if the chip can't be registered, such as
1028  * because the chip->base is invalid or already associated with a
1029  * different chip.  Otherwise it returns zero as a success code.
1030  *
1031  * When gpiochip_add() is called very early during boot, so that GPIOs
1032  * can be freely used, the chip->dev device must be registered before
1033  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
1034  * for GPIOs will fail rudely.
1035  *
1036  * If chip->base is negative, this requests dynamic assignment of
1037  * a range of valid GPIOs.
1038  */
1039 int gpiochip_add(struct gpio_chip *chip)
1040 {
1041         unsigned long   flags;
1042         int             status = 0;
1043         unsigned        id;
1044         int             base = chip->base;
1045
1046         if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
1047                         && base >= 0) {
1048                 status = -EINVAL;
1049                 goto fail;
1050         }
1051
1052         spin_lock_irqsave(&gpio_lock, flags);
1053
1054         if (base < 0) {
1055                 base = gpiochip_find_base(chip->ngpio);
1056                 if (base < 0) {
1057                         status = base;
1058                         goto unlock;
1059                 }
1060                 chip->base = base;
1061         }
1062
1063         /* these GPIO numbers must not be managed by another gpio_chip */
1064         for (id = base; id < base + chip->ngpio; id++) {
1065                 if (gpio_desc[id].chip != NULL) {
1066                         status = -EBUSY;
1067                         break;
1068                 }
1069         }
1070         if (status == 0) {
1071                 for (id = base; id < base + chip->ngpio; id++) {
1072                         gpio_desc[id].chip = chip;
1073
1074                         /* REVISIT:  most hardware initializes GPIOs as
1075                          * inputs (often with pullups enabled) so power
1076                          * usage is minimized.  Linux code should set the
1077                          * gpio direction first thing; but until it does,
1078                          * we may expose the wrong direction in sysfs.
1079                          */
1080                         gpio_desc[id].flags = !chip->direction_input
1081                                 ? (1 << FLAG_IS_OUT)
1082                                 : 0;
1083                 }
1084
1085                 of_gpiochip_add(chip);
1086         }
1087
1088 unlock:
1089         spin_unlock_irqrestore(&gpio_lock, flags);
1090
1091         if (status)
1092                 goto fail;
1093
1094         status = gpiochip_export(chip);
1095         if (status) {
1096                 of_gpiochip_remove(chip);
1097                 goto fail;
1098         }
1099
1100         return 0;
1101 fail:
1102         /* failures here can mean systems won't boot... */
1103         pr_err("gpiochip_add: gpios %d..%d (%s) failed to register\n",
1104                 chip->base, chip->base + chip->ngpio - 1,
1105                 chip->label ? : "generic");
1106         return status;
1107 }
1108 EXPORT_SYMBOL_GPL(gpiochip_add);
1109
1110 /**
1111  * gpiochip_remove() - unregister a gpio_chip
1112  * @chip: the chip to unregister
1113  *
1114  * A gpio_chip with any GPIOs still requested may not be removed.
1115  */
1116 int gpiochip_remove(struct gpio_chip *chip)
1117 {
1118         unsigned long   flags;
1119         int             status = 0;
1120         unsigned        id;
1121
1122         spin_lock_irqsave(&gpio_lock, flags);
1123
1124         of_gpiochip_remove(chip);
1125
1126         for (id = chip->base; id < chip->base + chip->ngpio; id++) {
1127                 if (test_bit(FLAG_REQUESTED, &gpio_desc[id].flags)) {
1128                         status = -EBUSY;
1129                         break;
1130                 }
1131         }
1132         if (status == 0) {
1133                 for (id = chip->base; id < chip->base + chip->ngpio; id++)
1134                         gpio_desc[id].chip = NULL;
1135         }
1136
1137         spin_unlock_irqrestore(&gpio_lock, flags);
1138
1139         if (status == 0)
1140                 gpiochip_unexport(chip);
1141
1142         return status;
1143 }
1144 EXPORT_SYMBOL_GPL(gpiochip_remove);
1145
1146 /**
1147  * gpiochip_find() - iterator for locating a specific gpio_chip
1148  * @data: data to pass to match function
1149  * @callback: Callback function to check gpio_chip
1150  *
1151  * Similar to bus_find_device.  It returns a reference to a gpio_chip as
1152  * determined by a user supplied @match callback.  The callback should return
1153  * 0 if the device doesn't match and non-zero if it does.  If the callback is
1154  * non-zero, this function will return to the caller and not iterate over any
1155  * more gpio_chips.
1156  */
1157 struct gpio_chip *gpiochip_find(void *data,
1158                                 int (*match)(struct gpio_chip *chip, void *data))
1159 {
1160         struct gpio_chip *chip = NULL;
1161         unsigned long flags;
1162         int i;
1163
1164         spin_lock_irqsave(&gpio_lock, flags);
1165         for (i = 0; i < ARCH_NR_GPIOS; i++) {
1166                 if (!gpio_desc[i].chip)
1167                         continue;
1168
1169                 if (match(gpio_desc[i].chip, data)) {
1170                         chip = gpio_desc[i].chip;
1171                         break;
1172                 }
1173         }
1174         spin_unlock_irqrestore(&gpio_lock, flags);
1175
1176         return chip;
1177 }
1178 EXPORT_SYMBOL_GPL(gpiochip_find);
1179
1180 /* These "optional" allocation calls help prevent drivers from stomping
1181  * on each other, and help provide better diagnostics in debugfs.
1182  * They're called even less than the "set direction" calls.
1183  */
1184 int gpio_request(unsigned gpio, const char *label)
1185 {
1186         struct gpio_desc        *desc;
1187         struct gpio_chip        *chip;
1188         int                     status = -EINVAL;
1189         unsigned long           flags;
1190
1191         spin_lock_irqsave(&gpio_lock, flags);
1192
1193         if (!gpio_is_valid(gpio))
1194                 goto done;
1195         desc = &gpio_desc[gpio];
1196         chip = desc->chip;
1197         if (chip == NULL)
1198                 goto done;
1199
1200         if (!try_module_get(chip->owner))
1201                 goto done;
1202
1203         /* NOTE:  gpio_request() can be called in early boot,
1204          * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1205          */
1206
1207         if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1208                 desc_set_label(desc, label ? : "?");
1209                 status = 0;
1210         } else {
1211                 status = -EBUSY;
1212                 module_put(chip->owner);
1213                 goto done;
1214         }
1215
1216         if (chip->request) {
1217                 /* chip->request may sleep */
1218                 spin_unlock_irqrestore(&gpio_lock, flags);
1219                 status = chip->request(chip, gpio - chip->base);
1220                 spin_lock_irqsave(&gpio_lock, flags);
1221
1222                 if (status < 0) {
1223                         desc_set_label(desc, NULL);
1224                         module_put(chip->owner);
1225                         clear_bit(FLAG_REQUESTED, &desc->flags);
1226                 }
1227         }
1228
1229 done:
1230         if (status)
1231                 pr_debug("gpio_request: gpio-%d (%s) status %d\n",
1232                         gpio, label ? : "?", status);
1233         spin_unlock_irqrestore(&gpio_lock, flags);
1234         return status;
1235 }
1236 EXPORT_SYMBOL_GPL(gpio_request);
1237
1238 void gpio_free(unsigned gpio)
1239 {
1240         unsigned long           flags;
1241         struct gpio_desc        *desc;
1242         struct gpio_chip        *chip;
1243
1244         might_sleep();
1245
1246         if (!gpio_is_valid(gpio)) {
1247                 WARN_ON(extra_checks);
1248                 return;
1249         }
1250
1251         gpio_unexport(gpio);
1252
1253         spin_lock_irqsave(&gpio_lock, flags);
1254
1255         desc = &gpio_desc[gpio];
1256         chip = desc->chip;
1257         if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
1258                 if (chip->free) {
1259                         spin_unlock_irqrestore(&gpio_lock, flags);
1260                         might_sleep_if(chip->can_sleep);
1261                         chip->free(chip, gpio - chip->base);
1262                         spin_lock_irqsave(&gpio_lock, flags);
1263                 }
1264                 desc_set_label(desc, NULL);
1265                 module_put(desc->chip->owner);
1266                 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1267                 clear_bit(FLAG_REQUESTED, &desc->flags);
1268         } else
1269                 WARN_ON(extra_checks);
1270
1271         spin_unlock_irqrestore(&gpio_lock, flags);
1272 }
1273 EXPORT_SYMBOL_GPL(gpio_free);
1274
1275 /**
1276  * gpio_request_one - request a single GPIO with initial configuration
1277  * @gpio:       the GPIO number
1278  * @flags:      GPIO configuration as specified by GPIOF_*
1279  * @label:      a literal description string of this GPIO
1280  */
1281 int gpio_request_one(unsigned gpio, unsigned long flags, const char *label)
1282 {
1283         int err;
1284
1285         err = gpio_request(gpio, label);
1286         if (err)
1287                 return err;
1288
1289         if (flags & GPIOF_DIR_IN)
1290                 err = gpio_direction_input(gpio);
1291         else
1292                 err = gpio_direction_output(gpio,
1293                                 (flags & GPIOF_INIT_HIGH) ? 1 : 0);
1294
1295         if (err)
1296                 gpio_free(gpio);
1297
1298         return err;
1299 }
1300 EXPORT_SYMBOL_GPL(gpio_request_one);
1301
1302 /**
1303  * gpio_request_array - request multiple GPIOs in a single call
1304  * @array:      array of the 'struct gpio'
1305  * @num:        how many GPIOs in the array
1306  */
1307 int gpio_request_array(const struct gpio *array, size_t num)
1308 {
1309         int i, err;
1310
1311         for (i = 0; i < num; i++, array++) {
1312                 err = gpio_request_one(array->gpio, array->flags, array->label);
1313                 if (err)
1314                         goto err_free;
1315         }
1316         return 0;
1317
1318 err_free:
1319         while (i--)
1320                 gpio_free((--array)->gpio);
1321         return err;
1322 }
1323 EXPORT_SYMBOL_GPL(gpio_request_array);
1324
1325 /**
1326  * gpio_free_array - release multiple GPIOs in a single call
1327  * @array:      array of the 'struct gpio'
1328  * @num:        how many GPIOs in the array
1329  */
1330 void gpio_free_array(const struct gpio *array, size_t num)
1331 {
1332         while (num--)
1333                 gpio_free((array++)->gpio);
1334 }
1335 EXPORT_SYMBOL_GPL(gpio_free_array);
1336
1337 /**
1338  * gpiochip_is_requested - return string iff signal was requested
1339  * @chip: controller managing the signal
1340  * @offset: of signal within controller's 0..(ngpio - 1) range
1341  *
1342  * Returns NULL if the GPIO is not currently requested, else a string.
1343  * If debugfs support is enabled, the string returned is the label passed
1344  * to gpio_request(); otherwise it is a meaningless constant.
1345  *
1346  * This function is for use by GPIO controller drivers.  The label can
1347  * help with diagnostics, and knowing that the signal is used as a GPIO
1348  * can help avoid accidentally multiplexing it to another controller.
1349  */
1350 const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
1351 {
1352         unsigned gpio = chip->base + offset;
1353
1354         if (!gpio_is_valid(gpio) || gpio_desc[gpio].chip != chip)
1355                 return NULL;
1356         if (test_bit(FLAG_REQUESTED, &gpio_desc[gpio].flags) == 0)
1357                 return NULL;
1358 #ifdef CONFIG_DEBUG_FS
1359         return gpio_desc[gpio].label;
1360 #else
1361         return "?";
1362 #endif
1363 }
1364 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
1365
1366
1367 /* Drivers MUST set GPIO direction before making get/set calls.  In
1368  * some cases this is done in early boot, before IRQs are enabled.
1369  *
1370  * As a rule these aren't called more than once (except for drivers
1371  * using the open-drain emulation idiom) so these are natural places
1372  * to accumulate extra debugging checks.  Note that we can't (yet)
1373  * rely on gpio_request() having been called beforehand.
1374  */
1375
1376 int gpio_direction_input(unsigned gpio)
1377 {
1378         unsigned long           flags;
1379         struct gpio_chip        *chip;
1380         struct gpio_desc        *desc = &gpio_desc[gpio];
1381         int                     status = -EINVAL;
1382
1383         spin_lock_irqsave(&gpio_lock, flags);
1384
1385         if (!gpio_is_valid(gpio))
1386                 goto fail;
1387         chip = desc->chip;
1388         if (!chip || !chip->get || !chip->direction_input)
1389                 goto fail;
1390         gpio -= chip->base;
1391         if (gpio >= chip->ngpio)
1392                 goto fail;
1393         status = gpio_ensure_requested(desc, gpio);
1394         if (status < 0)
1395                 goto fail;
1396
1397         /* now we know the gpio is valid and chip won't vanish */
1398
1399         spin_unlock_irqrestore(&gpio_lock, flags);
1400
1401         might_sleep_if(chip->can_sleep);
1402
1403         if (status) {
1404                 status = chip->request(chip, gpio);
1405                 if (status < 0) {
1406                         pr_debug("GPIO-%d: chip request fail, %d\n",
1407                                 chip->base + gpio, status);
1408                         /* and it's not available to anyone else ...
1409                          * gpio_request() is the fully clean solution.
1410                          */
1411                         goto lose;
1412                 }
1413         }
1414
1415         status = chip->direction_input(chip, gpio);
1416         if (status == 0)
1417                 clear_bit(FLAG_IS_OUT, &desc->flags);
1418
1419         trace_gpio_direction(chip->base + gpio, 1, status);
1420 lose:
1421         return status;
1422 fail:
1423         spin_unlock_irqrestore(&gpio_lock, flags);
1424         if (status)
1425                 pr_debug("%s: gpio-%d status %d\n",
1426                         __func__, gpio, status);
1427         return status;
1428 }
1429 EXPORT_SYMBOL_GPL(gpio_direction_input);
1430
1431 int gpio_direction_output(unsigned gpio, int value)
1432 {
1433         unsigned long           flags;
1434         struct gpio_chip        *chip;
1435         struct gpio_desc        *desc = &gpio_desc[gpio];
1436         int                     status = -EINVAL;
1437
1438         spin_lock_irqsave(&gpio_lock, flags);
1439
1440         if (!gpio_is_valid(gpio))
1441                 goto fail;
1442         chip = desc->chip;
1443         if (!chip || !chip->set || !chip->direction_output)
1444                 goto fail;
1445         gpio -= chip->base;
1446         if (gpio >= chip->ngpio)
1447                 goto fail;
1448         status = gpio_ensure_requested(desc, gpio);
1449         if (status < 0)
1450                 goto fail;
1451
1452         /* now we know the gpio is valid and chip won't vanish */
1453
1454         spin_unlock_irqrestore(&gpio_lock, flags);
1455
1456         might_sleep_if(chip->can_sleep);
1457
1458         if (status) {
1459                 status = chip->request(chip, gpio);
1460                 if (status < 0) {
1461                         pr_debug("GPIO-%d: chip request fail, %d\n",
1462                                 chip->base + gpio, status);
1463                         /* and it's not available to anyone else ...
1464                          * gpio_request() is the fully clean solution.
1465                          */
1466                         goto lose;
1467                 }
1468         }
1469
1470         status = chip->direction_output(chip, gpio, value);
1471         if (status == 0)
1472                 set_bit(FLAG_IS_OUT, &desc->flags);
1473         trace_gpio_value(chip->base + gpio, 0, value);
1474         trace_gpio_direction(chip->base + gpio, 0, status);
1475 lose:
1476         return status;
1477 fail:
1478         spin_unlock_irqrestore(&gpio_lock, flags);
1479         if (status)
1480                 pr_debug("%s: gpio-%d status %d\n",
1481                         __func__, gpio, status);
1482         return status;
1483 }
1484 EXPORT_SYMBOL_GPL(gpio_direction_output);
1485
1486 /**
1487  * gpio_set_debounce - sets @debounce time for a @gpio
1488  * @gpio: the gpio to set debounce time
1489  * @debounce: debounce time is microseconds
1490  */
1491 int gpio_set_debounce(unsigned gpio, unsigned debounce)
1492 {
1493         unsigned long           flags;
1494         struct gpio_chip        *chip;
1495         struct gpio_desc        *desc = &gpio_desc[gpio];
1496         int                     status = -EINVAL;
1497
1498         spin_lock_irqsave(&gpio_lock, flags);
1499
1500         if (!gpio_is_valid(gpio))
1501                 goto fail;
1502         chip = desc->chip;
1503         if (!chip || !chip->set || !chip->set_debounce)
1504                 goto fail;
1505         gpio -= chip->base;
1506         if (gpio >= chip->ngpio)
1507                 goto fail;
1508         status = gpio_ensure_requested(desc, gpio);
1509         if (status < 0)
1510                 goto fail;
1511
1512         /* now we know the gpio is valid and chip won't vanish */
1513
1514         spin_unlock_irqrestore(&gpio_lock, flags);
1515
1516         might_sleep_if(chip->can_sleep);
1517
1518         return chip->set_debounce(chip, gpio, debounce);
1519
1520 fail:
1521         spin_unlock_irqrestore(&gpio_lock, flags);
1522         if (status)
1523                 pr_debug("%s: gpio-%d status %d\n",
1524                         __func__, gpio, status);
1525
1526         return status;
1527 }
1528 EXPORT_SYMBOL_GPL(gpio_set_debounce);
1529
1530 /* I/O calls are only valid after configuration completed; the relevant
1531  * "is this a valid GPIO" error checks should already have been done.
1532  *
1533  * "Get" operations are often inlinable as reading a pin value register,
1534  * and masking the relevant bit in that register.
1535  *
1536  * When "set" operations are inlinable, they involve writing that mask to
1537  * one register to set a low value, or a different register to set it high.
1538  * Otherwise locking is needed, so there may be little value to inlining.
1539  *
1540  *------------------------------------------------------------------------
1541  *
1542  * IMPORTANT!!!  The hot paths -- get/set value -- assume that callers
1543  * have requested the GPIO.  That can include implicit requesting by
1544  * a direction setting call.  Marking a gpio as requested locks its chip
1545  * in memory, guaranteeing that these table lookups need no more locking
1546  * and that gpiochip_remove() will fail.
1547  *
1548  * REVISIT when debugging, consider adding some instrumentation to ensure
1549  * that the GPIO was actually requested.
1550  */
1551
1552 /**
1553  * __gpio_get_value() - return a gpio's value
1554  * @gpio: gpio whose value will be returned
1555  * Context: any
1556  *
1557  * This is used directly or indirectly to implement gpio_get_value().
1558  * It returns the zero or nonzero value provided by the associated
1559  * gpio_chip.get() method; or zero if no such method is provided.
1560  */
1561 int __gpio_get_value(unsigned gpio)
1562 {
1563         struct gpio_chip        *chip;
1564         int value;
1565
1566         chip = gpio_to_chip(gpio);
1567         WARN_ON(chip->can_sleep);
1568         value = chip->get ? chip->get(chip, gpio - chip->base) : 0;
1569         trace_gpio_value(gpio, 1, value);
1570         return value;
1571 }
1572 EXPORT_SYMBOL_GPL(__gpio_get_value);
1573
1574 /**
1575  * __gpio_set_value() - assign a gpio's value
1576  * @gpio: gpio whose value will be assigned
1577  * @value: value to assign
1578  * Context: any
1579  *
1580  * This is used directly or indirectly to implement gpio_set_value().
1581  * It invokes the associated gpio_chip.set() method.
1582  */
1583 void __gpio_set_value(unsigned gpio, int value)
1584 {
1585         struct gpio_chip        *chip;
1586
1587         chip = gpio_to_chip(gpio);
1588         WARN_ON(chip->can_sleep);
1589         trace_gpio_value(gpio, 0, value);
1590         chip->set(chip, gpio - chip->base, value);
1591 }
1592 EXPORT_SYMBOL_GPL(__gpio_set_value);
1593
1594 /**
1595  * __gpio_cansleep() - report whether gpio value access will sleep
1596  * @gpio: gpio in question
1597  * Context: any
1598  *
1599  * This is used directly or indirectly to implement gpio_cansleep().  It
1600  * returns nonzero if access reading or writing the GPIO value can sleep.
1601  */
1602 int __gpio_cansleep(unsigned gpio)
1603 {
1604         struct gpio_chip        *chip;
1605
1606         /* only call this on GPIOs that are valid! */
1607         chip = gpio_to_chip(gpio);
1608
1609         return chip->can_sleep;
1610 }
1611 EXPORT_SYMBOL_GPL(__gpio_cansleep);
1612
1613 /**
1614  * __gpio_to_irq() - return the IRQ corresponding to a GPIO
1615  * @gpio: gpio whose IRQ will be returned (already requested)
1616  * Context: any
1617  *
1618  * This is used directly or indirectly to implement gpio_to_irq().
1619  * It returns the number of the IRQ signaled by this (input) GPIO,
1620  * or a negative errno.
1621  */
1622 int __gpio_to_irq(unsigned gpio)
1623 {
1624         struct gpio_chip        *chip;
1625
1626         chip = gpio_to_chip(gpio);
1627         return chip->to_irq ? chip->to_irq(chip, gpio - chip->base) : -ENXIO;
1628 }
1629 EXPORT_SYMBOL_GPL(__gpio_to_irq);
1630
1631
1632
1633 /* There's no value in making it easy to inline GPIO calls that may sleep.
1634  * Common examples include ones connected to I2C or SPI chips.
1635  */
1636
1637 int gpio_get_value_cansleep(unsigned gpio)
1638 {
1639         struct gpio_chip        *chip;
1640         int value;
1641
1642         might_sleep_if(extra_checks);
1643         chip = gpio_to_chip(gpio);
1644         value = chip->get ? chip->get(chip, gpio - chip->base) : 0;
1645         trace_gpio_value(gpio, 1, value);
1646         return value;
1647 }
1648 EXPORT_SYMBOL_GPL(gpio_get_value_cansleep);
1649
1650 void gpio_set_value_cansleep(unsigned gpio, int value)
1651 {
1652         struct gpio_chip        *chip;
1653
1654         might_sleep_if(extra_checks);
1655         chip = gpio_to_chip(gpio);
1656         trace_gpio_value(gpio, 0, value);
1657         chip->set(chip, gpio - chip->base, value);
1658 }
1659 EXPORT_SYMBOL_GPL(gpio_set_value_cansleep);
1660
1661
1662 #ifdef CONFIG_DEBUG_FS
1663
1664 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_chip *chip)
1665 {
1666         unsigned                i;
1667         unsigned                gpio = chip->base;
1668         struct gpio_desc        *gdesc = &gpio_desc[gpio];
1669         int                     is_out;
1670
1671         for (i = 0; i < chip->ngpio; i++, gpio++, gdesc++) {
1672                 if (!test_bit(FLAG_REQUESTED, &gdesc->flags))
1673                         continue;
1674
1675                 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
1676                 seq_printf(s, " gpio-%-3d (%-20.20s) %s %s",
1677                         gpio, gdesc->label,
1678                         is_out ? "out" : "in ",
1679                         chip->get
1680                                 ? (chip->get(chip, i) ? "hi" : "lo")
1681                                 : "?  ");
1682                 seq_printf(s, "\n");
1683         }
1684 }
1685
1686 static int gpiolib_show(struct seq_file *s, void *unused)
1687 {
1688         struct gpio_chip        *chip = NULL;
1689         unsigned                gpio;
1690         int                     started = 0;
1691
1692         /* REVISIT this isn't locked against gpio_chip removal ... */
1693
1694         for (gpio = 0; gpio_is_valid(gpio); gpio++) {
1695                 struct device *dev;
1696
1697                 if (chip == gpio_desc[gpio].chip)
1698                         continue;
1699                 chip = gpio_desc[gpio].chip;
1700                 if (!chip)
1701                         continue;
1702
1703                 seq_printf(s, "%sGPIOs %d-%d",
1704                                 started ? "\n" : "",
1705                                 chip->base, chip->base + chip->ngpio - 1);
1706                 dev = chip->dev;
1707                 if (dev)
1708                         seq_printf(s, ", %s/%s",
1709                                 dev->bus ? dev->bus->name : "no-bus",
1710                                 dev_name(dev));
1711                 if (chip->label)
1712                         seq_printf(s, ", %s", chip->label);
1713                 if (chip->can_sleep)
1714                         seq_printf(s, ", can sleep");
1715                 seq_printf(s, ":\n");
1716
1717                 started = 1;
1718                 if (chip->dbg_show)
1719                         chip->dbg_show(s, chip);
1720                 else
1721                         gpiolib_dbg_show(s, chip);
1722         }
1723         return 0;
1724 }
1725
1726 static int gpiolib_open(struct inode *inode, struct file *file)
1727 {
1728         return single_open(file, gpiolib_show, NULL);
1729 }
1730
1731 static const struct file_operations gpiolib_operations = {
1732         .open           = gpiolib_open,
1733         .read           = seq_read,
1734         .llseek         = seq_lseek,
1735         .release        = single_release,
1736 };
1737
1738 static int __init gpiolib_debugfs_init(void)
1739 {
1740         /* /sys/kernel/debug/gpio */
1741         (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
1742                                 NULL, NULL, &gpiolib_operations);
1743         return 0;
1744 }
1745 subsys_initcall(gpiolib_debugfs_init);
1746
1747 #endif  /* DEBUG_FS */