Merge tag 'timers-core-2021-04-26' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-block.git] / drivers / gpio / gpiolib-sysfs.c
CommitLineData
dae5f0af 1// SPDX-License-Identifier: GPL-2.0
0eb4c6c2
AC
2#include <linux/idr.h>
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>
c43960fb 10#include <linux/slab.h>
1efba35a 11#include <linux/ctype.h>
0eb4c6c2
AC
12
13#include "gpiolib.h"
ef087d8e 14#include "gpiolib-sysfs.h"
0eb4c6c2 15
cef1717b
JH
16#define GPIO_IRQF_TRIGGER_FALLING BIT(0)
17#define GPIO_IRQF_TRIGGER_RISING BIT(1)
18#define GPIO_IRQF_TRIGGER_BOTH (GPIO_IRQF_TRIGGER_FALLING | \
19 GPIO_IRQF_TRIGGER_RISING)
20
c43960fb
JH
21struct gpiod_data {
22 struct gpio_desc *desc;
6ffcb797
JH
23
24 struct mutex mutex;
a08f5c21 25 struct kernfs_node *value_kn;
2ec74a95 26 int irq;
cef1717b 27 unsigned char irq_flags;
427fdeef
JH
28
29 bool direction_can_change;
c43960fb
JH
30};
31
6ffcb797
JH
32/*
33 * Lock to serialise gpiod export and unexport, and prevent re-export of
34 * gpiod whose chip is being unregistered.
0eb4c6c2
AC
35 */
36static DEFINE_MUTEX(sysfs_lock);
37
38/*
39 * /sys/class/gpio/gpioN... only for GPIOs that are exported
40 * /direction
41 * * MAY BE OMITTED if kernel won't allow direction changes
42 * * is read/write as "in" or "out"
43 * * may also be written as "high" or "low", initializing
44 * output value as specified ("out" implies "low")
45 * /value
46 * * always readable, subject to hardware behavior
47 * * may be writable, as zero/nonzero
48 * /edge
49 * * configures behavior of poll(2) on /value
50 * * available only if pin can generate IRQs on input
51 * * is read/write as "none", "falling", "rising", or "both"
52 * /active_low
53 * * configures polarity of /value
54 * * is read/write as zero/nonzero
55 * * also affects existing and subsequent "falling" and "rising"
56 * /edge configuration
57 */
58
6beac9d1 59static ssize_t direction_show(struct device *dev,
0eb4c6c2
AC
60 struct device_attribute *attr, char *buf)
61{
c43960fb
JH
62 struct gpiod_data *data = dev_get_drvdata(dev);
63 struct gpio_desc *desc = data->desc;
0eb4c6c2
AC
64 ssize_t status;
65
6ffcb797 66 mutex_lock(&data->mutex);
0eb4c6c2 67
f0b7866a
JH
68 gpiod_get_direction(desc);
69 status = sprintf(buf, "%s\n",
0eb4c6c2
AC
70 test_bit(FLAG_IS_OUT, &desc->flags)
71 ? "out" : "in");
0eb4c6c2 72
6ffcb797
JH
73 mutex_unlock(&data->mutex);
74
0eb4c6c2
AC
75 return status;
76}
77
6beac9d1 78static ssize_t direction_store(struct device *dev,
0eb4c6c2
AC
79 struct device_attribute *attr, const char *buf, size_t size)
80{
c43960fb
JH
81 struct gpiod_data *data = dev_get_drvdata(dev);
82 struct gpio_desc *desc = data->desc;
0eb4c6c2
AC
83 ssize_t status;
84
6ffcb797 85 mutex_lock(&data->mutex);
0eb4c6c2 86
f0b7866a 87 if (sysfs_streq(buf, "high"))
0eb4c6c2
AC
88 status = gpiod_direction_output_raw(desc, 1);
89 else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
90 status = gpiod_direction_output_raw(desc, 0);
91 else if (sysfs_streq(buf, "in"))
92 status = gpiod_direction_input(desc);
93 else
94 status = -EINVAL;
95
6ffcb797
JH
96 mutex_unlock(&data->mutex);
97
0eb4c6c2
AC
98 return status ? : size;
99}
6beac9d1 100static DEVICE_ATTR_RW(direction);
0eb4c6c2 101
6beac9d1 102static ssize_t value_show(struct device *dev,
0eb4c6c2
AC
103 struct device_attribute *attr, char *buf)
104{
c43960fb
JH
105 struct gpiod_data *data = dev_get_drvdata(dev);
106 struct gpio_desc *desc = data->desc;
0eb4c6c2
AC
107 ssize_t status;
108
6ffcb797 109 mutex_lock(&data->mutex);
0eb4c6c2 110
9295c012
CL
111 status = gpiod_get_value_cansleep(desc);
112 if (status < 0)
113 goto err;
0eb4c6c2 114
7a94b88c
CL
115 buf[0] = '0' + status;
116 buf[1] = '\n';
117 status = 2;
9295c012 118err:
6ffcb797
JH
119 mutex_unlock(&data->mutex);
120
0eb4c6c2
AC
121 return status;
122}
123
6beac9d1 124static ssize_t value_store(struct device *dev,
0eb4c6c2
AC
125 struct device_attribute *attr, const char *buf, size_t size)
126{
c43960fb
JH
127 struct gpiod_data *data = dev_get_drvdata(dev);
128 struct gpio_desc *desc = data->desc;
1efba35a 129 ssize_t status = 0;
0eb4c6c2 130
6ffcb797 131 mutex_lock(&data->mutex);
0eb4c6c2 132
f0b7866a 133 if (!test_bit(FLAG_IS_OUT, &desc->flags)) {
0eb4c6c2 134 status = -EPERM;
f0b7866a 135 } else {
0eb4c6c2
AC
136 long value;
137
1efba35a
CL
138 if (size <= 2 && isdigit(buf[0]) &&
139 (size == 1 || buf[1] == '\n'))
140 value = buf[0] - '0';
141 else
142 status = kstrtol(buf, 0, &value);
0eb4c6c2
AC
143 if (status == 0) {
144 gpiod_set_value_cansleep(desc, value);
145 status = size;
146 }
147 }
148
6ffcb797
JH
149 mutex_unlock(&data->mutex);
150
0eb4c6c2
AC
151 return status;
152}
7fda9100 153static DEVICE_ATTR_PREALLOC(value, S_IWUSR | S_IRUGO, value_show, value_store);
0eb4c6c2
AC
154
155static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
156{
a08f5c21
JH
157 struct gpiod_data *data = priv;
158
159 sysfs_notify_dirent(data->value_kn);
0eb4c6c2 160
0eb4c6c2
AC
161 return IRQ_HANDLED;
162}
163
6ffcb797 164/* Caller holds gpiod-data mutex. */
cef1717b 165static int gpio_sysfs_request_irq(struct device *dev, unsigned char flags)
0eb4c6c2 166{
0f628508
JH
167 struct gpiod_data *data = dev_get_drvdata(dev);
168 struct gpio_desc *desc = data->desc;
0eb4c6c2 169 unsigned long irq_flags;
2ec74a95 170 int ret;
0eb4c6c2 171
2ec74a95
JH
172 data->irq = gpiod_to_irq(desc);
173 if (data->irq < 0)
0eb4c6c2
AC
174 return -EIO;
175
2ec74a95
JH
176 data->value_kn = sysfs_get_dirent(dev->kobj.sd, "value");
177 if (!data->value_kn)
178 return -ENODEV;
0eb4c6c2
AC
179
180 irq_flags = IRQF_SHARED;
cef1717b 181 if (flags & GPIO_IRQF_TRIGGER_FALLING)
0eb4c6c2
AC
182 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
183 IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
cef1717b 184 if (flags & GPIO_IRQF_TRIGGER_RISING)
0eb4c6c2
AC
185 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
186 IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
187
52176d0d
JH
188 /*
189 * FIXME: This should be done in the irq_request_resources callback
190 * when the irq is requested, but a few drivers currently fail
191 * to do so.
192 *
193 * Remove this redundant call (along with the corresponding
194 * unlock) when those drivers have been fixed.
195 */
fdeb8e15 196 ret = gpiochip_lock_as_irq(desc->gdev->chip, gpio_chip_hwgpio(desc));
0eb4c6c2 197 if (ret < 0)
2ec74a95 198 goto err_put_kn;
0eb4c6c2 199
2ec74a95 200 ret = request_any_context_irq(data->irq, gpio_sysfs_irq, irq_flags,
a08f5c21 201 "gpiolib", data);
52176d0d
JH
202 if (ret < 0)
203 goto err_unlock;
0eb4c6c2 204
cef1717b 205 data->irq_flags = flags;
2ec74a95 206
0eb4c6c2
AC
207 return 0;
208
52176d0d 209err_unlock:
fdeb8e15 210 gpiochip_unlock_as_irq(desc->gdev->chip, gpio_chip_hwgpio(desc));
2ec74a95
JH
211err_put_kn:
212 sysfs_put(data->value_kn);
213
0eb4c6c2
AC
214 return ret;
215}
216
6ffcb797
JH
217/*
218 * Caller holds gpiod-data mutex (unless called after class-device
219 * deregistration).
220 */
2ec74a95
JH
221static void gpio_sysfs_free_irq(struct device *dev)
222{
223 struct gpiod_data *data = dev_get_drvdata(dev);
224 struct gpio_desc *desc = data->desc;
225
cef1717b 226 data->irq_flags = 0;
2ec74a95 227 free_irq(data->irq, data);
fdeb8e15 228 gpiochip_unlock_as_irq(desc->gdev->chip, gpio_chip_hwgpio(desc));
2ec74a95
JH
229 sysfs_put(data->value_kn);
230}
231
0eb4c6c2
AC
232static const struct {
233 const char *name;
cef1717b 234 unsigned char flags;
0eb4c6c2
AC
235} trigger_types[] = {
236 { "none", 0 },
cef1717b
JH
237 { "falling", GPIO_IRQF_TRIGGER_FALLING },
238 { "rising", GPIO_IRQF_TRIGGER_RISING },
239 { "both", GPIO_IRQF_TRIGGER_BOTH },
0eb4c6c2
AC
240};
241
6beac9d1 242static ssize_t edge_show(struct device *dev,
0eb4c6c2
AC
243 struct device_attribute *attr, char *buf)
244{
c43960fb 245 struct gpiod_data *data = dev_get_drvdata(dev);
f0b7866a
JH
246 ssize_t status = 0;
247 int i;
0eb4c6c2 248
6ffcb797 249 mutex_lock(&data->mutex);
0eb4c6c2 250
f0b7866a 251 for (i = 0; i < ARRAY_SIZE(trigger_types); i++) {
cef1717b 252 if (data->irq_flags == trigger_types[i].flags) {
f0b7866a
JH
253 status = sprintf(buf, "%s\n", trigger_types[i].name);
254 break;
255 }
0eb4c6c2
AC
256 }
257
6ffcb797
JH
258 mutex_unlock(&data->mutex);
259
0eb4c6c2
AC
260 return status;
261}
262
6beac9d1 263static ssize_t edge_store(struct device *dev,
0eb4c6c2
AC
264 struct device_attribute *attr, const char *buf, size_t size)
265{
b91e1807 266 struct gpiod_data *data = dev_get_drvdata(dev);
cef1717b 267 unsigned char flags;
2ec74a95 268 ssize_t status = size;
e4339ce3 269 int i;
0eb4c6c2 270
e4339ce3 271 for (i = 0; i < ARRAY_SIZE(trigger_types); i++) {
0eb4c6c2 272 if (sysfs_streq(trigger_types[i].name, buf))
e4339ce3
JH
273 break;
274 }
275
276 if (i == ARRAY_SIZE(trigger_types))
277 return -EINVAL;
0eb4c6c2 278
b91e1807
JH
279 flags = trigger_types[i].flags;
280
6ffcb797 281 mutex_lock(&data->mutex);
0eb4c6c2 282
cef1717b 283 if (flags == data->irq_flags) {
b91e1807
JH
284 status = size;
285 goto out_unlock;
286 }
287
cef1717b 288 if (data->irq_flags)
2ec74a95
JH
289 gpio_sysfs_free_irq(dev);
290
291 if (flags) {
292 status = gpio_sysfs_request_irq(dev, flags);
293 if (!status)
294 status = size;
295 }
0eb4c6c2 296
b91e1807 297out_unlock:
6ffcb797 298 mutex_unlock(&data->mutex);
0eb4c6c2
AC
299
300 return status;
301}
6beac9d1 302static DEVICE_ATTR_RW(edge);
0eb4c6c2 303
6ffcb797 304/* Caller holds gpiod-data mutex. */
2f323b85 305static int gpio_sysfs_set_active_low(struct device *dev, int value)
0eb4c6c2 306{
0f628508
JH
307 struct gpiod_data *data = dev_get_drvdata(dev);
308 struct gpio_desc *desc = data->desc;
0eb4c6c2 309 int status = 0;
cef1717b 310 unsigned int flags = data->irq_flags;
0eb4c6c2
AC
311
312 if (!!test_bit(FLAG_ACTIVE_LOW, &desc->flags) == !!value)
313 return 0;
314
315 if (value)
316 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
317 else
318 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
319
320 /* reconfigure poll(2) support if enabled on one edge only */
cef1717b
JH
321 if (flags == GPIO_IRQF_TRIGGER_FALLING ||
322 flags == GPIO_IRQF_TRIGGER_RISING) {
2ec74a95 323 gpio_sysfs_free_irq(dev);
cef1717b 324 status = gpio_sysfs_request_irq(dev, flags);
0eb4c6c2
AC
325 }
326
327 return status;
328}
329
6beac9d1 330static ssize_t active_low_show(struct device *dev,
0eb4c6c2
AC
331 struct device_attribute *attr, char *buf)
332{
c43960fb
JH
333 struct gpiod_data *data = dev_get_drvdata(dev);
334 struct gpio_desc *desc = data->desc;
0eb4c6c2
AC
335 ssize_t status;
336
6ffcb797 337 mutex_lock(&data->mutex);
0eb4c6c2 338
f0b7866a 339 status = sprintf(buf, "%d\n",
0eb4c6c2
AC
340 !!test_bit(FLAG_ACTIVE_LOW, &desc->flags));
341
6ffcb797 342 mutex_unlock(&data->mutex);
0eb4c6c2
AC
343
344 return status;
345}
346
6beac9d1 347static ssize_t active_low_store(struct device *dev,
0eb4c6c2
AC
348 struct device_attribute *attr, const char *buf, size_t size)
349{
6ffcb797 350 struct gpiod_data *data = dev_get_drvdata(dev);
0eb4c6c2 351 ssize_t status;
f0b7866a 352 long value;
0eb4c6c2 353
6ffcb797 354 mutex_lock(&data->mutex);
0eb4c6c2 355
f0b7866a
JH
356 status = kstrtol(buf, 0, &value);
357 if (status == 0)
2f323b85 358 status = gpio_sysfs_set_active_low(dev, value);
0eb4c6c2 359
6ffcb797 360 mutex_unlock(&data->mutex);
0eb4c6c2
AC
361
362 return status ? : size;
363}
6beac9d1 364static DEVICE_ATTR_RW(active_low);
0eb4c6c2 365
ebbeba12
JH
366static umode_t gpio_is_visible(struct kobject *kobj, struct attribute *attr,
367 int n)
368{
97cd738c 369 struct device *dev = kobj_to_dev(kobj);
c43960fb
JH
370 struct gpiod_data *data = dev_get_drvdata(dev);
371 struct gpio_desc *desc = data->desc;
ebbeba12 372 umode_t mode = attr->mode;
427fdeef 373 bool show_direction = data->direction_can_change;
ebbeba12
JH
374
375 if (attr == &dev_attr_direction.attr) {
376 if (!show_direction)
377 mode = 0;
378 } else if (attr == &dev_attr_edge.attr) {
379 if (gpiod_to_irq(desc) < 0)
380 mode = 0;
381 if (!show_direction && test_bit(FLAG_IS_OUT, &desc->flags))
382 mode = 0;
383 }
384
385 return mode;
386}
387
0915e6fe 388static struct attribute *gpio_attrs[] = {
ebbeba12
JH
389 &dev_attr_direction.attr,
390 &dev_attr_edge.attr,
0eb4c6c2
AC
391 &dev_attr_value.attr,
392 &dev_attr_active_low.attr,
393 NULL,
394};
ebbeba12
JH
395
396static const struct attribute_group gpio_group = {
397 .attrs = gpio_attrs,
398 .is_visible = gpio_is_visible,
399};
400
401static const struct attribute_group *gpio_groups[] = {
402 &gpio_group,
403 NULL
404};
0eb4c6c2
AC
405
406/*
407 * /sys/class/gpio/gpiochipN/
408 * /base ... matching gpio_chip.base (N)
409 * /label ... matching gpio_chip.label
410 * /ngpio ... matching gpio_chip.ngpio
411 */
412
6beac9d1 413static ssize_t base_show(struct device *dev,
0eb4c6c2
AC
414 struct device_attribute *attr, char *buf)
415{
416 const struct gpio_chip *chip = dev_get_drvdata(dev);
417
418 return sprintf(buf, "%d\n", chip->base);
419}
6beac9d1 420static DEVICE_ATTR_RO(base);
0eb4c6c2 421
6beac9d1 422static ssize_t label_show(struct device *dev,
0eb4c6c2
AC
423 struct device_attribute *attr, char *buf)
424{
425 const struct gpio_chip *chip = dev_get_drvdata(dev);
426
427 return sprintf(buf, "%s\n", chip->label ? : "");
428}
6beac9d1 429static DEVICE_ATTR_RO(label);
0eb4c6c2 430
6beac9d1 431static ssize_t ngpio_show(struct device *dev,
0eb4c6c2
AC
432 struct device_attribute *attr, char *buf)
433{
434 const struct gpio_chip *chip = dev_get_drvdata(dev);
435
436 return sprintf(buf, "%u\n", chip->ngpio);
437}
6beac9d1 438static DEVICE_ATTR_RO(ngpio);
0eb4c6c2 439
121b6a79 440static struct attribute *gpiochip_attrs[] = {
0eb4c6c2
AC
441 &dev_attr_base.attr,
442 &dev_attr_label.attr,
443 &dev_attr_ngpio.attr,
444 NULL,
445};
121b6a79 446ATTRIBUTE_GROUPS(gpiochip);
0eb4c6c2
AC
447
448/*
449 * /sys/class/gpio/export ... write-only
450 * integer N ... number of GPIO to export (full access)
451 * /sys/class/gpio/unexport ... write-only
452 * integer N ... number of GPIO to unexport
453 */
454static ssize_t export_store(struct class *class,
455 struct class_attribute *attr,
456 const char *buf, size_t len)
457{
458 long gpio;
459 struct gpio_desc *desc;
460 int status;
23cf00dd
MV
461 struct gpio_chip *gc;
462 int offset;
0eb4c6c2
AC
463
464 status = kstrtol(buf, 0, &gpio);
465 if (status < 0)
466 goto done;
467
f13a0b0b 468 desc = gpio_to_desc(gpio);
0eb4c6c2
AC
469 /* reject invalid GPIOs */
470 if (!desc) {
471 pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
472 return -EINVAL;
473 }
23cf00dd
MV
474 gc = desc->gdev->chip;
475 offset = gpio_chip_hwgpio(desc);
476 if (!gpiochip_line_is_valid(gc, offset)) {
477 pr_warn("%s: GPIO %ld masked\n", __func__, gpio);
478 return -EINVAL;
479 }
0eb4c6c2
AC
480
481 /* No extra locking here; FLAG_SYSFS just signifies that the
482 * request and export were done by on behalf of userspace, so
483 * they may be undone on its behalf too.
484 */
485
486 status = gpiod_request(desc, "sysfs");
8bbff39c 487 if (status) {
0eb4c6c2
AC
488 if (status == -EPROBE_DEFER)
489 status = -ENODEV;
490 goto done;
491 }
e10f72bf
AJ
492
493 status = gpiod_set_transitory(desc, false);
494 if (!status) {
495 status = gpiod_export(desc, true);
496 if (status < 0)
497 gpiod_free(desc);
498 else
499 set_bit(FLAG_SYSFS, &desc->flags);
500 }
0eb4c6c2
AC
501
502done:
503 if (status)
504 pr_debug("%s: status %d\n", __func__, status);
505 return status ? : len;
506}
d83bb159 507static CLASS_ATTR_WO(export);
0eb4c6c2
AC
508
509static ssize_t unexport_store(struct class *class,
510 struct class_attribute *attr,
511 const char *buf, size_t len)
512{
513 long gpio;
514 struct gpio_desc *desc;
515 int status;
516
517 status = kstrtol(buf, 0, &gpio);
518 if (status < 0)
519 goto done;
520
f13a0b0b 521 desc = gpio_to_desc(gpio);
0eb4c6c2
AC
522 /* reject bogus commands (gpio_unexport ignores them) */
523 if (!desc) {
524 pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
525 return -EINVAL;
526 }
527
528 status = -EINVAL;
529
530 /* No extra locking here; FLAG_SYSFS just signifies that the
531 * request and export were done by on behalf of userspace, so
532 * they may be undone on its behalf too.
533 */
534 if (test_and_clear_bit(FLAG_SYSFS, &desc->flags)) {
535 status = 0;
536 gpiod_free(desc);
537 }
538done:
539 if (status)
540 pr_debug("%s: status %d\n", __func__, status);
541 return status ? : len;
542}
d83bb159 543static CLASS_ATTR_WO(unexport);
0eb4c6c2 544
d83bb159
GKH
545static struct attribute *gpio_class_attrs[] = {
546 &class_attr_export.attr,
547 &class_attr_unexport.attr,
548 NULL,
0eb4c6c2 549};
d83bb159 550ATTRIBUTE_GROUPS(gpio_class);
0eb4c6c2
AC
551
552static struct class gpio_class = {
553 .name = "gpio",
554 .owner = THIS_MODULE,
555
d83bb159 556 .class_groups = gpio_class_groups,
0eb4c6c2
AC
557};
558
559
560/**
561 * gpiod_export - export a GPIO through sysfs
2d9d0519
TR
562 * @desc: GPIO to make available, already requested
563 * @direction_may_change: true if userspace may change GPIO direction
0eb4c6c2
AC
564 * Context: arch_initcall or later
565 *
566 * When drivers want to make a GPIO accessible to userspace after they
567 * have requested it -- perhaps while debugging, or as part of their
568 * public interface -- they may use this routine. If the GPIO can
569 * change direction (some can't) and the caller allows it, userspace
570 * will see "direction" sysfs attribute which may be used to change
571 * the gpio's direction. A "value" attribute will always be provided.
572 *
573 * Returns zero on success, else an error.
574 */
575int gpiod_export(struct gpio_desc *desc, bool direction_may_change)
576{
483d8211 577 struct gpio_chip *chip;
ff2b1359 578 struct gpio_device *gdev;
c43960fb 579 struct gpiod_data *data;
0eb4c6c2
AC
580 unsigned long flags;
581 int status;
582 const char *ioname = NULL;
583 struct device *dev;
584 int offset;
585
586 /* can't export until sysfs is available ... */
587 if (!gpio_class.p) {
588 pr_debug("%s: called too early!\n", __func__);
589 return -ENOENT;
590 }
591
592 if (!desc) {
593 pr_debug("%s: invalid gpio descriptor\n", __func__);
594 return -EINVAL;
595 }
596
fdeb8e15
LW
597 gdev = desc->gdev;
598 chip = gdev->chip;
483d8211 599
0eb4c6c2
AC
600 mutex_lock(&sysfs_lock);
601
483d8211 602 /* check if chip is being removed */
afbc4f31 603 if (!chip || !gdev->mockdev) {
483d8211 604 status = -ENODEV;
c43960fb 605 goto err_unlock;
483d8211
JH
606 }
607
0eb4c6c2
AC
608 spin_lock_irqsave(&gpio_lock, flags);
609 if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
610 test_bit(FLAG_EXPORT, &desc->flags)) {
611 spin_unlock_irqrestore(&gpio_lock, flags);
612 gpiod_dbg(desc, "%s: unavailable (requested=%d, exported=%d)\n",
613 __func__,
614 test_bit(FLAG_REQUESTED, &desc->flags),
615 test_bit(FLAG_EXPORT, &desc->flags));
616 status = -EPERM;
c43960fb 617 goto err_unlock;
0eb4c6c2 618 }
0eb4c6c2
AC
619 spin_unlock_irqrestore(&gpio_lock, flags);
620
c43960fb
JH
621 data = kzalloc(sizeof(*data), GFP_KERNEL);
622 if (!data) {
623 status = -ENOMEM;
624 goto err_unlock;
625 }
626
627 data->desc = desc;
6ffcb797 628 mutex_init(&data->mutex);
427fdeef
JH
629 if (chip->direction_input && chip->direction_output)
630 data->direction_can_change = direction_may_change;
631 else
632 data->direction_can_change = false;
c43960fb 633
0eb4c6c2 634 offset = gpio_chip_hwgpio(desc);
cecf58ab
JH
635 if (chip->names && chip->names[offset])
636 ioname = chip->names[offset];
0eb4c6c2 637
ff2b1359 638 dev = device_create_with_groups(&gpio_class, &gdev->dev,
c43960fb 639 MKDEV(0, 0), data, gpio_groups,
0915e6fe
JH
640 ioname ? ioname : "gpio%u",
641 desc_to_gpio(desc));
0eb4c6c2
AC
642 if (IS_ERR(dev)) {
643 status = PTR_ERR(dev);
c43960fb 644 goto err_free_data;
0eb4c6c2
AC
645 }
646
0eb4c6c2
AC
647 set_bit(FLAG_EXPORT, &desc->flags);
648 mutex_unlock(&sysfs_lock);
649 return 0;
650
c43960fb
JH
651err_free_data:
652 kfree(data);
653err_unlock:
0eb4c6c2
AC
654 mutex_unlock(&sysfs_lock);
655 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
656 return status;
657}
658EXPORT_SYMBOL_GPL(gpiod_export);
659
c43960fb 660static int match_export(struct device *dev, const void *desc)
0eb4c6c2 661{
c43960fb
JH
662 struct gpiod_data *data = dev_get_drvdata(dev);
663
664 return data->desc == desc;
0eb4c6c2
AC
665}
666
667/**
668 * gpiod_export_link - create a sysfs link to an exported GPIO node
669 * @dev: device under which to create symlink
670 * @name: name of the symlink
2d9d0519 671 * @desc: GPIO to create symlink to, already exported
0eb4c6c2
AC
672 *
673 * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
674 * node. Caller is responsible for unlinking.
675 *
676 * Returns zero on success, else an error.
677 */
678int gpiod_export_link(struct device *dev, const char *name,
679 struct gpio_desc *desc)
680{
56d30ec1
JH
681 struct device *cdev;
682 int ret;
0eb4c6c2
AC
683
684 if (!desc) {
685 pr_warn("%s: invalid GPIO\n", __func__);
686 return -EINVAL;
687 }
688
56d30ec1
JH
689 cdev = class_find_device(&gpio_class, NULL, desc, match_export);
690 if (!cdev)
691 return -ENODEV;
0eb4c6c2 692
56d30ec1
JH
693 ret = sysfs_create_link(&dev->kobj, &cdev->kobj, name);
694 put_device(cdev);
0eb4c6c2 695
56d30ec1 696 return ret;
0eb4c6c2
AC
697}
698EXPORT_SYMBOL_GPL(gpiod_export_link);
699
0eb4c6c2 700/**
31963eb0 701 * gpiod_unexport - reverse effect of gpiod_export()
2d9d0519 702 * @desc: GPIO to make unavailable
0eb4c6c2 703 *
31963eb0 704 * This is implicit on gpiod_free().
0eb4c6c2
AC
705 */
706void gpiod_unexport(struct gpio_desc *desc)
707{
72eba6f6
JH
708 struct gpiod_data *data;
709 struct device *dev;
0eb4c6c2
AC
710
711 if (!desc) {
712 pr_warn("%s: invalid GPIO\n", __func__);
713 return;
714 }
715
716 mutex_lock(&sysfs_lock);
717
72eba6f6
JH
718 if (!test_bit(FLAG_EXPORT, &desc->flags))
719 goto err_unlock;
0eb4c6c2 720
72eba6f6
JH
721 dev = class_find_device(&gpio_class, NULL, desc, match_export);
722 if (!dev)
723 goto err_unlock;
724
725 data = dev_get_drvdata(dev);
726
72eba6f6
JH
727 clear_bit(FLAG_EXPORT, &desc->flags);
728
729 device_unregister(dev);
730
731 /*
732 * Release irq after deregistration to prevent race with edge_store.
733 */
cef1717b 734 if (data->irq_flags)
72eba6f6 735 gpio_sysfs_free_irq(dev);
0eb4c6c2
AC
736
737 mutex_unlock(&sysfs_lock);
738
72eba6f6
JH
739 put_device(dev);
740 kfree(data);
0eb4c6c2 741
72eba6f6
JH
742 return;
743
744err_unlock:
745 mutex_unlock(&sysfs_lock);
0eb4c6c2
AC
746}
747EXPORT_SYMBOL_GPL(gpiod_unexport);
748
afbc4f31 749int gpiochip_sysfs_register(struct gpio_device *gdev)
0eb4c6c2 750{
0eb4c6c2 751 struct device *dev;
d27c1728 752 struct device *parent;
afbc4f31 753 struct gpio_chip *chip = gdev->chip;
0eb4c6c2 754
426577bd
JH
755 /*
756 * Many systems add gpio chips for SOC support very early,
0eb4c6c2 757 * before driver model support is available. In those cases we
426577bd 758 * register later, in gpiolib_sysfs_init() ... here we just
0eb4c6c2
AC
759 * verify that _some_ field of gpio_class got initialized.
760 */
761 if (!gpio_class.p)
762 return 0;
763
d27c1728
BJZ
764 /*
765 * For sysfs backward compatibility we need to preserve this
766 * preferred parenting to the gpio_chip parent field, if set.
767 */
768 if (chip->parent)
769 parent = chip->parent;
770 else
771 parent = &gdev->dev;
772
0eb4c6c2 773 /* use chip->base for the ID; it's already known to be unique */
ddd8891e
GU
774 dev = device_create_with_groups(&gpio_class, parent, MKDEV(0, 0), chip,
775 gpiochip_groups, GPIOCHIP_NAME "%d",
776 chip->base);
121b6a79 777 if (IS_ERR(dev))
6a4b6b0a 778 return PTR_ERR(dev);
3ff74be5
JH
779
780 mutex_lock(&sysfs_lock);
afbc4f31 781 gdev->mockdev = dev;
0eb4c6c2
AC
782 mutex_unlock(&sysfs_lock);
783
6a4b6b0a 784 return 0;
0eb4c6c2
AC
785}
786
afbc4f31 787void gpiochip_sysfs_unregister(struct gpio_device *gdev)
0eb4c6c2 788{
483d8211 789 struct gpio_desc *desc;
afbc4f31 790 struct gpio_chip *chip = gdev->chip;
483d8211 791 unsigned int i;
0eb4c6c2 792
afbc4f31 793 if (!gdev->mockdev)
6a4b6b0a 794 return;
0eb4c6c2 795
afbc4f31 796 device_unregister(gdev->mockdev);
6a4b6b0a
JH
797
798 /* prevent further gpiod exports */
799 mutex_lock(&sysfs_lock);
afbc4f31 800 gdev->mockdev = NULL;
6a4b6b0a 801 mutex_unlock(&sysfs_lock);
483d8211
JH
802
803 /* unregister gpiod class devices owned by sysfs */
804 for (i = 0; i < chip->ngpio; i++) {
fdeb8e15 805 desc = &gdev->descs[i];
483d8211
JH
806 if (test_and_clear_bit(FLAG_SYSFS, &desc->flags))
807 gpiod_free(desc);
808 }
0eb4c6c2
AC
809}
810
811static int __init gpiolib_sysfs_init(void)
812{
813 int status;
814 unsigned long flags;
ff2b1359 815 struct gpio_device *gdev;
0eb4c6c2
AC
816
817 status = class_register(&gpio_class);
818 if (status < 0)
819 return status;
820
821 /* Scan and register the gpio_chips which registered very
822 * early (e.g. before the class_register above was called).
823 *
824 * We run before arch_initcall() so chip->dev nodes can have
825 * registered, and so arch_initcall() can always gpio_export().
826 */
827 spin_lock_irqsave(&gpio_lock, flags);
ff2b1359 828 list_for_each_entry(gdev, &gpio_devices, list) {
afbc4f31 829 if (gdev->mockdev)
0eb4c6c2
AC
830 continue;
831
14141a93 832 /*
426577bd
JH
833 * TODO we yield gpio_lock here because
834 * gpiochip_sysfs_register() acquires a mutex. This is unsafe
835 * and needs to be fixed.
14141a93
AC
836 *
837 * Also it would be nice to use gpiochip_find() here so we
838 * can keep gpio_chips local to gpiolib.c, but the yield of
839 * gpio_lock prevents us from doing this.
840 */
0eb4c6c2 841 spin_unlock_irqrestore(&gpio_lock, flags);
afbc4f31 842 status = gpiochip_sysfs_register(gdev);
0eb4c6c2
AC
843 spin_lock_irqsave(&gpio_lock, flags);
844 }
845 spin_unlock_irqrestore(&gpio_lock, flags);
846
0eb4c6c2
AC
847 return status;
848}
849postcore_initcall(gpiolib_sysfs_init);