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