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