drivers/base/power/domain.c

   1 /*
   2  * drivers/base/power/domain.c - Common code related to device power domains.
   3  *
   4  * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
   5  *
   6  * This file is released under the GPLv2.
   7  */
   8
   9 #include <linux/init.h>
  10 #include <linux/kernel.h>
  11 #include <linux/io.h>
  12 #include <linux/pm_runtime.h>
  13 #include <linux/pm_domain.h>
  14 #include <linux/slab.h>
  15 #include <linux/err.h>
  16 #include <linux/sched.h>
  17 #include <linux/suspend.h>
  18
  19 #ifdef CONFIG_PM
  20
  21 static struct generic_pm_domain *dev_to_genpd(struct device *dev)
  22 {
  23         if (IS_ERR_OR_NULL(dev->pm_domain))
  24                 return ERR_PTR(-EINVAL);
  25
  26         return pd_to_genpd(dev->pm_domain);
  27 }
  28
  29 static void genpd_sd_counter_dec(struct generic_pm_domain *genpd)
  30 {
  31         if (!WARN_ON(genpd->sd_count == 0))
  32                         genpd->sd_count--;
  33 }
  34
  35 static void genpd_acquire_lock(struct generic_pm_domain *genpd)
  36 {
  37         DEFINE_WAIT(wait);
  38
  39         mutex_lock(&genpd->lock);
  40         /*
  41          * Wait for the domain to transition into either the active,
  42          * or the power off state.
  43          */
  44         for (;;) {
  45                 prepare_to_wait(&genpd->status_wait_queue, &wait,
  46                                 TASK_UNINTERRUPTIBLE);
  47                 if (genpd->status == GPD_STATE_ACTIVE
  48                     || genpd->status == GPD_STATE_POWER_OFF)
  49                         break;
  50                 mutex_unlock(&genpd->lock);
  51
  52                 schedule();
  53
  54                 mutex_lock(&genpd->lock);
  55         }
  56         finish_wait(&genpd->status_wait_queue, &wait);
  57 }
  58
  59 static void genpd_release_lock(struct generic_pm_domain *genpd)
  60 {
  61         mutex_unlock(&genpd->lock);
  62 }
  63
  64 static void genpd_set_active(struct generic_pm_domain *genpd)
  65 {
  66         if (genpd->resume_count == 0)
  67                 genpd->status = GPD_STATE_ACTIVE;
  68 }
  69
  70 /**
  71  * pm_genpd_poweron - Restore power to a given PM domain and its parents.
  72  * @genpd: PM domain to power up.
  73  *
  74  * Restore power to @genpd and all of its parents so that it is possible to
  75  * resume a device belonging to it.
  76  */
  77 int pm_genpd_poweron(struct generic_pm_domain *genpd)
  78 {
  79         struct generic_pm_domain *parent = genpd->parent;
  80         DEFINE_WAIT(wait);
  81         int ret = 0;
  82
  83  start:
  84         if (parent) {
  85                 genpd_acquire_lock(parent);
  86                 mutex_lock_nested(&genpd->lock, SINGLE_DEPTH_NESTING);
  87         } else {
  88                 mutex_lock(&genpd->lock);
  89         }
  90
  91         if (genpd->status == GPD_STATE_ACTIVE
  92             || (genpd->prepared_count > 0 && genpd->suspend_power_off))
  93                 goto out;
  94
  95         if (genpd->status != GPD_STATE_POWER_OFF) {
  96                 genpd_set_active(genpd);
  97                 goto out;
  98         }
  99
 100         if (parent && parent->status != GPD_STATE_ACTIVE) {
 101                 mutex_unlock(&genpd->lock);
 102                 genpd_release_lock(parent);
 103
 104                 ret = pm_genpd_poweron(parent);
 105                 if (ret)
 106                         return ret;
 107
 108                 goto start;
 109         }
 110
 111         if (genpd->power_on) {
 112                 int ret = genpd->power_on(genpd);
 113                 if (ret)
 114                         goto out;
 115         }
 116
 117         genpd_set_active(genpd);
 118         if (parent)
 119                 parent->sd_count++;
 120
 121  out:
 122         mutex_unlock(&genpd->lock);
 123         if (parent)
 124                 genpd_release_lock(parent);
 125
 126         return ret;
 127 }
 128
 129 #endif /* CONFIG_PM */
 130
 131 #ifdef CONFIG_PM_RUNTIME
 132
 133 /**
 134  * __pm_genpd_save_device - Save the pre-suspend state of a device.
 135  * @dle: Device list entry of the device to save the state of.
 136  * @genpd: PM domain the device belongs to.
 137  */
 138 static int __pm_genpd_save_device(struct dev_list_entry *dle,
 139                                   struct generic_pm_domain *genpd)
 140         __releases(&genpd->lock) __acquires(&genpd->lock)
 141 {
 142         struct device *dev = dle->dev;
 143         struct device_driver *drv = dev->driver;
 144         int ret = 0;
 145
 146         if (dle->need_restore)
 147                 return 0;
 148
 149         mutex_unlock(&genpd->lock);
 150
 151         if (drv && drv->pm && drv->pm->runtime_suspend) {
 152                 if (genpd->start_device)
 153                         genpd->start_device(dev);
 154
 155                 ret = drv->pm->runtime_suspend(dev);
 156
 157                 if (genpd->stop_device)
 158                         genpd->stop_device(dev);
 159         }
 160
 161         mutex_lock(&genpd->lock);
 162
 163         if (!ret)
 164                 dle->need_restore = true;
 165
 166         return ret;
 167 }
 168
 169 /**
 170  * __pm_genpd_restore_device - Restore the pre-suspend state of a device.
 171  * @dle: Device list entry of the device to restore the state of.
 172  * @genpd: PM domain the device belongs to.
 173  */
 174 static void __pm_genpd_restore_device(struct dev_list_entry *dle,
 175                                       struct generic_pm_domain *genpd)
 176         __releases(&genpd->lock) __acquires(&genpd->lock)
 177 {
 178         struct device *dev = dle->dev;
 179         struct device_driver *drv = dev->driver;
 180
 181         if (!dle->need_restore)
 182                 return;
 183
 184         mutex_unlock(&genpd->lock);
 185
 186         if (drv && drv->pm && drv->pm->runtime_resume) {
 187                 if (genpd->start_device)
 188                         genpd->start_device(dev);
 189
 190                 drv->pm->runtime_resume(dev);
 191
 192                 if (genpd->stop_device)
 193                         genpd->stop_device(dev);
 194         }
 195
 196         mutex_lock(&genpd->lock);
 197
 198         dle->need_restore = false;
 199 }
 200
 201 /**
 202  * genpd_abort_poweroff - Check if a PM domain power off should be aborted.
 203  * @genpd: PM domain to check.
 204  *
 205  * Return true if a PM domain's status changed to GPD_STATE_ACTIVE during
 206  * a "power off" operation, which means that a "power on" has occured in the
 207  * meantime, or if its resume_count field is different from zero, which means
 208  * that one of its devices has been resumed in the meantime.
 209  */
 210 static bool genpd_abort_poweroff(struct generic_pm_domain *genpd)
 211 {
 212         return genpd->status == GPD_STATE_ACTIVE || genpd->resume_count > 0;
 213 }
 214
 215 /**
 216  * genpd_queue_power_off_work - Queue up the execution of pm_genpd_poweroff().
 217  * @genpd: PM domait to power off.
 218  *
 219  * Queue up the execution of pm_genpd_poweroff() unless it's already been done
 220  * before.
 221  */
 222 static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
 223 {
 224         if (!work_pending(&genpd->power_off_work))
 225                 queue_work(pm_wq, &genpd->power_off_work);
 226 }
 227
 228 /**
 229  * pm_genpd_poweroff - Remove power from a given PM domain.
 230  * @genpd: PM domain to power down.
 231  *
 232  * If all of the @genpd's devices have been suspended and all of its subdomains
 233  * have been powered down, run the runtime suspend callbacks provided by all of
 234  * the @genpd's devices' drivers and remove power from @genpd.
 235  */
 236 static int pm_genpd_poweroff(struct generic_pm_domain *genpd)
 237         __releases(&genpd->lock) __acquires(&genpd->lock)
 238 {
 239         struct generic_pm_domain *parent;
 240         struct dev_list_entry *dle;
 241         unsigned int not_suspended;
 242         int ret = 0;
 243
 244  start:
 245         /*
 246          * Do not try to power off the domain in the following situations:
 247          * (1) The domain is already in the "power off" state.
 248          * (2) System suspend is in progress.
 249          * (3) One of the domain's devices is being resumed right now.
 250          */
 251         if (genpd->status == GPD_STATE_POWER_OFF || genpd->prepared_count > 0
 252             || genpd->resume_count > 0)
 253                 return 0;
 254
 255         if (genpd->sd_count > 0)
 256                 return -EBUSY;
 257
 258         not_suspended = 0;
 259         list_for_each_entry(dle, &genpd->dev_list, node)
 260                 if (dle->dev->driver && !pm_runtime_suspended(dle->dev))
 261                         not_suspended++;
 262
 263         if (not_suspended > genpd->in_progress)
 264                 return -EBUSY;
 265
 266         if (genpd->poweroff_task) {
 267                 /*
 268                  * Another instance of pm_genpd_poweroff() is executing
 269                  * callbacks, so tell it to start over and return.
 270                  */
 271                 genpd->status = GPD_STATE_REPEAT;
 272                 return 0;
 273         }
 274
 275         if (genpd->gov && genpd->gov->power_down_ok) {
 276                 if (!genpd->gov->power_down_ok(&genpd->domain))
 277                         return -EAGAIN;
 278         }
 279
 280         genpd->status = GPD_STATE_BUSY;
 281         genpd->poweroff_task = current;
 282
 283         list_for_each_entry_reverse(dle, &genpd->dev_list, node) {
 284                 ret = __pm_genpd_save_device(dle, genpd);
 285                 if (ret) {
 286                         genpd_set_active(genpd);
 287                         goto out;
 288                 }
 289
 290                 if (genpd_abort_poweroff(genpd))
 291                         goto out;
 292
 293                 if (genpd->status == GPD_STATE_REPEAT) {
 294                         genpd->poweroff_task = NULL;
 295                         goto start;
 296                 }
 297         }
 298
 299         parent = genpd->parent;
 300         if (parent) {
 301                 mutex_unlock(&genpd->lock);
 302
 303                 genpd_acquire_lock(parent);
 304                 mutex_lock_nested(&genpd->lock, SINGLE_DEPTH_NESTING);
 305
 306                 if (genpd_abort_poweroff(genpd)) {
 307                         genpd_release_lock(parent);
 308                         goto out;
 309                 }
 310         }
 311
 312         if (genpd->power_off)
 313                 genpd->power_off(genpd);
 314
 315         genpd->status = GPD_STATE_POWER_OFF;
 316
 317         if (parent) {
 318                 genpd_sd_counter_dec(parent);
 319                 if (parent->sd_count == 0)
 320                         genpd_queue_power_off_work(parent);
 321
 322                 genpd_release_lock(parent);
 323         }
 324
 325  out:
 326         genpd->poweroff_task = NULL;
 327         wake_up_all(&genpd->status_wait_queue);
 328         return ret;
 329 }
 330
 331 /**
 332  * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
 333  * @work: Work structure used for scheduling the execution of this function.
 334  */
 335 static void genpd_power_off_work_fn(struct work_struct *work)
 336 {
 337         struct generic_pm_domain *genpd;
 338
 339         genpd = container_of(work, struct generic_pm_domain, power_off_work);
 340
 341         genpd_acquire_lock(genpd);
 342         pm_genpd_poweroff(genpd);
 343         genpd_release_lock(genpd);
 344 }
 345
 346 /**
 347  * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
 348  * @dev: Device to suspend.
 349  *
 350  * Carry out a runtime suspend of a device under the assumption that its
 351  * pm_domain field points to the domain member of an object of type
 352  * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 353  */
 354 static int pm_genpd_runtime_suspend(struct device *dev)
 355 {
 356         struct generic_pm_domain *genpd;
 357
 358         dev_dbg(dev, "%s()\n", __func__);
 359
 360         genpd = dev_to_genpd(dev);
 361         if (IS_ERR(genpd))
 362                 return -EINVAL;
 363
 364         if (genpd->stop_device) {
 365                 int ret = genpd->stop_device(dev);
 366                 if (ret)
 367                         return ret;
 368         }
 369
 370         mutex_lock(&genpd->lock);
 371         genpd->in_progress++;
 372         pm_genpd_poweroff(genpd);
 373         genpd->in_progress--;
 374         mutex_unlock(&genpd->lock);
 375
 376         return 0;
 377 }
 378
 379 /**
 380  * __pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
 381  * @dev: Device to resume.
 382  * @genpd: PM domain the device belongs to.
 383  */
 384 static void __pm_genpd_runtime_resume(struct device *dev,
 385                                       struct generic_pm_domain *genpd)
 386 {
 387         struct dev_list_entry *dle;
 388
 389         list_for_each_entry(dle, &genpd->dev_list, node) {
 390                 if (dle->dev == dev) {
 391                         __pm_genpd_restore_device(dle, genpd);
 392                         break;
 393                 }
 394         }
 395 }
 396
 397 /**
 398  * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
 399  * @dev: Device to resume.
 400  *
 401  * Carry out a runtime resume of a device under the assumption that its
 402  * pm_domain field points to the domain member of an object of type
 403  * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 404  */
 405 static int pm_genpd_runtime_resume(struct device *dev)
 406 {
 407         struct generic_pm_domain *genpd;
 408         DEFINE_WAIT(wait);
 409         int ret;
 410
 411         dev_dbg(dev, "%s()\n", __func__);
 412
 413         genpd = dev_to_genpd(dev);
 414         if (IS_ERR(genpd))
 415                 return -EINVAL;
 416
 417         ret = pm_genpd_poweron(genpd);
 418         if (ret)
 419                 return ret;
 420
 421         mutex_lock(&genpd->lock);
 422         genpd->status = GPD_STATE_BUSY;
 423         genpd->resume_count++;
 424         for (;;) {
 425                 prepare_to_wait(&genpd->status_wait_queue, &wait,
 426                                 TASK_UNINTERRUPTIBLE);
 427                 /*
 428                  * If current is the powering off task, we have been called
 429                  * reentrantly from one of the device callbacks, so we should
 430                  * not wait.
 431                  */
 432                 if (!genpd->poweroff_task || genpd->poweroff_task == current)
 433                         break;
 434                 mutex_unlock(&genpd->lock);
 435
 436                 schedule();
 437
 438                 mutex_lock(&genpd->lock);
 439         }
 440         finish_wait(&genpd->status_wait_queue, &wait);
 441         __pm_genpd_runtime_resume(dev, genpd);
 442         genpd->resume_count--;
 443         genpd_set_active(genpd);
 444         wake_up_all(&genpd->status_wait_queue);
 445         mutex_unlock(&genpd->lock);
 446
 447         if (genpd->start_device)
 448                 genpd->start_device(dev);
 449
 450         return 0;
 451 }
 452
 453 #else
 454
 455 static inline void genpd_power_off_work_fn(struct work_struct *work) {}
 456 static inline void __pm_genpd_runtime_resume(struct device *dev,
 457                                              struct generic_pm_domain *genpd) {}
 458
 459 #define pm_genpd_runtime_suspend        NULL
 460 #define pm_genpd_runtime_resume         NULL
 461
 462 #endif /* CONFIG_PM_RUNTIME */
 463
 464 #ifdef CONFIG_PM_SLEEP
 465
 466 /**
 467  * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its parents.
 468  * @genpd: PM domain to power off, if possible.
 469  *
 470  * Check if the given PM domain can be powered off (during system suspend or
 471  * hibernation) and do that if so.  Also, in that case propagate to its parent.
 472  *
 473  * This function is only called in "noirq" stages of system power transitions,
 474  * so it need not acquire locks (all of the "noirq" callbacks are executed
 475  * sequentially, so it is guaranteed that it will never run twice in parallel).
 476  */
 477 static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd)
 478 {
 479         struct generic_pm_domain *parent = genpd->parent;
 480
 481         if (genpd->status == GPD_STATE_POWER_OFF)
 482                 return;
 483
 484         if (genpd->suspended_count != genpd->device_count || genpd->sd_count > 0)
 485                 return;
 486
 487         if (genpd->power_off)
 488                 genpd->power_off(genpd);
 489
 490         genpd->status = GPD_STATE_POWER_OFF;
 491         if (parent) {
 492                 genpd_sd_counter_dec(parent);
 493                 pm_genpd_sync_poweroff(parent);
 494         }
 495 }
 496
 497 /**
 498  * resume_needed - Check whether to resume a device before system suspend.
 499  * @dev: Device to check.
 500  * @genpd: PM domain the device belongs to.
 501  *
 502  * There are two cases in which a device that can wake up the system from sleep
 503  * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
 504  * to wake up the system and it has to remain active for this purpose while the
 505  * system is in the sleep state and (2) if the device is not enabled to wake up
 506  * the system from sleep states and it generally doesn't generate wakeup signals
 507  * by itself (those signals are generated on its behalf by other parts of the
 508  * system).  In the latter case it may be necessary to reconfigure the device's
 509  * wakeup settings during system suspend, because it may have been set up to
 510  * signal remote wakeup from the system's working state as needed by runtime PM.
 511  * Return 'true' in either of the above cases.
 512  */
 513 static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
 514 {
 515         bool active_wakeup;
 516
 517         if (!device_can_wakeup(dev))
 518                 return false;
 519
 520         active_wakeup = genpd->active_wakeup && genpd->active_wakeup(dev);
 521         return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
 522 }
 523
 524 /**
 525  * pm_genpd_prepare - Start power transition of a device in a PM domain.
 526  * @dev: Device to start the transition of.
 527  *
 528  * Start a power transition of a device (during a system-wide power transition)
 529  * under the assumption that its pm_domain field points to the domain member of
 530  * an object of type struct generic_pm_domain representing a PM domain
 531  * consisting of I/O devices.
 532  */
 533 static int pm_genpd_prepare(struct device *dev)
 534 {
 535         struct generic_pm_domain *genpd;
 536         int ret;
 537
 538         dev_dbg(dev, "%s()\n", __func__);
 539
 540         genpd = dev_to_genpd(dev);
 541         if (IS_ERR(genpd))
 542                 return -EINVAL;
 543
 544         /*
 545          * If a wakeup request is pending for the device, it should be woken up
 546          * at this point and a system wakeup event should be reported if it's
 547          * set up to wake up the system from sleep states.
 548          */
 549         pm_runtime_get_noresume(dev);
 550         if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
 551                 pm_wakeup_event(dev, 0);
 552
 553         if (pm_wakeup_pending()) {
 554                 pm_runtime_put_sync(dev);
 555                 return -EBUSY;
 556         }
 557
 558         if (resume_needed(dev, genpd))
 559                 pm_runtime_resume(dev);
 560
 561         genpd_acquire_lock(genpd);
 562
 563         if (genpd->prepared_count++ == 0)
 564                 genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
 565
 566         genpd_release_lock(genpd);
 567
 568         if (genpd->suspend_power_off) {
 569                 pm_runtime_put_noidle(dev);
 570                 return 0;
 571         }
 572
 573         /*
 574          * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
 575          * so pm_genpd_poweron() will return immediately, but if the device
 576          * is suspended (e.g. it's been stopped by .stop_device()), we need
 577          * to make it operational.
 578          */
 579         pm_runtime_resume(dev);
 580         __pm_runtime_disable(dev, false);
 581
 582         ret = pm_generic_prepare(dev);
 583         if (ret) {
 584                 mutex_lock(&genpd->lock);
 585
 586                 if (--genpd->prepared_count == 0)
 587                         genpd->suspend_power_off = false;
 588
 589                 mutex_unlock(&genpd->lock);
 590                 pm_runtime_enable(dev);
 591         }
 592
 593         pm_runtime_put_sync(dev);
 594         return ret;
 595 }
 596
 597 /**
 598  * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
 599  * @dev: Device to suspend.
 600  *
 601  * Suspend a device under the assumption that its pm_domain field points to the
 602  * domain member of an object of type struct generic_pm_domain representing
 603  * a PM domain consisting of I/O devices.
 604  */
 605 static int pm_genpd_suspend(struct device *dev)
 606 {
 607         struct generic_pm_domain *genpd;
 608
 609         dev_dbg(dev, "%s()\n", __func__);
 610
 611         genpd = dev_to_genpd(dev);
 612         if (IS_ERR(genpd))
 613                 return -EINVAL;
 614
 615         return genpd->suspend_power_off ? 0 : pm_generic_suspend(dev);
 616 }
 617
 618 /**
 619  * pm_genpd_suspend_noirq - Late suspend of a device from an I/O PM domain.
 620  * @dev: Device to suspend.
 621  *
 622  * Carry out a late suspend of a device under the assumption that its
 623  * pm_domain field points to the domain member of an object of type
 624  * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 625  */
 626 static int pm_genpd_suspend_noirq(struct device *dev)
 627 {
 628         struct generic_pm_domain *genpd;
 629         int ret;
 630
 631         dev_dbg(dev, "%s()\n", __func__);
 632
 633         genpd = dev_to_genpd(dev);
 634         if (IS_ERR(genpd))
 635                 return -EINVAL;
 636
 637         if (genpd->suspend_power_off)
 638                 return 0;
 639
 640         ret = pm_generic_suspend_noirq(dev);
 641         if (ret)
 642                 return ret;
 643
 644         if (device_may_wakeup(dev)
 645             && genpd->active_wakeup && genpd->active_wakeup(dev))
 646                 return 0;
 647
 648         if (genpd->stop_device)
 649                 genpd->stop_device(dev);
 650
 651         /*
 652          * Since all of the "noirq" callbacks are executed sequentially, it is
 653          * guaranteed that this function will never run twice in parallel for
 654          * the same PM domain, so it is not necessary to use locking here.
 655          */
 656         genpd->suspended_count++;
 657         pm_genpd_sync_poweroff(genpd);
 658
 659         return 0;
 660 }
 661
 662 /**
 663  * pm_genpd_resume_noirq - Early resume of a device from an I/O power domain.
 664  * @dev: Device to resume.
 665  *
 666  * Carry out an early resume of a device under the assumption that its
 667  * pm_domain field points to the domain member of an object of type
 668  * struct generic_pm_domain representing a power domain consisting of I/O
 669  * devices.
 670  */
 671 static int pm_genpd_resume_noirq(struct device *dev)
 672 {
 673         struct generic_pm_domain *genpd;
 674
 675         dev_dbg(dev, "%s()\n", __func__);
 676
 677         genpd = dev_to_genpd(dev);
 678         if (IS_ERR(genpd))
 679                 return -EINVAL;
 680
 681         if (genpd->suspend_power_off)
 682                 return 0;
 683
 684         /*
 685          * Since all of the "noirq" callbacks are executed sequentially, it is
 686          * guaranteed that this function will never run twice in parallel for
 687          * the same PM domain, so it is not necessary to use locking here.
 688          */
 689         pm_genpd_poweron(genpd);
 690         genpd->suspended_count--;
 691         if (genpd->start_device)
 692                 genpd->start_device(dev);
 693
 694         return pm_generic_resume_noirq(dev);
 695 }
 696
 697 /**
 698  * pm_genpd_resume - Resume a device belonging to an I/O power domain.
 699  * @dev: Device to resume.
 700  *
 701  * Resume a device under the assumption that its pm_domain field points to the
 702  * domain member of an object of type struct generic_pm_domain representing
 703  * a power domain consisting of I/O devices.
 704  */
 705 static int pm_genpd_resume(struct device *dev)
 706 {
 707         struct generic_pm_domain *genpd;
 708
 709         dev_dbg(dev, "%s()\n", __func__);
 710
 711         genpd = dev_to_genpd(dev);
 712         if (IS_ERR(genpd))
 713                 return -EINVAL;
 714
 715         return genpd->suspend_power_off ? 0 : pm_generic_resume(dev);
 716 }
 717
 718 /**
 719  * pm_genpd_freeze - Freeze a device belonging to an I/O power domain.
 720  * @dev: Device to freeze.
 721  *
 722  * Freeze a device under the assumption that its pm_domain field points to the
 723  * domain member of an object of type struct generic_pm_domain representing
 724  * a power domain consisting of I/O devices.
 725  */
 726 static int pm_genpd_freeze(struct device *dev)
 727 {
 728         struct generic_pm_domain *genpd;
 729
 730         dev_dbg(dev, "%s()\n", __func__);
 731
 732         genpd = dev_to_genpd(dev);
 733         if (IS_ERR(genpd))
 734                 return -EINVAL;
 735
 736         return genpd->suspend_power_off ? 0 : pm_generic_freeze(dev);
 737 }
 738
 739 /**
 740  * pm_genpd_freeze_noirq - Late freeze of a device from an I/O power domain.
 741  * @dev: Device to freeze.
 742  *
 743  * Carry out a late freeze of a device under the assumption that its
 744  * pm_domain field points to the domain member of an object of type
 745  * struct generic_pm_domain representing a power domain consisting of I/O
 746  * devices.
 747  */
 748 static int pm_genpd_freeze_noirq(struct device *dev)
 749 {
 750         struct generic_pm_domain *genpd;
 751         int ret;
 752
 753         dev_dbg(dev, "%s()\n", __func__);
 754
 755         genpd = dev_to_genpd(dev);
 756         if (IS_ERR(genpd))
 757                 return -EINVAL;
 758
 759         if (genpd->suspend_power_off)
 760                 return 0;
 761
 762         ret = pm_generic_freeze_noirq(dev);
 763         if (ret)
 764                 return ret;
 765
 766         if (genpd->stop_device)
 767                 genpd->stop_device(dev);
 768
 769         return 0;
 770 }
 771
 772 /**
 773  * pm_genpd_thaw_noirq - Early thaw of a device from an I/O power domain.
 774  * @dev: Device to thaw.
 775  *
 776  * Carry out an early thaw of a device under the assumption that its
 777  * pm_domain field points to the domain member of an object of type
 778  * struct generic_pm_domain representing a power domain consisting of I/O
 779  * devices.
 780  */
 781 static int pm_genpd_thaw_noirq(struct device *dev)
 782 {
 783         struct generic_pm_domain *genpd;
 784
 785         dev_dbg(dev, "%s()\n", __func__);
 786
 787         genpd = dev_to_genpd(dev);
 788         if (IS_ERR(genpd))
 789                 return -EINVAL;
 790
 791         if (genpd->suspend_power_off)
 792                 return 0;
 793
 794         if (genpd->start_device)
 795                 genpd->start_device(dev);
 796
 797         return pm_generic_thaw_noirq(dev);
 798 }
 799
 800 /**
 801  * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
 802  * @dev: Device to thaw.
 803  *
 804  * Thaw a device under the assumption that its pm_domain field points to the
 805  * domain member of an object of type struct generic_pm_domain representing
 806  * a power domain consisting of I/O devices.
 807  */
 808 static int pm_genpd_thaw(struct device *dev)
 809 {
 810         struct generic_pm_domain *genpd;
 811
 812         dev_dbg(dev, "%s()\n", __func__);
 813
 814         genpd = dev_to_genpd(dev);
 815         if (IS_ERR(genpd))
 816                 return -EINVAL;
 817
 818         return genpd->suspend_power_off ? 0 : pm_generic_thaw(dev);
 819 }
 820
 821 /**
 822  * pm_genpd_dev_poweroff - Power off a device belonging to an I/O PM domain.
 823  * @dev: Device to suspend.
 824  *
 825  * Power off a device under the assumption that its pm_domain field points to
 826  * the domain member of an object of type struct generic_pm_domain representing
 827  * a PM domain consisting of I/O devices.
 828  */
 829 static int pm_genpd_dev_poweroff(struct device *dev)
 830 {
 831         struct generic_pm_domain *genpd;
 832
 833         dev_dbg(dev, "%s()\n", __func__);
 834
 835         genpd = dev_to_genpd(dev);
 836         if (IS_ERR(genpd))
 837                 return -EINVAL;
 838
 839         return genpd->suspend_power_off ? 0 : pm_generic_poweroff(dev);
 840 }
 841
 842 /**
 843  * pm_genpd_dev_poweroff_noirq - Late power off of a device from a PM domain.
 844  * @dev: Device to suspend.
 845  *
 846  * Carry out a late powering off of a device under the assumption that its
 847  * pm_domain field points to the domain member of an object of type
 848  * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 849  */
 850 static int pm_genpd_dev_poweroff_noirq(struct device *dev)
 851 {
 852         struct generic_pm_domain *genpd;
 853         int ret;
 854
 855         dev_dbg(dev, "%s()\n", __func__);
 856
 857         genpd = dev_to_genpd(dev);
 858         if (IS_ERR(genpd))
 859                 return -EINVAL;
 860
 861         if (genpd->suspend_power_off)
 862                 return 0;
 863
 864         ret = pm_generic_poweroff_noirq(dev);
 865         if (ret)
 866                 return ret;
 867
 868         if (device_may_wakeup(dev)
 869             && genpd->active_wakeup && genpd->active_wakeup(dev))
 870                 return 0;
 871
 872         if (genpd->stop_device)
 873                 genpd->stop_device(dev);
 874
 875         /*
 876          * Since all of the "noirq" callbacks are executed sequentially, it is
 877          * guaranteed that this function will never run twice in parallel for
 878          * the same PM domain, so it is not necessary to use locking here.
 879          */
 880         genpd->suspended_count++;
 881         pm_genpd_sync_poweroff(genpd);
 882
 883         return 0;
 884 }
 885
 886 /**
 887  * pm_genpd_restore_noirq - Early restore of a device from an I/O power domain.
 888  * @dev: Device to resume.
 889  *
 890  * Carry out an early restore of a device under the assumption that its
 891  * pm_domain field points to the domain member of an object of type
 892  * struct generic_pm_domain representing a power domain consisting of I/O
 893  * devices.
 894  */
 895 static int pm_genpd_restore_noirq(struct device *dev)
 896 {
 897         struct generic_pm_domain *genpd;
 898
 899         dev_dbg(dev, "%s()\n", __func__);
 900
 901         genpd = dev_to_genpd(dev);
 902         if (IS_ERR(genpd))
 903                 return -EINVAL;
 904
 905         /*
 906          * Since all of the "noirq" callbacks are executed sequentially, it is
 907          * guaranteed that this function will never run twice in parallel for
 908          * the same PM domain, so it is not necessary to use locking here.
 909          */
 910         genpd->status = GPD_STATE_POWER_OFF;
 911         if (genpd->suspend_power_off) {
 912                 /*
 913                  * The boot kernel might put the domain into the power on state,
 914                  * so make sure it really is powered off.
 915                  */
 916                 if (genpd->power_off)
 917                         genpd->power_off(genpd);
 918                 return 0;
 919         }
 920
 921         pm_genpd_poweron(genpd);
 922         genpd->suspended_count--;
 923         if (genpd->start_device)
 924                 genpd->start_device(dev);
 925
 926         return pm_generic_restore_noirq(dev);
 927 }
 928
 929 /**
 930  * pm_genpd_restore - Restore a device belonging to an I/O power domain.
 931  * @dev: Device to resume.
 932  *
 933  * Restore a device under the assumption that its pm_domain field points to the
 934  * domain member of an object of type struct generic_pm_domain representing
 935  * a power domain consisting of I/O devices.
 936  */
 937 static int pm_genpd_restore(struct device *dev)
 938 {
 939         struct generic_pm_domain *genpd;
 940
 941         dev_dbg(dev, "%s()\n", __func__);
 942
 943         genpd = dev_to_genpd(dev);
 944         if (IS_ERR(genpd))
 945                 return -EINVAL;
 946
 947         return genpd->suspend_power_off ? 0 : pm_generic_restore(dev);
 948 }
 949
 950 /**
 951  * pm_genpd_complete - Complete power transition of a device in a power domain.
 952  * @dev: Device to complete the transition of.
 953  *
 954  * Complete a power transition of a device (during a system-wide power
 955  * transition) under the assumption that its pm_domain field points to the
 956  * domain member of an object of type struct generic_pm_domain representing
 957  * a power domain consisting of I/O devices.
 958  */
 959 static void pm_genpd_complete(struct device *dev)
 960 {
 961         struct generic_pm_domain *genpd;
 962         bool run_complete;
 963
 964         dev_dbg(dev, "%s()\n", __func__);
 965
 966         genpd = dev_to_genpd(dev);
 967         if (IS_ERR(genpd))
 968                 return;
 969
 970         mutex_lock(&genpd->lock);
 971
 972         run_complete = !genpd->suspend_power_off;
 973         if (--genpd->prepared_count == 0)
 974                 genpd->suspend_power_off = false;
 975
 976         mutex_unlock(&genpd->lock);
 977
 978         if (run_complete) {
 979                 pm_generic_complete(dev);
 980                 pm_runtime_set_active(dev);
 981                 pm_runtime_enable(dev);
 982                 pm_runtime_idle(dev);
 983         }
 984 }
 985
 986 #else
 987
 988 #define pm_genpd_prepare                NULL
 989 #define pm_genpd_suspend                NULL
 990 #define pm_genpd_suspend_noirq          NULL
 991 #define pm_genpd_resume_noirq           NULL
 992 #define pm_genpd_resume                 NULL
 993 #define pm_genpd_freeze                 NULL
 994 #define pm_genpd_freeze_noirq           NULL
 995 #define pm_genpd_thaw_noirq             NULL
 996 #define pm_genpd_thaw                   NULL
 997 #define pm_genpd_dev_poweroff_noirq     NULL
 998 #define pm_genpd_dev_poweroff           NULL
 999 #define pm_genpd_restore_noirq          NULL
