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