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