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