2 #include <linux/mutex.h>
3 #include <linux/device.h>
4 #include <linux/sysfs.h>
5 #include <linux/gpio/consumer.h>
6 #include <linux/gpio/driver.h>
7 #include <linux/interrupt.h>
8 #include <linux/kdev_t.h>
9 #include <linux/slab.h>
13 #define GPIO_IRQF_TRIGGER_FALLING BIT(0)
14 #define GPIO_IRQF_TRIGGER_RISING BIT(1)
15 #define GPIO_IRQF_TRIGGER_BOTH (GPIO_IRQF_TRIGGER_FALLING | \
16 GPIO_IRQF_TRIGGER_RISING)
19 struct gpio_desc *desc;
22 struct kernfs_node *value_kn;
24 unsigned char irq_flags;
26 bool direction_can_change;
30 * Lock to serialise gpiod export and unexport, and prevent re-export of
31 * gpiod whose chip is being unregistered.
33 static DEFINE_MUTEX(sysfs_lock);
36 * /sys/class/gpio/gpioN... only for GPIOs that are exported
38 * * MAY BE OMITTED if kernel won't allow direction changes
39 * * is read/write as "in" or "out"
40 * * may also be written as "high" or "low", initializing
41 * output value as specified ("out" implies "low")
43 * * always readable, subject to hardware behavior
44 * * may be writable, as zero/nonzero
46 * * configures behavior of poll(2) on /value
47 * * available only if pin can generate IRQs on input
48 * * is read/write as "none", "falling", "rising", or "both"
50 * * configures polarity of /value
51 * * is read/write as zero/nonzero
52 * * also affects existing and subsequent "falling" and "rising"
56 static ssize_t direction_show(struct device *dev,
57 struct device_attribute *attr, char *buf)
59 struct gpiod_data *data = dev_get_drvdata(dev);
60 struct gpio_desc *desc = data->desc;
63 mutex_lock(&data->mutex);
65 gpiod_get_direction(desc);
66 status = sprintf(buf, "%s\n",
67 test_bit(FLAG_IS_OUT, &desc->flags)
70 mutex_unlock(&data->mutex);
75 static ssize_t direction_store(struct device *dev,
76 struct device_attribute *attr, const char *buf, size_t size)
78 struct gpiod_data *data = dev_get_drvdata(dev);
79 struct gpio_desc *desc = data->desc;
82 mutex_lock(&data->mutex);
84 if (sysfs_streq(buf, "high"))
85 status = gpiod_direction_output_raw(desc, 1);
86 else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
87 status = gpiod_direction_output_raw(desc, 0);
88 else if (sysfs_streq(buf, "in"))
89 status = gpiod_direction_input(desc);
93 mutex_unlock(&data->mutex);
95 return status ? : size;
97 static DEVICE_ATTR_RW(direction);
99 static ssize_t value_show(struct device *dev,
100 struct device_attribute *attr, char *buf)
102 struct gpiod_data *data = dev_get_drvdata(dev);
103 struct gpio_desc *desc = data->desc;
106 mutex_lock(&data->mutex);
108 status = sprintf(buf, "%d\n", gpiod_get_value_cansleep(desc));
110 mutex_unlock(&data->mutex);
115 static ssize_t value_store(struct device *dev,
116 struct device_attribute *attr, const char *buf, size_t size)
118 struct gpiod_data *data = dev_get_drvdata(dev);
119 struct gpio_desc *desc = data->desc;
122 mutex_lock(&data->mutex);
124 if (!test_bit(FLAG_IS_OUT, &desc->flags)) {
129 status = kstrtol(buf, 0, &value);
131 gpiod_set_value_cansleep(desc, value);
136 mutex_unlock(&data->mutex);
140 static DEVICE_ATTR_RW(value);
142 static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
144 struct gpiod_data *data = priv;
146 sysfs_notify_dirent(data->value_kn);
151 /* Caller holds gpiod-data mutex. */
152 static int gpio_sysfs_request_irq(struct device *dev, unsigned char flags)
154 struct gpiod_data *data = dev_get_drvdata(dev);
155 struct gpio_desc *desc = data->desc;
156 unsigned long irq_flags;
159 data->irq = gpiod_to_irq(desc);
163 data->value_kn = sysfs_get_dirent(dev->kobj.sd, "value");
167 irq_flags = IRQF_SHARED;
168 if (flags & GPIO_IRQF_TRIGGER_FALLING)
169 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
170 IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
171 if (flags & GPIO_IRQF_TRIGGER_RISING)
172 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
173 IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
176 * FIXME: This should be done in the irq_request_resources callback
177 * when the irq is requested, but a few drivers currently fail
180 * Remove this redundant call (along with the corresponding
181 * unlock) when those drivers have been fixed.
183 ret = gpiochip_lock_as_irq(desc->chip, gpio_chip_hwgpio(desc));
187 ret = request_any_context_irq(data->irq, gpio_sysfs_irq, irq_flags,
192 data->irq_flags = flags;
197 gpiochip_unlock_as_irq(desc->chip, gpio_chip_hwgpio(desc));
199 sysfs_put(data->value_kn);
205 * Caller holds gpiod-data mutex (unless called after class-device
208 static void gpio_sysfs_free_irq(struct device *dev)
210 struct gpiod_data *data = dev_get_drvdata(dev);
211 struct gpio_desc *desc = data->desc;
214 free_irq(data->irq, data);
215 gpiochip_unlock_as_irq(desc->chip, gpio_chip_hwgpio(desc));
216 sysfs_put(data->value_kn);
219 static const struct {
222 } trigger_types[] = {
224 { "falling", GPIO_IRQF_TRIGGER_FALLING },
225 { "rising", GPIO_IRQF_TRIGGER_RISING },
226 { "both", GPIO_IRQF_TRIGGER_BOTH },
229 static ssize_t edge_show(struct device *dev,
230 struct device_attribute *attr, char *buf)
232 struct gpiod_data *data = dev_get_drvdata(dev);
236 mutex_lock(&data->mutex);
238 for (i = 0; i < ARRAY_SIZE(trigger_types); i++) {
239 if (data->irq_flags == trigger_types[i].flags) {
240 status = sprintf(buf, "%s\n", trigger_types[i].name);
245 mutex_unlock(&data->mutex);
250 static ssize_t edge_store(struct device *dev,
251 struct device_attribute *attr, const char *buf, size_t size)
253 struct gpiod_data *data = dev_get_drvdata(dev);
255 ssize_t status = size;
258 for (i = 0; i < ARRAY_SIZE(trigger_types); i++) {
259 if (sysfs_streq(trigger_types[i].name, buf))
263 if (i == ARRAY_SIZE(trigger_types))
266 flags = trigger_types[i].flags;
268 mutex_lock(&data->mutex);
270 if (flags == data->irq_flags) {
276 gpio_sysfs_free_irq(dev);
279 status = gpio_sysfs_request_irq(dev, flags);
285 mutex_unlock(&data->mutex);
289 static DEVICE_ATTR_RW(edge);
291 /* Caller holds gpiod-data mutex. */
292 static int gpio_sysfs_set_active_low(struct device *dev, int value)
294 struct gpiod_data *data = dev_get_drvdata(dev);
295 struct gpio_desc *desc = data->desc;
297 unsigned int flags = data->irq_flags;
299 if (!!test_bit(FLAG_ACTIVE_LOW, &desc->flags) == !!value)
303 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
305 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
307 /* reconfigure poll(2) support if enabled on one edge only */
308 if (flags == GPIO_IRQF_TRIGGER_FALLING ||
309 flags == GPIO_IRQF_TRIGGER_RISING) {
310 gpio_sysfs_free_irq(dev);
311 status = gpio_sysfs_request_irq(dev, flags);
317 static ssize_t active_low_show(struct device *dev,
318 struct device_attribute *attr, char *buf)
320 struct gpiod_data *data = dev_get_drvdata(dev);
321 struct gpio_desc *desc = data->desc;
324 mutex_lock(&data->mutex);
326 status = sprintf(buf, "%d\n",
327 !!test_bit(FLAG_ACTIVE_LOW, &desc->flags));
329 mutex_unlock(&data->mutex);
334 static ssize_t active_low_store(struct device *dev,
335 struct device_attribute *attr, const char *buf, size_t size)
337 struct gpiod_data *data = dev_get_drvdata(dev);
341 mutex_lock(&data->mutex);
343 status = kstrtol(buf, 0, &value);
345 status = gpio_sysfs_set_active_low(dev, value);
347 mutex_unlock(&data->mutex);
349 return status ? : size;
351 static DEVICE_ATTR_RW(active_low);
353 static umode_t gpio_is_visible(struct kobject *kobj, struct attribute *attr,
356 struct device *dev = container_of(kobj, struct device, kobj);
357 struct gpiod_data *data = dev_get_drvdata(dev);
358 struct gpio_desc *desc = data->desc;
359 umode_t mode = attr->mode;
360 bool show_direction = data->direction_can_change;
362 if (attr == &dev_attr_direction.attr) {
365 } else if (attr == &dev_attr_edge.attr) {
366 if (gpiod_to_irq(desc) < 0)
368 if (!show_direction && test_bit(FLAG_IS_OUT, &desc->flags))
375 static struct attribute *gpio_attrs[] = {
376 &dev_attr_direction.attr,
378 &dev_attr_value.attr,
379 &dev_attr_active_low.attr,
383 static const struct attribute_group gpio_group = {
385 .is_visible = gpio_is_visible,
388 static const struct attribute_group *gpio_groups[] = {
394 * /sys/class/gpio/gpiochipN/
395 * /base ... matching gpio_chip.base (N)
396 * /label ... matching gpio_chip.label
397 * /ngpio ... matching gpio_chip.ngpio
400 static ssize_t base_show(struct device *dev,
401 struct device_attribute *attr, char *buf)
403 const struct gpio_chip *chip = dev_get_drvdata(dev);
405 return sprintf(buf, "%d\n", chip->base);
407 static DEVICE_ATTR_RO(base);
409 static ssize_t label_show(struct device *dev,
410 struct device_attribute *attr, char *buf)
412 const struct gpio_chip *chip = dev_get_drvdata(dev);
414 return sprintf(buf, "%s\n", chip->label ? : "");
416 static DEVICE_ATTR_RO(label);
418 static ssize_t ngpio_show(struct device *dev,
419 struct device_attribute *attr, char *buf)
421 const struct gpio_chip *chip = dev_get_drvdata(dev);
423 return sprintf(buf, "%u\n", chip->ngpio);
425 static DEVICE_ATTR_RO(ngpio);
427 static struct attribute *gpiochip_attrs[] = {
429 &dev_attr_label.attr,
430 &dev_attr_ngpio.attr,
433 ATTRIBUTE_GROUPS(gpiochip);
436 * /sys/class/gpio/export ... write-only
437 * integer N ... number of GPIO to export (full access)
438 * /sys/class/gpio/unexport ... write-only
439 * integer N ... number of GPIO to unexport
441 static ssize_t export_store(struct class *class,
442 struct class_attribute *attr,
443 const char *buf, size_t len)
446 struct gpio_desc *desc;
449 status = kstrtol(buf, 0, &gpio);
453 desc = gpio_to_desc(gpio);
454 /* reject invalid GPIOs */
456 pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
460 /* No extra locking here; FLAG_SYSFS just signifies that the
461 * request and export were done by on behalf of userspace, so
462 * they may be undone on its behalf too.
465 status = gpiod_request(desc, "sysfs");
467 if (status == -EPROBE_DEFER)
471 status = gpiod_export(desc, true);
475 set_bit(FLAG_SYSFS, &desc->flags);
479 pr_debug("%s: status %d\n", __func__, status);
480 return status ? : len;
483 static ssize_t unexport_store(struct class *class,
484 struct class_attribute *attr,
485 const char *buf, size_t len)
488 struct gpio_desc *desc;
491 status = kstrtol(buf, 0, &gpio);
495 desc = gpio_to_desc(gpio);
496 /* reject bogus commands (gpio_unexport ignores them) */
498 pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
504 /* No extra locking here; FLAG_SYSFS just signifies that the
505 * request and export were done by on behalf of userspace, so
506 * they may be undone on its behalf too.
508 if (test_and_clear_bit(FLAG_SYSFS, &desc->flags)) {
514 pr_debug("%s: status %d\n", __func__, status);
515 return status ? : len;
518 static struct class_attribute gpio_class_attrs[] = {
519 __ATTR(export, 0200, NULL, export_store),
520 __ATTR(unexport, 0200, NULL, unexport_store),
524 static struct class gpio_class = {
526 .owner = THIS_MODULE,
528 .class_attrs = gpio_class_attrs,
533 * gpiod_export - export a GPIO through sysfs
534 * @gpio: gpio to make available, already requested
535 * @direction_may_change: true if userspace may change gpio direction
536 * Context: arch_initcall or later
538 * When drivers want to make a GPIO accessible to userspace after they
539 * have requested it -- perhaps while debugging, or as part of their
540 * public interface -- they may use this routine. If the GPIO can
541 * change direction (some can't) and the caller allows it, userspace
542 * will see "direction" sysfs attribute which may be used to change
543 * the gpio's direction. A "value" attribute will always be provided.
545 * Returns zero on success, else an error.
547 int gpiod_export(struct gpio_desc *desc, bool direction_may_change)
549 struct gpio_chip *chip;
550 struct gpiod_data *data;
553 const char *ioname = NULL;
557 /* can't export until sysfs is available ... */
559 pr_debug("%s: called too early!\n", __func__);
564 pr_debug("%s: invalid gpio descriptor\n", __func__);
570 mutex_lock(&sysfs_lock);
572 /* check if chip is being removed */
573 if (!chip || !chip->cdev) {
578 spin_lock_irqsave(&gpio_lock, flags);
579 if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
580 test_bit(FLAG_EXPORT, &desc->flags)) {
581 spin_unlock_irqrestore(&gpio_lock, flags);
582 gpiod_dbg(desc, "%s: unavailable (requested=%d, exported=%d)\n",
584 test_bit(FLAG_REQUESTED, &desc->flags),
585 test_bit(FLAG_EXPORT, &desc->flags));
589 spin_unlock_irqrestore(&gpio_lock, flags);
591 data = kzalloc(sizeof(*data), GFP_KERNEL);
598 mutex_init(&data->mutex);
599 if (chip->direction_input && chip->direction_output)
600 data->direction_can_change = direction_may_change;
602 data->direction_can_change = false;
604 offset = gpio_chip_hwgpio(desc);
605 if (chip->names && chip->names[offset])
606 ioname = chip->names[offset];
608 dev = device_create_with_groups(&gpio_class, chip->dev,
609 MKDEV(0, 0), data, gpio_groups,
610 ioname ? ioname : "gpio%u",
613 status = PTR_ERR(dev);
617 set_bit(FLAG_EXPORT, &desc->flags);
618 mutex_unlock(&sysfs_lock);
624 mutex_unlock(&sysfs_lock);
625 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
628 EXPORT_SYMBOL_GPL(gpiod_export);
630 static int match_export(struct device *dev, const void *desc)
632 struct gpiod_data *data = dev_get_drvdata(dev);
634 return data->desc == desc;
638 * gpiod_export_link - create a sysfs link to an exported GPIO node
639 * @dev: device under which to create symlink
640 * @name: name of the symlink
641 * @gpio: gpio to create symlink to, already exported
643 * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
644 * node. Caller is responsible for unlinking.
646 * Returns zero on success, else an error.
648 int gpiod_export_link(struct device *dev, const char *name,
649 struct gpio_desc *desc)
655 pr_warn("%s: invalid GPIO\n", __func__);
659 cdev = class_find_device(&gpio_class, NULL, desc, match_export);
663 ret = sysfs_create_link(&dev->kobj, &cdev->kobj, name);
668 EXPORT_SYMBOL_GPL(gpiod_export_link);
671 * gpiod_unexport - reverse effect of gpio_export()
672 * @gpio: gpio to make unavailable
674 * This is implicit on gpio_free().
676 void gpiod_unexport(struct gpio_desc *desc)
678 struct gpiod_data *data;
682 pr_warn("%s: invalid GPIO\n", __func__);
686 mutex_lock(&sysfs_lock);
688 if (!test_bit(FLAG_EXPORT, &desc->flags))
691 dev = class_find_device(&gpio_class, NULL, desc, match_export);
695 data = dev_get_drvdata(dev);
697 clear_bit(FLAG_EXPORT, &desc->flags);
699 device_unregister(dev);
702 * Release irq after deregistration to prevent race with edge_store.
705 gpio_sysfs_free_irq(dev);
707 mutex_unlock(&sysfs_lock);
715 mutex_unlock(&sysfs_lock);
717 EXPORT_SYMBOL_GPL(gpiod_unexport);
719 int gpiochip_sysfs_register(struct gpio_chip *chip)
724 * Many systems add gpio chips for SOC support very early,
725 * before driver model support is available. In those cases we
726 * register later, in gpiolib_sysfs_init() ... here we just
727 * verify that _some_ field of gpio_class got initialized.
732 /* use chip->base for the ID; it's already known to be unique */
733 dev = device_create_with_groups(&gpio_class, chip->dev, MKDEV(0, 0),
734 chip, gpiochip_groups,
735 "gpiochip%d", chip->base);
739 mutex_lock(&sysfs_lock);
741 mutex_unlock(&sysfs_lock);
746 void gpiochip_sysfs_unregister(struct gpio_chip *chip)
748 struct gpio_desc *desc;
754 device_unregister(chip->cdev);
756 /* prevent further gpiod exports */
757 mutex_lock(&sysfs_lock);
759 mutex_unlock(&sysfs_lock);
761 /* unregister gpiod class devices owned by sysfs */
762 for (i = 0; i < chip->ngpio; i++) {
763 desc = &chip->desc[i];
764 if (test_and_clear_bit(FLAG_SYSFS, &desc->flags))
769 static int __init gpiolib_sysfs_init(void)
773 struct gpio_chip *chip;
775 status = class_register(&gpio_class);
779 /* Scan and register the gpio_chips which registered very
780 * early (e.g. before the class_register above was called).
782 * We run before arch_initcall() so chip->dev nodes can have
783 * registered, and so arch_initcall() can always gpio_export().
785 spin_lock_irqsave(&gpio_lock, flags);
786 list_for_each_entry(chip, &gpio_chips, list) {
791 * TODO we yield gpio_lock here because
792 * gpiochip_sysfs_register() acquires a mutex. This is unsafe
793 * and needs to be fixed.
795 * Also it would be nice to use gpiochip_find() here so we
796 * can keep gpio_chips local to gpiolib.c, but the yield of
797 * gpio_lock prevents us from doing this.
799 spin_unlock_irqrestore(&gpio_lock, flags);
800 status = gpiochip_sysfs_register(chip);
801 spin_lock_irqsave(&gpio_lock, flags);
803 spin_unlock_irqrestore(&gpio_lock, flags);
808 postcore_initcall(gpiolib_sysfs_init);