1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/bitmap.h>
4 #include <linux/kernel.h>
5 #include <linux/module.h>
6 #include <linux/interrupt.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>
22 #include <linux/compat.h>
23 #include <linux/file.h>
24 #include <uapi/linux/gpio.h>
27 #include "gpiolib-of.h"
28 #include "gpiolib-acpi.h"
29 #include "gpiolib-cdev.h"
30 #include "gpiolib-sysfs.h"
32 #define CREATE_TRACE_POINTS
33 #include <trace/events/gpio.h>
35 /* Implementation infrastructure for GPIO interfaces.
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.
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.
47 * Otherwise, minimize overhead in what may be bitbanging codepaths.
50 #define extra_checks 1
52 #define extra_checks 0
55 /* Device and char device-related information */
56 static DEFINE_IDA(gpio_ida
);
57 static dev_t gpio_devt
;
58 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
59 static int gpio_bus_match(struct device
*dev
, struct device_driver
*drv
);
60 static struct bus_type gpio_bus_type
= {
62 .match
= gpio_bus_match
,
66 * Number of GPIOs to use for the fast path in set array
68 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
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.
74 DEFINE_SPINLOCK(gpio_lock
);
76 static DEFINE_MUTEX(gpio_lookup_lock
);
77 static LIST_HEAD(gpio_lookup_list
);
78 LIST_HEAD(gpio_devices
);
80 static DEFINE_MUTEX(gpio_machine_hogs_mutex
);
81 static LIST_HEAD(gpio_machine_hogs
);
83 static void gpiochip_free_hogs(struct gpio_chip
*gc
);
84 static int gpiochip_add_irqchip(struct gpio_chip
*gc
,
85 struct lock_class_key
*lock_key
,
86 struct lock_class_key
*request_key
);
87 static void gpiochip_irqchip_remove(struct gpio_chip
*gc
);
88 static int gpiochip_irqchip_init_hw(struct gpio_chip
*gc
);
89 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip
*gc
);
90 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip
*gc
);
92 static bool gpiolib_initialized
;
94 static inline void desc_set_label(struct gpio_desc
*d
, const char *label
)
100 * gpio_to_desc - Convert a GPIO number to its descriptor
101 * @gpio: global GPIO number
104 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
105 * with the given number exists in the system.
107 struct gpio_desc
*gpio_to_desc(unsigned gpio
)
109 struct gpio_device
*gdev
;
112 spin_lock_irqsave(&gpio_lock
, flags
);
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
];
122 spin_unlock_irqrestore(&gpio_lock
, flags
);
124 if (!gpio_is_valid(gpio
))
125 pr_warn("invalid GPIO %d\n", gpio
);
129 EXPORT_SYMBOL_GPL(gpio_to_desc
);
132 * gpiochip_get_desc - get the GPIO descriptor corresponding to the given
133 * hardware number for this chip
135 * @hwnum: hardware number of the GPIO for this chip
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.
141 struct gpio_desc
*gpiochip_get_desc(struct gpio_chip
*gc
,
144 struct gpio_device
*gdev
= gc
->gpiodev
;
146 if (hwnum
>= gdev
->ngpio
)
147 return ERR_PTR(-EINVAL
);
149 return &gdev
->descs
[hwnum
];
151 EXPORT_SYMBOL_GPL(gpiochip_get_desc
);
154 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
155 * @desc: GPIO descriptor
157 * This should disappear in the future but is needed since we still
158 * use GPIO numbers for error messages and sysfs nodes.
161 * The global GPIO number for the GPIO specified by its descriptor.
163 int desc_to_gpio(const struct gpio_desc
*desc
)
165 return desc
->gdev
->base
+ (desc
- &desc
->gdev
->descs
[0]);
167 EXPORT_SYMBOL_GPL(desc_to_gpio
);
171 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
172 * @desc: descriptor to return the chip of
174 struct gpio_chip
*gpiod_to_chip(const struct gpio_desc
*desc
)
176 if (!desc
|| !desc
->gdev
)
178 return desc
->gdev
->chip
;
180 EXPORT_SYMBOL_GPL(gpiod_to_chip
);
182 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
183 static int gpiochip_find_base(int ngpio
)
185 struct gpio_device
*gdev
;
186 int base
= ARCH_NR_GPIOS
- ngpio
;
188 list_for_each_entry_reverse(gdev
, &gpio_devices
, list
) {
189 /* found a free space? */
190 if (gdev
->base
+ gdev
->ngpio
<= base
)
193 /* nope, check the space right before the chip */
194 base
= gdev
->base
- ngpio
;
197 if (gpio_is_valid(base
)) {
198 pr_debug("%s: found new base at %d\n", __func__
, base
);
201 pr_err("%s: cannot find free range\n", __func__
);
207 * gpiod_get_direction - return the current direction of a GPIO
208 * @desc: GPIO to get the direction of
210 * Returns 0 for output, 1 for input, or an error code in case of error.
212 * This function may sleep if gpiod_cansleep() is true.
214 int gpiod_get_direction(struct gpio_desc
*desc
)
216 struct gpio_chip
*gc
;
220 gc
= gpiod_to_chip(desc
);
221 offset
= gpio_chip_hwgpio(desc
);
224 * Open drain emulation using input mode may incorrectly report
225 * input here, fix that up.
227 if (test_bit(FLAG_OPEN_DRAIN
, &desc
->flags
) &&
228 test_bit(FLAG_IS_OUT
, &desc
->flags
))
231 if (!gc
->get_direction
)
234 ret
= gc
->get_direction(gc
, offset
);
238 /* GPIOF_DIR_IN or other positive, otherwise GPIOF_DIR_OUT */
242 assign_bit(FLAG_IS_OUT
, &desc
->flags
, !ret
);
246 EXPORT_SYMBOL_GPL(gpiod_get_direction
);
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.
252 * Return -EBUSY if the new chip overlaps with some other chip's integer
255 static int gpiodev_add_to_list(struct gpio_device
*gdev
)
257 struct gpio_device
*prev
, *next
;
259 if (list_empty(&gpio_devices
)) {
260 /* initial entry in list */
261 list_add_tail(&gdev
->list
, &gpio_devices
);
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
);
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
);
279 list_for_each_entry_safe(prev
, next
, &gpio_devices
, list
) {
280 /* at the end of the list */
281 if (&next
->list
== &gpio_devices
)
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
);
292 dev_err(&gdev
->dev
, "GPIO integer space overlap, cannot add chip\n");
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.
302 static struct gpio_desc
*gpio_name_to_desc(const char * const name
)
304 struct gpio_device
*gdev
;
310 spin_lock_irqsave(&gpio_lock
, flags
);
312 list_for_each_entry(gdev
, &gpio_devices
, list
) {
315 for (i
= 0; i
!= gdev
->ngpio
; ++i
) {
316 struct gpio_desc
*desc
= &gdev
->descs
[i
];
321 if (!strcmp(desc
->name
, name
)) {
322 spin_unlock_irqrestore(&gpio_lock
, flags
);
328 spin_unlock_irqrestore(&gpio_lock
, flags
);
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.
338 * 1. Non-unique names are still accepted,
339 * 2. Name collisions within the same GPIO chip are not reported.
341 static int gpiochip_set_desc_names(struct gpio_chip
*gc
)
343 struct gpio_device
*gdev
= gc
->gpiodev
;
346 /* First check all names if they are unique */
347 for (i
= 0; i
!= gc
->ngpio
; ++i
) {
348 struct gpio_desc
*gpio
;
350 gpio
= gpio_name_to_desc(gc
->names
[i
]);
353 "Detected name collision for GPIO name '%s'\n",
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
];
365 * devprop_gpiochip_set_names - Set GPIO line names using device properties
366 * @chip: GPIO chip whose lines should be named, if possible
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
373 static int devprop_gpiochip_set_names(struct gpio_chip
*chip
)
375 struct gpio_device
*gdev
= chip
->gpiodev
;
376 struct fwnode_handle
*fwnode
= dev_fwnode(&gdev
->dev
);
381 count
= fwnode_property_string_array_count(fwnode
, "gpio-line-names");
386 * When offset is set in the driver side we assume the driver internally
387 * is using more than one gpiochip per the same device. We have to stop
388 * setting friendly names if the specified ones with 'gpio-line-names'
389 * are less than the offset in the device itself. This means all the
390 * lines are not present for every single pin within all the internal
393 if (count
<= chip
->offset
) {
394 dev_warn(&gdev
->dev
, "gpio-line-names too short (length %d), cannot map names for the gpiochip at offset %u\n",
395 count
, chip
->offset
);
399 names
= kcalloc(count
, sizeof(*names
), GFP_KERNEL
);
403 ret
= fwnode_property_read_string_array(fwnode
, "gpio-line-names",
406 dev_warn(&gdev
->dev
, "failed to read GPIO line names\n");
412 * When more that one gpiochip per device is used, 'count' can
413 * contain at most number gpiochips x chip->ngpio. We have to
414 * correctly distribute all defined lines taking into account
415 * chip->offset as starting point from where we will assign
416 * the names to pins from the 'names' array. Since property
417 * 'gpio-line-names' cannot contains gaps, we have to be sure
418 * we only assign those pins that really exists since chip->ngpio
419 * can be different of the chip->offset.
421 count
= (count
> chip
->offset
) ? count
- chip
->offset
: count
;
422 if (count
> chip
->ngpio
)
425 for (i
= 0; i
< count
; i
++)
426 gdev
->descs
[i
].name
= names
[chip
->offset
+ i
];
433 static unsigned long *gpiochip_allocate_mask(struct gpio_chip
*gc
)
437 p
= bitmap_alloc(gc
->ngpio
, GFP_KERNEL
);
441 /* Assume by default all GPIOs are valid */
442 bitmap_fill(p
, gc
->ngpio
);
447 static int gpiochip_alloc_valid_mask(struct gpio_chip
*gc
)
449 if (!(of_gpio_need_valid_mask(gc
) || gc
->init_valid_mask
))
452 gc
->valid_mask
= gpiochip_allocate_mask(gc
);
459 static int gpiochip_init_valid_mask(struct gpio_chip
*gc
)
461 if (gc
->init_valid_mask
)
462 return gc
->init_valid_mask(gc
,
469 static void gpiochip_free_valid_mask(struct gpio_chip
*gc
)
471 bitmap_free(gc
->valid_mask
);
472 gc
->valid_mask
= NULL
;
475 static int gpiochip_add_pin_ranges(struct gpio_chip
*gc
)
477 if (gc
->add_pin_ranges
)
478 return gc
->add_pin_ranges(gc
);
483 bool gpiochip_line_is_valid(const struct gpio_chip
*gc
,
486 /* No mask means all valid */
487 if (likely(!gc
->valid_mask
))
489 return test_bit(offset
, gc
->valid_mask
);
491 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid
);
493 static void gpiodevice_release(struct device
*dev
)
495 struct gpio_device
*gdev
= container_of(dev
, struct gpio_device
, dev
);
498 spin_lock_irqsave(&gpio_lock
, flags
);
499 list_del(&gdev
->list
);
500 spin_unlock_irqrestore(&gpio_lock
, flags
);
502 ida_free(&gpio_ida
, gdev
->id
);
503 kfree_const(gdev
->label
);
508 #ifdef CONFIG_GPIO_CDEV
509 #define gcdev_register(gdev, devt) gpiolib_cdev_register((gdev), (devt))
510 #define gcdev_unregister(gdev) gpiolib_cdev_unregister((gdev))
513 * gpiolib_cdev_register() indirectly calls device_add(), which is still
514 * required even when cdev is not selected.
516 #define gcdev_register(gdev, devt) device_add(&(gdev)->dev)
517 #define gcdev_unregister(gdev) device_del(&(gdev)->dev)
520 static int gpiochip_setup_dev(struct gpio_device
*gdev
)
524 ret
= gcdev_register(gdev
, gpio_devt
);
528 ret
= gpiochip_sysfs_register(gdev
);
530 goto err_remove_device
;
532 /* From this point, the .release() function cleans up gpio_device */
533 gdev
->dev
.release
= gpiodevice_release
;
534 dev_dbg(&gdev
->dev
, "registered GPIOs %d to %d on %s\n", gdev
->base
,
535 gdev
->base
+ gdev
->ngpio
- 1, gdev
->chip
->label
? : "generic");
540 gcdev_unregister(gdev
);
544 static void gpiochip_machine_hog(struct gpio_chip
*gc
, struct gpiod_hog
*hog
)
546 struct gpio_desc
*desc
;
549 desc
= gpiochip_get_desc(gc
, hog
->chip_hwnum
);
551 chip_err(gc
, "%s: unable to get GPIO desc: %ld\n", __func__
,
556 if (test_bit(FLAG_IS_HOGGED
, &desc
->flags
))
559 rv
= gpiod_hog(desc
, hog
->line_name
, hog
->lflags
, hog
->dflags
);
561 gpiod_err(desc
, "%s: unable to hog GPIO line (%s:%u): %d\n",
562 __func__
, gc
->label
, hog
->chip_hwnum
, rv
);
565 static void machine_gpiochip_add(struct gpio_chip
*gc
)
567 struct gpiod_hog
*hog
;
569 mutex_lock(&gpio_machine_hogs_mutex
);
571 list_for_each_entry(hog
, &gpio_machine_hogs
, list
) {
572 if (!strcmp(gc
->label
, hog
->chip_label
))
573 gpiochip_machine_hog(gc
, hog
);
576 mutex_unlock(&gpio_machine_hogs_mutex
);
579 static void gpiochip_setup_devs(void)
581 struct gpio_device
*gdev
;
584 list_for_each_entry(gdev
, &gpio_devices
, list
) {
585 ret
= gpiochip_setup_dev(gdev
);
588 "Failed to initialize gpio device (%d)\n", ret
);
592 int gpiochip_add_data_with_key(struct gpio_chip
*gc
, void *data
,
593 struct lock_class_key
*lock_key
,
594 struct lock_class_key
*request_key
)
596 struct fwnode_handle
*fwnode
= gc
->parent
? dev_fwnode(gc
->parent
) : NULL
;
601 struct gpio_device
*gdev
;
604 * First: allocate and populate the internal stat container, and
605 * set up the struct device.
607 gdev
= kzalloc(sizeof(*gdev
), GFP_KERNEL
);
610 gdev
->dev
.bus
= &gpio_bus_type
;
611 gdev
->dev
.parent
= gc
->parent
;
615 of_gpio_dev_init(gc
, gdev
);
616 acpi_gpio_dev_init(gc
, gdev
);
619 * Assign fwnode depending on the result of the previous calls,
620 * if none of them succeed, assign it to the parent's one.
622 gdev
->dev
.fwnode
= dev_fwnode(&gdev
->dev
) ?: fwnode
;
624 gdev
->id
= ida_alloc(&gpio_ida
, GFP_KERNEL
);
630 ret
= dev_set_name(&gdev
->dev
, GPIOCHIP_NAME
"%d", gdev
->id
);
634 device_initialize(&gdev
->dev
);
635 if (gc
->parent
&& gc
->parent
->driver
)
636 gdev
->owner
= gc
->parent
->driver
->owner
;
638 /* TODO: remove chip->owner */
639 gdev
->owner
= gc
->owner
;
641 gdev
->owner
= THIS_MODULE
;
643 gdev
->descs
= kcalloc(gc
->ngpio
, sizeof(gdev
->descs
[0]), GFP_KERNEL
);
646 goto err_free_dev_name
;
649 if (gc
->ngpio
== 0) {
650 chip_err(gc
, "tried to insert a GPIO chip with zero lines\n");
655 if (gc
->ngpio
> FASTPATH_NGPIO
)
656 chip_warn(gc
, "line cnt %u is greater than fast path cnt %u\n",
657 gc
->ngpio
, FASTPATH_NGPIO
);
659 gdev
->label
= kstrdup_const(gc
->label
?: "unknown", GFP_KERNEL
);
665 gdev
->ngpio
= gc
->ngpio
;
668 spin_lock_irqsave(&gpio_lock
, flags
);
671 * TODO: this allocates a Linux GPIO number base in the global
672 * GPIO numberspace for this chip. In the long run we want to
673 * get *rid* of this numberspace and use only descriptors, but
674 * it may be a pipe dream. It will not happen before we get rid
675 * of the sysfs interface anyways.
678 base
= gpiochip_find_base(gc
->ngpio
);
681 spin_unlock_irqrestore(&gpio_lock
, flags
);
685 * TODO: it should not be necessary to reflect the assigned
686 * base outside of the GPIO subsystem. Go over drivers and
687 * see if anyone makes use of this, else drop this and assign
694 ret
= gpiodev_add_to_list(gdev
);
696 spin_unlock_irqrestore(&gpio_lock
, flags
);
700 for (i
= 0; i
< gc
->ngpio
; i
++)
701 gdev
->descs
[i
].gdev
= gdev
;
703 spin_unlock_irqrestore(&gpio_lock
, flags
);
705 BLOCKING_INIT_NOTIFIER_HEAD(&gdev
->notifier
);
707 #ifdef CONFIG_PINCTRL
708 INIT_LIST_HEAD(&gdev
->pin_ranges
);
712 ret
= gpiochip_set_desc_names(gc
);
714 ret
= devprop_gpiochip_set_names(gc
);
716 goto err_remove_from_list
;
718 ret
= gpiochip_alloc_valid_mask(gc
);
720 goto err_remove_from_list
;
722 ret
= of_gpiochip_add(gc
);
724 goto err_free_gpiochip_mask
;
726 ret
= gpiochip_init_valid_mask(gc
);
728 goto err_remove_of_chip
;
730 for (i
= 0; i
< gc
->ngpio
; i
++) {
731 struct gpio_desc
*desc
= &gdev
->descs
[i
];
733 if (gc
->get_direction
&& gpiochip_line_is_valid(gc
, i
)) {
734 assign_bit(FLAG_IS_OUT
,
735 &desc
->flags
, !gc
->get_direction(gc
, i
));
737 assign_bit(FLAG_IS_OUT
,
738 &desc
->flags
, !gc
->direction_input
);
742 ret
= gpiochip_add_pin_ranges(gc
);
744 goto err_remove_of_chip
;
746 acpi_gpiochip_add(gc
);
748 machine_gpiochip_add(gc
);
750 ret
= gpiochip_irqchip_init_valid_mask(gc
);
752 goto err_remove_acpi_chip
;
754 ret
= gpiochip_irqchip_init_hw(gc
);
756 goto err_remove_acpi_chip
;
758 ret
= gpiochip_add_irqchip(gc
, lock_key
, request_key
);
760 goto err_remove_irqchip_mask
;
763 * By first adding the chardev, and then adding the device,
764 * we get a device node entry in sysfs under
765 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
766 * coldplug of device nodes and other udev business.
767 * We can do this only if gpiolib has been initialized.
768 * Otherwise, defer until later.
770 if (gpiolib_initialized
) {
771 ret
= gpiochip_setup_dev(gdev
);
773 goto err_remove_irqchip
;
778 gpiochip_irqchip_remove(gc
);
779 err_remove_irqchip_mask
:
780 gpiochip_irqchip_free_valid_mask(gc
);
781 err_remove_acpi_chip
:
782 acpi_gpiochip_remove(gc
);
784 gpiochip_free_hogs(gc
);
785 of_gpiochip_remove(gc
);
786 err_free_gpiochip_mask
:
787 gpiochip_remove_pin_ranges(gc
);
788 gpiochip_free_valid_mask(gc
);
789 err_remove_from_list
:
790 spin_lock_irqsave(&gpio_lock
, flags
);
791 list_del(&gdev
->list
);
792 spin_unlock_irqrestore(&gpio_lock
, flags
);
794 kfree_const(gdev
->label
);
798 kfree(dev_name(&gdev
->dev
));
800 ida_free(&gpio_ida
, gdev
->id
);
802 /* failures here can mean systems won't boot... */
803 if (ret
!= -EPROBE_DEFER
) {
804 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__
,
805 gdev
->base
, gdev
->base
+ gdev
->ngpio
- 1,
806 gc
->label
? : "generic", ret
);
811 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key
);
814 * gpiochip_get_data() - get per-subdriver data for the chip
818 * The per-subdriver data for the chip.
820 void *gpiochip_get_data(struct gpio_chip
*gc
)
822 return gc
->gpiodev
->data
;
824 EXPORT_SYMBOL_GPL(gpiochip_get_data
);
827 * gpiochip_remove() - unregister a gpio_chip
828 * @gc: the chip to unregister
830 * A gpio_chip with any GPIOs still requested may not be removed.
832 void gpiochip_remove(struct gpio_chip
*gc
)
834 struct gpio_device
*gdev
= gc
->gpiodev
;
838 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
839 gpiochip_sysfs_unregister(gdev
);
840 gpiochip_free_hogs(gc
);
841 /* Numb the device, cancelling all outstanding operations */
843 gpiochip_irqchip_remove(gc
);
844 acpi_gpiochip_remove(gc
);
845 of_gpiochip_remove(gc
);
846 gpiochip_remove_pin_ranges(gc
);
847 gpiochip_free_valid_mask(gc
);
849 * We accept no more calls into the driver from this point, so
850 * NULL the driver data pointer
854 spin_lock_irqsave(&gpio_lock
, flags
);
855 for (i
= 0; i
< gdev
->ngpio
; i
++) {
856 if (gpiochip_is_requested(gc
, i
))
859 spin_unlock_irqrestore(&gpio_lock
, flags
);
861 if (i
!= gdev
->ngpio
)
863 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
866 * The gpiochip side puts its use of the device to rest here:
867 * if there are no userspace clients, the chardev and device will
868 * be removed, else it will be dangling until the last user is
871 gcdev_unregister(gdev
);
872 put_device(&gdev
->dev
);
874 EXPORT_SYMBOL_GPL(gpiochip_remove
);
877 * gpiochip_find() - iterator for locating a specific gpio_chip
878 * @data: data to pass to match function
879 * @match: Callback function to check gpio_chip
881 * Similar to bus_find_device. It returns a reference to a gpio_chip as
882 * determined by a user supplied @match callback. The callback should return
883 * 0 if the device doesn't match and non-zero if it does. If the callback is
884 * non-zero, this function will return to the caller and not iterate over any
887 struct gpio_chip
*gpiochip_find(void *data
,
888 int (*match
)(struct gpio_chip
*gc
,
891 struct gpio_device
*gdev
;
892 struct gpio_chip
*gc
= NULL
;
895 spin_lock_irqsave(&gpio_lock
, flags
);
896 list_for_each_entry(gdev
, &gpio_devices
, list
)
897 if (gdev
->chip
&& match(gdev
->chip
, data
)) {
902 spin_unlock_irqrestore(&gpio_lock
, flags
);
906 EXPORT_SYMBOL_GPL(gpiochip_find
);
908 static int gpiochip_match_name(struct gpio_chip
*gc
, void *data
)
910 const char *name
= data
;
912 return !strcmp(gc
->label
, name
);
915 static struct gpio_chip
*find_chip_by_name(const char *name
)
917 return gpiochip_find((void *)name
, gpiochip_match_name
);
920 #ifdef CONFIG_GPIOLIB_IRQCHIP
923 * The following is irqchip helper code for gpiochips.
926 static int gpiochip_irqchip_init_hw(struct gpio_chip
*gc
)
928 struct gpio_irq_chip
*girq
= &gc
->irq
;
933 return girq
->init_hw(gc
);
936 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip
*gc
)
938 struct gpio_irq_chip
*girq
= &gc
->irq
;
940 if (!girq
->init_valid_mask
)
943 girq
->valid_mask
= gpiochip_allocate_mask(gc
);
944 if (!girq
->valid_mask
)
947 girq
->init_valid_mask(gc
, girq
->valid_mask
, gc
->ngpio
);
952 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip
*gc
)
954 bitmap_free(gc
->irq
.valid_mask
);
955 gc
->irq
.valid_mask
= NULL
;
958 bool gpiochip_irqchip_irq_valid(const struct gpio_chip
*gc
,
961 if (!gpiochip_line_is_valid(gc
, offset
))
963 /* No mask means all valid */
964 if (likely(!gc
->irq
.valid_mask
))
966 return test_bit(offset
, gc
->irq
.valid_mask
);
968 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid
);
970 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
973 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
975 * @gc: the gpiochip to set the irqchip hierarchical handler to
976 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
977 * will then percolate up to the parent
979 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip
*gc
,
980 struct irq_chip
*irqchip
)
982 /* DT will deal with mapping each IRQ as we go along */
983 if (is_of_node(gc
->irq
.fwnode
))
987 * This is for legacy and boardfile "irqchip" fwnodes: allocate
988 * irqs upfront instead of dynamically since we don't have the
989 * dynamic type of allocation that hardware description languages
990 * provide. Once all GPIO drivers using board files are gone from
991 * the kernel we can delete this code, but for a transitional period
992 * it is necessary to keep this around.
994 if (is_fwnode_irqchip(gc
->irq
.fwnode
)) {
998 for (i
= 0; i
< gc
->ngpio
; i
++) {
999 struct irq_fwspec fwspec
;
1000 unsigned int parent_hwirq
;
1001 unsigned int parent_type
;
1002 struct gpio_irq_chip
*girq
= &gc
->irq
;
1005 * We call the child to parent translation function
1006 * only to check if the child IRQ is valid or not.
1007 * Just pick the rising edge type here as that is what
1008 * we likely need to support.
1010 ret
= girq
->child_to_parent_hwirq(gc
, i
,
1011 IRQ_TYPE_EDGE_RISING
,
1015 chip_err(gc
, "skip set-up on hwirq %d\n",
1020 fwspec
.fwnode
= gc
->irq
.fwnode
;
1021 /* This is the hwirq for the GPIO line side of things */
1022 fwspec
.param
[0] = girq
->child_offset_to_irq(gc
, i
);
1023 /* Just pick something */
1024 fwspec
.param
[1] = IRQ_TYPE_EDGE_RISING
;
1025 fwspec
.param_count
= 2;
1026 ret
= __irq_domain_alloc_irqs(gc
->irq
.domain
,
1027 /* just pick something */
1036 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1043 chip_err(gc
, "%s unknown fwnode type proceed anyway\n", __func__
);
1048 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain
*d
,
1049 struct irq_fwspec
*fwspec
,
1050 unsigned long *hwirq
,
1053 /* We support standard DT translation */
1054 if (is_of_node(fwspec
->fwnode
) && fwspec
->param_count
== 2) {
1055 return irq_domain_translate_twocell(d
, fwspec
, hwirq
, type
);
1058 /* This is for board files and others not using DT */
1059 if (is_fwnode_irqchip(fwspec
->fwnode
)) {
1062 ret
= irq_domain_translate_twocell(d
, fwspec
, hwirq
, type
);
1065 WARN_ON(*type
== IRQ_TYPE_NONE
);
1071 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain
*d
,
1073 unsigned int nr_irqs
,
1076 struct gpio_chip
*gc
= d
->host_data
;
1077 irq_hw_number_t hwirq
;
1078 unsigned int type
= IRQ_TYPE_NONE
;
1079 struct irq_fwspec
*fwspec
= data
;
1081 unsigned int parent_hwirq
;
1082 unsigned int parent_type
;
1083 struct gpio_irq_chip
*girq
= &gc
->irq
;
1087 * The nr_irqs parameter is always one except for PCI multi-MSI
1088 * so this should not happen.
1090 WARN_ON(nr_irqs
!= 1);
1092 ret
= gc
->irq
.child_irq_domain_ops
.translate(d
, fwspec
, &hwirq
, &type
);
1096 chip_dbg(gc
, "allocate IRQ %d, hwirq %lu\n", irq
, hwirq
);
1098 ret
= girq
->child_to_parent_hwirq(gc
, hwirq
, type
,
1099 &parent_hwirq
, &parent_type
);
1101 chip_err(gc
, "can't look up hwirq %lu\n", hwirq
);
1104 chip_dbg(gc
, "found parent hwirq %u\n", parent_hwirq
);
1107 * We set handle_bad_irq because the .set_type() should
1108 * always be invoked and set the right type of handler.
1110 irq_domain_set_info(d
,
1119 /* This parent only handles asserted level IRQs */
1120 parent_arg
= girq
->populate_parent_alloc_arg(gc
, parent_hwirq
, parent_type
);
1124 chip_dbg(gc
, "alloc_irqs_parent for %d parent hwirq %d\n",
1126 irq_set_lockdep_class(irq
, gc
->irq
.lock_key
, gc
->irq
.request_key
);
1127 ret
= irq_domain_alloc_irqs_parent(d
, irq
, 1, parent_arg
);
1129 * If the parent irqdomain is msi, the interrupts have already
1130 * been allocated, so the EEXIST is good.
1132 if (irq_domain_is_msi(d
->parent
) && (ret
== -EEXIST
))
1136 "failed to allocate parent hwirq %d for hwirq %lu\n",
1137 parent_hwirq
, hwirq
);
1143 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip
*gc
,
1144 unsigned int offset
)
1149 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops
*ops
)
1151 ops
->activate
= gpiochip_irq_domain_activate
;
1152 ops
->deactivate
= gpiochip_irq_domain_deactivate
;
1153 ops
->alloc
= gpiochip_hierarchy_irq_domain_alloc
;
1154 ops
->free
= irq_domain_free_irqs_common
;
1157 * We only allow overriding the translate() function for
1158 * hierarchical chips, and this should only be done if the user
1159 * really need something other than 1:1 translation.
1161 if (!ops
->translate
)
1162 ops
->translate
= gpiochip_hierarchy_irq_domain_translate
;
1165 static int gpiochip_hierarchy_add_domain(struct gpio_chip
*gc
)
1167 if (!gc
->irq
.child_to_parent_hwirq
||
1169 chip_err(gc
, "missing irqdomain vital data\n");
1173 if (!gc
->irq
.child_offset_to_irq
)
1174 gc
->irq
.child_offset_to_irq
= gpiochip_child_offset_to_irq_noop
;
1176 if (!gc
->irq
.populate_parent_alloc_arg
)
1177 gc
->irq
.populate_parent_alloc_arg
=
1178 gpiochip_populate_parent_fwspec_twocell
;
1180 gpiochip_hierarchy_setup_domain_ops(&gc
->irq
.child_irq_domain_ops
);
1182 gc
->irq
.domain
= irq_domain_create_hierarchy(
1183 gc
->irq
.parent_domain
,
1187 &gc
->irq
.child_irq_domain_ops
,
1190 if (!gc
->irq
.domain
)
1193 gpiochip_set_hierarchical_irqchip(gc
, gc
->irq
.chip
);
1198 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip
*gc
)
1200 return !!gc
->irq
.parent_domain
;
1203 void *gpiochip_populate_parent_fwspec_twocell(struct gpio_chip
*gc
,
1204 unsigned int parent_hwirq
,
1205 unsigned int parent_type
)
1207 struct irq_fwspec
*fwspec
;
1209 fwspec
= kmalloc(sizeof(*fwspec
), GFP_KERNEL
);
1213 fwspec
->fwnode
= gc
->irq
.parent_domain
->fwnode
;
1214 fwspec
->param_count
= 2;
1215 fwspec
->param
[0] = parent_hwirq
;
1216 fwspec
->param
[1] = parent_type
;
1220 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell
);
1222 void *gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip
*gc
,
1223 unsigned int parent_hwirq
,
1224 unsigned int parent_type
)
1226 struct irq_fwspec
*fwspec
;
1228 fwspec
= kmalloc(sizeof(*fwspec
), GFP_KERNEL
);
1232 fwspec
->fwnode
= gc
->irq
.parent_domain
->fwnode
;
1233 fwspec
->param_count
= 4;
1234 fwspec
->param
[0] = 0;
1235 fwspec
->param
[1] = parent_hwirq
;
1236 fwspec
->param
[2] = 0;
1237 fwspec
->param
[3] = parent_type
;
1241 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell
);
1245 static int gpiochip_hierarchy_add_domain(struct gpio_chip
*gc
)
1250 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip
*gc
)
1255 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1258 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1259 * @d: the irqdomain used by this irqchip
1260 * @irq: the global irq number used by this GPIO irqchip irq
1261 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1263 * This function will set up the mapping for a certain IRQ line on a
1264 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1265 * stored inside the gpiochip.
1267 int gpiochip_irq_map(struct irq_domain
*d
, unsigned int irq
,
1268 irq_hw_number_t hwirq
)
1270 struct gpio_chip
*gc
= d
->host_data
;
1273 if (!gpiochip_irqchip_irq_valid(gc
, hwirq
))
1276 irq_set_chip_data(irq
, gc
);
1278 * This lock class tells lockdep that GPIO irqs are in a different
1279 * category than their parents, so it won't report false recursion.
1281 irq_set_lockdep_class(irq
, gc
->irq
.lock_key
, gc
->irq
.request_key
);
1282 irq_set_chip_and_handler(irq
, gc
->irq
.chip
, gc
->irq
.handler
);
1283 /* Chips that use nested thread handlers have them marked */
1284 if (gc
->irq
.threaded
)
1285 irq_set_nested_thread(irq
, 1);
1286 irq_set_noprobe(irq
);
1288 if (gc
->irq
.num_parents
== 1)
1289 ret
= irq_set_parent(irq
, gc
->irq
.parents
[0]);
1290 else if (gc
->irq
.map
)
1291 ret
= irq_set_parent(irq
, gc
->irq
.map
[hwirq
]);
1297 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1298 * is passed as default type.
1300 if (gc
->irq
.default_type
!= IRQ_TYPE_NONE
)
1301 irq_set_irq_type(irq
, gc
->irq
.default_type
);
1305 EXPORT_SYMBOL_GPL(gpiochip_irq_map
);
1307 void gpiochip_irq_unmap(struct irq_domain
*d
, unsigned int irq
)
1309 struct gpio_chip
*gc
= d
->host_data
;
1311 if (gc
->irq
.threaded
)
1312 irq_set_nested_thread(irq
, 0);
1313 irq_set_chip_and_handler(irq
, NULL
, NULL
);
1314 irq_set_chip_data(irq
, NULL
);
1316 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap
);
1318 static const struct irq_domain_ops gpiochip_domain_ops
= {
1319 .map
= gpiochip_irq_map
,
1320 .unmap
= gpiochip_irq_unmap
,
1321 /* Virtually all GPIO irqchips are twocell:ed */
1322 .xlate
= irq_domain_xlate_twocell
,
1326 * TODO: move these activate/deactivate in under the hierarchicial
1327 * irqchip implementation as static once SPMI and SSBI (all external
1328 * users) are phased over.
1331 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1332 * @domain: The IRQ domain used by this IRQ chip
1333 * @data: Outermost irq_data associated with the IRQ
1334 * @reserve: If set, only reserve an interrupt vector instead of assigning one
1336 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1337 * used as the activate function for the &struct irq_domain_ops. The host_data
1338 * for the IRQ domain must be the &struct gpio_chip.
1340 int gpiochip_irq_domain_activate(struct irq_domain
*domain
,
1341 struct irq_data
*data
, bool reserve
)
1343 struct gpio_chip
*gc
= domain
->host_data
;
1345 return gpiochip_lock_as_irq(gc
, data
->hwirq
);
1347 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate
);
1350 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1351 * @domain: The IRQ domain used by this IRQ chip
1352 * @data: Outermost irq_data associated with the IRQ
1354 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1355 * be used as the deactivate function for the &struct irq_domain_ops. The
1356 * host_data for the IRQ domain must be the &struct gpio_chip.
1358 void gpiochip_irq_domain_deactivate(struct irq_domain
*domain
,
1359 struct irq_data
*data
)
1361 struct gpio_chip
*gc
= domain
->host_data
;
1363 return gpiochip_unlock_as_irq(gc
, data
->hwirq
);
1365 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate
);
1367 static int gpiochip_to_irq(struct gpio_chip
*gc
, unsigned int offset
)
1369 struct irq_domain
*domain
= gc
->irq
.domain
;
1371 if (!gpiochip_irqchip_irq_valid(gc
, offset
))
1374 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1375 if (irq_domain_is_hierarchy(domain
)) {
1376 struct irq_fwspec spec
;
1378 spec
.fwnode
= domain
->fwnode
;
1379 spec
.param_count
= 2;
1380 spec
.param
[0] = gc
->irq
.child_offset_to_irq(gc
, offset
);
1381 spec
.param
[1] = IRQ_TYPE_NONE
;
1383 return irq_create_fwspec_mapping(&spec
);
1387 return irq_create_mapping(domain
, offset
);
1390 static int gpiochip_irq_reqres(struct irq_data
*d
)
1392 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
1394 return gpiochip_reqres_irq(gc
, d
->hwirq
);
1397 static void gpiochip_irq_relres(struct irq_data
*d
)
1399 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
1401 gpiochip_relres_irq(gc
, d
->hwirq
);
1404 static void gpiochip_irq_mask(struct irq_data
*d
)
1406 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
1408 if (gc
->irq
.irq_mask
)
1409 gc
->irq
.irq_mask(d
);
1410 gpiochip_disable_irq(gc
, d
->hwirq
);
1413 static void gpiochip_irq_unmask(struct irq_data
*d
)
1415 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
1417 gpiochip_enable_irq(gc
, d
->hwirq
);
1418 if (gc
->irq
.irq_unmask
)
1419 gc
->irq
.irq_unmask(d
);
1422 static void gpiochip_irq_enable(struct irq_data
*d
)
1424 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
1426 gpiochip_enable_irq(gc
, d
->hwirq
);
1427 gc
->irq
.irq_enable(d
);
1430 static void gpiochip_irq_disable(struct irq_data
*d
)
1432 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
1434 gc
->irq
.irq_disable(d
);
1435 gpiochip_disable_irq(gc
, d
->hwirq
);
1438 static void gpiochip_set_irq_hooks(struct gpio_chip
*gc
)
1440 struct irq_chip
*irqchip
= gc
->irq
.chip
;
1442 if (!irqchip
->irq_request_resources
&&
1443 !irqchip
->irq_release_resources
) {
1444 irqchip
->irq_request_resources
= gpiochip_irq_reqres
;
1445 irqchip
->irq_release_resources
= gpiochip_irq_relres
;
1447 if (WARN_ON(gc
->irq
.irq_enable
))
1449 /* Check if the irqchip already has this hook... */
1450 if (irqchip
->irq_enable
== gpiochip_irq_enable
||
1451 irqchip
->irq_mask
== gpiochip_irq_mask
) {
1453 * ...and if so, give a gentle warning that this is bad
1457 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1461 if (irqchip
->irq_disable
) {
1462 gc
->irq
.irq_disable
= irqchip
->irq_disable
;
1463 irqchip
->irq_disable
= gpiochip_irq_disable
;
1465 gc
->irq
.irq_mask
= irqchip
->irq_mask
;
1466 irqchip
->irq_mask
= gpiochip_irq_mask
;
1469 if (irqchip
->irq_enable
) {
1470 gc
->irq
.irq_enable
= irqchip
->irq_enable
;
1471 irqchip
->irq_enable
= gpiochip_irq_enable
;
1473 gc
->irq
.irq_unmask
= irqchip
->irq_unmask
;
1474 irqchip
->irq_unmask
= gpiochip_irq_unmask
;
1479 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1480 * @gc: the GPIO chip to add the IRQ chip to
1481 * @lock_key: lockdep class for IRQ lock
1482 * @request_key: lockdep class for IRQ request
1484 static int gpiochip_add_irqchip(struct gpio_chip
*gc
,
1485 struct lock_class_key
*lock_key
,
1486 struct lock_class_key
*request_key
)
1488 struct fwnode_handle
*fwnode
= dev_fwnode(&gc
->gpiodev
->dev
);
1489 struct irq_chip
*irqchip
= gc
->irq
.chip
;
1496 if (gc
->irq
.parent_handler
&& gc
->can_sleep
) {
1497 chip_err(gc
, "you cannot have chained interrupts on a chip that may sleep\n");
1501 type
= gc
->irq
.default_type
;
1504 * Specifying a default trigger is a terrible idea if DT or ACPI is
1505 * used to configure the interrupts, as you may end up with
1506 * conflicting triggers. Tell the user, and reset to NONE.
1508 if (WARN(fwnode
&& type
!= IRQ_TYPE_NONE
,
1509 "%pfw: Ignoring %u default trigger\n", fwnode
, type
))
1510 type
= IRQ_TYPE_NONE
;
1513 chip_warn(gc
, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__
);
1515 gc
->to_irq
= gpiochip_to_irq
;
1516 gc
->irq
.default_type
= type
;
1517 gc
->irq
.lock_key
= lock_key
;
1518 gc
->irq
.request_key
= request_key
;
1520 /* If a parent irqdomain is provided, let's build a hierarchy */
1521 if (gpiochip_hierarchy_is_hierarchical(gc
)) {
1522 int ret
= gpiochip_hierarchy_add_domain(gc
);
1526 /* Some drivers provide custom irqdomain ops */
1527 gc
->irq
.domain
= irq_domain_create_simple(fwnode
,
1530 gc
->irq
.domain_ops
?: &gpiochip_domain_ops
,
1532 if (!gc
->irq
.domain
)
1536 if (gc
->irq
.parent_handler
) {
1537 void *data
= gc
->irq
.parent_handler_data
?: gc
;
1539 for (i
= 0; i
< gc
->irq
.num_parents
; i
++) {
1541 * The parent IRQ chip is already using the chip_data
1542 * for this IRQ chip, so our callbacks simply use the
1545 irq_set_chained_handler_and_data(gc
->irq
.parents
[i
],
1546 gc
->irq
.parent_handler
,
1551 gpiochip_set_irq_hooks(gc
);
1553 acpi_gpiochip_request_interrupts(gc
);
1559 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1560 * @gc: the gpiochip to remove the irqchip from
1562 * This is called only from gpiochip_remove()
1564 static void gpiochip_irqchip_remove(struct gpio_chip
*gc
)
1566 struct irq_chip
*irqchip
= gc
->irq
.chip
;
1567 unsigned int offset
;
1569 acpi_gpiochip_free_interrupts(gc
);
1571 if (irqchip
&& gc
->irq
.parent_handler
) {
1572 struct gpio_irq_chip
*irq
= &gc
->irq
;
1575 for (i
= 0; i
< irq
->num_parents
; i
++)
1576 irq_set_chained_handler_and_data(irq
->parents
[i
],
1580 /* Remove all IRQ mappings and delete the domain */
1581 if (gc
->irq
.domain
) {
1584 for (offset
= 0; offset
< gc
->ngpio
; offset
++) {
1585 if (!gpiochip_irqchip_irq_valid(gc
, offset
))
1588 irq
= irq_find_mapping(gc
->irq
.domain
, offset
);
1589 irq_dispose_mapping(irq
);
1592 irq_domain_remove(gc
->irq
.domain
);
1596 if (irqchip
->irq_request_resources
== gpiochip_irq_reqres
) {
1597 irqchip
->irq_request_resources
= NULL
;
1598 irqchip
->irq_release_resources
= NULL
;
1600 if (irqchip
->irq_enable
== gpiochip_irq_enable
) {
1601 irqchip
->irq_enable
= gc
->irq
.irq_enable
;
1602 irqchip
->irq_disable
= gc
->irq
.irq_disable
;
1605 gc
->irq
.irq_enable
= NULL
;
1606 gc
->irq
.irq_disable
= NULL
;
1607 gc
->irq
.chip
= NULL
;
1609 gpiochip_irqchip_free_valid_mask(gc
);
1613 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1614 * @gc: the gpiochip to add the irqchip to
1615 * @domain: the irqdomain to add to the gpiochip
1617 * This function adds an IRQ domain to the gpiochip.
1619 int gpiochip_irqchip_add_domain(struct gpio_chip
*gc
,
1620 struct irq_domain
*domain
)
1625 gc
->to_irq
= gpiochip_to_irq
;
1626 gc
->irq
.domain
= domain
;
1630 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain
);
1632 #else /* CONFIG_GPIOLIB_IRQCHIP */
1634 static inline int gpiochip_add_irqchip(struct gpio_chip
*gc
,
1635 struct lock_class_key
*lock_key
,
1636 struct lock_class_key
*request_key
)
1640 static void gpiochip_irqchip_remove(struct gpio_chip
*gc
) {}
1642 static inline int gpiochip_irqchip_init_hw(struct gpio_chip
*gc
)
1647 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip
*gc
)
1651 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip
*gc
)
1654 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1657 * gpiochip_generic_request() - request the gpio function for a pin
1658 * @gc: the gpiochip owning the GPIO
1659 * @offset: the offset of the GPIO to request for GPIO function
1661 int gpiochip_generic_request(struct gpio_chip
*gc
, unsigned int offset
)
1663 return pinctrl_gpio_request(gc
->gpiodev
->base
+ offset
);
1665 EXPORT_SYMBOL_GPL(gpiochip_generic_request
);
1668 * gpiochip_generic_free() - free the gpio function from a pin
1669 * @gc: the gpiochip to request the gpio function for
1670 * @offset: the offset of the GPIO to free from GPIO function
1672 void gpiochip_generic_free(struct gpio_chip
*gc
, unsigned int offset
)
1674 pinctrl_gpio_free(gc
->gpiodev
->base
+ offset
);
1676 EXPORT_SYMBOL_GPL(gpiochip_generic_free
);
1679 * gpiochip_generic_config() - apply configuration for a pin
1680 * @gc: the gpiochip owning the GPIO
1681 * @offset: the offset of the GPIO to apply the configuration
1682 * @config: the configuration to be applied
1684 int gpiochip_generic_config(struct gpio_chip
*gc
, unsigned int offset
,
1685 unsigned long config
)
1687 return pinctrl_gpio_set_config(gc
->gpiodev
->base
+ offset
, config
);
1689 EXPORT_SYMBOL_GPL(gpiochip_generic_config
);
1691 #ifdef CONFIG_PINCTRL
1694 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1695 * @gc: the gpiochip to add the range for
1696 * @pctldev: the pin controller to map to
1697 * @gpio_offset: the start offset in the current gpio_chip number space
1698 * @pin_group: name of the pin group inside the pin controller
1700 * Calling this function directly from a DeviceTree-supported
1701 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1702 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1703 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1705 int gpiochip_add_pingroup_range(struct gpio_chip
*gc
,
1706 struct pinctrl_dev
*pctldev
,
1707 unsigned int gpio_offset
, const char *pin_group
)
1709 struct gpio_pin_range
*pin_range
;
1710 struct gpio_device
*gdev
= gc
->gpiodev
;
1713 pin_range
= kzalloc(sizeof(*pin_range
), GFP_KERNEL
);
1715 chip_err(gc
, "failed to allocate pin ranges\n");
1719 /* Use local offset as range ID */
1720 pin_range
->range
.id
= gpio_offset
;
1721 pin_range
->range
.gc
= gc
;
1722 pin_range
->range
.name
= gc
->label
;
1723 pin_range
->range
.base
= gdev
->base
+ gpio_offset
;
1724 pin_range
->pctldev
= pctldev
;
1726 ret
= pinctrl_get_group_pins(pctldev
, pin_group
,
1727 &pin_range
->range
.pins
,
1728 &pin_range
->range
.npins
);
1734 pinctrl_add_gpio_range(pctldev
, &pin_range
->range
);
1736 chip_dbg(gc
, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1737 gpio_offset
, gpio_offset
+ pin_range
->range
.npins
- 1,
1738 pinctrl_dev_get_devname(pctldev
), pin_group
);
1740 list_add_tail(&pin_range
->node
, &gdev
->pin_ranges
);
1744 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range
);
1747 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1748 * @gc: the gpiochip to add the range for
1749 * @pinctl_name: the dev_name() of the pin controller to map to
1750 * @gpio_offset: the start offset in the current gpio_chip number space
1751 * @pin_offset: the start offset in the pin controller number space
1752 * @npins: the number of pins from the offset of each pin space (GPIO and
1753 * pin controller) to accumulate in this range
1756 * 0 on success, or a negative error-code on failure.
1758 * Calling this function directly from a DeviceTree-supported
1759 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1760 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1761 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1763 int gpiochip_add_pin_range(struct gpio_chip
*gc
, const char *pinctl_name
,
1764 unsigned int gpio_offset
, unsigned int pin_offset
,
1767 struct gpio_pin_range
*pin_range
;
1768 struct gpio_device
*gdev
= gc
->gpiodev
;
1771 pin_range
= kzalloc(sizeof(*pin_range
), GFP_KERNEL
);
1773 chip_err(gc
, "failed to allocate pin ranges\n");
1777 /* Use local offset as range ID */
1778 pin_range
->range
.id
= gpio_offset
;
1779 pin_range
->range
.gc
= gc
;
1780 pin_range
->range
.name
= gc
->label
;
1781 pin_range
->range
.base
= gdev
->base
+ gpio_offset
;
1782 pin_range
->range
.pin_base
= pin_offset
;
1783 pin_range
->range
.npins
= npins
;
1784 pin_range
->pctldev
= pinctrl_find_and_add_gpio_range(pinctl_name
,
1786 if (IS_ERR(pin_range
->pctldev
)) {
1787 ret
= PTR_ERR(pin_range
->pctldev
);
1788 chip_err(gc
, "could not create pin range\n");
1792 chip_dbg(gc
, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1793 gpio_offset
, gpio_offset
+ npins
- 1,
1795 pin_offset
, pin_offset
+ npins
- 1);
1797 list_add_tail(&pin_range
->node
, &gdev
->pin_ranges
);
1801 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range
);
1804 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1805 * @gc: the chip to remove all the mappings for
1807 void gpiochip_remove_pin_ranges(struct gpio_chip
*gc
)
1809 struct gpio_pin_range
*pin_range
, *tmp
;
1810 struct gpio_device
*gdev
= gc
->gpiodev
;
1812 list_for_each_entry_safe(pin_range
, tmp
, &gdev
->pin_ranges
, node
) {
1813 list_del(&pin_range
->node
);
1814 pinctrl_remove_gpio_range(pin_range
->pctldev
,
1819 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges
);
1821 #endif /* CONFIG_PINCTRL */
1823 /* These "optional" allocation calls help prevent drivers from stomping
1824 * on each other, and help provide better diagnostics in debugfs.
1825 * They're called even less than the "set direction" calls.
1827 static int gpiod_request_commit(struct gpio_desc
*desc
, const char *label
)
1829 struct gpio_chip
*gc
= desc
->gdev
->chip
;
1831 unsigned long flags
;
1835 label
= kstrdup_const(label
, GFP_KERNEL
);
1840 spin_lock_irqsave(&gpio_lock
, flags
);
1842 /* NOTE: gpio_request() can be called in early boot,
1843 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1846 if (test_and_set_bit(FLAG_REQUESTED
, &desc
->flags
) == 0) {
1847 desc_set_label(desc
, label
? : "?");
1850 goto out_free_unlock
;
1854 /* gc->request may sleep */
1855 spin_unlock_irqrestore(&gpio_lock
, flags
);
1856 offset
= gpio_chip_hwgpio(desc
);
1857 if (gpiochip_line_is_valid(gc
, offset
))
1858 ret
= gc
->request(gc
, offset
);
1861 spin_lock_irqsave(&gpio_lock
, flags
);
1864 desc_set_label(desc
, NULL
);
1865 clear_bit(FLAG_REQUESTED
, &desc
->flags
);
1866 goto out_free_unlock
;
1869 if (gc
->get_direction
) {
1870 /* gc->get_direction may sleep */
1871 spin_unlock_irqrestore(&gpio_lock
, flags
);
1872 gpiod_get_direction(desc
);
1873 spin_lock_irqsave(&gpio_lock
, flags
);
1875 spin_unlock_irqrestore(&gpio_lock
, flags
);
1879 spin_unlock_irqrestore(&gpio_lock
, flags
);
1885 * This descriptor validation needs to be inserted verbatim into each
1886 * function taking a descriptor, so we need to use a preprocessor
1887 * macro to avoid endless duplication. If the desc is NULL it is an
1888 * optional GPIO and calls should just bail out.
1890 static int validate_desc(const struct gpio_desc
*desc
, const char *func
)
1895 pr_warn("%s: invalid GPIO (errorpointer)\n", func
);
1896 return PTR_ERR(desc
);
1899 pr_warn("%s: invalid GPIO (no device)\n", func
);
1902 if (!desc
->gdev
->chip
) {
1903 dev_warn(&desc
->gdev
->dev
,
1904 "%s: backing chip is gone\n", func
);
1910 #define VALIDATE_DESC(desc) do { \
1911 int __valid = validate_desc(desc, __func__); \
1916 #define VALIDATE_DESC_VOID(desc) do { \
1917 int __valid = validate_desc(desc, __func__); \
1922 int gpiod_request(struct gpio_desc
*desc
, const char *label
)
1924 int ret
= -EPROBE_DEFER
;
1925 struct gpio_device
*gdev
;
1927 VALIDATE_DESC(desc
);
1930 if (try_module_get(gdev
->owner
)) {
1931 ret
= gpiod_request_commit(desc
, label
);
1933 module_put(gdev
->owner
);
1935 get_device(&gdev
->dev
);
1939 gpiod_dbg(desc
, "%s: status %d\n", __func__
, ret
);
1944 static bool gpiod_free_commit(struct gpio_desc
*desc
)
1947 unsigned long flags
;
1948 struct gpio_chip
*gc
;
1952 gpiod_unexport(desc
);
1954 spin_lock_irqsave(&gpio_lock
, flags
);
1956 gc
= desc
->gdev
->chip
;
1957 if (gc
&& test_bit(FLAG_REQUESTED
, &desc
->flags
)) {
1959 spin_unlock_irqrestore(&gpio_lock
, flags
);
1960 might_sleep_if(gc
->can_sleep
);
1961 gc
->free(gc
, gpio_chip_hwgpio(desc
));
1962 spin_lock_irqsave(&gpio_lock
, flags
);
1964 kfree_const(desc
->label
);
1965 desc_set_label(desc
, NULL
);
1966 clear_bit(FLAG_ACTIVE_LOW
, &desc
->flags
);
1967 clear_bit(FLAG_REQUESTED
, &desc
->flags
);
1968 clear_bit(FLAG_OPEN_DRAIN
, &desc
->flags
);
1969 clear_bit(FLAG_OPEN_SOURCE
, &desc
->flags
);
1970 clear_bit(FLAG_PULL_UP
, &desc
->flags
);
1971 clear_bit(FLAG_PULL_DOWN
, &desc
->flags
);
1972 clear_bit(FLAG_BIAS_DISABLE
, &desc
->flags
);
1973 clear_bit(FLAG_EDGE_RISING
, &desc
->flags
);
1974 clear_bit(FLAG_EDGE_FALLING
, &desc
->flags
);
1975 clear_bit(FLAG_IS_HOGGED
, &desc
->flags
);
1976 #ifdef CONFIG_OF_DYNAMIC
1979 #ifdef CONFIG_GPIO_CDEV
1980 WRITE_ONCE(desc
->debounce_period_us
, 0);
1985 spin_unlock_irqrestore(&gpio_lock
, flags
);
1986 blocking_notifier_call_chain(&desc
->gdev
->notifier
,
1987 GPIOLINE_CHANGED_RELEASED
, desc
);
1992 void gpiod_free(struct gpio_desc
*desc
)
1994 if (desc
&& desc
->gdev
&& gpiod_free_commit(desc
)) {
1995 module_put(desc
->gdev
->owner
);
1996 put_device(&desc
->gdev
->dev
);
1998 WARN_ON(extra_checks
);
2003 * gpiochip_is_requested - return string iff signal was requested
2004 * @gc: controller managing the signal
2005 * @offset: of signal within controller's 0..(ngpio - 1) range
2007 * Returns NULL if the GPIO is not currently requested, else a string.
2008 * The string returned is the label passed to gpio_request(); if none has been
2009 * passed it is a meaningless, non-NULL constant.
2011 * This function is for use by GPIO controller drivers. The label can
2012 * help with diagnostics, and knowing that the signal is used as a GPIO
2013 * can help avoid accidentally multiplexing it to another controller.
2015 const char *gpiochip_is_requested(struct gpio_chip
*gc
, unsigned int offset
)
2017 struct gpio_desc
*desc
;
2019 desc
= gpiochip_get_desc(gc
, offset
);
2023 if (test_bit(FLAG_REQUESTED
, &desc
->flags
) == 0)
2027 EXPORT_SYMBOL_GPL(gpiochip_is_requested
);
2030 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2032 * @hwnum: hardware number of the GPIO for which to request the descriptor
2033 * @label: label for the GPIO
2034 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2035 * specify things like line inversion semantics with the machine flags
2036 * such as GPIO_OUT_LOW
2037 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2038 * can be used to specify consumer semantics such as open drain
2040 * Function allows GPIO chip drivers to request and use their own GPIO
2041 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2042 * function will not increase reference count of the GPIO chip module. This
2043 * allows the GPIO chip module to be unloaded as needed (we assume that the
2044 * GPIO chip driver handles freeing the GPIOs it has requested).
2047 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2050 struct gpio_desc
*gpiochip_request_own_desc(struct gpio_chip
*gc
,
2053 enum gpio_lookup_flags lflags
,
2054 enum gpiod_flags dflags
)
2056 struct gpio_desc
*desc
= gpiochip_get_desc(gc
, hwnum
);
2060 chip_err(gc
, "failed to get GPIO descriptor\n");
2064 ret
= gpiod_request_commit(desc
, label
);
2066 return ERR_PTR(ret
);
2068 ret
= gpiod_configure_flags(desc
, label
, lflags
, dflags
);
2070 chip_err(gc
, "setup of own GPIO %s failed\n", label
);
2071 gpiod_free_commit(desc
);
2072 return ERR_PTR(ret
);
2077 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc
);
2080 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2081 * @desc: GPIO descriptor to free
2083 * Function frees the given GPIO requested previously with
2084 * gpiochip_request_own_desc().
2086 void gpiochip_free_own_desc(struct gpio_desc
*desc
)
2089 gpiod_free_commit(desc
);
2091 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc
);
2094 * Drivers MUST set GPIO direction before making get/set calls. In
2095 * some cases this is done in early boot, before IRQs are enabled.
2097 * As a rule these aren't called more than once (except for drivers
2098 * using the open-drain emulation idiom) so these are natural places
2099 * to accumulate extra debugging checks. Note that we can't (yet)
2100 * rely on gpio_request() having been called beforehand.
2103 static int gpio_do_set_config(struct gpio_chip
*gc
, unsigned int offset
,
2104 unsigned long config
)
2106 if (!gc
->set_config
)
2109 return gc
->set_config(gc
, offset
, config
);
2112 static int gpio_set_config_with_argument(struct gpio_desc
*desc
,
2113 enum pin_config_param mode
,
2116 struct gpio_chip
*gc
= desc
->gdev
->chip
;
2117 unsigned long config
;
2119 config
= pinconf_to_config_packed(mode
, argument
);
2120 return gpio_do_set_config(gc
, gpio_chip_hwgpio(desc
), config
);
2123 static int gpio_set_config_with_argument_optional(struct gpio_desc
*desc
,
2124 enum pin_config_param mode
,
2127 struct device
*dev
= &desc
->gdev
->dev
;
2128 int gpio
= gpio_chip_hwgpio(desc
);
2131 ret
= gpio_set_config_with_argument(desc
, mode
, argument
);
2132 if (ret
!= -ENOTSUPP
)
2136 case PIN_CONFIG_PERSIST_STATE
:
2137 dev_dbg(dev
, "Persistence not supported for GPIO %d\n", gpio
);
2146 static int gpio_set_config(struct gpio_desc
*desc
, enum pin_config_param mode
)
2148 return gpio_set_config_with_argument(desc
, mode
, 0);
2151 static int gpio_set_bias(struct gpio_desc
*desc
)
2153 enum pin_config_param bias
;
2156 if (test_bit(FLAG_BIAS_DISABLE
, &desc
->flags
))
2157 bias
= PIN_CONFIG_BIAS_DISABLE
;
2158 else if (test_bit(FLAG_PULL_UP
, &desc
->flags
))
2159 bias
= PIN_CONFIG_BIAS_PULL_UP
;
2160 else if (test_bit(FLAG_PULL_DOWN
, &desc
->flags
))
2161 bias
= PIN_CONFIG_BIAS_PULL_DOWN
;
2166 case PIN_CONFIG_BIAS_PULL_DOWN
:
2167 case PIN_CONFIG_BIAS_PULL_UP
:
2176 return gpio_set_config_with_argument_optional(desc
, bias
, arg
);
2180 * gpio_set_debounce_timeout() - Set debounce timeout
2181 * @desc: GPIO descriptor to set the debounce timeout
2182 * @debounce: Debounce timeout in microseconds
2184 * The function calls the certain GPIO driver to set debounce timeout
2187 * Returns 0 on success, or negative error code otherwise.
2189 int gpio_set_debounce_timeout(struct gpio_desc
*desc
, unsigned int debounce
)
2191 return gpio_set_config_with_argument_optional(desc
,
2192 PIN_CONFIG_INPUT_DEBOUNCE
,
2197 * gpiod_direction_input - set the GPIO direction to input
2198 * @desc: GPIO to set to input
2200 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2201 * be called safely on it.
2203 * Return 0 in case of success, else an error code.
2205 int gpiod_direction_input(struct gpio_desc
*desc
)
2207 struct gpio_chip
*gc
;
2210 VALIDATE_DESC(desc
);
2211 gc
= desc
->gdev
->chip
;
2214 * It is legal to have no .get() and .direction_input() specified if
2215 * the chip is output-only, but you can't specify .direction_input()
2216 * and not support the .get() operation, that doesn't make sense.
2218 if (!gc
->get
&& gc
->direction_input
) {
2220 "%s: missing get() but have direction_input()\n",
2226 * If we have a .direction_input() callback, things are simple,
2227 * just call it. Else we are some input-only chip so try to check the
2228 * direction (if .get_direction() is supported) else we silently
2229 * assume we are in input mode after this.
2231 if (gc
->direction_input
) {
2232 ret
= gc
->direction_input(gc
, gpio_chip_hwgpio(desc
));
2233 } else if (gc
->get_direction
&&
2234 (gc
->get_direction(gc
, gpio_chip_hwgpio(desc
)) != 1)) {
2236 "%s: missing direction_input() operation and line is output\n",
2241 clear_bit(FLAG_IS_OUT
, &desc
->flags
);
2242 ret
= gpio_set_bias(desc
);
2245 trace_gpio_direction(desc_to_gpio(desc
), 1, ret
);
2249 EXPORT_SYMBOL_GPL(gpiod_direction_input
);
2251 static int gpiod_direction_output_raw_commit(struct gpio_desc
*desc
, int value
)
2253 struct gpio_chip
*gc
= desc
->gdev
->chip
;
2258 * It's OK not to specify .direction_output() if the gpiochip is
2259 * output-only, but if there is then not even a .set() operation it
2260 * is pretty tricky to drive the output line.
2262 if (!gc
->set
&& !gc
->direction_output
) {
2264 "%s: missing set() and direction_output() operations\n",
2269 if (gc
->direction_output
) {
2270 ret
= gc
->direction_output(gc
, gpio_chip_hwgpio(desc
), val
);
2272 /* Check that we are in output mode if we can */
2273 if (gc
->get_direction
&&
2274 gc
->get_direction(gc
, gpio_chip_hwgpio(desc
))) {
2276 "%s: missing direction_output() operation\n",
2281 * If we can't actively set the direction, we are some
2282 * output-only chip, so just drive the output as desired.
2284 gc
->set(gc
, gpio_chip_hwgpio(desc
), val
);
2288 set_bit(FLAG_IS_OUT
, &desc
->flags
);
2289 trace_gpio_value(desc_to_gpio(desc
), 0, val
);
2290 trace_gpio_direction(desc_to_gpio(desc
), 0, ret
);
2295 * gpiod_direction_output_raw - set the GPIO direction to output
2296 * @desc: GPIO to set to output
2297 * @value: initial output value of the GPIO
2299 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2300 * be called safely on it. The initial value of the output must be specified
2301 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2303 * Return 0 in case of success, else an error code.
2305 int gpiod_direction_output_raw(struct gpio_desc
*desc
, int value
)
2307 VALIDATE_DESC(desc
);
2308 return gpiod_direction_output_raw_commit(desc
, value
);
2310 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw
);
2313 * gpiod_direction_output - set the GPIO direction to output
2314 * @desc: GPIO to set to output
2315 * @value: initial output value of the GPIO
2317 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2318 * be called safely on it. The initial value of the output must be specified
2319 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2322 * Return 0 in case of success, else an error code.
2324 int gpiod_direction_output(struct gpio_desc
*desc
, int value
)
2328 VALIDATE_DESC(desc
);
2329 if (test_bit(FLAG_ACTIVE_LOW
, &desc
->flags
))
2334 /* GPIOs used for enabled IRQs shall not be set as output */
2335 if (test_bit(FLAG_USED_AS_IRQ
, &desc
->flags
) &&
2336 test_bit(FLAG_IRQ_IS_ENABLED
, &desc
->flags
)) {
2338 "%s: tried to set a GPIO tied to an IRQ as output\n",
2343 if (test_bit(FLAG_OPEN_DRAIN
, &desc
->flags
)) {
2344 /* First see if we can enable open drain in hardware */
2345 ret
= gpio_set_config(desc
, PIN_CONFIG_DRIVE_OPEN_DRAIN
);
2347 goto set_output_value
;
2348 /* Emulate open drain by not actively driving the line high */
2350 ret
= gpiod_direction_input(desc
);
2351 goto set_output_flag
;
2354 else if (test_bit(FLAG_OPEN_SOURCE
, &desc
->flags
)) {
2355 ret
= gpio_set_config(desc
, PIN_CONFIG_DRIVE_OPEN_SOURCE
);
2357 goto set_output_value
;
2358 /* Emulate open source by not actively driving the line low */
2360 ret
= gpiod_direction_input(desc
);
2361 goto set_output_flag
;
2364 gpio_set_config(desc
, PIN_CONFIG_DRIVE_PUSH_PULL
);
2368 ret
= gpio_set_bias(desc
);
2371 return gpiod_direction_output_raw_commit(desc
, value
);
2375 * When emulating open-source or open-drain functionalities by not
2376 * actively driving the line (setting mode to input) we still need to
2377 * set the IS_OUT flag or otherwise we won't be able to set the line
2381 set_bit(FLAG_IS_OUT
, &desc
->flags
);
2384 EXPORT_SYMBOL_GPL(gpiod_direction_output
);
2387 * gpiod_set_config - sets @config for a GPIO
2388 * @desc: descriptor of the GPIO for which to set the configuration
2389 * @config: Same packed config format as generic pinconf
2392 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2395 int gpiod_set_config(struct gpio_desc
*desc
, unsigned long config
)
2397 struct gpio_chip
*gc
;
2399 VALIDATE_DESC(desc
);
2400 gc
= desc
->gdev
->chip
;
2402 return gpio_do_set_config(gc
, gpio_chip_hwgpio(desc
), config
);
2404 EXPORT_SYMBOL_GPL(gpiod_set_config
);
2407 * gpiod_set_debounce - sets @debounce time for a GPIO
2408 * @desc: descriptor of the GPIO for which to set debounce time
2409 * @debounce: debounce time in microseconds
2412 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2415 int gpiod_set_debounce(struct gpio_desc
*desc
, unsigned int debounce
)
2417 unsigned long config
;
2419 config
= pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE
, debounce
);
2420 return gpiod_set_config(desc
, config
);
2422 EXPORT_SYMBOL_GPL(gpiod_set_debounce
);
2425 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2426 * @desc: descriptor of the GPIO for which to configure persistence
2427 * @transitory: True to lose state on suspend or reset, false for persistence
2430 * 0 on success, otherwise a negative error code.
2432 int gpiod_set_transitory(struct gpio_desc
*desc
, bool transitory
)
2434 VALIDATE_DESC(desc
);
2436 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2437 * persistence state.
2439 assign_bit(FLAG_TRANSITORY
, &desc
->flags
, transitory
);
2441 /* If the driver supports it, set the persistence state now */
2442 return gpio_set_config_with_argument_optional(desc
,
2443 PIN_CONFIG_PERSIST_STATE
,
2446 EXPORT_SYMBOL_GPL(gpiod_set_transitory
);
2449 * gpiod_is_active_low - test whether a GPIO is active-low or not
2450 * @desc: the gpio descriptor to test
2452 * Returns 1 if the GPIO is active-low, 0 otherwise.
2454 int gpiod_is_active_low(const struct gpio_desc
*desc
)
2456 VALIDATE_DESC(desc
);
2457 return test_bit(FLAG_ACTIVE_LOW
, &desc
->flags
);
2459 EXPORT_SYMBOL_GPL(gpiod_is_active_low
);
2462 * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2463 * @desc: the gpio descriptor to change
2465 void gpiod_toggle_active_low(struct gpio_desc
*desc
)
2467 VALIDATE_DESC_VOID(desc
);
2468 change_bit(FLAG_ACTIVE_LOW
, &desc
->flags
);
2470 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low
);
2472 /* I/O calls are only valid after configuration completed; the relevant
2473 * "is this a valid GPIO" error checks should already have been done.
2475 * "Get" operations are often inlinable as reading a pin value register,
2476 * and masking the relevant bit in that register.
2478 * When "set" operations are inlinable, they involve writing that mask to
2479 * one register to set a low value, or a different register to set it high.
2480 * Otherwise locking is needed, so there may be little value to inlining.
2482 *------------------------------------------------------------------------
2484 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2485 * have requested the GPIO. That can include implicit requesting by
2486 * a direction setting call. Marking a gpio as requested locks its chip
2487 * in memory, guaranteeing that these table lookups need no more locking
2488 * and that gpiochip_remove() will fail.
2490 * REVISIT when debugging, consider adding some instrumentation to ensure
2491 * that the GPIO was actually requested.
2494 static int gpiod_get_raw_value_commit(const struct gpio_desc
*desc
)
2496 struct gpio_chip
*gc
;
2500 gc
= desc
->gdev
->chip
;
2501 offset
= gpio_chip_hwgpio(desc
);
2502 value
= gc
->get
? gc
->get(gc
, offset
) : -EIO
;
2503 value
= value
< 0 ? value
: !!value
;
2504 trace_gpio_value(desc_to_gpio(desc
), 1, value
);
2508 static int gpio_chip_get_multiple(struct gpio_chip
*gc
,
2509 unsigned long *mask
, unsigned long *bits
)
2511 if (gc
->get_multiple
) {
2512 return gc
->get_multiple(gc
, mask
, bits
);
2513 } else if (gc
->get
) {
2516 for_each_set_bit(i
, mask
, gc
->ngpio
) {
2517 value
= gc
->get(gc
, i
);
2520 __assign_bit(i
, bits
, value
);
2527 int gpiod_get_array_value_complex(bool raw
, bool can_sleep
,
2528 unsigned int array_size
,
2529 struct gpio_desc
**desc_array
,
2530 struct gpio_array
*array_info
,
2531 unsigned long *value_bitmap
)
2536 * Validate array_info against desc_array and its size.
2537 * It should immediately follow desc_array if both
2538 * have been obtained from the same gpiod_get_array() call.
2540 if (array_info
&& array_info
->desc
== desc_array
&&
2541 array_size
<= array_info
->size
&&
2542 (void *)array_info
== desc_array
+ array_info
->size
) {
2544 WARN_ON(array_info
->chip
->can_sleep
);
2546 ret
= gpio_chip_get_multiple(array_info
->chip
,
2547 array_info
->get_mask
,
2552 if (!raw
&& !bitmap_empty(array_info
->invert_mask
, array_size
))
2553 bitmap_xor(value_bitmap
, value_bitmap
,
2554 array_info
->invert_mask
, array_size
);
2556 i
= find_first_zero_bit(array_info
->get_mask
, array_size
);
2557 if (i
== array_size
)
2563 while (i
< array_size
) {
2564 struct gpio_chip
*gc
= desc_array
[i
]->gdev
->chip
;
2565 DECLARE_BITMAP(fastpath_mask
, FASTPATH_NGPIO
);
2566 DECLARE_BITMAP(fastpath_bits
, FASTPATH_NGPIO
);
2567 unsigned long *mask
, *bits
;
2570 if (likely(gc
->ngpio
<= FASTPATH_NGPIO
)) {
2571 mask
= fastpath_mask
;
2572 bits
= fastpath_bits
;
2574 gfp_t flags
= can_sleep
? GFP_KERNEL
: GFP_ATOMIC
;
2576 mask
= bitmap_alloc(gc
->ngpio
, flags
);
2580 bits
= bitmap_alloc(gc
->ngpio
, flags
);
2587 bitmap_zero(mask
, gc
->ngpio
);
2590 WARN_ON(gc
->can_sleep
);
2592 /* collect all inputs belonging to the same chip */
2595 const struct gpio_desc
*desc
= desc_array
[i
];
2596 int hwgpio
= gpio_chip_hwgpio(desc
);
2598 __set_bit(hwgpio
, mask
);
2602 i
= find_next_zero_bit(array_info
->get_mask
,
2604 } while ((i
< array_size
) &&
2605 (desc_array
[i
]->gdev
->chip
== gc
));
2607 ret
= gpio_chip_get_multiple(gc
, mask
, bits
);
2609 if (mask
!= fastpath_mask
)
2611 if (bits
!= fastpath_bits
)
2616 for (j
= first
; j
< i
; ) {
2617 const struct gpio_desc
*desc
= desc_array
[j
];
2618 int hwgpio
= gpio_chip_hwgpio(desc
);
2619 int value
= test_bit(hwgpio
, bits
);
2621 if (!raw
&& test_bit(FLAG_ACTIVE_LOW
, &desc
->flags
))
2623 __assign_bit(j
, value_bitmap
, value
);
2624 trace_gpio_value(desc_to_gpio(desc
), 1, value
);
2628 j
= find_next_zero_bit(array_info
->get_mask
, i
,
2632 if (mask
!= fastpath_mask
)
2634 if (bits
!= fastpath_bits
)
2641 * gpiod_get_raw_value() - return a gpio's raw value
2642 * @desc: gpio whose value will be returned
2644 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2645 * its ACTIVE_LOW status, or negative errno on failure.
2647 * This function can be called from contexts where we cannot sleep, and will
2648 * complain if the GPIO chip functions potentially sleep.
2650 int gpiod_get_raw_value(const struct gpio_desc
*desc
)
2652 VALIDATE_DESC(desc
);
2653 /* Should be using gpiod_get_raw_value_cansleep() */
2654 WARN_ON(desc
->gdev
->chip
->can_sleep
);
2655 return gpiod_get_raw_value_commit(desc
);
2657 EXPORT_SYMBOL_GPL(gpiod_get_raw_value
);
2660 * gpiod_get_value() - return a gpio's value
2661 * @desc: gpio whose value will be returned
2663 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2664 * account, or negative errno on failure.
2666 * This function can be called from contexts where we cannot sleep, and will
2667 * complain if the GPIO chip functions potentially sleep.
2669 int gpiod_get_value(const struct gpio_desc
*desc
)
2673 VALIDATE_DESC(desc
);
2674 /* Should be using gpiod_get_value_cansleep() */
2675 WARN_ON(desc
->gdev
->chip
->can_sleep
);
2677 value
= gpiod_get_raw_value_commit(desc
);
2681 if (test_bit(FLAG_ACTIVE_LOW
, &desc
->flags
))
2686 EXPORT_SYMBOL_GPL(gpiod_get_value
);
2689 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2690 * @array_size: number of elements in the descriptor array / value bitmap
2691 * @desc_array: array of GPIO descriptors whose values will be read
2692 * @array_info: information on applicability of fast bitmap processing path
2693 * @value_bitmap: bitmap to store the read values
2695 * Read the raw values of the GPIOs, i.e. the values of the physical lines
2696 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
2697 * else an error code.
2699 * This function can be called from contexts where we cannot sleep,
2700 * and it will complain if the GPIO chip functions potentially sleep.
2702 int gpiod_get_raw_array_value(unsigned int array_size
,
2703 struct gpio_desc
**desc_array
,
2704 struct gpio_array
*array_info
,
2705 unsigned long *value_bitmap
)
2709 return gpiod_get_array_value_complex(true, false, array_size
,
2710 desc_array
, array_info
,
2713 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value
);
2716 * gpiod_get_array_value() - read values from an array of GPIOs
2717 * @array_size: number of elements in the descriptor array / value bitmap
2718 * @desc_array: array of GPIO descriptors whose values will be read
2719 * @array_info: information on applicability of fast bitmap processing path
2720 * @value_bitmap: bitmap to store the read values
2722 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2723 * into account. Return 0 in case of success, else an error code.
2725 * This function can be called from contexts where we cannot sleep,
2726 * and it will complain if the GPIO chip functions potentially sleep.
2728 int gpiod_get_array_value(unsigned int array_size
,
2729 struct gpio_desc
**desc_array
,
2730 struct gpio_array
*array_info
,
2731 unsigned long *value_bitmap
)
2735 return gpiod_get_array_value_complex(false, false, array_size
,
2736 desc_array
, array_info
,
2739 EXPORT_SYMBOL_GPL(gpiod_get_array_value
);
2742 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2743 * @desc: gpio descriptor whose state need to be set.
2744 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2746 static void gpio_set_open_drain_value_commit(struct gpio_desc
*desc
, bool value
)
2749 struct gpio_chip
*gc
= desc
->gdev
->chip
;
2750 int offset
= gpio_chip_hwgpio(desc
);
2753 ret
= gc
->direction_input(gc
, offset
);
2755 ret
= gc
->direction_output(gc
, offset
, 0);
2757 set_bit(FLAG_IS_OUT
, &desc
->flags
);
2759 trace_gpio_direction(desc_to_gpio(desc
), value
, ret
);
2762 "%s: Error in set_value for open drain err %d\n",
2767 * _gpio_set_open_source_value() - Set the open source gpio's value.
2768 * @desc: gpio descriptor whose state need to be set.
2769 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2771 static void gpio_set_open_source_value_commit(struct gpio_desc
*desc
, bool value
)
2774 struct gpio_chip
*gc
= desc
->gdev
->chip
;
2775 int offset
= gpio_chip_hwgpio(desc
);
2778 ret
= gc
->direction_output(gc
, offset
, 1);
2780 set_bit(FLAG_IS_OUT
, &desc
->flags
);
2782 ret
= gc
->direction_input(gc
, offset
);
2784 trace_gpio_direction(desc_to_gpio(desc
), !value
, ret
);
2787 "%s: Error in set_value for open source err %d\n",
2791 static void gpiod_set_raw_value_commit(struct gpio_desc
*desc
, bool value
)
2793 struct gpio_chip
*gc
;
2795 gc
= desc
->gdev
->chip
;
2796 trace_gpio_value(desc_to_gpio(desc
), 0, value
);
2797 gc
->set(gc
, gpio_chip_hwgpio(desc
), value
);
2801 * set multiple outputs on the same chip;
2802 * use the chip's set_multiple function if available;
2803 * otherwise set the outputs sequentially;
2804 * @chip: the GPIO chip we operate on
2805 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2806 * defines which outputs are to be changed
2807 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2808 * defines the values the outputs specified by mask are to be set to
2810 static void gpio_chip_set_multiple(struct gpio_chip
*gc
,
2811 unsigned long *mask
, unsigned long *bits
)
2813 if (gc
->set_multiple
) {
2814 gc
->set_multiple(gc
, mask
, bits
);
2818 /* set outputs if the corresponding mask bit is set */
2819 for_each_set_bit(i
, mask
, gc
->ngpio
)
2820 gc
->set(gc
, i
, test_bit(i
, bits
));
2824 int gpiod_set_array_value_complex(bool raw
, bool can_sleep
,
2825 unsigned int array_size
,
2826 struct gpio_desc
**desc_array
,
2827 struct gpio_array
*array_info
,
2828 unsigned long *value_bitmap
)
2833 * Validate array_info against desc_array and its size.
2834 * It should immediately follow desc_array if both
2835 * have been obtained from the same gpiod_get_array() call.
2837 if (array_info
&& array_info
->desc
== desc_array
&&
2838 array_size
<= array_info
->size
&&
2839 (void *)array_info
== desc_array
+ array_info
->size
) {
2841 WARN_ON(array_info
->chip
->can_sleep
);
2843 if (!raw
&& !bitmap_empty(array_info
->invert_mask
, array_size
))
2844 bitmap_xor(value_bitmap
, value_bitmap
,
2845 array_info
->invert_mask
, array_size
);
2847 gpio_chip_set_multiple(array_info
->chip
, array_info
->set_mask
,
2850 i
= find_first_zero_bit(array_info
->set_mask
, array_size
);
2851 if (i
== array_size
)
2857 while (i
< array_size
) {
2858 struct gpio_chip
*gc
= desc_array
[i
]->gdev
->chip
;
2859 DECLARE_BITMAP(fastpath_mask
, FASTPATH_NGPIO
);
2860 DECLARE_BITMAP(fastpath_bits
, FASTPATH_NGPIO
);
2861 unsigned long *mask
, *bits
;
2864 if (likely(gc
->ngpio
<= FASTPATH_NGPIO
)) {
2865 mask
= fastpath_mask
;
2866 bits
= fastpath_bits
;
2868 gfp_t flags
= can_sleep
? GFP_KERNEL
: GFP_ATOMIC
;
2870 mask
= bitmap_alloc(gc
->ngpio
, flags
);
2874 bits
= bitmap_alloc(gc
->ngpio
, flags
);
2881 bitmap_zero(mask
, gc
->ngpio
);
2884 WARN_ON(gc
->can_sleep
);
2887 struct gpio_desc
*desc
= desc_array
[i
];
2888 int hwgpio
= gpio_chip_hwgpio(desc
);
2889 int value
= test_bit(i
, value_bitmap
);
2892 * Pins applicable for fast input but not for
2893 * fast output processing may have been already
2894 * inverted inside the fast path, skip them.
2896 if (!raw
&& !(array_info
&&
2897 test_bit(i
, array_info
->invert_mask
)) &&
2898 test_bit(FLAG_ACTIVE_LOW
, &desc
->flags
))
2900 trace_gpio_value(desc_to_gpio(desc
), 0, value
);
2902 * collect all normal outputs belonging to the same chip
2903 * open drain and open source outputs are set individually
2905 if (test_bit(FLAG_OPEN_DRAIN
, &desc
->flags
) && !raw
) {
2906 gpio_set_open_drain_value_commit(desc
, value
);
2907 } else if (test_bit(FLAG_OPEN_SOURCE
, &desc
->flags
) && !raw
) {
2908 gpio_set_open_source_value_commit(desc
, value
);
2910 __set_bit(hwgpio
, mask
);
2911 __assign_bit(hwgpio
, bits
, value
);
2917 i
= find_next_zero_bit(array_info
->set_mask
,
2919 } while ((i
< array_size
) &&
2920 (desc_array
[i
]->gdev
->chip
== gc
));
2921 /* push collected bits to outputs */
2923 gpio_chip_set_multiple(gc
, mask
, bits
);
2925 if (mask
!= fastpath_mask
)
2927 if (bits
!= fastpath_bits
)
2934 * gpiod_set_raw_value() - assign a gpio's raw value
2935 * @desc: gpio whose value will be assigned
2936 * @value: value to assign
2938 * Set the raw value of the GPIO, i.e. the value of its physical line without
2939 * regard for its ACTIVE_LOW status.
2941 * This function can be called from contexts where we cannot sleep, and will
2942 * complain if the GPIO chip functions potentially sleep.
2944 void gpiod_set_raw_value(struct gpio_desc
*desc
, int value
)
2946 VALIDATE_DESC_VOID(desc
);
2947 /* Should be using gpiod_set_raw_value_cansleep() */
2948 WARN_ON(desc
->gdev
->chip
->can_sleep
);
2949 gpiod_set_raw_value_commit(desc
, value
);
2951 EXPORT_SYMBOL_GPL(gpiod_set_raw_value
);
2954 * gpiod_set_value_nocheck() - set a GPIO line value without checking
2955 * @desc: the descriptor to set the value on
2956 * @value: value to set
2958 * This sets the value of a GPIO line backing a descriptor, applying
2959 * different semantic quirks like active low and open drain/source
2962 static void gpiod_set_value_nocheck(struct gpio_desc
*desc
, int value
)
2964 if (test_bit(FLAG_ACTIVE_LOW
, &desc
->flags
))
2966 if (test_bit(FLAG_OPEN_DRAIN
, &desc
->flags
))
2967 gpio_set_open_drain_value_commit(desc
, value
);
2968 else if (test_bit(FLAG_OPEN_SOURCE
, &desc
->flags
))
2969 gpio_set_open_source_value_commit(desc
, value
);
2971 gpiod_set_raw_value_commit(desc
, value
);
2975 * gpiod_set_value() - assign a gpio's value
2976 * @desc: gpio whose value will be assigned
2977 * @value: value to assign
2979 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
2980 * OPEN_DRAIN and OPEN_SOURCE flags into account.
2982 * This function can be called from contexts where we cannot sleep, and will
2983 * complain if the GPIO chip functions potentially sleep.
2985 void gpiod_set_value(struct gpio_desc
*desc
, int value
)
2987 VALIDATE_DESC_VOID(desc
);
2988 /* Should be using gpiod_set_value_cansleep() */
2989 WARN_ON(desc
->gdev
->chip
->can_sleep
);
2990 gpiod_set_value_nocheck(desc
, value
);
2992 EXPORT_SYMBOL_GPL(gpiod_set_value
);
2995 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
2996 * @array_size: number of elements in the descriptor array / value bitmap
2997 * @desc_array: array of GPIO descriptors whose values will be assigned
2998 * @array_info: information on applicability of fast bitmap processing path
2999 * @value_bitmap: bitmap of values to assign
3001 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3002 * without regard for their ACTIVE_LOW status.
3004 * This function can be called from contexts where we cannot sleep, and will
3005 * complain if the GPIO chip functions potentially sleep.
3007 int gpiod_set_raw_array_value(unsigned int array_size
,
3008 struct gpio_desc
**desc_array
,
3009 struct gpio_array
*array_info
,
3010 unsigned long *value_bitmap
)
3014 return gpiod_set_array_value_complex(true, false, array_size
,
3015 desc_array
, array_info
, value_bitmap
);
3017 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value
);
3020 * gpiod_set_array_value() - assign values to an array of GPIOs
3021 * @array_size: number of elements in the descriptor array / value bitmap
3022 * @desc_array: array of GPIO descriptors whose values will be assigned
3023 * @array_info: information on applicability of fast bitmap processing path
3024 * @value_bitmap: bitmap of values to assign
3026 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3029 * This function can be called from contexts where we cannot sleep, and will
3030 * complain if the GPIO chip functions potentially sleep.
3032 int gpiod_set_array_value(unsigned int array_size
,
3033 struct gpio_desc
**desc_array
,
3034 struct gpio_array
*array_info
,
3035 unsigned long *value_bitmap
)
3039 return gpiod_set_array_value_complex(false, false, array_size
,
3040 desc_array
, array_info
,
3043 EXPORT_SYMBOL_GPL(gpiod_set_array_value
);
3046 * gpiod_cansleep() - report whether gpio value access may sleep
3047 * @desc: gpio to check
3050 int gpiod_cansleep(const struct gpio_desc
*desc
)
3052 VALIDATE_DESC(desc
);
3053 return desc
->gdev
->chip
->can_sleep
;
3055 EXPORT_SYMBOL_GPL(gpiod_cansleep
);
3058 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3059 * @desc: gpio to set the consumer name on
3060 * @name: the new consumer name
3062 int gpiod_set_consumer_name(struct gpio_desc
*desc
, const char *name
)
3064 VALIDATE_DESC(desc
);
3066 name
= kstrdup_const(name
, GFP_KERNEL
);
3071 kfree_const(desc
->label
);
3072 desc_set_label(desc
, name
);
3076 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name
);
3079 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3080 * @desc: gpio whose IRQ will be returned (already requested)
3082 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3085 int gpiod_to_irq(const struct gpio_desc
*desc
)
3087 struct gpio_chip
*gc
;
3091 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3092 * requires this function to not return zero on an invalid descriptor
3093 * but rather a negative error number.
3095 if (!desc
|| IS_ERR(desc
) || !desc
->gdev
|| !desc
->gdev
->chip
)
3098 gc
= desc
->gdev
->chip
;
3099 offset
= gpio_chip_hwgpio(desc
);
3101 int retirq
= gc
->to_irq(gc
, offset
);
3103 /* Zero means NO_IRQ */
3109 #ifdef CONFIG_GPIOLIB_IRQCHIP
3112 * Avoid race condition with other code, which tries to lookup
3113 * an IRQ before the irqchip has been properly registered,
3114 * i.e. while gpiochip is still being brought up.
3116 return -EPROBE_DEFER
;
3121 EXPORT_SYMBOL_GPL(gpiod_to_irq
);
3124 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3125 * @gc: the chip the GPIO to lock belongs to
3126 * @offset: the offset of the GPIO to lock as IRQ
3128 * This is used directly by GPIO drivers that want to lock down
3129 * a certain GPIO line to be used for IRQs.
3131 int gpiochip_lock_as_irq(struct gpio_chip
*gc
, unsigned int offset
)
3133 struct gpio_desc
*desc
;
3135 desc
= gpiochip_get_desc(gc
, offset
);
3137 return PTR_ERR(desc
);
3140 * If it's fast: flush the direction setting if something changed
3143 if (!gc
->can_sleep
&& gc
->get_direction
) {
3144 int dir
= gpiod_get_direction(desc
);
3147 chip_err(gc
, "%s: cannot get GPIO direction\n",
3153 /* To be valid for IRQ the line needs to be input or open drain */
3154 if (test_bit(FLAG_IS_OUT
, &desc
->flags
) &&
3155 !test_bit(FLAG_OPEN_DRAIN
, &desc
->flags
)) {
3157 "%s: tried to flag a GPIO set as output for IRQ\n",
3162 set_bit(FLAG_USED_AS_IRQ
, &desc
->flags
);
3163 set_bit(FLAG_IRQ_IS_ENABLED
, &desc
->flags
);
3166 * If the consumer has not set up a label (such as when the
3167 * IRQ is referenced from .to_irq()) we set up a label here
3168 * so it is clear this is used as an interrupt.
3171 desc_set_label(desc
, "interrupt");
3175 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq
);
3178 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3179 * @gc: the chip the GPIO to lock belongs to
3180 * @offset: the offset of the GPIO to lock as IRQ
3182 * This is used directly by GPIO drivers that want to indicate
3183 * that a certain GPIO is no longer used exclusively for IRQ.
3185 void gpiochip_unlock_as_irq(struct gpio_chip
*gc
, unsigned int offset
)
3187 struct gpio_desc
*desc
;
3189 desc
= gpiochip_get_desc(gc
, offset
);
3193 clear_bit(FLAG_USED_AS_IRQ
, &desc
->flags
);
3194 clear_bit(FLAG_IRQ_IS_ENABLED
, &desc
->flags
);
3196 /* If we only had this marking, erase it */
3197 if (desc
->label
&& !strcmp(desc
->label
, "interrupt"))
3198 desc_set_label(desc
, NULL
);
3200 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq
);
3202 void gpiochip_disable_irq(struct gpio_chip
*gc
, unsigned int offset
)
3204 struct gpio_desc
*desc
= gpiochip_get_desc(gc
, offset
);
3206 if (!IS_ERR(desc
) &&
3207 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ
, &desc
->flags
)))
3208 clear_bit(FLAG_IRQ_IS_ENABLED
, &desc
->flags
);
3210 EXPORT_SYMBOL_GPL(gpiochip_disable_irq
);
3212 void gpiochip_enable_irq(struct gpio_chip
*gc
, unsigned int offset
)
3214 struct gpio_desc
*desc
= gpiochip_get_desc(gc
, offset
);
3216 if (!IS_ERR(desc
) &&
3217 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ
, &desc
->flags
))) {
3219 * We must not be output when using IRQ UNLESS we are
3222 WARN_ON(test_bit(FLAG_IS_OUT
, &desc
->flags
) &&
3223 !test_bit(FLAG_OPEN_DRAIN
, &desc
->flags
));
3224 set_bit(FLAG_IRQ_IS_ENABLED
, &desc
->flags
);
3227 EXPORT_SYMBOL_GPL(gpiochip_enable_irq
);
3229 bool gpiochip_line_is_irq(struct gpio_chip
*gc
, unsigned int offset
)
3231 if (offset
>= gc
->ngpio
)
3234 return test_bit(FLAG_USED_AS_IRQ
, &gc
->gpiodev
->descs
[offset
].flags
);
3236 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq
);
3238 int gpiochip_reqres_irq(struct gpio_chip
*gc
, unsigned int offset
)
3242 if (!try_module_get(gc
->gpiodev
->owner
))
3245 ret
= gpiochip_lock_as_irq(gc
, offset
);
3247 chip_err(gc
, "unable to lock HW IRQ %u for IRQ\n", offset
);
3248 module_put(gc
->gpiodev
->owner
);
3253 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq
);
3255 void gpiochip_relres_irq(struct gpio_chip
*gc
, unsigned int offset
)
3257 gpiochip_unlock_as_irq(gc
, offset
);
3258 module_put(gc
->gpiodev
->owner
);
3260 EXPORT_SYMBOL_GPL(gpiochip_relres_irq
);
3262 bool gpiochip_line_is_open_drain(struct gpio_chip
*gc
, unsigned int offset
)
3264 if (offset
>= gc
->ngpio
)
3267 return test_bit(FLAG_OPEN_DRAIN
, &gc
->gpiodev
->descs
[offset
].flags
);
3269 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain
);
3271 bool gpiochip_line_is_open_source(struct gpio_chip
*gc
, unsigned int offset
)
3273 if (offset
>= gc
->ngpio
)
3276 return test_bit(FLAG_OPEN_SOURCE
, &gc
->gpiodev
->descs
[offset
].flags
);
3278 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source
);
3280 bool gpiochip_line_is_persistent(struct gpio_chip
*gc
, unsigned int offset
)
3282 if (offset
>= gc
->ngpio
)
3285 return !test_bit(FLAG_TRANSITORY
, &gc
->gpiodev
->descs
[offset
].flags
);
3287 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent
);
3290 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3291 * @desc: gpio whose value will be returned
3293 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3294 * its ACTIVE_LOW status, or negative errno on failure.
3296 * This function is to be called from contexts that can sleep.
3298 int gpiod_get_raw_value_cansleep(const struct gpio_desc
*desc
)
3300 might_sleep_if(extra_checks
);
3301 VALIDATE_DESC(desc
);
3302 return gpiod_get_raw_value_commit(desc
);
3304 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep
);
3307 * gpiod_get_value_cansleep() - return a gpio's value
3308 * @desc: gpio whose value will be returned
3310 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3311 * account, or negative errno on failure.
3313 * This function is to be called from contexts that can sleep.
3315 int gpiod_get_value_cansleep(const struct gpio_desc
*desc
)
3319 might_sleep_if(extra_checks
);
3320 VALIDATE_DESC(desc
);
3321 value
= gpiod_get_raw_value_commit(desc
);
3325 if (test_bit(FLAG_ACTIVE_LOW
, &desc
->flags
))
3330 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep
);
3333 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3334 * @array_size: number of elements in the descriptor array / value bitmap
3335 * @desc_array: array of GPIO descriptors whose values will be read
3336 * @array_info: information on applicability of fast bitmap processing path
3337 * @value_bitmap: bitmap to store the read values
3339 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3340 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3341 * else an error code.
3343 * This function is to be called from contexts that can sleep.
3345 int gpiod_get_raw_array_value_cansleep(unsigned int array_size
,
3346 struct gpio_desc
**desc_array
,
3347 struct gpio_array
*array_info
,
3348 unsigned long *value_bitmap
)
3350 might_sleep_if(extra_checks
);
3353 return gpiod_get_array_value_complex(true, true, array_size
,
3354 desc_array
, array_info
,
3357 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep
);
3360 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3361 * @array_size: number of elements in the descriptor array / value bitmap
3362 * @desc_array: array of GPIO descriptors whose values will be read
3363 * @array_info: information on applicability of fast bitmap processing path
3364 * @value_bitmap: bitmap to store the read values
3366 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3367 * into account. Return 0 in case of success, else an error code.
3369 * This function is to be called from contexts that can sleep.
3371 int gpiod_get_array_value_cansleep(unsigned int array_size
,
3372 struct gpio_desc
**desc_array
,
3373 struct gpio_array
*array_info
,
3374 unsigned long *value_bitmap
)
3376 might_sleep_if(extra_checks
);
3379 return gpiod_get_array_value_complex(false, true, array_size
,
3380 desc_array
, array_info
,
3383 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep
);
3386 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3387 * @desc: gpio whose value will be assigned
3388 * @value: value to assign
3390 * Set the raw value of the GPIO, i.e. the value of its physical line without
3391 * regard for its ACTIVE_LOW status.
3393 * This function is to be called from contexts that can sleep.
3395 void gpiod_set_raw_value_cansleep(struct gpio_desc
*desc
, int value
)
3397 might_sleep_if(extra_checks
);
3398 VALIDATE_DESC_VOID(desc
);
3399 gpiod_set_raw_value_commit(desc
, value
);
3401 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep
);
3404 * gpiod_set_value_cansleep() - assign a gpio's value
3405 * @desc: gpio whose value will be assigned
3406 * @value: value to assign
3408 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3411 * This function is to be called from contexts that can sleep.
3413 void gpiod_set_value_cansleep(struct gpio_desc
*desc
, int value
)
3415 might_sleep_if(extra_checks
);
3416 VALIDATE_DESC_VOID(desc
);
3417 gpiod_set_value_nocheck(desc
, value
);
3419 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep
);
3422 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3423 * @array_size: number of elements in the descriptor array / value bitmap
3424 * @desc_array: array of GPIO descriptors whose values will be assigned
3425 * @array_info: information on applicability of fast bitmap processing path
3426 * @value_bitmap: bitmap of values to assign
3428 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3429 * without regard for their ACTIVE_LOW status.
3431 * This function is to be called from contexts that can sleep.
3433 int gpiod_set_raw_array_value_cansleep(unsigned int array_size
,
3434 struct gpio_desc
**desc_array
,
3435 struct gpio_array
*array_info
,
3436 unsigned long *value_bitmap
)
3438 might_sleep_if(extra_checks
);
3441 return gpiod_set_array_value_complex(true, true, array_size
, desc_array
,
3442 array_info
, value_bitmap
);
3444 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep
);
3447 * gpiod_add_lookup_tables() - register GPIO device consumers
3448 * @tables: list of tables of consumers to register
3449 * @n: number of tables in the list
3451 void gpiod_add_lookup_tables(struct gpiod_lookup_table
**tables
, size_t n
)
3455 mutex_lock(&gpio_lookup_lock
);
3457 for (i
= 0; i
< n
; i
++)
3458 list_add_tail(&tables
[i
]->list
, &gpio_lookup_list
);
3460 mutex_unlock(&gpio_lookup_lock
);
3464 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3465 * @array_size: number of elements in the descriptor array / value bitmap
3466 * @desc_array: array of GPIO descriptors whose values will be assigned
3467 * @array_info: information on applicability of fast bitmap processing path
3468 * @value_bitmap: bitmap of values to assign
3470 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3473 * This function is to be called from contexts that can sleep.
3475 int gpiod_set_array_value_cansleep(unsigned int array_size
,
3476 struct gpio_desc
**desc_array
,
3477 struct gpio_array
*array_info
,
3478 unsigned long *value_bitmap
)
3480 might_sleep_if(extra_checks
);
3483 return gpiod_set_array_value_complex(false, true, array_size
,
3484 desc_array
, array_info
,
3487 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep
);
3490 * gpiod_add_lookup_table() - register GPIO device consumers
3491 * @table: table of consumers to register
3493 void gpiod_add_lookup_table(struct gpiod_lookup_table
*table
)
3495 mutex_lock(&gpio_lookup_lock
);
3497 list_add_tail(&table
->list
, &gpio_lookup_list
);
3499 mutex_unlock(&gpio_lookup_lock
);
3501 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table
);
3504 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3505 * @table: table of consumers to unregister
3507 void gpiod_remove_lookup_table(struct gpiod_lookup_table
*table
)
3509 /* Nothing to remove */
3513 mutex_lock(&gpio_lookup_lock
);
3515 list_del(&table
->list
);
3517 mutex_unlock(&gpio_lookup_lock
);
3519 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table
);
3522 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3523 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3525 void gpiod_add_hogs(struct gpiod_hog
*hogs
)
3527 struct gpio_chip
*gc
;
3528 struct gpiod_hog
*hog
;
3530 mutex_lock(&gpio_machine_hogs_mutex
);
3532 for (hog
= &hogs
[0]; hog
->chip_label
; hog
++) {
3533 list_add_tail(&hog
->list
, &gpio_machine_hogs
);
3536 * The chip may have been registered earlier, so check if it
3537 * exists and, if so, try to hog the line now.
3539 gc
= find_chip_by_name(hog
->chip_label
);
3541 gpiochip_machine_hog(gc
, hog
);
3544 mutex_unlock(&gpio_machine_hogs_mutex
);
3546 EXPORT_SYMBOL_GPL(gpiod_add_hogs
);
3548 static struct gpiod_lookup_table
*gpiod_find_lookup_table(struct device
*dev
)
3550 const char *dev_id
= dev
? dev_name(dev
) : NULL
;
3551 struct gpiod_lookup_table
*table
;
3553 mutex_lock(&gpio_lookup_lock
);
3555 list_for_each_entry(table
, &gpio_lookup_list
, list
) {
3556 if (table
->dev_id
&& dev_id
) {
3558 * Valid strings on both ends, must be identical to have
3561 if (!strcmp(table
->dev_id
, dev_id
))
3565 * One of the pointers is NULL, so both must be to have
3568 if (dev_id
== table
->dev_id
)
3575 mutex_unlock(&gpio_lookup_lock
);
3579 static struct gpio_desc
*gpiod_find(struct device
*dev
, const char *con_id
,
3580 unsigned int idx
, unsigned long *flags
)
3582 struct gpio_desc
*desc
= ERR_PTR(-ENOENT
);
3583 struct gpiod_lookup_table
*table
;
3584 struct gpiod_lookup
*p
;
3586 table
= gpiod_find_lookup_table(dev
);
3590 for (p
= &table
->table
[0]; p
->key
; p
++) {
3591 struct gpio_chip
*gc
;
3593 /* idx must always match exactly */
3597 /* If the lookup entry has a con_id, require exact match */
3598 if (p
->con_id
&& (!con_id
|| strcmp(p
->con_id
, con_id
)))
3601 if (p
->chip_hwnum
== U16_MAX
) {
3602 desc
= gpio_name_to_desc(p
->key
);
3608 dev_warn(dev
, "cannot find GPIO line %s, deferring\n",
3610 return ERR_PTR(-EPROBE_DEFER
);
3613 gc
= find_chip_by_name(p
->key
);
3617 * As the lookup table indicates a chip with
3618 * p->key should exist, assume it may
3619 * still appear later and let the interested
3620 * consumer be probed again or let the Deferred
3621 * Probe infrastructure handle the error.
3623 dev_warn(dev
, "cannot find GPIO chip %s, deferring\n",
3625 return ERR_PTR(-EPROBE_DEFER
);
3628 if (gc
->ngpio
<= p
->chip_hwnum
) {
3630 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
3631 idx
, p
->chip_hwnum
, gc
->ngpio
- 1,
3633 return ERR_PTR(-EINVAL
);
3636 desc
= gpiochip_get_desc(gc
, p
->chip_hwnum
);
3645 static int platform_gpio_count(struct device
*dev
, const char *con_id
)
3647 struct gpiod_lookup_table
*table
;
3648 struct gpiod_lookup
*p
;
3649 unsigned int count
= 0;
3651 table
= gpiod_find_lookup_table(dev
);
3655 for (p
= &table
->table
[0]; p
->key
; p
++) {
3656 if ((con_id
&& p
->con_id
&& !strcmp(con_id
, p
->con_id
)) ||
3657 (!con_id
&& !p
->con_id
))
3667 * fwnode_gpiod_get_index - obtain a GPIO from firmware node
3668 * @fwnode: handle of the firmware node
3669 * @con_id: function within the GPIO consumer
3670 * @index: index of the GPIO to obtain for the consumer
3671 * @flags: GPIO initialization flags
3672 * @label: label to attach to the requested GPIO
3674 * This function can be used for drivers that get their configuration
3675 * from opaque firmware.
3677 * The function properly finds the corresponding GPIO using whatever is the
3678 * underlying firmware interface and then makes sure that the GPIO
3679 * descriptor is requested before it is returned to the caller.
3682 * On successful request the GPIO pin is configured in accordance with
3685 * In case of error an ERR_PTR() is returned.
3687 struct gpio_desc
*fwnode_gpiod_get_index(struct fwnode_handle
*fwnode
,
3688 const char *con_id
, int index
,
3689 enum gpiod_flags flags
,
3692 struct gpio_desc
*desc
;
3693 char prop_name
[32]; /* 32 is max size of property name */
3696 for (i
= 0; i
< ARRAY_SIZE(gpio_suffixes
); i
++) {
3698 snprintf(prop_name
, sizeof(prop_name
), "%s-%s",
3699 con_id
, gpio_suffixes
[i
]);
3701 snprintf(prop_name
, sizeof(prop_name
), "%s",
3704 desc
= fwnode_get_named_gpiod(fwnode
, prop_name
, index
, flags
,
3706 if (!gpiod_not_found(desc
))
3712 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index
);
3715 * gpiod_count - return the number of GPIOs associated with a device / function
3716 * or -ENOENT if no GPIO has been assigned to the requested function
3717 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3718 * @con_id: function within the GPIO consumer
3720 int gpiod_count(struct device
*dev
, const char *con_id
)
3722 const struct fwnode_handle
*fwnode
= dev
? dev_fwnode(dev
) : NULL
;
3723 int count
= -ENOENT
;
3725 if (is_of_node(fwnode
))
3726 count
= of_gpio_get_count(dev
, con_id
);
3727 else if (is_acpi_node(fwnode
))
3728 count
= acpi_gpio_count(dev
, con_id
);
3731 count
= platform_gpio_count(dev
, con_id
);
3735 EXPORT_SYMBOL_GPL(gpiod_count
);
3738 * gpiod_get - obtain a GPIO for a given GPIO function
3739 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3740 * @con_id: function within the GPIO consumer
3741 * @flags: optional GPIO initialization flags
3743 * Return the GPIO descriptor corresponding to the function con_id of device
3744 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3745 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3747 struct gpio_desc
*__must_check
gpiod_get(struct device
*dev
, const char *con_id
,
3748 enum gpiod_flags flags
)
3750 return gpiod_get_index(dev
, con_id
, 0, flags
);
3752 EXPORT_SYMBOL_GPL(gpiod_get
);
3755 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3756 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3757 * @con_id: function within the GPIO consumer
3758 * @flags: optional GPIO initialization flags
3760 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3761 * the requested function it will return NULL. This is convenient for drivers
3762 * that need to handle optional GPIOs.
3764 struct gpio_desc
*__must_check
gpiod_get_optional(struct device
*dev
,
3766 enum gpiod_flags flags
)
3768 return gpiod_get_index_optional(dev
, con_id
, 0, flags
);
3770 EXPORT_SYMBOL_GPL(gpiod_get_optional
);
3774 * gpiod_configure_flags - helper function to configure a given GPIO
3775 * @desc: gpio whose value will be assigned
3776 * @con_id: function within the GPIO consumer
3777 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3778 * of_find_gpio() or of_get_gpio_hog()
3779 * @dflags: gpiod_flags - optional GPIO initialization flags
3781 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3782 * requested function and/or index, or another IS_ERR() code if an error
3783 * occurred while trying to acquire the GPIO.
3785 int gpiod_configure_flags(struct gpio_desc
*desc
, const char *con_id
,
3786 unsigned long lflags
, enum gpiod_flags dflags
)
3790 if (lflags
& GPIO_ACTIVE_LOW
)
3791 set_bit(FLAG_ACTIVE_LOW
, &desc
->flags
);
3793 if (lflags
& GPIO_OPEN_DRAIN
)
3794 set_bit(FLAG_OPEN_DRAIN
, &desc
->flags
);
3795 else if (dflags
& GPIOD_FLAGS_BIT_OPEN_DRAIN
) {
3797 * This enforces open drain mode from the consumer side.
3798 * This is necessary for some busses like I2C, but the lookup
3799 * should *REALLY* have specified them as open drain in the
3800 * first place, so print a little warning here.
3802 set_bit(FLAG_OPEN_DRAIN
, &desc
->flags
);
3804 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
3807 if (lflags
& GPIO_OPEN_SOURCE
)
3808 set_bit(FLAG_OPEN_SOURCE
, &desc
->flags
);
3810 if ((lflags
& GPIO_PULL_UP
) && (lflags
& GPIO_PULL_DOWN
)) {
3812 "both pull-up and pull-down enabled, invalid configuration\n");
3816 if (lflags
& GPIO_PULL_UP
)
3817 set_bit(FLAG_PULL_UP
, &desc
->flags
);
3818 else if (lflags
& GPIO_PULL_DOWN
)
3819 set_bit(FLAG_PULL_DOWN
, &desc
->flags
);
3821 ret
= gpiod_set_transitory(desc
, (lflags
& GPIO_TRANSITORY
));
3825 /* No particular flag request, return here... */
3826 if (!(dflags
& GPIOD_FLAGS_BIT_DIR_SET
)) {
3827 gpiod_dbg(desc
, "no flags found for %s\n", con_id
);
3832 if (dflags
& GPIOD_FLAGS_BIT_DIR_OUT
)
3833 ret
= gpiod_direction_output(desc
,
3834 !!(dflags
& GPIOD_FLAGS_BIT_DIR_VAL
));
3836 ret
= gpiod_direction_input(desc
);
3842 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3843 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3844 * @con_id: function within the GPIO consumer
3845 * @idx: index of the GPIO to obtain in the consumer
3846 * @flags: optional GPIO initialization flags
3848 * This variant of gpiod_get() allows to access GPIOs other than the first
3849 * defined one for functions that define several GPIOs.
3851 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3852 * requested function and/or index, or another IS_ERR() code if an error
3853 * occurred while trying to acquire the GPIO.
3855 struct gpio_desc
*__must_check
gpiod_get_index(struct device
*dev
,
3858 enum gpiod_flags flags
)
3860 unsigned long lookupflags
= GPIO_LOOKUP_FLAGS_DEFAULT
;
3861 struct gpio_desc
*desc
= NULL
;
3863 /* Maybe we have a device name, maybe not */
3864 const char *devname
= dev
? dev_name(dev
) : "?";
3865 const struct fwnode_handle
*fwnode
= dev
? dev_fwnode(dev
) : NULL
;
3867 dev_dbg(dev
, "GPIO lookup for consumer %s\n", con_id
);
3869 /* Using device tree? */
3870 if (is_of_node(fwnode
)) {
3871 dev_dbg(dev
, "using device tree for GPIO lookup\n");
3872 desc
= of_find_gpio(dev
, con_id
, idx
, &lookupflags
);
3873 } else if (is_acpi_node(fwnode
)) {
3874 dev_dbg(dev
, "using ACPI for GPIO lookup\n");
3875 desc
= acpi_find_gpio(dev
, con_id
, idx
, &flags
, &lookupflags
);
3879 * Either we are not using DT or ACPI, or their lookup did not return
3880 * a result. In that case, use platform lookup as a fallback.
3882 if (!desc
|| gpiod_not_found(desc
)) {
3883 dev_dbg(dev
, "using lookup tables for GPIO lookup\n");
3884 desc
= gpiod_find(dev
, con_id
, idx
, &lookupflags
);
3888 dev_dbg(dev
, "No GPIO consumer %s found\n", con_id
);
3893 * If a connection label was passed use that, else attempt to use
3894 * the device name as label
3896 ret
= gpiod_request(desc
, con_id
? con_id
: devname
);
3898 if (ret
== -EBUSY
&& flags
& GPIOD_FLAGS_BIT_NONEXCLUSIVE
) {
3900 * This happens when there are several consumers for
3901 * the same GPIO line: we just return here without
3902 * further initialization. It is a bit if a hack.
3903 * This is necessary to support fixed regulators.
3905 * FIXME: Make this more sane and safe.
3907 dev_info(dev
, "nonexclusive access to GPIO for %s\n",
3908 con_id
? con_id
: devname
);
3911 return ERR_PTR(ret
);
3915 ret
= gpiod_configure_flags(desc
, con_id
, lookupflags
, flags
);
3917 dev_dbg(dev
, "setup of GPIO %s failed\n", con_id
);
3919 return ERR_PTR(ret
);
3922 blocking_notifier_call_chain(&desc
->gdev
->notifier
,
3923 GPIOLINE_CHANGED_REQUESTED
, desc
);
3927 EXPORT_SYMBOL_GPL(gpiod_get_index
);
3930 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3931 * @fwnode: handle of the firmware node
3932 * @propname: name of the firmware property representing the GPIO
3933 * @index: index of the GPIO to obtain for the consumer
3934 * @dflags: GPIO initialization flags
3935 * @label: label to attach to the requested GPIO
3937 * This function can be used for drivers that get their configuration
3938 * from opaque firmware.
3940 * The function properly finds the corresponding GPIO using whatever is the
3941 * underlying firmware interface and then makes sure that the GPIO
3942 * descriptor is requested before it is returned to the caller.
3945 * On successful request the GPIO pin is configured in accordance with
3948 * In case of error an ERR_PTR() is returned.
3950 struct gpio_desc
*fwnode_get_named_gpiod(struct fwnode_handle
*fwnode
,
3951 const char *propname
, int index
,
3952 enum gpiod_flags dflags
,
3955 unsigned long lflags
= GPIO_LOOKUP_FLAGS_DEFAULT
;
3956 struct gpio_desc
*desc
= ERR_PTR(-ENODEV
);
3959 if (is_of_node(fwnode
)) {
3960 desc
= gpiod_get_from_of_node(to_of_node(fwnode
),
3965 } else if (is_acpi_node(fwnode
)) {
3966 struct acpi_gpio_info info
;
3968 desc
= acpi_node_get_gpiod(fwnode
, propname
, index
, &info
);
3972 acpi_gpio_update_gpiod_flags(&dflags
, &info
);
3973 acpi_gpio_update_gpiod_lookup_flags(&lflags
, &info
);
3975 return ERR_PTR(-EINVAL
);
3977 /* Currently only ACPI takes this path */
3978 ret
= gpiod_request(desc
, label
);
3980 return ERR_PTR(ret
);
3982 ret
= gpiod_configure_flags(desc
, propname
, lflags
, dflags
);
3985 return ERR_PTR(ret
);
3988 blocking_notifier_call_chain(&desc
->gdev
->notifier
,
3989 GPIOLINE_CHANGED_REQUESTED
, desc
);
3993 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod
);
3996 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3998 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3999 * @con_id: function within the GPIO consumer
4000 * @index: index of the GPIO to obtain in the consumer
4001 * @flags: optional GPIO initialization flags
4003 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
4004 * specified index was assigned to the requested function it will return NULL.
4005 * This is convenient for drivers that need to handle optional GPIOs.
4007 struct gpio_desc
*__must_check
gpiod_get_index_optional(struct device
*dev
,
4010 enum gpiod_flags flags
)
4012 struct gpio_desc
*desc
;
4014 desc
= gpiod_get_index(dev
, con_id
, index
, flags
);
4015 if (gpiod_not_found(desc
))
4020 EXPORT_SYMBOL_GPL(gpiod_get_index_optional
);
4023 * gpiod_hog - Hog the specified GPIO desc given the provided flags
4024 * @desc: gpio whose value will be assigned
4025 * @name: gpio line name
4026 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
4027 * of_find_gpio() or of_get_gpio_hog()
4028 * @dflags: gpiod_flags - optional GPIO initialization flags
4030 int gpiod_hog(struct gpio_desc
*desc
, const char *name
,
4031 unsigned long lflags
, enum gpiod_flags dflags
)
4033 struct gpio_chip
*gc
;
4034 struct gpio_desc
*local_desc
;
4038 gc
= gpiod_to_chip(desc
);
4039 hwnum
= gpio_chip_hwgpio(desc
);
4041 local_desc
= gpiochip_request_own_desc(gc
, hwnum
, name
,
4043 if (IS_ERR(local_desc
)) {
4044 ret
= PTR_ERR(local_desc
);
4045 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4046 name
, gc
->label
, hwnum
, ret
);
4050 /* Mark GPIO as hogged so it can be identified and removed later */
4051 set_bit(FLAG_IS_HOGGED
, &desc
->flags
);
4053 gpiod_info(desc
, "hogged as %s%s\n",
4054 (dflags
& GPIOD_FLAGS_BIT_DIR_OUT
) ? "output" : "input",
4055 (dflags
& GPIOD_FLAGS_BIT_DIR_OUT
) ?
4056 (dflags
& GPIOD_FLAGS_BIT_DIR_VAL
) ? "/high" : "/low" : "");
4062 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4063 * @gc: gpio chip to act on
4065 static void gpiochip_free_hogs(struct gpio_chip
*gc
)
4069 for (id
= 0; id
< gc
->ngpio
; id
++) {
4070 if (test_bit(FLAG_IS_HOGGED
, &gc
->gpiodev
->descs
[id
].flags
))
4071 gpiochip_free_own_desc(&gc
->gpiodev
->descs
[id
]);
4076 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4077 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4078 * @con_id: function within the GPIO consumer
4079 * @flags: optional GPIO initialization flags
4081 * This function acquires all the GPIOs defined under a given function.
4083 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4084 * no GPIO has been assigned to the requested function, or another IS_ERR()
4085 * code if an error occurred while trying to acquire the GPIOs.
4087 struct gpio_descs
*__must_check
gpiod_get_array(struct device
*dev
,
4089 enum gpiod_flags flags
)
4091 struct gpio_desc
*desc
;
4092 struct gpio_descs
*descs
;
4093 struct gpio_array
*array_info
= NULL
;
4094 struct gpio_chip
*gc
;
4095 int count
, bitmap_size
;
4097 count
= gpiod_count(dev
, con_id
);
4099 return ERR_PTR(count
);
4101 descs
= kzalloc(struct_size(descs
, desc
, count
), GFP_KERNEL
);
4103 return ERR_PTR(-ENOMEM
);
4105 for (descs
->ndescs
= 0; descs
->ndescs
< count
; ) {
4106 desc
= gpiod_get_index(dev
, con_id
, descs
->ndescs
, flags
);
4108 gpiod_put_array(descs
);
4109 return ERR_CAST(desc
);
4112 descs
->desc
[descs
->ndescs
] = desc
;
4114 gc
= gpiod_to_chip(desc
);
4116 * If pin hardware number of array member 0 is also 0, select
4117 * its chip as a candidate for fast bitmap processing path.
4119 if (descs
->ndescs
== 0 && gpio_chip_hwgpio(desc
) == 0) {
4120 struct gpio_descs
*array
;
4122 bitmap_size
= BITS_TO_LONGS(gc
->ngpio
> count
?
4125 array
= kzalloc(struct_size(descs
, desc
, count
) +
4126 struct_size(array_info
, invert_mask
,
4127 3 * bitmap_size
), GFP_KERNEL
);
4129 gpiod_put_array(descs
);
4130 return ERR_PTR(-ENOMEM
);
4133 memcpy(array
, descs
,
4134 struct_size(descs
, desc
, descs
->ndescs
+ 1));
4138 array_info
= (void *)(descs
->desc
+ count
);
4139 array_info
->get_mask
= array_info
->invert_mask
+
4141 array_info
->set_mask
= array_info
->get_mask
+
4144 array_info
->desc
= descs
->desc
;
4145 array_info
->size
= count
;
4146 array_info
->chip
= gc
;
4147 bitmap_set(array_info
->get_mask
, descs
->ndescs
,
4148 count
- descs
->ndescs
);
4149 bitmap_set(array_info
->set_mask
, descs
->ndescs
,
4150 count
- descs
->ndescs
);
4151 descs
->info
= array_info
;
4153 /* Unmark array members which don't belong to the 'fast' chip */
4154 if (array_info
&& array_info
->chip
!= gc
) {
4155 __clear_bit(descs
->ndescs
, array_info
->get_mask
);
4156 __clear_bit(descs
->ndescs
, array_info
->set_mask
);
4159 * Detect array members which belong to the 'fast' chip
4160 * but their pins are not in hardware order.
4162 else if (array_info
&&
4163 gpio_chip_hwgpio(desc
) != descs
->ndescs
) {
4165 * Don't use fast path if all array members processed so
4166 * far belong to the same chip as this one but its pin
4167 * hardware number is different from its array index.
4169 if (bitmap_full(array_info
->get_mask
, descs
->ndescs
)) {
4172 __clear_bit(descs
->ndescs
,
4173 array_info
->get_mask
);
4174 __clear_bit(descs
->ndescs
,
4175 array_info
->set_mask
);
4177 } else if (array_info
) {
4178 /* Exclude open drain or open source from fast output */
4179 if (gpiochip_line_is_open_drain(gc
, descs
->ndescs
) ||
4180 gpiochip_line_is_open_source(gc
, descs
->ndescs
))
4181 __clear_bit(descs
->ndescs
,
4182 array_info
->set_mask
);
4183 /* Identify 'fast' pins which require invertion */
4184 if (gpiod_is_active_low(desc
))
4185 __set_bit(descs
->ndescs
,
4186 array_info
->invert_mask
);
4193 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4194 array_info
->chip
->label
, array_info
->size
,
4195 *array_info
->get_mask
, *array_info
->set_mask
,
4196 *array_info
->invert_mask
);
4199 EXPORT_SYMBOL_GPL(gpiod_get_array
);
4202 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4204 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4205 * @con_id: function within the GPIO consumer
4206 * @flags: optional GPIO initialization flags
4208 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4209 * assigned to the requested function it will return NULL.
4211 struct gpio_descs
*__must_check
gpiod_get_array_optional(struct device
*dev
,
4213 enum gpiod_flags flags
)
4215 struct gpio_descs
*descs
;
4217 descs
= gpiod_get_array(dev
, con_id
, flags
);
4218 if (gpiod_not_found(descs
))
4223 EXPORT_SYMBOL_GPL(gpiod_get_array_optional
);
4226 * gpiod_put - dispose of a GPIO descriptor
4227 * @desc: GPIO descriptor to dispose of
4229 * No descriptor can be used after gpiod_put() has been called on it.
4231 void gpiod_put(struct gpio_desc
*desc
)
4236 EXPORT_SYMBOL_GPL(gpiod_put
);
4239 * gpiod_put_array - dispose of multiple GPIO descriptors
4240 * @descs: struct gpio_descs containing an array of descriptors
4242 void gpiod_put_array(struct gpio_descs
*descs
)
4246 for (i
= 0; i
< descs
->ndescs
; i
++)
4247 gpiod_put(descs
->desc
[i
]);
4251 EXPORT_SYMBOL_GPL(gpiod_put_array
);
4254 static int gpio_bus_match(struct device
*dev
, struct device_driver
*drv
)
4256 struct fwnode_handle
*fwnode
= dev_fwnode(dev
);
4259 * Only match if the fwnode doesn't already have a proper struct device
4262 if (fwnode
&& fwnode
->dev
!= dev
)
4267 static int gpio_stub_drv_probe(struct device
*dev
)
4270 * The DT node of some GPIO chips have a "compatible" property, but
4271 * never have a struct device added and probed by a driver to register
4272 * the GPIO chip with gpiolib. In such cases, fw_devlink=on will cause
4273 * the consumers of the GPIO chip to get probe deferred forever because
4274 * they will be waiting for a device associated with the GPIO chip
4275 * firmware node to get added and bound to a driver.
4277 * To allow these consumers to probe, we associate the struct
4278 * gpio_device of the GPIO chip with the firmware node and then simply
4279 * bind it to this stub driver.
4284 static struct device_driver gpio_stub_drv
= {
4285 .name
= "gpio_stub_drv",
4286 .bus
= &gpio_bus_type
,
4287 .probe
= gpio_stub_drv_probe
,
4290 static int __init
gpiolib_dev_init(void)
4294 /* Register GPIO sysfs bus */
4295 ret
= bus_register(&gpio_bus_type
);
4297 pr_err("gpiolib: could not register GPIO bus type\n");
4301 ret
= driver_register(&gpio_stub_drv
);
4303 pr_err("gpiolib: could not register GPIO stub driver\n");
4304 bus_unregister(&gpio_bus_type
);
4308 ret
= alloc_chrdev_region(&gpio_devt
, 0, GPIO_DEV_MAX
, GPIOCHIP_NAME
);
4310 pr_err("gpiolib: failed to allocate char dev region\n");
4311 driver_unregister(&gpio_stub_drv
);
4312 bus_unregister(&gpio_bus_type
);
4316 gpiolib_initialized
= true;
4317 gpiochip_setup_devs();
4319 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4320 WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier
));
4321 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4325 core_initcall(gpiolib_dev_init
);
4327 #ifdef CONFIG_DEBUG_FS
4329 static void gpiolib_dbg_show(struct seq_file
*s
, struct gpio_device
*gdev
)
4332 struct gpio_chip
*gc
= gdev
->chip
;
4333 unsigned gpio
= gdev
->base
;
4334 struct gpio_desc
*gdesc
= &gdev
->descs
[0];
4339 for (i
= 0; i
< gdev
->ngpio
; i
++, gpio
++, gdesc
++) {
4340 if (!test_bit(FLAG_REQUESTED
, &gdesc
->flags
)) {
4342 seq_printf(s
, " gpio-%-3d (%-20.20s)\n",
4348 gpiod_get_direction(gdesc
);
4349 is_out
= test_bit(FLAG_IS_OUT
, &gdesc
->flags
);
4350 is_irq
= test_bit(FLAG_USED_AS_IRQ
, &gdesc
->flags
);
4351 active_low
= test_bit(FLAG_ACTIVE_LOW
, &gdesc
->flags
);
4352 seq_printf(s
, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s",
4353 gpio
, gdesc
->name
? gdesc
->name
: "", gdesc
->label
,
4354 is_out
? "out" : "in ",
4355 gc
->get
? (gc
->get(gc
, i
) ? "hi" : "lo") : "? ",
4356 is_irq
? "IRQ " : "",
4357 active_low
? "ACTIVE LOW" : "");
4358 seq_printf(s
, "\n");
4362 static void *gpiolib_seq_start(struct seq_file
*s
, loff_t
*pos
)
4364 unsigned long flags
;
4365 struct gpio_device
*gdev
= NULL
;
4366 loff_t index
= *pos
;
4370 spin_lock_irqsave(&gpio_lock
, flags
);
4371 list_for_each_entry(gdev
, &gpio_devices
, list
)
4373 spin_unlock_irqrestore(&gpio_lock
, flags
);
4376 spin_unlock_irqrestore(&gpio_lock
, flags
);
4381 static void *gpiolib_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
4383 unsigned long flags
;
4384 struct gpio_device
*gdev
= v
;
4387 spin_lock_irqsave(&gpio_lock
, flags
);
4388 if (list_is_last(&gdev
->list
, &gpio_devices
))
4391 ret
= list_entry(gdev
->list
.next
, struct gpio_device
, list
);
4392 spin_unlock_irqrestore(&gpio_lock
, flags
);
4400 static void gpiolib_seq_stop(struct seq_file
*s
, void *v
)
4404 static int gpiolib_seq_show(struct seq_file
*s
, void *v
)
4406 struct gpio_device
*gdev
= v
;
4407 struct gpio_chip
*gc
= gdev
->chip
;
4408 struct device
*parent
;
4411 seq_printf(s
, "%s%s: (dangling chip)", (char *)s
->private,
4412 dev_name(&gdev
->dev
));
4416 seq_printf(s
, "%s%s: GPIOs %d-%d", (char *)s
->private,
4417 dev_name(&gdev
->dev
),
4418 gdev
->base
, gdev
->base
+ gdev
->ngpio
- 1);
4419 parent
= gc
->parent
;
4421 seq_printf(s
, ", parent: %s/%s",
4422 parent
->bus
? parent
->bus
->name
: "no-bus",
4425 seq_printf(s
, ", %s", gc
->label
);
4427 seq_printf(s
, ", can sleep");
4428 seq_printf(s
, ":\n");
4431 gc
->dbg_show(s
, gc
);
4433 gpiolib_dbg_show(s
, gdev
);
4438 static const struct seq_operations gpiolib_sops
= {
4439 .start
= gpiolib_seq_start
,
4440 .next
= gpiolib_seq_next
,
4441 .stop
= gpiolib_seq_stop
,
4442 .show
= gpiolib_seq_show
,
4444 DEFINE_SEQ_ATTRIBUTE(gpiolib
);
4446 static int __init
gpiolib_debugfs_init(void)
4448 /* /sys/kernel/debug/gpio */
4449 debugfs_create_file("gpio", 0444, NULL
, NULL
, &gpiolib_fops
);
4452 subsys_initcall(gpiolib_debugfs_init
);
4454 #endif /* DEBUG_FS */