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