]>
Commit | Line | Data |
---|---|---|
d2876d08 DB |
1 | #include <linux/kernel.h> |
2 | #include <linux/module.h> | |
ff77c352 | 3 | #include <linux/interrupt.h> |
d2876d08 DB |
4 | #include <linux/irq.h> |
5 | #include <linux/spinlock.h> | |
1a989d0f | 6 | #include <linux/list.h> |
d8f388d8 DB |
7 | #include <linux/device.h> |
8 | #include <linux/err.h> | |
9 | #include <linux/debugfs.h> | |
10 | #include <linux/seq_file.h> | |
11 | #include <linux/gpio.h> | |
391c970c | 12 | #include <linux/of_gpio.h> |
ff77c352 | 13 | #include <linux/idr.h> |
5a0e3ad6 | 14 | #include <linux/slab.h> |
7b199811 | 15 | #include <linux/acpi.h> |
53e7cac3 | 16 | #include <linux/gpio/driver.h> |
0a6d3158 | 17 | #include <linux/gpio/machine.h> |
d2876d08 | 18 | |
664e3e5a MW |
19 | #include "gpiolib.h" |
20 | ||
3f397c21 UKK |
21 | #define CREATE_TRACE_POINTS |
22 | #include <trace/events/gpio.h> | |
d2876d08 | 23 | |
79a9becd | 24 | /* Implementation infrastructure for GPIO interfaces. |
d2876d08 | 25 | * |
79a9becd AC |
26 | * The GPIO programming interface allows for inlining speed-critical |
27 | * get/set operations for common cases, so that access to SOC-integrated | |
28 | * GPIOs can sometimes cost only an instruction or two per bit. | |
d2876d08 DB |
29 | */ |
30 | ||
31 | ||
32 | /* When debugging, extend minimal trust to callers and platform code. | |
33 | * Also emit diagnostic messages that may help initial bringup, when | |
34 | * board setup or driver bugs are most common. | |
35 | * | |
36 | * Otherwise, minimize overhead in what may be bitbanging codepaths. | |
37 | */ | |
38 | #ifdef DEBUG | |
39 | #define extra_checks 1 | |
40 | #else | |
41 | #define extra_checks 0 | |
42 | #endif | |
43 | ||
44 | /* gpio_lock prevents conflicts during gpio_desc[] table updates. | |
45 | * While any GPIO is requested, its gpio_chip is not removable; | |
46 | * each GPIO's "requested" flag serves as a lock and refcount. | |
47 | */ | |
0eb4c6c2 | 48 | DEFINE_SPINLOCK(gpio_lock); |
d2876d08 | 49 | |
6c0b4e6c AC |
50 | #define GPIO_OFFSET_VALID(chip, offset) (offset >= 0 && offset < chip->ngpio) |
51 | ||
bae48da2 AC |
52 | static DEFINE_MUTEX(gpio_lookup_lock); |
53 | static LIST_HEAD(gpio_lookup_list); | |
0eb4c6c2 | 54 | LIST_HEAD(gpio_chips); |
1a2a99c6 | 55 | |
6d86750c JH |
56 | |
57 | static void gpiochip_free_hogs(struct gpio_chip *chip); | |
58 | static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip); | |
59 | ||
60 | ||
d2876d08 DB |
61 | static inline void desc_set_label(struct gpio_desc *d, const char *label) |
62 | { | |
d2876d08 | 63 | d->label = label; |
d2876d08 DB |
64 | } |
65 | ||
372e722e AC |
66 | /** |
67 | * Convert a GPIO number to its descriptor | |
68 | */ | |
79a9becd | 69 | struct gpio_desc *gpio_to_desc(unsigned gpio) |
372e722e | 70 | { |
14e85c0e AC |
71 | struct gpio_chip *chip; |
72 | unsigned long flags; | |
73 | ||
74 | spin_lock_irqsave(&gpio_lock, flags); | |
75 | ||
76 | list_for_each_entry(chip, &gpio_chips, list) { | |
77 | if (chip->base <= gpio && chip->base + chip->ngpio > gpio) { | |
78 | spin_unlock_irqrestore(&gpio_lock, flags); | |
79 | return &chip->desc[gpio - chip->base]; | |
80 | } | |
81 | } | |
82 | ||
83 | spin_unlock_irqrestore(&gpio_lock, flags); | |
84 | ||
0e9a5edf AC |
85 | if (!gpio_is_valid(gpio)) |
86 | WARN(1, "invalid GPIO %d\n", gpio); | |
87 | ||
14e85c0e | 88 | return NULL; |
372e722e | 89 | } |
79a9becd | 90 | EXPORT_SYMBOL_GPL(gpio_to_desc); |
372e722e | 91 | |
d468bf9e | 92 | /** |
bb1e88cc | 93 | * Get the GPIO descriptor corresponding to the given hw number for this chip. |
d468bf9e | 94 | */ |
bb1e88cc AC |
95 | struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, |
96 | u16 hwnum) | |
d468bf9e | 97 | { |
bb1e88cc | 98 | if (hwnum >= chip->ngpio) |
b7d0a28a | 99 | return ERR_PTR(-EINVAL); |
d468bf9e | 100 | |
bb1e88cc | 101 | return &chip->desc[hwnum]; |
d468bf9e | 102 | } |
372e722e AC |
103 | |
104 | /** | |
105 | * Convert a GPIO descriptor to the integer namespace. | |
106 | * This should disappear in the future but is needed since we still | |
107 | * use GPIO numbers for error messages and sysfs nodes | |
108 | */ | |
79a9becd | 109 | int desc_to_gpio(const struct gpio_desc *desc) |
372e722e | 110 | { |
14e85c0e | 111 | return desc->chip->base + (desc - &desc->chip->desc[0]); |
372e722e | 112 | } |
79a9becd | 113 | EXPORT_SYMBOL_GPL(desc_to_gpio); |
372e722e AC |
114 | |
115 | ||
79a9becd AC |
116 | /** |
117 | * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs | |
118 | * @desc: descriptor to return the chip of | |
119 | */ | |
120 | struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc) | |
372e722e | 121 | { |
bcabdef1 | 122 | return desc ? desc->chip : NULL; |
372e722e | 123 | } |
79a9becd | 124 | EXPORT_SYMBOL_GPL(gpiod_to_chip); |
d2876d08 | 125 | |
8d0aab2f AV |
126 | /* dynamic allocation of GPIOs, e.g. on a hotplugged device */ |
127 | static int gpiochip_find_base(int ngpio) | |
128 | { | |
83cabe33 AC |
129 | struct gpio_chip *chip; |
130 | int base = ARCH_NR_GPIOS - ngpio; | |
8d0aab2f | 131 | |
83cabe33 AC |
132 | list_for_each_entry_reverse(chip, &gpio_chips, list) { |
133 | /* found a free space? */ | |
134 | if (chip->base + chip->ngpio <= base) | |
135 | break; | |
136 | else | |
137 | /* nope, check the space right before the chip */ | |
138 | base = chip->base - ngpio; | |
8d0aab2f AV |
139 | } |
140 | ||
83cabe33 | 141 | if (gpio_is_valid(base)) { |
8d0aab2f | 142 | pr_debug("%s: found new base at %d\n", __func__, base); |
83cabe33 AC |
143 | return base; |
144 | } else { | |
145 | pr_err("%s: cannot find free range\n", __func__); | |
146 | return -ENOSPC; | |
169b6a7a | 147 | } |
169b6a7a AV |
148 | } |
149 | ||
79a9becd AC |
150 | /** |
151 | * gpiod_get_direction - return the current direction of a GPIO | |
152 | * @desc: GPIO to get the direction of | |
153 | * | |
154 | * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error. | |
155 | * | |
156 | * This function may sleep if gpiod_cansleep() is true. | |
157 | */ | |
8e53b0f1 | 158 | int gpiod_get_direction(struct gpio_desc *desc) |
80b0a602 MN |
159 | { |
160 | struct gpio_chip *chip; | |
372e722e | 161 | unsigned offset; |
80b0a602 MN |
162 | int status = -EINVAL; |
163 | ||
372e722e AC |
164 | chip = gpiod_to_chip(desc); |
165 | offset = gpio_chip_hwgpio(desc); | |
80b0a602 MN |
166 | |
167 | if (!chip->get_direction) | |
168 | return status; | |
169 | ||
372e722e | 170 | status = chip->get_direction(chip, offset); |
80b0a602 MN |
171 | if (status > 0) { |
172 | /* GPIOF_DIR_IN, or other positive */ | |
173 | status = 1; | |
8e53b0f1 | 174 | clear_bit(FLAG_IS_OUT, &desc->flags); |
80b0a602 MN |
175 | } |
176 | if (status == 0) { | |
177 | /* GPIOF_DIR_OUT */ | |
8e53b0f1 | 178 | set_bit(FLAG_IS_OUT, &desc->flags); |
80b0a602 MN |
179 | } |
180 | return status; | |
181 | } | |
79a9becd | 182 | EXPORT_SYMBOL_GPL(gpiod_get_direction); |
80b0a602 | 183 | |
1a989d0f AC |
184 | /* |
185 | * Add a new chip to the global chips list, keeping the list of chips sorted | |
186 | * by base order. | |
187 | * | |
188 | * Return -EBUSY if the new chip overlaps with some other chip's integer | |
189 | * space. | |
190 | */ | |
191 | static int gpiochip_add_to_list(struct gpio_chip *chip) | |
192 | { | |
193 | struct list_head *pos = &gpio_chips; | |
194 | struct gpio_chip *_chip; | |
195 | int err = 0; | |
196 | ||
197 | /* find where to insert our chip */ | |
198 | list_for_each(pos, &gpio_chips) { | |
199 | _chip = list_entry(pos, struct gpio_chip, list); | |
200 | /* shall we insert before _chip? */ | |
201 | if (_chip->base >= chip->base + chip->ngpio) | |
202 | break; | |
203 | } | |
204 | ||
205 | /* are we stepping on the chip right before? */ | |
206 | if (pos != &gpio_chips && pos->prev != &gpio_chips) { | |
207 | _chip = list_entry(pos->prev, struct gpio_chip, list); | |
208 | if (_chip->base + _chip->ngpio > chip->base) { | |
209 | dev_err(chip->dev, | |
210 | "GPIO integer space overlap, cannot add chip\n"); | |
211 | err = -EBUSY; | |
212 | } | |
213 | } | |
214 | ||
215 | if (!err) | |
216 | list_add_tail(&chip->list, pos); | |
217 | ||
218 | return err; | |
219 | } | |
220 | ||
d2876d08 DB |
221 | /** |
222 | * gpiochip_add() - register a gpio_chip | |
223 | * @chip: the chip to register, with chip->base initialized | |
14e85c0e | 224 | * Context: potentially before irqs will work |
d2876d08 DB |
225 | * |
226 | * Returns a negative errno if the chip can't be registered, such as | |
227 | * because the chip->base is invalid or already associated with a | |
228 | * different chip. Otherwise it returns zero as a success code. | |
8d0aab2f | 229 | * |
d8f388d8 DB |
230 | * When gpiochip_add() is called very early during boot, so that GPIOs |
231 | * can be freely used, the chip->dev device must be registered before | |
232 | * the gpio framework's arch_initcall(). Otherwise sysfs initialization | |
233 | * for GPIOs will fail rudely. | |
234 | * | |
8d0aab2f AV |
235 | * If chip->base is negative, this requests dynamic assignment of |
236 | * a range of valid GPIOs. | |
d2876d08 DB |
237 | */ |
238 | int gpiochip_add(struct gpio_chip *chip) | |
239 | { | |
240 | unsigned long flags; | |
241 | int status = 0; | |
242 | unsigned id; | |
8d0aab2f | 243 | int base = chip->base; |
14e85c0e | 244 | struct gpio_desc *descs; |
d2876d08 | 245 | |
14e85c0e AC |
246 | descs = kcalloc(chip->ngpio, sizeof(descs[0]), GFP_KERNEL); |
247 | if (!descs) | |
248 | return -ENOMEM; | |
d2876d08 DB |
249 | |
250 | spin_lock_irqsave(&gpio_lock, flags); | |
251 | ||
8d0aab2f AV |
252 | if (base < 0) { |
253 | base = gpiochip_find_base(chip->ngpio); | |
254 | if (base < 0) { | |
255 | status = base; | |
225fce83 JH |
256 | spin_unlock_irqrestore(&gpio_lock, flags); |
257 | goto err_free_descs; | |
8d0aab2f AV |
258 | } |
259 | chip->base = base; | |
260 | } | |
261 | ||
1a989d0f | 262 | status = gpiochip_add_to_list(chip); |
05aa5203 JH |
263 | if (status) { |
264 | spin_unlock_irqrestore(&gpio_lock, flags); | |
265 | goto err_free_descs; | |
266 | } | |
1a989d0f | 267 | |
05aa5203 JH |
268 | for (id = 0; id < chip->ngpio; id++) { |
269 | struct gpio_desc *desc = &descs[id]; | |
270 | ||
271 | desc->chip = chip; | |
272 | ||
273 | /* REVISIT: most hardware initializes GPIOs as inputs (often | |
274 | * with pullups enabled) so power usage is minimized. Linux | |
275 | * code should set the gpio direction first thing; but until | |
276 | * it does, and in case chip->get_direction is not set, we may | |
277 | * expose the wrong direction in sysfs. | |
278 | */ | |
279 | desc->flags = !chip->direction_input ? (1 << FLAG_IS_OUT) : 0; | |
d2876d08 DB |
280 | } |
281 | ||
14e85c0e AC |
282 | chip->desc = descs; |
283 | ||
3bae4811 ZG |
284 | spin_unlock_irqrestore(&gpio_lock, flags); |
285 | ||
f23f1516 SH |
286 | #ifdef CONFIG_PINCTRL |
287 | INIT_LIST_HEAD(&chip->pin_ranges); | |
288 | #endif | |
289 | ||
391c970c | 290 | of_gpiochip_add(chip); |
664e3e5a | 291 | acpi_gpiochip_add(chip); |
391c970c | 292 | |
426577bd | 293 | status = gpiochip_sysfs_register(chip); |
225fce83 JH |
294 | if (status) |
295 | goto err_remove_chip; | |
cedb1881 | 296 | |
7589e59f | 297 | pr_debug("%s: registered GPIOs %d to %d on device: %s\n", __func__, |
64842aad GL |
298 | chip->base, chip->base + chip->ngpio - 1, |
299 | chip->label ? : "generic"); | |
300 | ||
cedb1881 | 301 | return 0; |
3bae4811 | 302 | |
225fce83 JH |
303 | err_remove_chip: |
304 | acpi_gpiochip_remove(chip); | |
6d86750c | 305 | gpiochip_free_hogs(chip); |
225fce83 JH |
306 | of_gpiochip_remove(chip); |
307 | spin_lock_irqsave(&gpio_lock, flags); | |
308 | list_del(&chip->list); | |
3bae4811 | 309 | spin_unlock_irqrestore(&gpio_lock, flags); |
05aa5203 | 310 | chip->desc = NULL; |
225fce83 | 311 | err_free_descs: |
14e85c0e | 312 | kfree(descs); |
14e85c0e | 313 | |
d2876d08 | 314 | /* failures here can mean systems won't boot... */ |
7589e59f | 315 | pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__, |
cedb1881 AV |
316 | chip->base, chip->base + chip->ngpio - 1, |
317 | chip->label ? : "generic"); | |
d2876d08 DB |
318 | return status; |
319 | } | |
320 | EXPORT_SYMBOL_GPL(gpiochip_add); | |
321 | ||
322 | /** | |
323 | * gpiochip_remove() - unregister a gpio_chip | |
324 | * @chip: the chip to unregister | |
325 | * | |
326 | * A gpio_chip with any GPIOs still requested may not be removed. | |
327 | */ | |
e1db1706 | 328 | void gpiochip_remove(struct gpio_chip *chip) |
d2876d08 | 329 | { |
fab28b89 | 330 | struct gpio_desc *desc; |
d2876d08 | 331 | unsigned long flags; |
d2876d08 | 332 | unsigned id; |
fab28b89 | 333 | bool requested = false; |
d2876d08 | 334 | |
426577bd | 335 | gpiochip_sysfs_unregister(chip); |
01cca93a | 336 | |
00acc3dc JH |
337 | gpiochip_irqchip_remove(chip); |
338 | ||
6072b9dc | 339 | acpi_gpiochip_remove(chip); |
9ef0d6f7 | 340 | gpiochip_remove_pin_ranges(chip); |
f625d460 | 341 | gpiochip_free_hogs(chip); |
391c970c AV |
342 | of_gpiochip_remove(chip); |
343 | ||
6798acaa | 344 | spin_lock_irqsave(&gpio_lock, flags); |
6c0b4e6c | 345 | for (id = 0; id < chip->ngpio; id++) { |
fab28b89 JH |
346 | desc = &chip->desc[id]; |
347 | desc->chip = NULL; | |
348 | if (test_bit(FLAG_REQUESTED, &desc->flags)) | |
349 | requested = true; | |
d2876d08 | 350 | } |
e1db1706 | 351 | list_del(&chip->list); |
d2876d08 | 352 | spin_unlock_irqrestore(&gpio_lock, flags); |
14e85c0e | 353 | |
fab28b89 JH |
354 | if (requested) |
355 | dev_crit(chip->dev, "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n"); | |
356 | ||
14e85c0e AC |
357 | kfree(chip->desc); |
358 | chip->desc = NULL; | |
d2876d08 DB |
359 | } |
360 | EXPORT_SYMBOL_GPL(gpiochip_remove); | |
361 | ||
594fa265 GL |
362 | /** |
363 | * gpiochip_find() - iterator for locating a specific gpio_chip | |
364 | * @data: data to pass to match function | |
365 | * @callback: Callback function to check gpio_chip | |
366 | * | |
367 | * Similar to bus_find_device. It returns a reference to a gpio_chip as | |
368 | * determined by a user supplied @match callback. The callback should return | |
369 | * 0 if the device doesn't match and non-zero if it does. If the callback is | |
370 | * non-zero, this function will return to the caller and not iterate over any | |
371 | * more gpio_chips. | |
372 | */ | |
07ce8ec7 | 373 | struct gpio_chip *gpiochip_find(void *data, |
6e2cf651 | 374 | int (*match)(struct gpio_chip *chip, |
3d0f7cf0 | 375 | void *data)) |
594fa265 | 376 | { |
125eef96 | 377 | struct gpio_chip *chip; |
594fa265 | 378 | unsigned long flags; |
594fa265 GL |
379 | |
380 | spin_lock_irqsave(&gpio_lock, flags); | |
125eef96 AC |
381 | list_for_each_entry(chip, &gpio_chips, list) |
382 | if (match(chip, data)) | |
594fa265 | 383 | break; |
125eef96 AC |
384 | |
385 | /* No match? */ | |
386 | if (&chip->list == &gpio_chips) | |
387 | chip = NULL; | |
594fa265 GL |
388 | spin_unlock_irqrestore(&gpio_lock, flags); |
389 | ||
390 | return chip; | |
391 | } | |
8fa0c9bf | 392 | EXPORT_SYMBOL_GPL(gpiochip_find); |
d2876d08 | 393 | |
79697ef9 AC |
394 | static int gpiochip_match_name(struct gpio_chip *chip, void *data) |
395 | { | |
396 | const char *name = data; | |
397 | ||
398 | return !strcmp(chip->label, name); | |
399 | } | |
400 | ||
401 | static struct gpio_chip *find_chip_by_name(const char *name) | |
402 | { | |
403 | return gpiochip_find((void *)name, gpiochip_match_name); | |
404 | } | |
405 | ||
14250520 LW |
406 | #ifdef CONFIG_GPIOLIB_IRQCHIP |
407 | ||
408 | /* | |
409 | * The following is irqchip helper code for gpiochips. | |
410 | */ | |
411 | ||
412 | /** | |
3f97d5fc LW |
413 | * gpiochip_set_chained_irqchip() - sets a chained irqchip to a gpiochip |
414 | * @gpiochip: the gpiochip to set the irqchip chain to | |
415 | * @irqchip: the irqchip to chain to the gpiochip | |
14250520 LW |
416 | * @parent_irq: the irq number corresponding to the parent IRQ for this |
417 | * chained irqchip | |
418 | * @parent_handler: the parent interrupt handler for the accumulated IRQ | |
3f97d5fc LW |
419 | * coming out of the gpiochip. If the interrupt is nested rather than |
420 | * cascaded, pass NULL in this handler argument | |
14250520 LW |
421 | */ |
422 | void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip, | |
423 | struct irq_chip *irqchip, | |
424 | int parent_irq, | |
425 | irq_flow_handler_t parent_handler) | |
426 | { | |
83141a77 LW |
427 | unsigned int offset; |
428 | ||
83141a77 LW |
429 | if (!gpiochip->irqdomain) { |
430 | chip_err(gpiochip, "called %s before setting up irqchip\n", | |
431 | __func__); | |
1c8732bb LW |
432 | return; |
433 | } | |
434 | ||
3f97d5fc LW |
435 | if (parent_handler) { |
436 | if (gpiochip->can_sleep) { | |
437 | chip_err(gpiochip, | |
438 | "you cannot have chained interrupts on a " | |
439 | "chip that may sleep\n"); | |
440 | return; | |
441 | } | |
3f97d5fc LW |
442 | /* |
443 | * The parent irqchip is already using the chip_data for this | |
444 | * irqchip, so our callbacks simply use the handler_data. | |
445 | */ | |
446 | irq_set_handler_data(parent_irq, gpiochip); | |
ea584595 | 447 | irq_set_chained_handler(parent_irq, parent_handler); |
25e4fe92 DES |
448 | |
449 | gpiochip->irq_parent = parent_irq; | |
3f97d5fc | 450 | } |
83141a77 LW |
451 | |
452 | /* Set the parent IRQ for all affected IRQs */ | |
453 | for (offset = 0; offset < gpiochip->ngpio; offset++) | |
454 | irq_set_parent(irq_find_mapping(gpiochip->irqdomain, offset), | |
455 | parent_irq); | |
14250520 LW |
456 | } |
457 | EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip); | |
458 | ||
e45d1c80 LW |
459 | /* |
460 | * This lock class tells lockdep that GPIO irqs are in a different | |
461 | * category than their parents, so it won't report false recursion. | |
462 | */ | |
463 | static struct lock_class_key gpiochip_irq_lock_class; | |
464 | ||
14250520 LW |
465 | /** |
466 | * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip | |
467 | * @d: the irqdomain used by this irqchip | |
468 | * @irq: the global irq number used by this GPIO irqchip irq | |
469 | * @hwirq: the local IRQ/GPIO line offset on this gpiochip | |
470 | * | |
471 | * This function will set up the mapping for a certain IRQ line on a | |
472 | * gpiochip by assigning the gpiochip as chip data, and using the irqchip | |
473 | * stored inside the gpiochip. | |
474 | */ | |
475 | static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq, | |
476 | irq_hw_number_t hwirq) | |
477 | { | |
478 | struct gpio_chip *chip = d->host_data; | |
479 | ||
14250520 | 480 | irq_set_chip_data(irq, chip); |
e45d1c80 | 481 | irq_set_lockdep_class(irq, &gpiochip_irq_lock_class); |
7633fb95 | 482 | irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler); |
1c8732bb | 483 | /* Chips that can sleep need nested thread handlers */ |
295494af | 484 | if (chip->can_sleep && !chip->irq_not_threaded) |
1c8732bb | 485 | irq_set_nested_thread(irq, 1); |
14250520 LW |
486 | #ifdef CONFIG_ARM |
487 | set_irq_flags(irq, IRQF_VALID); | |
488 | #else | |
489 | irq_set_noprobe(irq); | |
490 | #endif | |
1333b90f LW |
491 | /* |
492 | * No set-up of the hardware will happen if IRQ_TYPE_NONE | |
493 | * is passed as default type. | |
494 | */ | |
495 | if (chip->irq_default_type != IRQ_TYPE_NONE) | |
496 | irq_set_irq_type(irq, chip->irq_default_type); | |
14250520 LW |
497 | |
498 | return 0; | |
499 | } | |
500 | ||
c3626fde LW |
501 | static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq) |
502 | { | |
1c8732bb LW |
503 | struct gpio_chip *chip = d->host_data; |
504 | ||
c3626fde LW |
505 | #ifdef CONFIG_ARM |
506 | set_irq_flags(irq, 0); | |
507 | #endif | |
1c8732bb LW |
508 | if (chip->can_sleep) |
509 | irq_set_nested_thread(irq, 0); | |
c3626fde LW |
510 | irq_set_chip_and_handler(irq, NULL, NULL); |
511 | irq_set_chip_data(irq, NULL); | |
512 | } | |
513 | ||
14250520 LW |
514 | static const struct irq_domain_ops gpiochip_domain_ops = { |
515 | .map = gpiochip_irq_map, | |
c3626fde | 516 | .unmap = gpiochip_irq_unmap, |
14250520 LW |
517 | /* Virtually all GPIO irqchips are twocell:ed */ |
518 | .xlate = irq_domain_xlate_twocell, | |
519 | }; | |
520 | ||
521 | static int gpiochip_irq_reqres(struct irq_data *d) | |
522 | { | |
523 | struct gpio_chip *chip = irq_data_get_irq_chip_data(d); | |
524 | ||
e3a2e878 | 525 | if (gpiochip_lock_as_irq(chip, d->hwirq)) { |
14250520 LW |
526 | chip_err(chip, |
527 | "unable to lock HW IRQ %lu for IRQ\n", | |
528 | d->hwirq); | |
529 | return -EINVAL; | |
530 | } | |
531 | return 0; | |
532 | } | |
533 | ||
534 | static void gpiochip_irq_relres(struct irq_data *d) | |
535 | { | |
536 | struct gpio_chip *chip = irq_data_get_irq_chip_data(d); | |
537 | ||
e3a2e878 | 538 | gpiochip_unlock_as_irq(chip, d->hwirq); |
14250520 LW |
539 | } |
540 | ||
541 | static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset) | |
542 | { | |
543 | return irq_find_mapping(chip->irqdomain, offset); | |
544 | } | |
545 | ||
546 | /** | |
547 | * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip | |
548 | * @gpiochip: the gpiochip to remove the irqchip from | |
549 | * | |
550 | * This is called only from gpiochip_remove() | |
551 | */ | |
552 | static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) | |
553 | { | |
c3626fde LW |
554 | unsigned int offset; |
555 | ||
afa82fab MW |
556 | acpi_gpiochip_free_interrupts(gpiochip); |
557 | ||
25e4fe92 DES |
558 | if (gpiochip->irq_parent) { |
559 | irq_set_chained_handler(gpiochip->irq_parent, NULL); | |
560 | irq_set_handler_data(gpiochip->irq_parent, NULL); | |
561 | } | |
562 | ||
c3626fde LW |
563 | /* Remove all IRQ mappings and delete the domain */ |
564 | if (gpiochip->irqdomain) { | |
565 | for (offset = 0; offset < gpiochip->ngpio; offset++) | |
e3893386 GS |
566 | irq_dispose_mapping( |
567 | irq_find_mapping(gpiochip->irqdomain, offset)); | |
14250520 | 568 | irq_domain_remove(gpiochip->irqdomain); |
c3626fde | 569 | } |
14250520 LW |
570 | |
571 | if (gpiochip->irqchip) { | |
572 | gpiochip->irqchip->irq_request_resources = NULL; | |
573 | gpiochip->irqchip->irq_release_resources = NULL; | |
574 | gpiochip->irqchip = NULL; | |
575 | } | |
576 | } | |
577 | ||
578 | /** | |
579 | * gpiochip_irqchip_add() - adds an irqchip to a gpiochip | |
580 | * @gpiochip: the gpiochip to add the irqchip to | |
581 | * @irqchip: the irqchip to add to the gpiochip | |
582 | * @first_irq: if not dynamically assigned, the base (first) IRQ to | |
583 | * allocate gpiochip irqs from | |
584 | * @handler: the irq handler to use (often a predefined irq core function) | |
1333b90f LW |
585 | * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE |
586 | * to have the core avoid setting up any default type in the hardware. | |
14250520 LW |
587 | * |
588 | * This function closely associates a certain irqchip with a certain | |
589 | * gpiochip, providing an irq domain to translate the local IRQs to | |
590 | * global irqs in the gpiolib core, and making sure that the gpiochip | |
591 | * is passed as chip data to all related functions. Driver callbacks | |
592 | * need to use container_of() to get their local state containers back | |
593 | * from the gpiochip passed as chip data. An irqdomain will be stored | |
594 | * in the gpiochip that shall be used by the driver to handle IRQ number | |
595 | * translation. The gpiochip will need to be initialized and registered | |
596 | * before calling this function. | |
597 | * | |
c3626fde LW |
598 | * This function will handle two cell:ed simple IRQs and assumes all |
599 | * the pins on the gpiochip can generate a unique IRQ. Everything else | |
14250520 LW |
600 | * need to be open coded. |
601 | */ | |
602 | int gpiochip_irqchip_add(struct gpio_chip *gpiochip, | |
603 | struct irq_chip *irqchip, | |
604 | unsigned int first_irq, | |
605 | irq_flow_handler_t handler, | |
606 | unsigned int type) | |
607 | { | |
608 | struct device_node *of_node; | |
609 | unsigned int offset; | |
c3626fde | 610 | unsigned irq_base = 0; |
14250520 LW |
611 | |
612 | if (!gpiochip || !irqchip) | |
613 | return -EINVAL; | |
614 | ||
615 | if (!gpiochip->dev) { | |
616 | pr_err("missing gpiochip .dev parent pointer\n"); | |
617 | return -EINVAL; | |
618 | } | |
619 | of_node = gpiochip->dev->of_node; | |
620 | #ifdef CONFIG_OF_GPIO | |
621 | /* | |
20a8a968 | 622 | * If the gpiochip has an assigned OF node this takes precedence |
14250520 LW |
623 | * FIXME: get rid of this and use gpiochip->dev->of_node everywhere |
624 | */ | |
625 | if (gpiochip->of_node) | |
626 | of_node = gpiochip->of_node; | |
627 | #endif | |
628 | gpiochip->irqchip = irqchip; | |
629 | gpiochip->irq_handler = handler; | |
630 | gpiochip->irq_default_type = type; | |
631 | gpiochip->to_irq = gpiochip_to_irq; | |
632 | gpiochip->irqdomain = irq_domain_add_simple(of_node, | |
633 | gpiochip->ngpio, first_irq, | |
634 | &gpiochip_domain_ops, gpiochip); | |
635 | if (!gpiochip->irqdomain) { | |
636 | gpiochip->irqchip = NULL; | |
637 | return -EINVAL; | |
638 | } | |
639 | irqchip->irq_request_resources = gpiochip_irq_reqres; | |
640 | irqchip->irq_release_resources = gpiochip_irq_relres; | |
641 | ||
642 | /* | |
643 | * Prepare the mapping since the irqchip shall be orthogonal to | |
644 | * any gpiochip calls. If the first_irq was zero, this is | |
645 | * necessary to allocate descriptors for all IRQs. | |
646 | */ | |
c3626fde LW |
647 | for (offset = 0; offset < gpiochip->ngpio; offset++) { |
648 | irq_base = irq_create_mapping(gpiochip->irqdomain, offset); | |
649 | if (offset == 0) | |
650 | /* | |
651 | * Store the base into the gpiochip to be used when | |
652 | * unmapping the irqs. | |
653 | */ | |
654 | gpiochip->irq_base = irq_base; | |
655 | } | |
14250520 | 656 | |
afa82fab MW |
657 | acpi_gpiochip_request_interrupts(gpiochip); |
658 | ||
14250520 LW |
659 | return 0; |
660 | } | |
661 | EXPORT_SYMBOL_GPL(gpiochip_irqchip_add); | |
662 | ||
663 | #else /* CONFIG_GPIOLIB_IRQCHIP */ | |
664 | ||
665 | static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {} | |
666 | ||
667 | #endif /* CONFIG_GPIOLIB_IRQCHIP */ | |
668 | ||
f23f1516 | 669 | #ifdef CONFIG_PINCTRL |
165adc9c | 670 | |
586a87e6 CR |
671 | /** |
672 | * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping | |
673 | * @chip: the gpiochip to add the range for | |
674 | * @pinctrl: the dev_name() of the pin controller to map to | |
675 | * @gpio_offset: the start offset in the current gpio_chip number space | |
676 | * @pin_group: name of the pin group inside the pin controller | |
677 | */ | |
678 | int gpiochip_add_pingroup_range(struct gpio_chip *chip, | |
679 | struct pinctrl_dev *pctldev, | |
680 | unsigned int gpio_offset, const char *pin_group) | |
681 | { | |
682 | struct gpio_pin_range *pin_range; | |
683 | int ret; | |
684 | ||
685 | pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL); | |
686 | if (!pin_range) { | |
1a2a99c6 | 687 | chip_err(chip, "failed to allocate pin ranges\n"); |
586a87e6 CR |
688 | return -ENOMEM; |
689 | } | |
690 | ||
691 | /* Use local offset as range ID */ | |
692 | pin_range->range.id = gpio_offset; | |
693 | pin_range->range.gc = chip; | |
694 | pin_range->range.name = chip->label; | |
695 | pin_range->range.base = chip->base + gpio_offset; | |
696 | pin_range->pctldev = pctldev; | |
697 | ||
698 | ret = pinctrl_get_group_pins(pctldev, pin_group, | |
699 | &pin_range->range.pins, | |
700 | &pin_range->range.npins); | |
61c6375d MN |
701 | if (ret < 0) { |
702 | kfree(pin_range); | |
586a87e6 | 703 | return ret; |
61c6375d | 704 | } |
586a87e6 CR |
705 | |
706 | pinctrl_add_gpio_range(pctldev, &pin_range->range); | |
707 | ||
1a2a99c6 AS |
708 | chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n", |
709 | gpio_offset, gpio_offset + pin_range->range.npins - 1, | |
586a87e6 CR |
710 | pinctrl_dev_get_devname(pctldev), pin_group); |
711 | ||
712 | list_add_tail(&pin_range->node, &chip->pin_ranges); | |
713 | ||
714 | return 0; | |
715 | } | |
716 | EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range); | |
717 | ||
3f0f8670 LW |
718 | /** |
719 | * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping | |
720 | * @chip: the gpiochip to add the range for | |
721 | * @pinctrl_name: the dev_name() of the pin controller to map to | |
316511c0 LW |
722 | * @gpio_offset: the start offset in the current gpio_chip number space |
723 | * @pin_offset: the start offset in the pin controller number space | |
3f0f8670 LW |
724 | * @npins: the number of pins from the offset of each pin space (GPIO and |
725 | * pin controller) to accumulate in this range | |
726 | */ | |
1e63d7b9 | 727 | int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name, |
316511c0 | 728 | unsigned int gpio_offset, unsigned int pin_offset, |
3f0f8670 | 729 | unsigned int npins) |
f23f1516 SH |
730 | { |
731 | struct gpio_pin_range *pin_range; | |
b4d4b1f0 | 732 | int ret; |
f23f1516 | 733 | |
3f0f8670 | 734 | pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL); |
f23f1516 | 735 | if (!pin_range) { |
1a2a99c6 | 736 | chip_err(chip, "failed to allocate pin ranges\n"); |
1e63d7b9 | 737 | return -ENOMEM; |
f23f1516 SH |
738 | } |
739 | ||
3f0f8670 | 740 | /* Use local offset as range ID */ |
316511c0 | 741 | pin_range->range.id = gpio_offset; |
3f0f8670 | 742 | pin_range->range.gc = chip; |
f23f1516 | 743 | pin_range->range.name = chip->label; |
316511c0 LW |
744 | pin_range->range.base = chip->base + gpio_offset; |
745 | pin_range->range.pin_base = pin_offset; | |
f23f1516 | 746 | pin_range->range.npins = npins; |
192c369c | 747 | pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name, |
f23f1516 | 748 | &pin_range->range); |
8f23ca1a | 749 | if (IS_ERR(pin_range->pctldev)) { |
b4d4b1f0 | 750 | ret = PTR_ERR(pin_range->pctldev); |
1a2a99c6 | 751 | chip_err(chip, "could not create pin range\n"); |
3f0f8670 | 752 | kfree(pin_range); |
b4d4b1f0 | 753 | return ret; |
3f0f8670 | 754 | } |
1a2a99c6 AS |
755 | chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n", |
756 | gpio_offset, gpio_offset + npins - 1, | |
316511c0 LW |
757 | pinctl_name, |
758 | pin_offset, pin_offset + npins - 1); | |
f23f1516 SH |
759 | |
760 | list_add_tail(&pin_range->node, &chip->pin_ranges); | |
1e63d7b9 LW |
761 | |
762 | return 0; | |
f23f1516 | 763 | } |
165adc9c | 764 | EXPORT_SYMBOL_GPL(gpiochip_add_pin_range); |
f23f1516 | 765 | |
3f0f8670 LW |
766 | /** |
767 | * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings | |
768 | * @chip: the chip to remove all the mappings for | |
769 | */ | |
f23f1516 SH |
770 | void gpiochip_remove_pin_ranges(struct gpio_chip *chip) |
771 | { | |
772 | struct gpio_pin_range *pin_range, *tmp; | |
773 | ||
774 | list_for_each_entry_safe(pin_range, tmp, &chip->pin_ranges, node) { | |
775 | list_del(&pin_range->node); | |
776 | pinctrl_remove_gpio_range(pin_range->pctldev, | |
777 | &pin_range->range); | |
3f0f8670 | 778 | kfree(pin_range); |
f23f1516 SH |
779 | } |
780 | } | |
165adc9c LW |
781 | EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges); |
782 | ||
783 | #endif /* CONFIG_PINCTRL */ | |
f23f1516 | 784 | |
d2876d08 DB |
785 | /* These "optional" allocation calls help prevent drivers from stomping |
786 | * on each other, and help provide better diagnostics in debugfs. | |
787 | * They're called even less than the "set direction" calls. | |
788 | */ | |
77c2d792 | 789 | static int __gpiod_request(struct gpio_desc *desc, const char *label) |
d2876d08 | 790 | { |
77c2d792 MW |
791 | struct gpio_chip *chip = desc->chip; |
792 | int status; | |
d2876d08 DB |
793 | unsigned long flags; |
794 | ||
bcabdef1 AC |
795 | spin_lock_irqsave(&gpio_lock, flags); |
796 | ||
d2876d08 | 797 | /* NOTE: gpio_request() can be called in early boot, |
35e8bb51 | 798 | * before IRQs are enabled, for non-sleeping (SOC) GPIOs. |
d2876d08 DB |
799 | */ |
800 | ||
801 | if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) { | |
802 | desc_set_label(desc, label ? : "?"); | |
803 | status = 0; | |
438d8908 | 804 | } else { |
d2876d08 | 805 | status = -EBUSY; |
7460db56 | 806 | goto done; |
35e8bb51 DB |
807 | } |
808 | ||
809 | if (chip->request) { | |
810 | /* chip->request may sleep */ | |
811 | spin_unlock_irqrestore(&gpio_lock, flags); | |
372e722e | 812 | status = chip->request(chip, gpio_chip_hwgpio(desc)); |
35e8bb51 DB |
813 | spin_lock_irqsave(&gpio_lock, flags); |
814 | ||
815 | if (status < 0) { | |
816 | desc_set_label(desc, NULL); | |
35e8bb51 | 817 | clear_bit(FLAG_REQUESTED, &desc->flags); |
80b0a602 | 818 | goto done; |
35e8bb51 | 819 | } |
438d8908 | 820 | } |
80b0a602 MN |
821 | if (chip->get_direction) { |
822 | /* chip->get_direction may sleep */ | |
823 | spin_unlock_irqrestore(&gpio_lock, flags); | |
372e722e | 824 | gpiod_get_direction(desc); |
80b0a602 MN |
825 | spin_lock_irqsave(&gpio_lock, flags); |
826 | } | |
77c2d792 MW |
827 | done: |
828 | spin_unlock_irqrestore(&gpio_lock, flags); | |
829 | return status; | |
830 | } | |
831 | ||
0eb4c6c2 | 832 | int gpiod_request(struct gpio_desc *desc, const char *label) |
77c2d792 MW |
833 | { |
834 | int status = -EPROBE_DEFER; | |
835 | struct gpio_chip *chip; | |
836 | ||
837 | if (!desc) { | |
838 | pr_warn("%s: invalid GPIO\n", __func__); | |
839 | return -EINVAL; | |
840 | } | |
841 | ||
842 | chip = desc->chip; | |
843 | if (!chip) | |
844 | goto done; | |
845 | ||
846 | if (try_module_get(chip->owner)) { | |
847 | status = __gpiod_request(desc, label); | |
848 | if (status < 0) | |
849 | module_put(chip->owner); | |
850 | } | |
851 | ||
d2876d08 DB |
852 | done: |
853 | if (status) | |
7589e59f | 854 | gpiod_dbg(desc, "%s: status %d\n", __func__, status); |
77c2d792 | 855 | |
d2876d08 DB |
856 | return status; |
857 | } | |
372e722e | 858 | |
77c2d792 | 859 | static bool __gpiod_free(struct gpio_desc *desc) |
d2876d08 | 860 | { |
77c2d792 | 861 | bool ret = false; |
d2876d08 | 862 | unsigned long flags; |
35e8bb51 | 863 | struct gpio_chip *chip; |
d2876d08 | 864 | |
3d599d1c UKK |
865 | might_sleep(); |
866 | ||
372e722e | 867 | gpiod_unexport(desc); |
d8f388d8 | 868 | |
d2876d08 DB |
869 | spin_lock_irqsave(&gpio_lock, flags); |
870 | ||
35e8bb51 DB |
871 | chip = desc->chip; |
872 | if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) { | |
873 | if (chip->free) { | |
874 | spin_unlock_irqrestore(&gpio_lock, flags); | |
9c4ba946 | 875 | might_sleep_if(chip->can_sleep); |
372e722e | 876 | chip->free(chip, gpio_chip_hwgpio(desc)); |
35e8bb51 DB |
877 | spin_lock_irqsave(&gpio_lock, flags); |
878 | } | |
d2876d08 | 879 | desc_set_label(desc, NULL); |
07697461 | 880 | clear_bit(FLAG_ACTIVE_LOW, &desc->flags); |
35e8bb51 | 881 | clear_bit(FLAG_REQUESTED, &desc->flags); |
aca5ce14 | 882 | clear_bit(FLAG_OPEN_DRAIN, &desc->flags); |
25553ff0 | 883 | clear_bit(FLAG_OPEN_SOURCE, &desc->flags); |
f625d460 | 884 | clear_bit(FLAG_IS_HOGGED, &desc->flags); |
77c2d792 MW |
885 | ret = true; |
886 | } | |
d2876d08 DB |
887 | |
888 | spin_unlock_irqrestore(&gpio_lock, flags); | |
77c2d792 MW |
889 | return ret; |
890 | } | |
891 | ||
0eb4c6c2 | 892 | void gpiod_free(struct gpio_desc *desc) |
77c2d792 MW |
893 | { |
894 | if (desc && __gpiod_free(desc)) | |
895 | module_put(desc->chip->owner); | |
896 | else | |
897 | WARN_ON(extra_checks); | |
d2876d08 | 898 | } |
372e722e | 899 | |
d2876d08 DB |
900 | /** |
901 | * gpiochip_is_requested - return string iff signal was requested | |
902 | * @chip: controller managing the signal | |
903 | * @offset: of signal within controller's 0..(ngpio - 1) range | |
904 | * | |
905 | * Returns NULL if the GPIO is not currently requested, else a string. | |
9c8318ff AC |
906 | * The string returned is the label passed to gpio_request(); if none has been |
907 | * passed it is a meaningless, non-NULL constant. | |
d2876d08 DB |
908 | * |
909 | * This function is for use by GPIO controller drivers. The label can | |
910 | * help with diagnostics, and knowing that the signal is used as a GPIO | |
911 | * can help avoid accidentally multiplexing it to another controller. | |
912 | */ | |
913 | const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset) | |
914 | { | |
6c0b4e6c | 915 | struct gpio_desc *desc; |
d2876d08 | 916 | |
6c0b4e6c | 917 | if (!GPIO_OFFSET_VALID(chip, offset)) |
d2876d08 | 918 | return NULL; |
6c0b4e6c AC |
919 | |
920 | desc = &chip->desc[offset]; | |
921 | ||
372e722e | 922 | if (test_bit(FLAG_REQUESTED, &desc->flags) == 0) |
d2876d08 | 923 | return NULL; |
372e722e | 924 | return desc->label; |
d2876d08 DB |
925 | } |
926 | EXPORT_SYMBOL_GPL(gpiochip_is_requested); | |
927 | ||
77c2d792 MW |
928 | /** |
929 | * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor | |
930 | * @desc: GPIO descriptor to request | |
931 | * @label: label for the GPIO | |
932 | * | |
933 | * Function allows GPIO chip drivers to request and use their own GPIO | |
934 | * descriptors via gpiolib API. Difference to gpiod_request() is that this | |
935 | * function will not increase reference count of the GPIO chip module. This | |
936 | * allows the GPIO chip module to be unloaded as needed (we assume that the | |
937 | * GPIO chip driver handles freeing the GPIOs it has requested). | |
938 | */ | |
abdc08a3 AC |
939 | struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum, |
940 | const char *label) | |
77c2d792 | 941 | { |
abdc08a3 AC |
942 | struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum); |
943 | int err; | |
77c2d792 | 944 | |
abdc08a3 AC |
945 | if (IS_ERR(desc)) { |
946 | chip_err(chip, "failed to get GPIO descriptor\n"); | |
947 | return desc; | |
948 | } | |
949 | ||
950 | err = __gpiod_request(desc, label); | |
951 | if (err < 0) | |
952 | return ERR_PTR(err); | |
77c2d792 | 953 | |
abdc08a3 | 954 | return desc; |
77c2d792 | 955 | } |
f7d4ad98 | 956 | EXPORT_SYMBOL_GPL(gpiochip_request_own_desc); |
77c2d792 MW |
957 | |
958 | /** | |
959 | * gpiochip_free_own_desc - Free GPIO requested by the chip driver | |
960 | * @desc: GPIO descriptor to free | |
961 | * | |
962 | * Function frees the given GPIO requested previously with | |
963 | * gpiochip_request_own_desc(). | |
964 | */ | |
965 | void gpiochip_free_own_desc(struct gpio_desc *desc) | |
966 | { | |
967 | if (desc) | |
968 | __gpiod_free(desc); | |
969 | } | |
f7d4ad98 | 970 | EXPORT_SYMBOL_GPL(gpiochip_free_own_desc); |
d2876d08 DB |
971 | |
972 | /* Drivers MUST set GPIO direction before making get/set calls. In | |
973 | * some cases this is done in early boot, before IRQs are enabled. | |
974 | * | |
975 | * As a rule these aren't called more than once (except for drivers | |
976 | * using the open-drain emulation idiom) so these are natural places | |
977 | * to accumulate extra debugging checks. Note that we can't (yet) | |
978 | * rely on gpio_request() having been called beforehand. | |
979 | */ | |
980 | ||
79a9becd AC |
981 | /** |
982 | * gpiod_direction_input - set the GPIO direction to input | |
983 | * @desc: GPIO to set to input | |
984 | * | |
985 | * Set the direction of the passed GPIO to input, such as gpiod_get_value() can | |
986 | * be called safely on it. | |
987 | * | |
988 | * Return 0 in case of success, else an error code. | |
989 | */ | |
990 | int gpiod_direction_input(struct gpio_desc *desc) | |
d2876d08 | 991 | { |
d2876d08 | 992 | struct gpio_chip *chip; |
d2876d08 DB |
993 | int status = -EINVAL; |
994 | ||
be1a4b13 | 995 | if (!desc || !desc->chip) { |
bcabdef1 AC |
996 | pr_warn("%s: invalid GPIO\n", __func__); |
997 | return -EINVAL; | |
998 | } | |
999 | ||
be1a4b13 LW |
1000 | chip = desc->chip; |
1001 | if (!chip->get || !chip->direction_input) { | |
6424de5a MB |
1002 | gpiod_warn(desc, |
1003 | "%s: missing get() or direction_input() operations\n", | |
7589e59f | 1004 | __func__); |
be1a4b13 LW |
1005 | return -EIO; |
1006 | } | |
1007 | ||
d82da797 | 1008 | status = chip->direction_input(chip, gpio_chip_hwgpio(desc)); |
d2876d08 DB |
1009 | if (status == 0) |
1010 | clear_bit(FLAG_IS_OUT, &desc->flags); | |
3f397c21 | 1011 | |
372e722e | 1012 | trace_gpio_direction(desc_to_gpio(desc), 1, status); |
d82da797 | 1013 | |
d2876d08 DB |
1014 | return status; |
1015 | } | |
79a9becd | 1016 | EXPORT_SYMBOL_GPL(gpiod_direction_input); |
372e722e | 1017 | |
ef70bbe1 | 1018 | static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value) |
d2876d08 | 1019 | { |
d2876d08 | 1020 | struct gpio_chip *chip; |
d2876d08 DB |
1021 | int status = -EINVAL; |
1022 | ||
d468bf9e LW |
1023 | /* GPIOs used for IRQs shall not be set as output */ |
1024 | if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) { | |
1025 | gpiod_err(desc, | |
1026 | "%s: tried to set a GPIO tied to an IRQ as output\n", | |
1027 | __func__); | |
1028 | return -EIO; | |
1029 | } | |
1030 | ||
aca5ce14 LD |
1031 | /* Open drain pin should not be driven to 1 */ |
1032 | if (value && test_bit(FLAG_OPEN_DRAIN, &desc->flags)) | |
372e722e | 1033 | return gpiod_direction_input(desc); |
aca5ce14 | 1034 | |
25553ff0 LD |
1035 | /* Open source pin should not be driven to 0 */ |
1036 | if (!value && test_bit(FLAG_OPEN_SOURCE, &desc->flags)) | |
372e722e | 1037 | return gpiod_direction_input(desc); |
25553ff0 | 1038 | |
be1a4b13 LW |
1039 | chip = desc->chip; |
1040 | if (!chip->set || !chip->direction_output) { | |
6424de5a MB |
1041 | gpiod_warn(desc, |
1042 | "%s: missing set() or direction_output() operations\n", | |
1043 | __func__); | |
be1a4b13 LW |
1044 | return -EIO; |
1045 | } | |
1046 | ||
d82da797 | 1047 | status = chip->direction_output(chip, gpio_chip_hwgpio(desc), value); |
d2876d08 DB |
1048 | if (status == 0) |
1049 | set_bit(FLAG_IS_OUT, &desc->flags); | |
372e722e AC |
1050 | trace_gpio_value(desc_to_gpio(desc), 0, value); |
1051 | trace_gpio_direction(desc_to_gpio(desc), 0, status); | |
d2876d08 DB |
1052 | return status; |
1053 | } | |
ef70bbe1 PZ |
1054 | |
1055 | /** | |
1056 | * gpiod_direction_output_raw - set the GPIO direction to output | |
1057 | * @desc: GPIO to set to output | |
1058 | * @value: initial output value of the GPIO | |
1059 | * | |
1060 | * Set the direction of the passed GPIO to output, such as gpiod_set_value() can | |
1061 | * be called safely on it. The initial value of the output must be specified | |
1062 | * as raw value on the physical line without regard for the ACTIVE_LOW status. | |
1063 | * | |
1064 | * Return 0 in case of success, else an error code. | |
1065 | */ | |
1066 | int gpiod_direction_output_raw(struct gpio_desc *desc, int value) | |
1067 | { | |
1068 | if (!desc || !desc->chip) { | |
1069 | pr_warn("%s: invalid GPIO\n", __func__); | |
1070 | return -EINVAL; | |
1071 | } | |
1072 | return _gpiod_direction_output_raw(desc, value); | |
1073 | } | |
1074 | EXPORT_SYMBOL_GPL(gpiod_direction_output_raw); | |
1075 | ||
1076 | /** | |
90df4fe0 | 1077 | * gpiod_direction_output - set the GPIO direction to output |
ef70bbe1 PZ |
1078 | * @desc: GPIO to set to output |
1079 | * @value: initial output value of the GPIO | |
1080 | * | |
1081 | * Set the direction of the passed GPIO to output, such as gpiod_set_value() can | |
1082 | * be called safely on it. The initial value of the output must be specified | |
1083 | * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into | |
1084 | * account. | |
1085 | * | |
1086 | * Return 0 in case of success, else an error code. | |
1087 | */ | |
1088 | int gpiod_direction_output(struct gpio_desc *desc, int value) | |
1089 | { | |
1090 | if (!desc || !desc->chip) { | |
1091 | pr_warn("%s: invalid GPIO\n", __func__); | |
1092 | return -EINVAL; | |
1093 | } | |
1094 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) | |
1095 | value = !value; | |
1096 | return _gpiod_direction_output_raw(desc, value); | |
1097 | } | |
79a9becd | 1098 | EXPORT_SYMBOL_GPL(gpiod_direction_output); |
d2876d08 | 1099 | |
c4b5be98 | 1100 | /** |
79a9becd | 1101 | * gpiod_set_debounce - sets @debounce time for a @gpio |
c4b5be98 FB |
1102 | * @gpio: the gpio to set debounce time |
1103 | * @debounce: debounce time is microseconds | |
65d87656 LW |
1104 | * |
1105 | * returns -ENOTSUPP if the controller does not support setting | |
1106 | * debounce. | |
c4b5be98 | 1107 | */ |
79a9becd | 1108 | int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce) |
c4b5be98 | 1109 | { |
c4b5be98 | 1110 | struct gpio_chip *chip; |
c4b5be98 | 1111 | |
be1a4b13 | 1112 | if (!desc || !desc->chip) { |
bcabdef1 AC |
1113 | pr_warn("%s: invalid GPIO\n", __func__); |
1114 | return -EINVAL; | |
1115 | } | |
1116 | ||
c4b5be98 | 1117 | chip = desc->chip; |
be1a4b13 | 1118 | if (!chip->set || !chip->set_debounce) { |
6424de5a MB |
1119 | gpiod_dbg(desc, |
1120 | "%s: missing set() or set_debounce() operations\n", | |
1121 | __func__); | |
65d87656 | 1122 | return -ENOTSUPP; |
be1a4b13 LW |
1123 | } |
1124 | ||
d82da797 | 1125 | return chip->set_debounce(chip, gpio_chip_hwgpio(desc), debounce); |
c4b5be98 | 1126 | } |
79a9becd | 1127 | EXPORT_SYMBOL_GPL(gpiod_set_debounce); |
372e722e | 1128 | |
79a9becd AC |
1129 | /** |
1130 | * gpiod_is_active_low - test whether a GPIO is active-low or not | |
1131 | * @desc: the gpio descriptor to test | |
1132 | * | |
1133 | * Returns 1 if the GPIO is active-low, 0 otherwise. | |
1134 | */ | |
1135 | int gpiod_is_active_low(const struct gpio_desc *desc) | |
372e722e | 1136 | { |
79a9becd | 1137 | return test_bit(FLAG_ACTIVE_LOW, &desc->flags); |
372e722e | 1138 | } |
79a9becd | 1139 | EXPORT_SYMBOL_GPL(gpiod_is_active_low); |
d2876d08 DB |
1140 | |
1141 | /* I/O calls are only valid after configuration completed; the relevant | |
1142 | * "is this a valid GPIO" error checks should already have been done. | |
1143 | * | |
1144 | * "Get" operations are often inlinable as reading a pin value register, | |
1145 | * and masking the relevant bit in that register. | |
1146 | * | |
1147 | * When "set" operations are inlinable, they involve writing that mask to | |
1148 | * one register to set a low value, or a different register to set it high. | |
1149 | * Otherwise locking is needed, so there may be little value to inlining. | |
1150 | * | |
1151 | *------------------------------------------------------------------------ | |
1152 | * | |
1153 | * IMPORTANT!!! The hot paths -- get/set value -- assume that callers | |
1154 | * have requested the GPIO. That can include implicit requesting by | |
1155 | * a direction setting call. Marking a gpio as requested locks its chip | |
1156 | * in memory, guaranteeing that these table lookups need no more locking | |
1157 | * and that gpiochip_remove() will fail. | |
1158 | * | |
1159 | * REVISIT when debugging, consider adding some instrumentation to ensure | |
1160 | * that the GPIO was actually requested. | |
1161 | */ | |
1162 | ||
23600969 | 1163 | static bool _gpiod_get_raw_value(const struct gpio_desc *desc) |
d2876d08 DB |
1164 | { |
1165 | struct gpio_chip *chip; | |
23600969 | 1166 | bool value; |
372e722e | 1167 | int offset; |
d2876d08 | 1168 | |
372e722e AC |
1169 | chip = desc->chip; |
1170 | offset = gpio_chip_hwgpio(desc); | |
23600969 | 1171 | value = chip->get ? chip->get(chip, offset) : false; |
372e722e | 1172 | trace_gpio_value(desc_to_gpio(desc), 1, value); |
3f397c21 | 1173 | return value; |
d2876d08 | 1174 | } |
372e722e | 1175 | |
d2876d08 | 1176 | /** |
79a9becd AC |
1177 | * gpiod_get_raw_value() - return a gpio's raw value |
1178 | * @desc: gpio whose value will be returned | |
d2876d08 | 1179 | * |
79a9becd AC |
1180 | * Return the GPIO's raw value, i.e. the value of the physical line disregarding |
1181 | * its ACTIVE_LOW status. | |
1182 | * | |
1183 | * This function should be called from contexts where we cannot sleep, and will | |
1184 | * complain if the GPIO chip functions potentially sleep. | |
d2876d08 | 1185 | */ |
79a9becd | 1186 | int gpiod_get_raw_value(const struct gpio_desc *desc) |
d2876d08 | 1187 | { |
bcabdef1 AC |
1188 | if (!desc) |
1189 | return 0; | |
e4e449e8 | 1190 | /* Should be using gpio_get_value_cansleep() */ |
d8e0ac08 | 1191 | WARN_ON(desc->chip->can_sleep); |
79a9becd | 1192 | return _gpiod_get_raw_value(desc); |
d2876d08 | 1193 | } |
79a9becd | 1194 | EXPORT_SYMBOL_GPL(gpiod_get_raw_value); |
372e722e | 1195 | |
79a9becd AC |
1196 | /** |
1197 | * gpiod_get_value() - return a gpio's value | |
1198 | * @desc: gpio whose value will be returned | |
1199 | * | |
1200 | * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into | |
1201 | * account. | |
1202 | * | |
1203 | * This function should be called from contexts where we cannot sleep, and will | |
1204 | * complain if the GPIO chip functions potentially sleep. | |
1205 | */ | |
1206 | int gpiod_get_value(const struct gpio_desc *desc) | |
372e722e | 1207 | { |
79a9becd AC |
1208 | int value; |
1209 | if (!desc) | |
1210 | return 0; | |
1211 | /* Should be using gpio_get_value_cansleep() */ | |
1212 | WARN_ON(desc->chip->can_sleep); | |
1213 | ||
1214 | value = _gpiod_get_raw_value(desc); | |
1215 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) | |
1216 | value = !value; | |
1217 | ||
1218 | return value; | |
372e722e | 1219 | } |
79a9becd | 1220 | EXPORT_SYMBOL_GPL(gpiod_get_value); |
d2876d08 | 1221 | |
aca5ce14 LD |
1222 | /* |
1223 | * _gpio_set_open_drain_value() - Set the open drain gpio's value. | |
79a9becd | 1224 | * @desc: gpio descriptor whose state need to be set. |
20a8a968 | 1225 | * @value: Non-zero for setting it HIGH otherwise it will set to LOW. |
aca5ce14 | 1226 | */ |
23600969 | 1227 | static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value) |
aca5ce14 LD |
1228 | { |
1229 | int err = 0; | |
372e722e AC |
1230 | struct gpio_chip *chip = desc->chip; |
1231 | int offset = gpio_chip_hwgpio(desc); | |
1232 | ||
aca5ce14 | 1233 | if (value) { |
372e722e | 1234 | err = chip->direction_input(chip, offset); |
aca5ce14 | 1235 | if (!err) |
372e722e | 1236 | clear_bit(FLAG_IS_OUT, &desc->flags); |
aca5ce14 | 1237 | } else { |
372e722e | 1238 | err = chip->direction_output(chip, offset, 0); |
aca5ce14 | 1239 | if (!err) |
372e722e | 1240 | set_bit(FLAG_IS_OUT, &desc->flags); |
aca5ce14 | 1241 | } |
372e722e | 1242 | trace_gpio_direction(desc_to_gpio(desc), value, err); |
aca5ce14 | 1243 | if (err < 0) |
6424de5a MB |
1244 | gpiod_err(desc, |
1245 | "%s: Error in set_value for open drain err %d\n", | |
1246 | __func__, err); | |
aca5ce14 LD |
1247 | } |
1248 | ||
25553ff0 | 1249 | /* |
79a9becd AC |
1250 | * _gpio_set_open_source_value() - Set the open source gpio's value. |
1251 | * @desc: gpio descriptor whose state need to be set. | |
20a8a968 | 1252 | * @value: Non-zero for setting it HIGH otherwise it will set to LOW. |
25553ff0 | 1253 | */ |
23600969 | 1254 | static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value) |
25553ff0 LD |
1255 | { |
1256 | int err = 0; | |
372e722e AC |
1257 | struct gpio_chip *chip = desc->chip; |
1258 | int offset = gpio_chip_hwgpio(desc); | |
1259 | ||
25553ff0 | 1260 | if (value) { |
372e722e | 1261 | err = chip->direction_output(chip, offset, 1); |
25553ff0 | 1262 | if (!err) |
372e722e | 1263 | set_bit(FLAG_IS_OUT, &desc->flags); |
25553ff0 | 1264 | } else { |
372e722e | 1265 | err = chip->direction_input(chip, offset); |
25553ff0 | 1266 | if (!err) |
372e722e | 1267 | clear_bit(FLAG_IS_OUT, &desc->flags); |
25553ff0 | 1268 | } |
372e722e | 1269 | trace_gpio_direction(desc_to_gpio(desc), !value, err); |
25553ff0 | 1270 | if (err < 0) |
6424de5a MB |
1271 | gpiod_err(desc, |
1272 | "%s: Error in set_value for open source err %d\n", | |
1273 | __func__, err); | |
25553ff0 LD |
1274 | } |
1275 | ||
23600969 | 1276 | static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value) |
d2876d08 DB |
1277 | { |
1278 | struct gpio_chip *chip; | |
1279 | ||
372e722e | 1280 | chip = desc->chip; |
372e722e AC |
1281 | trace_gpio_value(desc_to_gpio(desc), 0, value); |
1282 | if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) | |
1283 | _gpio_set_open_drain_value(desc, value); | |
1284 | else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) | |
1285 | _gpio_set_open_source_value(desc, value); | |
aca5ce14 | 1286 | else |
372e722e AC |
1287 | chip->set(chip, gpio_chip_hwgpio(desc), value); |
1288 | } | |
1289 | ||
5f424243 RI |
1290 | /* |
1291 | * set multiple outputs on the same chip; | |
1292 | * use the chip's set_multiple function if available; | |
1293 | * otherwise set the outputs sequentially; | |
1294 | * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word | |
1295 | * defines which outputs are to be changed | |
1296 | * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word | |
1297 | * defines the values the outputs specified by mask are to be set to | |
1298 | */ | |
1299 | static void gpio_chip_set_multiple(struct gpio_chip *chip, | |
1300 | unsigned long *mask, unsigned long *bits) | |
1301 | { | |
1302 | if (chip->set_multiple) { | |
1303 | chip->set_multiple(chip, mask, bits); | |
1304 | } else { | |
1305 | int i; | |
1306 | for (i = 0; i < chip->ngpio; i++) { | |
1307 | if (mask[BIT_WORD(i)] == 0) { | |
1308 | /* no more set bits in this mask word; | |
1309 | * skip ahead to the next word */ | |
1310 | i = (BIT_WORD(i) + 1) * BITS_PER_LONG - 1; | |
1311 | continue; | |
1312 | } | |
1313 | /* set outputs if the corresponding mask bit is set */ | |
38e003f4 | 1314 | if (__test_and_clear_bit(i, mask)) |
5f424243 | 1315 | chip->set(chip, i, test_bit(i, bits)); |
5f424243 RI |
1316 | } |
1317 | } | |
1318 | } | |
1319 | ||
3fff99bc RI |
1320 | static void gpiod_set_array_value_priv(bool raw, bool can_sleep, |
1321 | unsigned int array_size, | |
1322 | struct gpio_desc **desc_array, | |
1323 | int *value_array) | |
5f424243 RI |
1324 | { |
1325 | int i = 0; | |
1326 | ||
1327 | while (i < array_size) { | |
1328 | struct gpio_chip *chip = desc_array[i]->chip; | |
1329 | unsigned long mask[BITS_TO_LONGS(chip->ngpio)]; | |
1330 | unsigned long bits[BITS_TO_LONGS(chip->ngpio)]; | |
1331 | int count = 0; | |
1332 | ||
38e003f4 | 1333 | if (!can_sleep) |
5f424243 | 1334 | WARN_ON(chip->can_sleep); |
38e003f4 | 1335 | |
5f424243 RI |
1336 | memset(mask, 0, sizeof(mask)); |
1337 | do { | |
1338 | struct gpio_desc *desc = desc_array[i]; | |
1339 | int hwgpio = gpio_chip_hwgpio(desc); | |
1340 | int value = value_array[i]; | |
1341 | ||
1342 | if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags)) | |
1343 | value = !value; | |
1344 | trace_gpio_value(desc_to_gpio(desc), 0, value); | |
1345 | /* | |
1346 | * collect all normal outputs belonging to the same chip | |
1347 | * open drain and open source outputs are set individually | |
1348 | */ | |
1349 | if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) { | |
38e003f4 | 1350 | _gpio_set_open_drain_value(desc, value); |
5f424243 RI |
1351 | } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) { |
1352 | _gpio_set_open_source_value(desc, value); | |
1353 | } else { | |
1354 | __set_bit(hwgpio, mask); | |
38e003f4 | 1355 | if (value) |
5f424243 | 1356 | __set_bit(hwgpio, bits); |
38e003f4 | 1357 | else |
5f424243 | 1358 | __clear_bit(hwgpio, bits); |
5f424243 RI |
1359 | count++; |
1360 | } | |
1361 | i++; | |
1362 | } while ((i < array_size) && (desc_array[i]->chip == chip)); | |
1363 | /* push collected bits to outputs */ | |
38e003f4 | 1364 | if (count != 0) |
5f424243 | 1365 | gpio_chip_set_multiple(chip, mask, bits); |
5f424243 RI |
1366 | } |
1367 | } | |
1368 | ||
d2876d08 | 1369 | /** |
79a9becd AC |
1370 | * gpiod_set_raw_value() - assign a gpio's raw value |
1371 | * @desc: gpio whose value will be assigned | |
d2876d08 | 1372 | * @value: value to assign |
d2876d08 | 1373 | * |
79a9becd AC |
1374 | * Set the raw value of the GPIO, i.e. the value of its physical line without |
1375 | * regard for its ACTIVE_LOW status. | |
1376 | * | |
1377 | * This function should be called from contexts where we cannot sleep, and will | |
1378 | * complain if the GPIO chip functions potentially sleep. | |
d2876d08 | 1379 | */ |
79a9becd | 1380 | void gpiod_set_raw_value(struct gpio_desc *desc, int value) |
372e722e | 1381 | { |
bcabdef1 AC |
1382 | if (!desc) |
1383 | return; | |
e4e449e8 | 1384 | /* Should be using gpio_set_value_cansleep() */ |
d8e0ac08 | 1385 | WARN_ON(desc->chip->can_sleep); |
79a9becd | 1386 | _gpiod_set_raw_value(desc, value); |
d2876d08 | 1387 | } |
79a9becd | 1388 | EXPORT_SYMBOL_GPL(gpiod_set_raw_value); |
d2876d08 DB |
1389 | |
1390 | /** | |
79a9becd AC |
1391 | * gpiod_set_value() - assign a gpio's value |
1392 | * @desc: gpio whose value will be assigned | |
1393 | * @value: value to assign | |
1394 | * | |
1395 | * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into | |
1396 | * account | |
d2876d08 | 1397 | * |
79a9becd AC |
1398 | * This function should be called from contexts where we cannot sleep, and will |
1399 | * complain if the GPIO chip functions potentially sleep. | |
d2876d08 | 1400 | */ |
79a9becd | 1401 | void gpiod_set_value(struct gpio_desc *desc, int value) |
d2876d08 | 1402 | { |
bcabdef1 | 1403 | if (!desc) |
79a9becd AC |
1404 | return; |
1405 | /* Should be using gpio_set_value_cansleep() */ | |
1406 | WARN_ON(desc->chip->can_sleep); | |
1407 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) | |
1408 | value = !value; | |
1409 | _gpiod_set_raw_value(desc, value); | |
372e722e | 1410 | } |
79a9becd | 1411 | EXPORT_SYMBOL_GPL(gpiod_set_value); |
d2876d08 | 1412 | |
5f424243 | 1413 | /** |
3fff99bc | 1414 | * gpiod_set_raw_array_value() - assign values to an array of GPIOs |
5f424243 RI |
1415 | * @array_size: number of elements in the descriptor / value arrays |
1416 | * @desc_array: array of GPIO descriptors whose values will be assigned | |
1417 | * @value_array: array of values to assign | |
1418 | * | |
1419 | * Set the raw values of the GPIOs, i.e. the values of the physical lines | |
1420 | * without regard for their ACTIVE_LOW status. | |
1421 | * | |
1422 | * This function should be called from contexts where we cannot sleep, and will | |
1423 | * complain if the GPIO chip functions potentially sleep. | |
1424 | */ | |
3fff99bc | 1425 | void gpiod_set_raw_array_value(unsigned int array_size, |
5f424243 RI |
1426 | struct gpio_desc **desc_array, int *value_array) |
1427 | { | |
1428 | if (!desc_array) | |
1429 | return; | |
3fff99bc RI |
1430 | gpiod_set_array_value_priv(true, false, array_size, desc_array, |
1431 | value_array); | |
5f424243 | 1432 | } |
3fff99bc | 1433 | EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value); |
5f424243 RI |
1434 | |
1435 | /** | |
3fff99bc | 1436 | * gpiod_set_array_value() - assign values to an array of GPIOs |
5f424243 RI |
1437 | * @array_size: number of elements in the descriptor / value arrays |
1438 | * @desc_array: array of GPIO descriptors whose values will be assigned | |
1439 | * @value_array: array of values to assign | |
1440 | * | |
1441 | * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status | |
1442 | * into account. | |
1443 | * | |
1444 | * This function should be called from contexts where we cannot sleep, and will | |
1445 | * complain if the GPIO chip functions potentially sleep. | |
1446 | */ | |
3fff99bc RI |
1447 | void gpiod_set_array_value(unsigned int array_size, |
1448 | struct gpio_desc **desc_array, int *value_array) | |
5f424243 RI |
1449 | { |
1450 | if (!desc_array) | |
1451 | return; | |
3fff99bc RI |
1452 | gpiod_set_array_value_priv(false, false, array_size, desc_array, |
1453 | value_array); | |
5f424243 | 1454 | } |
3fff99bc | 1455 | EXPORT_SYMBOL_GPL(gpiod_set_array_value); |
5f424243 | 1456 | |
d2876d08 | 1457 | /** |
79a9becd AC |
1458 | * gpiod_cansleep() - report whether gpio value access may sleep |
1459 | * @desc: gpio to check | |
d2876d08 | 1460 | * |
d2876d08 | 1461 | */ |
79a9becd | 1462 | int gpiod_cansleep(const struct gpio_desc *desc) |
372e722e | 1463 | { |
bcabdef1 AC |
1464 | if (!desc) |
1465 | return 0; | |
372e722e | 1466 | return desc->chip->can_sleep; |
d2876d08 | 1467 | } |
79a9becd | 1468 | EXPORT_SYMBOL_GPL(gpiod_cansleep); |
d2876d08 | 1469 | |
0f6d504e | 1470 | /** |
79a9becd AC |
1471 | * gpiod_to_irq() - return the IRQ corresponding to a GPIO |
1472 | * @desc: gpio whose IRQ will be returned (already requested) | |
0f6d504e | 1473 | * |
79a9becd AC |
1474 | * Return the IRQ corresponding to the passed GPIO, or an error code in case of |
1475 | * error. | |
0f6d504e | 1476 | */ |
79a9becd | 1477 | int gpiod_to_irq(const struct gpio_desc *desc) |
0f6d504e DB |
1478 | { |
1479 | struct gpio_chip *chip; | |
372e722e | 1480 | int offset; |
0f6d504e | 1481 | |
bcabdef1 AC |
1482 | if (!desc) |
1483 | return -EINVAL; | |
372e722e AC |
1484 | chip = desc->chip; |
1485 | offset = gpio_chip_hwgpio(desc); | |
1486 | return chip->to_irq ? chip->to_irq(chip, offset) : -ENXIO; | |
0f6d504e | 1487 | } |
79a9becd | 1488 | EXPORT_SYMBOL_GPL(gpiod_to_irq); |
0f6d504e | 1489 | |
d468bf9e | 1490 | /** |
e3a2e878 | 1491 | * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ |
d74be6df AC |
1492 | * @chip: the chip the GPIO to lock belongs to |
1493 | * @offset: the offset of the GPIO to lock as IRQ | |
d468bf9e LW |
1494 | * |
1495 | * This is used directly by GPIO drivers that want to lock down | |
f438acdf | 1496 | * a certain GPIO line to be used for IRQs. |
d468bf9e | 1497 | */ |
e3a2e878 | 1498 | int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset) |
372e722e | 1499 | { |
d74be6df | 1500 | if (offset >= chip->ngpio) |
d468bf9e LW |
1501 | return -EINVAL; |
1502 | ||
d74be6df AC |
1503 | if (test_bit(FLAG_IS_OUT, &chip->desc[offset].flags)) { |
1504 | chip_err(chip, | |
d468bf9e LW |
1505 | "%s: tried to flag a GPIO set as output for IRQ\n", |
1506 | __func__); | |
1507 | return -EIO; | |
1508 | } | |
1509 | ||
d74be6df | 1510 | set_bit(FLAG_USED_AS_IRQ, &chip->desc[offset].flags); |
d468bf9e | 1511 | return 0; |
372e722e | 1512 | } |
e3a2e878 | 1513 | EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq); |
d2876d08 | 1514 | |
d468bf9e | 1515 | /** |
e3a2e878 | 1516 | * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ |
d74be6df AC |
1517 | * @chip: the chip the GPIO to lock belongs to |
1518 | * @offset: the offset of the GPIO to lock as IRQ | |
d468bf9e LW |
1519 | * |
1520 | * This is used directly by GPIO drivers that want to indicate | |
1521 | * that a certain GPIO is no longer used exclusively for IRQ. | |
d2876d08 | 1522 | */ |
e3a2e878 | 1523 | void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset) |
d468bf9e | 1524 | { |
d74be6df | 1525 | if (offset >= chip->ngpio) |
d468bf9e | 1526 | return; |
d2876d08 | 1527 | |
d74be6df | 1528 | clear_bit(FLAG_USED_AS_IRQ, &chip->desc[offset].flags); |
d468bf9e | 1529 | } |
e3a2e878 | 1530 | EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq); |
d468bf9e | 1531 | |
79a9becd AC |
1532 | /** |
1533 | * gpiod_get_raw_value_cansleep() - return a gpio's raw value | |
1534 | * @desc: gpio whose value will be returned | |
1535 | * | |
1536 | * Return the GPIO's raw value, i.e. the value of the physical line disregarding | |
1537 | * its ACTIVE_LOW status. | |
1538 | * | |
1539 | * This function is to be called from contexts that can sleep. | |
d2876d08 | 1540 | */ |
79a9becd | 1541 | int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc) |
d2876d08 | 1542 | { |
d2876d08 | 1543 | might_sleep_if(extra_checks); |
bcabdef1 AC |
1544 | if (!desc) |
1545 | return 0; | |
79a9becd | 1546 | return _gpiod_get_raw_value(desc); |
d2876d08 | 1547 | } |
79a9becd | 1548 | EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep); |
372e722e | 1549 | |
79a9becd AC |
1550 | /** |
1551 | * gpiod_get_value_cansleep() - return a gpio's value | |
1552 | * @desc: gpio whose value will be returned | |
1553 | * | |
1554 | * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into | |
1555 | * account. | |
1556 | * | |
1557 | * This function is to be called from contexts that can sleep. | |
1558 | */ | |
1559 | int gpiod_get_value_cansleep(const struct gpio_desc *desc) | |
d2876d08 | 1560 | { |
3f397c21 | 1561 | int value; |
d2876d08 DB |
1562 | |
1563 | might_sleep_if(extra_checks); | |
bcabdef1 AC |
1564 | if (!desc) |
1565 | return 0; | |
79a9becd AC |
1566 | |
1567 | value = _gpiod_get_raw_value(desc); | |
1568 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) | |
1569 | value = !value; | |
1570 | ||
3f397c21 | 1571 | return value; |
d2876d08 | 1572 | } |
79a9becd | 1573 | EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep); |
372e722e | 1574 | |
79a9becd AC |
1575 | /** |
1576 | * gpiod_set_raw_value_cansleep() - assign a gpio's raw value | |
1577 | * @desc: gpio whose value will be assigned | |
1578 | * @value: value to assign | |
1579 | * | |
1580 | * Set the raw value of the GPIO, i.e. the value of its physical line without | |
1581 | * regard for its ACTIVE_LOW status. | |
1582 | * | |
1583 | * This function is to be called from contexts that can sleep. | |
1584 | */ | |
1585 | void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value) | |
372e722e | 1586 | { |
d2876d08 | 1587 | might_sleep_if(extra_checks); |
bcabdef1 AC |
1588 | if (!desc) |
1589 | return; | |
79a9becd | 1590 | _gpiod_set_raw_value(desc, value); |
372e722e | 1591 | } |
79a9becd | 1592 | EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep); |
d2876d08 | 1593 | |
79a9becd AC |
1594 | /** |
1595 | * gpiod_set_value_cansleep() - assign a gpio's value | |
1596 | * @desc: gpio whose value will be assigned | |
1597 | * @value: value to assign | |
1598 | * | |
1599 | * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into | |
1600 | * account | |
1601 | * | |
1602 | * This function is to be called from contexts that can sleep. | |
1603 | */ | |
1604 | void gpiod_set_value_cansleep(struct gpio_desc *desc, int value) | |
d2876d08 | 1605 | { |
d2876d08 | 1606 | might_sleep_if(extra_checks); |
bcabdef1 AC |
1607 | if (!desc) |
1608 | return; | |
79a9becd AC |
1609 | |
1610 | if (test_bit(FLAG_ACTIVE_LOW, &desc->flags)) | |
1611 | value = !value; | |
1612 | _gpiod_set_raw_value(desc, value); | |
372e722e | 1613 | } |
79a9becd | 1614 | EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep); |
d2876d08 | 1615 | |
5f424243 | 1616 | /** |
3fff99bc | 1617 | * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs |
5f424243 RI |
1618 | * @array_size: number of elements in the descriptor / value arrays |
1619 | * @desc_array: array of GPIO descriptors whose values will be assigned | |
1620 | * @value_array: array of values to assign | |
1621 | * | |
1622 | * Set the raw values of the GPIOs, i.e. the values of the physical lines | |
1623 | * without regard for their ACTIVE_LOW status. | |
1624 | * | |
1625 | * This function is to be called from contexts that can sleep. | |
1626 | */ | |
3fff99bc RI |
1627 | void gpiod_set_raw_array_value_cansleep(unsigned int array_size, |
1628 | struct gpio_desc **desc_array, | |
1629 | int *value_array) | |
5f424243 RI |
1630 | { |
1631 | might_sleep_if(extra_checks); | |
1632 | if (!desc_array) | |
1633 | return; | |
3fff99bc RI |
1634 | gpiod_set_array_value_priv(true, true, array_size, desc_array, |
1635 | value_array); | |
5f424243 | 1636 | } |
3fff99bc | 1637 | EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep); |
5f424243 RI |
1638 | |
1639 | /** | |
3fff99bc | 1640 | * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs |
5f424243 RI |
1641 | * @array_size: number of elements in the descriptor / value arrays |
1642 | * @desc_array: array of GPIO descriptors whose values will be assigned | |
1643 | * @value_array: array of values to assign | |
1644 | * | |
1645 | * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status | |
1646 | * into account. | |
1647 | * | |
1648 | * This function is to be called from contexts that can sleep. | |
1649 | */ | |
3fff99bc RI |
1650 | void gpiod_set_array_value_cansleep(unsigned int array_size, |
1651 | struct gpio_desc **desc_array, | |
1652 | int *value_array) | |
5f424243 RI |
1653 | { |
1654 | might_sleep_if(extra_checks); | |
1655 | if (!desc_array) | |
1656 | return; | |
3fff99bc RI |
1657 | gpiod_set_array_value_priv(false, true, array_size, desc_array, |
1658 | value_array); | |
5f424243 | 1659 | } |
3fff99bc | 1660 | EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep); |
5f424243 | 1661 | |
bae48da2 | 1662 | /** |
ad824783 AC |
1663 | * gpiod_add_lookup_table() - register GPIO device consumers |
1664 | * @table: table of consumers to register | |
bae48da2 | 1665 | */ |
ad824783 | 1666 | void gpiod_add_lookup_table(struct gpiod_lookup_table *table) |
bae48da2 AC |
1667 | { |
1668 | mutex_lock(&gpio_lookup_lock); | |
1669 | ||
ad824783 | 1670 | list_add_tail(&table->list, &gpio_lookup_list); |
bae48da2 AC |
1671 | |
1672 | mutex_unlock(&gpio_lookup_lock); | |
1673 | } | |
1674 | ||
bae48da2 | 1675 | static struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id, |
53e7cac3 AC |
1676 | unsigned int idx, |
1677 | enum gpio_lookup_flags *flags) | |
bae48da2 AC |
1678 | { |
1679 | char prop_name[32]; /* 32 is max size of property name */ | |
1680 | enum of_gpio_flags of_flags; | |
1681 | struct gpio_desc *desc; | |
dd34c37a | 1682 | unsigned int i; |
bae48da2 | 1683 | |
7f2e553a | 1684 | for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { |
dd34c37a | 1685 | if (con_id) |
9e089246 | 1686 | snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id, |
7f2e553a | 1687 | gpio_suffixes[i]); |
dd34c37a | 1688 | else |
9e089246 | 1689 | snprintf(prop_name, sizeof(prop_name), "%s", |
7f2e553a | 1690 | gpio_suffixes[i]); |
bae48da2 | 1691 | |
dd34c37a TR |
1692 | desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx, |
1693 | &of_flags); | |
06fc3b70 | 1694 | if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER)) |
dd34c37a TR |
1695 | break; |
1696 | } | |
bae48da2 AC |
1697 | |
1698 | if (IS_ERR(desc)) | |
1699 | return desc; | |
1700 | ||
1701 | if (of_flags & OF_GPIO_ACTIVE_LOW) | |
53e7cac3 | 1702 | *flags |= GPIO_ACTIVE_LOW; |
bae48da2 AC |
1703 | |
1704 | return desc; | |
1705 | } | |
d2876d08 | 1706 | |
81f59e9d | 1707 | static struct gpio_desc *acpi_find_gpio(struct device *dev, const char *con_id, |
53e7cac3 AC |
1708 | unsigned int idx, |
1709 | enum gpio_lookup_flags *flags) | |
372e722e | 1710 | { |
0d9a693c | 1711 | struct acpi_device *adev = ACPI_COMPANION(dev); |
e01f440a MW |
1712 | struct acpi_gpio_info info; |
1713 | struct gpio_desc *desc; | |
0d9a693c MW |
1714 | char propname[32]; |
1715 | int i; | |
e01f440a | 1716 | |
0d9a693c | 1717 | /* Try first from _DSD */ |
7f2e553a | 1718 | for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { |
0d9a693c MW |
1719 | if (con_id && strcmp(con_id, "gpios")) { |
1720 | snprintf(propname, sizeof(propname), "%s-%s", | |
7f2e553a | 1721 | con_id, gpio_suffixes[i]); |
0d9a693c MW |
1722 | } else { |
1723 | snprintf(propname, sizeof(propname), "%s", | |
7f2e553a | 1724 | gpio_suffixes[i]); |
0d9a693c MW |
1725 | } |
1726 | ||
1727 | desc = acpi_get_gpiod_by_index(adev, propname, idx, &info); | |
1728 | if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER)) | |
1729 | break; | |
1730 | } | |
1731 | ||
1732 | /* Then from plain _CRS GPIOs */ | |
1733 | if (IS_ERR(desc)) { | |
1734 | desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info); | |
1735 | if (IS_ERR(desc)) | |
1736 | return desc; | |
1737 | } | |
e01f440a | 1738 | |
0d9a693c | 1739 | if (info.active_low) |
53e7cac3 | 1740 | *flags |= GPIO_ACTIVE_LOW; |
e01f440a MW |
1741 | |
1742 | return desc; | |
81f59e9d MW |
1743 | } |
1744 | ||
ad824783 | 1745 | static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev) |
bae48da2 AC |
1746 | { |
1747 | const char *dev_id = dev ? dev_name(dev) : NULL; | |
ad824783 | 1748 | struct gpiod_lookup_table *table; |
bae48da2 AC |
1749 | |
1750 | mutex_lock(&gpio_lookup_lock); | |
1751 | ||
ad824783 AC |
1752 | list_for_each_entry(table, &gpio_lookup_list, list) { |
1753 | if (table->dev_id && dev_id) { | |
1754 | /* | |
1755 | * Valid strings on both ends, must be identical to have | |
1756 | * a match | |
1757 | */ | |
1758 | if (!strcmp(table->dev_id, dev_id)) | |
1759 | goto found; | |
1760 | } else { | |
1761 | /* | |
1762 | * One of the pointers is NULL, so both must be to have | |
1763 | * a match | |
1764 | */ | |
1765 | if (dev_id == table->dev_id) | |
1766 | goto found; | |
1767 | } | |
1768 | } | |
1769 | table = NULL; | |
bae48da2 | 1770 | |
ad824783 AC |
1771 | found: |
1772 | mutex_unlock(&gpio_lookup_lock); | |
1773 | return table; | |
1774 | } | |
bae48da2 | 1775 | |
ad824783 AC |
1776 | static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id, |
1777 | unsigned int idx, | |
1778 | enum gpio_lookup_flags *flags) | |
1779 | { | |
2a3cf6a3 | 1780 | struct gpio_desc *desc = ERR_PTR(-ENOENT); |
ad824783 AC |
1781 | struct gpiod_lookup_table *table; |
1782 | struct gpiod_lookup *p; | |
bae48da2 | 1783 | |
ad824783 AC |
1784 | table = gpiod_find_lookup_table(dev); |
1785 | if (!table) | |
1786 | return desc; | |
bae48da2 | 1787 | |
ad824783 AC |
1788 | for (p = &table->table[0]; p->chip_label; p++) { |
1789 | struct gpio_chip *chip; | |
bae48da2 | 1790 | |
ad824783 | 1791 | /* idx must always match exactly */ |
bae48da2 AC |
1792 | if (p->idx != idx) |
1793 | continue; | |
1794 | ||
ad824783 AC |
1795 | /* If the lookup entry has a con_id, require exact match */ |
1796 | if (p->con_id && (!con_id || strcmp(p->con_id, con_id))) | |
1797 | continue; | |
bae48da2 | 1798 | |
ad824783 | 1799 | chip = find_chip_by_name(p->chip_label); |
bae48da2 | 1800 | |
ad824783 | 1801 | if (!chip) { |
2a3cf6a3 AC |
1802 | dev_err(dev, "cannot find GPIO chip %s\n", |
1803 | p->chip_label); | |
1804 | return ERR_PTR(-ENODEV); | |
ad824783 | 1805 | } |
bae48da2 | 1806 | |
ad824783 | 1807 | if (chip->ngpio <= p->chip_hwnum) { |
2a3cf6a3 AC |
1808 | dev_err(dev, |
1809 | "requested GPIO %d is out of range [0..%d] for chip %s\n", | |
1810 | idx, chip->ngpio, chip->label); | |
1811 | return ERR_PTR(-EINVAL); | |
bae48da2 | 1812 | } |
bae48da2 | 1813 | |
bb1e88cc | 1814 | desc = gpiochip_get_desc(chip, p->chip_hwnum); |
ad824783 | 1815 | *flags = p->flags; |
bae48da2 | 1816 | |
2a3cf6a3 | 1817 | return desc; |
bae48da2 AC |
1818 | } |
1819 | ||
bae48da2 AC |
1820 | return desc; |
1821 | } | |
1822 | ||
66858527 RI |
1823 | static int dt_gpio_count(struct device *dev, const char *con_id) |
1824 | { | |
1825 | int ret; | |
1826 | char propname[32]; | |
1827 | unsigned int i; | |
1828 | ||
1829 | for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { | |
1830 | if (con_id) | |
1831 | snprintf(propname, sizeof(propname), "%s-%s", | |
1832 | con_id, gpio_suffixes[i]); | |
1833 | else | |
1834 | snprintf(propname, sizeof(propname), "%s", | |
1835 | gpio_suffixes[i]); | |
1836 | ||
1837 | ret = of_gpio_named_count(dev->of_node, propname); | |
1838 | if (ret >= 0) | |
1839 | break; | |
1840 | } | |
1841 | return ret; | |
1842 | } | |
1843 | ||
1844 | static int platform_gpio_count(struct device *dev, const char *con_id) | |
1845 | { | |
1846 | struct gpiod_lookup_table *table; | |
1847 | struct gpiod_lookup *p; | |
1848 | unsigned int count = 0; | |
1849 | ||
1850 | table = gpiod_find_lookup_table(dev); | |
1851 | if (!table) | |
1852 | return -ENOENT; | |
1853 | ||
1854 | for (p = &table->table[0]; p->chip_label; p++) { | |
1855 | if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) || | |
1856 | (!con_id && !p->con_id)) | |
1857 | count++; | |
1858 | } | |
1859 | if (!count) | |
1860 | return -ENOENT; | |
1861 | ||
1862 | return count; | |
1863 | } | |
1864 | ||
1865 | /** | |
1866 | * gpiod_count - return the number of GPIOs associated with a device / function | |
1867 | * or -ENOENT if no GPIO has been assigned to the requested function | |
1868 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
1869 | * @con_id: function within the GPIO consumer | |
1870 | */ | |
1871 | int gpiod_count(struct device *dev, const char *con_id) | |
1872 | { | |
1873 | int count = -ENOENT; | |
1874 | ||
1875 | if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node) | |
1876 | count = dt_gpio_count(dev, con_id); | |
1877 | else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev)) | |
1878 | count = acpi_gpio_count(dev, con_id); | |
1879 | ||
1880 | if (count < 0) | |
1881 | count = platform_gpio_count(dev, con_id); | |
1882 | ||
1883 | return count; | |
1884 | } | |
1885 | EXPORT_SYMBOL_GPL(gpiod_count); | |
1886 | ||
bae48da2 | 1887 | /** |
0879162f | 1888 | * gpiod_get - obtain a GPIO for a given GPIO function |
ad824783 | 1889 | * @dev: GPIO consumer, can be NULL for system-global GPIOs |
bae48da2 | 1890 | * @con_id: function within the GPIO consumer |
39b2bbe3 | 1891 | * @flags: optional GPIO initialization flags |
bae48da2 AC |
1892 | * |
1893 | * Return the GPIO descriptor corresponding to the function con_id of device | |
2a3cf6a3 | 1894 | * dev, -ENOENT if no GPIO has been assigned to the requested function, or |
20a8a968 | 1895 | * another IS_ERR() code if an error occurred while trying to acquire the GPIO. |
bae48da2 | 1896 | */ |
39b2bbe3 AC |
1897 | struct gpio_desc *__must_check __gpiod_get(struct device *dev, const char *con_id, |
1898 | enum gpiod_flags flags) | |
bae48da2 | 1899 | { |
39b2bbe3 | 1900 | return gpiod_get_index(dev, con_id, 0, flags); |
bae48da2 | 1901 | } |
39b2bbe3 | 1902 | EXPORT_SYMBOL_GPL(__gpiod_get); |
bae48da2 | 1903 | |
29a1f233 TR |
1904 | /** |
1905 | * gpiod_get_optional - obtain an optional GPIO for a given GPIO function | |
1906 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
1907 | * @con_id: function within the GPIO consumer | |
39b2bbe3 | 1908 | * @flags: optional GPIO initialization flags |
29a1f233 TR |
1909 | * |
1910 | * This is equivalent to gpiod_get(), except that when no GPIO was assigned to | |
1911 | * the requested function it will return NULL. This is convenient for drivers | |
1912 | * that need to handle optional GPIOs. | |
1913 | */ | |
39b2bbe3 AC |
1914 | struct gpio_desc *__must_check __gpiod_get_optional(struct device *dev, |
1915 | const char *con_id, | |
1916 | enum gpiod_flags flags) | |
29a1f233 | 1917 | { |
39b2bbe3 | 1918 | return gpiod_get_index_optional(dev, con_id, 0, flags); |
29a1f233 | 1919 | } |
39b2bbe3 | 1920 | EXPORT_SYMBOL_GPL(__gpiod_get_optional); |
29a1f233 | 1921 | |
f625d460 BP |
1922 | |
1923 | /** | |
1924 | * gpiod_configure_flags - helper function to configure a given GPIO | |
1925 | * @desc: gpio whose value will be assigned | |
1926 | * @con_id: function within the GPIO consumer | |
1927 | * @lflags: gpio_lookup_flags - returned from of_find_gpio() or | |
1928 | * of_get_gpio_hog() | |
1929 | * @dflags: gpiod_flags - optional GPIO initialization flags | |
1930 | * | |
1931 | * Return 0 on success, -ENOENT if no GPIO has been assigned to the | |
1932 | * requested function and/or index, or another IS_ERR() code if an error | |
1933 | * occurred while trying to acquire the GPIO. | |
1934 | */ | |
1935 | static int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id, | |
1936 | unsigned long lflags, enum gpiod_flags dflags) | |
1937 | { | |
1938 | int status; | |
1939 | ||
1940 | if (lflags & GPIO_ACTIVE_LOW) | |
1941 | set_bit(FLAG_ACTIVE_LOW, &desc->flags); | |
1942 | if (lflags & GPIO_OPEN_DRAIN) | |
1943 | set_bit(FLAG_OPEN_DRAIN, &desc->flags); | |
1944 | if (lflags & GPIO_OPEN_SOURCE) | |
1945 | set_bit(FLAG_OPEN_SOURCE, &desc->flags); | |
1946 | ||
1947 | /* No particular flag request, return here... */ | |
1948 | if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) { | |
1949 | pr_debug("no flags found for %s\n", con_id); | |
1950 | return 0; | |
1951 | } | |
1952 | ||
1953 | /* Process flags */ | |
1954 | if (dflags & GPIOD_FLAGS_BIT_DIR_OUT) | |
1955 | status = gpiod_direction_output(desc, | |
1956 | dflags & GPIOD_FLAGS_BIT_DIR_VAL); | |
1957 | else | |
1958 | status = gpiod_direction_input(desc); | |
1959 | ||
1960 | return status; | |
1961 | } | |
1962 | ||
bae48da2 AC |
1963 | /** |
1964 | * gpiod_get_index - obtain a GPIO from a multi-index GPIO function | |
fdd6a5fe | 1965 | * @dev: GPIO consumer, can be NULL for system-global GPIOs |
bae48da2 AC |
1966 | * @con_id: function within the GPIO consumer |
1967 | * @idx: index of the GPIO to obtain in the consumer | |
39b2bbe3 | 1968 | * @flags: optional GPIO initialization flags |
bae48da2 AC |
1969 | * |
1970 | * This variant of gpiod_get() allows to access GPIOs other than the first | |
1971 | * defined one for functions that define several GPIOs. | |
1972 | * | |
2a3cf6a3 AC |
1973 | * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the |
1974 | * requested function and/or index, or another IS_ERR() code if an error | |
20a8a968 | 1975 | * occurred while trying to acquire the GPIO. |
bae48da2 | 1976 | */ |
39b2bbe3 | 1977 | struct gpio_desc *__must_check __gpiod_get_index(struct device *dev, |
bae48da2 | 1978 | const char *con_id, |
39b2bbe3 AC |
1979 | unsigned int idx, |
1980 | enum gpiod_flags flags) | |
bae48da2 | 1981 | { |
35c5d7fd | 1982 | struct gpio_desc *desc = NULL; |
bae48da2 | 1983 | int status; |
39b2bbe3 | 1984 | enum gpio_lookup_flags lookupflags = 0; |
bae48da2 AC |
1985 | |
1986 | dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id); | |
1987 | ||
4d8440b9 RW |
1988 | if (dev) { |
1989 | /* Using device tree? */ | |
1990 | if (IS_ENABLED(CONFIG_OF) && dev->of_node) { | |
1991 | dev_dbg(dev, "using device tree for GPIO lookup\n"); | |
1992 | desc = of_find_gpio(dev, con_id, idx, &lookupflags); | |
1993 | } else if (ACPI_COMPANION(dev)) { | |
1994 | dev_dbg(dev, "using ACPI for GPIO lookup\n"); | |
1995 | desc = acpi_find_gpio(dev, con_id, idx, &lookupflags); | |
1996 | } | |
35c5d7fd AC |
1997 | } |
1998 | ||
1999 | /* | |
2000 | * Either we are not using DT or ACPI, or their lookup did not return | |
2001 | * a result. In that case, use platform lookup as a fallback. | |
2002 | */ | |
2a3cf6a3 | 2003 | if (!desc || desc == ERR_PTR(-ENOENT)) { |
43a8785a | 2004 | dev_dbg(dev, "using lookup tables for GPIO lookup\n"); |
39b2bbe3 | 2005 | desc = gpiod_find(dev, con_id, idx, &lookupflags); |
bae48da2 AC |
2006 | } |
2007 | ||
2008 | if (IS_ERR(desc)) { | |
351cfe0f | 2009 | dev_dbg(dev, "lookup for GPIO %s failed\n", con_id); |
bae48da2 AC |
2010 | return desc; |
2011 | } | |
2012 | ||
2013 | status = gpiod_request(desc, con_id); | |
bae48da2 AC |
2014 | if (status < 0) |
2015 | return ERR_PTR(status); | |
2016 | ||
f625d460 | 2017 | status = gpiod_configure_flags(desc, con_id, lookupflags, flags); |
39b2bbe3 AC |
2018 | if (status < 0) { |
2019 | dev_dbg(dev, "setup of GPIO %s failed\n", con_id); | |
2020 | gpiod_put(desc); | |
2021 | return ERR_PTR(status); | |
2022 | } | |
2023 | ||
bae48da2 AC |
2024 | return desc; |
2025 | } | |
39b2bbe3 | 2026 | EXPORT_SYMBOL_GPL(__gpiod_get_index); |
bae48da2 | 2027 | |
40b73183 MW |
2028 | /** |
2029 | * fwnode_get_named_gpiod - obtain a GPIO from firmware node | |
2030 | * @fwnode: handle of the firmware node | |
2031 | * @propname: name of the firmware property representing the GPIO | |
2032 | * | |
2033 | * This function can be used for drivers that get their configuration | |
2034 | * from firmware. | |
2035 | * | |
2036 | * Function properly finds the corresponding GPIO using whatever is the | |
2037 | * underlying firmware interface and then makes sure that the GPIO | |
2038 | * descriptor is requested before it is returned to the caller. | |
2039 | * | |
2040 | * In case of error an ERR_PTR() is returned. | |
2041 | */ | |
2042 | struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode, | |
2043 | const char *propname) | |
2044 | { | |
2045 | struct gpio_desc *desc = ERR_PTR(-ENODEV); | |
2046 | bool active_low = false; | |
2047 | int ret; | |
2048 | ||
2049 | if (!fwnode) | |
2050 | return ERR_PTR(-EINVAL); | |
2051 | ||
2052 | if (is_of_node(fwnode)) { | |
2053 | enum of_gpio_flags flags; | |
2054 | ||
c181fb3e | 2055 | desc = of_get_named_gpiod_flags(to_of_node(fwnode), propname, 0, |
40b73183 MW |
2056 | &flags); |
2057 | if (!IS_ERR(desc)) | |
2058 | active_low = flags & OF_GPIO_ACTIVE_LOW; | |
2059 | } else if (is_acpi_node(fwnode)) { | |
2060 | struct acpi_gpio_info info; | |
2061 | ||
c181fb3e | 2062 | desc = acpi_get_gpiod_by_index(to_acpi_node(fwnode), propname, 0, |
40b73183 MW |
2063 | &info); |
2064 | if (!IS_ERR(desc)) | |
2065 | active_low = info.active_low; | |
2066 | } | |
2067 | ||
2068 | if (IS_ERR(desc)) | |
2069 | return desc; | |
2070 | ||
2071 | ret = gpiod_request(desc, NULL); | |
2072 | if (ret) | |
2073 | return ERR_PTR(ret); | |
2074 | ||
2075 | /* Only value flag can be set from both DT and ACPI is active_low */ | |
2076 | if (active_low) | |
2077 | set_bit(FLAG_ACTIVE_LOW, &desc->flags); | |
2078 | ||
2079 | return desc; | |
2080 | } | |
2081 | EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod); | |
2082 | ||
29a1f233 TR |
2083 | /** |
2084 | * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO | |
2085 | * function | |
2086 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
2087 | * @con_id: function within the GPIO consumer | |
2088 | * @index: index of the GPIO to obtain in the consumer | |
39b2bbe3 | 2089 | * @flags: optional GPIO initialization flags |
29a1f233 TR |
2090 | * |
2091 | * This is equivalent to gpiod_get_index(), except that when no GPIO with the | |
2092 | * specified index was assigned to the requested function it will return NULL. | |
2093 | * This is convenient for drivers that need to handle optional GPIOs. | |
2094 | */ | |
39b2bbe3 | 2095 | struct gpio_desc *__must_check __gpiod_get_index_optional(struct device *dev, |
29a1f233 | 2096 | const char *con_id, |
39b2bbe3 AC |
2097 | unsigned int index, |
2098 | enum gpiod_flags flags) | |
29a1f233 TR |
2099 | { |
2100 | struct gpio_desc *desc; | |
2101 | ||
39b2bbe3 | 2102 | desc = gpiod_get_index(dev, con_id, index, flags); |
29a1f233 TR |
2103 | if (IS_ERR(desc)) { |
2104 | if (PTR_ERR(desc) == -ENOENT) | |
2105 | return NULL; | |
2106 | } | |
2107 | ||
2108 | return desc; | |
2109 | } | |
39b2bbe3 | 2110 | EXPORT_SYMBOL_GPL(__gpiod_get_index_optional); |
29a1f233 | 2111 | |
f625d460 BP |
2112 | /** |
2113 | * gpiod_hog - Hog the specified GPIO desc given the provided flags | |
2114 | * @desc: gpio whose value will be assigned | |
2115 | * @name: gpio line name | |
2116 | * @lflags: gpio_lookup_flags - returned from of_find_gpio() or | |
2117 | * of_get_gpio_hog() | |
2118 | * @dflags: gpiod_flags - optional GPIO initialization flags | |
2119 | */ | |
2120 | int gpiod_hog(struct gpio_desc *desc, const char *name, | |
2121 | unsigned long lflags, enum gpiod_flags dflags) | |
2122 | { | |
2123 | struct gpio_chip *chip; | |
2124 | struct gpio_desc *local_desc; | |
2125 | int hwnum; | |
2126 | int status; | |
2127 | ||
2128 | chip = gpiod_to_chip(desc); | |
2129 | hwnum = gpio_chip_hwgpio(desc); | |
2130 | ||
2131 | local_desc = gpiochip_request_own_desc(chip, hwnum, name); | |
2132 | if (IS_ERR(local_desc)) { | |
a713890d LW |
2133 | pr_err("requesting hog GPIO %s (chip %s, offset %d) failed\n", |
2134 | name, chip->label, hwnum); | |
f625d460 BP |
2135 | return PTR_ERR(local_desc); |
2136 | } | |
2137 | ||
2138 | status = gpiod_configure_flags(desc, name, lflags, dflags); | |
2139 | if (status < 0) { | |
a713890d LW |
2140 | pr_err("setup of hog GPIO %s (chip %s, offset %d) failed\n", |
2141 | name, chip->label, hwnum); | |
f625d460 BP |
2142 | gpiochip_free_own_desc(desc); |
2143 | return status; | |
2144 | } | |
2145 | ||
2146 | /* Mark GPIO as hogged so it can be identified and removed later */ | |
2147 | set_bit(FLAG_IS_HOGGED, &desc->flags); | |
2148 | ||
2149 | pr_info("GPIO line %d (%s) hogged as %s%s\n", | |
2150 | desc_to_gpio(desc), name, | |
2151 | (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input", | |
2152 | (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? | |
2153 | (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":""); | |
2154 | ||
2155 | return 0; | |
2156 | } | |
2157 | ||
2158 | /** | |
2159 | * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog | |
2160 | * @chip: gpio chip to act on | |
2161 | * | |
2162 | * This is only used by of_gpiochip_remove to free hogged gpios | |
2163 | */ | |
2164 | static void gpiochip_free_hogs(struct gpio_chip *chip) | |
2165 | { | |
2166 | int id; | |
2167 | ||
2168 | for (id = 0; id < chip->ngpio; id++) { | |
2169 | if (test_bit(FLAG_IS_HOGGED, &chip->desc[id].flags)) | |
2170 | gpiochip_free_own_desc(&chip->desc[id]); | |
2171 | } | |
2172 | } | |
2173 | ||
66858527 RI |
2174 | /** |
2175 | * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function | |
2176 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
2177 | * @con_id: function within the GPIO consumer | |
2178 | * @flags: optional GPIO initialization flags | |
2179 | * | |
2180 | * This function acquires all the GPIOs defined under a given function. | |
2181 | * | |
2182 | * Return a struct gpio_descs containing an array of descriptors, -ENOENT if | |
2183 | * no GPIO has been assigned to the requested function, or another IS_ERR() | |
2184 | * code if an error occurred while trying to acquire the GPIOs. | |
2185 | */ | |
2186 | struct gpio_descs *__must_check gpiod_get_array(struct device *dev, | |
2187 | const char *con_id, | |
2188 | enum gpiod_flags flags) | |
2189 | { | |
2190 | struct gpio_desc *desc; | |
2191 | struct gpio_descs *descs; | |
2192 | int count; | |
2193 | ||
2194 | count = gpiod_count(dev, con_id); | |
2195 | if (count < 0) | |
2196 | return ERR_PTR(count); | |
2197 | ||
2198 | descs = kzalloc(sizeof(*descs) + sizeof(descs->desc[0]) * count, | |
2199 | GFP_KERNEL); | |
2200 | if (!descs) | |
2201 | return ERR_PTR(-ENOMEM); | |
2202 | ||
2203 | for (descs->ndescs = 0; descs->ndescs < count; ) { | |
2204 | desc = gpiod_get_index(dev, con_id, descs->ndescs, flags); | |
2205 | if (IS_ERR(desc)) { | |
2206 | gpiod_put_array(descs); | |
2207 | return ERR_CAST(desc); | |
2208 | } | |
2209 | descs->desc[descs->ndescs] = desc; | |
2210 | descs->ndescs++; | |
2211 | } | |
2212 | return descs; | |
2213 | } | |
2214 | EXPORT_SYMBOL_GPL(gpiod_get_array); | |
2215 | ||
2216 | /** | |
2217 | * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO | |
2218 | * function | |
2219 | * @dev: GPIO consumer, can be NULL for system-global GPIOs | |
2220 | * @con_id: function within the GPIO consumer | |
2221 | * @flags: optional GPIO initialization flags | |
2222 | * | |
2223 | * This is equivalent to gpiod_get_array(), except that when no GPIO was | |
2224 | * assigned to the requested function it will return NULL. | |
2225 | */ | |
2226 | struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev, | |
2227 | const char *con_id, | |
2228 | enum gpiod_flags flags) | |
2229 | { | |
2230 | struct gpio_descs *descs; | |
2231 | ||
2232 | descs = gpiod_get_array(dev, con_id, flags); | |
2233 | if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT)) | |
2234 | return NULL; | |
2235 | ||
2236 | return descs; | |
2237 | } | |
2238 | EXPORT_SYMBOL_GPL(gpiod_get_array_optional); | |
2239 | ||
bae48da2 AC |
2240 | /** |
2241 | * gpiod_put - dispose of a GPIO descriptor | |
2242 | * @desc: GPIO descriptor to dispose of | |
2243 | * | |
2244 | * No descriptor can be used after gpiod_put() has been called on it. | |
2245 | */ | |
2246 | void gpiod_put(struct gpio_desc *desc) | |
2247 | { | |
2248 | gpiod_free(desc); | |
372e722e | 2249 | } |
bae48da2 | 2250 | EXPORT_SYMBOL_GPL(gpiod_put); |
d2876d08 | 2251 | |
66858527 RI |
2252 | /** |
2253 | * gpiod_put_array - dispose of multiple GPIO descriptors | |
2254 | * @descs: struct gpio_descs containing an array of descriptors | |
2255 | */ | |
2256 | void gpiod_put_array(struct gpio_descs *descs) | |
2257 | { | |
2258 | unsigned int i; | |
2259 | ||
2260 | for (i = 0; i < descs->ndescs; i++) | |
2261 | gpiod_put(descs->desc[i]); | |
2262 | ||
2263 | kfree(descs); | |
2264 | } | |
2265 | EXPORT_SYMBOL_GPL(gpiod_put_array); | |
2266 | ||
d2876d08 DB |
2267 | #ifdef CONFIG_DEBUG_FS |
2268 | ||
d2876d08 DB |
2269 | static void gpiolib_dbg_show(struct seq_file *s, struct gpio_chip *chip) |
2270 | { | |
2271 | unsigned i; | |
2272 | unsigned gpio = chip->base; | |
6c0b4e6c | 2273 | struct gpio_desc *gdesc = &chip->desc[0]; |
d2876d08 | 2274 | int is_out; |
d468bf9e | 2275 | int is_irq; |
d2876d08 DB |
2276 | |
2277 | for (i = 0; i < chip->ngpio; i++, gpio++, gdesc++) { | |
2278 | if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) | |
2279 | continue; | |
2280 | ||
372e722e | 2281 | gpiod_get_direction(gdesc); |
d2876d08 | 2282 | is_out = test_bit(FLAG_IS_OUT, &gdesc->flags); |
d468bf9e LW |
2283 | is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags); |
2284 | seq_printf(s, " gpio-%-3d (%-20.20s) %s %s %s", | |
d2876d08 DB |
2285 | gpio, gdesc->label, |
2286 | is_out ? "out" : "in ", | |
2287 | chip->get | |
2288 | ? (chip->get(chip, i) ? "hi" : "lo") | |
d468bf9e LW |
2289 | : "? ", |
2290 | is_irq ? "IRQ" : " "); | |
d2876d08 DB |
2291 | seq_printf(s, "\n"); |
2292 | } | |
2293 | } | |
2294 | ||
f9c4a31f | 2295 | static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos) |
d2876d08 | 2296 | { |
362432ae | 2297 | unsigned long flags; |
f9c4a31f | 2298 | struct gpio_chip *chip = NULL; |
cb1650d4 | 2299 | loff_t index = *pos; |
d2876d08 | 2300 | |
f9c4a31f | 2301 | s->private = ""; |
d2876d08 | 2302 | |
362432ae | 2303 | spin_lock_irqsave(&gpio_lock, flags); |
cb1650d4 | 2304 | list_for_each_entry(chip, &gpio_chips, list) |
362432ae GL |
2305 | if (index-- == 0) { |
2306 | spin_unlock_irqrestore(&gpio_lock, flags); | |
cb1650d4 | 2307 | return chip; |
f9c4a31f | 2308 | } |
362432ae | 2309 | spin_unlock_irqrestore(&gpio_lock, flags); |
f9c4a31f | 2310 | |
cb1650d4 | 2311 | return NULL; |
f9c4a31f TR |
2312 | } |
2313 | ||
2314 | static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos) | |
2315 | { | |
362432ae | 2316 | unsigned long flags; |
f9c4a31f | 2317 | struct gpio_chip *chip = v; |
f9c4a31f TR |
2318 | void *ret = NULL; |
2319 | ||
362432ae | 2320 | spin_lock_irqsave(&gpio_lock, flags); |
cb1650d4 AC |
2321 | if (list_is_last(&chip->list, &gpio_chips)) |
2322 | ret = NULL; | |
2323 | else | |
2324 | ret = list_entry(chip->list.next, struct gpio_chip, list); | |
362432ae | 2325 | spin_unlock_irqrestore(&gpio_lock, flags); |
f9c4a31f TR |
2326 | |
2327 | s->private = "\n"; | |
2328 | ++*pos; | |
2329 | ||
2330 | return ret; | |
2331 | } | |
2332 | ||
2333 | static void gpiolib_seq_stop(struct seq_file *s, void *v) | |
2334 | { | |
2335 | } | |
2336 | ||
2337 | static int gpiolib_seq_show(struct seq_file *s, void *v) | |
2338 | { | |
2339 | struct gpio_chip *chip = v; | |
2340 | struct device *dev; | |
2341 | ||
2342 | seq_printf(s, "%sGPIOs %d-%d", (char *)s->private, | |
2343 | chip->base, chip->base + chip->ngpio - 1); | |
2344 | dev = chip->dev; | |
2345 | if (dev) | |
2346 | seq_printf(s, ", %s/%s", dev->bus ? dev->bus->name : "no-bus", | |
2347 | dev_name(dev)); | |
2348 | if (chip->label) | |
2349 | seq_printf(s, ", %s", chip->label); | |
2350 | if (chip->can_sleep) | |
2351 | seq_printf(s, ", can sleep"); | |
2352 | seq_printf(s, ":\n"); | |
2353 | ||
2354 | if (chip->dbg_show) | |
2355 | chip->dbg_show(s, chip); | |
2356 | else | |
2357 | gpiolib_dbg_show(s, chip); | |
2358 | ||
d2876d08 DB |
2359 | return 0; |
2360 | } | |
2361 | ||
f9c4a31f TR |
2362 | static const struct seq_operations gpiolib_seq_ops = { |
2363 | .start = gpiolib_seq_start, | |
2364 | .next = gpiolib_seq_next, | |
2365 | .stop = gpiolib_seq_stop, | |
2366 | .show = gpiolib_seq_show, | |
2367 | }; | |
2368 | ||
d2876d08 DB |
2369 | static int gpiolib_open(struct inode *inode, struct file *file) |
2370 | { | |
f9c4a31f | 2371 | return seq_open(file, &gpiolib_seq_ops); |
d2876d08 DB |
2372 | } |
2373 | ||
828c0950 | 2374 | static const struct file_operations gpiolib_operations = { |
f9c4a31f | 2375 | .owner = THIS_MODULE, |
d2876d08 DB |
2376 | .open = gpiolib_open, |
2377 | .read = seq_read, | |
2378 | .llseek = seq_lseek, | |
f9c4a31f | 2379 | .release = seq_release, |
d2876d08 DB |
2380 | }; |
2381 | ||
2382 | static int __init gpiolib_debugfs_init(void) | |
2383 | { | |
2384 | /* /sys/kernel/debug/gpio */ | |
2385 | (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO, | |
2386 | NULL, NULL, &gpiolib_operations); | |
2387 | return 0; | |
2388 | } | |
2389 | subsys_initcall(gpiolib_debugfs_init); | |
2390 | ||
2391 | #endif /* DEBUG_FS */ |