b.liu | e958203 | 2025-04-17 19:18:16 +0800 | [diff] [blame^] | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
| 2 | /* |
| 3 | * Reset Controller framework |
| 4 | * |
| 5 | * Copyright 2013 Philipp Zabel, Pengutronix |
| 6 | */ |
| 7 | #include <linux/atomic.h> |
| 8 | #include <linux/device.h> |
| 9 | #include <linux/err.h> |
| 10 | #include <linux/export.h> |
| 11 | #include <linux/kernel.h> |
| 12 | #include <linux/kref.h> |
| 13 | #include <linux/module.h> |
| 14 | #include <linux/of.h> |
| 15 | #include <linux/reset.h> |
| 16 | #include <linux/reset-controller.h> |
| 17 | #include <linux/slab.h> |
| 18 | |
| 19 | static DEFINE_MUTEX(reset_list_mutex); |
| 20 | static LIST_HEAD(reset_controller_list); |
| 21 | |
| 22 | static DEFINE_MUTEX(reset_lookup_mutex); |
| 23 | static LIST_HEAD(reset_lookup_list); |
| 24 | |
| 25 | /** |
| 26 | * struct reset_control - a reset control |
| 27 | * @rcdev: a pointer to the reset controller device |
| 28 | * this reset control belongs to |
| 29 | * @list: list entry for the rcdev's reset controller list |
| 30 | * @id: ID of the reset controller in the reset |
| 31 | * controller device |
| 32 | * @refcnt: Number of gets of this reset_control |
| 33 | * @acquired: Only one reset_control may be acquired for a given rcdev and id. |
| 34 | * @shared: Is this a shared (1), or an exclusive (0) reset_control? |
| 35 | * @deassert_cnt: Number of times this reset line has been deasserted |
| 36 | * @triggered_count: Number of times this reset line has been reset. Currently |
| 37 | * only used for shared resets, which means that the value |
| 38 | * will be either 0 or 1. |
| 39 | */ |
| 40 | struct reset_control { |
| 41 | struct reset_controller_dev *rcdev; |
| 42 | struct list_head list; |
| 43 | unsigned int id; |
| 44 | struct kref refcnt; |
| 45 | bool acquired; |
| 46 | bool shared; |
| 47 | bool array; |
| 48 | atomic_t deassert_count; |
| 49 | atomic_t triggered_count; |
| 50 | }; |
| 51 | |
| 52 | /** |
| 53 | * struct reset_control_array - an array of reset controls |
| 54 | * @base: reset control for compatibility with reset control API functions |
| 55 | * @num_rstcs: number of reset controls |
| 56 | * @rstc: array of reset controls |
| 57 | */ |
| 58 | struct reset_control_array { |
| 59 | struct reset_control base; |
| 60 | unsigned int num_rstcs; |
| 61 | struct reset_control *rstc[]; |
| 62 | }; |
| 63 | |
| 64 | static const char *rcdev_name(struct reset_controller_dev *rcdev) |
| 65 | { |
| 66 | if (rcdev->dev) |
| 67 | return dev_name(rcdev->dev); |
| 68 | |
| 69 | if (rcdev->of_node) |
| 70 | return rcdev->of_node->full_name; |
| 71 | |
| 72 | return NULL; |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * of_reset_simple_xlate - translate reset_spec to the reset line number |
| 77 | * @rcdev: a pointer to the reset controller device |
| 78 | * @reset_spec: reset line specifier as found in the device tree |
| 79 | * |
| 80 | * This simple translation function should be used for reset controllers |
| 81 | * with 1:1 mapping, where reset lines can be indexed by number without gaps. |
| 82 | */ |
| 83 | static int of_reset_simple_xlate(struct reset_controller_dev *rcdev, |
| 84 | const struct of_phandle_args *reset_spec) |
| 85 | { |
| 86 | if (reset_spec->args[0] >= rcdev->nr_resets) |
| 87 | return -EINVAL; |
| 88 | |
| 89 | return reset_spec->args[0]; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * reset_controller_register - register a reset controller device |
| 94 | * @rcdev: a pointer to the initialized reset controller device |
| 95 | */ |
| 96 | int reset_controller_register(struct reset_controller_dev *rcdev) |
| 97 | { |
| 98 | if (!rcdev->of_xlate) { |
| 99 | rcdev->of_reset_n_cells = 1; |
| 100 | rcdev->of_xlate = of_reset_simple_xlate; |
| 101 | } |
| 102 | |
| 103 | INIT_LIST_HEAD(&rcdev->reset_control_head); |
| 104 | |
| 105 | mutex_lock(&reset_list_mutex); |
| 106 | list_add(&rcdev->list, &reset_controller_list); |
| 107 | mutex_unlock(&reset_list_mutex); |
| 108 | |
| 109 | return 0; |
| 110 | } |
| 111 | EXPORT_SYMBOL_GPL(reset_controller_register); |
| 112 | |
| 113 | /** |
| 114 | * reset_controller_unregister - unregister a reset controller device |
| 115 | * @rcdev: a pointer to the reset controller device |
| 116 | */ |
| 117 | void reset_controller_unregister(struct reset_controller_dev *rcdev) |
| 118 | { |
| 119 | mutex_lock(&reset_list_mutex); |
| 120 | list_del(&rcdev->list); |
| 121 | mutex_unlock(&reset_list_mutex); |
| 122 | } |
| 123 | EXPORT_SYMBOL_GPL(reset_controller_unregister); |
| 124 | |
| 125 | static void devm_reset_controller_release(struct device *dev, void *res) |
| 126 | { |
| 127 | reset_controller_unregister(*(struct reset_controller_dev **)res); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * devm_reset_controller_register - resource managed reset_controller_register() |
| 132 | * @dev: device that is registering this reset controller |
| 133 | * @rcdev: a pointer to the initialized reset controller device |
| 134 | * |
| 135 | * Managed reset_controller_register(). For reset controllers registered by |
| 136 | * this function, reset_controller_unregister() is automatically called on |
| 137 | * driver detach. See reset_controller_register() for more information. |
| 138 | */ |
| 139 | int devm_reset_controller_register(struct device *dev, |
| 140 | struct reset_controller_dev *rcdev) |
| 141 | { |
| 142 | struct reset_controller_dev **rcdevp; |
| 143 | int ret; |
| 144 | |
| 145 | rcdevp = devres_alloc(devm_reset_controller_release, sizeof(*rcdevp), |
| 146 | GFP_KERNEL); |
| 147 | if (!rcdevp) |
| 148 | return -ENOMEM; |
| 149 | |
| 150 | ret = reset_controller_register(rcdev); |
| 151 | if (!ret) { |
| 152 | *rcdevp = rcdev; |
| 153 | devres_add(dev, rcdevp); |
| 154 | } else { |
| 155 | devres_free(rcdevp); |
| 156 | } |
| 157 | |
| 158 | return ret; |
| 159 | } |
| 160 | EXPORT_SYMBOL_GPL(devm_reset_controller_register); |
| 161 | |
| 162 | /** |
| 163 | * reset_controller_add_lookup - register a set of lookup entries |
| 164 | * @lookup: array of reset lookup entries |
| 165 | * @num_entries: number of entries in the lookup array |
| 166 | */ |
| 167 | void reset_controller_add_lookup(struct reset_control_lookup *lookup, |
| 168 | unsigned int num_entries) |
| 169 | { |
| 170 | struct reset_control_lookup *entry; |
| 171 | unsigned int i; |
| 172 | |
| 173 | mutex_lock(&reset_lookup_mutex); |
| 174 | for (i = 0; i < num_entries; i++) { |
| 175 | entry = &lookup[i]; |
| 176 | |
| 177 | if (!entry->dev_id || !entry->provider) { |
| 178 | pr_warn("%s(): reset lookup entry badly specified, skipping\n", |
| 179 | __func__); |
| 180 | continue; |
| 181 | } |
| 182 | |
| 183 | list_add_tail(&entry->list, &reset_lookup_list); |
| 184 | } |
| 185 | mutex_unlock(&reset_lookup_mutex); |
| 186 | } |
| 187 | EXPORT_SYMBOL_GPL(reset_controller_add_lookup); |
| 188 | |
| 189 | static inline struct reset_control_array * |
| 190 | rstc_to_array(struct reset_control *rstc) { |
| 191 | return container_of(rstc, struct reset_control_array, base); |
| 192 | } |
| 193 | |
| 194 | static int reset_control_array_reset(struct reset_control_array *resets) |
| 195 | { |
| 196 | int ret, i; |
| 197 | |
| 198 | for (i = 0; i < resets->num_rstcs; i++) { |
| 199 | ret = reset_control_reset(resets->rstc[i]); |
| 200 | if (ret) |
| 201 | return ret; |
| 202 | } |
| 203 | |
| 204 | return 0; |
| 205 | } |
| 206 | |
| 207 | static int reset_control_array_assert(struct reset_control_array *resets) |
| 208 | { |
| 209 | int ret, i; |
| 210 | |
| 211 | for (i = 0; i < resets->num_rstcs; i++) { |
| 212 | ret = reset_control_assert(resets->rstc[i]); |
| 213 | if (ret) |
| 214 | goto err; |
| 215 | } |
| 216 | |
| 217 | return 0; |
| 218 | |
| 219 | err: |
| 220 | while (i--) |
| 221 | reset_control_deassert(resets->rstc[i]); |
| 222 | return ret; |
| 223 | } |
| 224 | |
| 225 | static int reset_control_array_deassert(struct reset_control_array *resets) |
| 226 | { |
| 227 | int ret, i; |
| 228 | |
| 229 | for (i = 0; i < resets->num_rstcs; i++) { |
| 230 | ret = reset_control_deassert(resets->rstc[i]); |
| 231 | if (ret) |
| 232 | goto err; |
| 233 | } |
| 234 | |
| 235 | return 0; |
| 236 | |
| 237 | err: |
| 238 | while (i--) |
| 239 | reset_control_assert(resets->rstc[i]); |
| 240 | return ret; |
| 241 | } |
| 242 | |
| 243 | static int reset_control_array_acquire(struct reset_control_array *resets) |
| 244 | { |
| 245 | unsigned int i; |
| 246 | int err; |
| 247 | |
| 248 | for (i = 0; i < resets->num_rstcs; i++) { |
| 249 | err = reset_control_acquire(resets->rstc[i]); |
| 250 | if (err < 0) |
| 251 | goto release; |
| 252 | } |
| 253 | |
| 254 | return 0; |
| 255 | |
| 256 | release: |
| 257 | while (i--) |
| 258 | reset_control_release(resets->rstc[i]); |
| 259 | |
| 260 | return err; |
| 261 | } |
| 262 | |
| 263 | static void reset_control_array_release(struct reset_control_array *resets) |
| 264 | { |
| 265 | unsigned int i; |
| 266 | |
| 267 | for (i = 0; i < resets->num_rstcs; i++) |
| 268 | reset_control_release(resets->rstc[i]); |
| 269 | } |
| 270 | |
| 271 | static inline bool reset_control_is_array(struct reset_control *rstc) |
| 272 | { |
| 273 | return rstc->array; |
| 274 | } |
| 275 | |
| 276 | /** |
| 277 | * reset_control_reset - reset the controlled device |
| 278 | * @rstc: reset controller |
| 279 | * |
| 280 | * On a shared reset line the actual reset pulse is only triggered once for the |
| 281 | * lifetime of the reset_control instance: for all but the first caller this is |
| 282 | * a no-op. |
| 283 | * Consumers must not use reset_control_(de)assert on shared reset lines when |
| 284 | * reset_control_reset has been used. |
| 285 | * |
| 286 | * If rstc is NULL it is an optional reset and the function will just |
| 287 | * return 0. |
| 288 | */ |
| 289 | int reset_control_reset(struct reset_control *rstc) |
| 290 | { |
| 291 | int ret; |
| 292 | |
| 293 | if (!rstc) |
| 294 | return 0; |
| 295 | |
| 296 | if (WARN_ON(IS_ERR(rstc))) |
| 297 | return -EINVAL; |
| 298 | |
| 299 | if (reset_control_is_array(rstc)) |
| 300 | return reset_control_array_reset(rstc_to_array(rstc)); |
| 301 | |
| 302 | if (!rstc->rcdev->ops->reset) |
| 303 | return -ENOTSUPP; |
| 304 | |
| 305 | if (rstc->shared) { |
| 306 | if (WARN_ON(atomic_read(&rstc->deassert_count) != 0)) |
| 307 | return -EINVAL; |
| 308 | |
| 309 | if (atomic_inc_return(&rstc->triggered_count) != 1) |
| 310 | return 0; |
| 311 | } else { |
| 312 | if (!rstc->acquired) |
| 313 | return -EPERM; |
| 314 | } |
| 315 | |
| 316 | ret = rstc->rcdev->ops->reset(rstc->rcdev, rstc->id); |
| 317 | if (rstc->shared && ret) |
| 318 | atomic_dec(&rstc->triggered_count); |
| 319 | |
| 320 | return ret; |
| 321 | } |
| 322 | EXPORT_SYMBOL_GPL(reset_control_reset); |
| 323 | |
| 324 | /** |
| 325 | * reset_control_assert - asserts the reset line |
| 326 | * @rstc: reset controller |
| 327 | * |
| 328 | * Calling this on an exclusive reset controller guarantees that the reset |
| 329 | * will be asserted. When called on a shared reset controller the line may |
| 330 | * still be deasserted, as long as other users keep it so. |
| 331 | * |
| 332 | * For shared reset controls a driver cannot expect the hw's registers and |
| 333 | * internal state to be reset, but must be prepared for this to happen. |
| 334 | * Consumers must not use reset_control_reset on shared reset lines when |
| 335 | * reset_control_(de)assert has been used. |
| 336 | * return 0. |
| 337 | * |
| 338 | * If rstc is NULL it is an optional reset and the function will just |
| 339 | * return 0. |
| 340 | */ |
| 341 | int reset_control_assert(struct reset_control *rstc) |
| 342 | { |
| 343 | if (!rstc) |
| 344 | return 0; |
| 345 | |
| 346 | if (WARN_ON(IS_ERR(rstc))) |
| 347 | return -EINVAL; |
| 348 | |
| 349 | if (reset_control_is_array(rstc)) |
| 350 | return reset_control_array_assert(rstc_to_array(rstc)); |
| 351 | |
| 352 | if (rstc->shared) { |
| 353 | if (WARN_ON(atomic_read(&rstc->triggered_count) != 0)) |
| 354 | return -EINVAL; |
| 355 | |
| 356 | if (WARN_ON(atomic_read(&rstc->deassert_count) == 0)) |
| 357 | return -EINVAL; |
| 358 | |
| 359 | if (atomic_dec_return(&rstc->deassert_count) != 0) |
| 360 | return 0; |
| 361 | |
| 362 | /* |
| 363 | * Shared reset controls allow the reset line to be in any state |
| 364 | * after this call, so doing nothing is a valid option. |
| 365 | */ |
| 366 | if (!rstc->rcdev->ops->assert) |
| 367 | return 0; |
| 368 | } else { |
| 369 | /* |
| 370 | * If the reset controller does not implement .assert(), there |
| 371 | * is no way to guarantee that the reset line is asserted after |
| 372 | * this call. |
| 373 | */ |
| 374 | if (!rstc->rcdev->ops->assert) |
| 375 | return -ENOTSUPP; |
| 376 | |
| 377 | if (!rstc->acquired) { |
| 378 | WARN(1, "reset %s (ID: %u) is not acquired\n", |
| 379 | rcdev_name(rstc->rcdev), rstc->id); |
| 380 | return -EPERM; |
| 381 | } |
| 382 | } |
| 383 | |
| 384 | return rstc->rcdev->ops->assert(rstc->rcdev, rstc->id); |
| 385 | } |
| 386 | EXPORT_SYMBOL_GPL(reset_control_assert); |
| 387 | |
| 388 | /** |
| 389 | * reset_control_deassert - deasserts the reset line |
| 390 | * @rstc: reset controller |
| 391 | * |
| 392 | * After calling this function, the reset is guaranteed to be deasserted. |
| 393 | * Consumers must not use reset_control_reset on shared reset lines when |
| 394 | * reset_control_(de)assert has been used. |
| 395 | * return 0. |
| 396 | * |
| 397 | * If rstc is NULL it is an optional reset and the function will just |
| 398 | * return 0. |
| 399 | */ |
| 400 | int reset_control_deassert(struct reset_control *rstc) |
| 401 | { |
| 402 | if (!rstc) |
| 403 | return 0; |
| 404 | |
| 405 | if (WARN_ON(IS_ERR(rstc))) |
| 406 | return -EINVAL; |
| 407 | |
| 408 | if (reset_control_is_array(rstc)) |
| 409 | return reset_control_array_deassert(rstc_to_array(rstc)); |
| 410 | |
| 411 | if (rstc->shared) { |
| 412 | if (WARN_ON(atomic_read(&rstc->triggered_count) != 0)) |
| 413 | return -EINVAL; |
| 414 | |
| 415 | if (atomic_inc_return(&rstc->deassert_count) != 1) |
| 416 | return 0; |
| 417 | } else { |
| 418 | if (!rstc->acquired) { |
| 419 | WARN(1, "reset %s (ID: %u) is not acquired\n", |
| 420 | rcdev_name(rstc->rcdev), rstc->id); |
| 421 | return -EPERM; |
| 422 | } |
| 423 | } |
| 424 | |
| 425 | /* |
| 426 | * If the reset controller does not implement .deassert(), we assume |
| 427 | * that it handles self-deasserting reset lines via .reset(). In that |
| 428 | * case, the reset lines are deasserted by default. If that is not the |
| 429 | * case, the reset controller driver should implement .deassert() and |
| 430 | * return -ENOTSUPP. |
| 431 | */ |
| 432 | if (!rstc->rcdev->ops->deassert) |
| 433 | return 0; |
| 434 | |
| 435 | return rstc->rcdev->ops->deassert(rstc->rcdev, rstc->id); |
| 436 | } |
| 437 | EXPORT_SYMBOL_GPL(reset_control_deassert); |
| 438 | |
| 439 | /** |
| 440 | * reset_control_status - returns a negative errno if not supported, a |
| 441 | * positive value if the reset line is asserted, or zero if the reset |
| 442 | * line is not asserted or if the desc is NULL (optional reset). |
| 443 | * @rstc: reset controller |
| 444 | */ |
| 445 | int reset_control_status(struct reset_control *rstc) |
| 446 | { |
| 447 | if (!rstc) |
| 448 | return 0; |
| 449 | |
| 450 | if (WARN_ON(IS_ERR(rstc)) || reset_control_is_array(rstc)) |
| 451 | return -EINVAL; |
| 452 | |
| 453 | if (rstc->rcdev->ops->status) |
| 454 | return rstc->rcdev->ops->status(rstc->rcdev, rstc->id); |
| 455 | |
| 456 | return -ENOTSUPP; |
| 457 | } |
| 458 | EXPORT_SYMBOL_GPL(reset_control_status); |
| 459 | |
| 460 | /** |
| 461 | * reset_control_acquire() - acquires a reset control for exclusive use |
| 462 | * @rstc: reset control |
| 463 | * |
| 464 | * This is used to explicitly acquire a reset control for exclusive use. Note |
| 465 | * that exclusive resets are requested as acquired by default. In order for a |
| 466 | * second consumer to be able to control the reset, the first consumer has to |
| 467 | * release it first. Typically the easiest way to achieve this is to call the |
| 468 | * reset_control_get_exclusive_released() to obtain an instance of the reset |
| 469 | * control. Such reset controls are not acquired by default. |
| 470 | * |
| 471 | * Consumers implementing shared access to an exclusive reset need to follow |
| 472 | * a specific protocol in order to work together. Before consumers can change |
| 473 | * a reset they must acquire exclusive access using reset_control_acquire(). |
| 474 | * After they are done operating the reset, they must release exclusive access |
| 475 | * with a call to reset_control_release(). Consumers are not granted exclusive |
| 476 | * access to the reset as long as another consumer hasn't released a reset. |
| 477 | * |
| 478 | * See also: reset_control_release() |
| 479 | */ |
| 480 | int reset_control_acquire(struct reset_control *rstc) |
| 481 | { |
| 482 | struct reset_control *rc; |
| 483 | |
| 484 | if (!rstc) |
| 485 | return 0; |
| 486 | |
| 487 | if (WARN_ON(IS_ERR(rstc))) |
| 488 | return -EINVAL; |
| 489 | |
| 490 | if (reset_control_is_array(rstc)) |
| 491 | return reset_control_array_acquire(rstc_to_array(rstc)); |
| 492 | |
| 493 | mutex_lock(&reset_list_mutex); |
| 494 | |
| 495 | if (rstc->acquired) { |
| 496 | mutex_unlock(&reset_list_mutex); |
| 497 | return 0; |
| 498 | } |
| 499 | |
| 500 | list_for_each_entry(rc, &rstc->rcdev->reset_control_head, list) { |
| 501 | if (rstc != rc && rstc->id == rc->id) { |
| 502 | if (rc->acquired) { |
| 503 | mutex_unlock(&reset_list_mutex); |
| 504 | return -EBUSY; |
| 505 | } |
| 506 | } |
| 507 | } |
| 508 | |
| 509 | rstc->acquired = true; |
| 510 | |
| 511 | mutex_unlock(&reset_list_mutex); |
| 512 | return 0; |
| 513 | } |
| 514 | EXPORT_SYMBOL_GPL(reset_control_acquire); |
| 515 | |
| 516 | /** |
| 517 | * reset_control_release() - releases exclusive access to a reset control |
| 518 | * @rstc: reset control |
| 519 | * |
| 520 | * Releases exclusive access right to a reset control previously obtained by a |
| 521 | * call to reset_control_acquire(). Until a consumer calls this function, no |
| 522 | * other consumers will be granted exclusive access. |
| 523 | * |
| 524 | * See also: reset_control_acquire() |
| 525 | */ |
| 526 | void reset_control_release(struct reset_control *rstc) |
| 527 | { |
| 528 | if (!rstc || WARN_ON(IS_ERR(rstc))) |
| 529 | return; |
| 530 | |
| 531 | if (reset_control_is_array(rstc)) |
| 532 | reset_control_array_release(rstc_to_array(rstc)); |
| 533 | else |
| 534 | rstc->acquired = false; |
| 535 | } |
| 536 | EXPORT_SYMBOL_GPL(reset_control_release); |
| 537 | |
| 538 | static struct reset_control *__reset_control_get_internal( |
| 539 | struct reset_controller_dev *rcdev, |
| 540 | unsigned int index, bool shared, bool acquired) |
| 541 | { |
| 542 | struct reset_control *rstc; |
| 543 | |
| 544 | lockdep_assert_held(&reset_list_mutex); |
| 545 | |
| 546 | list_for_each_entry(rstc, &rcdev->reset_control_head, list) { |
| 547 | if (rstc->id == index) { |
| 548 | /* |
| 549 | * Allow creating a secondary exclusive reset_control |
| 550 | * that is initially not acquired for an already |
| 551 | * controlled reset line. |
| 552 | */ |
| 553 | if (!rstc->shared && !shared && !acquired) |
| 554 | break; |
| 555 | |
| 556 | if (WARN_ON(!rstc->shared || !shared)) |
| 557 | return ERR_PTR(-EBUSY); |
| 558 | |
| 559 | kref_get(&rstc->refcnt); |
| 560 | return rstc; |
| 561 | } |
| 562 | } |
| 563 | |
| 564 | rstc = kzalloc(sizeof(*rstc), GFP_KERNEL); |
| 565 | if (!rstc) |
| 566 | return ERR_PTR(-ENOMEM); |
| 567 | |
| 568 | if (!try_module_get(rcdev->owner)) { |
| 569 | kfree(rstc); |
| 570 | return ERR_PTR(-ENODEV); |
| 571 | } |
| 572 | |
| 573 | rstc->rcdev = rcdev; |
| 574 | list_add(&rstc->list, &rcdev->reset_control_head); |
| 575 | rstc->id = index; |
| 576 | kref_init(&rstc->refcnt); |
| 577 | rstc->acquired = acquired; |
| 578 | rstc->shared = shared; |
| 579 | |
| 580 | return rstc; |
| 581 | } |
| 582 | |
| 583 | static void __reset_control_release(struct kref *kref) |
| 584 | { |
| 585 | struct reset_control *rstc = container_of(kref, struct reset_control, |
| 586 | refcnt); |
| 587 | |
| 588 | lockdep_assert_held(&reset_list_mutex); |
| 589 | |
| 590 | module_put(rstc->rcdev->owner); |
| 591 | |
| 592 | list_del(&rstc->list); |
| 593 | kfree(rstc); |
| 594 | } |
| 595 | |
| 596 | static void __reset_control_put_internal(struct reset_control *rstc) |
| 597 | { |
| 598 | lockdep_assert_held(&reset_list_mutex); |
| 599 | |
| 600 | if (IS_ERR_OR_NULL(rstc)) |
| 601 | return; |
| 602 | |
| 603 | kref_put(&rstc->refcnt, __reset_control_release); |
| 604 | } |
| 605 | |
| 606 | struct reset_control *__of_reset_control_get(struct device_node *node, |
| 607 | const char *id, int index, bool shared, |
| 608 | bool optional, bool acquired) |
| 609 | { |
| 610 | struct reset_control *rstc; |
| 611 | struct reset_controller_dev *r, *rcdev; |
| 612 | struct of_phandle_args args; |
| 613 | int rstc_id; |
| 614 | int ret; |
| 615 | |
| 616 | if (!node) |
| 617 | return ERR_PTR(-EINVAL); |
| 618 | |
| 619 | if (id) { |
| 620 | index = of_property_match_string(node, |
| 621 | "reset-names", id); |
| 622 | if (index == -EILSEQ) |
| 623 | return ERR_PTR(index); |
| 624 | if (index < 0) |
| 625 | return optional ? NULL : ERR_PTR(-ENOENT); |
| 626 | } |
| 627 | |
| 628 | ret = of_parse_phandle_with_args(node, "resets", "#reset-cells", |
| 629 | index, &args); |
| 630 | if (ret == -EINVAL) |
| 631 | return ERR_PTR(ret); |
| 632 | if (ret) |
| 633 | return optional ? NULL : ERR_PTR(ret); |
| 634 | |
| 635 | mutex_lock(&reset_list_mutex); |
| 636 | rcdev = NULL; |
| 637 | list_for_each_entry(r, &reset_controller_list, list) { |
| 638 | if (args.np == r->of_node) { |
| 639 | rcdev = r; |
| 640 | break; |
| 641 | } |
| 642 | } |
| 643 | |
| 644 | if (!rcdev) { |
| 645 | rstc = ERR_PTR(-EPROBE_DEFER); |
| 646 | goto out; |
| 647 | } |
| 648 | |
| 649 | if (WARN_ON(args.args_count != rcdev->of_reset_n_cells)) { |
| 650 | rstc = ERR_PTR(-EINVAL); |
| 651 | goto out; |
| 652 | } |
| 653 | |
| 654 | rstc_id = rcdev->of_xlate(rcdev, &args); |
| 655 | if (rstc_id < 0) { |
| 656 | rstc = ERR_PTR(rstc_id); |
| 657 | goto out; |
| 658 | } |
| 659 | |
| 660 | /* reset_list_mutex also protects the rcdev's reset_control list */ |
| 661 | rstc = __reset_control_get_internal(rcdev, rstc_id, shared, acquired); |
| 662 | |
| 663 | out: |
| 664 | mutex_unlock(&reset_list_mutex); |
| 665 | of_node_put(args.np); |
| 666 | |
| 667 | return rstc; |
| 668 | } |
| 669 | EXPORT_SYMBOL_GPL(__of_reset_control_get); |
| 670 | |
| 671 | static struct reset_controller_dev * |
| 672 | __reset_controller_by_name(const char *name) |
| 673 | { |
| 674 | struct reset_controller_dev *rcdev; |
| 675 | |
| 676 | lockdep_assert_held(&reset_list_mutex); |
| 677 | |
| 678 | list_for_each_entry(rcdev, &reset_controller_list, list) { |
| 679 | if (!rcdev->dev) |
| 680 | continue; |
| 681 | |
| 682 | if (!strcmp(name, dev_name(rcdev->dev))) |
| 683 | return rcdev; |
| 684 | } |
| 685 | |
| 686 | return NULL; |
| 687 | } |
| 688 | |
| 689 | static struct reset_control * |
| 690 | __reset_control_get_from_lookup(struct device *dev, const char *con_id, |
| 691 | bool shared, bool optional, bool acquired) |
| 692 | { |
| 693 | const struct reset_control_lookup *lookup; |
| 694 | struct reset_controller_dev *rcdev; |
| 695 | const char *dev_id = dev_name(dev); |
| 696 | struct reset_control *rstc = NULL; |
| 697 | |
| 698 | mutex_lock(&reset_lookup_mutex); |
| 699 | |
| 700 | list_for_each_entry(lookup, &reset_lookup_list, list) { |
| 701 | if (strcmp(lookup->dev_id, dev_id)) |
| 702 | continue; |
| 703 | |
| 704 | if ((!con_id && !lookup->con_id) || |
| 705 | ((con_id && lookup->con_id) && |
| 706 | !strcmp(con_id, lookup->con_id))) { |
| 707 | mutex_lock(&reset_list_mutex); |
| 708 | rcdev = __reset_controller_by_name(lookup->provider); |
| 709 | if (!rcdev) { |
| 710 | mutex_unlock(&reset_list_mutex); |
| 711 | mutex_unlock(&reset_lookup_mutex); |
| 712 | /* Reset provider may not be ready yet. */ |
| 713 | return ERR_PTR(-EPROBE_DEFER); |
| 714 | } |
| 715 | |
| 716 | rstc = __reset_control_get_internal(rcdev, |
| 717 | lookup->index, |
| 718 | shared, acquired); |
| 719 | mutex_unlock(&reset_list_mutex); |
| 720 | break; |
| 721 | } |
| 722 | } |
| 723 | |
| 724 | mutex_unlock(&reset_lookup_mutex); |
| 725 | |
| 726 | if (!rstc) |
| 727 | return optional ? NULL : ERR_PTR(-ENOENT); |
| 728 | |
| 729 | return rstc; |
| 730 | } |
| 731 | |
| 732 | struct reset_control *__reset_control_get(struct device *dev, const char *id, |
| 733 | int index, bool shared, bool optional, |
| 734 | bool acquired) |
| 735 | { |
| 736 | if (WARN_ON(shared && acquired)) |
| 737 | return ERR_PTR(-EINVAL); |
| 738 | |
| 739 | if (dev->of_node) |
| 740 | return __of_reset_control_get(dev->of_node, id, index, shared, |
| 741 | optional, acquired); |
| 742 | |
| 743 | return __reset_control_get_from_lookup(dev, id, shared, optional, |
| 744 | acquired); |
| 745 | } |
| 746 | EXPORT_SYMBOL_GPL(__reset_control_get); |
| 747 | |
| 748 | static void reset_control_array_put(struct reset_control_array *resets) |
| 749 | { |
| 750 | int i; |
| 751 | |
| 752 | mutex_lock(&reset_list_mutex); |
| 753 | for (i = 0; i < resets->num_rstcs; i++) |
| 754 | __reset_control_put_internal(resets->rstc[i]); |
| 755 | mutex_unlock(&reset_list_mutex); |
| 756 | kfree(resets); |
| 757 | } |
| 758 | |
| 759 | /** |
| 760 | * reset_control_put - free the reset controller |
| 761 | * @rstc: reset controller |
| 762 | */ |
| 763 | void reset_control_put(struct reset_control *rstc) |
| 764 | { |
| 765 | if (IS_ERR_OR_NULL(rstc)) |
| 766 | return; |
| 767 | |
| 768 | if (reset_control_is_array(rstc)) { |
| 769 | reset_control_array_put(rstc_to_array(rstc)); |
| 770 | return; |
| 771 | } |
| 772 | |
| 773 | mutex_lock(&reset_list_mutex); |
| 774 | __reset_control_put_internal(rstc); |
| 775 | mutex_unlock(&reset_list_mutex); |
| 776 | } |
| 777 | EXPORT_SYMBOL_GPL(reset_control_put); |
| 778 | |
| 779 | static void devm_reset_control_release(struct device *dev, void *res) |
| 780 | { |
| 781 | reset_control_put(*(struct reset_control **)res); |
| 782 | } |
| 783 | |
| 784 | struct reset_control *__devm_reset_control_get(struct device *dev, |
| 785 | const char *id, int index, bool shared, |
| 786 | bool optional, bool acquired) |
| 787 | { |
| 788 | struct reset_control **ptr, *rstc; |
| 789 | |
| 790 | ptr = devres_alloc(devm_reset_control_release, sizeof(*ptr), |
| 791 | GFP_KERNEL); |
| 792 | if (!ptr) |
| 793 | return ERR_PTR(-ENOMEM); |
| 794 | |
| 795 | rstc = __reset_control_get(dev, id, index, shared, optional, acquired); |
| 796 | if (!IS_ERR_OR_NULL(rstc)) { |
| 797 | *ptr = rstc; |
| 798 | devres_add(dev, ptr); |
| 799 | } else { |
| 800 | devres_free(ptr); |
| 801 | } |
| 802 | |
| 803 | return rstc; |
| 804 | } |
| 805 | EXPORT_SYMBOL_GPL(__devm_reset_control_get); |
| 806 | |
| 807 | /** |
| 808 | * device_reset - find reset controller associated with the device |
| 809 | * and perform reset |
| 810 | * @dev: device to be reset by the controller |
| 811 | * @optional: whether it is optional to reset the device |
| 812 | * |
| 813 | * Convenience wrapper for __reset_control_get() and reset_control_reset(). |
| 814 | * This is useful for the common case of devices with single, dedicated reset |
| 815 | * lines. |
| 816 | */ |
| 817 | int __device_reset(struct device *dev, bool optional) |
| 818 | { |
| 819 | struct reset_control *rstc; |
| 820 | int ret; |
| 821 | |
| 822 | rstc = __reset_control_get(dev, NULL, 0, 0, optional, true); |
| 823 | if (IS_ERR(rstc)) |
| 824 | return PTR_ERR(rstc); |
| 825 | |
| 826 | ret = reset_control_reset(rstc); |
| 827 | |
| 828 | reset_control_put(rstc); |
| 829 | |
| 830 | return ret; |
| 831 | } |
| 832 | EXPORT_SYMBOL_GPL(__device_reset); |
| 833 | |
| 834 | /* |
| 835 | * APIs to manage an array of reset controls. |
| 836 | */ |
| 837 | |
| 838 | /** |
| 839 | * of_reset_control_get_count - Count number of resets available with a device |
| 840 | * |
| 841 | * @node: device node that contains 'resets'. |
| 842 | * |
| 843 | * Returns positive reset count on success, or error number on failure and |
| 844 | * on count being zero. |
| 845 | */ |
| 846 | static int of_reset_control_get_count(struct device_node *node) |
| 847 | { |
| 848 | int count; |
| 849 | |
| 850 | if (!node) |
| 851 | return -EINVAL; |
| 852 | |
| 853 | count = of_count_phandle_with_args(node, "resets", "#reset-cells"); |
| 854 | if (count == 0) |
| 855 | count = -ENOENT; |
| 856 | |
| 857 | return count; |
| 858 | } |
| 859 | |
| 860 | /** |
| 861 | * of_reset_control_array_get - Get a list of reset controls using |
| 862 | * device node. |
| 863 | * |
| 864 | * @np: device node for the device that requests the reset controls array |
| 865 | * @shared: whether reset controls are shared or not |
| 866 | * @optional: whether it is optional to get the reset controls |
| 867 | * @acquired: only one reset control may be acquired for a given controller |
| 868 | * and ID |
| 869 | * |
| 870 | * Returns pointer to allocated reset_control on success or error on failure |
| 871 | */ |
| 872 | struct reset_control * |
| 873 | of_reset_control_array_get(struct device_node *np, bool shared, bool optional, |
| 874 | bool acquired) |
| 875 | { |
| 876 | struct reset_control_array *resets; |
| 877 | struct reset_control *rstc; |
| 878 | int num, i; |
| 879 | |
| 880 | num = of_reset_control_get_count(np); |
| 881 | if (num < 0) |
| 882 | return optional ? NULL : ERR_PTR(num); |
| 883 | |
| 884 | resets = kzalloc(struct_size(resets, rstc, num), GFP_KERNEL); |
| 885 | if (!resets) |
| 886 | return ERR_PTR(-ENOMEM); |
| 887 | |
| 888 | for (i = 0; i < num; i++) { |
| 889 | rstc = __of_reset_control_get(np, NULL, i, shared, optional, |
| 890 | acquired); |
| 891 | if (IS_ERR(rstc)) |
| 892 | goto err_rst; |
| 893 | resets->rstc[i] = rstc; |
| 894 | } |
| 895 | resets->num_rstcs = num; |
| 896 | resets->base.array = true; |
| 897 | |
| 898 | return &resets->base; |
| 899 | |
| 900 | err_rst: |
| 901 | mutex_lock(&reset_list_mutex); |
| 902 | while (--i >= 0) |
| 903 | __reset_control_put_internal(resets->rstc[i]); |
| 904 | mutex_unlock(&reset_list_mutex); |
| 905 | |
| 906 | kfree(resets); |
| 907 | |
| 908 | return rstc; |
| 909 | } |
| 910 | EXPORT_SYMBOL_GPL(of_reset_control_array_get); |
| 911 | |
| 912 | /** |
| 913 | * devm_reset_control_array_get - Resource managed reset control array get |
| 914 | * |
| 915 | * @dev: device that requests the list of reset controls |
| 916 | * @shared: whether reset controls are shared or not |
| 917 | * @optional: whether it is optional to get the reset controls |
| 918 | * |
| 919 | * The reset control array APIs are intended for a list of resets |
| 920 | * that just have to be asserted or deasserted, without any |
| 921 | * requirements on the order. |
| 922 | * |
| 923 | * Returns pointer to allocated reset_control on success or error on failure |
| 924 | */ |
| 925 | struct reset_control * |
| 926 | devm_reset_control_array_get(struct device *dev, bool shared, bool optional) |
| 927 | { |
| 928 | struct reset_control **devres; |
| 929 | struct reset_control *rstc; |
| 930 | |
| 931 | devres = devres_alloc(devm_reset_control_release, sizeof(*devres), |
| 932 | GFP_KERNEL); |
| 933 | if (!devres) |
| 934 | return ERR_PTR(-ENOMEM); |
| 935 | |
| 936 | rstc = of_reset_control_array_get(dev->of_node, shared, optional, true); |
| 937 | if (IS_ERR_OR_NULL(rstc)) { |
| 938 | devres_free(devres); |
| 939 | return rstc; |
| 940 | } |
| 941 | |
| 942 | *devres = rstc; |
| 943 | devres_add(dev, devres); |
| 944 | |
| 945 | return rstc; |
| 946 | } |
| 947 | EXPORT_SYMBOL_GPL(devm_reset_control_array_get); |
| 948 | |
| 949 | static int reset_control_get_count_from_lookup(struct device *dev) |
| 950 | { |
| 951 | const struct reset_control_lookup *lookup; |
| 952 | const char *dev_id; |
| 953 | int count = 0; |
| 954 | |
| 955 | if (!dev) |
| 956 | return -EINVAL; |
| 957 | |
| 958 | dev_id = dev_name(dev); |
| 959 | mutex_lock(&reset_lookup_mutex); |
| 960 | |
| 961 | list_for_each_entry(lookup, &reset_lookup_list, list) { |
| 962 | if (!strcmp(lookup->dev_id, dev_id)) |
| 963 | count++; |
| 964 | } |
| 965 | |
| 966 | mutex_unlock(&reset_lookup_mutex); |
| 967 | |
| 968 | if (count == 0) |
| 969 | count = -ENOENT; |
| 970 | |
| 971 | return count; |
| 972 | } |
| 973 | |
| 974 | /** |
| 975 | * reset_control_get_count - Count number of resets available with a device |
| 976 | * |
| 977 | * @dev: device for which to return the number of resets |
| 978 | * |
| 979 | * Returns positive reset count on success, or error number on failure and |
| 980 | * on count being zero. |
| 981 | */ |
| 982 | int reset_control_get_count(struct device *dev) |
| 983 | { |
| 984 | if (dev->of_node) |
| 985 | return of_reset_control_get_count(dev->of_node); |
| 986 | |
| 987 | return reset_control_get_count_from_lookup(dev); |
| 988 | } |
| 989 | EXPORT_SYMBOL_GPL(reset_control_get_count); |