1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/mutex.h>
4 #include <linux/device.h>
5 #include <linux/sysfs.h>
6 #include <linux/gpio/consumer.h>
7 #include <linux/gpio/driver.h>
8 #include <linux/interrupt.h>
9 #include <linux/kdev_t.h>
10 #include <linux/slab.h>
11 #include <linux/ctype.h>
14 #include "gpiolib-sysfs.h"
16 #define GPIO_IRQF_TRIGGER_NONE 0
17 #define GPIO_IRQF_TRIGGER_FALLING BIT(0)
18 #define GPIO_IRQF_TRIGGER_RISING BIT(1)
19 #define GPIO_IRQF_TRIGGER_BOTH (GPIO_IRQF_TRIGGER_FALLING | \
20 GPIO_IRQF_TRIGGER_RISING)
23 struct gpio_desc *desc;
26 struct kernfs_node *value_kn;
28 unsigned char irq_flags;
30 bool direction_can_change;
34 * Lock to serialise gpiod export and unexport, and prevent re-export of
35 * gpiod whose chip is being unregistered.
37 static DEFINE_MUTEX(sysfs_lock);
40 * /sys/class/gpio/gpioN... only for GPIOs that are exported
42 * * MAY BE OMITTED if kernel won't allow direction changes
43 * * is read/write as "in" or "out"
44 * * may also be written as "high" or "low", initializing
45 * output value as specified ("out" implies "low")
47 * * always readable, subject to hardware behavior
48 * * may be writable, as zero/nonzero
50 * * configures behavior of poll(2) on /value
51 * * available only if pin can generate IRQs on input
52 * * is read/write as "none", "falling", "rising", or "both"
54 * * configures polarity of /value
55 * * is read/write as zero/nonzero
56 * * also affects existing and subsequent "falling" and "rising"
60 static ssize_t direction_show(struct device *dev,
61 struct device_attribute *attr, char *buf)
63 struct gpiod_data *data = dev_get_drvdata(dev);
64 struct gpio_desc *desc = data->desc;
67 mutex_lock(&data->mutex);
69 gpiod_get_direction(desc);
70 value = !!test_bit(FLAG_IS_OUT, &desc->flags);
72 mutex_unlock(&data->mutex);
74 return sysfs_emit(buf, "%s\n", value ? "out" : "in");
77 static ssize_t direction_store(struct device *dev,
78 struct device_attribute *attr, const char *buf, size_t size)
80 struct gpiod_data *data = dev_get_drvdata(dev);
81 struct gpio_desc *desc = data->desc;
84 mutex_lock(&data->mutex);
86 if (sysfs_streq(buf, "high"))
87 status = gpiod_direction_output_raw(desc, 1);
88 else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
89 status = gpiod_direction_output_raw(desc, 0);
90 else if (sysfs_streq(buf, "in"))
91 status = gpiod_direction_input(desc);
95 mutex_unlock(&data->mutex);
97 return status ? : size;
99 static DEVICE_ATTR_RW(direction);
101 static ssize_t value_show(struct device *dev,
102 struct device_attribute *attr, char *buf)
104 struct gpiod_data *data = dev_get_drvdata(dev);
105 struct gpio_desc *desc = data->desc;
108 mutex_lock(&data->mutex);
110 status = gpiod_get_value_cansleep(desc);
112 mutex_unlock(&data->mutex);
117 return sysfs_emit(buf, "%zd\n", status);
120 static ssize_t value_store(struct device *dev,
121 struct device_attribute *attr, const char *buf, size_t size)
123 struct gpiod_data *data = dev_get_drvdata(dev);
124 struct gpio_desc *desc = data->desc;
128 status = kstrtol(buf, 0, &value);
130 mutex_lock(&data->mutex);
132 if (!test_bit(FLAG_IS_OUT, &desc->flags)) {
134 } else if (status == 0) {
135 gpiod_set_value_cansleep(desc, value);
139 mutex_unlock(&data->mutex);
143 static DEVICE_ATTR_PREALLOC(value, S_IWUSR | S_IRUGO, value_show, value_store);
145 static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
147 struct gpiod_data *data = priv;
149 sysfs_notify_dirent(data->value_kn);
154 /* Caller holds gpiod-data mutex. */
155 static int gpio_sysfs_request_irq(struct device *dev, unsigned char flags)
157 struct gpiod_data *data = dev_get_drvdata(dev);
158 struct gpio_desc *desc = data->desc;
159 unsigned long irq_flags;
162 data->irq = gpiod_to_irq(desc);
166 data->value_kn = sysfs_get_dirent(dev->kobj.sd, "value");
170 irq_flags = IRQF_SHARED;
171 if (flags & GPIO_IRQF_TRIGGER_FALLING)
172 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
173 IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
174 if (flags & GPIO_IRQF_TRIGGER_RISING)
175 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
176 IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
179 * FIXME: This should be done in the irq_request_resources callback
180 * when the irq is requested, but a few drivers currently fail
183 * Remove this redundant call (along with the corresponding
184 * unlock) when those drivers have been fixed.
186 ret = gpiochip_lock_as_irq(desc->gdev->chip, gpio_chip_hwgpio(desc));
190 ret = request_any_context_irq(data->irq, gpio_sysfs_irq, irq_flags,
195 data->irq_flags = flags;
200 gpiochip_unlock_as_irq(desc->gdev->chip, gpio_chip_hwgpio(desc));
202 sysfs_put(data->value_kn);
208 * Caller holds gpiod-data mutex (unless called after class-device
211 static void gpio_sysfs_free_irq(struct device *dev)
213 struct gpiod_data *data = dev_get_drvdata(dev);
214 struct gpio_desc *desc = data->desc;
217 free_irq(data->irq, data);
218 gpiochip_unlock_as_irq(desc->gdev->chip, gpio_chip_hwgpio(desc));
219 sysfs_put(data->value_kn);
222 static const char * const trigger_names[] = {
223 [GPIO_IRQF_TRIGGER_NONE] = "none",
224 [GPIO_IRQF_TRIGGER_FALLING] = "falling",
225 [GPIO_IRQF_TRIGGER_RISING] = "rising",
226 [GPIO_IRQF_TRIGGER_BOTH] = "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);
235 mutex_lock(&data->mutex);
237 flags = data->irq_flags;
239 mutex_unlock(&data->mutex);
241 if (flags >= ARRAY_SIZE(trigger_names))
244 return sysfs_emit(buf, "%s\n", trigger_names[flags]);
247 static ssize_t edge_store(struct device *dev,
248 struct device_attribute *attr, const char *buf, size_t size)
250 struct gpiod_data *data = dev_get_drvdata(dev);
251 ssize_t status = size;
254 flags = sysfs_match_string(trigger_names, buf);
258 mutex_lock(&data->mutex);
260 if (flags == data->irq_flags) {
266 gpio_sysfs_free_irq(dev);
269 status = gpio_sysfs_request_irq(dev, flags);
275 mutex_unlock(&data->mutex);
279 static DEVICE_ATTR_RW(edge);
281 /* Caller holds gpiod-data mutex. */
282 static int gpio_sysfs_set_active_low(struct device *dev, int value)
284 struct gpiod_data *data = dev_get_drvdata(dev);
285 struct gpio_desc *desc = data->desc;
287 unsigned int flags = data->irq_flags;
289 if (!!test_bit(FLAG_ACTIVE_LOW, &desc->flags) == !!value)
292 assign_bit(FLAG_ACTIVE_LOW, &desc->flags, value);
294 /* reconfigure poll(2) support if enabled on one edge only */
295 if (flags == GPIO_IRQF_TRIGGER_FALLING ||
296 flags == GPIO_IRQF_TRIGGER_RISING) {
297 gpio_sysfs_free_irq(dev);
298 status = gpio_sysfs_request_irq(dev, flags);
304 static ssize_t active_low_show(struct device *dev,
305 struct device_attribute *attr, char *buf)
307 struct gpiod_data *data = dev_get_drvdata(dev);
308 struct gpio_desc *desc = data->desc;
311 mutex_lock(&data->mutex);
313 value = !!test_bit(FLAG_ACTIVE_LOW, &desc->flags);
315 mutex_unlock(&data->mutex);
317 return sysfs_emit(buf, "%d\n", value);
320 static ssize_t active_low_store(struct device *dev,
321 struct device_attribute *attr, const char *buf, size_t size)
323 struct gpiod_data *data = dev_get_drvdata(dev);
327 status = kstrtol(buf, 0, &value);
331 mutex_lock(&data->mutex);
333 status = gpio_sysfs_set_active_low(dev, value);
335 mutex_unlock(&data->mutex);
337 return status ? : size;
339 static DEVICE_ATTR_RW(active_low);
341 static umode_t gpio_is_visible(struct kobject *kobj, struct attribute *attr,
344 struct device *dev = kobj_to_dev(kobj);
345 struct gpiod_data *data = dev_get_drvdata(dev);
346 struct gpio_desc *desc = data->desc;
347 umode_t mode = attr->mode;
348 bool show_direction = data->direction_can_change;
350 if (attr == &dev_attr_direction.attr) {
353 } else if (attr == &dev_attr_edge.attr) {
354 if (gpiod_to_irq(desc) < 0)
356 if (!show_direction && test_bit(FLAG_IS_OUT, &desc->flags))
363 static struct attribute *gpio_attrs[] = {
364 &dev_attr_direction.attr,
366 &dev_attr_value.attr,
367 &dev_attr_active_low.attr,
371 static const struct attribute_group gpio_group = {
373 .is_visible = gpio_is_visible,
376 static const struct attribute_group *gpio_groups[] = {
382 * /sys/class/gpio/gpiochipN/
383 * /base ... matching gpio_chip.base (N)
384 * /label ... matching gpio_chip.label
385 * /ngpio ... matching gpio_chip.ngpio
388 static ssize_t base_show(struct device *dev,
389 struct device_attribute *attr, char *buf)
391 const struct gpio_chip *chip = dev_get_drvdata(dev);
393 return sysfs_emit(buf, "%d\n", chip->base);
395 static DEVICE_ATTR_RO(base);
397 static ssize_t label_show(struct device *dev,
398 struct device_attribute *attr, char *buf)
400 const struct gpio_chip *chip = dev_get_drvdata(dev);
402 return sysfs_emit(buf, "%s\n", chip->label ?: "");
404 static DEVICE_ATTR_RO(label);
406 static ssize_t ngpio_show(struct device *dev,
407 struct device_attribute *attr, char *buf)
409 const struct gpio_chip *chip = dev_get_drvdata(dev);
411 return sysfs_emit(buf, "%u\n", chip->ngpio);
413 static DEVICE_ATTR_RO(ngpio);
415 static struct attribute *gpiochip_attrs[] = {
417 &dev_attr_label.attr,
418 &dev_attr_ngpio.attr,
421 ATTRIBUTE_GROUPS(gpiochip);
424 * /sys/class/gpio/export ... write-only
425 * integer N ... number of GPIO to export (full access)
426 * /sys/class/gpio/unexport ... write-only
427 * integer N ... number of GPIO to unexport
429 static ssize_t export_store(struct class *class,
430 struct class_attribute *attr,
431 const char *buf, size_t len)
434 struct gpio_desc *desc;
436 struct gpio_chip *gc;
439 status = kstrtol(buf, 0, &gpio);
443 desc = gpio_to_desc(gpio);
444 /* reject invalid GPIOs */
446 pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
449 gc = desc->gdev->chip;
450 offset = gpio_chip_hwgpio(desc);
451 if (!gpiochip_line_is_valid(gc, offset)) {
452 pr_warn("%s: GPIO %ld masked\n", __func__, gpio);
456 /* No extra locking here; FLAG_SYSFS just signifies that the
457 * request and export were done by on behalf of userspace, so
458 * they may be undone on its behalf too.
461 status = gpiod_request_user(desc, "sysfs");
465 status = gpiod_set_transitory(desc, false);
467 status = gpiod_export(desc, true);
471 set_bit(FLAG_SYSFS, &desc->flags);
476 pr_debug("%s: status %d\n", __func__, status);
477 return status ? : len;
479 static CLASS_ATTR_WO(export);
481 static ssize_t unexport_store(struct class *class,
482 struct class_attribute *attr,
483 const char *buf, size_t len)
486 struct gpio_desc *desc;
489 status = kstrtol(buf, 0, &gpio);
493 desc = gpio_to_desc(gpio);
494 /* reject bogus commands (gpio_unexport ignores them) */
496 pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
502 /* No extra locking here; FLAG_SYSFS just signifies that the
503 * request and export were done by on behalf of userspace, so
504 * they may be undone on its behalf too.
506 if (test_and_clear_bit(FLAG_SYSFS, &desc->flags)) {
512 pr_debug("%s: status %d\n", __func__, status);
513 return status ? : len;
515 static CLASS_ATTR_WO(unexport);
517 static struct attribute *gpio_class_attrs[] = {
518 &class_attr_export.attr,
519 &class_attr_unexport.attr,
522 ATTRIBUTE_GROUPS(gpio_class);
524 static struct class gpio_class = {
526 .owner = THIS_MODULE,
528 .class_groups = gpio_class_groups,
533 * gpiod_export - export a GPIO through sysfs
534 * @desc: 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 gpio_device *gdev;
551 struct gpiod_data *data;
554 const char *ioname = NULL;
558 /* can't export until sysfs is available ... */
560 pr_debug("%s: called too early!\n", __func__);
565 pr_debug("%s: invalid gpio descriptor\n", __func__);
572 mutex_lock(&sysfs_lock);
574 /* check if chip is being removed */
575 if (!chip || !gdev->mockdev) {
580 spin_lock_irqsave(&gpio_lock, flags);
581 if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
582 test_bit(FLAG_EXPORT, &desc->flags)) {
583 spin_unlock_irqrestore(&gpio_lock, flags);
584 gpiod_dbg(desc, "%s: unavailable (requested=%d, exported=%d)\n",
586 test_bit(FLAG_REQUESTED, &desc->flags),
587 test_bit(FLAG_EXPORT, &desc->flags));
591 spin_unlock_irqrestore(&gpio_lock, flags);
593 data = kzalloc(sizeof(*data), GFP_KERNEL);
600 mutex_init(&data->mutex);
601 if (chip->direction_input && chip->direction_output)
602 data->direction_can_change = direction_may_change;
604 data->direction_can_change = false;
606 offset = gpio_chip_hwgpio(desc);
607 if (chip->names && chip->names[offset])
608 ioname = chip->names[offset];
610 dev = device_create_with_groups(&gpio_class, &gdev->dev,
611 MKDEV(0, 0), data, gpio_groups,
612 ioname ? ioname : "gpio%u",
615 status = PTR_ERR(dev);
619 set_bit(FLAG_EXPORT, &desc->flags);
620 mutex_unlock(&sysfs_lock);
626 mutex_unlock(&sysfs_lock);
627 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
630 EXPORT_SYMBOL_GPL(gpiod_export);
632 static int match_export(struct device *dev, const void *desc)
634 struct gpiod_data *data = dev_get_drvdata(dev);
636 return data->desc == desc;
640 * gpiod_export_link - create a sysfs link to an exported GPIO node
641 * @dev: device under which to create symlink
642 * @name: name of the symlink
643 * @desc: GPIO to create symlink to, already exported
645 * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
646 * node. Caller is responsible for unlinking.
648 * Returns zero on success, else an error.
650 int gpiod_export_link(struct device *dev, const char *name,
651 struct gpio_desc *desc)
657 pr_warn("%s: invalid GPIO\n", __func__);
661 cdev = class_find_device(&gpio_class, NULL, desc, match_export);
665 ret = sysfs_create_link(&dev->kobj, &cdev->kobj, name);
670 EXPORT_SYMBOL_GPL(gpiod_export_link);
673 * gpiod_unexport - reverse effect of gpiod_export()
674 * @desc: GPIO to make unavailable
676 * This is implicit on gpiod_free().
678 void gpiod_unexport(struct gpio_desc *desc)
680 struct gpiod_data *data;
684 pr_warn("%s: invalid GPIO\n", __func__);
688 mutex_lock(&sysfs_lock);
690 if (!test_bit(FLAG_EXPORT, &desc->flags))
693 dev = class_find_device(&gpio_class, NULL, desc, match_export);
697 data = dev_get_drvdata(dev);
699 clear_bit(FLAG_EXPORT, &desc->flags);
701 device_unregister(dev);
704 * Release irq after deregistration to prevent race with edge_store.
707 gpio_sysfs_free_irq(dev);
709 mutex_unlock(&sysfs_lock);
717 mutex_unlock(&sysfs_lock);
719 EXPORT_SYMBOL_GPL(gpiod_unexport);
721 int gpiochip_sysfs_register(struct gpio_device *gdev)
724 struct device *parent;
725 struct gpio_chip *chip = gdev->chip;
728 * Many systems add gpio chips for SOC support very early,
729 * before driver model support is available. In those cases we
730 * register later, in gpiolib_sysfs_init() ... here we just
731 * verify that _some_ field of gpio_class got initialized.
737 * For sysfs backward compatibility we need to preserve this
738 * preferred parenting to the gpio_chip parent field, if set.
741 parent = chip->parent;
745 /* use chip->base for the ID; it's already known to be unique */
746 dev = device_create_with_groups(&gpio_class, parent, MKDEV(0, 0), chip,
747 gpiochip_groups, GPIOCHIP_NAME "%d",
752 mutex_lock(&sysfs_lock);
754 mutex_unlock(&sysfs_lock);
759 void gpiochip_sysfs_unregister(struct gpio_device *gdev)
761 struct gpio_desc *desc;
762 struct gpio_chip *chip = gdev->chip;
767 device_unregister(gdev->mockdev);
769 /* prevent further gpiod exports */
770 mutex_lock(&sysfs_lock);
771 gdev->mockdev = NULL;
772 mutex_unlock(&sysfs_lock);
774 /* unregister gpiod class devices owned by sysfs */
775 for_each_gpio_desc_with_flag(chip, desc, FLAG_SYSFS)
779 static int __init gpiolib_sysfs_init(void)
783 struct gpio_device *gdev;
785 status = class_register(&gpio_class);
789 /* Scan and register the gpio_chips which registered very
790 * early (e.g. before the class_register above was called).
792 * We run before arch_initcall() so chip->dev nodes can have
793 * registered, and so arch_initcall() can always gpio_export().
795 spin_lock_irqsave(&gpio_lock, flags);
796 list_for_each_entry(gdev, &gpio_devices, list) {
801 * TODO we yield gpio_lock here because
802 * gpiochip_sysfs_register() acquires a mutex. This is unsafe
803 * and needs to be fixed.
805 * Also it would be nice to use gpiochip_find() here so we
806 * can keep gpio_chips local to gpiolib.c, but the yield of
807 * gpio_lock prevents us from doing this.
809 spin_unlock_irqrestore(&gpio_lock, flags);
810 status = gpiochip_sysfs_register(gdev);
811 spin_lock_irqsave(&gpio_lock, flags);
813 spin_unlock_irqrestore(&gpio_lock, flags);
817 postcore_initcall(gpiolib_sysfs_init);