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