1000 #define pm_genpd_restore                NULL
1001 #define pm_genpd_complete               NULL
1002
1003 #endif /* CONFIG_PM_SLEEP */
1004
1005 /**
1006  * pm_genpd_add_device - Add a device to an I/O PM domain.
1007  * @genpd: PM domain to add the device to.
1008  * @dev: Device to be added.
1009  */
1010 int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev)
1011 {
1012         struct dev_list_entry *dle;
1013         int ret = 0;
1014
1015         dev_dbg(dev, "%s()\n", __func__);
1016
1017         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1018                 return -EINVAL;
1019
1020         genpd_acquire_lock(genpd);
1021
1022         if (genpd->status == GPD_STATE_POWER_OFF) {
1023                 ret = -EINVAL;
1024                 goto out;
1025         }
1026
1027         if (genpd->prepared_count > 0) {
1028                 ret = -EAGAIN;
1029                 goto out;
1030         }
1031
1032         list_for_each_entry(dle, &genpd->dev_list, node)
1033                 if (dle->dev == dev) {
1034                         ret = -EINVAL;
1035                         goto out;
1036                 }
1037
1038         dle = kzalloc(sizeof(*dle), GFP_KERNEL);
1039         if (!dle) {
1040                 ret = -ENOMEM;
1041                 goto out;
1042         }
1043
1044         dle->dev = dev;
1045         dle->need_restore = false;
1046         list_add_tail(&dle->node, &genpd->dev_list);
1047         genpd->device_count++;
1048
1049         spin_lock_irq(&dev->power.lock);
1050         dev->pm_domain = &genpd->domain;
1051         spin_unlock_irq(&dev->power.lock);
1052
1053  out:
1054         genpd_release_lock(genpd);
1055
1056         return ret;
1057 }
1058
1059 /**
1060  * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1061  * @genpd: PM domain to remove the device from.
1062  * @dev: Device to be removed.
1063  */
1064 int pm_genpd_remove_device(struct generic_pm_domain *genpd,
1065                            struct device *dev)
1066 {
1067         struct dev_list_entry *dle;
1068         int ret = -EINVAL;
1069
1070         dev_dbg(dev, "%s()\n", __func__);
1071
1072         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1073                 return -EINVAL;
1074
1075         genpd_acquire_lock(genpd);
1076
1077         if (genpd->prepared_count > 0) {
1078                 ret = -EAGAIN;
1079                 goto out;
1080         }
1081
1082         list_for_each_entry(dle, &genpd->dev_list, node) {
1083                 if (dle->dev != dev)
1084                         continue;
1085
1086                 spin_lock_irq(&dev->power.lock);
1087                 dev->pm_domain = NULL;
1088                 spin_unlock_irq(&dev->power.lock);
1089
1090                 genpd->device_count--;
1091                 list_del(&dle->node);
1092                 kfree(dle);
1093
1094                 ret = 0;
1095                 break;
1096         }
1097
1098  out:
1099         genpd_release_lock(genpd);
1100
1101         return ret;
1102 }
1103
1104 /**
1105  * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1106  * @genpd: Master PM domain to add the subdomain to.
1107  * @new_subdomain: Subdomain to be added.
1108  */
1109 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1110                            struct generic_pm_domain *new_subdomain)
1111 {
1112         struct generic_pm_domain *subdomain;
1113         int ret = 0;
1114
1115         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(new_subdomain))
1116                 return -EINVAL;
1117
1118  start:
1119         genpd_acquire_lock(genpd);
1120         mutex_lock_nested(&new_subdomain->lock, SINGLE_DEPTH_NESTING);
1121
1122         if (new_subdomain->status != GPD_STATE_POWER_OFF
1123             && new_subdomain->status != GPD_STATE_ACTIVE) {
1124                 mutex_unlock(&new_subdomain->lock);
1125                 genpd_release_lock(genpd);
1126                 goto start;
1127         }
1128
1129         if (genpd->status == GPD_STATE_POWER_OFF
1130             &&  new_subdomain->status != GPD_STATE_POWER_OFF) {
1131                 ret = -EINVAL;
1132                 goto out;
1133         }
1134
1135         list_for_each_entry(subdomain, &genpd->sd_list, sd_node) {
1136                 if (subdomain == new_subdomain) {
1137                         ret = -EINVAL;
1138                         goto out;
1139                 }
1140         }
1141
1142         list_add_tail(&new_subdomain->sd_node, &genpd->sd_list);
1143         new_subdomain->parent = genpd;
1144         if (subdomain->status != GPD_STATE_POWER_OFF)
1145                 genpd->sd_count++;
1146
1147  out:
1148         mutex_unlock(&new_subdomain->lock);
1149         genpd_release_lock(genpd);
1150
1151         return ret;
1152 }
1153
1154 /**
1155  * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1156  * @genpd: Master PM domain to remove the subdomain from.
1157  * @target: Subdomain to be removed.
1158  */
1159 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1160                               struct generic_pm_domain *target)
1161 {
1162         struct generic_pm_domain *subdomain;
1163         int ret = -EINVAL;
1164
1165         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(target))
1166                 return -EINVAL;
1167
1168  start:
1169         genpd_acquire_lock(genpd);
1170
1171         list_for_each_entry(subdomain, &genpd->sd_list, sd_node) {
1172                 if (subdomain != target)
1173                         continue;
1174
1175                 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1176
1177                 if (subdomain->status != GPD_STATE_POWER_OFF
1178                     && subdomain->status != GPD_STATE_ACTIVE) {
1179                         mutex_unlock(&subdomain->lock);
1180                         genpd_release_lock(genpd);
1181                         goto start;
1182                 }
1183
1184                 list_del(&subdomain->sd_node);
1185                 subdomain->parent = NULL;
1186                 if (subdomain->status != GPD_STATE_POWER_OFF)
1187                         genpd_sd_counter_dec(genpd);
1188
1189                 mutex_unlock(&subdomain->lock);
1190
1191                 ret = 0;
1192                 break;
1193         }
1194
1195         genpd_release_lock(genpd);
1196
1197         return ret;
1198 }
1199
1200 /**
1201  * pm_genpd_init - Initialize a generic I/O PM domain object.
1202  * @genpd: PM domain object to initialize.
1203  * @gov: PM domain governor to associate with the domain (may be NULL).
1204  * @is_off: Initial value of the domain's power_is_off field.
1205  */
1206 void pm_genpd_init(struct generic_pm_domain *genpd,
1207                    struct dev_power_governor *gov, bool is_off)
1208 {
1209         if (IS_ERR_OR_NULL(genpd))
1210                 return;
1211
1212         INIT_LIST_HEAD(&genpd->sd_node);
1213         genpd->parent = NULL;
1214         INIT_LIST_HEAD(&genpd->dev_list);
1215         INIT_LIST_HEAD(&genpd->sd_list);
1216         mutex_init(&genpd->lock);
1217         genpd->gov = gov;
1218         INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
1219         genpd->in_progress = 0;
1220         genpd->sd_count = 0;
1221         genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
1222         init_waitqueue_head(&genpd->status_wait_queue);
1223         genpd->poweroff_task = NULL;
1224         genpd->resume_count = 0;
1225         genpd->device_count = 0;
1226         genpd->suspended_count = 0;
1227         genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
1228         genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
1229         genpd->domain.ops.runtime_idle = pm_generic_runtime_idle;
1230         genpd->domain.ops.prepare = pm_genpd_prepare;
1231         genpd->domain.ops.suspend = pm_genpd_suspend;
1232         genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
1233         genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1234         genpd->domain.ops.resume = pm_genpd_resume;
1235         genpd->domain.ops.freeze = pm_genpd_freeze;
1236         genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
1237         genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1238         genpd->domain.ops.thaw = pm_genpd_thaw;
1239         genpd->domain.ops.poweroff = pm_genpd_dev_poweroff;
1240         genpd->domain.ops.poweroff_noirq = pm_genpd_dev_poweroff_noirq;
1241         genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
1242         genpd->domain.ops.restore = pm_genpd_restore;
1243         genpd->domain.ops.complete = pm_genpd_complete;
1244 }