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