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