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