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/delay.h>
  10 #include <linux/kernel.h>
  11 #include <linux/io.h>
  12 #include <linux/platform_device.h>
  13 #include <linux/pm_runtime.h>
  14 #include <linux/pm_domain.h>
  15 #include <linux/pm_qos.h>
  16 #include <linux/pm_clock.h>
  17 #include <linux/slab.h>
  18 #include <linux/err.h>
  19 #include <linux/sched.h>
  20 #include <linux/suspend.h>
  21 #include <linux/export.h>
  22
  23 #define GENPD_RETRY_MAX_MS      250             /* Approximate */
  24
  25 #define GENPD_DEV_CALLBACK(genpd, type, callback, dev)          \
  26 ({                                                              \
  27         type (*__routine)(struct device *__d);                  \
  28         type __ret = (type)0;                                   \
  29                                                                 \
  30         __routine = genpd->dev_ops.callback;                    \
  31         if (__routine) {                                        \
  32                 __ret = __routine(dev);                         \
  33         }                                                       \
  34         __ret;                                                  \
  35 })
  36
  37 #define GENPD_DEV_TIMED_CALLBACK(genpd, type, callback, dev, field, name)       \
  38 ({                                                                              \
  39         ktime_t __start = ktime_get();                                          \
  40         type __retval = GENPD_DEV_CALLBACK(genpd, type, callback, dev);         \
  41         s64 __elapsed = ktime_to_ns(ktime_sub(ktime_get(), __start));           \
  42         struct gpd_timing_data *__td = &dev_gpd_data(dev)->td;                  \
  43         if (!__retval && __elapsed > __td->field) {                             \
  44                 __td->field = __elapsed;                                        \
  45                 dev_dbg(dev, name " latency exceeded, new value %lld ns\n",     \
  46                         __elapsed);                                             \
  47                 genpd->max_off_time_changed = true;                             \
  48                 __td->constraint_changed = true;                                \
  49         }                                                                       \
  50         __retval;                                                               \
  51 })
  52
  53 static LIST_HEAD(gpd_list);
  54 static DEFINE_MUTEX(gpd_list_lock);
  55
  56 /*
  57  * Get the generic PM domain for a particular struct device.
  58  * This validates the struct device pointer, the PM domain pointer,
  59  * and checks that the PM domain pointer is a real generic PM domain.
  60  * Any failure results in NULL being returned.
  61  */
  62 struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
  63 {
  64         struct generic_pm_domain *genpd = NULL, *gpd;
  65
  66         if (IS_ERR_OR_NULL(dev) || IS_ERR_OR_NULL(dev->pm_domain))
  67                 return NULL;
  68
  69         mutex_lock(&gpd_list_lock);
  70         list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
  71                 if (&gpd->domain == dev->pm_domain) {
  72                         genpd = gpd;
  73                         break;
  74                 }
  75         }
  76         mutex_unlock(&gpd_list_lock);
  77
  78         return genpd;
  79 }
  80
  81 /*
  82  * This should only be used where we are certain that the pm_domain
  83  * attached to the device is a genpd domain.
  84  */
  85 static struct generic_pm_domain *dev_to_genpd(struct device *dev)
  86 {
  87         if (IS_ERR_OR_NULL(dev->pm_domain))
  88                 return ERR_PTR(-EINVAL);
  89
  90         return pd_to_genpd(dev->pm_domain);
  91 }
  92
  93 static int genpd_stop_dev(struct generic_pm_domain *genpd, struct device *dev)
  94 {
  95         return GENPD_DEV_TIMED_CALLBACK(genpd, int, stop, dev,
  96                                         stop_latency_ns, "stop");
  97 }
  98
  99 static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev,
 100                         bool timed)
 101 {
 102         if (!timed)
 103                 return GENPD_DEV_CALLBACK(genpd, int, start, dev);
 104
 105         return GENPD_DEV_TIMED_CALLBACK(genpd, int, start, dev,
 106                                         start_latency_ns, "start");
 107 }
 108
 109 static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
 110 {
 111         bool ret = false;
 112
 113         if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
 114                 ret = !!atomic_dec_and_test(&genpd->sd_count);
 115
 116         return ret;
 117 }
 118
 119 static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
 120 {
 121         atomic_inc(&genpd->sd_count);
 122         smp_mb__after_atomic();
 123 }
 124
 125 static int genpd_power_on(struct generic_pm_domain *genpd, bool timed)
 126 {
 127         ktime_t time_start;
 128         s64 elapsed_ns;
 129         int ret;
 130
 131         if (!genpd->power_on)
 132                 return 0;
 133
 134         if (!timed)
 135                 return genpd->power_on(genpd);
 136
 137         time_start = ktime_get();
 138         ret = genpd->power_on(genpd);
 139         if (ret)
 140                 return ret;
 141
 142         elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
 143         if (elapsed_ns <= genpd->power_on_latency_ns)
 144                 return ret;
 145
 146         genpd->power_on_latency_ns = elapsed_ns;
 147         genpd->max_off_time_changed = true;
 148         pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
 149                  genpd->name, "on", elapsed_ns);
 150
 151         return ret;
 152 }
 153
 154 static int genpd_power_off(struct generic_pm_domain *genpd, bool timed)
 155 {
 156         ktime_t time_start;
 157         s64 elapsed_ns;
 158         int ret;
 159
 160         if (!genpd->power_off)
 161                 return 0;
 162
 163         if (!timed)
 164                 return genpd->power_off(genpd);
 165
 166         time_start = ktime_get();
 167         ret = genpd->power_off(genpd);
 168         if (ret == -EBUSY)
 169                 return ret;
 170
 171         elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
 172         if (elapsed_ns <= genpd->power_off_latency_ns)
 173                 return ret;
 174
 175         genpd->power_off_latency_ns = elapsed_ns;
 176         genpd->max_off_time_changed = true;
 177         pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
 178                  genpd->name, "off", elapsed_ns);
 179
 180         return ret;
 181 }
 182
 183 /**
 184  * genpd_queue_power_off_work - Queue up the execution of pm_genpd_poweroff().
 185  * @genpd: PM domait to power off.
 186  *
 187  * Queue up the execution of pm_genpd_poweroff() unless it's already been done
 188  * before.
 189  */
 190 static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
 191 {
 192         queue_work(pm_wq, &genpd->power_off_work);
 193 }
 194
 195 /**
 196  * __pm_genpd_poweron - Restore power to a given PM domain and its masters.
 197  * @genpd: PM domain to power up.
 198  *
 199  * Restore power to @genpd and all of its masters so that it is possible to
 200  * resume a device belonging to it.
 201  */
 202 static int __pm_genpd_poweron(struct generic_pm_domain *genpd)
 203 {
 204         struct gpd_link *link;
 205         int ret = 0;
 206
 207         if (genpd->status == GPD_STATE_ACTIVE
 208             || (genpd->prepared_count > 0 && genpd->suspend_power_off))
 209                 return 0;
 210
 211         /*
 212          * The list is guaranteed not to change while the loop below is being
 213          * executed, unless one of the masters' .power_on() callbacks fiddles
 214          * with it.
 215          */
 216         list_for_each_entry(link, &genpd->slave_links, slave_node) {
 217                 genpd_sd_counter_inc(link->master);
 218
 219                 ret = pm_genpd_poweron(link->master);
 220                 if (ret) {
 221                         genpd_sd_counter_dec(link->master);
 222                         goto err;
 223                 }
 224         }
 225
 226         ret = genpd_power_on(genpd, true);
 227         if (ret)
 228                 goto err;
 229
 230         genpd->status = GPD_STATE_ACTIVE;
 231         return 0;
 232
 233  err:
 234         list_for_each_entry_continue_reverse(link,
 235                                         &genpd->slave_links,
 236                                         slave_node) {
 237                 genpd_sd_counter_dec(link->master);
 238                 genpd_queue_power_off_work(link->master);
 239         }
 240
 241         return ret;
 242 }
 243
 244 /**
 245  * pm_genpd_poweron - Restore power to a given PM domain and its masters.
 246  * @genpd: PM domain to power up.
 247  */
 248 int pm_genpd_poweron(struct generic_pm_domain *genpd)
 249 {
 250         int ret;
 251
 252         mutex_lock(&genpd->lock);
 253         ret = __pm_genpd_poweron(genpd);
 254         mutex_unlock(&genpd->lock);
 255         return ret;
 256 }
 257
 258 static int genpd_save_dev(struct generic_pm_domain *genpd, struct device *dev)
 259 {
 260         return GENPD_DEV_TIMED_CALLBACK(genpd, int, save_state, dev,
 261                                         save_state_latency_ns, "state save");
 262 }
 263
 264 static int genpd_restore_dev(struct generic_pm_domain *genpd,
 265                         struct device *dev, bool timed)
 266 {
 267         if (!timed)
 268                 return GENPD_DEV_CALLBACK(genpd, int, restore_state, dev);
 269
 270         return GENPD_DEV_TIMED_CALLBACK(genpd, int, restore_state, dev,
 271                                         restore_state_latency_ns,
 272                                         "state restore");
 273 }
 274
 275 static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
 276                                      unsigned long val, void *ptr)
 277 {
 278         struct generic_pm_domain_data *gpd_data;
 279         struct device *dev;
 280
 281         gpd_data = container_of(nb, struct generic_pm_domain_data, nb);
 282         dev = gpd_data->base.dev;
 283
 284         for (;;) {
 285                 struct generic_pm_domain *genpd;
 286                 struct pm_domain_data *pdd;
 287
 288                 spin_lock_irq(&dev->power.lock);
 289
 290                 pdd = dev->power.subsys_data ?
 291                                 dev->power.subsys_data->domain_data : NULL;
 292                 if (pdd && pdd->dev) {
 293                         to_gpd_data(pdd)->td.constraint_changed = true;
 294                         genpd = dev_to_genpd(dev);
 295                 } else {
 296                         genpd = ERR_PTR(-ENODATA);
 297                 }
 298
 299                 spin_unlock_irq(&dev->power.lock);
 300
 301                 if (!IS_ERR(genpd)) {
 302                         mutex_lock(&genpd->lock);
 303                         genpd->max_off_time_changed = true;
 304                         mutex_unlock(&genpd->lock);
 305                 }
 306
 307                 dev = dev->parent;
 308                 if (!dev || dev->power.ignore_children)
 309                         break;
 310         }
 311
 312         return NOTIFY_DONE;
 313 }
 314
 315 /**
 316  * pm_genpd_poweroff - Remove power from a given PM domain.
 317  * @genpd: PM domain to power down.
 318  * @is_async: PM domain is powered down from a scheduled work
 319  *
 320  * If all of the @genpd's devices have been suspended and all of its subdomains
 321  * have been powered down, remove power from @genpd.
 322  */
 323 static int pm_genpd_poweroff(struct generic_pm_domain *genpd, bool is_async)
 324 {
 325         struct pm_domain_data *pdd;
 326         struct gpd_link *link;
 327         unsigned int not_suspended = 0;
 328
 329         /*
 330          * Do not try to power off the domain in the following situations:
 331          * (1) The domain is already in the "power off" state.
 332          * (2) System suspend is in progress.
 333          */
 334         if (genpd->status == GPD_STATE_POWER_OFF
 335             || genpd->prepared_count > 0)
 336                 return 0;
 337
 338         if (atomic_read(&genpd->sd_count) > 0)
 339                 return -EBUSY;
 340
 341         list_for_each_entry(pdd, &genpd->dev_list, list_node) {
 342                 enum pm_qos_flags_status stat;
 343
 344                 stat = dev_pm_qos_flags(pdd->dev,
 345                                         PM_QOS_FLAG_NO_POWER_OFF
 346                                                 | PM_QOS_FLAG_REMOTE_WAKEUP);
 347                 if (stat > PM_QOS_FLAGS_NONE)
 348                         return -EBUSY;
 349
 350                 if (pdd->dev->driver && (!pm_runtime_suspended(pdd->dev)
 351                     || pdd->dev->power.irq_safe))
 352                         not_suspended++;
 353         }
 354
 355         if (not_suspended > 1 || (not_suspended == 1 && is_async))
 356                 return -EBUSY;
 357
 358         if (genpd->gov && genpd->gov->power_down_ok) {
 359                 if (!genpd->gov->power_down_ok(&genpd->domain))
 360                         return -EAGAIN;
 361         }
 362
 363         if (genpd->power_off) {
 364                 int ret;
 365
 366                 if (atomic_read(&genpd->sd_count) > 0)
 367                         return -EBUSY;
 368
 369                 /*
 370                  * If sd_count > 0 at this point, one of the subdomains hasn't
 371                  * managed to call pm_genpd_poweron() for the master yet after
 372                  * incrementing it.  In that case pm_genpd_poweron() will wait
 373                  * for us to drop the lock, so we can call .power_off() and let
 374                  * the pm_genpd_poweron() restore power for us (this shouldn't
 375                  * happen very often).
 376                  */
 377                 ret = genpd_power_off(genpd, true);
 378                 if (ret)
 379                         return ret;
 380         }
 381
 382         genpd->status = GPD_STATE_POWER_OFF;
 383
 384         list_for_each_entry(link, &genpd->slave_links, slave_node) {
 385                 genpd_sd_counter_dec(link->master);
 386                 genpd_queue_power_off_work(link->master);
 387         }
 388
 389         return 0;
 390 }
 391
 392 /**
 393  * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
 394  * @work: Work structure used for scheduling the execution of this function.
 395  */
 396 static void genpd_power_off_work_fn(struct work_struct *work)
 397 {
 398         struct generic_pm_domain *genpd;
 399
 400         genpd = container_of(work, struct generic_pm_domain, power_off_work);
 401
 402         mutex_lock(&genpd->lock);
 403         pm_genpd_poweroff(genpd, true);
 404         mutex_unlock(&genpd->lock);
 405 }
 406
 407 /**
 408  * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
 409  * @dev: Device to suspend.
 410  *
 411  * Carry out a runtime suspend of a device under the assumption that its
 412  * pm_domain field points to the domain member of an object of type
 413  * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 414  */
 415 static int pm_genpd_runtime_suspend(struct device *dev)
 416 {
 417         struct generic_pm_domain *genpd;
 418         bool (*stop_ok)(struct device *__dev);
 419         int ret;
 420
 421         dev_dbg(dev, "%s()\n", __func__);
 422
 423         genpd = dev_to_genpd(dev);
 424         if (IS_ERR(genpd))
 425                 return -EINVAL;
 426
 427         stop_ok = genpd->gov ? genpd->gov->stop_ok : NULL;
 428         if (stop_ok && !stop_ok(dev))
 429                 return -EBUSY;
 430
 431         ret = genpd_save_dev(genpd, dev);
 432         if (ret)
 433                 return ret;
 434
 435         ret = genpd_stop_dev(genpd, dev);
 436         if (ret) {
 437                 genpd_restore_dev(genpd, dev, true);
 438                 return ret;
 439         }
 440
 441         /*
 442          * If power.irq_safe is set, this routine will be run with interrupts
 443          * off, so it can't use mutexes.
 444          */
 445         if (dev->power.irq_safe)
 446                 return 0;
 447
 448         mutex_lock(&genpd->lock);
 449         pm_genpd_poweroff(genpd, false);
 450         mutex_unlock(&genpd->lock);
 451
 452         return 0;
 453 }
 454
 455 /**
 456  * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
 457  * @dev: Device to resume.
 458  *
 459  * Carry out a runtime resume of a device under the assumption that its
 460  * pm_domain field points to the domain member of an object of type
 461  * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 462  */
 463 static int pm_genpd_runtime_resume(struct device *dev)
 464 {
 465         struct generic_pm_domain *genpd;
 466         int ret;
 467         bool timed = true;
 468
 469         dev_dbg(dev, "%s()\n", __func__);
 470
 471         genpd = dev_to_genpd(dev);
 472         if (IS_ERR(genpd))
 473                 return -EINVAL;
 474
 475         /* If power.irq_safe, the PM domain is never powered off. */
 476         if (dev->power.irq_safe) {
 477                 timed = false;
 478                 goto out;
 479         }
 480
 481         mutex_lock(&genpd->lock);
 482         ret = __pm_genpd_poweron(genpd);
 483         mutex_unlock(&genpd->lock);
 484
 485         if (ret)
 486                 return ret;
 487
 488  out:
 489         genpd_start_dev(genpd, dev, timed);
 490         genpd_restore_dev(genpd, dev, timed);
 491
 492         return 0;
 493 }
 494
 495 static bool pd_ignore_unused;
 496 static int __init pd_ignore_unused_setup(char *__unused)
 497 {
 498         pd_ignore_unused = true;
 499         return 1;
 500 }
 501 __setup("pd_ignore_unused", pd_ignore_unused_setup);
 502
 503 /**
 504  * genpd_poweroff_unused - Power off all PM domains with no devices in use.
 505  */
 506 static int __init genpd_poweroff_unused(void)
 507 {
 508         struct generic_pm_domain *genpd;
 509
 510         if (pd_ignore_unused) {
 511                 pr_warn("genpd: Not disabling unused power domains\n");
 512                 return 0;
 513         }
 514
 515         mutex_lock(&gpd_list_lock);
 516
 517         list_for_each_entry(genpd, &gpd_list, gpd_list_node)
 518                 genpd_queue_power_off_work(genpd);
 519
 520         mutex_unlock(&gpd_list_lock);
 521
 522         return 0;
 523 }
 524 late_initcall(genpd_poweroff_unused);
 525
 526 #ifdef CONFIG_PM_SLEEP
 527
 528 /**
 529  * pm_genpd_present - Check if the given PM domain has been initialized.
 530  * @genpd: PM domain to check.
 531  */
 532 static bool pm_genpd_present(const struct generic_pm_domain *genpd)
 533 {
 534         const struct generic_pm_domain *gpd;
 535
 536         if (IS_ERR_OR_NULL(genpd))
 537                 return false;
 538
 539         list_for_each_entry(gpd, &gpd_list, gpd_list_node)
 540                 if (gpd == genpd)
 541                         return true;
 542
 543         return false;
 544 }
 545
 546 static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
 547                                     struct device *dev)
 548 {
 549         return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
 550 }
 551
 552 /**
 553  * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
 554  * @genpd: PM domain to power off, if possible.
 555  * @timed: True if latency measurements are allowed.
 556  *
 557  * Check if the given PM domain can be powered off (during system suspend or
 558  * hibernation) and do that if so.  Also, in that case propagate to its masters.
 559  *
 560  * This function is only called in "noirq" and "syscore" stages of system power
 561  * transitions, so it need not acquire locks (all of the "noirq" callbacks are
 562  * executed sequentially, so it is guaranteed that it will never run twice in
 563  * parallel).
 564  */
 565 static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd,
 566                                    bool timed)
 567 {
 568         struct gpd_link *link;
 569
 570         if (genpd->status == GPD_STATE_POWER_OFF)
 571                 return;
 572
 573         if (genpd->suspended_count != genpd->device_count
 574             || atomic_read(&genpd->sd_count) > 0)
 575                 return;
 576
 577         genpd_power_off(genpd, timed);
 578
 579         genpd->status = GPD_STATE_POWER_OFF;
 580
 581         list_for_each_entry(link, &genpd->slave_links, slave_node) {
 582                 genpd_sd_counter_dec(link->master);
 583                 pm_genpd_sync_poweroff(link->master, timed);
 584         }
 585 }
 586
 587 /**
 588  * pm_genpd_sync_poweron - Synchronously power on a PM domain and its masters.
 589  * @genpd: PM domain to power on.
 590  * @timed: True if latency measurements are allowed.
 591  *
 592  * This function is only called in "noirq" and "syscore" stages of system power
 593  * transitions, so it need not acquire locks (all of the "noirq" callbacks are
 594  * executed sequentially, so it is guaranteed that it will never run twice in
 595  * parallel).
 596  */
 597 static void pm_genpd_sync_poweron(struct generic_pm_domain *genpd,
 598                                   bool timed)
 599 {
 600         struct gpd_link *link;
 601
 602         if (genpd->status == GPD_STATE_ACTIVE)
 603                 return;
 604
 605         list_for_each_entry(link, &genpd->slave_links, slave_node) {
 606                 pm_genpd_sync_poweron(link->master, timed);
 607                 genpd_sd_counter_inc(link->master);
 608         }
 609
 610         genpd_power_on(genpd, timed);
 611
 612         genpd->status = GPD_STATE_ACTIVE;
 613 }
 614
 615 /**
 616  * resume_needed - Check whether to resume a device before system suspend.
 617  * @dev: Device to check.
 618  * @genpd: PM domain the device belongs to.
 619  *
 620  * There are two cases in which a device that can wake up the system from sleep
 621  * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
 622  * to wake up the system and it has to remain active for this purpose while the
 623  * system is in the sleep state and (2) if the device is not enabled to wake up
 624  * the system from sleep states and it generally doesn't generate wakeup signals
 625  * by itself (those signals are generated on its behalf by other parts of the
 626  * system).  In the latter case it may be necessary to reconfigure the device's
 627  * wakeup settings during system suspend, because it may have been set up to
 628  * signal remote wakeup from the system's working state as needed by runtime PM.
 629  * Return 'true' in either of the above cases.
 630  */
 631 static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
 632 {
 633         bool active_wakeup;
 634
 635         if (!device_can_wakeup(dev))
 636                 return false;
 637
 638         active_wakeup = genpd_dev_active_wakeup(genpd, dev);
 639         return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
 640 }
 641
 642 /**
 643  * pm_genpd_prepare - Start power transition of a device in a PM domain.
 644  * @dev: Device to start the transition of.
 645  *
 646  * Start a power transition of a device (during a system-wide power transition)
 647  * under the assumption that its pm_domain field points to the domain member of
 648  * an object of type struct generic_pm_domain representing a PM domain
 649  * consisting of I/O devices.
 650  */
 651 static int pm_genpd_prepare(struct device *dev)
 652 {
 653         struct generic_pm_domain *genpd;
 654         int ret;
 655
 656         dev_dbg(dev, "%s()\n", __func__);
 657
 658         genpd = dev_to_genpd(dev);
 659         if (IS_ERR(genpd))
 660                 return -EINVAL;
 661
 662         /*
 663          * If a wakeup request is pending for the device, it should be woken up
 664          * at this point and a system wakeup event should be reported if it's
 665          * set up to wake up the system from sleep states.
 666          */
 667         pm_runtime_get_noresume(dev);
 668         if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
 669                 pm_wakeup_event(dev, 0);
 670
 671         if (pm_wakeup_pending()) {
 672                 pm_runtime_put(dev);
 673                 return -EBUSY;
 674         }
 675
 676         if (resume_needed(dev, genpd))
 677                 pm_runtime_resume(dev);
 678
 679         mutex_lock(&genpd->lock);
 680
 681         if (genpd->prepared_count++ == 0) {
 682                 genpd->suspended_count = 0;
 683                 genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
 684         }
 685
 686         mutex_unlock(&genpd->lock);
 687
 688         if (genpd->suspend_power_off) {
 689                 pm_runtime_put_noidle(dev);
 690                 return 0;
 691         }
 692
 693         /*
 694          * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
 695          * so pm_genpd_poweron() will return immediately, but if the device
 696          * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
 697          * to make it operational.
 698          */
 699         pm_runtime_resume(dev);
 700         __pm_runtime_disable(dev, false);
 701
 702         ret = pm_generic_prepare(dev);
 703         if (ret) {
 704                 mutex_lock(&genpd->lock);
 705
 706                 if (--genpd->prepared_count == 0)
 707                         genpd->suspend_power_off = false;
 708
 709                 mutex_unlock(&genpd->lock);
 710                 pm_runtime_enable(dev);
 711         }
 712
 713         pm_runtime_put(dev);
 714         return ret;
 715 }
 716
 717 /**
 718  * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
 719  * @dev: Device to suspend.
 720  *
 721  * Suspend a device under the assumption that its pm_domain field points to the
 722  * domain member of an object of type struct generic_pm_domain representing
 723  * a PM domain consisting of I/O devices.
 724  */
 725 static int pm_genpd_suspend(struct device *dev)
 726 {
 727         struct generic_pm_domain *genpd;
 728
 729         dev_dbg(dev, "%s()\n", __func__);
 730
 731         genpd = dev_to_genpd(dev);
 732         if (IS_ERR(genpd))
 733                 return -EINVAL;
 734
 735         return genpd->suspend_power_off ? 0 : pm_generic_suspend(dev);
 736 }
 737
 738 /**
 739  * pm_genpd_suspend_late - Late suspend of a device from an I/O PM domain.
 740  * @dev: Device to suspend.
 741  *
 742  * Carry out a late suspend of a device under the assumption that its
 743  * pm_domain field points to the domain member of an object of type
 744  * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 745  */
 746 static int pm_genpd_suspend_late(struct device *dev)
 747 {
 748         struct generic_pm_domain *genpd;
 749
 750         dev_dbg(dev, "%s()\n", __func__);
 751
 752         genpd = dev_to_genpd(dev);
 753         if (IS_ERR(genpd))
 754                 return -EINVAL;
 755
 756         return genpd->suspend_power_off ? 0 : pm_generic_suspend_late(dev);
 757 }
 758
 759 /**
 760  * pm_genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
 761  * @dev: Device to suspend.
 762  *
 763  * Stop the device and remove power from the domain if all devices in it have
 764  * been stopped.
 765  */
 766 static int pm_genpd_suspend_noirq(struct device *dev)
 767 {
 768         struct generic_pm_domain *genpd;
 769
 770         dev_dbg(dev, "%s()\n", __func__);
 771
 772         genpd = dev_to_genpd(dev);
 773         if (IS_ERR(genpd))
 774                 return -EINVAL;
 775
 776         if (genpd->suspend_power_off
 777             || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
 778                 return 0;
 779
 780         genpd_stop_dev(genpd, dev);
 781
 782         /*
 783          * Since all of the "noirq" callbacks are executed sequentially, it is
 784          * guaranteed that this function will never run twice in parallel for
 785          * the same PM domain, so it is not necessary to use locking here.
 786          */
 787         genpd->suspended_count++;
 788         pm_genpd_sync_poweroff(genpd, true);
 789
 790         return 0;
 791 }
 792
 793 /**
 794  * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
 795  * @dev: Device to resume.
 796  *
 797  * Restore power to the device's PM domain, if necessary, and start the device.
 798  */
 799 static int pm_genpd_resume_noirq(struct device *dev)
 800 {
 801         struct generic_pm_domain *genpd;
 802
 803         dev_dbg(dev, "%s()\n", __func__);
 804
 805         genpd = dev_to_genpd(dev);
 806         if (IS_ERR(genpd))
 807                 return -EINVAL;
 808
 809         if (genpd->suspend_power_off
 810             || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
 811                 return 0;
 812
 813         /*
 814          * Since all of the "noirq" callbacks are executed sequentially, it is
 815          * guaranteed that this function will never run twice in parallel for
 816          * the same PM domain, so it is not necessary to use locking here.
 817          */
 818         pm_genpd_sync_poweron(genpd, true);
 819         genpd->suspended_count--;
 820
 821         return genpd_start_dev(genpd, dev, true);
 822 }
 823
 824 /**
 825  * pm_genpd_resume_early - Early resume of a device in an I/O PM domain.
 826  * @dev: Device to resume.
 827  *
 828  * Carry out an early resume of a device under the assumption that its
 829  * pm_domain field points to the domain member of an object of type
 830  * struct generic_pm_domain representing a power domain consisting of I/O
 831  * devices.
 832  */
 833 static int pm_genpd_resume_early(struct device *dev)
 834 {
 835         struct generic_pm_domain *genpd;
 836
 837         dev_dbg(dev, "%s()\n", __func__);
 838
 839         genpd = dev_to_genpd(dev);
 840         if (IS_ERR(genpd))
 841                 return -EINVAL;
 842
 843         return genpd->suspend_power_off ? 0 : pm_generic_resume_early(dev);
 844 }
 845
 846 /**
 847  * pm_genpd_resume - Resume of device in an I/O PM domain.
 848  * @dev: Device to resume.
 849  *
 850  * Resume a device under the assumption that its pm_domain field points to the
 851  * domain member of an object of type struct generic_pm_domain representing
 852  * a power domain consisting of I/O devices.
 853  */
 854 static int pm_genpd_resume(struct device *dev)
 855 {
 856         struct generic_pm_domain *genpd;
 857
 858         dev_dbg(dev, "%s()\n", __func__);
 859
 860         genpd = dev_to_genpd(dev);
 861         if (IS_ERR(genpd))
 862                 return -EINVAL;
 863
 864         return genpd->suspend_power_off ? 0 : pm_generic_resume(dev);
 865 }
 866
 867 /**
 868  * pm_genpd_freeze - Freezing a device in an I/O PM domain.
 869  * @dev: Device to freeze.
 870  *
 871  * Freeze a device under the assumption that its pm_domain field points to the
 872  * domain member of an object of type struct generic_pm_domain representing
 873  * a power domain consisting of I/O devices.
 874  */
 875 static int pm_genpd_freeze(struct device *dev)
 876 {
 877         struct generic_pm_domain *genpd;
 878
 879         dev_dbg(dev, "%s()\n", __func__);
 880
 881         genpd = dev_to_genpd(dev);
 882         if (IS_ERR(genpd))
 883                 return -EINVAL;
 884
 885         return genpd->suspend_power_off ? 0 : pm_generic_freeze(dev);
 886 }
 887
 888 /**
 889  * pm_genpd_freeze_late - Late freeze of a device in an I/O PM domain.
 890  * @dev: Device to freeze.
 891  *
 892  * Carry out a late freeze of a device under the assumption that its
 893  * pm_domain field points to the domain member of an object of type
 894  * struct generic_pm_domain representing a power domain consisting of I/O
 895  * devices.
 896  */
 897 static int pm_genpd_freeze_late(struct device *dev)
 898 {
 899         struct generic_pm_domain *genpd;
 900
 901         dev_dbg(dev, "%s()\n", __func__);
 902
 903         genpd = dev_to_genpd(dev);
 904         if (IS_ERR(genpd))
 905                 return -EINVAL;
 906
 907         return genpd->suspend_power_off ? 0 : pm_generic_freeze_late(dev);
 908 }
 909
 910 /**
 911  * pm_genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
 912  * @dev: Device to freeze.
 913  *
 914  * Carry out a late freeze of a device under the assumption that its
 915  * pm_domain field points to the domain member of an object of type
 916  * struct generic_pm_domain representing a power domain consisting of I/O
 917  * devices.
 918  */
 919 static int pm_genpd_freeze_noirq(struct device *dev)
 920 {
 921         struct generic_pm_domain *genpd;
 922
 923         dev_dbg(dev, "%s()\n", __func__);
 924
 925         genpd = dev_to_genpd(dev);
 926         if (IS_ERR(genpd))
 927                 return -EINVAL;
 928
 929         return genpd->suspend_power_off ? 0 : genpd_stop_dev(genpd, dev);
 930 }
 931
 932 /**
 933  * pm_genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
 934  * @dev: Device to thaw.
 935  *
 936  * Start the device, unless power has been removed from the domain already
 937  * before the system transition.
 938  */
 939 static int pm_genpd_thaw_noirq(struct device *dev)
 940 {
 941         struct generic_pm_domain *genpd;
 942
 943         dev_dbg(dev, "%s()\n", __func__);
 944
 945         genpd = dev_to_genpd(dev);
 946         if (IS_ERR(genpd))
 947                 return -EINVAL;
 948
 949         return genpd->suspend_power_off ? 0 : genpd_start_dev(genpd, dev, true);
 950 }
 951
 952 /**
 953  * pm_genpd_thaw_early - Early thaw of device in an I/O PM domain.
 954  * @dev: Device to thaw.
 955  *
 956  * Carry out an early thaw of a device under the assumption that its
 957  * pm_domain field points to the domain member of an object of type
 958  * struct generic_pm_domain representing a power domain consisting of I/O
 959  * devices.
 960  */
 961 static int pm_genpd_thaw_early(struct device *dev)
 962 {
 963         struct generic_pm_domain *genpd;
 964
 965         dev_dbg(dev, "%s()\n", __func__);
 966
 967         genpd = dev_to_genpd(dev);
 968         if (IS_ERR(genpd))
 969                 return -EINVAL;
 970
 971         return genpd->suspend_power_off ? 0 : pm_generic_thaw_early(dev);
 972 }
 973
 974 /**
 975  * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
 976  * @dev: Device to thaw.
 977  *
 978  * Thaw a device under the assumption that its pm_domain field points to the
 979  * domain member of an object of type struct generic_pm_domain representing
 980  * a power domain consisting of I/O devices.
 981  */
 982 static int pm_genpd_thaw(struct device *dev)
 983 {
 984         struct generic_pm_domain *genpd;
 985
 986         dev_dbg(dev, "%s()\n", __func__);
 987
 988         genpd = dev_to_genpd(dev);
 989         if (IS_ERR(genpd))
 990                 return -EINVAL;
 991
 992         return genpd->suspend_power_off ? 0 : pm_generic_thaw(dev);
 993 }
 994
 995 /**
 996  * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
 997  * @dev: Device to resume.
 998  *
 999  * Make sure the domain will be in the same power state as before the
1000  * hibernation the system is resuming from and start the device if necessary.
1001  */
1002 static int pm_genpd_restore_noirq(struct device *dev)
1003 {
1004         struct generic_pm_domain *genpd;
1005
1006         dev_dbg(dev, "%s()\n", __func__);
1007
1008         genpd = dev_to_genpd(dev);
1009         if (IS_ERR(genpd))
1010                 return -EINVAL;
1011
1012         /*
1013          * Since all of the "noirq" callbacks are executed sequentially, it is
1014          * guaranteed that this function will never run twice in parallel for
1015          * the same PM domain, so it is not necessary to use locking here.
1016          *
1017          * At this point suspended_count == 0 means we are being run for the
1018          * first time for the given domain in the present cycle.
1019          */
1020         if (genpd->suspended_count++ == 0) {
1021                 /*
1022                  * The boot kernel might put the domain into arbitrary state,
1023                  * so make it appear as powered off to pm_genpd_sync_poweron(),
1024                  * so that it tries to power it on in case it was really off.
1025                  */
1026                 genpd->status = GPD_STATE_POWER_OFF;
1027                 if (genpd->suspend_power_off) {
1028                         /*
1029                          * If the domain was off before the hibernation, make
1030                          * sure it will be off going forward.
1031                          */
1032                         genpd_power_off(genpd, true);
1033
1034                         return 0;
1035                 }
1036         }
1037
1038         if (genpd->suspend_power_off)
1039                 return 0;
1040
1041         pm_genpd_sync_poweron(genpd, true);
1042
1043         return genpd_start_dev(genpd, dev, true);
1044 }
1045
1046 /**
1047  * pm_genpd_complete - Complete power transition of a device in a power domain.
1048  * @dev: Device to complete the transition of.
1049  *
1050  * Complete a power transition of a device (during a system-wide power
1051  * transition) under the assumption that its pm_domain field points to the
1052  * domain member of an object of type struct generic_pm_domain representing
1053  * a power domain consisting of I/O devices.
1054  */
1055 static void pm_genpd_complete(struct device *dev)
1056 {
1057         struct generic_pm_domain *genpd;
1058         bool run_complete;
1059
1060         dev_dbg(dev, "%s()\n", __func__);
1061
1062         genpd = dev_to_genpd(dev);
1063         if (IS_ERR(genpd))
1064                 return;
1065
1066         mutex_lock(&genpd->lock);
1067
1068         run_complete = !genpd->suspend_power_off;
1069         if (--genpd->prepared_count == 0)
1070                 genpd->suspend_power_off = false;
1071
1072         mutex_unlock(&genpd->lock);
1073
1074         if (run_complete) {
1075                 pm_generic_complete(dev);
1076                 pm_runtime_set_active(dev);
1077                 pm_runtime_enable(dev);
1078                 pm_request_idle(dev);
1079         }
1080 }
1081
1082 /**
1083  * genpd_syscore_switch - Switch power during system core suspend or resume.
1084  * @dev: Device that normally is marked as "always on" to switch power for.
1085  *
1086  * This routine may only be called during the system core (syscore) suspend or
1087  * resume phase for devices whose "always on" flags are set.
1088  */
1089 static void genpd_syscore_switch(struct device *dev, bool suspend)
1090 {
1091         struct generic_pm_domain *genpd;
1092
1093         genpd = dev_to_genpd(dev);
1094         if (!pm_genpd_present(genpd))
1095                 return;
1096
1097         if (suspend) {
1098                 genpd->suspended_count++;
1099                 pm_genpd_sync_poweroff(genpd, false);
1100         } else {
1101                 pm_genpd_sync_poweron(genpd, false);
1102                 genpd->suspended_count--;
1103         }
1104 }
1105
1106 void pm_genpd_syscore_poweroff(struct device *dev)
1107 {
1108         genpd_syscore_switch(dev, true);
1109 }
1110 EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweroff);
1111
1112 void pm_genpd_syscore_poweron(struct device *dev)
1113 {
1114         genpd_syscore_switch(dev, false);
1115 }
1116 EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweron);
1117
1118 #else /* !CONFIG_PM_SLEEP */
1119
1120 #define pm_genpd_prepare                NULL
1121 #define pm_genpd_suspend                NULL
1122 #define pm_genpd_suspend_late           NULL
1123 #define pm_genpd_suspend_noirq          NULL
1124 #define pm_genpd_resume_early           NULL
1125 #define pm_genpd_resume_noirq           NULL
1126 #define pm_genpd_resume                 NULL
1127 #define pm_genpd_freeze                 NULL
1128 #define pm_genpd_freeze_late            NULL
1129 #define pm_genpd_freeze_noirq           NULL
1130 #define pm_genpd_thaw_early             NULL
1131 #define pm_genpd_thaw_noirq             NULL
1132 #define pm_genpd_thaw                   NULL
1133 #define pm_genpd_restore_noirq          NULL
1134 #define pm_genpd_complete               NULL
1135
1136 #endif /* CONFIG_PM_SLEEP */
1137
1138 static struct generic_pm_domain_data *genpd_alloc_dev_data(struct device *dev,
1139                                         struct generic_pm_domain *genpd,
1140                                         struct gpd_timing_data *td)
1141 {
1142         struct generic_pm_domain_data *gpd_data;
1143         int ret;
1144
1145         ret = dev_pm_get_subsys_data(dev);
1146         if (ret)
1147                 return ERR_PTR(ret);
1148
1149         gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
1150         if (!gpd_data) {
1151                 ret = -ENOMEM;
1152                 goto err_put;
1153         }
1154
1155         if (td)
1156                 gpd_data->td = *td;
1157
1158         gpd_data->base.dev = dev;
1159         gpd_data->td.constraint_changed = true;
1160         gpd_data->td.effective_constraint_ns = -1;
1161         gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
1162
1163         spin_lock_irq(&dev->power.lock);
1164
1165         if (dev->power.subsys_data->domain_data) {
1166                 ret = -EINVAL;
1167                 goto err_free;
1168         }
1169
1170         dev->power.subsys_data->domain_data = &gpd_data->base;
1171         dev->pm_domain = &genpd->domain;
1172
1173         spin_unlock_irq(&dev->power.lock);
1174
1175         return gpd_data;
1176
1177  err_free:
1178         spin_unlock_irq(&dev->power.lock);
1179         kfree(gpd_data);
1180  err_put:
1181         dev_pm_put_subsys_data(dev);
1182         return ERR_PTR(ret);
1183 }
1184
1185 static void genpd_free_dev_data(struct device *dev,
1186                                 struct generic_pm_domain_data *gpd_data)
1187 {
1188         spin_lock_irq(&dev->power.lock);
1189
1190         dev->pm_domain = NULL;
1191         dev->power.subsys_data->domain_data = NULL;
1192
1193         spin_unlock_irq(&dev->power.lock);
1194
1195         kfree(gpd_data);
1196         dev_pm_put_subsys_data(dev);
1197 }
1198
1199 /**
1200  * __pm_genpd_add_device - Add a device to an I/O PM domain.
1201  * @genpd: PM domain to add the device to.
1202  * @dev: Device to be added.
1203  * @td: Set of PM QoS timing parameters to attach to the device.
1204  */
1205 int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1206                           struct gpd_timing_data *td)
1207 {
1208         struct generic_pm_domain_data *gpd_data;
1209         int ret = 0;
1210
1211         dev_dbg(dev, "%s()\n", __func__);
1212
1213         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1214                 return -EINVAL;
1215
1216         gpd_data = genpd_alloc_dev_data(dev, genpd, td);
1217         if (IS_ERR(gpd_data))
1218                 return PTR_ERR(gpd_data);
1219
1220         mutex_lock(&genpd->lock);
1221
1222         if (genpd->prepared_count > 0) {
1223                 ret = -EAGAIN;
1224                 goto out;
1225         }
1226
1227         ret = genpd->attach_dev ? genpd->attach_dev(genpd, dev) : 0;
1228         if (ret)
1229                 goto out;
1230
1231         genpd->device_count++;
1232         genpd->max_off_time_changed = true;
1233
1234         list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1235
1236  out:
1237         mutex_unlock(&genpd->lock);
1238
1239         if (ret)
1240                 genpd_free_dev_data(dev, gpd_data);
1241         else
1242                 dev_pm_qos_add_notifier(dev, &gpd_data->nb);
1243
1244         return ret;
1245 }
1246
1247 /**
1248  * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1249  * @genpd: PM domain to remove the device from.
1250  * @dev: Device to be removed.
1251  */
1252 int pm_genpd_remove_device(struct generic_pm_domain *genpd,
1253                            struct device *dev)
1254 {
1255         struct generic_pm_domain_data *gpd_data;
1256         struct pm_domain_data *pdd;
1257         int ret = 0;
1258
1259         dev_dbg(dev, "%s()\n", __func__);
1260
1261         if (!genpd || genpd != pm_genpd_lookup_dev(dev))
1262                 return -EINVAL;
1263
1264         /* The above validation also means we have existing domain_data. */
1265         pdd = dev->power.subsys_data->domain_data;
1266         gpd_data = to_gpd_data(pdd);
1267         dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
1268
1269         mutex_lock(&genpd->lock);
1270
1271         if (genpd->prepared_count > 0) {
1272                 ret = -EAGAIN;
1273                 goto out;
1274         }
1275
1276         genpd->device_count--;
1277         genpd->max_off_time_changed = true;
1278
1279         if (genpd->detach_dev)
1280                 genpd->detach_dev(genpd, dev);
1281
1282         list_del_init(&pdd->list_node);
1283
1284         mutex_unlock(&genpd->lock);
1285
1286         genpd_free_dev_data(dev, gpd_data);
1287
1288         return 0;
1289
1290  out:
1291         mutex_unlock(&genpd->lock);
1292         dev_pm_qos_add_notifier(dev, &gpd_data->nb);
1293
1294         return ret;
1295 }
1296
1297 /**
1298  * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1299  * @genpd: Master PM domain to add the subdomain to.
1300  * @subdomain: Subdomain to be added.
1301  */
1302 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1303                            struct generic_pm_domain *subdomain)
1304 {
1305         struct gpd_link *link;
1306         int ret = 0;
1307
1308         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
1309             || genpd == subdomain)
1310                 return -EINVAL;
1311
1312         mutex_lock(&genpd->lock);
1313         mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1314
1315         if (genpd->status == GPD_STATE_POWER_OFF
1316             &&  subdomain->status != GPD_STATE_POWER_OFF) {
1317                 ret = -EINVAL;
1318                 goto out;
1319         }
1320
1321         list_for_each_entry(link, &genpd->master_links, master_node) {
1322                 if (link->slave == subdomain && link->master == genpd) {
1323                         ret = -EINVAL;
1324                         goto out;
1325                 }
1326         }
1327
1328         link = kzalloc(sizeof(*link), GFP_KERNEL);
1329         if (!link) {
1330                 ret = -ENOMEM;
1331                 goto out;
1332         }
1333         link->master = genpd;
1334         list_add_tail(&link->master_node, &genpd->master_links);
1335         link->slave = subdomain;
1336         list_add_tail(&link->slave_node, &subdomain->slave_links);
1337         if (subdomain->status != GPD_STATE_POWER_OFF)
1338                 genpd_sd_counter_inc(genpd);
1339
1340  out:
1341         mutex_unlock(&subdomain->lock);
1342         mutex_unlock(&genpd->lock);
1343
1344         return ret;
1345 }
1346
1347 /**
1348  * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1349  * @genpd: Master PM domain to remove the subdomain from.
1350  * @subdomain: Subdomain to be removed.
1351  */
1352 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1353                               struct generic_pm_domain *subdomain)
1354 {
1355         struct gpd_link *link;
1356         int ret = -EINVAL;
1357
1358         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1359                 return -EINVAL;
1360
1361         mutex_lock(&genpd->lock);
1362
1363         if (!list_empty(&subdomain->slave_links) || subdomain->device_count) {
1364                 pr_warn("%s: unable to remove subdomain %s\n", genpd->name,
1365                         subdomain->name);
1366                 ret = -EBUSY;
1367                 goto out;
1368         }
1369
1370         list_for_each_entry(link, &genpd->master_links, master_node) {
1371                 if (link->slave != subdomain)
1372                         continue;
1373
1374                 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1375
1376                 list_del(&link->master_node);
1377                 list_del(&link->slave_node);
1378                 kfree(link);
1379                 if (subdomain->status != GPD_STATE_POWER_OFF)
1380                         genpd_sd_counter_dec(genpd);
1381
1382                 mutex_unlock(&subdomain->lock);
1383
1384                 ret = 0;
1385                 break;
1386         }
1387
1388 out:
1389         mutex_unlock(&genpd->lock);
1390
1391         return ret;
1392 }
1393
1394 /* Default device callbacks for generic PM domains. */
1395
1396 /**
1397  * pm_genpd_default_save_state - Default "save device state" for PM domains.
1398  * @dev: Device to handle.
1399  */
1400 static int pm_genpd_default_save_state(struct device *dev)
1401 {
1402         int (*cb)(struct device *__dev);
1403
1404         if (dev->type && dev->type->pm)
1405                 cb = dev->type->pm->runtime_suspend;
1406         else if (dev->class && dev->class->pm)
1407                 cb = dev->class->pm->runtime_suspend;
1408         else if (dev->bus && dev->bus->pm)
1409                 cb = dev->bus->pm->runtime_suspend;
1410         else
1411                 cb = NULL;
1412
1413         if (!cb && dev->driver && dev->driver->pm)
1414                 cb = dev->driver->pm->runtime_suspend;
1415
1416         return cb ? cb(dev) : 0;
1417 }
1418
1419 /**
1420  * pm_genpd_default_restore_state - Default PM domains "restore device state".
1421  * @dev: Device to handle.
1422  */
1423 static int pm_genpd_default_restore_state(struct device *dev)
1424 {
1425         int (*cb)(struct device *__dev);
1426
1427         if (dev->type && dev->type->pm)
1428                 cb = dev->type->pm->runtime_resume;
1429         else if (dev->class && dev->class->pm)
1430                 cb = dev->class->pm->runtime_resume;
1431         else if (dev->bus && dev->bus->pm)
1432                 cb = dev->bus->pm->runtime_resume;
1433         else
1434                 cb = NULL;
1435
1436         if (!cb && dev->driver && dev->driver->pm)
1437                 cb = dev->driver->pm->runtime_resume;
1438
1439         return cb ? cb(dev) : 0;
1440 }
1441
1442 /**
1443  * pm_genpd_init - Initialize a generic I/O PM domain object.
1444  * @genpd: PM domain object to initialize.
1445  * @gov: PM domain governor to associate with the domain (may be NULL).
1446  * @is_off: Initial value of the domain's power_is_off field.
1447  */
1448 void pm_genpd_init(struct generic_pm_domain *genpd,
1449                    struct dev_power_governor *gov, bool is_off)
1450 {
1451         if (IS_ERR_OR_NULL(genpd))
1452                 return;
1453
1454         INIT_LIST_HEAD(&genpd->master_links);
1455         INIT_LIST_HEAD(&genpd->slave_links);
1456         INIT_LIST_HEAD(&genpd->dev_list);
1457         mutex_init(&genpd->lock);
1458         genpd->gov = gov;
1459         INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
1460         atomic_set(&genpd->sd_count, 0);
1461         genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
1462         genpd->device_count = 0;
1463         genpd->max_off_time_ns = -1;
1464         genpd->max_off_time_changed = true;
1465         genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
1466         genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
1467         genpd->domain.ops.prepare = pm_genpd_prepare;
1468         genpd->domain.ops.suspend = pm_genpd_suspend;
1469         genpd->domain.ops.suspend_late = pm_genpd_suspend_late;
1470         genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
1471         genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1472         genpd->domain.ops.resume_early = pm_genpd_resume_early;
1473         genpd->domain.ops.resume = pm_genpd_resume;
1474         genpd->domain.ops.freeze = pm_genpd_freeze;
1475         genpd->domain.ops.freeze_late = pm_genpd_freeze_late;
1476         genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
1477         genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1478         genpd->domain.ops.thaw_early = pm_genpd_thaw_early;
1479         genpd->domain.ops.thaw = pm_genpd_thaw;
1480         genpd->domain.ops.poweroff = pm_genpd_suspend;
1481         genpd->domain.ops.poweroff_late = pm_genpd_suspend_late;
1482         genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
1483         genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
1484         genpd->domain.ops.restore_early = pm_genpd_resume_early;
1485         genpd->domain.ops.restore = pm_genpd_resume;
1486         genpd->domain.ops.complete = pm_genpd_complete;
1487         genpd->dev_ops.save_state = pm_genpd_default_save_state;
1488         genpd->dev_ops.restore_state = pm_genpd_default_restore_state;
1489
1490         if (genpd->flags & GENPD_FLAG_PM_CLK) {
1491                 genpd->dev_ops.stop = pm_clk_suspend;
1492                 genpd->dev_ops.start = pm_clk_resume;
1493         }
1494
1495         mutex_lock(&gpd_list_lock);
1496         list_add(&genpd->gpd_list_node, &gpd_list);
1497         mutex_unlock(&gpd_list_lock);
1498 }
1499 EXPORT_SYMBOL_GPL(pm_genpd_init);
1500
1501 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
1502 /*
1503  * Device Tree based PM domain providers.
1504  *
1505  * The code below implements generic device tree based PM domain providers that
1506  * bind device tree nodes with generic PM domains registered in the system.
1507  *
1508  * Any driver that registers generic PM domains and needs to support binding of
1509  * devices to these domains is supposed to register a PM domain provider, which
1510  * maps a PM domain specifier retrieved from the device tree to a PM domain.
1511  *
1512  * Two simple mapping functions have been provided for convenience:
1513  *  - __of_genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
1514  *  - __of_genpd_xlate_onecell() for mapping of multiple PM domains per node by
1515  *    index.
1516  */
1517
1518 /**
1519  * struct of_genpd_provider - PM domain provider registration structure
1520  * @link: Entry in global list of PM domain providers
1521  * @node: Pointer to device tree node of PM domain provider
1522  * @xlate: Provider-specific xlate callback mapping a set of specifier cells
1523  *         into a PM domain.
1524  * @data: context pointer to be passed into @xlate callback
1525  */
1526 struct of_genpd_provider {
1527         struct list_head link;
1528         struct device_node *node;
1529         genpd_xlate_t xlate;
1530         void *data;
1531 };
1532
1533 /* List of registered PM domain providers. */
1534 static LIST_HEAD(of_genpd_providers);
1535 /* Mutex to protect the list above. */
1536 static DEFINE_MUTEX(of_genpd_mutex);
1537
1538 /**
1539  * __of_genpd_xlate_simple() - Xlate function for direct node-domain mapping
1540  * @genpdspec: OF phandle args to map into a PM domain
1541  * @data: xlate function private data - pointer to struct generic_pm_domain
1542  *
1543  * This is a generic xlate function that can be used to model PM domains that
1544  * have their own device tree nodes. The private data of xlate function needs
1545  * to be a valid pointer to struct generic_pm_domain.
1546  */
1547 struct generic_pm_domain *__of_genpd_xlate_simple(
1548                                         struct of_phandle_args *genpdspec,
1549                                         void *data)
1550 {
1551         if (genpdspec->args_count != 0)
1552                 return ERR_PTR(-EINVAL);
1553         return data;
1554 }
1555 EXPORT_SYMBOL_GPL(__of_genpd_xlate_simple);
1556
1557 /**
1558  * __of_genpd_xlate_onecell() - Xlate function using a single index.
1559  * @genpdspec: OF phandle args to map into a PM domain
1560  * @data: xlate function private data - pointer to struct genpd_onecell_data
1561  *
1562  * This is a generic xlate function that can be used to model simple PM domain
1563  * controllers that have one device tree node and provide multiple PM domains.
1564  * A single cell is used as an index into an array of PM domains specified in
1565  * the genpd_onecell_data struct when registering the provider.
1566  */
1567 struct generic_pm_domain *__of_genpd_xlate_onecell(
1568                                         struct of_phandle_args *genpdspec,
1569                                         void *data)
1570 {
1571         struct genpd_onecell_data *genpd_data = data;
1572         unsigned int idx = genpdspec->args[0];
1573
1574         if (genpdspec->args_count != 1)
1575                 return ERR_PTR(-EINVAL);
1576
1577         if (idx >= genpd_data->num_domains) {
1578                 pr_err("%s: invalid domain index %u\n", __func__, idx);
1579                 return ERR_PTR(-EINVAL);
1580         }
1581
1582         if (!genpd_data->domains[idx])
1583                 return ERR_PTR(-ENOENT);
1584
1585         return genpd_data->domains[idx];
1586 }
1587 EXPORT_SYMBOL_GPL(__of_genpd_xlate_onecell);
1588
1589 /**
1590  * __of_genpd_add_provider() - Register a PM domain provider for a node
1591  * @np: Device node pointer associated with the PM domain provider.
1592  * @xlate: Callback for decoding PM domain from phandle arguments.
1593  * @data: Context pointer for @xlate callback.
1594  */
1595 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
1596                         void *data)
1597 {
1598         struct of_genpd_provider *cp;
1599
1600         cp = kzalloc(sizeof(*cp), GFP_KERNEL);
1601         if (!cp)
1602                 return -ENOMEM;
1603
1604         cp->node = of_node_get(np);
1605         cp->data = data;
1606         cp->xlate = xlate;
1607
1608         mutex_lock(&of_genpd_mutex);
1609         list_add(&cp->link, &of_genpd_providers);
1610         mutex_unlock(&of_genpd_mutex);
1611         pr_debug("Added domain provider from %s\n", np->full_name);
1612
1613         return 0;
1614 }
1615 EXPORT_SYMBOL_GPL(__of_genpd_add_provider);
1616
1617 /**
1618  * of_genpd_del_provider() - Remove a previously registered PM domain provider
1619  * @np: Device node pointer associated with the PM domain provider
1620  */
1621 void of_genpd_del_provider(struct device_node *np)
1622 {
1623         struct of_genpd_provider *cp;
1624
1625         mutex_lock(&of_genpd_mutex);
1626         list_for_each_entry(cp, &of_genpd_providers, link) {
1627                 if (cp->node == np) {
1628                         list_del(&cp->link);
1629                         of_node_put(cp->node);
1630                         kfree(cp);
1631                         break;
1632                 }
1633         }
1634         mutex_unlock(&of_genpd_mutex);
1635 }
1636 EXPORT_SYMBOL_GPL(of_genpd_del_provider);
1637
1638 /**
1639  * of_genpd_get_from_provider() - Look-up PM domain
1640  * @genpdspec: OF phandle args to use for look-up
1641  *
1642  * Looks for a PM domain provider under the node specified by @genpdspec and if
1643  * found, uses xlate function of the provider to map phandle args to a PM
1644  * domain.
1645  *
1646  * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
1647  * on failure.
1648  */
1649 struct generic_pm_domain *of_genpd_get_from_provider(
1650                                         struct of_phandle_args *genpdspec)
1651 {
1652         struct generic_pm_domain *genpd = ERR_PTR(-ENOENT);
1653         struct of_genpd_provider *provider;
1654
1655         mutex_lock(&of_genpd_mutex);
1656
1657         /* Check if we have such a provider in our array */
1658         list_for_each_entry(provider, &of_genpd_providers, link) {
1659                 if (provider->node == genpdspec->np)
1660                         genpd = provider->xlate(genpdspec, provider->data);
1661                 if (!IS_ERR(genpd))
1662                         break;
1663         }
1664
1665         mutex_unlock(&of_genpd_mutex);
1666
1667         return genpd;
1668 }
1669 EXPORT_SYMBOL_GPL(of_genpd_get_from_provider);
1670
1671 /**
1672  * genpd_dev_pm_detach - Detach a device from its PM domain.
1673  * @dev: Device to detach.
1674  * @power_off: Currently not used
1675  *
1676  * Try to locate a corresponding generic PM domain, which the device was
1677  * attached to previously. If such is found, the device is detached from it.
1678  */
1679 static void genpd_dev_pm_detach(struct device *dev, bool power_off)
1680 {
1681         struct generic_pm_domain *pd;
1682         unsigned int i;
1683         int ret = 0;
1684
1685         pd = pm_genpd_lookup_dev(dev);
1686         if (!pd)
1687                 return;
1688
1689         dev_dbg(dev, "removing from PM domain %s\n", pd->name);
1690
1691         for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
1692                 ret = pm_genpd_remove_device(pd, dev);
1693                 if (ret != -EAGAIN)
1694                         break;
1695
1696                 mdelay(i);
1697                 cond_resched();
1698         }
1699
1700         if (ret < 0) {
1701                 dev_err(dev, "failed to remove from PM domain %s: %d",
1702                         pd->name, ret);
1703                 return;
1704         }
1705
1706         /* Check if PM domain can be powered off after removing this device. */
1707         genpd_queue_power_off_work(pd);
1708 }
1709
1710 static void genpd_dev_pm_sync(struct device *dev)
1711 {
1712         struct generic_pm_domain *pd;
1713
1714         pd = dev_to_genpd(dev);
1715         if (IS_ERR(pd))
1716                 return;
1717
1718         genpd_queue_power_off_work(pd);
1719 }
1720
1721 /**
1722  * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
1723  * @dev: Device to attach.
1724  *
1725  * Parse device's OF node to find a PM domain specifier. If such is found,
1726  * attaches the device to retrieved pm_domain ops.
1727  *
1728  * Both generic and legacy Samsung-specific DT bindings are supported to keep
1729  * backwards compatibility with existing DTBs.
1730  *
1731  * Returns 0 on successfully attached PM domain or negative error code. Note
1732  * that if a power-domain exists for the device, but it cannot be found or
1733  * turned on, then return -EPROBE_DEFER to ensure that the device is not
1734  * probed and to re-try again later.
1735  */
1736 int genpd_dev_pm_attach(struct device *dev)
1737 {
1738         struct of_phandle_args pd_args;
1739         struct generic_pm_domain *pd;
1740         unsigned int i;
1741         int ret;
1742
1743         if (!dev->of_node)
1744                 return -ENODEV;
1745
1746         if (dev->pm_domain)
1747                 return -EEXIST;
1748
1749         ret = of_parse_phandle_with_args(dev->of_node, "power-domains",
1750                                         "#power-domain-cells", 0, &pd_args);
1751         if (ret < 0) {
1752                 if (ret != -ENOENT)
1753                         return ret;
1754
1755                 /*
1756                  * Try legacy Samsung-specific bindings
1757                  * (for backwards compatibility of DT ABI)
1758                  */
1759                 pd_args.args_count = 0;
1760                 pd_args.np = of_parse_phandle(dev->of_node,
1761                                                 "samsung,power-domain", 0);
1762                 if (!pd_args.np)
1763                         return -ENOENT;
1764         }
1765
1766         pd = of_genpd_get_from_provider(&pd_args);
1767         if (IS_ERR(pd)) {
1768                 dev_dbg(dev, "%s() failed to find PM domain: %ld\n",
1769                         __func__, PTR_ERR(pd));
1770                 of_node_put(dev->of_node);
1771                 return -EPROBE_DEFER;
1772         }
1773
1774         dev_dbg(dev, "adding to PM domain %s\n", pd->name);
1775
1776         for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
1777                 ret = pm_genpd_add_device(pd, dev);
1778                 if (ret != -EAGAIN)
1779                         break;
1780
1781                 mdelay(i);
1782                 cond_resched();
1783         }
1784
1785         if (ret < 0) {
1786                 dev_err(dev, "failed to add to PM domain %s: %d",
1787                         pd->name, ret);
1788                 of_node_put(dev->of_node);
1789                 goto out;
1790         }
1791
1792         dev->pm_domain->detach = genpd_dev_pm_detach;
1793         dev->pm_domain->sync = genpd_dev_pm_sync;
1794         ret = pm_genpd_poweron(pd);
1795
1796 out:
1797         return ret ? -EPROBE_DEFER : 0;
1798 }
1799 EXPORT_SYMBOL_GPL(genpd_dev_pm_attach);
1800 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
1801
1802
1803 /***        debugfs support        ***/
1804
1805 #ifdef CONFIG_PM_ADVANCED_DEBUG
1806 #include <linux/pm.h>
1807 #include <linux/device.h>
1808 #include <linux/debugfs.h>
1809 #include <linux/seq_file.h>
1810 #include <linux/init.h>
1811 #include <linux/kobject.h>
1812 static struct dentry *pm_genpd_debugfs_dir;
1813
1814 /*
1815  * TODO: This function is a slightly modified version of rtpm_status_show
1816  * from sysfs.c, so generalize it.
1817  */
1818 static void rtpm_status_str(struct seq_file *s, struct device *dev)
1819 {
1820         static const char * const status_lookup[] = {
1821                 [RPM_ACTIVE] = "active",
1822                 [RPM_RESUMING] = "resuming",
1823                 [RPM_SUSPENDED] = "suspended",
1824                 [RPM_SUSPENDING] = "suspending"
1825         };
1826         const char *p = "";
1827
1828         if (dev->power.runtime_error)
1829                 p = "error";
1830         else if (dev->power.disable_depth)
1831                 p = "unsupported";
1832         else if (dev->power.runtime_status < ARRAY_SIZE(status_lookup))
1833                 p = status_lookup[dev->power.runtime_status];
1834         else
1835                 WARN_ON(1);
1836
1837         seq_puts(s, p);
1838 }
1839
1840 static int pm_genpd_summary_one(struct seq_file *s,
1841                                 struct generic_pm_domain *genpd)
1842 {
1843         static const char * const status_lookup[] = {
1844                 [GPD_STATE_ACTIVE] = "on",
1845                 [GPD_STATE_POWER_OFF] = "off"
1846         };
1847         struct pm_domain_data *pm_data;
1848         const char *kobj_path;
1849         struct gpd_link *link;
1850         int ret;
1851
1852         ret = mutex_lock_interruptible(&genpd->lock);
1853         if (ret)
1854                 return -ERESTARTSYS;
1855
1856         if (WARN_ON(genpd->status >= ARRAY_SIZE(status_lookup)))
1857                 goto exit;
1858         seq_printf(s, "%-30s  %-15s ", genpd->name, status_lookup[genpd->status]);
1859
1860         /*
1861          * Modifications on the list require holding locks on both
1862          * master and slave, so we are safe.
1863          * Also genpd->name is immutable.
1864          */
1865         list_for_each_entry(link, &genpd->master_links, master_node) {
1866                 seq_printf(s, "%s", link->slave->name);
1867                 if (!list_is_last(&link->master_node, &genpd->master_links))
1868                         seq_puts(s, ", ");
1869         }
1870
1871         list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
1872                 kobj_path = kobject_get_path(&pm_data->dev->kobj, GFP_KERNEL);
1873                 if (kobj_path == NULL)
1874                         continue;
1875
1876                 seq_printf(s, "\n    %-50s  ", kobj_path);
1877                 rtpm_status_str(s, pm_data->dev);
1878                 kfree(kobj_path);
1879         }
1880
1881         seq_puts(s, "\n");
1882 exit:
1883         mutex_unlock(&genpd->lock);
1884
1885         return 0;
1886 }
1887
1888 static int pm_genpd_summary_show(struct seq_file *s, void *data)
1889 {
1890         struct generic_pm_domain *genpd;
1891         int ret = 0;
1892
1893         seq_puts(s, "domain                          status          slaves\n");
1894         seq_puts(s, "    /device                                             runtime status\n");
1895         seq_puts(s, "----------------------------------------------------------------------\n");
1896
1897         ret = mutex_lock_interruptible(&gpd_list_lock);
1898         if (ret)
1899                 return -ERESTARTSYS;
1900
1901         list_for_each_entry(genpd, &gpd_list, gpd_list_node) {
1902                 ret = pm_genpd_summary_one(s, genpd);
1903                 if (ret)
1904                         break;
1905         }
1906         mutex_unlock(&gpd_list_lock);
1907
1908         return ret;
1909 }
1910
1911 static int pm_genpd_summary_open(struct inode *inode, struct file *file)
1912 {
1913         return single_open(file, pm_genpd_summary_show, NULL);
1914 }
1915
1916 static const struct file_operations pm_genpd_summary_fops = {
1917         .open = pm_genpd_summary_open,
1918         .read = seq_read,
1919         .llseek = seq_lseek,
1920         .release = single_release,
1921 };
1922
1923 static int __init pm_genpd_debug_init(void)
1924 {
1925         struct dentry *d;
1926
1927         pm_genpd_debugfs_dir = debugfs_create_dir("pm_genpd", NULL);
1928
1929         if (!pm_genpd_debugfs_dir)
1930                 return -ENOMEM;
1931
1932         d = debugfs_create_file("pm_genpd_summary", S_IRUGO,
1933                         pm_genpd_debugfs_dir, NULL, &pm_genpd_summary_fops);
1934         if (!d)
1935                 return -ENOMEM;
1936
1937         return 0;
1938 }
1939 late_initcall(pm_genpd_debug_init);
1940
1941 static void __exit pm_genpd_debug_exit(void)
1942 {
1943         debugfs_remove_recursive(pm_genpd_debugfs_dir);
1944 }
1945 __exitcall(pm_genpd_debug_exit);
1946 #endif /* CONFIG_PM_ADVANCED_DEBUG */