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