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