]>
Commit | Line | Data |
---|---|---|
5e4e6fb3 | 1 | #include <linux/bitops.h> |
d2876d08 DB |
2 | #include <linux/kernel.h> |
3 | #include <linux/module.h> | |
ff77c352 | 4 | #include <linux/interrupt.h> |
d2876d08 DB |
5 | #include <linux/irq.h> |
6 | #include <linux/spinlock.h> | |
1a989d0f | 7 | #include <linux/list.h> |
d8f388d8 DB |
8 | #include <linux/device.h> |
9 | #include <linux/err.h> | |
10 | #include <linux/debugfs.h> | |
11 | #include <linux/seq_file.h> | |
12 | #include <linux/gpio.h> | |
391c970c | 13 | #include <linux/of_gpio.h> |
ff77c352 | 14 | #include <linux/idr.h> |
5a0e3ad6 | 15 | #include <linux/slab.h> |
7b199811 | 16 | #include <linux/acpi.h> |
53e7cac3 | 17 | #include <linux/gpio/driver.h> |
0a6d3158 | 18 | #include <linux/gpio/machine.h> |
c771c2f4 | 19 | #include <linux/pinctrl/consumer.h> |
3c702e99 LW |
20 | #include <linux/cdev.h> |
21 | #include <linux/fs.h> | |
22 | #include <linux/uaccess.h> | |
8b92e17e | 23 | #include <linux/compat.h> |
d7c51b47 | 24 | #include <linux/anon_inodes.h> |
953b956a | 25 | #include <linux/file.h> |
61f922db LW |
26 | #include <linux/kfifo.h> |
27 | #include <linux/poll.h> | |
28 | #include <linux/timekeeping.h> | |
3c702e99 | 29 | #include <uapi/linux/gpio.h> |
d2876d08 | 30 | |
664e3e5a MW |
31 | #include "gpiolib.h" |
32 | ||
3f397c21 UKK |
33 | #define CREATE_TRACE_POINTS |
34 | #include <trace/events/gpio.h> | |
d2876d08 | 35 | |
79a9becd | 36 | /* Implementation infrastructure for GPIO interfaces. |
d2876d08 | 37 | * |
79a9becd AC |
38 | * The GPIO programming interface allows for inlining speed-critical |
39 | * get/set operations for common cases, so that access to SOC-integrated | |
40 | * GPIOs can sometimes cost only an instruction or two per bit. | |
d2876d08 DB |
41 | */ |
42 | ||
43 | ||
44 | /* When debugging, extend minimal trust to callers and platform code. | |
45 | * Also emit diagnostic messages that may help initial bringup, when | |
46 | * board setup or driver bugs are most common. | |
47 | * | |
48 | * Otherwise, minimize overhead in what may be bitbanging codepaths. | |
49 | */ | |
50 | #ifdef DEBUG | |
51 | #define extra_checks 1 | |
52 | #else | |
53 | #define extra_checks 0 | |
54 | #endif | |
55 | ||
ff2b1359 LW |
56 | /* Device and char device-related information */ |
57 | static DEFINE_IDA(gpio_ida); | |
3c702e99 LW |
58 | static dev_t gpio_devt; |
59 | #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */ | |
60 | static struct bus_type gpio_bus_type = { | |
61 | .name = "gpio", | |
62 | }; | |
ff2b1359 | 63 | |
d2876d08 DB |
64 | /* gpio_lock prevents conflicts during gpio_desc[] table updates. |
65 | * While any GPIO is requested, its gpio_chip is not removable; | |
66 | * each GPIO's "requested" flag serves as a lock and refcount. | |
67 | */ | |
0eb4c6c2 | 68 | DEFINE_SPINLOCK(gpio_lock); |
d2876d08 | 69 | |
bae48da2 AC |
70 | static DEFINE_MUTEX(gpio_lookup_lock); |
71 | static LIST_HEAD(gpio_lookup_list); | |
ff2b1359 | 72 | LIST_HEAD(gpio_devices); |
6d86750c JH |
73 | |
74 | static void gpiochip_free_hogs(struct gpio_chip *chip); | |
75 | static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip); | |
79b804cb MW |
76 | static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip); |
77 | static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip); | |
6d86750c | 78 | |
159f3cd9 | 79 | static bool gpiolib_initialized; |
6d86750c | 80 | |
d2876d08 DB |
81 | static inline void desc_set_label(struct gpio_desc *d, const char *label) |
82 | { | |
d2876d08 | 83 | d->label = label; |
d2876d08 DB |
84 | } |
85 | ||
372e722e AC |
86 | /** |
87 | * Convert a GPIO number to its descriptor | |
88 | */ | |
79a9becd | 89 | struct gpio_desc *gpio_to_desc(unsigned gpio) |
372e722e | 90 | { |
ff2b1359 | 91 | struct gpio_device *gdev; |
14e85c0e AC |
92 | unsigned long flags; |
93 | ||
94 | spin_lock_irqsave(&gpio_lock, flags); | |
95 | ||
ff2b1359 | 96 | list_for_each_entry(gdev, &gpio_devices, list) { |
fdeb8e15 LW |
97 | if (gdev->base <= gpio && |
98 | gdev->base + gdev->ngpio > gpio) { | |
14e85c0e | 99 | spin_unlock_irqrestore(&gpio_lock, flags); |
fdeb8e15 | 100 | return &gdev->descs[gpio - gdev->base]; |
14e85c0e AC |
101 | } |
102 | } | |
103 | ||
104 | spin_unlock_irqrestore(&gpio_lock, flags); | |
105 | ||
0e9a5edf AC |
106 | if (!gpio_is_valid(gpio)) |
107 | WARN(1, "invalid GPIO %d\n", gpio); | |
108 | ||
14e85c0e | 109 | return NULL; |
372e722e | 110 | } |
79a9becd | 111 | EXPORT_SYMBOL_GPL(gpio_to_desc); |
372e722e | 112 | |
d468bf9e | 113 | /** |
bb1e88cc | 114 | * Get the GPIO descriptor corresponding to the given hw number for this chip. |
d468bf9e | 115 | */ |
bb1e88cc AC |
116 | struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, |
117 | u16 hwnum) | |
d468bf9e | 118 | { |
fdeb8e15 LW |
119 | struct gpio_device *gdev = chip->gpiodev; |
120 | ||
121 | if (hwnum >= gdev->ngpio) | |
b7d0a28a | 122 | return ERR_PTR(-EINVAL); |
d468bf9e | 123 | |
fdeb8e15 | 124 | return &gdev->descs[hwnum]; |
d468bf9e | 125 | } |
372e722e AC |
126 | |
127 | /** | |
128 | * Convert a GPIO descriptor to the integer namespace. | |
129 | * This should disappear in the future but is needed since we still | |
130 | * use GPIO numbers for error messages and sysfs nodes | |
131 | */ | |
79a9becd | 132 | int desc_to_gpio(const struct gpio_desc *desc) |
372e722e | 133 | { |
fdeb8e15 | 134 | return desc->gdev->base + (desc - &desc->gdev->descs[0]); |
372e722e | 135 | } |
79a9becd | 136 | EXPORT_SYMBOL_GPL(desc_to_gpio); |
372e722e AC |
137 | |
138 | ||
79a9becd AC |
139 | /** |
140 | * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs | |
141 | * @desc: descriptor to return the chip of | |
142 | */ | |
143 | struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc) | |
372e722e | 144 | { |
fdeb8e15 LW |
145 | if (!desc || !desc->gdev || !desc->gdev->chip) |
146 | return NULL; | |
147 | return desc->gdev->chip; | |
372e722e | 148 | } |
79a9becd | 149 | EXPORT_SYMBOL_GPL(gpiod_to_chip); |
d2876d08 | 150 | |
8d0aab2f AV |
151 | /* dynamic allocation of GPIOs, e.g. on a hotplugged device */ |
152 | static int gpiochip_find_base(int ngpio) | |
153 | { | |
ff2b1359 | 154 | struct gpio_device *gdev; |
83cabe33 | 155 | int base = ARCH_NR_GPIOS - ngpio; |
8d0aab2f | 156 | |
ff2b1359 | 157 | list_for_each_entry_reverse(gdev, &gpio_devices, list) { |
83cabe33 | 158 | /* found a free space? */ |
fdeb8e15 | 159 | if (gdev->base + gdev->ngpio <= base) |
83cabe33 AC |
160 | break; |
161 | else | |
162 | /* nope, check the space right before the chip */ | |
fdeb8e15 | 163 | base = gdev->base - ngpio; |
8d0aab2f AV |
164 | } |
165 | ||
83cabe33 | 166 | if (gpio_is_valid(base)) { |
8d0aab2f | 167 | pr_debug("%s: found new base at %d\n", __func__, base); |
83cabe33 AC |
168 | return base; |
169 | } else { | |
170 | pr_err("%s: cannot find free range\n", __func__); | |
171 | return -ENOSPC; | |
169b6a7a | 172 | } |
169b6a7a AV |
173 | } |
174 | ||
79a9becd AC |
175 | /** |
176 | * gpiod_get_direction - return the current direction of a GPIO | |
177 | * @desc: GPIO to get the direction of | |
178 | * | |
179 | * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error. | |
180 | * | |
181 | * This function may sleep if gpiod_cansleep() is true. | |
182 | */ | |
8e53b0f1 | 183 | int gpiod_get_direction(struct gpio_desc *desc) |
80b0a602 MN |
184 | { |
185 | struct gpio_chip *chip; | |
372e722e | 186 | unsigned offset; |
80b0a602 MN |
187 | int status = -EINVAL; |
188 | ||
372e722e AC |
189 | chip = gpiod_to_chip(desc); |
190 | offset = gpio_chip_hwgpio(desc); | |
80b0a602 MN |
191 | |
192 | if (!chip->get_direction) | |
193 | return status; | |
194 | ||
372e722e | 195 | status = chip->get_direction(chip, offset); |
80b0a602 MN |
196 | if (status > 0) { |
197 | /* GPIOF_DIR_IN, or other positive */ | |
198 | status = 1; | |
8e53b0f1 | 199 | clear_bit(FLAG_IS_OUT, &desc->flags); |
80b0a602 MN |
200 | } |
201 | if (status == 0) { | |
202 | /* GPIOF_DIR_OUT */ | |
8e53b0f1 | 203 | set_bit(FLAG_IS_OUT, &desc->flags); |
80b0a602 MN |
204 | } |
205 | return status; | |
206 | } | |
79a9becd | 207 | EXPORT_SYMBOL_GPL(gpiod_get_direction); |
80b0a602 | 208 | |
1a989d0f AC |
209 | /* |
210 | * Add a new chip to the global chips list, keeping the list of chips sorted | |
ef7c7553 | 211 | * by range(means [base, base + ngpio - 1]) order. |
1a989d0f AC |
212 | * |
213 | * Return -EBUSY if the new chip overlaps with some other chip's integer | |
214 | * space. | |
215 | */ | |
ff2b1359 | 216 | static int gpiodev_add_to_list(struct gpio_device *gdev) |
1a989d0f | 217 | { |
a961f9b4 | 218 | struct gpio_device *prev, *next; |
1a989d0f | 219 | |
ff2b1359 | 220 | if (list_empty(&gpio_devices)) { |
a961f9b4 | 221 | /* initial entry in list */ |
ff2b1359 | 222 | list_add_tail(&gdev->list, &gpio_devices); |
e28ecca6 | 223 | return 0; |
1a989d0f AC |
224 | } |
225 | ||
a961f9b4 BJZ |
226 | next = list_entry(gpio_devices.next, struct gpio_device, list); |
227 | if (gdev->base + gdev->ngpio <= next->base) { | |
228 | /* add before first entry */ | |
229 | list_add(&gdev->list, &gpio_devices); | |
230 | return 0; | |
1a989d0f AC |
231 | } |
232 | ||
a961f9b4 BJZ |
233 | prev = list_entry(gpio_devices.prev, struct gpio_device, list); |
234 | if (prev->base + prev->ngpio <= gdev->base) { | |
235 | /* add behind last entry */ | |
236 | list_add_tail(&gdev->list, &gpio_devices); | |
96098df1 | 237 | return 0; |
1a989d0f AC |
238 | } |
239 | ||
a961f9b4 BJZ |
240 | list_for_each_entry_safe(prev, next, &gpio_devices, list) { |
241 | /* at the end of the list */ | |
242 | if (&next->list == &gpio_devices) | |
243 | break; | |
1a989d0f | 244 | |
a961f9b4 BJZ |
245 | /* add between prev and next */ |
246 | if (prev->base + prev->ngpio <= gdev->base | |
247 | && gdev->base + gdev->ngpio <= next->base) { | |
248 | list_add(&gdev->list, &prev->list); | |
249 | return 0; | |
250 | } | |
251 | } | |
252 | ||
253 | dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n"); | |
254 | return -EBUSY; | |
1a989d0f AC |
255 | } |
256 | ||
f881bab0 LW |
257 | /** |
258 | * Convert a GPIO name to its descriptor | |
259 | */ | |
260 | static struct gpio_desc *gpio_name_to_desc(const char * const name) | |
261 | { | |
ff2b1359 | 262 | struct gpio_device *gdev; |
f881bab0 LW |
263 | unsigned long flags; |
264 | ||
265 | spin_lock_irqsave(&gpio_lock, flags); | |
266 | ||
ff2b1359 | 267 | list_for_each_entry(gdev, &gpio_devices, list) { |
f881bab0 LW |
268 | int i; |
269 | ||
fdeb8e15 LW |
270 | for (i = 0; i != gdev->ngpio; ++i) { |
271 | struct gpio_desc *desc = &gdev->descs[i]; | |
f881bab0 | 272 | |
fdeb8e15 | 273 | if (!desc->name || !name) |
f881bab0 LW |
274 | continue; |
275 | ||
fdeb8e15 | 276 | if (!strcmp(desc->name, name)) { |
f881bab0 | 277 | spin_unlock_irqrestore(&gpio_lock, flags); |
fdeb8e15 | 278 | return desc; |
f881bab0 LW |
279 | } |
280 | } | |
281 | } | |
282 | ||
283 | spin_unlock_irqrestore(&gpio_lock, flags); | |
284 | ||
285 | return NULL; | |
286 | } | |
287 | ||
5f3ca732 MP |
288 | /* |
289 | * Takes the names from gc->names and checks if they are all unique. If they | |
290 | * are, they are assigned to their gpio descriptors. | |
291 | * | |
ed37915c | 292 | * Warning if one of the names is already used for a different GPIO. |
5f3ca732 MP |
293 | */ |
294 | static int gpiochip_set_desc_names(struct gpio_chip *gc) | |
295 | { | |
fdeb8e15 | 296 | struct gpio_device *gdev = gc->gpiodev; |
5f3ca732 MP |
297 | int i; |
298 | ||
299 | if (!gc->names) | |
300 | return 0; | |
301 | ||
302 | /* First check all names if they are unique */ | |
303 | for (i = 0; i != gc->ngpio; ++i) { | |
304 | struct gpio_desc *gpio; | |
305 | ||
306 | gpio = gpio_name_to_desc(gc->names[i]); | |
f881bab0 | 307 | if (gpio) |
fdeb8e15 | 308 | dev_warn(&gdev->dev, |
34ffd85d | 309 | "Detected name collision for GPIO name '%s'\n", |
f881bab0 | 310 | gc->names[i]); |
5f3ca732 MP |
311 | } |
312 | ||
313 | /* Then add all names to the GPIO descriptors */ | |
314 | for (i = 0; i != gc->ngpio; ++i) | |
fdeb8e15 | 315 | gdev->descs[i].name = gc->names[i]; |
5f3ca732 MP |
316 | |
317 | return 0; | |
318 | } | |
319 | ||
d7c51b47 LW |
320 | /* |
321 | * GPIO line handle management | |
322 | */ | |
323 | ||
324 | /** | |
325 | * struct linehandle_state - contains the state of a userspace handle | |
326 | * @gdev: the GPIO device the handle pertains to | |
327 | * @label: consumer label used to tag descriptors | |
328 | * @descs: the GPIO descriptors held by this handle | |
329 | * @numdescs: the number of descriptors held in the descs array | |
330 | */ | |
331 | struct linehandle_state { | |
332 | struct gpio_device *gdev; | |
333 | const char *label; | |
334 | struct gpio_desc *descs[GPIOHANDLES_MAX]; | |
335 | u32 numdescs; | |
336 | }; | |
337 | ||
e3e847c7 LPC |
338 | #define GPIOHANDLE_REQUEST_VALID_FLAGS \ |
339 | (GPIOHANDLE_REQUEST_INPUT | \ | |
340 | GPIOHANDLE_REQUEST_OUTPUT | \ | |
341 | GPIOHANDLE_REQUEST_ACTIVE_LOW | \ | |
342 | GPIOHANDLE_REQUEST_OPEN_DRAIN | \ | |
343 | GPIOHANDLE_REQUEST_OPEN_SOURCE) | |
344 | ||
d7c51b47 LW |
345 | static long linehandle_ioctl(struct file *filep, unsigned int cmd, |
346 | unsigned long arg) | |
347 | { | |
348 | struct linehandle_state *lh = filep->private_data; | |
349 | void __user *ip = (void __user *)arg; | |
350 | struct gpiohandle_data ghd; | |
351 | int i; | |
352 | ||
353 | if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) { | |
354 | int val; | |
355 | ||
3eded5d8 LPC |
356 | memset(&ghd, 0, sizeof(ghd)); |
357 | ||
d7c51b47 LW |
358 | /* TODO: check if descriptors are really input */ |
359 | for (i = 0; i < lh->numdescs; i++) { | |
360 | val = gpiod_get_value_cansleep(lh->descs[i]); | |
361 | if (val < 0) | |
362 | return val; | |
363 | ghd.values[i] = val; | |
364 | } | |
365 | ||
366 | if (copy_to_user(ip, &ghd, sizeof(ghd))) | |
367 | return -EFAULT; | |
368 | ||
369 | return 0; | |
370 | } else if (cmd == GPIOHANDLE_SET_LINE_VALUES_IOCTL) { | |
371 | int vals[GPIOHANDLES_MAX]; | |
372 | ||
373 | /* TODO: check if descriptors are really output */ | |
374 | if (copy_from_user(&ghd, ip, sizeof(ghd))) | |
375 | return -EFAULT; | |
376 | ||
377 | /* Clamp all values to [0,1] */ | |
378 | for (i = 0; i < lh->numdescs; i++) | |
379 | vals[i] = !!ghd.values[i]; | |
380 | ||
381 | /* Reuse the array setting function */ | |
382 | gpiod_set_array_value_complex(false, | |
383 | true, | |
384 | lh->numdescs, | |
385 | lh->descs, | |
386 | vals); | |
387 | return 0; | |
388 | } | |
389 | return -EINVAL; | |
390 | } | |
391 | ||
392 | #ifdef CONFIG_COMPAT | |
393 | static long linehandle_ioctl_compat(struct file *filep, unsigned int cmd, | |
394 | unsigned long arg) | |
395 | { | |
396 | return linehandle_ioctl(filep, cmd, (unsigned long)compat_ptr(arg)); | |
397 | } | |
398 | #endif | |
399 | ||
400 | static int linehandle_release(struct inode *inode, struct file *filep) | |
401 | { | |
402 | struct linehandle_state *lh = filep->private_data; | |
403 | struct gpio_device *gdev = lh->gdev; | |
404 | int i; | |
405 | ||
406 | for (i = 0; i < lh->numdescs; i++) | |
407 | gpiod_free(lh->descs[i]); | |
408 | kfree(lh->label); | |
409 | kfree(lh); | |
410 | put_device(&gdev->dev); | |
411 | return 0; | |
412 | } | |
413 | ||
414 | static const struct file_operations linehandle_fileops = { | |
415 | .release = linehandle_release, | |
416 | .owner = THIS_MODULE, | |
417 | .llseek = noop_llseek, | |
418 | .unlocked_ioctl = linehandle_ioctl, | |
419 | #ifdef CONFIG_COMPAT | |
420 | .compat_ioctl = linehandle_ioctl_compat, | |
421 | #endif | |
422 | }; | |
423 | ||
424 | static int linehandle_create(struct gpio_device *gdev, void __user *ip) | |
425 | { | |
426 | struct gpiohandle_request handlereq; | |
427 | struct linehandle_state *lh; | |
953b956a | 428 | struct file *file; |
d7c51b47 LW |
429 | int fd, i, ret; |
430 | ||
431 | if (copy_from_user(&handlereq, ip, sizeof(handlereq))) | |
432 | return -EFAULT; | |
433 | if ((handlereq.lines == 0) || (handlereq.lines > GPIOHANDLES_MAX)) | |
434 | return -EINVAL; | |
435 | ||
436 | lh = kzalloc(sizeof(*lh), GFP_KERNEL); | |
437 | if (!lh) | |
438 | return -ENOMEM; | |
439 | lh->gdev = gdev; | |
440 | get_device(&gdev->dev); | |
441 | ||
442 | /* Make sure this is terminated */ | |
443 | handlereq.consumer_label[sizeof(handlereq.consumer_label)-1] = '\0'; | |
444 | if (strlen(handlereq.consumer_label)) { | |
445 | lh->label = kstrdup(handlereq.consumer_label, | |
446 | GFP_KERNEL); | |
447 | if (!lh->label) { | |
448 | ret = -ENOMEM; | |
449 | goto out_free_lh; | |
450 | } | |
451 | } | |
452 | ||
453 | /* Request each GPIO */ | |
454 | for (i = 0; i < handlereq.lines; i++) { | |
455 | u32 offset = handlereq.lineoffsets[i]; | |
456 | u32 lflags = handlereq.flags; | |
457 | struct gpio_desc *desc; | |
458 | ||
e405f9fc LPC |
459 | if (offset >= gdev->ngpio) { |
460 | ret = -EINVAL; | |
461 | goto out_free_descs; | |
462 | } | |
463 | ||
e3e847c7 LPC |
464 | /* Return an error if a unknown flag is set */ |
465 | if (lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS) { | |
466 | ret = -EINVAL; | |
467 | goto out_free_descs; | |
468 | } | |
469 | ||
d7c51b47 LW |
470 | desc = &gdev->descs[offset]; |
471 | ret = gpiod_request(desc, lh->label); | |
472 | if (ret) | |
473 | goto out_free_descs; | |
474 | lh->descs[i] = desc; | |
475 | ||
476 | if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW) | |
477 | set_bit(FLAG_ACTIVE_LOW, &desc->flags); | |
478 | if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN) | |
479 | set_bit(FLAG_OPEN_DRAIN, &desc->flags); | |
480 | if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE) | |
481 | set_bit(FLAG_OPEN_SOURCE, &desc->flags); | |
482 | ||
483 | /* | |
484 | * Lines have to be requested explicitly for input | |
485 | * or output, else the line will be treated "as is". | |
486 | */ | |
487 | if (lflags & GPIOHANDLE_REQUEST_OUTPUT) { | |
488 | int val = !!handlereq.default_values[i]; | |
489 | ||
490 | ret = gpiod_direction_output(desc, val); | |
491 | if (ret) | |
492 | goto out_free_descs; | |
493 | } else if (lflags & GPIOHANDLE_REQUEST_INPUT) { | |
494 | ret = gpiod_direction_input(desc); | |
495 | if (ret) | |
496 | goto out_free_descs; | |
497 | } | |
498 | dev_dbg(&gdev->dev, "registered chardev handle for line %d\n", | |
499 | offset); | |
500 | } | |
e2f608be LW |
501 | /* Let i point at the last handle */ |
502 | i--; | |
d7c51b47 LW |
503 | lh->numdescs = handlereq.lines; |
504 | ||
953b956a | 505 | fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC); |
d7c51b47 LW |
506 | if (fd < 0) { |
507 | ret = fd; | |
508 | goto out_free_descs; | |
509 | } | |
510 | ||
953b956a LPC |
511 | file = anon_inode_getfile("gpio-linehandle", |
512 | &linehandle_fileops, | |
513 | lh, | |
514 | O_RDONLY | O_CLOEXEC); | |
515 | if (IS_ERR(file)) { | |
516 | ret = PTR_ERR(file); | |
517 | goto out_put_unused_fd; | |
518 | } | |
519 | ||
d7c51b47 | 520 | handlereq.fd = fd; |
d932cd49 | 521 | if (copy_to_user(ip, &handlereq, sizeof(handlereq))) { |
953b956a LPC |
522 | /* |
523 | * fput() will trigger the release() callback, so do not go onto | |
524 | * the regular error cleanup path here. | |
525 | */ | |
526 | fput(file); | |
527 | put_unused_fd(fd); | |
528 | return -EFAULT; | |
d932cd49 | 529 | } |
d7c51b47 | 530 | |
953b956a LPC |
531 | fd_install(fd, file); |
532 | ||
d7c51b47 LW |
533 | dev_dbg(&gdev->dev, "registered chardev handle for %d lines\n", |
534 | lh->numdescs); | |
535 | ||
536 | return 0; | |
537 | ||
953b956a LPC |
538 | out_put_unused_fd: |
539 | put_unused_fd(fd); | |
d7c51b47 LW |
540 | out_free_descs: |
541 | for (; i >= 0; i--) | |
542 | gpiod_free(lh->descs[i]); | |
543 | kfree(lh->label); | |
544 | out_free_lh: | |
545 | kfree(lh); | |
546 | put_device(&gdev->dev); | |
547 | return ret; | |
548 | } | |
549 | ||
61f922db LW |
550 | /* |
551 | * GPIO line event management | |
552 | */ | |
553 | ||
554 | /** | |
555 | * struct lineevent_state - contains the state of a userspace event | |
556 | * @gdev: the GPIO device the event pertains to | |
557 | * @label: consumer label used to tag descriptors | |
558 | * @desc: the GPIO descriptor held by this event | |
559 | * @eflags: the event flags this line was requested with | |
560 | * @irq: the interrupt that trigger in response to events on this GPIO | |
561 | * @wait: wait queue that handles blocking reads of events | |
562 | * @events: KFIFO for the GPIO events | |
563 | * @read_lock: mutex lock to protect reads from colliding with adding | |
564 | * new events to the FIFO | |
565 | */ | |
566 | struct lineevent_state { | |
567 | struct gpio_device *gdev; | |
568 | const char *label; | |
569 | struct gpio_desc *desc; | |
570 | u32 eflags; | |
571 | int irq; | |
572 | wait_queue_head_t wait; | |
573 | DECLARE_KFIFO(events, struct gpioevent_data, 16); | |
574 | struct mutex read_lock; | |
575 | }; | |
576 | ||
ac7dbb99 LPC |
577 | #define GPIOEVENT_REQUEST_VALID_FLAGS \ |
578 | (GPIOEVENT_REQUEST_RISING_EDGE | \ | |
579 | GPIOEVENT_REQUEST_FALLING_EDGE) | |
580 | ||
61f922db LW |
581 | static unsigned int lineevent_poll(struct file *filep, |
582 | struct poll_table_struct *wait) | |
583 | { | |
584 | struct lineevent_state *le = filep->private_data; | |
585 | unsigned int events = 0; | |
586 | ||
587 | poll_wait(filep, &le->wait, wait); | |
588 | ||
589 | if (!kfifo_is_empty(&le->events)) | |
590 | events = POLLIN | POLLRDNORM; | |
591 | ||
592 | return events; | |
593 | } | |
594 | ||
595 | ||
596 | static ssize_t lineevent_read(struct file *filep, | |
597 | char __user *buf, | |
598 | size_t count, | |
599 | loff_t *f_ps) | |
600 | { | |
601 | struct lineevent_state *le = filep->private_data; | |
602 | unsigned int copied; | |
603 | int ret; | |
604 | ||
605 | if (count < sizeof(struct gpioevent_data)) | |
606 | return -EINVAL; | |
607 | ||
608 | do { | |
609 | if (kfifo_is_empty(&le->events)) { | |
610 | if (filep->f_flags & O_NONBLOCK) | |
611 | return -EAGAIN; | |
612 | ||
613 | ret = wait_event_interruptible(le->wait, | |
614 | !kfifo_is_empty(&le->events)); | |
615 | if (ret) | |
616 | return ret; | |
617 | } | |
618 | ||
619 | if (mutex_lock_interruptible(&le->read_lock)) | |
620 | return -ERESTARTSYS; | |
621 | ret = kfifo_to_user(&le->events, buf, count, &copied); | |
622 | mutex_unlock(&le->read_lock); | |
623 | ||
624 | if (ret) | |
625 | return ret; | |
626 | ||
627 | /* | |
628 | * If we couldn't read anything from the fifo (a different | |
629 | * thread might have been faster) we either return -EAGAIN if | |
630 | * the file descriptor is non-blocking, otherwise we go back to | |
631 | * sleep and wait for more data to arrive. | |
632 | */ | |
633 | if (copied == 0 && (filep->f_flags & O_NONBLOCK)) | |
634 | return -EAGAIN; | |
635 | ||
636 | } while (copied == 0); | |
637 | ||
638 | return copied; | |
639 | } | |
640 | ||
641 | static int lineevent_release(struct inode *inode, struct file *filep) | |
642 | { | |
643 | struct lineevent_state *le = filep->private_data; | |
644 | struct gpio_device *gdev = le->gdev; | |
645 | ||
646 | free_irq(le->irq, le); | |
647 | gpiod_free(le->desc); | |
648 | kfree(le->label); | |
649 | kfree(le); | |
650 | put_device(&gdev->dev); | |
651 | return 0; | |
652 | } | |
653 | ||
654 | static long lineevent_ioctl(struct file *filep, unsigned int cmd, | |
655 | unsigned long arg) | |
656 | { | |
657 | struct lineevent_state *le = filep->private_data; | |
658 | void __user *ip = (void __user *)arg; | |
659 | struct gpiohandle_data ghd; | |
660 | ||
661 | /* | |
662 | * We can get the value for an event line but not set it, | |
663 | * because it is input by definition. | |
664 | */ | |
665 | if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) { | |
666 | int val; | |
667 | ||
d82aa4a8 LPC |
668 | memset(&ghd, 0, sizeof(ghd)); |
669 | ||
61f922db LW |
670 | val = gpiod_get_value_cansleep(le->desc); |
671 | if (val < 0) | |
672 | return val; | |
673 | ghd.values[0] = val; | |
674 | ||
675 | if (copy_to_user(ip, &ghd, sizeof(ghd))) | |
676 | return -EFAULT; | |
677 | ||
678 | return 0; | |
679 | } | |
680 | return -EINVAL; | |
681 | } | |
682 | ||
683 | #ifdef CONFIG_COMPAT | |
684 | static long lineevent_ioctl_compat(struct file *filep, unsigned int cmd, | |
685 | unsigned long arg) | |
686 | { | |
687 | return lineevent_ioctl(filep, cmd, (unsigned long)compat_ptr(arg)); | |
688 | } | |
689 | #endif | |
690 | ||
691 | static const struct file_operations lineevent_fileops = { | |
692 | .release = lineevent_release, | |
693 | .read = lineevent_read, | |
694 | .poll = lineevent_poll, | |
695 | .owner = THIS_MODULE, | |
696 | .llseek = noop_llseek, | |
697 | .unlocked_ioctl = lineevent_ioctl, | |
698 | #ifdef CONFIG_COMPAT | |
699 | .compat_ioctl = lineevent_ioctl_compat, | |
700 | #endif | |
701 | }; | |
702 | ||
33265b17 | 703 | static irqreturn_t lineevent_irq_thread(int irq, void *p) |
61f922db LW |
704 | { |
705 | struct lineevent_state *le = p; | |
706 | struct gpioevent_data ge; | |
707 | int ret; | |
708 | ||
709 | ge.timestamp = ktime_get_real_ns(); | |
710 | ||
711 | if (le->eflags & GPIOEVENT_REQUEST_BOTH_EDGES) { | |
712 | int level = gpiod_get_value_cansleep(le->desc); | |
713 | ||
714 | if (level) | |
715 | /* Emit low-to-high event */ | |
716 | ge.id = GPIOEVENT_EVENT_RISING_EDGE; | |
717 | else | |
718 | /* Emit high-to-low event */ | |
719 | ge.id = GPIOEVENT_EVENT_FALLING_EDGE; | |
720 | } else if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE) { | |
721 | /* Emit low-to-high event */ | |
722 | ge.id = GPIOEVENT_EVENT_RISING_EDGE; | |
723 | } else if (le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) { | |
724 | /* Emit high-to-low event */ | |
725 | ge.id = GPIOEVENT_EVENT_FALLING_EDGE; | |
bc0207a5 AB |
726 | } else { |
727 | return IRQ_NONE; | |
61f922db LW |
728 | } |
729 | ||
730 | ret = kfifo_put(&le->events, ge); | |
731 | if (ret != 0) | |
732 | wake_up_poll(&le->wait, POLLIN); | |
733 | ||
734 | return IRQ_HANDLED; | |
735 | } | |
736 | ||
737 | static int lineevent_create(struct gpio_device *gdev, void __user *ip) | |
738 | { | |
739 | struct gpioevent_request eventreq; | |
740 | struct lineevent_state *le; | |
741 | struct gpio_desc *desc; | |
953b956a | 742 | struct file *file; |
61f922db LW |
743 | u32 offset; |
744 | u32 lflags; | |
745 | u32 eflags; | |
746 | int fd; | |
747 | int ret; | |
748 | int irqflags = 0; | |
749 | ||
750 | if (copy_from_user(&eventreq, ip, sizeof(eventreq))) | |
751 | return -EFAULT; | |
752 | ||
753 | le = kzalloc(sizeof(*le), GFP_KERNEL); | |
754 | if (!le) | |
755 | return -ENOMEM; | |
756 | le->gdev = gdev; | |
757 | get_device(&gdev->dev); | |
758 | ||
759 | /* Make sure this is terminated */ | |
760 | eventreq.consumer_label[sizeof(eventreq.consumer_label)-1] = '\0'; | |
761 | if (strlen(eventreq.consumer_label)) { | |
762 | le->label = kstrdup(eventreq.consumer_label, | |
763 | GFP_KERNEL); | |
764 | if (!le->label) { | |
765 | ret = -ENOMEM; | |
766 | goto out_free_le; | |
767 | } | |
768 | } | |
769 | ||
770 | offset = eventreq.lineoffset; | |
771 | lflags = eventreq.handleflags; | |
772 | eflags = eventreq.eventflags; | |
773 | ||
b8b0e3d3 LPC |
774 | if (offset >= gdev->ngpio) { |
775 | ret = -EINVAL; | |
776 | goto out_free_label; | |
777 | } | |
778 | ||
ac7dbb99 LPC |
779 | /* Return an error if a unknown flag is set */ |
780 | if ((lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS) || | |
781 | (eflags & ~GPIOEVENT_REQUEST_VALID_FLAGS)) { | |
782 | ret = -EINVAL; | |
783 | goto out_free_label; | |
784 | } | |
785 | ||
61f922db LW |
786 | /* This is just wrong: we don't look for events on output lines */ |
787 | if (lflags & GPIOHANDLE_REQUEST_OUTPUT) { | |
788 | ret = -EINVAL; | |
789 | goto out_free_label; | |
790 | } | |
791 | ||
792 | desc = &gdev->descs[offset]; | |
793 | ret = gpiod_request(desc, le->label); | |
794 | if (ret) | |
795 | goto out_free_desc; | |
796 | le->desc = desc; | |
797 | le->eflags = eflags; | |
798 | ||
799 | if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW) | |
800 | set_bit(FLAG_ACTIVE_LOW, &desc->flags); | |
801 | if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN) | |
802 | set_bit(FLAG_OPEN_DRAIN, &desc->flags); | |
803 | if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE) | |
804 | set_bit(FLAG_OPEN_SOURCE, &desc->flags); | |
805 | ||
806 | ret = gpiod_direction_input(desc); | |
807 | if (ret) | |
808 | goto out_free_desc; | |
809 | ||
810 | le->irq = gpiod_to_irq(desc); | |
811 | if (le->irq <= 0) { | |
812 | ret = -ENODEV; | |
813 | goto out_free_desc; | |
814 | } | |
815 | ||
816 | if (eflags & GPIOEVENT_REQUEST_RISING_EDGE) | |
817 | irqflags |= IRQF_TRIGGER_RISING; | |
818 | if (eflags & GPIOEVENT_REQUEST_FALLING_EDGE) | |
819 | irqflags |= IRQF_TRIGGER_FALLING; | |
820 | irqflags |= IRQF_ONESHOT; | |
821 | irqflags |= IRQF_SHARED; | |
822 | ||
823 | INIT_KFIFO(le->events); | |
824 | init_waitqueue_head(&le->wait); | |
825 | mutex_init(&le->read_lock); | |
826 | ||
827 | /* Request a thread to read the events */ | |
828 | ret = request_threaded_irq(le->irq, | |
829 | NULL, | |
830 | lineevent_irq_thread, | |
831 | irqflags, | |
832 | le->label, | |
833 | le); | |
834 | if (ret) | |
835 | goto out_free_desc; | |
836 | ||
953b956a | 837 | fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC); |
61f922db LW |
838 | if (fd < 0) { |
839 | ret = fd; | |
840 | goto out_free_irq; | |
841 | } | |
842 | ||
953b956a LPC |
843 | file = anon_inode_getfile("gpio-event", |
844 | &lineevent_fileops, | |
845 | le, | |
846 | O_RDONLY | O_CLOEXEC); | |
847 | if (IS_ERR(file)) { | |
848 | ret = PTR_ERR(file); | |
849 | goto out_put_unused_fd; | |
850 | } | |
851 | ||
61f922db | 852 | eventreq.fd = fd; |
d932cd49 | 853 | if (copy_to_user(ip, &eventreq, sizeof(eventreq))) { |
953b956a LPC |
854 | /* |
855 | * fput() will trigger the release() callback, so do not go onto | |
856 | * the regular error cleanup path here. | |
857 | */ | |
858 | fput(file); | |
859 | put_unused_fd(fd); | |
860 | return -EFAULT; | |
d932cd49 | 861 | } |
61f922db | 862 | |
953b956a LPC |
863 | fd_install(fd, file); |
864 | ||
61f922db LW |
865 | return 0; |
866 | ||
953b956a LPC |
867 | out_put_unused_fd: |
868 | put_unused_fd(fd); | |
61f922db LW |
869 | out_free_irq: |
870 | free_irq(le->irq, le); | |
871 | out_free_desc: | |
872 | gpiod_free(le->desc); | |
873 | out_free_label: | |
874 | kfree(le->label); | |
875 | out_free_le: | |
876 | kfree(le); | |
877 | put_device(&gdev->dev); | |
878 | return ret; | |
879 | } | |
880 | ||
3c702e99 LW |
881 | /** |
882 | * gpio_ioctl() - ioctl handler for the GPIO chardev | |
883 | */ | |
884 | static long gpio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg) | |
885 | { | |
886 | struct gpio_device *gdev = filp->private_data; | |
887 | struct gpio_chip *chip = gdev->chip; | |
8b92e17e | 888 | void __user *ip = (void __user *)arg; |
3c702e99 LW |
889 | |
890 | /* We fail any subsequent ioctl():s when the chip is gone */ | |
891 | if (!chip) | |
892 | return -ENODEV; | |
893 | ||
521a2ad6 | 894 | /* Fill in the struct and pass to userspace */ |
3c702e99 | 895 | if (cmd == GPIO_GET_CHIPINFO_IOCTL) { |
521a2ad6 LW |
896 | struct gpiochip_info chipinfo; |
897 | ||
0f4bbb23 LPC |
898 | memset(&chipinfo, 0, sizeof(chipinfo)); |
899 | ||
3c702e99 LW |
900 | strncpy(chipinfo.name, dev_name(&gdev->dev), |
901 | sizeof(chipinfo.name)); | |
902 | chipinfo.name[sizeof(chipinfo.name)-1] = '\0'; | |
df4878e9 LW |
903 | strncpy(chipinfo.label, gdev->label, |
904 | sizeof(chipinfo.label)); | |
905 | chipinfo.label[sizeof(chipinfo.label)-1] = '\0'; | |
fdeb8e15 | 906 | chipinfo.lines = gdev->ngpio; |
3c702e99 LW |
907 | if (copy_to_user(ip, &chipinfo, sizeof(chipinfo))) |
908 | return -EFAULT; | |
909 | return 0; | |
521a2ad6 LW |
910 | } else if (cmd == GPIO_GET_LINEINFO_IOCTL) { |
911 | struct gpioline_info lineinfo; | |
912 | struct gpio_desc *desc; | |
913 | ||
914 | if (copy_from_user(&lineinfo, ip, sizeof(lineinfo))) | |
915 | return -EFAULT; | |
1f1cc456 | 916 | if (lineinfo.line_offset >= gdev->ngpio) |
521a2ad6 LW |
917 | return -EINVAL; |
918 | ||
919 | desc = &gdev->descs[lineinfo.line_offset]; | |
920 | if (desc->name) { | |
921 | strncpy(lineinfo.name, desc->name, | |
922 | sizeof(lineinfo.name)); | |
923 | lineinfo.name[sizeof(lineinfo.name)-1] = '\0'; | |
924 | } else { | |
925 | lineinfo.name[0] = '\0'; | |
926 | } | |
927 | if (desc->label) { | |
214338e3 LW |
928 | strncpy(lineinfo.consumer, desc->label, |
929 | sizeof(lineinfo.consumer)); | |
930 | lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0'; | |
521a2ad6 | 931 | } else { |
214338e3 | 932 | lineinfo.consumer[0] = '\0'; |
521a2ad6 LW |
933 | } |
934 | ||
935 | /* | |
936 | * Userspace only need to know that the kernel is using | |
937 | * this GPIO so it can't use it. | |
938 | */ | |
939 | lineinfo.flags = 0; | |
9d8cc89c LW |
940 | if (test_bit(FLAG_REQUESTED, &desc->flags) || |
941 | test_bit(FLAG_IS_HOGGED, &desc->flags) || | |
942 | test_bit(FLAG_USED_AS_IRQ, &desc->flags) || | |
943 | test_bit(FLAG_EXPORT, &desc->flags) || | |
944 | test_bit(FLAG_SYSFS, &desc->flags)) | |
521a2ad6 | 945 | lineinfo.flags |= GPIOLINE_FLAG_KERNEL; |
9d8cc89c | 946 | if (test_bit(FLAG_IS_OUT, &desc->flags)) |
521a2ad6 | 947 | lineinfo.flags |= GPIOLINE_FLAG_IS_OUT; |
9d8cc89c | 948 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) |
521a2ad6 | 949 | lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW; |
9d8cc89c | 950 | if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) |
521a2ad6 | 951 | lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN; |
9d8cc89c | 952 | if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) |
521a2ad6 LW |
953 | lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE; |
954 | ||
955 | if (copy_to_user(ip, &lineinfo, sizeof(lineinfo))) | |
956 | return -EFAULT; | |
957 | return 0; | |
d7c51b47 LW |
958 | } else if (cmd == GPIO_GET_LINEHANDLE_IOCTL) { |
959 | return linehandle_create(gdev, ip); | |
61f922db LW |
960 | } else if (cmd == GPIO_GET_LINEEVENT_IOCTL) { |
961 | return lineevent_create(gdev, ip); | |
3c702e99 LW |
962 | } |
963 | return -EINVAL; | |
964 | } | |
965 | ||
8b92e17e LW |
966 | #ifdef CONFIG_COMPAT |
967 | static long gpio_ioctl_compat(struct file *filp, unsigned int cmd, | |
968 | unsigned long arg) | |
969 | { | |
970 | return gpio_ioctl(filp, cmd, (unsigned long)compat_ptr(arg)); | |
971 | } | |
972 | #endif | |
973 | ||
3c702e99 LW |
974 | /** |
975 | * gpio_chrdev_open() - open the chardev for ioctl operations | |
976 | * @inode: inode for this chardev | |
977 | * @filp: file struct for storing private data | |
978 | * Returns 0 on success | |
979 | */ | |
980 | static int gpio_chrdev_open(struct inode *inode, struct file *filp) | |
981 | { | |
982 | struct gpio_device *gdev = container_of(inode->i_cdev, | |
983 | struct gpio_device, chrdev); | |
984 | ||
985 | /* Fail on open if the backing gpiochip is gone */ | |
fb505747 | 986 | if (!gdev->chip) |
3c702e99 LW |
987 | return -ENODEV; |
988 | get_device(&gdev->dev); | |
989 | filp->private_data = gdev; | |
f4e81c52 LPC |
990 | |
991 | return nonseekable_open(inode, filp); | |
3c702e99 LW |
992 | } |
993 | ||
994 | /** | |
995 | * gpio_chrdev_release() - close chardev after ioctl operations | |
996 | * @inode: inode for this chardev | |
997 | * @filp: file struct for storing private data | |
998 | * Returns 0 on success | |
999 | */ | |
1000 | static int gpio_chrdev_release(struct inode *inode, struct file *filp) | |
1001 | { | |
1002 | struct gpio_device *gdev = container_of(inode->i_cdev, | |
1003 | struct gpio_device, chrdev); | |
1004 | ||
3c702e99 LW |
1005 | put_device(&gdev->dev); |
1006 | return 0; | |
1007 | } | |
1008 | ||
1009 | ||
1010 | static const struct file_operations gpio_fileops = { | |
1011 | .release = gpio_chrdev_release, | |
1012 | .open = gpio_chrdev_open, | |
1013 | .owner = THIS_MODULE, | |
f4e81c52 | 1014 | .llseek = no_llseek, |
3c702e99 | 1015 | .unlocked_ioctl = gpio_ioctl, |
8b92e17e LW |
1016 | #ifdef CONFIG_COMPAT |
1017 | .compat_ioctl = gpio_ioctl_compat, | |
1018 | #endif | |
3c702e99 LW |
1019 | }; |
1020 | ||
ff2b1359 LW |
1021 | static void gpiodevice_release(struct device *dev) |
1022 | { | |
1023 | struct gpio_device *gdev = dev_get_drvdata(dev); | |
1024 | ||
1025 | list_del(&gdev->list); | |
1026 | ida_simple_remove(&gpio_ida, gdev->id); | |
476e2fc5 GR |
1027 | kfree(gdev->label); |
1028 | kfree(gdev->descs); | |
9efd9e69 | 1029 | kfree(gdev); |
ff2b1359 LW |
1030 | } |
1031 | ||
159f3cd9 GR |
1032 | static int gpiochip_setup_dev(struct gpio_device *gdev) |
1033 | { | |
1034 | int status; | |
1035 | ||
1036 | cdev_init(&gdev->chrdev, &gpio_fileops); | |
1037 | gdev->chrdev.owner = THIS_MODULE; | |
1038 | gdev->chrdev.kobj.parent = &gdev->dev.kobj; | |
1039 | gdev->dev.devt = MKDEV(MAJOR(gpio_devt), gdev->id); | |
1040 | status = cdev_add(&gdev->chrdev, gdev->dev.devt, 1); | |
1041 | if (status < 0) | |
1042 | chip_warn(gdev->chip, "failed to add char device %d:%d\n", | |
1043 | MAJOR(gpio_devt), gdev->id); | |
1044 | else | |
1045 | chip_dbg(gdev->chip, "added GPIO chardev (%d:%d)\n", | |
1046 | MAJOR(gpio_devt), gdev->id); | |
1047 | status = device_add(&gdev->dev); | |
1048 | if (status) | |
1049 | goto err_remove_chardev; | |
1050 | ||
1051 | status = gpiochip_sysfs_register(gdev); | |
1052 | if (status) | |
1053 | goto err_remove_device; | |
1054 | ||
1055 | /* From this point, the .release() function cleans up gpio_device */ | |
1056 | gdev->dev.release = gpiodevice_release; | |
159f3cd9 GR |
1057 | pr_debug("%s: registered GPIOs %d to %d on device: %s (%s)\n", |
1058 | __func__, gdev->base, gdev->base + gdev->ngpio - 1, | |
1059 | dev_name(&gdev->dev), gdev->chip->label ? : "generic"); | |
1060 | ||
1061 | return 0; | |
1062 | ||
1063 | err_remove_device: | |
1064 | device_del(&gdev->dev); | |
1065 | err_remove_chardev: | |
1066 | cdev_del(&gdev->chrdev); | |
1067 | return status; | |
1068 | } | |
1069 | ||
1070 | static void gpiochip_setup_devs(void) | |
1071 | { | |
1072 | struct gpio_device *gdev; | |
1073 | int err; | |
1074 | ||
1075 | list_for_each_entry(gdev, &gpio_devices, list) { | |
1076 | err = gpiochip_setup_dev(gdev); | |
1077 | if (err) | |
1078 | pr_err("%s: Failed to initialize gpio device (%d)\n", | |
1079 | dev_name(&gdev->dev), err); | |
1080 | } | |
1081 | } | |
1082 | ||
d2876d08 | 1083 | /** |
b08ea35a | 1084 | * gpiochip_add_data() - register a gpio_chip |
d2876d08 | 1085 | * @chip: the chip to register, with chip->base initialized |
14e85c0e | 1086 | * Context: potentially before irqs will work |
d2876d08 DB |
1087 | * |
1088 | * Returns a negative errno if the chip can't be registered, such as | |
1089 | * because the chip->base is invalid or already associated with a | |
1090 | * different chip. Otherwise it returns zero as a success code. | |
8d0aab2f | 1091 | * |
b08ea35a | 1092 | * When gpiochip_add_data() is called very early during boot, so that GPIOs |
c88402c2 | 1093 | * can be freely used, the chip->parent device must be registered before |
d8f388d8 DB |
1094 | * the gpio framework's arch_initcall(). Otherwise sysfs initialization |
1095 | * for GPIOs will fail rudely. | |
1096 | * | |
159f3cd9 GR |
1097 | * gpiochip_add_data() must only be called after gpiolib initialization, |
1098 | * ie after core_initcall(). | |
1099 | * | |
8d0aab2f AV |
1100 | * If chip->base is negative, this requests dynamic assignment of |
1101 | * a range of valid GPIOs. | |
d2876d08 | 1102 | */ |
b08ea35a | 1103 | int gpiochip_add_data(struct gpio_chip *chip, void *data) |
d2876d08 DB |
1104 | { |
1105 | unsigned long flags; | |
1106 | int status = 0; | |
ff2b1359 | 1107 | unsigned i; |
8d0aab2f | 1108 | int base = chip->base; |
ff2b1359 | 1109 | struct gpio_device *gdev; |
d2876d08 | 1110 | |
ff2b1359 LW |
1111 | /* |
1112 | * First: allocate and populate the internal stat container, and | |
1113 | * set up the struct device. | |
1114 | */ | |
969f07b4 | 1115 | gdev = kzalloc(sizeof(*gdev), GFP_KERNEL); |
ff2b1359 | 1116 | if (!gdev) |
14e85c0e | 1117 | return -ENOMEM; |
3c702e99 | 1118 | gdev->dev.bus = &gpio_bus_type; |
ff2b1359 LW |
1119 | gdev->chip = chip; |
1120 | chip->gpiodev = gdev; | |
1121 | if (chip->parent) { | |
1122 | gdev->dev.parent = chip->parent; | |
1123 | gdev->dev.of_node = chip->parent->of_node; | |
acc6e331 TR |
1124 | } |
1125 | ||
ff2b1359 LW |
1126 | #ifdef CONFIG_OF_GPIO |
1127 | /* If the gpiochip has an assigned OF node this takes precedence */ | |
acc6e331 TR |
1128 | if (chip->of_node) |
1129 | gdev->dev.of_node = chip->of_node; | |
ff2b1359 | 1130 | #endif |
acc6e331 | 1131 | |
ff2b1359 LW |
1132 | gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL); |
1133 | if (gdev->id < 0) { | |
1134 | status = gdev->id; | |
1135 | goto err_free_gdev; | |
1136 | } | |
1137 | dev_set_name(&gdev->dev, "gpiochip%d", gdev->id); | |
1138 | device_initialize(&gdev->dev); | |
1139 | dev_set_drvdata(&gdev->dev, gdev); | |
1140 | if (chip->parent && chip->parent->driver) | |
1141 | gdev->owner = chip->parent->driver->owner; | |
1142 | else if (chip->owner) | |
1143 | /* TODO: remove chip->owner */ | |
1144 | gdev->owner = chip->owner; | |
1145 | else | |
1146 | gdev->owner = THIS_MODULE; | |
d2876d08 | 1147 | |
476e2fc5 | 1148 | gdev->descs = kcalloc(chip->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL); |
1c3cdb18 | 1149 | if (!gdev->descs) { |
ff2b1359 LW |
1150 | status = -ENOMEM; |
1151 | goto err_free_gdev; | |
1152 | } | |
1153 | ||
5ed41cc4 BJZ |
1154 | if (chip->ngpio == 0) { |
1155 | chip_err(chip, "tried to insert a GPIO chip with zero lines\n"); | |
ff2b1359 | 1156 | status = -EINVAL; |
159f3cd9 | 1157 | goto err_free_descs; |
5ed41cc4 | 1158 | } |
df4878e9 LW |
1159 | |
1160 | if (chip->label) | |
476e2fc5 | 1161 | gdev->label = kstrdup(chip->label, GFP_KERNEL); |
df4878e9 | 1162 | else |
476e2fc5 | 1163 | gdev->label = kstrdup("unknown", GFP_KERNEL); |
df4878e9 LW |
1164 | if (!gdev->label) { |
1165 | status = -ENOMEM; | |
476e2fc5 | 1166 | goto err_free_descs; |
df4878e9 LW |
1167 | } |
1168 | ||
fdeb8e15 | 1169 | gdev->ngpio = chip->ngpio; |
43c54eca | 1170 | gdev->data = data; |
5ed41cc4 | 1171 | |
d2876d08 DB |
1172 | spin_lock_irqsave(&gpio_lock, flags); |
1173 | ||
fdeb8e15 LW |
1174 | /* |
1175 | * TODO: this allocates a Linux GPIO number base in the global | |
1176 | * GPIO numberspace for this chip. In the long run we want to | |
1177 | * get *rid* of this numberspace and use only descriptors, but | |
1178 | * it may be a pipe dream. It will not happen before we get rid | |
1179 | * of the sysfs interface anyways. | |
1180 | */ | |
8d0aab2f AV |
1181 | if (base < 0) { |
1182 | base = gpiochip_find_base(chip->ngpio); | |
1183 | if (base < 0) { | |
1184 | status = base; | |
225fce83 | 1185 | spin_unlock_irqrestore(&gpio_lock, flags); |
476e2fc5 | 1186 | goto err_free_label; |
8d0aab2f | 1187 | } |
fdeb8e15 LW |
1188 | /* |
1189 | * TODO: it should not be necessary to reflect the assigned | |
1190 | * base outside of the GPIO subsystem. Go over drivers and | |
1191 | * see if anyone makes use of this, else drop this and assign | |
1192 | * a poison instead. | |
1193 | */ | |
8d0aab2f AV |
1194 | chip->base = base; |
1195 | } | |
fdeb8e15 | 1196 | gdev->base = base; |
8d0aab2f | 1197 | |
ff2b1359 | 1198 | status = gpiodev_add_to_list(gdev); |
05aa5203 JH |
1199 | if (status) { |
1200 | spin_unlock_irqrestore(&gpio_lock, flags); | |
476e2fc5 | 1201 | goto err_free_label; |
05aa5203 | 1202 | } |
1a989d0f | 1203 | |
545ebd9a LW |
1204 | spin_unlock_irqrestore(&gpio_lock, flags); |
1205 | ||
ff2b1359 | 1206 | for (i = 0; i < chip->ngpio; i++) { |
1c3cdb18 | 1207 | struct gpio_desc *desc = &gdev->descs[i]; |
05aa5203 | 1208 | |
fdeb8e15 | 1209 | desc->gdev = gdev; |
72d32000 LW |
1210 | /* |
1211 | * REVISIT: most hardware initializes GPIOs as inputs | |
1212 | * (often with pullups enabled) so power usage is | |
1213 | * minimized. Linux code should set the gpio direction | |
1214 | * first thing; but until it does, and in case | |
1215 | * chip->get_direction is not set, we may expose the | |
1216 | * wrong direction in sysfs. | |
05aa5203 | 1217 | */ |
72d32000 LW |
1218 | |
1219 | if (chip->get_direction) { | |
1220 | /* | |
1221 | * If we have .get_direction, set up the initial | |
1222 | * direction flag from the hardware. | |
1223 | */ | |
1224 | int dir = chip->get_direction(chip, i); | |
1225 | ||
1226 | if (!dir) | |
1227 | set_bit(FLAG_IS_OUT, &desc->flags); | |
1228 | } else if (!chip->direction_input) { | |
1229 | /* | |
1230 | * If the chip lacks the .direction_input callback | |
1231 | * we logically assume all lines are outputs. | |
1232 | */ | |
1233 | set_bit(FLAG_IS_OUT, &desc->flags); | |
1234 | } | |
d2876d08 | 1235 | } |
14e85c0e | 1236 | |
f23f1516 | 1237 | #ifdef CONFIG_PINCTRL |
20ec3e39 | 1238 | INIT_LIST_HEAD(&gdev->pin_ranges); |
f23f1516 SH |
1239 | #endif |
1240 | ||
5f3ca732 MP |
1241 | status = gpiochip_set_desc_names(chip); |
1242 | if (status) | |
1243 | goto err_remove_from_list; | |
1244 | ||
79b804cb MW |
1245 | status = gpiochip_irqchip_init_valid_mask(chip); |
1246 | if (status) | |
1247 | goto err_remove_from_list; | |
1248 | ||
28355f81 TV |
1249 | status = of_gpiochip_add(chip); |
1250 | if (status) | |
1251 | goto err_remove_chip; | |
1252 | ||
664e3e5a | 1253 | acpi_gpiochip_add(chip); |
391c970c | 1254 | |
3c702e99 LW |
1255 | /* |
1256 | * By first adding the chardev, and then adding the device, | |
1257 | * we get a device node entry in sysfs under | |
1258 | * /sys/bus/gpio/devices/gpiochipN/dev that can be used for | |
1259 | * coldplug of device nodes and other udev business. | |
159f3cd9 GR |
1260 | * We can do this only if gpiolib has been initialized. |
1261 | * Otherwise, defer until later. | |
3c702e99 | 1262 | */ |
159f3cd9 GR |
1263 | if (gpiolib_initialized) { |
1264 | status = gpiochip_setup_dev(gdev); | |
1265 | if (status) | |
1266 | goto err_remove_chip; | |
1267 | } | |
cedb1881 | 1268 | return 0; |
3bae4811 | 1269 | |
225fce83 JH |
1270 | err_remove_chip: |
1271 | acpi_gpiochip_remove(chip); | |
6d86750c | 1272 | gpiochip_free_hogs(chip); |
225fce83 | 1273 | of_gpiochip_remove(chip); |
79b804cb | 1274 | gpiochip_irqchip_free_valid_mask(chip); |
5f3ca732 | 1275 | err_remove_from_list: |
225fce83 | 1276 | spin_lock_irqsave(&gpio_lock, flags); |
ff2b1359 | 1277 | list_del(&gdev->list); |
3bae4811 | 1278 | spin_unlock_irqrestore(&gpio_lock, flags); |
476e2fc5 GR |
1279 | err_free_label: |
1280 | kfree(gdev->label); | |
1281 | err_free_descs: | |
1282 | kfree(gdev->descs); | |
ff2b1359 LW |
1283 | err_free_gdev: |
1284 | ida_simple_remove(&gpio_ida, gdev->id); | |
d2876d08 | 1285 | /* failures here can mean systems won't boot... */ |
7589e59f | 1286 | pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__, |
fdeb8e15 LW |
1287 | gdev->base, gdev->base + gdev->ngpio - 1, |
1288 | chip->label ? : "generic"); | |
1289 | kfree(gdev); | |
d2876d08 DB |
1290 | return status; |
1291 | } | |
b08ea35a | 1292 | EXPORT_SYMBOL_GPL(gpiochip_add_data); |
d2876d08 | 1293 | |
43c54eca LW |
1294 | /** |
1295 | * gpiochip_get_data() - get per-subdriver data for the chip | |
1296 | */ | |
1297 | void *gpiochip_get_data(struct gpio_chip *chip) | |
1298 | { | |
1299 | return chip->gpiodev->data; | |
1300 | } | |
1301 | EXPORT_SYMBOL_GPL(gpiochip_get_data); | |
1302 | ||
d2876d08 DB |
1303 | /** |
1304 | * gpiochip_remove() - unregister a gpio_chip | |
1305 | * @chip: the chip to unregister | |
1306 | * | |
1307 | * A gpio_chip with any GPIOs still requested may not be removed. | |
1308 | */ | |
e1db1706 | 1309 | void gpiochip_remove(struct gpio_chip *chip) |
d2876d08 | 1310 | { |
ff2b1359 | 1311 | struct gpio_device *gdev = chip->gpiodev; |
fab28b89 | 1312 | struct gpio_desc *desc; |
d2876d08 | 1313 | unsigned long flags; |
1c3cdb18 | 1314 | unsigned i; |
fab28b89 | 1315 | bool requested = false; |
d2876d08 | 1316 | |
ff2b1359 | 1317 | /* FIXME: should the legacy sysfs handling be moved to gpio_device? */ |
afbc4f31 | 1318 | gpiochip_sysfs_unregister(gdev); |
5018ada6 | 1319 | gpiochip_free_hogs(chip); |
bd203bd5 BJZ |
1320 | /* Numb the device, cancelling all outstanding operations */ |
1321 | gdev->chip = NULL; | |
00acc3dc | 1322 | gpiochip_irqchip_remove(chip); |
6072b9dc | 1323 | acpi_gpiochip_remove(chip); |
9ef0d6f7 | 1324 | gpiochip_remove_pin_ranges(chip); |
391c970c | 1325 | of_gpiochip_remove(chip); |
43c54eca LW |
1326 | /* |
1327 | * We accept no more calls into the driver from this point, so | |
1328 | * NULL the driver data pointer | |
1329 | */ | |
1330 | gdev->data = NULL; | |
391c970c | 1331 | |
6798acaa | 1332 | spin_lock_irqsave(&gpio_lock, flags); |
fdeb8e15 | 1333 | for (i = 0; i < gdev->ngpio; i++) { |
1c3cdb18 | 1334 | desc = &gdev->descs[i]; |
fab28b89 JH |
1335 | if (test_bit(FLAG_REQUESTED, &desc->flags)) |
1336 | requested = true; | |
d2876d08 | 1337 | } |
d2876d08 | 1338 | spin_unlock_irqrestore(&gpio_lock, flags); |
14e85c0e | 1339 | |
fab28b89 | 1340 | if (requested) |
fdeb8e15 | 1341 | dev_crit(&gdev->dev, |
58383c78 | 1342 | "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n"); |
fab28b89 | 1343 | |
ff2b1359 LW |
1344 | /* |
1345 | * The gpiochip side puts its use of the device to rest here: | |
1346 | * if there are no userspace clients, the chardev and device will | |
1347 | * be removed, else it will be dangling until the last user is | |
1348 | * gone. | |
1349 | */ | |
f4833b8c RRD |
1350 | cdev_del(&gdev->chrdev); |
1351 | device_del(&gdev->dev); | |
ff2b1359 | 1352 | put_device(&gdev->dev); |
d2876d08 DB |
1353 | } |
1354 | EXPORT_SYMBOL_GPL(gpiochip_remove); | |
1355 | ||
0cf3292c LD |
1356 | static void devm_gpio_chip_release(struct device *dev, void *res) |
1357 | { | |
1358 | struct gpio_chip *chip = *(struct gpio_chip **)res; | |
1359 | ||
1360 | gpiochip_remove(chip); | |
1361 | } | |
1362 | ||
1363 | static int devm_gpio_chip_match(struct device *dev, void *res, void *data) | |
1364 | ||
1365 | { | |
1366 | struct gpio_chip **r = res; | |
1367 | ||
1368 | if (!r || !*r) { | |
1369 | WARN_ON(!r || !*r); | |
1370 | return 0; | |
1371 | } | |
1372 | ||
1373 | return *r == data; | |
1374 | } | |
1375 | ||
1376 | /** | |
1377 | * devm_gpiochip_add_data() - Resource manager piochip_add_data() | |
1378 | * @dev: the device pointer on which irq_chip belongs to. | |
1379 | * @chip: the chip to register, with chip->base initialized | |
1380 | * Context: potentially before irqs will work | |
1381 | * | |
1382 | * Returns a negative errno if the chip can't be registered, such as | |
1383 | * because the chip->base is invalid or already associated with a | |
1384 | * different chip. Otherwise it returns zero as a success code. | |
1385 | * | |
1386 | * The gpio chip automatically be released when the device is unbound. | |
1387 | */ | |
1388 | int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip, | |
1389 | void *data) | |
1390 | { | |
1391 | struct gpio_chip **ptr; | |
1392 | int ret; | |
1393 | ||
1394 | ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr), | |
1395 | GFP_KERNEL); | |
1396 | if (!ptr) | |
1397 | return -ENOMEM; | |
1398 | ||
1399 | ret = gpiochip_add_data(chip, data); | |
1400 | if (ret < 0) { | |
1401 | devres_free(ptr); | |
1402 | return ret; | |
1403 | } | |
1404 | ||
1405 | *ptr = chip; | |
1406 | devres_add(dev, ptr); | |
1407 | ||
1408 | return 0; | |
1409 | } | |
1410 | EXPORT_SYMBOL_GPL(devm_gpiochip_add_data); | |
1411 | ||
1412 | /** | |
1413 | * devm_gpiochip_remove() - Resource manager of gpiochip_remove() | |
1414 | * @dev: device for which which resource was allocated | |
1415 | * @chip: the chip to remove | |
1416 | * | |
1417 | * A gpio_chip with any GPIOs still requested may not be removed. | |
1418 | */ | |
1419 | void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip) | |
1420 | { | |
1421 | int ret; | |
1422 | ||
1423 | ret = devres_release(dev, devm_gpio_chip_release, | |
1424 | devm_gpio_chip_match, chip); | |
3988d663 | 1425 | WARN_ON(ret); |
0cf3292c LD |
1426 | } |
1427 | EXPORT_SYMBOL_GPL(devm_gpiochip_remove); | |
1428 | ||
594fa265 GL |
1429 | /** |
1430 | * gpiochip_find() - iterator for locating a specific gpio_chip | |
1431 | * @data: data to pass to match function | |
1432 | * @callback: Callback function to check gpio_chip | |
1433 | * | |
1434 | * Similar to bus_find_device. It returns a reference to a gpio_chip as | |
1435 | * determined by a user supplied @match callback. The callback should return | |
1436 | * 0 if the device doesn't match and non-zero if it does. If the callback is | |
1437 | * non-zero, this function will return to the caller and not iterate over any | |
1438 | * more gpio_chips. | |
1439 | */ | |
07ce8ec7 | 1440 | struct gpio_chip *gpiochip_find(void *data, |
6e2cf651 | 1441 | int (*match)(struct gpio_chip *chip, |
3d0f7cf0 | 1442 | void *data)) |
594fa265 | 1443 | { |
ff2b1359 | 1444 | struct gpio_device *gdev; |
acf06ff7 | 1445 | struct gpio_chip *chip = NULL; |
594fa265 | 1446 | unsigned long flags; |
594fa265 GL |
1447 | |
1448 | spin_lock_irqsave(&gpio_lock, flags); | |
ff2b1359 | 1449 | list_for_each_entry(gdev, &gpio_devices, list) |
acf06ff7 MY |
1450 | if (gdev->chip && match(gdev->chip, data)) { |
1451 | chip = gdev->chip; | |
594fa265 | 1452 | break; |
acf06ff7 | 1453 | } |
ff2b1359 | 1454 | |
594fa265 GL |
1455 | spin_unlock_irqrestore(&gpio_lock, flags); |
1456 | ||
1457 | return chip; | |
1458 | } | |
8fa0c9bf | 1459 | EXPORT_SYMBOL_GPL(gpiochip_find); |
d2876d08 | 1460 | |
79697ef9 AC |
1461 | static int gpiochip_match_name(struct gpio_chip *chip, void *data) |
1462 | { | |
1463 | const char *name = data; | |
1464 | ||
1465 | return !strcmp(chip->label, name); | |
1466 | } | |
1467 | ||
1468 | static struct gpio_chip *find_chip_by_name(const char *name) | |
1469 | { | |
1470 | return gpiochip_find((void *)name, gpiochip_match_name); | |
1471 | } | |
1472 | ||
14250520 LW |
1473 | #ifdef CONFIG_GPIOLIB_IRQCHIP |
1474 | ||
1475 | /* | |
1476 | * The following is irqchip helper code for gpiochips. | |
1477 | */ | |
1478 | ||
79b804cb MW |
1479 | static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip) |
1480 | { | |
1481 | int i; | |
1482 | ||
1483 | if (!gpiochip->irq_need_valid_mask) | |
1484 | return 0; | |
1485 | ||
1486 | gpiochip->irq_valid_mask = kcalloc(BITS_TO_LONGS(gpiochip->ngpio), | |
1487 | sizeof(long), GFP_KERNEL); | |
1488 | if (!gpiochip->irq_valid_mask) | |
1489 | return -ENOMEM; | |
1490 | ||
1491 | /* Assume by default all GPIOs are valid */ | |
1492 | for (i = 0; i < gpiochip->ngpio; i++) | |
1493 | set_bit(i, gpiochip->irq_valid_mask); | |
1494 | ||
1495 | return 0; | |
1496 | } | |
1497 | ||
1498 | static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip) | |
1499 | { | |
1500 | kfree(gpiochip->irq_valid_mask); | |
1501 | gpiochip->irq_valid_mask = NULL; | |
1502 | } | |
1503 | ||
1504 | static bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip, | |
1505 | unsigned int offset) | |
1506 | { | |
1507 | /* No mask means all valid */ | |
1508 | if (likely(!gpiochip->irq_valid_mask)) | |
1509 | return true; | |
1510 | return test_bit(offset, gpiochip->irq_valid_mask); | |
1511 | } | |
1512 | ||
14250520 | 1513 | /** |
d245b3f9 | 1514 | * gpiochip_set_cascaded_irqchip() - connects a cascaded irqchip to a gpiochip |
3f97d5fc LW |
1515 | * @gpiochip: the gpiochip to set the irqchip chain to |
1516 | * @irqchip: the irqchip to chain to the gpiochip | |
14250520 LW |
1517 | * @parent_irq: the irq number corresponding to the parent IRQ for this |
1518 | * chained irqchip | |
1519 | * @parent_handler: the parent interrupt handler for the accumulated IRQ | |
3f97d5fc LW |
1520 | * coming out of the gpiochip. If the interrupt is nested rather than |
1521 | * cascaded, pass NULL in this handler argument | |
14250520 | 1522 | */ |
d245b3f9 LW |
1523 | static void gpiochip_set_cascaded_irqchip(struct gpio_chip *gpiochip, |
1524 | struct irq_chip *irqchip, | |
1525 | int parent_irq, | |
1526 | irq_flow_handler_t parent_handler) | |
14250520 | 1527 | { |
83141a77 LW |
1528 | unsigned int offset; |
1529 | ||
83141a77 LW |
1530 | if (!gpiochip->irqdomain) { |
1531 | chip_err(gpiochip, "called %s before setting up irqchip\n", | |
1532 | __func__); | |
1c8732bb LW |
1533 | return; |
1534 | } | |
1535 | ||
3f97d5fc LW |
1536 | if (parent_handler) { |
1537 | if (gpiochip->can_sleep) { | |
1538 | chip_err(gpiochip, | |
1539 | "you cannot have chained interrupts on a " | |
1540 | "chip that may sleep\n"); | |
1541 | return; | |
1542 | } | |
3f97d5fc LW |
1543 | /* |
1544 | * The parent irqchip is already using the chip_data for this | |
1545 | * irqchip, so our callbacks simply use the handler_data. | |
1546 | */ | |
f7f87753 TG |
1547 | irq_set_chained_handler_and_data(parent_irq, parent_handler, |
1548 | gpiochip); | |
25e4fe92 | 1549 | |
d245b3f9 | 1550 | gpiochip->irq_chained_parent = parent_irq; |
3f97d5fc | 1551 | } |
83141a77 LW |
1552 | |
1553 | /* Set the parent IRQ for all affected IRQs */ | |
79b804cb MW |
1554 | for (offset = 0; offset < gpiochip->ngpio; offset++) { |
1555 | if (!gpiochip_irqchip_irq_valid(gpiochip, offset)) | |
1556 | continue; | |
83141a77 LW |
1557 | irq_set_parent(irq_find_mapping(gpiochip->irqdomain, offset), |
1558 | parent_irq); | |
79b804cb | 1559 | } |
14250520 | 1560 | } |
d245b3f9 LW |
1561 | |
1562 | /** | |
1563 | * gpiochip_set_chained_irqchip() - connects a chained irqchip to a gpiochip | |
1564 | * @gpiochip: the gpiochip to set the irqchip chain to | |
1565 | * @irqchip: the irqchip to chain to the gpiochip | |
1566 | * @parent_irq: the irq number corresponding to the parent IRQ for this | |
1567 | * chained irqchip | |
1568 | * @parent_handler: the parent interrupt handler for the accumulated IRQ | |
1569 | * coming out of the gpiochip. If the interrupt is nested rather than | |
1570 | * cascaded, pass NULL in this handler argument | |
1571 | */ | |
1572 | void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip, | |
1573 | struct irq_chip *irqchip, | |
1574 | int parent_irq, | |
1575 | irq_flow_handler_t parent_handler) | |
1576 | { | |
1577 | gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq, | |
1578 | parent_handler); | |
1579 | } | |
14250520 LW |
1580 | EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip); |
1581 | ||
d245b3f9 LW |
1582 | /** |
1583 | * gpiochip_set_nested_irqchip() - connects a nested irqchip to a gpiochip | |
1584 | * @gpiochip: the gpiochip to set the irqchip nested handler to | |
1585 | * @irqchip: the irqchip to nest to the gpiochip | |
1586 | * @parent_irq: the irq number corresponding to the parent IRQ for this | |
1587 | * nested irqchip | |
1588 | */ | |
1589 | void gpiochip_set_nested_irqchip(struct gpio_chip *gpiochip, | |
1590 | struct irq_chip *irqchip, | |
1591 | int parent_irq) | |
1592 | { | |
1593 | if (!gpiochip->irq_nested) { | |
1594 | chip_err(gpiochip, "tried to nest a chained gpiochip\n"); | |
1595 | return; | |
1596 | } | |
1597 | gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq, | |
1598 | NULL); | |
1599 | } | |
1600 | EXPORT_SYMBOL_GPL(gpiochip_set_nested_irqchip); | |
1601 | ||
14250520 LW |
1602 | /** |
1603 | * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip | |
1604 | * @d: the irqdomain used by this irqchip | |
1605 | * @irq: the global irq number used by this GPIO irqchip irq | |
1606 | * @hwirq: the local IRQ/GPIO line offset on this gpiochip | |
1607 | * | |
1608 | * This function will set up the mapping for a certain IRQ line on a | |
1609 | * gpiochip by assigning the gpiochip as chip data, and using the irqchip | |
1610 | * stored inside the gpiochip. | |
1611 | */ | |
1612 | static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq, | |
1613 | irq_hw_number_t hwirq) | |
1614 | { | |
1615 | struct gpio_chip *chip = d->host_data; | |
1616 | ||
14250520 | 1617 | irq_set_chip_data(irq, chip); |
a0a8bcf4 GS |
1618 | /* |
1619 | * This lock class tells lockdep that GPIO irqs are in a different | |
1620 | * category than their parents, so it won't report false recursion. | |
1621 | */ | |
1622 | irq_set_lockdep_class(irq, chip->lock_key); | |
7633fb95 | 1623 | irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler); |
d245b3f9 LW |
1624 | /* Chips that use nested thread handlers have them marked */ |
1625 | if (chip->irq_nested) | |
1c8732bb | 1626 | irq_set_nested_thread(irq, 1); |
14250520 | 1627 | irq_set_noprobe(irq); |
23393d49 | 1628 | |
1333b90f LW |
1629 | /* |
1630 | * No set-up of the hardware will happen if IRQ_TYPE_NONE | |
1631 | * is passed as default type. | |
1632 | */ | |
1633 | if (chip->irq_default_type != IRQ_TYPE_NONE) | |
1634 | irq_set_irq_type(irq, chip->irq_default_type); | |
14250520 LW |
1635 | |
1636 | return 0; | |
1637 | } | |
1638 | ||
c3626fde LW |
1639 | static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq) |
1640 | { | |
1c8732bb LW |
1641 | struct gpio_chip *chip = d->host_data; |
1642 | ||
d245b3f9 | 1643 | if (chip->irq_nested) |
1c8732bb | 1644 | irq_set_nested_thread(irq, 0); |
c3626fde LW |
1645 | irq_set_chip_and_handler(irq, NULL, NULL); |
1646 | irq_set_chip_data(irq, NULL); | |
1647 | } | |
1648 | ||
14250520 LW |
1649 | static const struct irq_domain_ops gpiochip_domain_ops = { |
1650 | .map = gpiochip_irq_map, | |
c3626fde | 1651 | .unmap = gpiochip_irq_unmap, |
14250520 LW |
1652 | /* Virtually all GPIO irqchips are twocell:ed */ |
1653 | .xlate = irq_domain_xlate_twocell, | |
1654 | }; | |
1655 | ||
1656 | static int gpiochip_irq_reqres(struct irq_data *d) | |
1657 | { | |
1658 | struct gpio_chip *chip = irq_data_get_irq_chip_data(d); | |
1659 | ||
ff2b1359 | 1660 | if (!try_module_get(chip->gpiodev->owner)) |
5b76e79c GS |
1661 | return -ENODEV; |
1662 | ||
e3a2e878 | 1663 | if (gpiochip_lock_as_irq(chip, d->hwirq)) { |
14250520 LW |
1664 | chip_err(chip, |
1665 | "unable to lock HW IRQ %lu for IRQ\n", | |
1666 | d->hwirq); | |
ff2b1359 | 1667 | module_put(chip->gpiodev->owner); |
14250520 LW |
1668 | return -EINVAL; |
1669 | } | |
1670 | return 0; | |
1671 | } | |
1672 | ||
1673 | static void gpiochip_irq_relres(struct irq_data *d) | |
1674 | { | |
1675 | struct gpio_chip *chip = irq_data_get_irq_chip_data(d); | |
1676 | ||
e3a2e878 | 1677 | gpiochip_unlock_as_irq(chip, d->hwirq); |
ff2b1359 | 1678 | module_put(chip->gpiodev->owner); |
14250520 LW |
1679 | } |
1680 | ||
1681 | static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset) | |
1682 | { | |
1683 | return irq_find_mapping(chip->irqdomain, offset); | |
1684 | } | |
1685 | ||
1686 | /** | |
1687 | * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip | |
1688 | * @gpiochip: the gpiochip to remove the irqchip from | |
1689 | * | |
1690 | * This is called only from gpiochip_remove() | |
1691 | */ | |
1692 | static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) | |
1693 | { | |
c3626fde LW |
1694 | unsigned int offset; |
1695 | ||
afa82fab MW |
1696 | acpi_gpiochip_free_interrupts(gpiochip); |
1697 | ||
d245b3f9 LW |
1698 | if (gpiochip->irq_chained_parent) { |
1699 | irq_set_chained_handler(gpiochip->irq_chained_parent, NULL); | |
1700 | irq_set_handler_data(gpiochip->irq_chained_parent, NULL); | |
25e4fe92 DES |
1701 | } |
1702 | ||
c3626fde LW |
1703 | /* Remove all IRQ mappings and delete the domain */ |
1704 | if (gpiochip->irqdomain) { | |
79b804cb MW |
1705 | for (offset = 0; offset < gpiochip->ngpio; offset++) { |
1706 | if (!gpiochip_irqchip_irq_valid(gpiochip, offset)) | |
1707 | continue; | |
e3893386 GS |
1708 | irq_dispose_mapping( |
1709 | irq_find_mapping(gpiochip->irqdomain, offset)); | |
79b804cb | 1710 | } |
14250520 | 1711 | irq_domain_remove(gpiochip->irqdomain); |
c3626fde | 1712 | } |
14250520 LW |
1713 | |
1714 | if (gpiochip->irqchip) { | |
1715 | gpiochip->irqchip->irq_request_resources = NULL; | |
1716 | gpiochip->irqchip->irq_release_resources = NULL; | |
1717 | gpiochip->irqchip = NULL; | |
1718 | } | |
79b804cb MW |
1719 | |
1720 | gpiochip_irqchip_free_valid_mask(gpiochip); | |
14250520 LW |
1721 | } |
1722 | ||
1723 | /** | |
739e6f59 | 1724 | * gpiochip_irqchip_add_key() - adds an irqchip to a gpiochip |
14250520 LW |
1725 | * @gpiochip: the gpiochip to add the irqchip to |
1726 | * @irqchip: the irqchip to add to the gpiochip | |
1727 | * @first_irq: if not dynamically assigned, the base (first) IRQ to | |
1728 | * allocate gpiochip irqs from | |
1729 | * @handler: the irq handler to use (often a predefined irq core function) | |
1333b90f LW |
1730 | * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE |
1731 | * to have the core avoid setting up any default type in the hardware. | |
d245b3f9 LW |
1732 | * @nested: whether this is a nested irqchip calling handle_nested_irq() |
1733 | * in its IRQ handler | |
a0a8bcf4 | 1734 | * @lock_key: lockdep class |
14250520 LW |
1735 | * |
1736 | * This function closely associates a certain irqchip with a certain | |
1737 | * gpiochip, providing an irq domain to translate the local IRQs to | |
1738 | * global irqs in the gpiolib core, and making sure that the gpiochip | |
1739 | * is passed as chip data to all related functions. Driver callbacks | |
09dd5f9e | 1740 | * need to use gpiochip_get_data() to get their local state containers back |
14250520 LW |
1741 | * from the gpiochip passed as chip data. An irqdomain will be stored |
1742 | * in the gpiochip that shall be used by the driver to handle IRQ number | |
1743 | * translation. The gpiochip will need to be initialized and registered | |
1744 | * before calling this function. | |
1745 | * | |
c3626fde LW |
1746 | * This function will handle two cell:ed simple IRQs and assumes all |
1747 | * the pins on the gpiochip can generate a unique IRQ. Everything else | |
14250520 LW |
1748 | * need to be open coded. |
1749 | */ | |
739e6f59 LW |
1750 | int gpiochip_irqchip_add_key(struct gpio_chip *gpiochip, |
1751 | struct irq_chip *irqchip, | |
1752 | unsigned int first_irq, | |
1753 | irq_flow_handler_t handler, | |
1754 | unsigned int type, | |
1755 | bool nested, | |
1756 | struct lock_class_key *lock_key) | |
14250520 LW |
1757 | { |
1758 | struct device_node *of_node; | |
79b804cb | 1759 | bool irq_base_set = false; |
14250520 | 1760 | unsigned int offset; |
c3626fde | 1761 | unsigned irq_base = 0; |
14250520 LW |
1762 | |
1763 | if (!gpiochip || !irqchip) | |
1764 | return -EINVAL; | |
1765 | ||
58383c78 | 1766 | if (!gpiochip->parent) { |
14250520 LW |
1767 | pr_err("missing gpiochip .dev parent pointer\n"); |
1768 | return -EINVAL; | |
1769 | } | |
d245b3f9 | 1770 | gpiochip->irq_nested = nested; |
58383c78 | 1771 | of_node = gpiochip->parent->of_node; |
14250520 LW |
1772 | #ifdef CONFIG_OF_GPIO |
1773 | /* | |
20a8a968 | 1774 | * If the gpiochip has an assigned OF node this takes precedence |
c88402c2 BJZ |
1775 | * FIXME: get rid of this and use gpiochip->parent->of_node |
1776 | * everywhere | |
14250520 LW |
1777 | */ |
1778 | if (gpiochip->of_node) | |
1779 | of_node = gpiochip->of_node; | |
1780 | #endif | |
332e99d5 | 1781 | /* |
0a1e0053 | 1782 | * Specifying a default trigger is a terrible idea if DT or ACPI is |
332e99d5 MZ |
1783 | * used to configure the interrupts, as you may end-up with |
1784 | * conflicting triggers. Tell the user, and reset to NONE. | |
1785 | */ | |
1786 | if (WARN(of_node && type != IRQ_TYPE_NONE, | |
1787 | "%s: Ignoring %d default trigger\n", of_node->full_name, type)) | |
1788 | type = IRQ_TYPE_NONE; | |
0a1e0053 MW |
1789 | if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) { |
1790 | acpi_handle_warn(ACPI_HANDLE(gpiochip->parent), | |
1791 | "Ignoring %d default trigger\n", type); | |
1792 | type = IRQ_TYPE_NONE; | |
1793 | } | |
332e99d5 | 1794 | |
14250520 LW |
1795 | gpiochip->irqchip = irqchip; |
1796 | gpiochip->irq_handler = handler; | |
1797 | gpiochip->irq_default_type = type; | |
1798 | gpiochip->to_irq = gpiochip_to_irq; | |
a0a8bcf4 | 1799 | gpiochip->lock_key = lock_key; |
14250520 LW |
1800 | gpiochip->irqdomain = irq_domain_add_simple(of_node, |
1801 | gpiochip->ngpio, first_irq, | |
1802 | &gpiochip_domain_ops, gpiochip); | |
1803 | if (!gpiochip->irqdomain) { | |
1804 | gpiochip->irqchip = NULL; | |
1805 | return -EINVAL; | |
1806 | } | |
8b67a1f0 RV |
1807 | |
1808 | /* | |
1809 | * It is possible for a driver to override this, but only if the | |
1810 | * alternative functions are both implemented. | |
1811 | */ | |
1812 | if (!irqchip->irq_request_resources && | |
1813 | !irqchip->irq_release_resources) { | |
1814 | irqchip->irq_request_resources = gpiochip_irq_reqres; | |
1815 | irqchip->irq_release_resources = gpiochip_irq_relres; | |
1816 | } | |
14250520 LW |
1817 | |
1818 | /* | |
1819 | * Prepare the mapping since the irqchip shall be orthogonal to | |
1820 | * any gpiochip calls. If the first_irq was zero, this is | |
1821 | * necessary to allocate descriptors for all IRQs. | |
1822 | */ | |
c3626fde | 1823 | for (offset = 0; offset < gpiochip->ngpio; offset++) { |
79b804cb MW |
1824 | if (!gpiochip_irqchip_irq_valid(gpiochip, offset)) |
1825 | continue; | |
c3626fde | 1826 | irq_base = irq_create_mapping(gpiochip->irqdomain, offset); |
79b804cb | 1827 | if (!irq_base_set) { |
c3626fde LW |
1828 | /* |
1829 | * Store the base into the gpiochip to be used when | |
1830 | * unmapping the irqs. | |
1831 | */ | |
1832 | gpiochip->irq_base = irq_base; | |
79b804cb MW |
1833 | irq_base_set = true; |
1834 | } | |
c3626fde | 1835 | } |
14250520 | 1836 | |
afa82fab MW |
1837 | acpi_gpiochip_request_interrupts(gpiochip); |
1838 | ||
14250520 LW |
1839 | return 0; |
1840 | } | |
739e6f59 | 1841 | EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_key); |
14250520 LW |
1842 | |
1843 | #else /* CONFIG_GPIOLIB_IRQCHIP */ | |
1844 | ||
1845 | static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {} | |
79b804cb MW |
1846 | static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip) |
1847 | { | |
1848 | return 0; | |
1849 | } | |
1850 | static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip) | |
1851 | { } | |
14250520 LW |
1852 | |
1853 | #endif /* CONFIG_GPIOLIB_IRQCHIP */ | |
1854 | ||
c771c2f4 JG |
1855 | /** |
1856 | * gpiochip_generic_request() - request the gpio function for a pin | |
1857 | * @chip: the gpiochip owning the GPIO | |
1858 | * @offset: the offset of the GPIO to request for GPIO function | |
1859 | */ | |
1860 | int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset) | |
1861 | { | |
fdeb8e15 | 1862 | return pinctrl_request_gpio(chip->gpiodev->base + offset); |
c771c2f4 JG |
1863 | } |
1864 | EXPORT_SYMBOL_GPL(gpiochip_generic_request); | |
1865 | ||
1866 | /** | |
1867 | * gpiochip_generic_free() - free the gpio function from a pin | |
1868 | * @chip: the gpiochip to request the gpio function for | |
1869 | * @offset: the offset of the GPIO to free from GPIO function | |
1870 | */ | |
1871 | void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset) | |
1872 | { | |
fdeb8e15 | 1873 | pinctrl_free_gpio(chip->gpiodev->base + offset); |
c771c2f4 JG |
1874 | } |
1875 | EXPORT_SYMBOL_GPL(gpiochip_generic_free); | |
1876 | ||
2956b5d9 MW |
1877 | /** |
1878 | * gpiochip_generic_config() - apply configuration for a pin | |
1879 | * @chip: the gpiochip owning the GPIO | |
1880 | * @offset: the offset of the GPIO to apply the configuration | |
1881 | * @config: the configuration to be applied | |
1882 | */ | |
1883 | int gpiochip_generic_config(struct gpio_chip *chip, unsigned offset, | |
1884 | unsigned long config) | |
1885 | { | |
1886 | return pinctrl_gpio_set_config(chip->gpiodev->base + offset, config); | |
1887 | } | |
1888 | EXPORT_SYMBOL_GPL(gpiochip_generic_config); | |
1889 | ||
f23f1516 | 1890 | #ifdef CONFIG_PINCTRL |
165adc9c | 1891 | |
586a87e6 CR |
1892 | /** |
1893 | * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping | |
1894 | * @chip: the gpiochip to add the range for | |
d32651f6 | 1895 | * @pctldev: the pin controller to map to |
586a87e6 CR |
1896 | * @gpio_offset: the start offset in the current gpio_chip number space |
1897 | * @pin_group: name of the pin group inside the pin controller | |
1898 | */ | |
1899 | int gpiochip_add_pingroup_range(struct gpio_chip *chip, | |
1900 | struct pinctrl_dev *pctldev, | |
1901 | unsigned int gpio_offset, const char *pin_group) | |
1902 | { | |
1903 | struct gpio_pin_range *pin_range; | |
fdeb8e15 | 1904 | struct gpio_device *gdev = chip->gpiodev; |
586a87e6 CR |
1905 | int ret; |
1906 | ||
1907 | pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL); | |
1908 | if (!pin_range) { | |
1a2a99c6 | 1909 | chip_err(chip, "failed to allocate pin ranges\n"); |
586a87e6 CR |
1910 | return -ENOMEM; |
1911 | } | |
1912 | ||
1913 | /* Use local offset as range ID */ | |
1914 | pin_range->range.id = gpio_offset; | |
1915 | pin_range->range.gc = chip; | |
1916 | pin_range->range.name = chip->label; | |
fdeb8e15 | 1917 | pin_range->range.base = gdev->base + gpio_offset; |
586a87e6 CR |
1918 | pin_range->pctldev = pctldev; |
1919 | ||
1920 | ret = pinctrl_get_group_pins(pctldev, pin_group, | |
1921 | &pin_range->range.pins, | |
1922 | &pin_range->range.npins); | |
61c6375d MN |
1923 | if (ret < 0) { |
1924 | kfree(pin_range); | |
586a87e6 | 1925 | return ret; |
61c6375d | 1926 | } |
586a87e6 CR |
1927 | |
1928 | pinctrl_add_gpio_range(pctldev, &pin_range->range); | |
1929 | ||
1a2a99c6 AS |
1930 | chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n", |
1931 | gpio_offset, gpio_offset + pin_range->range.npins - 1, | |
586a87e6 CR |
1932 | pinctrl_dev_get_devname(pctldev), pin_group); |
1933 | ||
20ec3e39 | 1934 | list_add_tail(&pin_range->node, &gdev->pin_ranges); |
586a87e6 CR |
1935 | |
1936 | return 0; | |
1937 | } | |
1938 | EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range); | |
1939 | ||
3f0f8670 LW |
1940 | /** |
1941 | * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping | |
1942 | * @chip: the gpiochip to add the range for | |
1943 | * @pinctrl_name: the dev_name() of the pin controller to map to | |
316511c0 LW |
1944 | * @gpio_offset: the start offset in the current gpio_chip number space |
1945 | * @pin_offset: the start offset in the pin controller number space | |
3f0f8670 LW |
1946 | * @npins: the number of pins from the offset of each pin space (GPIO and |
1947 | * pin controller) to accumulate in this range | |
1948 | */ | |
1e63d7b9 | 1949 | int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name, |
316511c0 | 1950 | unsigned int gpio_offset, unsigned int pin_offset, |
3f0f8670 | 1951 | unsigned int npins) |
f23f1516 SH |
1952 | { |
1953 | struct gpio_pin_range *pin_range; | |
fdeb8e15 | 1954 | struct gpio_device *gdev = chip->gpiodev; |
b4d4b1f0 | 1955 | int ret; |
f23f1516 | 1956 | |
3f0f8670 | 1957 | pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL); |
f23f1516 | 1958 | if (!pin_range) { |
1a2a99c6 | 1959 | chip_err(chip, "failed to allocate pin ranges\n"); |
1e63d7b9 | 1960 | return -ENOMEM; |
f23f1516 SH |
1961 | } |
1962 | ||
3f0f8670 | 1963 | /* Use local offset as range ID */ |
316511c0 | 1964 | pin_range->range.id = gpio_offset; |
3f0f8670 | 1965 | pin_range->range.gc = chip; |
f23f1516 | 1966 | pin_range->range.name = chip->label; |
fdeb8e15 | 1967 | pin_range->range.base = gdev->base + gpio_offset; |
316511c0 | 1968 | pin_range->range.pin_base = pin_offset; |
f23f1516 | 1969 | pin_range->range.npins = npins; |
192c369c | 1970 | pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name, |
f23f1516 | 1971 | &pin_range->range); |
8f23ca1a | 1972 | if (IS_ERR(pin_range->pctldev)) { |
b4d4b1f0 | 1973 | ret = PTR_ERR(pin_range->pctldev); |
1a2a99c6 | 1974 | chip_err(chip, "could not create pin range\n"); |
3f0f8670 | 1975 | kfree(pin_range); |
b4d4b1f0 | 1976 | return ret; |
3f0f8670 | 1977 | } |
1a2a99c6 AS |
1978 | chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n", |
1979 | gpio_offset, gpio_offset + npins - 1, | |
316511c0 LW |
1980 | pinctl_name, |
1981 | pin_offset, pin_offset + npins - 1); | |
f23f1516 | 1982 | |
20ec3e39 | 1983 | list_add_tail(&pin_range->node, &gdev->pin_ranges); |
1e63d7b9 LW |
1984 | |
1985 | return 0; | |
f23f1516 | 1986 | } |
165adc9c | 1987 | EXPORT_SYMBOL_GPL(gpiochip_add_pin_range); |
f23f1516 | 1988 | |
3f0f8670 LW |
1989 | /** |
1990 | * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings | |
1991 | * @chip: the chip to remove all the mappings for | |
1992 | */ | |
f23f1516 SH |
1993 | void gpiochip_remove_pin_ranges(struct gpio_chip *chip) |
1994 | { | |
1995 | struct gpio_pin_range *pin_range, *tmp; | |
20ec3e39 | 1996 | struct gpio_device *gdev = chip->gpiodev; |
f23f1516 | 1997 | |
20ec3e39 | 1998 | list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) { |
f23f1516 SH |
1999 | list_del(&pin_range->node); |
2000 | pinctrl_remove_gpio_range(pin_range->pctldev, | |
2001 | &pin_range->range); | |
3f0f8670 | 2002 | kfree(pin_range); |
f23f1516 SH |
2003 | } |
2004 | } | |
165adc9c LW |
2005 | EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges); |
2006 | ||
2007 | #endif /* CONFIG_PINCTRL */ | |
f23f1516 | 2008 | |
d2876d08 DB |
2009 | /* These "optional" allocation calls help prevent drivers from stomping |
2010 | * on each other, and help provide better diagnostics in debugfs. | |
2011 | * They're called even less than the "set direction" calls. | |
2012 | */ | |
77c2d792 | 2013 | static int __gpiod_request(struct gpio_desc *desc, const char *label) |
d2876d08 | 2014 | { |
fdeb8e15 | 2015 | struct gpio_chip *chip = desc->gdev->chip; |
77c2d792 | 2016 | int status; |
d2876d08 DB |
2017 | unsigned long flags; |
2018 | ||
bcabdef1 AC |
2019 | spin_lock_irqsave(&gpio_lock, flags); |
2020 | ||
d2876d08 | 2021 | /* NOTE: gpio_request() can be called in early boot, |
35e8bb51 | 2022 | * before IRQs are enabled, for non-sleeping (SOC) GPIOs. |
d2876d08 DB |
2023 | */ |
2024 | ||
2025 | if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) { | |
2026 | desc_set_label(desc, label ? : "?"); | |
2027 | status = 0; | |
438d8908 | 2028 | } else { |
d2876d08 | 2029 | status = -EBUSY; |
7460db56 | 2030 | goto done; |
35e8bb51 DB |
2031 | } |
2032 | ||
2033 | if (chip->request) { | |
2034 | /* chip->request may sleep */ | |
2035 | spin_unlock_irqrestore(&gpio_lock, flags); | |
372e722e | 2036 | status = chip->request(chip, gpio_chip_hwgpio(desc)); |
35e8bb51 DB |
2037 | spin_lock_irqsave(&gpio_lock, flags); |
2038 | ||
2039 | if (status < 0) { | |
2040 | desc_set_label(desc, NULL); | |
35e8bb51 | 2041 | clear_bit(FLAG_REQUESTED, &desc->flags); |
80b0a602 | 2042 | goto done; |
35e8bb51 | 2043 | } |
438d8908 | 2044 | } |
80b0a602 MN |
2045 | if (chip->get_direction) { |
2046 | /* chip->get_direction may sleep */ | |
2047 | spin_unlock_irqrestore(&gpio_lock, flags); | |
372e722e | 2048 | gpiod_get_direction(desc); |
80b0a602 MN |
2049 | spin_lock_irqsave(&gpio_lock, flags); |
2050 | } | |
77c2d792 MW |
2051 | done: |
2052 | spin_unlock_irqrestore(&gpio_lock, flags); | |
2053 | return status; | |
2054 | } | |
2055 | ||
fdeb8e15 LW |
2056 | /* |
2057 | * This descriptor validation needs to be inserted verbatim into each | |
2058 | * function taking a descriptor, so we need to use a preprocessor | |
54d77198 LW |
2059 | * macro to avoid endless duplication. If the desc is NULL it is an |
2060 | * optional GPIO and calls should just bail out. | |
fdeb8e15 LW |
2061 | */ |
2062 | #define VALIDATE_DESC(desc) do { \ | |
54d77198 LW |
2063 | if (!desc) \ |
2064 | return 0; \ | |
bfbbe44d LW |
2065 | if (IS_ERR(desc)) { \ |
2066 | pr_warn("%s: invalid GPIO (errorpointer)\n", __func__); \ | |
2067 | return PTR_ERR(desc); \ | |
2068 | } \ | |
54d77198 | 2069 | if (!desc->gdev) { \ |
bfbbe44d | 2070 | pr_warn("%s: invalid GPIO (no device)\n", __func__); \ |
fdeb8e15 LW |
2071 | return -EINVAL; \ |
2072 | } \ | |
2073 | if ( !desc->gdev->chip ) { \ | |
2074 | dev_warn(&desc->gdev->dev, \ | |
2075 | "%s: backing chip is gone\n", __func__); \ | |
2076 | return 0; \ | |
2077 | } } while (0) | |
2078 | ||
2079 | #define VALIDATE_DESC_VOID(desc) do { \ | |
54d77198 LW |
2080 | if (!desc) \ |
2081 | return; \ | |
bfbbe44d LW |
2082 | if (IS_ERR(desc)) { \ |
2083 | pr_warn("%s: invalid GPIO (errorpointer)\n", __func__); \ | |
2084 | return; \ | |
2085 | } \ | |
54d77198 | 2086 | if (!desc->gdev) { \ |
bfbbe44d | 2087 | pr_warn("%s: invalid GPIO (no device)\n", __func__); \ |
fdeb8e15 LW |
2088 | return; \ |
2089 | } \ | |
2090 | if (!desc->gdev->chip) { \ | |
2091 | dev_warn(&desc->gdev->dev, \ | |
2092 | "%s: backing chip is gone\n", __func__); \ | |
2093 | return; \ | |
2094 | } } while (0) | |
2095 | ||
2096 | ||
0eb4c6c2 | 2097 | int gpiod_request(struct gpio_desc *desc, const char *label) |
77c2d792 MW |
2098 | { |
2099 | int status = -EPROBE_DEFER; | |
fdeb8e15 | 2100 | struct gpio_device *gdev; |
77c2d792 | 2101 | |
fdeb8e15 LW |
2102 | VALIDATE_DESC(desc); |
2103 | gdev = desc->gdev; | |
77c2d792 | 2104 | |
fdeb8e15 | 2105 | if (try_module_get(gdev->owner)) { |
77c2d792 MW |
2106 | status = __gpiod_request(desc, label); |
2107 | if (status < 0) | |
fdeb8e15 | 2108 | module_put(gdev->owner); |
33a68e86 LW |
2109 | else |
2110 | get_device(&gdev->dev); | |
77c2d792 MW |
2111 | } |
2112 | ||
d2876d08 | 2113 | if (status) |
7589e59f | 2114 | gpiod_dbg(desc, "%s: status %d\n", __func__, status); |
77c2d792 | 2115 | |
d2876d08 DB |
2116 | return status; |
2117 | } | |
372e722e | 2118 | |
77c2d792 | 2119 | static bool __gpiod_free(struct gpio_desc *desc) |
d2876d08 | 2120 | { |
77c2d792 | 2121 | bool ret = false; |
d2876d08 | 2122 | unsigned long flags; |
35e8bb51 | 2123 | struct gpio_chip *chip; |
d2876d08 | 2124 | |
3d599d1c UKK |
2125 | might_sleep(); |
2126 | ||
372e722e | 2127 | gpiod_unexport(desc); |
d8f388d8 | 2128 | |
d2876d08 DB |
2129 | spin_lock_irqsave(&gpio_lock, flags); |
2130 | ||
fdeb8e15 | 2131 | chip = desc->gdev->chip; |
35e8bb51 DB |
2132 | if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) { |
2133 | if (chip->free) { | |
2134 | spin_unlock_irqrestore(&gpio_lock, flags); | |
9c4ba946 | 2135 | might_sleep_if(chip->can_sleep); |
372e722e | 2136 | chip->free(chip, gpio_chip_hwgpio(desc)); |
35e8bb51 DB |
2137 | spin_lock_irqsave(&gpio_lock, flags); |
2138 | } | |
d2876d08 | 2139 | desc_set_label(desc, NULL); |
07697461 | 2140 | clear_bit(FLAG_ACTIVE_LOW, &desc->flags); |
35e8bb51 | 2141 | clear_bit(FLAG_REQUESTED, &desc->flags); |
aca5ce14 | 2142 | clear_bit(FLAG_OPEN_DRAIN, &desc->flags); |
25553ff0 | 2143 | clear_bit(FLAG_OPEN_SOURCE, &desc->flags); |
f625d460 | 2144 | clear_bit(FLAG_IS_HOGGED, &desc->flags); |
77c2d792 MW |
2145 | ret = true; |
2146 | } | |
d2876d08 DB |
2147 | |
2148 | spin_unlock_irqrestore(&gpio_lock, flags); | |
77c2d792 MW |
2149 | return ret; |
2150 | } | |
2151 | ||
0eb4c6c2 | 2152 | void gpiod_free(struct gpio_desc *desc) |
77c2d792 | 2153 | { |
33a68e86 | 2154 | if (desc && desc->gdev && __gpiod_free(desc)) { |
fdeb8e15 | 2155 | module_put(desc->gdev->owner); |
33a68e86 LW |
2156 | put_device(&desc->gdev->dev); |
2157 | } else { | |
77c2d792 | 2158 | WARN_ON(extra_checks); |
33a68e86 | 2159 | } |
d2876d08 | 2160 | } |
372e722e | 2161 | |
d2876d08 DB |
2162 | /** |
2163 | * gpiochip_is_requested - return string iff signal was requested | |
2164 | * @chip: controller managing the signal | |
2165 | * @offset: of signal within controller's 0..(ngpio - 1) range | |
2166 | * | |
2167 | * Returns NULL if the GPIO is not currently requested, else a string. | |
9c8318ff AC |
2168 | * The string returned is the label passed to gpio_request(); if none has been |
2169 | * passed it is a meaningless, non-NULL constant. | |
d2876d08 DB |
2170 | * |
2171 | * This function is for use by GPIO controller drivers. The label can | |
2172 | * help with diagnostics, and knowing that the signal is used as a GPIO | |
2173 | * can help avoid accidentally multiplexing it to another controller. | |
2174 | */ | |
2175 | const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset) | |
2176 | { | |
6c0b4e6c | 2177 | struct gpio_desc *desc; |
d2876d08 | 2178 | |
48b5953e | 2179 | if (offset >= chip->ngpio) |
d2876d08 | 2180 | return NULL; |
6c0b4e6c | 2181 | |
1c3cdb18 | 2182 | desc = &chip->gpiodev->descs[offset]; |
6c0b4e6c | 2183 | |
372e722e | 2184 | if (test_bit(FLAG_REQUESTED, &desc->flags) == 0) |
d2876d08 | 2185 | return NULL; |
372e722e | 2186 | return desc->label; |
d2876d08 DB |
2187 | } |
2188 | EXPORT_SYMBOL_GPL(gpiochip_is_requested); | |
2189 | ||
77c2d792 MW |
2190 | /** |
2191 | * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor | |
2192 | * @desc: GPIO descriptor to request | |
2193 | * @label: label for the GPIO | |
2194 | * | |
2195 | * Function allows GPIO chip drivers to request and use their own GPIO | |
2196 | * descriptors via gpiolib API. Difference to gpiod_request() is that this | |
2197 | * function will not increase reference count of the GPIO chip module. This | |
2198 | * allows the GPIO chip module to be unloaded as needed (we assume that the | |
2199 | * GPIO chip driver handles freeing the GPIOs it has requested). | |
2200 | */ | |
abdc08a3 AC |
2201 | struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum, |
2202 | const char *label) | |
77c2d792 | 2203 | { |
abdc08a3 AC |
2204 | struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum); |
2205 | int err; | |
77c2d792 | 2206 | |
abdc08a3 AC |
2207 | if (IS_ERR(desc)) { |
2208 | chip_err(chip, "failed to get GPIO descriptor\n"); | |
2209 | return desc; | |
2210 | } | |
2211 | ||
2212 | err = __gpiod_request(desc, label); | |
2213 | if (err < 0) | |
2214 | return ERR_PTR(err); | |
77c2d792 | 2215 | |
abdc08a3 | 2216 | return desc; |
77c2d792 | 2217 | } |
f7d4ad98 | 2218 | EXPORT_SYMBOL_GPL(gpiochip_request_own_desc); |
77c2d792 MW |
2219 | |
2220 | /** | |
2221 | * gpiochip_free_own_desc - Free GPIO requested by the chip driver | |
2222 | * @desc: GPIO descriptor to free | |
2223 | * | |
2224 | * Function frees the given GPIO requested previously with | |
2225 | * gpiochip_request_own_desc(). | |
2226 | */ | |
2227 | void gpiochip_free_own_desc(struct gpio_desc *desc) | |
2228 | { | |
2229 | if (desc) | |
2230 | __gpiod_free(desc); | |
2231 | } | |
f7d4ad98 | 2232 | EXPORT_SYMBOL_GPL(gpiochip_free_own_desc); |
d2876d08 | 2233 | |
fdeb8e15 LW |
2234 | /* |
2235 | * Drivers MUST set GPIO direction before making get/set calls. In | |
d2876d08 DB |
2236 | * some cases this is done in early boot, before IRQs are enabled. |
2237 | * | |
2238 | * As a rule these aren't called more than once (except for drivers | |
2239 | * using the open-drain emulation idiom) so these are natural places | |
2240 | * to accumulate extra debugging checks. Note that we can't (yet) | |
2241 | * rely on gpio_request() having been called beforehand. | |
2242 | */ | |
2243 | ||
79a9becd AC |
2244 | /** |
2245 | * gpiod_direction_input - set the GPIO direction to input | |
2246 | * @desc: GPIO to set to input | |
2247 | * | |
2248 | * Set the direction of the passed GPIO to input, such as gpiod_get_value() can | |
2249 | * be called safely on it. | |
2250 | * | |
2251 | * Return 0 in case of success, else an error code. | |
2252 | */ | |
2253 | int gpiod_direction_input(struct gpio_desc *desc) | |
d2876d08 | 2254 | { |
d2876d08 | 2255 | struct gpio_chip *chip; |
d2876d08 DB |
2256 | int status = -EINVAL; |
2257 | ||
fdeb8e15 LW |
2258 | VALIDATE_DESC(desc); |
2259 | chip = desc->gdev->chip; | |
bcabdef1 | 2260 | |
be1a4b13 | 2261 | if (!chip->get || !chip->direction_input) { |
6424de5a MB |
2262 | gpiod_warn(desc, |
2263 | "%s: missing get() or direction_input() operations\n", | |
7589e59f | 2264 | __func__); |
be1a4b13 LW |
2265 | return -EIO; |
2266 | } | |
2267 | ||
d82da797 | 2268 | status = chip->direction_input(chip, gpio_chip_hwgpio(desc)); |
d2876d08 DB |
2269 | if (status == 0) |
2270 | clear_bit(FLAG_IS_OUT, &desc->flags); | |
3f397c21 | 2271 | |
372e722e | 2272 | trace_gpio_direction(desc_to_gpio(desc), 1, status); |
d82da797 | 2273 | |
d2876d08 DB |
2274 | return status; |
2275 | } | |
79a9becd | 2276 | EXPORT_SYMBOL_GPL(gpiod_direction_input); |
372e722e | 2277 | |
2956b5d9 MW |
2278 | static int gpio_set_drive_single_ended(struct gpio_chip *gc, unsigned offset, |
2279 | enum pin_config_param mode) | |
2280 | { | |
2281 | unsigned long config = { PIN_CONF_PACKED(mode, 0) }; | |
2282 | ||
2283 | return gc->set_config ? gc->set_config(gc, offset, config) : -ENOTSUPP; | |
2284 | } | |
2285 | ||
ef70bbe1 | 2286 | static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value) |
d2876d08 | 2287 | { |
c663e5f5 | 2288 | struct gpio_chip *gc = desc->gdev->chip; |
ad17731d | 2289 | int val = !!value; |
c663e5f5 | 2290 | int ret; |
d2876d08 | 2291 | |
d468bf9e LW |
2292 | /* GPIOs used for IRQs shall not be set as output */ |
2293 | if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) { | |
2294 | gpiod_err(desc, | |
2295 | "%s: tried to set a GPIO tied to an IRQ as output\n", | |
2296 | __func__); | |
2297 | return -EIO; | |
2298 | } | |
2299 | ||
c663e5f5 LW |
2300 | if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) { |
2301 | /* First see if we can enable open drain in hardware */ | |
2956b5d9 MW |
2302 | ret = gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc), |
2303 | PIN_CONFIG_DRIVE_OPEN_DRAIN); | |
2304 | if (!ret) | |
2305 | goto set_output_value; | |
c663e5f5 | 2306 | /* Emulate open drain by not actively driving the line high */ |
ad17731d | 2307 | if (val) |
c663e5f5 LW |
2308 | return gpiod_direction_input(desc); |
2309 | } | |
2310 | else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) { | |
2956b5d9 MW |
2311 | ret = gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc), |
2312 | PIN_CONFIG_DRIVE_OPEN_SOURCE); | |
2313 | if (!ret) | |
2314 | goto set_output_value; | |
c663e5f5 | 2315 | /* Emulate open source by not actively driving the line low */ |
ad17731d | 2316 | if (!val) |
c663e5f5 LW |
2317 | return gpiod_direction_input(desc); |
2318 | } else { | |
2956b5d9 MW |
2319 | gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc), |
2320 | PIN_CONFIG_DRIVE_PUSH_PULL); | |
c663e5f5 | 2321 | } |
25553ff0 | 2322 | |
c663e5f5 LW |
2323 | set_output_value: |
2324 | if (!gc->set || !gc->direction_output) { | |
6424de5a MB |
2325 | gpiod_warn(desc, |
2326 | "%s: missing set() or direction_output() operations\n", | |
2327 | __func__); | |
be1a4b13 LW |
2328 | return -EIO; |
2329 | } | |
2330 | ||
ad17731d | 2331 | ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val); |
c663e5f5 | 2332 | if (!ret) |
d2876d08 | 2333 | set_bit(FLAG_IS_OUT, &desc->flags); |
ad17731d | 2334 | trace_gpio_value(desc_to_gpio(desc), 0, val); |
c663e5f5 LW |
2335 | trace_gpio_direction(desc_to_gpio(desc), 0, ret); |
2336 | return ret; | |
d2876d08 | 2337 | } |
ef70bbe1 PZ |
2338 | |
2339 | /** | |
2340 | * gpiod_direction_output_raw - set the GPIO direction to output | |
2341 | * @desc: GPIO to set to output | |
2342 | * @value: initial output value of the GPIO | |
2343 | * | |
2344 | * Set the direction of the passed GPIO to output, such as gpiod_set_value() can | |
2345 | * be called safely on it. The initial value of the output must be specified | |
2346 | * as raw value on the physical line without regard for the ACTIVE_LOW status. | |
2347 | * | |
2348 | * Return 0 in case of success, else an error code. | |
2349 | */ | |
2350 | int gpiod_direction_output_raw(struct gpio_desc *desc, int value) | |
2351 | { | |
fdeb8e15 | 2352 | VALIDATE_DESC(desc); |
ef70bbe1 PZ |
2353 | return _gpiod_direction_output_raw(desc, value); |
2354 | } | |
2355 | EXPORT_SYMBOL_GPL(gpiod_direction_output_raw); | |
2356 | ||
2357 | /** | |
90df4fe0 | 2358 | * gpiod_direction_output - set the GPIO direction to output |
ef70bbe1 PZ |
2359 | * @desc: GPIO to set to output |
2360 | * @value: initial output value of the GPIO | |
2361 | * | |
2362 | * Set the direction of the passed GPIO to output, such as gpiod_set_value() can | |
2363 | * be called safely on it. The initial value of the output must be specified | |
2364 | * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into | |
2365 | * account. | |
2366 | * | |
2367 | * Return 0 in case of success, else an error code. | |
2368 | */ | |
2369 | int gpiod_direction_output(struct gpio_desc *desc, int value) | |
2370 | { | |
fdeb8e15 | 2371 | VALIDATE_DESC(desc); |
ef70bbe1 PZ |
2372 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) |
2373 | value = !value; | |
ad17731d LW |
2374 | else |
2375 | value = !!value; | |
ef70bbe1 PZ |
2376 | return _gpiod_direction_output_raw(desc, value); |
2377 | } | |
79a9becd | 2378 | EXPORT_SYMBOL_GPL(gpiod_direction_output); |
d2876d08 | 2379 | |
c4b5be98 | 2380 | /** |
79a9becd | 2381 | * gpiod_set_debounce - sets @debounce time for a @gpio |
c4b5be98 FB |
2382 | * @gpio: the gpio to set debounce time |
2383 | * @debounce: debounce time is microseconds | |
65d87656 LW |
2384 | * |
2385 | * returns -ENOTSUPP if the controller does not support setting | |
2386 | * debounce. | |
c4b5be98 | 2387 | */ |
79a9becd | 2388 | int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce) |
c4b5be98 | 2389 | { |
c4b5be98 | 2390 | struct gpio_chip *chip; |
2956b5d9 | 2391 | unsigned long config; |
c4b5be98 | 2392 | |
fdeb8e15 LW |
2393 | VALIDATE_DESC(desc); |
2394 | chip = desc->gdev->chip; | |
2956b5d9 | 2395 | if (!chip->set || !chip->set_config) { |
6424de5a | 2396 | gpiod_dbg(desc, |
2956b5d9 | 2397 | "%s: missing set() or set_config() operations\n", |
6424de5a | 2398 | __func__); |
65d87656 | 2399 | return -ENOTSUPP; |
be1a4b13 LW |
2400 | } |
2401 | ||
2956b5d9 MW |
2402 | config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce); |
2403 | return chip->set_config(chip, gpio_chip_hwgpio(desc), config); | |
c4b5be98 | 2404 | } |
79a9becd | 2405 | EXPORT_SYMBOL_GPL(gpiod_set_debounce); |
372e722e | 2406 | |
79a9becd AC |
2407 | /** |
2408 | * gpiod_is_active_low - test whether a GPIO is active-low or not | |
2409 | * @desc: the gpio descriptor to test | |
2410 | * | |
2411 | * Returns 1 if the GPIO is active-low, 0 otherwise. | |
2412 | */ | |
2413 | int gpiod_is_active_low(const struct gpio_desc *desc) | |
372e722e | 2414 | { |
fdeb8e15 | 2415 | VALIDATE_DESC(desc); |
79a9becd | 2416 | return test_bit(FLAG_ACTIVE_LOW, &desc->flags); |
372e722e | 2417 | } |
79a9becd | 2418 | EXPORT_SYMBOL_GPL(gpiod_is_active_low); |
d2876d08 DB |
2419 | |
2420 | /* I/O calls are only valid after configuration completed; the relevant | |
2421 | * "is this a valid GPIO" error checks should already have been done. | |
2422 | * | |
2423 | * "Get" operations are often inlinable as reading a pin value register, | |
2424 | * and masking the relevant bit in that register. | |
2425 | * | |
2426 | * When "set" operations are inlinable, they involve writing that mask to | |
2427 | * one register to set a low value, or a different register to set it high. | |
2428 | * Otherwise locking is needed, so there may be little value to inlining. | |
2429 | * | |
2430 | *------------------------------------------------------------------------ | |
2431 | * | |
2432 | * IMPORTANT!!! The hot paths -- get/set value -- assume that callers | |
2433 | * have requested the GPIO. That can include implicit requesting by | |
2434 | * a direction setting call. Marking a gpio as requested locks its chip | |
2435 | * in memory, guaranteeing that these table lookups need no more locking | |
2436 | * and that gpiochip_remove() will fail. | |
2437 | * | |
2438 | * REVISIT when debugging, consider adding some instrumentation to ensure | |
2439 | * that the GPIO was actually requested. | |
2440 | */ | |
2441 | ||
e20538b8 | 2442 | static int _gpiod_get_raw_value(const struct gpio_desc *desc) |
d2876d08 DB |
2443 | { |
2444 | struct gpio_chip *chip; | |
372e722e | 2445 | int offset; |
e20538b8 | 2446 | int value; |
d2876d08 | 2447 | |
fdeb8e15 | 2448 | chip = desc->gdev->chip; |
372e722e | 2449 | offset = gpio_chip_hwgpio(desc); |
e20538b8 | 2450 | value = chip->get ? chip->get(chip, offset) : -EIO; |
723a6303 | 2451 | value = value < 0 ? value : !!value; |
372e722e | 2452 | trace_gpio_value(desc_to_gpio(desc), 1, value); |
3f397c21 | 2453 | return value; |
d2876d08 | 2454 | } |
372e722e | 2455 | |
d2876d08 | 2456 | /** |
79a9becd AC |
2457 | * gpiod_get_raw_value() - return a gpio's raw value |
2458 | * @desc: gpio whose value will be returned | |
d2876d08 | 2459 | * |
79a9becd | 2460 | * Return the GPIO's raw value, i.e. the value of the physical line disregarding |
e20538b8 | 2461 | * its ACTIVE_LOW status, or negative errno on failure. |
79a9becd AC |
2462 | * |
2463 | * This function should be called from contexts where we cannot sleep, and will | |
2464 | * complain if the GPIO chip functions potentially sleep. | |
d2876d08 | 2465 | */ |
79a9becd | 2466 | int gpiod_get_raw_value(const struct gpio_desc *desc) |
d2876d08 | 2467 | { |
fdeb8e15 | 2468 | VALIDATE_DESC(desc); |
e4e449e8 | 2469 | /* Should be using gpio_get_value_cansleep() */ |
fdeb8e15 | 2470 | WARN_ON(desc->gdev->chip->can_sleep); |
79a9becd | 2471 | return _gpiod_get_raw_value(desc); |
d2876d08 | 2472 | } |
79a9becd | 2473 | EXPORT_SYMBOL_GPL(gpiod_get_raw_value); |
372e722e | 2474 | |
79a9becd AC |
2475 | /** |
2476 | * gpiod_get_value() - return a gpio's value | |
2477 | * @desc: gpio whose value will be returned | |
2478 | * | |
2479 | * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into | |
e20538b8 | 2480 | * account, or negative errno on failure. |
79a9becd AC |
2481 | * |
2482 | * This function should be called from contexts where we cannot sleep, and will | |
2483 | * complain if the GPIO chip functions potentially sleep. | |
2484 | */ | |
2485 | int gpiod_get_value(const struct gpio_desc *desc) | |
372e722e | 2486 | { |
79a9becd | 2487 | int value; |
fdeb8e15 LW |
2488 | |
2489 | VALIDATE_DESC(desc); | |
79a9becd | 2490 | /* Should be using gpio_get_value_cansleep() */ |
fdeb8e15 | 2491 | WARN_ON(desc->gdev->chip->can_sleep); |
79a9becd AC |
2492 | |
2493 | value = _gpiod_get_raw_value(desc); | |
e20538b8 BA |
2494 | if (value < 0) |
2495 | return value; | |
2496 | ||
79a9becd AC |
2497 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) |
2498 | value = !value; | |
2499 | ||
2500 | return value; | |
372e722e | 2501 | } |
79a9becd | 2502 | EXPORT_SYMBOL_GPL(gpiod_get_value); |
d2876d08 | 2503 | |
aca5ce14 LD |
2504 | /* |
2505 | * _gpio_set_open_drain_value() - Set the open drain gpio's value. | |
79a9becd | 2506 | * @desc: gpio descriptor whose state need to be set. |
20a8a968 | 2507 | * @value: Non-zero for setting it HIGH otherwise it will set to LOW. |
aca5ce14 | 2508 | */ |
23600969 | 2509 | static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value) |
aca5ce14 LD |
2510 | { |
2511 | int err = 0; | |
fdeb8e15 | 2512 | struct gpio_chip *chip = desc->gdev->chip; |
372e722e AC |
2513 | int offset = gpio_chip_hwgpio(desc); |
2514 | ||
aca5ce14 | 2515 | if (value) { |
372e722e | 2516 | err = chip->direction_input(chip, offset); |
aca5ce14 | 2517 | if (!err) |
372e722e | 2518 | clear_bit(FLAG_IS_OUT, &desc->flags); |
aca5ce14 | 2519 | } else { |
372e722e | 2520 | err = chip->direction_output(chip, offset, 0); |
aca5ce14 | 2521 | if (!err) |
372e722e | 2522 | set_bit(FLAG_IS_OUT, &desc->flags); |
aca5ce14 | 2523 | } |
372e722e | 2524 | trace_gpio_direction(desc_to_gpio(desc), value, err); |
aca5ce14 | 2525 | if (err < 0) |
6424de5a MB |
2526 | gpiod_err(desc, |
2527 | "%s: Error in set_value for open drain err %d\n", | |
2528 | __func__, err); | |
aca5ce14 LD |
2529 | } |
2530 | ||
25553ff0 | 2531 | /* |
79a9becd AC |
2532 | * _gpio_set_open_source_value() - Set the open source gpio's value. |
2533 | * @desc: gpio descriptor whose state need to be set. | |
20a8a968 | 2534 | * @value: Non-zero for setting it HIGH otherwise it will set to LOW. |
25553ff0 | 2535 | */ |
23600969 | 2536 | static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value) |
25553ff0 LD |
2537 | { |
2538 | int err = 0; | |
fdeb8e15 | 2539 | struct gpio_chip *chip = desc->gdev->chip; |
372e722e AC |
2540 | int offset = gpio_chip_hwgpio(desc); |
2541 | ||
25553ff0 | 2542 | if (value) { |
372e722e | 2543 | err = chip->direction_output(chip, offset, 1); |
25553ff0 | 2544 | if (!err) |
372e722e | 2545 | set_bit(FLAG_IS_OUT, &desc->flags); |
25553ff0 | 2546 | } else { |
372e722e | 2547 | err = chip->direction_input(chip, offset); |
25553ff0 | 2548 | if (!err) |
372e722e | 2549 | clear_bit(FLAG_IS_OUT, &desc->flags); |
25553ff0 | 2550 | } |
372e722e | 2551 | trace_gpio_direction(desc_to_gpio(desc), !value, err); |
25553ff0 | 2552 | if (err < 0) |
6424de5a MB |
2553 | gpiod_err(desc, |
2554 | "%s: Error in set_value for open source err %d\n", | |
2555 | __func__, err); | |
25553ff0 LD |
2556 | } |
2557 | ||
23600969 | 2558 | static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value) |
d2876d08 DB |
2559 | { |
2560 | struct gpio_chip *chip; | |
2561 | ||
fdeb8e15 | 2562 | chip = desc->gdev->chip; |
372e722e AC |
2563 | trace_gpio_value(desc_to_gpio(desc), 0, value); |
2564 | if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) | |
2565 | _gpio_set_open_drain_value(desc, value); | |
2566 | else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) | |
2567 | _gpio_set_open_source_value(desc, value); | |
aca5ce14 | 2568 | else |
372e722e AC |
2569 | chip->set(chip, gpio_chip_hwgpio(desc), value); |
2570 | } | |
2571 | ||
5f424243 RI |
2572 | /* |
2573 | * set multiple outputs on the same chip; | |
2574 | * use the chip's set_multiple function if available; | |
2575 | * otherwise set the outputs sequentially; | |
2576 | * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word | |
2577 | * defines which outputs are to be changed | |
2578 | * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word | |
2579 | * defines the values the outputs specified by mask are to be set to | |
2580 | */ | |
2581 | static void gpio_chip_set_multiple(struct gpio_chip *chip, | |
2582 | unsigned long *mask, unsigned long *bits) | |
2583 | { | |
2584 | if (chip->set_multiple) { | |
2585 | chip->set_multiple(chip, mask, bits); | |
2586 | } else { | |
5e4e6fb3 AS |
2587 | unsigned int i; |
2588 | ||
2589 | /* set outputs if the corresponding mask bit is set */ | |
2590 | for_each_set_bit(i, mask, chip->ngpio) | |
2591 | chip->set(chip, i, test_bit(i, bits)); | |
5f424243 RI |
2592 | } |
2593 | } | |
2594 | ||
44c7288f LW |
2595 | void gpiod_set_array_value_complex(bool raw, bool can_sleep, |
2596 | unsigned int array_size, | |
2597 | struct gpio_desc **desc_array, | |
2598 | int *value_array) | |
5f424243 RI |
2599 | { |
2600 | int i = 0; | |
2601 | ||
2602 | while (i < array_size) { | |
fdeb8e15 | 2603 | struct gpio_chip *chip = desc_array[i]->gdev->chip; |
5f424243 RI |
2604 | unsigned long mask[BITS_TO_LONGS(chip->ngpio)]; |
2605 | unsigned long bits[BITS_TO_LONGS(chip->ngpio)]; | |
2606 | int count = 0; | |
2607 | ||
38e003f4 | 2608 | if (!can_sleep) |
5f424243 | 2609 | WARN_ON(chip->can_sleep); |
38e003f4 | 2610 | |
5f424243 RI |
2611 | memset(mask, 0, sizeof(mask)); |
2612 | do { | |
2613 | struct gpio_desc *desc = desc_array[i]; | |
2614 | int hwgpio = gpio_chip_hwgpio(desc); | |
2615 | int value = value_array[i]; | |
2616 | ||
2617 | if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags)) | |
2618 | value = !value; | |
2619 | trace_gpio_value(desc_to_gpio(desc), 0, value); | |
2620 | /* | |
2621 | * collect all normal outputs belonging to the same chip | |
2622 | * open drain and open source outputs are set individually | |
2623 | */ | |
2624 | if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) { | |
38e003f4 | 2625 | _gpio_set_open_drain_value(desc, value); |
5f424243 RI |
2626 | } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) { |
2627 | _gpio_set_open_source_value(desc, value); | |
2628 | } else { | |
2629 | __set_bit(hwgpio, mask); | |
38e003f4 | 2630 | if (value) |
5f424243 | 2631 | __set_bit(hwgpio, bits); |
38e003f4 | 2632 | else |
5f424243 | 2633 | __clear_bit(hwgpio, bits); |
5f424243 RI |
2634 | count++; |
2635 | } | |
2636 | i++; | |
fdeb8e15 LW |
2637 | } while ((i < array_size) && |
2638 | (desc_array[i]->gdev->chip == chip)); | |
5f424243 | 2639 | /* push collected bits to outputs */ |
38e003f4 | 2640 | if (count != 0) |
5f424243 | 2641 | gpio_chip_set_multiple(chip, mask, bits); |
5f424243 RI |
2642 | } |
2643 | } | |
2644 | ||
d2876d08 | 2645 | /** |
79a9becd AC |
2646 | * gpiod_set_raw_value() - assign a gpio's raw value |
2647 | * @desc: gpio whose value will be assigned | |
d2876d08 | 2648 | * @value: value to assign |
d2876d08 | 2649 | * |
79a9becd AC |
2650 | * Set the raw value of the GPIO, i.e. the value of its physical line without |
2651 | * regard for its ACTIVE_LOW status. | |
2652 | * | |
2653 | * This function should be called from contexts where we cannot sleep, and will | |
2654 | * complain if the GPIO chip functions potentially sleep. | |
d2876d08 | 2655 | */ |
79a9becd | 2656 | void gpiod_set_raw_value(struct gpio_desc *desc, int value) |
372e722e | 2657 | { |
fdeb8e15 | 2658 | VALIDATE_DESC_VOID(desc); |
1cfab8f8 | 2659 | /* Should be using gpiod_set_value_cansleep() */ |
fdeb8e15 | 2660 | WARN_ON(desc->gdev->chip->can_sleep); |
79a9becd | 2661 | _gpiod_set_raw_value(desc, value); |
d2876d08 | 2662 | } |
79a9becd | 2663 | EXPORT_SYMBOL_GPL(gpiod_set_raw_value); |
d2876d08 DB |
2664 | |
2665 | /** | |
79a9becd AC |
2666 | * gpiod_set_value() - assign a gpio's value |
2667 | * @desc: gpio whose value will be assigned | |
2668 | * @value: value to assign | |
2669 | * | |
2670 | * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into | |
2671 | * account | |
d2876d08 | 2672 | * |
79a9becd AC |
2673 | * This function should be called from contexts where we cannot sleep, and will |
2674 | * complain if the GPIO chip functions potentially sleep. | |
d2876d08 | 2675 | */ |
79a9becd | 2676 | void gpiod_set_value(struct gpio_desc *desc, int value) |
d2876d08 | 2677 | { |
fdeb8e15 | 2678 | VALIDATE_DESC_VOID(desc); |
1cfab8f8 | 2679 | /* Should be using gpiod_set_value_cansleep() */ |
fdeb8e15 | 2680 | WARN_ON(desc->gdev->chip->can_sleep); |
79a9becd AC |
2681 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) |
2682 | value = !value; | |
2683 | _gpiod_set_raw_value(desc, value); | |
372e722e | 2684 | } |
79a9becd | 2685 | EXPORT_SYMBOL_GPL(gpiod_set_value); |
d2876d08 | 2686 | |
5f424243 | 2687 | /** |
3fff99bc | 2688 | * gpiod_set_raw_array_value() - assign values to an array of GPIOs |
5f424243 RI |
2689 | * @array_size: number of elements in the descriptor / value arrays |
2690 | * @desc_array: array of GPIO descriptors whose values will be assigned | |
2691 | * @value_array: array of values to assign | |
2692 | * | |
2693 | * Set the raw values of the GPIOs, i.e. the values of the physical lines | |
2694 | * without regard for their ACTIVE_LOW status. | |
2695 | * | |
2696 | * This function should be called from contexts where we cannot sleep, and will | |
2697 | * complain if the GPIO chip functions potentially sleep. | |
2698 | */ | |
3fff99bc | 2699 | void gpiod_set_raw_array_value(unsigned int array_size, |
5f424243 RI |
2700 | struct gpio_desc **desc_array, int *value_array) |
2701 | { | |
2702 | if (!desc_array) | |
2703 | return; | |
44c7288f LW |
2704 | gpiod_set_array_value_complex(true, false, array_size, desc_array, |
2705 | value_array); | |
5f424243 | 2706 | } |
3fff99bc | 2707 | EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value); |
5f424243 RI |
2708 | |
2709 | /** | |
3fff99bc | 2710 | * gpiod_set_array_value() - assign values to an array of GPIOs |
5f424243 RI |
2711 | * @array_size: number of elements in the descriptor / value arrays |
2712 | * @desc_array: array of GPIO descriptors whose values will be assigned | |
2713 | * @value_array: array of values to assign | |
2714 | * | |
2715 | * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status | |
2716 | * into account. | |
2717 | * | |
2718 | * This function should be called from contexts where we cannot sleep, and will | |
2719 | * complain if the GPIO chip functions potentially sleep. | |
2720 | */ | |
3fff99bc RI |
2721 | void gpiod_set_array_value(unsigned int array_size, |
2722 | struct gpio_desc **desc_array, int *value_array) | |
5f424243 RI |
2723 | { |
2724 | if (!desc_array) | |
2725 | return; | |
44c7288f LW |
2726 | gpiod_set_array_value_complex(false, false, array_size, desc_array, |
2727 | value_array); | |
5f424243 | 2728 | } |
3fff99bc | 2729 | EXPORT_SYMBOL_GPL(gpiod_set_array_value); |
5f424243 | 2730 | |
d2876d08 | 2731 | /** |
79a9becd AC |
2732 | * gpiod_cansleep() - report whether gpio value access may sleep |
2733 | * @desc: gpio to check | |
d2876d08 | 2734 | * |
d2876d08 | 2735 | */ |
79a9becd | 2736 | int gpiod_cansleep(const struct gpio_desc *desc) |
372e722e | 2737 | { |
fdeb8e15 LW |
2738 | VALIDATE_DESC(desc); |
2739 | return desc->gdev->chip->can_sleep; | |
d2876d08 | 2740 | } |
79a9becd | 2741 | EXPORT_SYMBOL_GPL(gpiod_cansleep); |
d2876d08 | 2742 | |
0f6d504e | 2743 | /** |
79a9becd AC |
2744 | * gpiod_to_irq() - return the IRQ corresponding to a GPIO |
2745 | * @desc: gpio whose IRQ will be returned (already requested) | |
0f6d504e | 2746 | * |
79a9becd AC |
2747 | * Return the IRQ corresponding to the passed GPIO, or an error code in case of |
2748 | * error. | |
0f6d504e | 2749 | */ |
79a9becd | 2750 | int gpiod_to_irq(const struct gpio_desc *desc) |
0f6d504e | 2751 | { |
4c37ce86 LW |
2752 | struct gpio_chip *chip; |
2753 | int offset; | |
0f6d504e | 2754 | |
79bb71bd LW |
2755 | /* |
2756 | * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics | |
2757 | * requires this function to not return zero on an invalid descriptor | |
2758 | * but rather a negative error number. | |
2759 | */ | |
bfbbe44d | 2760 | if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip) |
79bb71bd LW |
2761 | return -EINVAL; |
2762 | ||
fdeb8e15 | 2763 | chip = desc->gdev->chip; |
372e722e | 2764 | offset = gpio_chip_hwgpio(desc); |
4c37ce86 LW |
2765 | if (chip->to_irq) { |
2766 | int retirq = chip->to_irq(chip, offset); | |
2767 | ||
2768 | /* Zero means NO_IRQ */ | |
2769 | if (!retirq) | |
2770 | return -ENXIO; | |
2771 | ||
2772 | return retirq; | |
2773 | } | |
2774 | return -ENXIO; | |
0f6d504e | 2775 | } |
79a9becd | 2776 | EXPORT_SYMBOL_GPL(gpiod_to_irq); |
0f6d504e | 2777 | |
d468bf9e | 2778 | /** |
e3a2e878 | 2779 | * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ |
d74be6df AC |
2780 | * @chip: the chip the GPIO to lock belongs to |
2781 | * @offset: the offset of the GPIO to lock as IRQ | |
d468bf9e LW |
2782 | * |
2783 | * This is used directly by GPIO drivers that want to lock down | |
f438acdf | 2784 | * a certain GPIO line to be used for IRQs. |
d468bf9e | 2785 | */ |
e3a2e878 | 2786 | int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset) |
372e722e | 2787 | { |
9c10280d LW |
2788 | struct gpio_desc *desc; |
2789 | ||
2790 | desc = gpiochip_get_desc(chip, offset); | |
2791 | if (IS_ERR(desc)) | |
2792 | return PTR_ERR(desc); | |
2793 | ||
60f8339e LW |
2794 | /* |
2795 | * If it's fast: flush the direction setting if something changed | |
2796 | * behind our back | |
2797 | */ | |
2798 | if (!chip->can_sleep && chip->get_direction) { | |
9c10280d LW |
2799 | int dir = chip->get_direction(chip, offset); |
2800 | ||
2801 | if (dir) | |
2802 | clear_bit(FLAG_IS_OUT, &desc->flags); | |
2803 | else | |
2804 | set_bit(FLAG_IS_OUT, &desc->flags); | |
2805 | } | |
d468bf9e | 2806 | |
9c10280d | 2807 | if (test_bit(FLAG_IS_OUT, &desc->flags)) { |
d74be6df | 2808 | chip_err(chip, |
d468bf9e LW |
2809 | "%s: tried to flag a GPIO set as output for IRQ\n", |
2810 | __func__); | |
2811 | return -EIO; | |
2812 | } | |
2813 | ||
9c10280d | 2814 | set_bit(FLAG_USED_AS_IRQ, &desc->flags); |
3940c34a LW |
2815 | |
2816 | /* | |
2817 | * If the consumer has not set up a label (such as when the | |
2818 | * IRQ is referenced from .to_irq()) we set up a label here | |
2819 | * so it is clear this is used as an interrupt. | |
2820 | */ | |
2821 | if (!desc->label) | |
2822 | desc_set_label(desc, "interrupt"); | |
2823 | ||
d468bf9e | 2824 | return 0; |
372e722e | 2825 | } |
e3a2e878 | 2826 | EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq); |
d2876d08 | 2827 | |
d468bf9e | 2828 | /** |
e3a2e878 | 2829 | * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ |
d74be6df AC |
2830 | * @chip: the chip the GPIO to lock belongs to |
2831 | * @offset: the offset of the GPIO to lock as IRQ | |
d468bf9e LW |
2832 | * |
2833 | * This is used directly by GPIO drivers that want to indicate | |
2834 | * that a certain GPIO is no longer used exclusively for IRQ. | |
d2876d08 | 2835 | */ |
e3a2e878 | 2836 | void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset) |
d468bf9e | 2837 | { |
3940c34a LW |
2838 | struct gpio_desc *desc; |
2839 | ||
2840 | desc = gpiochip_get_desc(chip, offset); | |
2841 | if (IS_ERR(desc)) | |
d468bf9e | 2842 | return; |
d2876d08 | 2843 | |
3940c34a LW |
2844 | clear_bit(FLAG_USED_AS_IRQ, &desc->flags); |
2845 | ||
2846 | /* If we only had this marking, erase it */ | |
2847 | if (desc->label && !strcmp(desc->label, "interrupt")) | |
2848 | desc_set_label(desc, NULL); | |
d468bf9e | 2849 | } |
e3a2e878 | 2850 | EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq); |
d468bf9e | 2851 | |
6cee3821 LW |
2852 | bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset) |
2853 | { | |
2854 | if (offset >= chip->ngpio) | |
2855 | return false; | |
2856 | ||
2857 | return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags); | |
2858 | } | |
2859 | EXPORT_SYMBOL_GPL(gpiochip_line_is_irq); | |
2860 | ||
143b65d6 LW |
2861 | bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset) |
2862 | { | |
2863 | if (offset >= chip->ngpio) | |
2864 | return false; | |
2865 | ||
2866 | return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags); | |
2867 | } | |
2868 | EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain); | |
2869 | ||
2870 | bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset) | |
2871 | { | |
2872 | if (offset >= chip->ngpio) | |
2873 | return false; | |
2874 | ||
2875 | return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags); | |
2876 | } | |
2877 | EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source); | |
2878 | ||
79a9becd AC |
2879 | /** |
2880 | * gpiod_get_raw_value_cansleep() - return a gpio's raw value | |
2881 | * @desc: gpio whose value will be returned | |
2882 | * | |
2883 | * Return the GPIO's raw value, i.e. the value of the physical line disregarding | |
e20538b8 | 2884 | * its ACTIVE_LOW status, or negative errno on failure. |
79a9becd AC |
2885 | * |
2886 | * This function is to be called from contexts that can sleep. | |
d2876d08 | 2887 | */ |
79a9becd | 2888 | int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc) |
d2876d08 | 2889 | { |
d2876d08 | 2890 | might_sleep_if(extra_checks); |
fdeb8e15 | 2891 | VALIDATE_DESC(desc); |
79a9becd | 2892 | return _gpiod_get_raw_value(desc); |
d2876d08 | 2893 | } |
79a9becd | 2894 | EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep); |
372e722e | 2895 | |
79a9becd AC |
2896 | /** |
2897 | * gpiod_get_value_cansleep() - return a gpio's value | |
2898 | * @desc: gpio whose value will be returned | |
2899 | * | |
2900 | * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into | |
e20538b8 | 2901 | * account, or negative errno on failure. |
79a9becd AC |
2902 | * |
2903 | * This function is to be called from contexts that can sleep. | |
2904 | */ | |
2905 | int gpiod_get_value_cansleep(const struct gpio_desc *desc) | |
d2876d08 | 2906 | { |
3f397c21 | 2907 | int value; |
d2876d08 DB |
2908 | |
2909 | might_sleep_if(extra_checks); | |
fdeb8e15 | 2910 | VALIDATE_DESC(desc); |
79a9becd | 2911 | value = _gpiod_get_raw_value(desc); |
e20538b8 BA |
2912 | if (value < 0) |
2913 | return value; | |
2914 | ||
79a9becd AC |
2915 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) |
2916 | value = !value; | |
2917 | ||
3f397c21 | 2918 | return value; |
d2876d08 | 2919 | } |
79a9becd | 2920 | EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep); |
372e722e | 2921 | |
79a9becd AC |
2922 | /** |
2923 | * gpiod_set_raw_value_cansleep() - assign a gpio's raw value | |
2924 | * @desc: gpio whose value will be assigned | |
2925 | * @value: value to assign | |
2926 | * | |
2927 | * Set the raw value of the GPIO, i.e. the value of its physical line without | |
2928 | * regard for its ACTIVE_LOW status. | |
2929 | * | |
2930 | * This function is to be called from contexts that can sleep. | |
2931 | */ | |
2932 | void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value) | |
372e722e | 2933 | { |
d2876d08 | 2934 | might_sleep_if(extra_checks); |
fdeb8e15 | 2935 | VALIDATE_DESC_VOID(desc); |
79a9becd | 2936 | _gpiod_set_raw_value(desc, value); |
372e722e | 2937 | } |
79a9becd | 2938 | EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep); |
d2876d08 | 2939 | |
79a9becd AC |
2940 | /** |
2941 | * gpiod_set_value_cansleep() - assign a gpio's value | |
2942 | * @desc: gpio whose value will be assigned | |
2943 | * @value: value to assign | |
2944 | * | |
2945 | * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into | |
2946 | * account | |
2947 | * | |
2948 | * This function is to be called from contexts that can sleep. | |
2949 | */ | |
2950 | void gpiod_set_value_cansleep(struct gpio_desc *desc, int value) | |
d2876d08 | 2951 | { |
d2876d08 | 2952 | might_sleep_if(extra_checks); |
fdeb8e15 | 2953 | VALIDATE_DESC_VOID(desc); |
79a9becd AC |
2954 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) |
2955 | value = !value; | |
2956 | _gpiod_set_raw_value(desc, value); | |
372e722e | 2957 | } |
79a9becd | 2958 | EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep); |
d2876d08 | 2959 | |
5f424243 | 2960 | /** |
3fff99bc | 2961 | * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs |
5f424243 RI |
2962 | * @array_size: number of elements in the descriptor / value arrays |
2963 | * @desc_array: array of GPIO descriptors whose values will be assigned | |
2964 | * @value_array: array of values to assign | |
2965 | * | |
2966 | * Set the raw values of the GPIOs, i.e. the values of the physical lines | |
2967 | * without regard for their ACTIVE_LOW status. | |
2968 | * | |
2969 | * This function is to be called from contexts that can sleep. | |
2970 | */ | |
3fff99bc RI |
2971 | void gpiod_set_raw_array_value_cansleep(unsigned int array_size, |
2972 | struct gpio_desc **desc_array, | |
2973 | int *value_array) | |
5f424243 RI |
2974 | { |
2975 | might_sleep_if(extra_checks); | |
2976 | if (!desc_array) | |
2977 | return; | |
44c7288f LW |
2978 | gpiod_set_array_value_complex(true, true, array_size, desc_array, |
2979 | value_array); | |
5f424243 | 2980 | } |
3fff99bc | 2981 | EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep); |
5f424243 RI |
2982 | |
2983 | /** | |
3fff99bc | 2984 | * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs |
5f424243 RI |
2985 | * @array_size: number of elements in the descriptor / value arrays |
2986 | * @desc_array: array of GPIO descriptors whose values will be assigned | |
2987 | * @value_array: array of values to assign | |
2988 | * | |
2989 | * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status | |
2990 | * into account. | |
2991 | * | |
2992 | * This function is to be called from contexts that can sleep. | |
2993 | */ | |
3fff99bc RI |
2994 | void gpiod_set_array_value_cansleep(unsigned int array_size, |
2995 | struct gpio_desc **desc_array, | |
2996 | int *value_array) | |
5f424243 RI |
2997 | { |
2998 | might_sleep_if(extra_checks); | |
2999 | if (!desc_array) | |
3000 | return; | |
44c7288f LW |
3001 | gpiod_set_array_value_complex(false, true, array_size, desc_array, |
3002 | value_array); | |
5f424243 | 3003 | } |
3fff99bc | 3004 | EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep); |
5f424243 | 3005 | |
bae48da2 | 3006 | /** |
ad824783 AC |
3007 | * gpiod_add_lookup_table() - register GPIO device consumers |
3008 | * @table: table of consumers to register | |
bae48da2 | 3009 | */ |
ad824783 | 3010 | void gpiod_add_lookup_table(struct gpiod_lookup_table *table) |
bae48da2 AC |
3011 | { |
3012 | mutex_lock(&gpio_lookup_lock); | |
3013 | ||
ad824783 | 3014 | list_add_tail(&table->list, &gpio_lookup_list); |
bae48da2 AC |
3015 | |
3016 | mutex_unlock(&gpio_lookup_lock); | |
3017 | } | |
3018 | ||
be9015ab SK |
3019 | /** |
3020 | * gpiod_remove_lookup_table() - unregister GPIO device consumers | |
3021 | * @table: table of consumers to unregister | |
3022 | */ | |
3023 | void gpiod_remove_lookup_table(struct gpiod_lookup_table *table) | |
3024 | { | |
3025 | mutex_lock(&gpio_lookup_lock); | |
3026 | ||
3027 | list_del(&table->list); | |
3028 | ||
3029 | mutex_unlock(&gpio_lookup_lock); | |
3030 | } | |
3031 | ||
ad824783 | 3032 | static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev) |
bae48da2 AC |
3033 | { |
3034 | const char *dev_id = dev ? dev_name(dev) : NULL; | |
ad824783 | 3035 | struct gpiod_lookup_table *table; |
bae48da2 AC |
3036 | |
3037 | mutex_lock(&gpio_lookup_lock); | |
3038 | ||
ad824783 AC |
3039 | list_for_each_entry(table, &gpio_lookup_list, list) { |
3040 | if (table->dev_id && dev_id) { | |
3041 | /* | |
3042 | * Valid strings on both ends, must be identical to have | |
3043 | * a match | |
3044 | */ | |
3045 | if (!strcmp(table->dev_id, dev_id)) | |
3046 | goto found; | |
3047 | } else { | |
3048 | /* | |
3049 | * One of the pointers is NULL, so both must be to have | |
3050 | * a match | |
3051 | */ | |
3052 | if (dev_id == table->dev_id) | |
3053 | goto found; | |
3054 | } | |
3055 | } | |
3056 | table = NULL; | |
bae48da2 | 3057 | |
ad824783 AC |
3058 | found: |
3059 | mutex_unlock(&gpio_lookup_lock); | |
3060 | return table; | |
3061 | } | |
bae48da2 | 3062 | |
ad824783 AC |
3063 | static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id, |
3064 | unsigned int idx, | |
3065 | enum gpio_lookup_flags *flags) | |
3066 | { | |
2a3cf6a3 | 3067 | struct gpio_desc *desc = ERR_PTR(-ENOENT); |
ad824783 AC |
3068 | struct gpiod_lookup_table *table; |
3069 | struct gpiod_lookup *p; | |
bae48da2 | 3070 | |
ad824783 AC |
3071 | table = gpiod_find_lookup_table(dev); |
3072 | if (!table) | |
3073 | return desc; | |
bae48da2 | 3074 | |
ad824783 AC |
3075 | for (p = &table->table[0]; p->chip_label; p++) { |
3076 | struct gpio_chip *chip; | |
bae48da2 | 3077 | |
ad824783 | 3078 | /* idx must always match exactly */ |
bae48da2 AC |
3079 | if (p->idx != idx) |
3080 | continue; | |
3081 | ||
ad824783 AC |
3082 | /* If the lookup entry has a con_id, require exact match */ |
3083 | if (p->con_id && (!con_id || strcmp(p->con_id, con_id))) | |
3084 | continue; | |
bae48da2 | 3085 | |
ad824783 | 3086 | chip = find_chip_by_name(p->chip_label); |
bae48da2 | 3087 | |
ad824783 | 3088 | if (!chip) { |
2a3cf6a3 AC |
3089 | dev_err(dev, "cannot find GPIO chip %s\n", |
3090 | p->chip_label); | |
3091 | return ERR_PTR(-ENODEV); | |
ad824783 | 3092 | } |
bae48da2 | 3093 | |
ad824783 | 3094 | if (chip->ngpio <= p->chip_hwnum) { |
2a3cf6a3 AC |
3095 | dev_err(dev, |
3096 | "requested GPIO %d is out of range [0..%d] for chip %s\n", | |
3097 | idx, chip->ngpio, chip->label); | |
3098 | return ERR_PTR(-EINVAL); | |
bae48da2 | 3099 | } |
bae48da2 | 3100 | |
bb1e88cc | 3101 | desc = gpiochip_get_desc(chip, p->chip_hwnum); |
ad824783 | 3102 | *flags = p->flags; |
bae48da2 | 3103 | |
2a3cf6a3 | 3104 | return desc; |
bae48da2 AC |
3105 | } |
3106 | ||
bae48da2 AC |
3107 | return desc; |
3108 | } | |
3109 | ||
66858527 RI |
3110 | static int dt_gpio_count(struct device *dev, const char *con_id) |
3111 | { | |
3112 | int ret; | |
3113 | char propname[32]; | |
3114 | unsigned int i; | |
3115 | ||
3116 | for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { | |
3117 | if (con_id) | |
3118 | snprintf(propname, sizeof(propname), "%s-%s", | |
3119 | con_id, gpio_suffixes[i]); | |
3120 | else | |
3121 | snprintf(propname, sizeof(propname), "%s", | |
3122 | gpio_suffixes[i]); | |
3123 | ||
3124 | ret = of_gpio_named_count(dev->of_node, propname); | |
3125 | if (ret >= 0) | |
3126 | break; | |
3127 | } | |
3128 | return ret; | |
3129 | } | |
3130 | ||
3131 | static int platform_gpio_count(struct device *dev, const char *con_id) | |
3132 | { | |
3133 | struct gpiod_lookup_table *table; | |
3134 | struct gpiod_lookup *p; | |
3135 | unsigned int count = 0; | |
3136 | ||
3137 | table = gpiod_find_lookup_table(dev); | |
3138 | if (!table) | |
3139 | return -ENOENT; | |
3140 | ||
3141 | for (p = &table->table[0]; p->chip_label; p++) { | |
3142 | if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) || | |
3143 | (!con_id && !p->con_id)) | |
3144 | count++; | |
3145 | } | |
3146 | if (!count) | |
3147 | return -ENOENT; | |
3148 | ||
3149 | return count; | |
3150 | } | |
3151 | ||
3152 | /** | |
3153 | * gpiod_count - return the number of GPIOs associated with a device / function | |
3154 | * or -ENOENT if no GPIO has been assigned to the requested function | |
3155 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
3156 | * @con_id: function within the GPIO consumer | |
3157 | */ | |
3158 | int gpiod_count(struct device *dev, const char *con_id) | |
3159 | { | |
3160 | int count = -ENOENT; | |
3161 | ||
3162 | if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node) | |
3163 | count = dt_gpio_count(dev, con_id); | |
3164 | else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev)) | |
3165 | count = acpi_gpio_count(dev, con_id); | |
3166 | ||
3167 | if (count < 0) | |
3168 | count = platform_gpio_count(dev, con_id); | |
3169 | ||
3170 | return count; | |
3171 | } | |
3172 | EXPORT_SYMBOL_GPL(gpiod_count); | |
3173 | ||
bae48da2 | 3174 | /** |
0879162f | 3175 | * gpiod_get - obtain a GPIO for a given GPIO function |
ad824783 | 3176 | * @dev: GPIO consumer, can be NULL for system-global GPIOs |
bae48da2 | 3177 | * @con_id: function within the GPIO consumer |
39b2bbe3 | 3178 | * @flags: optional GPIO initialization flags |
bae48da2 AC |
3179 | * |
3180 | * Return the GPIO descriptor corresponding to the function con_id of device | |
2a3cf6a3 | 3181 | * dev, -ENOENT if no GPIO has been assigned to the requested function, or |
20a8a968 | 3182 | * another IS_ERR() code if an error occurred while trying to acquire the GPIO. |
bae48da2 | 3183 | */ |
b17d1bf1 | 3184 | struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id, |
39b2bbe3 | 3185 | enum gpiod_flags flags) |
bae48da2 | 3186 | { |
39b2bbe3 | 3187 | return gpiod_get_index(dev, con_id, 0, flags); |
bae48da2 | 3188 | } |
b17d1bf1 | 3189 | EXPORT_SYMBOL_GPL(gpiod_get); |
bae48da2 | 3190 | |
29a1f233 TR |
3191 | /** |
3192 | * gpiod_get_optional - obtain an optional GPIO for a given GPIO function | |
3193 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
3194 | * @con_id: function within the GPIO consumer | |
39b2bbe3 | 3195 | * @flags: optional GPIO initialization flags |
29a1f233 TR |
3196 | * |
3197 | * This is equivalent to gpiod_get(), except that when no GPIO was assigned to | |
3198 | * the requested function it will return NULL. This is convenient for drivers | |
3199 | * that need to handle optional GPIOs. | |
3200 | */ | |
b17d1bf1 | 3201 | struct gpio_desc *__must_check gpiod_get_optional(struct device *dev, |
39b2bbe3 AC |
3202 | const char *con_id, |
3203 | enum gpiod_flags flags) | |
29a1f233 | 3204 | { |
39b2bbe3 | 3205 | return gpiod_get_index_optional(dev, con_id, 0, flags); |
29a1f233 | 3206 | } |
b17d1bf1 | 3207 | EXPORT_SYMBOL_GPL(gpiod_get_optional); |
29a1f233 | 3208 | |
f625d460 BP |
3209 | |
3210 | /** | |
3211 | * gpiod_configure_flags - helper function to configure a given GPIO | |
3212 | * @desc: gpio whose value will be assigned | |
3213 | * @con_id: function within the GPIO consumer | |
85b03b30 JH |
3214 | * @lflags: gpio_lookup_flags - returned from of_find_gpio() or |
3215 | * of_get_gpio_hog() | |
f625d460 BP |
3216 | * @dflags: gpiod_flags - optional GPIO initialization flags |
3217 | * | |
3218 | * Return 0 on success, -ENOENT if no GPIO has been assigned to the | |
3219 | * requested function and/or index, or another IS_ERR() code if an error | |
3220 | * occurred while trying to acquire the GPIO. | |
3221 | */ | |
3222 | static int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id, | |
85b03b30 | 3223 | unsigned long lflags, enum gpiod_flags dflags) |
f625d460 BP |
3224 | { |
3225 | int status; | |
3226 | ||
85b03b30 JH |
3227 | if (lflags & GPIO_ACTIVE_LOW) |
3228 | set_bit(FLAG_ACTIVE_LOW, &desc->flags); | |
3229 | if (lflags & GPIO_OPEN_DRAIN) | |
3230 | set_bit(FLAG_OPEN_DRAIN, &desc->flags); | |
3231 | if (lflags & GPIO_OPEN_SOURCE) | |
3232 | set_bit(FLAG_OPEN_SOURCE, &desc->flags); | |
3233 | ||
f625d460 BP |
3234 | /* No particular flag request, return here... */ |
3235 | if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) { | |
3236 | pr_debug("no flags found for %s\n", con_id); | |
3237 | return 0; | |
3238 | } | |
3239 | ||
3240 | /* Process flags */ | |
3241 | if (dflags & GPIOD_FLAGS_BIT_DIR_OUT) | |
3242 | status = gpiod_direction_output(desc, | |
ad17731d | 3243 | !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL)); |
f625d460 BP |
3244 | else |
3245 | status = gpiod_direction_input(desc); | |
3246 | ||
3247 | return status; | |
3248 | } | |
3249 | ||
bae48da2 AC |
3250 | /** |
3251 | * gpiod_get_index - obtain a GPIO from a multi-index GPIO function | |
fdd6a5fe | 3252 | * @dev: GPIO consumer, can be NULL for system-global GPIOs |
bae48da2 AC |
3253 | * @con_id: function within the GPIO consumer |
3254 | * @idx: index of the GPIO to obtain in the consumer | |
39b2bbe3 | 3255 | * @flags: optional GPIO initialization flags |
bae48da2 AC |
3256 | * |
3257 | * This variant of gpiod_get() allows to access GPIOs other than the first | |
3258 | * defined one for functions that define several GPIOs. | |
3259 | * | |
2a3cf6a3 AC |
3260 | * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the |
3261 | * requested function and/or index, or another IS_ERR() code if an error | |
20a8a968 | 3262 | * occurred while trying to acquire the GPIO. |
bae48da2 | 3263 | */ |
b17d1bf1 | 3264 | struct gpio_desc *__must_check gpiod_get_index(struct device *dev, |
bae48da2 | 3265 | const char *con_id, |
39b2bbe3 AC |
3266 | unsigned int idx, |
3267 | enum gpiod_flags flags) | |
bae48da2 | 3268 | { |
35c5d7fd | 3269 | struct gpio_desc *desc = NULL; |
bae48da2 | 3270 | int status; |
39b2bbe3 | 3271 | enum gpio_lookup_flags lookupflags = 0; |
bae48da2 AC |
3272 | |
3273 | dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id); | |
3274 | ||
4d8440b9 RW |
3275 | if (dev) { |
3276 | /* Using device tree? */ | |
3277 | if (IS_ENABLED(CONFIG_OF) && dev->of_node) { | |
3278 | dev_dbg(dev, "using device tree for GPIO lookup\n"); | |
3279 | desc = of_find_gpio(dev, con_id, idx, &lookupflags); | |
3280 | } else if (ACPI_COMPANION(dev)) { | |
3281 | dev_dbg(dev, "using ACPI for GPIO lookup\n"); | |
25487533 | 3282 | desc = acpi_find_gpio(dev, con_id, idx, flags, &lookupflags); |
4d8440b9 | 3283 | } |
35c5d7fd AC |
3284 | } |
3285 | ||
3286 | /* | |
3287 | * Either we are not using DT or ACPI, or their lookup did not return | |
3288 | * a result. In that case, use platform lookup as a fallback. | |
3289 | */ | |
2a3cf6a3 | 3290 | if (!desc || desc == ERR_PTR(-ENOENT)) { |
43a8785a | 3291 | dev_dbg(dev, "using lookup tables for GPIO lookup\n"); |
39b2bbe3 | 3292 | desc = gpiod_find(dev, con_id, idx, &lookupflags); |
bae48da2 AC |
3293 | } |
3294 | ||
3295 | if (IS_ERR(desc)) { | |
351cfe0f | 3296 | dev_dbg(dev, "lookup for GPIO %s failed\n", con_id); |
bae48da2 AC |
3297 | return desc; |
3298 | } | |
3299 | ||
3300 | status = gpiod_request(desc, con_id); | |
bae48da2 AC |
3301 | if (status < 0) |
3302 | return ERR_PTR(status); | |
3303 | ||
85b03b30 | 3304 | status = gpiod_configure_flags(desc, con_id, lookupflags, flags); |
39b2bbe3 AC |
3305 | if (status < 0) { |
3306 | dev_dbg(dev, "setup of GPIO %s failed\n", con_id); | |
3307 | gpiod_put(desc); | |
3308 | return ERR_PTR(status); | |
3309 | } | |
3310 | ||
bae48da2 AC |
3311 | return desc; |
3312 | } | |
b17d1bf1 | 3313 | EXPORT_SYMBOL_GPL(gpiod_get_index); |
bae48da2 | 3314 | |
40b73183 MW |
3315 | /** |
3316 | * fwnode_get_named_gpiod - obtain a GPIO from firmware node | |
3317 | * @fwnode: handle of the firmware node | |
3318 | * @propname: name of the firmware property representing the GPIO | |
537b94da | 3319 | * @index: index of the GPIO to obtain in the consumer |
a264d10f | 3320 | * @dflags: GPIO initialization flags |
40b73183 MW |
3321 | * |
3322 | * This function can be used for drivers that get their configuration | |
3323 | * from firmware. | |
3324 | * | |
3325 | * Function properly finds the corresponding GPIO using whatever is the | |
3326 | * underlying firmware interface and then makes sure that the GPIO | |
3327 | * descriptor is requested before it is returned to the caller. | |
3328 | * | |
a264d10f AS |
3329 | * On successfull request the GPIO pin is configured in accordance with |
3330 | * provided @dflags. | |
3331 | * | |
40b73183 MW |
3332 | * In case of error an ERR_PTR() is returned. |
3333 | */ | |
3334 | struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode, | |
537b94da | 3335 | const char *propname, int index, |
b2987d74 AS |
3336 | enum gpiod_flags dflags, |
3337 | const char *label) | |
40b73183 MW |
3338 | { |
3339 | struct gpio_desc *desc = ERR_PTR(-ENODEV); | |
a264d10f | 3340 | unsigned long lflags = 0; |
40b73183 | 3341 | bool active_low = false; |
90b665f6 | 3342 | bool single_ended = false; |
40b73183 MW |
3343 | int ret; |
3344 | ||
3345 | if (!fwnode) | |
3346 | return ERR_PTR(-EINVAL); | |
3347 | ||
3348 | if (is_of_node(fwnode)) { | |
3349 | enum of_gpio_flags flags; | |
3350 | ||
537b94da BB |
3351 | desc = of_get_named_gpiod_flags(to_of_node(fwnode), propname, |
3352 | index, &flags); | |
90b665f6 | 3353 | if (!IS_ERR(desc)) { |
40b73183 | 3354 | active_low = flags & OF_GPIO_ACTIVE_LOW; |
90b665f6 LP |
3355 | single_ended = flags & OF_GPIO_SINGLE_ENDED; |
3356 | } | |
40b73183 MW |
3357 | } else if (is_acpi_node(fwnode)) { |
3358 | struct acpi_gpio_info info; | |
3359 | ||
537b94da | 3360 | desc = acpi_node_get_gpiod(fwnode, propname, index, &info); |
40b73183 | 3361 | if (!IS_ERR(desc)) |
52044723 | 3362 | active_low = info.polarity == GPIO_ACTIVE_LOW; |
40b73183 MW |
3363 | } |
3364 | ||
3365 | if (IS_ERR(desc)) | |
3366 | return desc; | |
3367 | ||
b2987d74 | 3368 | ret = gpiod_request(desc, label); |
85b03b30 JH |
3369 | if (ret) |
3370 | return ERR_PTR(ret); | |
3371 | ||
40b73183 | 3372 | if (active_low) |
a264d10f | 3373 | lflags |= GPIO_ACTIVE_LOW; |
40b73183 | 3374 | |
90b665f6 LP |
3375 | if (single_ended) { |
3376 | if (active_low) | |
a264d10f | 3377 | lflags |= GPIO_OPEN_DRAIN; |
90b665f6 | 3378 | else |
a264d10f AS |
3379 | lflags |= GPIO_OPEN_SOURCE; |
3380 | } | |
3381 | ||
3382 | ret = gpiod_configure_flags(desc, propname, lflags, dflags); | |
3383 | if (ret < 0) { | |
3384 | gpiod_put(desc); | |
3385 | return ERR_PTR(ret); | |
90b665f6 LP |
3386 | } |
3387 | ||
40b73183 MW |
3388 | return desc; |
3389 | } | |
3390 | EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod); | |
3391 | ||
29a1f233 TR |
3392 | /** |
3393 | * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO | |
3394 | * function | |
3395 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
3396 | * @con_id: function within the GPIO consumer | |
3397 | * @index: index of the GPIO to obtain in the consumer | |
39b2bbe3 | 3398 | * @flags: optional GPIO initialization flags |
29a1f233 TR |
3399 | * |
3400 | * This is equivalent to gpiod_get_index(), except that when no GPIO with the | |
3401 | * specified index was assigned to the requested function it will return NULL. | |
3402 | * This is convenient for drivers that need to handle optional GPIOs. | |
3403 | */ | |
b17d1bf1 | 3404 | struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev, |
29a1f233 | 3405 | const char *con_id, |
39b2bbe3 AC |
3406 | unsigned int index, |
3407 | enum gpiod_flags flags) | |
29a1f233 TR |
3408 | { |
3409 | struct gpio_desc *desc; | |
3410 | ||
39b2bbe3 | 3411 | desc = gpiod_get_index(dev, con_id, index, flags); |
29a1f233 TR |
3412 | if (IS_ERR(desc)) { |
3413 | if (PTR_ERR(desc) == -ENOENT) | |
3414 | return NULL; | |
3415 | } | |
3416 | ||
3417 | return desc; | |
3418 | } | |
b17d1bf1 | 3419 | EXPORT_SYMBOL_GPL(gpiod_get_index_optional); |
29a1f233 | 3420 | |
f625d460 BP |
3421 | /** |
3422 | * gpiod_hog - Hog the specified GPIO desc given the provided flags | |
3423 | * @desc: gpio whose value will be assigned | |
3424 | * @name: gpio line name | |
3425 | * @lflags: gpio_lookup_flags - returned from of_find_gpio() or | |
3426 | * of_get_gpio_hog() | |
3427 | * @dflags: gpiod_flags - optional GPIO initialization flags | |
3428 | */ | |
3429 | int gpiod_hog(struct gpio_desc *desc, const char *name, | |
3430 | unsigned long lflags, enum gpiod_flags dflags) | |
3431 | { | |
3432 | struct gpio_chip *chip; | |
3433 | struct gpio_desc *local_desc; | |
3434 | int hwnum; | |
3435 | int status; | |
3436 | ||
3437 | chip = gpiod_to_chip(desc); | |
3438 | hwnum = gpio_chip_hwgpio(desc); | |
3439 | ||
3440 | local_desc = gpiochip_request_own_desc(chip, hwnum, name); | |
3441 | if (IS_ERR(local_desc)) { | |
c31a571d LD |
3442 | status = PTR_ERR(local_desc); |
3443 | pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n", | |
3444 | name, chip->label, hwnum, status); | |
3445 | return status; | |
f625d460 BP |
3446 | } |
3447 | ||
85b03b30 | 3448 | status = gpiod_configure_flags(desc, name, lflags, dflags); |
f625d460 | 3449 | if (status < 0) { |
c31a571d LD |
3450 | pr_err("setup of hog GPIO %s (chip %s, offset %d) failed, %d\n", |
3451 | name, chip->label, hwnum, status); | |
f625d460 BP |
3452 | gpiochip_free_own_desc(desc); |
3453 | return status; | |
3454 | } | |
3455 | ||
3456 | /* Mark GPIO as hogged so it can be identified and removed later */ | |
3457 | set_bit(FLAG_IS_HOGGED, &desc->flags); | |
3458 | ||
3459 | pr_info("GPIO line %d (%s) hogged as %s%s\n", | |
3460 | desc_to_gpio(desc), name, | |
3461 | (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input", | |
3462 | (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? | |
3463 | (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":""); | |
3464 | ||
3465 | return 0; | |
3466 | } | |
3467 | ||
3468 | /** | |
3469 | * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog | |
3470 | * @chip: gpio chip to act on | |
3471 | * | |
3472 | * This is only used by of_gpiochip_remove to free hogged gpios | |
3473 | */ | |
3474 | static void gpiochip_free_hogs(struct gpio_chip *chip) | |
3475 | { | |
3476 | int id; | |
3477 | ||
3478 | for (id = 0; id < chip->ngpio; id++) { | |
1c3cdb18 LW |
3479 | if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags)) |
3480 | gpiochip_free_own_desc(&chip->gpiodev->descs[id]); | |
f625d460 BP |
3481 | } |
3482 | } | |
3483 | ||
66858527 RI |
3484 | /** |
3485 | * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function | |
3486 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
3487 | * @con_id: function within the GPIO consumer | |
3488 | * @flags: optional GPIO initialization flags | |
3489 | * | |
3490 | * This function acquires all the GPIOs defined under a given function. | |
3491 | * | |
3492 | * Return a struct gpio_descs containing an array of descriptors, -ENOENT if | |
3493 | * no GPIO has been assigned to the requested function, or another IS_ERR() | |
3494 | * code if an error occurred while trying to acquire the GPIOs. | |
3495 | */ | |
3496 | struct gpio_descs *__must_check gpiod_get_array(struct device *dev, | |
3497 | const char *con_id, | |
3498 | enum gpiod_flags flags) | |
3499 | { | |
3500 | struct gpio_desc *desc; | |
3501 | struct gpio_descs *descs; | |
3502 | int count; | |
3503 | ||
3504 | count = gpiod_count(dev, con_id); | |
3505 | if (count < 0) | |
3506 | return ERR_PTR(count); | |
3507 | ||
3508 | descs = kzalloc(sizeof(*descs) + sizeof(descs->desc[0]) * count, | |
3509 | GFP_KERNEL); | |
3510 | if (!descs) | |
3511 | return ERR_PTR(-ENOMEM); | |
3512 | ||
3513 | for (descs->ndescs = 0; descs->ndescs < count; ) { | |
3514 | desc = gpiod_get_index(dev, con_id, descs->ndescs, flags); | |
3515 | if (IS_ERR(desc)) { | |
3516 | gpiod_put_array(descs); | |
3517 | return ERR_CAST(desc); | |
3518 | } | |
3519 | descs->desc[descs->ndescs] = desc; | |
3520 | descs->ndescs++; | |
3521 | } | |
3522 | return descs; | |
3523 | } | |
3524 | EXPORT_SYMBOL_GPL(gpiod_get_array); | |
3525 | ||
3526 | /** | |
3527 | * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO | |
3528 | * function | |
3529 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
3530 | * @con_id: function within the GPIO consumer | |
3531 | * @flags: optional GPIO initialization flags | |
3532 | * | |
3533 | * This is equivalent to gpiod_get_array(), except that when no GPIO was | |
3534 | * assigned to the requested function it will return NULL. | |
3535 | */ | |
3536 | struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev, | |
3537 | const char *con_id, | |
3538 | enum gpiod_flags flags) | |
3539 | { | |
3540 | struct gpio_descs *descs; | |
3541 | ||
3542 | descs = gpiod_get_array(dev, con_id, flags); | |
3543 | if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT)) | |
3544 | return NULL; | |
3545 | ||
3546 | return descs; | |
3547 | } | |
3548 | EXPORT_SYMBOL_GPL(gpiod_get_array_optional); | |
3549 | ||
bae48da2 AC |
3550 | /** |
3551 | * gpiod_put - dispose of a GPIO descriptor | |
3552 | * @desc: GPIO descriptor to dispose of | |
3553 | * | |
3554 | * No descriptor can be used after gpiod_put() has been called on it. | |
3555 | */ | |
3556 | void gpiod_put(struct gpio_desc *desc) | |
3557 | { | |
3558 | gpiod_free(desc); | |
372e722e | 3559 | } |
bae48da2 | 3560 | EXPORT_SYMBOL_GPL(gpiod_put); |
d2876d08 | 3561 | |
66858527 RI |
3562 | /** |
3563 | * gpiod_put_array - dispose of multiple GPIO descriptors | |
3564 | * @descs: struct gpio_descs containing an array of descriptors | |
3565 | */ | |
3566 | void gpiod_put_array(struct gpio_descs *descs) | |
3567 | { | |
3568 | unsigned int i; | |
3569 | ||
3570 | for (i = 0; i < descs->ndescs; i++) | |
3571 | gpiod_put(descs->desc[i]); | |
3572 | ||
3573 | kfree(descs); | |
3574 | } | |
3575 | EXPORT_SYMBOL_GPL(gpiod_put_array); | |
3576 | ||
3c702e99 LW |
3577 | static int __init gpiolib_dev_init(void) |
3578 | { | |
3579 | int ret; | |
3580 | ||
3581 | /* Register GPIO sysfs bus */ | |
3582 | ret = bus_register(&gpio_bus_type); | |
3583 | if (ret < 0) { | |
3584 | pr_err("gpiolib: could not register GPIO bus type\n"); | |
3585 | return ret; | |
3586 | } | |
3587 | ||
3588 | ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip"); | |
3589 | if (ret < 0) { | |
3590 | pr_err("gpiolib: failed to allocate char dev region\n"); | |
3591 | bus_unregister(&gpio_bus_type); | |
159f3cd9 GR |
3592 | } else { |
3593 | gpiolib_initialized = true; | |
3594 | gpiochip_setup_devs(); | |
3c702e99 LW |
3595 | } |
3596 | return ret; | |
3597 | } | |
3598 | core_initcall(gpiolib_dev_init); | |
3599 | ||
d2876d08 DB |
3600 | #ifdef CONFIG_DEBUG_FS |
3601 | ||
fdeb8e15 | 3602 | static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev) |
d2876d08 DB |
3603 | { |
3604 | unsigned i; | |
fdeb8e15 LW |
3605 | struct gpio_chip *chip = gdev->chip; |
3606 | unsigned gpio = gdev->base; | |
3607 | struct gpio_desc *gdesc = &gdev->descs[0]; | |
d2876d08 | 3608 | int is_out; |
d468bf9e | 3609 | int is_irq; |
d2876d08 | 3610 | |
fdeb8e15 | 3611 | for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) { |
ced433e2 MP |
3612 | if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) { |
3613 | if (gdesc->name) { | |
3614 | seq_printf(s, " gpio-%-3d (%-20.20s)\n", | |
3615 | gpio, gdesc->name); | |
3616 | } | |
d2876d08 | 3617 | continue; |
ced433e2 | 3618 | } |
d2876d08 | 3619 | |
372e722e | 3620 | gpiod_get_direction(gdesc); |
d2876d08 | 3621 | is_out = test_bit(FLAG_IS_OUT, &gdesc->flags); |
d468bf9e | 3622 | is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags); |
ced433e2 MP |
3623 | seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s", |
3624 | gpio, gdesc->name ? gdesc->name : "", gdesc->label, | |
d2876d08 DB |
3625 | is_out ? "out" : "in ", |
3626 | chip->get | |
3627 | ? (chip->get(chip, i) ? "hi" : "lo") | |
d468bf9e LW |
3628 | : "? ", |
3629 | is_irq ? "IRQ" : " "); | |
d2876d08 DB |
3630 | seq_printf(s, "\n"); |
3631 | } | |
3632 | } | |
3633 | ||
f9c4a31f | 3634 | static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos) |
d2876d08 | 3635 | { |
362432ae | 3636 | unsigned long flags; |
ff2b1359 | 3637 | struct gpio_device *gdev = NULL; |
cb1650d4 | 3638 | loff_t index = *pos; |
d2876d08 | 3639 | |
f9c4a31f | 3640 | s->private = ""; |
d2876d08 | 3641 | |
362432ae | 3642 | spin_lock_irqsave(&gpio_lock, flags); |
ff2b1359 | 3643 | list_for_each_entry(gdev, &gpio_devices, list) |
362432ae GL |
3644 | if (index-- == 0) { |
3645 | spin_unlock_irqrestore(&gpio_lock, flags); | |
ff2b1359 | 3646 | return gdev; |
f9c4a31f | 3647 | } |
362432ae | 3648 | spin_unlock_irqrestore(&gpio_lock, flags); |
f9c4a31f | 3649 | |
cb1650d4 | 3650 | return NULL; |
f9c4a31f TR |
3651 | } |
3652 | ||
3653 | static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos) | |
3654 | { | |
362432ae | 3655 | unsigned long flags; |
ff2b1359 | 3656 | struct gpio_device *gdev = v; |
f9c4a31f TR |
3657 | void *ret = NULL; |
3658 | ||
362432ae | 3659 | spin_lock_irqsave(&gpio_lock, flags); |
ff2b1359 | 3660 | if (list_is_last(&gdev->list, &gpio_devices)) |
cb1650d4 AC |
3661 | ret = NULL; |
3662 | else | |
ff2b1359 | 3663 | ret = list_entry(gdev->list.next, struct gpio_device, list); |
362432ae | 3664 | spin_unlock_irqrestore(&gpio_lock, flags); |
f9c4a31f TR |
3665 | |
3666 | s->private = "\n"; | |
3667 | ++*pos; | |
3668 | ||
3669 | return ret; | |
3670 | } | |
3671 | ||
3672 | static void gpiolib_seq_stop(struct seq_file *s, void *v) | |
3673 | { | |
3674 | } | |
3675 | ||
3676 | static int gpiolib_seq_show(struct seq_file *s, void *v) | |
3677 | { | |
ff2b1359 LW |
3678 | struct gpio_device *gdev = v; |
3679 | struct gpio_chip *chip = gdev->chip; | |
3680 | struct device *parent; | |
3681 | ||
3682 | if (!chip) { | |
3683 | seq_printf(s, "%s%s: (dangling chip)", (char *)s->private, | |
3684 | dev_name(&gdev->dev)); | |
3685 | return 0; | |
3686 | } | |
f9c4a31f | 3687 | |
ff2b1359 LW |
3688 | seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private, |
3689 | dev_name(&gdev->dev), | |
fdeb8e15 | 3690 | gdev->base, gdev->base + gdev->ngpio - 1); |
ff2b1359 LW |
3691 | parent = chip->parent; |
3692 | if (parent) | |
3693 | seq_printf(s, ", parent: %s/%s", | |
3694 | parent->bus ? parent->bus->name : "no-bus", | |
3695 | dev_name(parent)); | |
f9c4a31f TR |
3696 | if (chip->label) |
3697 | seq_printf(s, ", %s", chip->label); | |
3698 | if (chip->can_sleep) | |
3699 | seq_printf(s, ", can sleep"); | |
3700 | seq_printf(s, ":\n"); | |
3701 | ||
3702 | if (chip->dbg_show) | |
3703 | chip->dbg_show(s, chip); | |
3704 | else | |
fdeb8e15 | 3705 | gpiolib_dbg_show(s, gdev); |
f9c4a31f | 3706 | |
d2876d08 DB |
3707 | return 0; |
3708 | } | |
3709 | ||
f9c4a31f TR |
3710 | static const struct seq_operations gpiolib_seq_ops = { |
3711 | .start = gpiolib_seq_start, | |
3712 | .next = gpiolib_seq_next, | |
3713 | .stop = gpiolib_seq_stop, | |
3714 | .show = gpiolib_seq_show, | |
3715 | }; | |
3716 | ||
d2876d08 DB |
3717 | static int gpiolib_open(struct inode *inode, struct file *file) |
3718 | { | |
f9c4a31f | 3719 | return seq_open(file, &gpiolib_seq_ops); |
d2876d08 DB |
3720 | } |
3721 | ||
828c0950 | 3722 | static const struct file_operations gpiolib_operations = { |
f9c4a31f | 3723 | .owner = THIS_MODULE, |
d2876d08 DB |
3724 | .open = gpiolib_open, |
3725 | .read = seq_read, | |
3726 | .llseek = seq_lseek, | |
f9c4a31f | 3727 | .release = seq_release, |
d2876d08 DB |
3728 | }; |
3729 | ||
3730 | static int __init gpiolib_debugfs_init(void) | |
3731 | { | |
3732 | /* /sys/kernel/debug/gpio */ | |
3733 | (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO, | |
3734 | NULL, NULL, &gpiolib_operations); | |
3735 | return 0; | |
3736 | } | |
3737 | subsys_initcall(gpiolib_debugfs_init); | |
3738 | ||
3739 | #endif /* DEBUG_FS */ |