Merge tag 'dt-5.15' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[linux-2.6-microblaze.git] / drivers / base / power / domain.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * drivers/base/power/domain.c - Common code related to device power domains.
4  *
5  * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
6  */
7 #define pr_fmt(fmt) "PM: " fmt
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_opp.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/pm_domain.h>
16 #include <linux/pm_qos.h>
17 #include <linux/pm_clock.h>
18 #include <linux/slab.h>
19 #include <linux/err.h>
20 #include <linux/sched.h>
21 #include <linux/suspend.h>
22 #include <linux/export.h>
23 #include <linux/cpu.h>
24 #include <linux/debugfs.h>
25
26 #include "power.h"
27
28 #define GENPD_RETRY_MAX_MS      250             /* Approximate */
29
30 #define GENPD_DEV_CALLBACK(genpd, type, callback, dev)          \
31 ({                                                              \
32         type (*__routine)(struct device *__d);                  \
33         type __ret = (type)0;                                   \
34                                                                 \
35         __routine = genpd->dev_ops.callback;                    \
36         if (__routine) {                                        \
37                 __ret = __routine(dev);                         \
38         }                                                       \
39         __ret;                                                  \
40 })
41
42 static LIST_HEAD(gpd_list);
43 static DEFINE_MUTEX(gpd_list_lock);
44
45 struct genpd_lock_ops {
46         void (*lock)(struct generic_pm_domain *genpd);
47         void (*lock_nested)(struct generic_pm_domain *genpd, int depth);
48         int (*lock_interruptible)(struct generic_pm_domain *genpd);
49         void (*unlock)(struct generic_pm_domain *genpd);
50 };
51
52 static void genpd_lock_mtx(struct generic_pm_domain *genpd)
53 {
54         mutex_lock(&genpd->mlock);
55 }
56
57 static void genpd_lock_nested_mtx(struct generic_pm_domain *genpd,
58                                         int depth)
59 {
60         mutex_lock_nested(&genpd->mlock, depth);
61 }
62
63 static int genpd_lock_interruptible_mtx(struct generic_pm_domain *genpd)
64 {
65         return mutex_lock_interruptible(&genpd->mlock);
66 }
67
68 static void genpd_unlock_mtx(struct generic_pm_domain *genpd)
69 {
70         return mutex_unlock(&genpd->mlock);
71 }
72
73 static const struct genpd_lock_ops genpd_mtx_ops = {
74         .lock = genpd_lock_mtx,
75         .lock_nested = genpd_lock_nested_mtx,
76         .lock_interruptible = genpd_lock_interruptible_mtx,
77         .unlock = genpd_unlock_mtx,
78 };
79
80 static void genpd_lock_spin(struct generic_pm_domain *genpd)
81         __acquires(&genpd->slock)
82 {
83         unsigned long flags;
84
85         spin_lock_irqsave(&genpd->slock, flags);
86         genpd->lock_flags = flags;
87 }
88
89 static void genpd_lock_nested_spin(struct generic_pm_domain *genpd,
90                                         int depth)
91         __acquires(&genpd->slock)
92 {
93         unsigned long flags;
94
95         spin_lock_irqsave_nested(&genpd->slock, flags, depth);
96         genpd->lock_flags = flags;
97 }
98
99 static int genpd_lock_interruptible_spin(struct generic_pm_domain *genpd)
100         __acquires(&genpd->slock)
101 {
102         unsigned long flags;
103
104         spin_lock_irqsave(&genpd->slock, flags);
105         genpd->lock_flags = flags;
106         return 0;
107 }
108
109 static void genpd_unlock_spin(struct generic_pm_domain *genpd)
110         __releases(&genpd->slock)
111 {
112         spin_unlock_irqrestore(&genpd->slock, genpd->lock_flags);
113 }
114
115 static const struct genpd_lock_ops genpd_spin_ops = {
116         .lock = genpd_lock_spin,
117         .lock_nested = genpd_lock_nested_spin,
118         .lock_interruptible = genpd_lock_interruptible_spin,
119         .unlock = genpd_unlock_spin,
120 };
121
122 #define genpd_lock(p)                   p->lock_ops->lock(p)
123 #define genpd_lock_nested(p, d)         p->lock_ops->lock_nested(p, d)
124 #define genpd_lock_interruptible(p)     p->lock_ops->lock_interruptible(p)
125 #define genpd_unlock(p)                 p->lock_ops->unlock(p)
126
127 #define genpd_status_on(genpd)          (genpd->status == GENPD_STATE_ON)
128 #define genpd_is_irq_safe(genpd)        (genpd->flags & GENPD_FLAG_IRQ_SAFE)
129 #define genpd_is_always_on(genpd)       (genpd->flags & GENPD_FLAG_ALWAYS_ON)
130 #define genpd_is_active_wakeup(genpd)   (genpd->flags & GENPD_FLAG_ACTIVE_WAKEUP)
131 #define genpd_is_cpu_domain(genpd)      (genpd->flags & GENPD_FLAG_CPU_DOMAIN)
132 #define genpd_is_rpm_always_on(genpd)   (genpd->flags & GENPD_FLAG_RPM_ALWAYS_ON)
133
134 static inline bool irq_safe_dev_in_no_sleep_domain(struct device *dev,
135                 const struct generic_pm_domain *genpd)
136 {
137         bool ret;
138
139         ret = pm_runtime_is_irq_safe(dev) && !genpd_is_irq_safe(genpd);
140
141         /*
142          * Warn once if an IRQ safe device is attached to a no sleep domain, as
143          * to indicate a suboptimal configuration for PM. For an always on
144          * domain this isn't case, thus don't warn.
145          */
146         if (ret && !genpd_is_always_on(genpd))
147                 dev_warn_once(dev, "PM domain %s will not be powered off\n",
148                                 genpd->name);
149
150         return ret;
151 }
152
153 static int genpd_runtime_suspend(struct device *dev);
154
155 /*
156  * Get the generic PM domain for a particular struct device.
157  * This validates the struct device pointer, the PM domain pointer,
158  * and checks that the PM domain pointer is a real generic PM domain.
159  * Any failure results in NULL being returned.
160  */
161 static struct generic_pm_domain *dev_to_genpd_safe(struct device *dev)
162 {
163         if (IS_ERR_OR_NULL(dev) || IS_ERR_OR_NULL(dev->pm_domain))
164                 return NULL;
165
166         /* A genpd's always have its ->runtime_suspend() callback assigned. */
167         if (dev->pm_domain->ops.runtime_suspend == genpd_runtime_suspend)
168                 return pd_to_genpd(dev->pm_domain);
169
170         return NULL;
171 }
172
173 /*
174  * This should only be used where we are certain that the pm_domain
175  * attached to the device is a genpd domain.
176  */
177 static struct generic_pm_domain *dev_to_genpd(struct device *dev)
178 {
179         if (IS_ERR_OR_NULL(dev->pm_domain))
180                 return ERR_PTR(-EINVAL);
181
182         return pd_to_genpd(dev->pm_domain);
183 }
184
185 static int genpd_stop_dev(const struct generic_pm_domain *genpd,
186                           struct device *dev)
187 {
188         return GENPD_DEV_CALLBACK(genpd, int, stop, dev);
189 }
190
191 static int genpd_start_dev(const struct generic_pm_domain *genpd,
192                            struct device *dev)
193 {
194         return GENPD_DEV_CALLBACK(genpd, int, start, dev);
195 }
196
197 static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
198 {
199         bool ret = false;
200
201         if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
202                 ret = !!atomic_dec_and_test(&genpd->sd_count);
203
204         return ret;
205 }
206
207 static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
208 {
209         atomic_inc(&genpd->sd_count);
210         smp_mb__after_atomic();
211 }
212
213 #ifdef CONFIG_DEBUG_FS
214 static struct dentry *genpd_debugfs_dir;
215
216 static void genpd_debug_add(struct generic_pm_domain *genpd);
217
218 static void genpd_debug_remove(struct generic_pm_domain *genpd)
219 {
220         struct dentry *d;
221
222         d = debugfs_lookup(genpd->name, genpd_debugfs_dir);
223         debugfs_remove(d);
224 }
225
226 static void genpd_update_accounting(struct generic_pm_domain *genpd)
227 {
228         ktime_t delta, now;
229
230         now = ktime_get();
231         delta = ktime_sub(now, genpd->accounting_time);
232
233         /*
234          * If genpd->status is active, it means we are just
235          * out of off and so update the idle time and vice
236          * versa.
237          */
238         if (genpd->status == GENPD_STATE_ON) {
239                 int state_idx = genpd->state_idx;
240
241                 genpd->states[state_idx].idle_time =
242                         ktime_add(genpd->states[state_idx].idle_time, delta);
243         } else {
244                 genpd->on_time = ktime_add(genpd->on_time, delta);
245         }
246
247         genpd->accounting_time = now;
248 }
249 #else
250 static inline void genpd_debug_add(struct generic_pm_domain *genpd) {}
251 static inline void genpd_debug_remove(struct generic_pm_domain *genpd) {}
252 static inline void genpd_update_accounting(struct generic_pm_domain *genpd) {}
253 #endif
254
255 static int _genpd_reeval_performance_state(struct generic_pm_domain *genpd,
256                                            unsigned int state)
257 {
258         struct generic_pm_domain_data *pd_data;
259         struct pm_domain_data *pdd;
260         struct gpd_link *link;
261
262         /* New requested state is same as Max requested state */
263         if (state == genpd->performance_state)
264                 return state;
265
266         /* New requested state is higher than Max requested state */
267         if (state > genpd->performance_state)
268                 return state;
269
270         /* Traverse all devices within the domain */
271         list_for_each_entry(pdd, &genpd->dev_list, list_node) {
272                 pd_data = to_gpd_data(pdd);
273
274                 if (pd_data->performance_state > state)
275                         state = pd_data->performance_state;
276         }
277
278         /*
279          * Traverse all sub-domains within the domain. This can be
280          * done without any additional locking as the link->performance_state
281          * field is protected by the parent genpd->lock, which is already taken.
282          *
283          * Also note that link->performance_state (subdomain's performance state
284          * requirement to parent domain) is different from
285          * link->child->performance_state (current performance state requirement
286          * of the devices/sub-domains of the subdomain) and so can have a
287          * different value.
288          *
289          * Note that we also take vote from powered-off sub-domains into account
290          * as the same is done for devices right now.
291          */
292         list_for_each_entry(link, &genpd->parent_links, parent_node) {
293                 if (link->performance_state > state)
294                         state = link->performance_state;
295         }
296
297         return state;
298 }
299
300 static int genpd_xlate_performance_state(struct generic_pm_domain *genpd,
301                                          struct generic_pm_domain *parent,
302                                          unsigned int pstate)
303 {
304         if (!parent->set_performance_state)
305                 return pstate;
306
307         return dev_pm_opp_xlate_performance_state(genpd->opp_table,
308                                                   parent->opp_table,
309                                                   pstate);
310 }
311
312 static int _genpd_set_performance_state(struct generic_pm_domain *genpd,
313                                         unsigned int state, int depth)
314 {
315         struct generic_pm_domain *parent;
316         struct gpd_link *link;
317         int parent_state, ret;
318
319         if (state == genpd->performance_state)
320                 return 0;
321
322         /* Propagate to parents of genpd */
323         list_for_each_entry(link, &genpd->child_links, child_node) {
324                 parent = link->parent;
325
326                 /* Find parent's performance state */
327                 ret = genpd_xlate_performance_state(genpd, parent, state);
328                 if (unlikely(ret < 0))
329                         goto err;
330
331                 parent_state = ret;
332
333                 genpd_lock_nested(parent, depth + 1);
334
335                 link->prev_performance_state = link->performance_state;
336                 link->performance_state = parent_state;
337                 parent_state = _genpd_reeval_performance_state(parent,
338                                                 parent_state);
339                 ret = _genpd_set_performance_state(parent, parent_state, depth + 1);
340                 if (ret)
341                         link->performance_state = link->prev_performance_state;
342
343                 genpd_unlock(parent);
344
345                 if (ret)
346                         goto err;
347         }
348
349         if (genpd->set_performance_state) {
350                 ret = genpd->set_performance_state(genpd, state);
351                 if (ret)
352                         goto err;
353         }
354
355         genpd->performance_state = state;
356         return 0;
357
358 err:
359         /* Encountered an error, lets rollback */
360         list_for_each_entry_continue_reverse(link, &genpd->child_links,
361                                              child_node) {
362                 parent = link->parent;
363
364                 genpd_lock_nested(parent, depth + 1);
365
366                 parent_state = link->prev_performance_state;
367                 link->performance_state = parent_state;
368
369                 parent_state = _genpd_reeval_performance_state(parent,
370                                                 parent_state);
371                 if (_genpd_set_performance_state(parent, parent_state, depth + 1)) {
372                         pr_err("%s: Failed to roll back to %d performance state\n",
373                                parent->name, parent_state);
374                 }
375
376                 genpd_unlock(parent);
377         }
378
379         return ret;
380 }
381
382 static int genpd_set_performance_state(struct device *dev, unsigned int state)
383 {
384         struct generic_pm_domain *genpd = dev_to_genpd(dev);
385         struct generic_pm_domain_data *gpd_data = dev_gpd_data(dev);
386         unsigned int prev_state;
387         int ret;
388
389         prev_state = gpd_data->performance_state;
390         if (prev_state == state)
391                 return 0;
392
393         gpd_data->performance_state = state;
394         state = _genpd_reeval_performance_state(genpd, state);
395
396         ret = _genpd_set_performance_state(genpd, state, 0);
397         if (ret)
398                 gpd_data->performance_state = prev_state;
399
400         return ret;
401 }
402
403 static int genpd_drop_performance_state(struct device *dev)
404 {
405         unsigned int prev_state = dev_gpd_data(dev)->performance_state;
406
407         if (!genpd_set_performance_state(dev, 0))
408                 return prev_state;
409
410         return 0;
411 }
412
413 static void genpd_restore_performance_state(struct device *dev,
414                                             unsigned int state)
415 {
416         if (state)
417                 genpd_set_performance_state(dev, state);
418 }
419
420 /**
421  * dev_pm_genpd_set_performance_state- Set performance state of device's power
422  * domain.
423  *
424  * @dev: Device for which the performance-state needs to be set.
425  * @state: Target performance state of the device. This can be set as 0 when the
426  *         device doesn't have any performance state constraints left (And so
427  *         the device wouldn't participate anymore to find the target
428  *         performance state of the genpd).
429  *
430  * It is assumed that the users guarantee that the genpd wouldn't be detached
431  * while this routine is getting called.
432  *
433  * Returns 0 on success and negative error values on failures.
434  */
435 int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state)
436 {
437         struct generic_pm_domain *genpd;
438         int ret = 0;
439
440         genpd = dev_to_genpd_safe(dev);
441         if (!genpd)
442                 return -ENODEV;
443
444         if (WARN_ON(!dev->power.subsys_data ||
445                      !dev->power.subsys_data->domain_data))
446                 return -EINVAL;
447
448         genpd_lock(genpd);
449         if (pm_runtime_suspended(dev)) {
450                 dev_gpd_data(dev)->rpm_pstate = state;
451         } else {
452                 ret = genpd_set_performance_state(dev, state);
453                 if (!ret)
454                         dev_gpd_data(dev)->rpm_pstate = 0;
455         }
456         genpd_unlock(genpd);
457
458         return ret;
459 }
460 EXPORT_SYMBOL_GPL(dev_pm_genpd_set_performance_state);
461
462 /**
463  * dev_pm_genpd_set_next_wakeup - Notify PM framework of an impending wakeup.
464  *
465  * @dev: Device to handle
466  * @next: impending interrupt/wakeup for the device
467  *
468  *
469  * Allow devices to inform of the next wakeup. It's assumed that the users
470  * guarantee that the genpd wouldn't be detached while this routine is getting
471  * called. Additionally, it's also assumed that @dev isn't runtime suspended
472  * (RPM_SUSPENDED)."
473  * Although devices are expected to update the next_wakeup after the end of
474  * their usecase as well, it is possible the devices themselves may not know
475  * about that, so stale @next will be ignored when powering off the domain.
476  */
477 void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next)
478 {
479         struct generic_pm_domain_data *gpd_data;
480         struct generic_pm_domain *genpd;
481
482         genpd = dev_to_genpd_safe(dev);
483         if (!genpd)
484                 return;
485
486         gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
487         gpd_data->next_wakeup = next;
488 }
489 EXPORT_SYMBOL_GPL(dev_pm_genpd_set_next_wakeup);
490
491 static int _genpd_power_on(struct generic_pm_domain *genpd, bool timed)
492 {
493         unsigned int state_idx = genpd->state_idx;
494         ktime_t time_start;
495         s64 elapsed_ns;
496         int ret;
497
498         /* Notify consumers that we are about to power on. */
499         ret = raw_notifier_call_chain_robust(&genpd->power_notifiers,
500                                              GENPD_NOTIFY_PRE_ON,
501                                              GENPD_NOTIFY_OFF, NULL);
502         ret = notifier_to_errno(ret);
503         if (ret)
504                 return ret;
505
506         if (!genpd->power_on)
507                 goto out;
508
509         if (!timed) {
510                 ret = genpd->power_on(genpd);
511                 if (ret)
512                         goto err;
513
514                 goto out;
515         }
516
517         time_start = ktime_get();
518         ret = genpd->power_on(genpd);
519         if (ret)
520                 goto err;
521
522         elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
523         if (elapsed_ns <= genpd->states[state_idx].power_on_latency_ns)
524                 goto out;
525
526         genpd->states[state_idx].power_on_latency_ns = elapsed_ns;
527         genpd->max_off_time_changed = true;
528         pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
529                  genpd->name, "on", elapsed_ns);
530
531 out:
532         raw_notifier_call_chain(&genpd->power_notifiers, GENPD_NOTIFY_ON, NULL);
533         return 0;
534 err:
535         raw_notifier_call_chain(&genpd->power_notifiers, GENPD_NOTIFY_OFF,
536                                 NULL);
537         return ret;
538 }
539
540 static int _genpd_power_off(struct generic_pm_domain *genpd, bool timed)
541 {
542         unsigned int state_idx = genpd->state_idx;
543         ktime_t time_start;
544         s64 elapsed_ns;
545         int ret;
546
547         /* Notify consumers that we are about to power off. */
548         ret = raw_notifier_call_chain_robust(&genpd->power_notifiers,
549                                              GENPD_NOTIFY_PRE_OFF,
550                                              GENPD_NOTIFY_ON, NULL);
551         ret = notifier_to_errno(ret);
552         if (ret)
553                 return ret;
554
555         if (!genpd->power_off)
556                 goto out;
557
558         if (!timed) {
559                 ret = genpd->power_off(genpd);
560                 if (ret)
561                         goto busy;
562
563                 goto out;
564         }
565
566         time_start = ktime_get();
567         ret = genpd->power_off(genpd);
568         if (ret)
569                 goto busy;
570
571         elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
572         if (elapsed_ns <= genpd->states[state_idx].power_off_latency_ns)
573                 goto out;
574
575         genpd->states[state_idx].power_off_latency_ns = elapsed_ns;
576         genpd->max_off_time_changed = true;
577         pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
578                  genpd->name, "off", elapsed_ns);
579
580 out:
581         raw_notifier_call_chain(&genpd->power_notifiers, GENPD_NOTIFY_OFF,
582                                 NULL);
583         return 0;
584 busy:
585         raw_notifier_call_chain(&genpd->power_notifiers, GENPD_NOTIFY_ON, NULL);
586         return ret;
587 }
588
589 /**
590  * genpd_queue_power_off_work - Queue up the execution of genpd_power_off().
591  * @genpd: PM domain to power off.
592  *
593  * Queue up the execution of genpd_power_off() unless it's already been done
594  * before.
595  */
596 static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
597 {
598         queue_work(pm_wq, &genpd->power_off_work);
599 }
600
601 /**
602  * genpd_power_off - Remove power from a given PM domain.
603  * @genpd: PM domain to power down.
604  * @one_dev_on: If invoked from genpd's ->runtime_suspend|resume() callback, the
605  * RPM status of the releated device is in an intermediate state, not yet turned
606  * into RPM_SUSPENDED. This means genpd_power_off() must allow one device to not
607  * be RPM_SUSPENDED, while it tries to power off the PM domain.
608  * @depth: nesting count for lockdep.
609  *
610  * If all of the @genpd's devices have been suspended and all of its subdomains
611  * have been powered down, remove power from @genpd.
612  */
613 static int genpd_power_off(struct generic_pm_domain *genpd, bool one_dev_on,
614                            unsigned int depth)
615 {
616         struct pm_domain_data *pdd;
617         struct gpd_link *link;
618         unsigned int not_suspended = 0;
619         int ret;
620
621         /*
622          * Do not try to power off the domain in the following situations:
623          * (1) The domain is already in the "power off" state.
624          * (2) System suspend is in progress.
625          */
626         if (!genpd_status_on(genpd) || genpd->prepared_count > 0)
627                 return 0;
628
629         /*
630          * Abort power off for the PM domain in the following situations:
631          * (1) The domain is configured as always on.
632          * (2) When the domain has a subdomain being powered on.
633          */
634         if (genpd_is_always_on(genpd) ||
635                         genpd_is_rpm_always_on(genpd) ||
636                         atomic_read(&genpd->sd_count) > 0)
637                 return -EBUSY;
638
639         list_for_each_entry(pdd, &genpd->dev_list, list_node) {
640                 enum pm_qos_flags_status stat;
641
642                 stat = dev_pm_qos_flags(pdd->dev, PM_QOS_FLAG_NO_POWER_OFF);
643                 if (stat > PM_QOS_FLAGS_NONE)
644                         return -EBUSY;
645
646                 /*
647                  * Do not allow PM domain to be powered off, when an IRQ safe
648                  * device is part of a non-IRQ safe domain.
649                  */
650                 if (!pm_runtime_suspended(pdd->dev) ||
651                         irq_safe_dev_in_no_sleep_domain(pdd->dev, genpd))
652                         not_suspended++;
653         }
654
655         if (not_suspended > 1 || (not_suspended == 1 && !one_dev_on))
656                 return -EBUSY;
657
658         if (genpd->gov && genpd->gov->power_down_ok) {
659                 if (!genpd->gov->power_down_ok(&genpd->domain))
660                         return -EAGAIN;
661         }
662
663         /* Default to shallowest state. */
664         if (!genpd->gov)
665                 genpd->state_idx = 0;
666
667         /* Don't power off, if a child domain is waiting to power on. */
668         if (atomic_read(&genpd->sd_count) > 0)
669                 return -EBUSY;
670
671         ret = _genpd_power_off(genpd, true);
672         if (ret) {
673                 genpd->states[genpd->state_idx].rejected++;
674                 return ret;
675         }
676
677         genpd->status = GENPD_STATE_OFF;
678         genpd_update_accounting(genpd);
679         genpd->states[genpd->state_idx].usage++;
680
681         list_for_each_entry(link, &genpd->child_links, child_node) {
682                 genpd_sd_counter_dec(link->parent);
683                 genpd_lock_nested(link->parent, depth + 1);
684                 genpd_power_off(link->parent, false, depth + 1);
685                 genpd_unlock(link->parent);
686         }
687
688         return 0;
689 }
690
691 /**
692  * genpd_power_on - Restore power to a given PM domain and its parents.
693  * @genpd: PM domain to power up.
694  * @depth: nesting count for lockdep.
695  *
696  * Restore power to @genpd and all of its parents so that it is possible to
697  * resume a device belonging to it.
698  */
699 static int genpd_power_on(struct generic_pm_domain *genpd, unsigned int depth)
700 {
701         struct gpd_link *link;
702         int ret = 0;
703
704         if (genpd_status_on(genpd))
705                 return 0;
706
707         /*
708          * The list is guaranteed not to change while the loop below is being
709          * executed, unless one of the parents' .power_on() callbacks fiddles
710          * with it.
711          */
712         list_for_each_entry(link, &genpd->child_links, child_node) {
713                 struct generic_pm_domain *parent = link->parent;
714
715                 genpd_sd_counter_inc(parent);
716
717                 genpd_lock_nested(parent, depth + 1);
718                 ret = genpd_power_on(parent, depth + 1);
719                 genpd_unlock(parent);
720
721                 if (ret) {
722                         genpd_sd_counter_dec(parent);
723                         goto err;
724                 }
725         }
726
727         ret = _genpd_power_on(genpd, true);
728         if (ret)
729                 goto err;
730
731         genpd->status = GENPD_STATE_ON;
732         genpd_update_accounting(genpd);
733
734         return 0;
735
736  err:
737         list_for_each_entry_continue_reverse(link,
738                                         &genpd->child_links,
739                                         child_node) {
740                 genpd_sd_counter_dec(link->parent);
741                 genpd_lock_nested(link->parent, depth + 1);
742                 genpd_power_off(link->parent, false, depth + 1);
743                 genpd_unlock(link->parent);
744         }
745
746         return ret;
747 }
748
749 static int genpd_dev_pm_start(struct device *dev)
750 {
751         struct generic_pm_domain *genpd = dev_to_genpd(dev);
752
753         return genpd_start_dev(genpd, dev);
754 }
755
756 static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
757                                      unsigned long val, void *ptr)
758 {
759         struct generic_pm_domain_data *gpd_data;
760         struct device *dev;
761
762         gpd_data = container_of(nb, struct generic_pm_domain_data, nb);
763         dev = gpd_data->base.dev;
764
765         for (;;) {
766                 struct generic_pm_domain *genpd;
767                 struct pm_domain_data *pdd;
768
769                 spin_lock_irq(&dev->power.lock);
770
771                 pdd = dev->power.subsys_data ?
772                                 dev->power.subsys_data->domain_data : NULL;
773                 if (pdd) {
774                         to_gpd_data(pdd)->td.constraint_changed = true;
775                         genpd = dev_to_genpd(dev);
776                 } else {
777                         genpd = ERR_PTR(-ENODATA);
778                 }
779
780                 spin_unlock_irq(&dev->power.lock);
781
782                 if (!IS_ERR(genpd)) {
783                         genpd_lock(genpd);
784                         genpd->max_off_time_changed = true;
785                         genpd_unlock(genpd);
786                 }
787
788                 dev = dev->parent;
789                 if (!dev || dev->power.ignore_children)
790                         break;
791         }
792
793         return NOTIFY_DONE;
794 }
795
796 /**
797  * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
798  * @work: Work structure used for scheduling the execution of this function.
799  */
800 static void genpd_power_off_work_fn(struct work_struct *work)
801 {
802         struct generic_pm_domain *genpd;
803
804         genpd = container_of(work, struct generic_pm_domain, power_off_work);
805
806         genpd_lock(genpd);
807         genpd_power_off(genpd, false, 0);
808         genpd_unlock(genpd);
809 }
810
811 /**
812  * __genpd_runtime_suspend - walk the hierarchy of ->runtime_suspend() callbacks
813  * @dev: Device to handle.
814  */
815 static int __genpd_runtime_suspend(struct device *dev)
816 {
817         int (*cb)(struct device *__dev);
818
819         if (dev->type && dev->type->pm)
820                 cb = dev->type->pm->runtime_suspend;
821         else if (dev->class && dev->class->pm)
822                 cb = dev->class->pm->runtime_suspend;
823         else if (dev->bus && dev->bus->pm)
824                 cb = dev->bus->pm->runtime_suspend;
825         else
826                 cb = NULL;
827
828         if (!cb && dev->driver && dev->driver->pm)
829                 cb = dev->driver->pm->runtime_suspend;
830
831         return cb ? cb(dev) : 0;
832 }
833
834 /**
835  * __genpd_runtime_resume - walk the hierarchy of ->runtime_resume() callbacks
836  * @dev: Device to handle.
837  */
838 static int __genpd_runtime_resume(struct device *dev)
839 {
840         int (*cb)(struct device *__dev);
841
842         if (dev->type && dev->type->pm)
843                 cb = dev->type->pm->runtime_resume;
844         else if (dev->class && dev->class->pm)
845                 cb = dev->class->pm->runtime_resume;
846         else if (dev->bus && dev->bus->pm)
847                 cb = dev->bus->pm->runtime_resume;
848         else
849                 cb = NULL;
850
851         if (!cb && dev->driver && dev->driver->pm)
852                 cb = dev->driver->pm->runtime_resume;
853
854         return cb ? cb(dev) : 0;
855 }
856
857 /**
858  * genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
859  * @dev: Device to suspend.
860  *
861  * Carry out a runtime suspend of a device under the assumption that its
862  * pm_domain field points to the domain member of an object of type
863  * struct generic_pm_domain representing a PM domain consisting of I/O devices.
864  */
865 static int genpd_runtime_suspend(struct device *dev)
866 {
867         struct generic_pm_domain *genpd;
868         bool (*suspend_ok)(struct device *__dev);
869         struct generic_pm_domain_data *gpd_data = dev_gpd_data(dev);
870         struct gpd_timing_data *td = &gpd_data->td;
871         bool runtime_pm = pm_runtime_enabled(dev);
872         ktime_t time_start;
873         s64 elapsed_ns;
874         int ret;
875
876         dev_dbg(dev, "%s()\n", __func__);
877
878         genpd = dev_to_genpd(dev);
879         if (IS_ERR(genpd))
880                 return -EINVAL;
881
882         /*
883          * A runtime PM centric subsystem/driver may re-use the runtime PM
884          * callbacks for other purposes than runtime PM. In those scenarios
885          * runtime PM is disabled. Under these circumstances, we shall skip
886          * validating/measuring the PM QoS latency.
887          */
888         suspend_ok = genpd->gov ? genpd->gov->suspend_ok : NULL;
889         if (runtime_pm && suspend_ok && !suspend_ok(dev))
890                 return -EBUSY;
891
892         /* Measure suspend latency. */
893         time_start = 0;
894         if (runtime_pm)
895                 time_start = ktime_get();
896
897         ret = __genpd_runtime_suspend(dev);
898         if (ret)
899                 return ret;
900
901         ret = genpd_stop_dev(genpd, dev);
902         if (ret) {
903                 __genpd_runtime_resume(dev);
904                 return ret;
905         }
906
907         /* Update suspend latency value if the measured time exceeds it. */
908         if (runtime_pm) {
909                 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
910                 if (elapsed_ns > td->suspend_latency_ns) {
911                         td->suspend_latency_ns = elapsed_ns;
912                         dev_dbg(dev, "suspend latency exceeded, %lld ns\n",
913                                 elapsed_ns);
914                         genpd->max_off_time_changed = true;
915                         td->constraint_changed = true;
916                 }
917         }
918
919         /*
920          * If power.irq_safe is set, this routine may be run with
921          * IRQs disabled, so suspend only if the PM domain also is irq_safe.
922          */
923         if (irq_safe_dev_in_no_sleep_domain(dev, genpd))
924                 return 0;
925
926         genpd_lock(genpd);
927         gpd_data->rpm_pstate = genpd_drop_performance_state(dev);
928         genpd_power_off(genpd, true, 0);
929         genpd_unlock(genpd);
930
931         return 0;
932 }
933
934 /**
935  * genpd_runtime_resume - Resume a device belonging to I/O PM domain.
936  * @dev: Device to resume.
937  *
938  * Carry out a runtime resume 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 PM domain consisting of I/O devices.
941  */
942 static int genpd_runtime_resume(struct device *dev)
943 {
944         struct generic_pm_domain *genpd;
945         struct generic_pm_domain_data *gpd_data = dev_gpd_data(dev);
946         struct gpd_timing_data *td = &gpd_data->td;
947         bool runtime_pm = pm_runtime_enabled(dev);
948         ktime_t time_start;
949         s64 elapsed_ns;
950         int ret;
951         bool timed = true;
952
953         dev_dbg(dev, "%s()\n", __func__);
954
955         genpd = dev_to_genpd(dev);
956         if (IS_ERR(genpd))
957                 return -EINVAL;
958
959         /*
960          * As we don't power off a non IRQ safe domain, which holds
961          * an IRQ safe device, we don't need to restore power to it.
962          */
963         if (irq_safe_dev_in_no_sleep_domain(dev, genpd)) {
964                 timed = false;
965                 goto out;
966         }
967
968         genpd_lock(genpd);
969         ret = genpd_power_on(genpd, 0);
970         if (!ret)
971                 genpd_restore_performance_state(dev, gpd_data->rpm_pstate);
972         genpd_unlock(genpd);
973
974         if (ret)
975                 return ret;
976
977  out:
978         /* Measure resume latency. */
979         time_start = 0;
980         if (timed && runtime_pm)
981                 time_start = ktime_get();
982
983         ret = genpd_start_dev(genpd, dev);
984         if (ret)
985                 goto err_poweroff;
986
987         ret = __genpd_runtime_resume(dev);
988         if (ret)
989                 goto err_stop;
990
991         /* Update resume latency value if the measured time exceeds it. */
992         if (timed && runtime_pm) {
993                 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
994                 if (elapsed_ns > td->resume_latency_ns) {
995                         td->resume_latency_ns = elapsed_ns;
996                         dev_dbg(dev, "resume latency exceeded, %lld ns\n",
997                                 elapsed_ns);
998                         genpd->max_off_time_changed = true;
999                         td->constraint_changed = true;
1000                 }
1001         }
1002
1003         return 0;
1004
1005 err_stop:
1006         genpd_stop_dev(genpd, dev);
1007 err_poweroff:
1008         if (!pm_runtime_is_irq_safe(dev) || genpd_is_irq_safe(genpd)) {
1009                 genpd_lock(genpd);
1010                 gpd_data->rpm_pstate = genpd_drop_performance_state(dev);
1011                 genpd_power_off(genpd, true, 0);
1012                 genpd_unlock(genpd);
1013         }
1014
1015         return ret;
1016 }
1017
1018 static bool pd_ignore_unused;
1019 static int __init pd_ignore_unused_setup(char *__unused)
1020 {
1021         pd_ignore_unused = true;
1022         return 1;
1023 }
1024 __setup("pd_ignore_unused", pd_ignore_unused_setup);
1025
1026 /**
1027  * genpd_power_off_unused - Power off all PM domains with no devices in use.
1028  */
1029 static int __init genpd_power_off_unused(void)
1030 {
1031         struct generic_pm_domain *genpd;
1032
1033         if (pd_ignore_unused) {
1034                 pr_warn("genpd: Not disabling unused power domains\n");
1035                 return 0;
1036         }
1037
1038         mutex_lock(&gpd_list_lock);
1039
1040         list_for_each_entry(genpd, &gpd_list, gpd_list_node)
1041                 genpd_queue_power_off_work(genpd);
1042
1043         mutex_unlock(&gpd_list_lock);
1044
1045         return 0;
1046 }
1047 late_initcall(genpd_power_off_unused);
1048
1049 #ifdef CONFIG_PM_SLEEP
1050
1051 /**
1052  * genpd_sync_power_off - Synchronously power off a PM domain and its parents.
1053  * @genpd: PM domain to power off, if possible.
1054  * @use_lock: use the lock.
1055  * @depth: nesting count for lockdep.
1056  *
1057  * Check if the given PM domain can be powered off (during system suspend or
1058  * hibernation) and do that if so.  Also, in that case propagate to its parents.
1059  *
1060  * This function is only called in "noirq" and "syscore" stages of system power
1061  * transitions. The "noirq" callbacks may be executed asynchronously, thus in
1062  * these cases the lock must be held.
1063  */
1064 static void genpd_sync_power_off(struct generic_pm_domain *genpd, bool use_lock,
1065                                  unsigned int depth)
1066 {
1067         struct gpd_link *link;
1068
1069         if (!genpd_status_on(genpd) || genpd_is_always_on(genpd))
1070                 return;
1071
1072         if (genpd->suspended_count != genpd->device_count
1073             || atomic_read(&genpd->sd_count) > 0)
1074                 return;
1075
1076         /* Choose the deepest state when suspending */
1077         genpd->state_idx = genpd->state_count - 1;
1078         if (_genpd_power_off(genpd, false))
1079                 return;
1080
1081         genpd->status = GENPD_STATE_OFF;
1082
1083         list_for_each_entry(link, &genpd->child_links, child_node) {
1084                 genpd_sd_counter_dec(link->parent);
1085
1086                 if (use_lock)
1087                         genpd_lock_nested(link->parent, depth + 1);
1088
1089                 genpd_sync_power_off(link->parent, use_lock, depth + 1);
1090
1091                 if (use_lock)
1092                         genpd_unlock(link->parent);
1093         }
1094 }
1095
1096 /**
1097  * genpd_sync_power_on - Synchronously power on a PM domain and its parents.
1098  * @genpd: PM domain to power on.
1099  * @use_lock: use the lock.
1100  * @depth: nesting count for lockdep.
1101  *
1102  * This function is only called in "noirq" and "syscore" stages of system power
1103  * transitions. The "noirq" callbacks may be executed asynchronously, thus in
1104  * these cases the lock must be held.
1105  */
1106 static void genpd_sync_power_on(struct generic_pm_domain *genpd, bool use_lock,
1107                                 unsigned int depth)
1108 {
1109         struct gpd_link *link;
1110
1111         if (genpd_status_on(genpd))
1112                 return;
1113
1114         list_for_each_entry(link, &genpd->child_links, child_node) {
1115                 genpd_sd_counter_inc(link->parent);
1116
1117                 if (use_lock)
1118                         genpd_lock_nested(link->parent, depth + 1);
1119
1120                 genpd_sync_power_on(link->parent, use_lock, depth + 1);
1121
1122                 if (use_lock)
1123                         genpd_unlock(link->parent);
1124         }
1125
1126         _genpd_power_on(genpd, false);
1127         genpd->status = GENPD_STATE_ON;
1128 }
1129
1130 /**
1131  * genpd_prepare - Start power transition of a device in a PM domain.
1132  * @dev: Device to start the transition of.
1133  *
1134  * Start a power transition of a device (during a system-wide power transition)
1135  * under the assumption that its pm_domain field points to the domain member of
1136  * an object of type struct generic_pm_domain representing a PM domain
1137  * consisting of I/O devices.
1138  */
1139 static int genpd_prepare(struct device *dev)
1140 {
1141         struct generic_pm_domain *genpd;
1142         int ret;
1143
1144         dev_dbg(dev, "%s()\n", __func__);
1145
1146         genpd = dev_to_genpd(dev);
1147         if (IS_ERR(genpd))
1148                 return -EINVAL;
1149
1150         genpd_lock(genpd);
1151
1152         if (genpd->prepared_count++ == 0)
1153                 genpd->suspended_count = 0;
1154
1155         genpd_unlock(genpd);
1156
1157         ret = pm_generic_prepare(dev);
1158         if (ret < 0) {
1159                 genpd_lock(genpd);
1160
1161                 genpd->prepared_count--;
1162
1163                 genpd_unlock(genpd);
1164         }
1165
1166         /* Never return 1, as genpd don't cope with the direct_complete path. */
1167         return ret >= 0 ? 0 : ret;
1168 }
1169
1170 /**
1171  * genpd_finish_suspend - Completion of suspend or hibernation of device in an
1172  *   I/O pm domain.
1173  * @dev: Device to suspend.
1174  * @poweroff: Specifies if this is a poweroff_noirq or suspend_noirq callback.
1175  *
1176  * Stop the device and remove power from the domain if all devices in it have
1177  * been stopped.
1178  */
1179 static int genpd_finish_suspend(struct device *dev, bool poweroff)
1180 {
1181         struct generic_pm_domain *genpd;
1182         int ret = 0;
1183
1184         genpd = dev_to_genpd(dev);
1185         if (IS_ERR(genpd))
1186                 return -EINVAL;
1187
1188         if (poweroff)
1189                 ret = pm_generic_poweroff_noirq(dev);
1190         else
1191                 ret = pm_generic_suspend_noirq(dev);
1192         if (ret)
1193                 return ret;
1194
1195         if (device_wakeup_path(dev) && genpd_is_active_wakeup(genpd))
1196                 return 0;
1197
1198         if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1199             !pm_runtime_status_suspended(dev)) {
1200                 ret = genpd_stop_dev(genpd, dev);
1201                 if (ret) {
1202                         if (poweroff)
1203                                 pm_generic_restore_noirq(dev);
1204                         else
1205                                 pm_generic_resume_noirq(dev);
1206                         return ret;
1207                 }
1208         }
1209
1210         genpd_lock(genpd);
1211         genpd->suspended_count++;
1212         genpd_sync_power_off(genpd, true, 0);
1213         genpd_unlock(genpd);
1214
1215         return 0;
1216 }
1217
1218 /**
1219  * genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
1220  * @dev: Device to suspend.
1221  *
1222  * Stop the device and remove power from the domain if all devices in it have
1223  * been stopped.
1224  */
1225 static int genpd_suspend_noirq(struct device *dev)
1226 {
1227         dev_dbg(dev, "%s()\n", __func__);
1228
1229         return genpd_finish_suspend(dev, false);
1230 }
1231
1232 /**
1233  * genpd_resume_noirq - Start of resume of device in an I/O PM domain.
1234  * @dev: Device to resume.
1235  *
1236  * Restore power to the device's PM domain, if necessary, and start the device.
1237  */
1238 static int genpd_resume_noirq(struct device *dev)
1239 {
1240         struct generic_pm_domain *genpd;
1241         int ret;
1242
1243         dev_dbg(dev, "%s()\n", __func__);
1244
1245         genpd = dev_to_genpd(dev);
1246         if (IS_ERR(genpd))
1247                 return -EINVAL;
1248
1249         if (device_wakeup_path(dev) && genpd_is_active_wakeup(genpd))
1250                 return pm_generic_resume_noirq(dev);
1251
1252         genpd_lock(genpd);
1253         genpd_sync_power_on(genpd, true, 0);
1254         genpd->suspended_count--;
1255         genpd_unlock(genpd);
1256
1257         if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1258             !pm_runtime_status_suspended(dev)) {
1259                 ret = genpd_start_dev(genpd, dev);
1260                 if (ret)
1261                         return ret;
1262         }
1263
1264         return pm_generic_resume_noirq(dev);
1265 }
1266
1267 /**
1268  * genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
1269  * @dev: Device to freeze.
1270  *
1271  * Carry out a late freeze of a device under the assumption that its
1272  * pm_domain field points to the domain member of an object of type
1273  * struct generic_pm_domain representing a power domain consisting of I/O
1274  * devices.
1275  */
1276 static int genpd_freeze_noirq(struct device *dev)
1277 {
1278         const struct generic_pm_domain *genpd;
1279         int ret = 0;
1280
1281         dev_dbg(dev, "%s()\n", __func__);
1282
1283         genpd = dev_to_genpd(dev);
1284         if (IS_ERR(genpd))
1285                 return -EINVAL;
1286
1287         ret = pm_generic_freeze_noirq(dev);
1288         if (ret)
1289                 return ret;
1290
1291         if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1292             !pm_runtime_status_suspended(dev))
1293                 ret = genpd_stop_dev(genpd, dev);
1294
1295         return ret;
1296 }
1297
1298 /**
1299  * genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
1300  * @dev: Device to thaw.
1301  *
1302  * Start the device, unless power has been removed from the domain already
1303  * before the system transition.
1304  */
1305 static int genpd_thaw_noirq(struct device *dev)
1306 {
1307         const struct generic_pm_domain *genpd;
1308         int ret = 0;
1309
1310         dev_dbg(dev, "%s()\n", __func__);
1311
1312         genpd = dev_to_genpd(dev);
1313         if (IS_ERR(genpd))
1314                 return -EINVAL;
1315
1316         if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1317             !pm_runtime_status_suspended(dev)) {
1318                 ret = genpd_start_dev(genpd, dev);
1319                 if (ret)
1320                         return ret;
1321         }
1322
1323         return pm_generic_thaw_noirq(dev);
1324 }
1325
1326 /**
1327  * genpd_poweroff_noirq - Completion of hibernation of device in an
1328  *   I/O PM domain.
1329  * @dev: Device to poweroff.
1330  *
1331  * Stop the device and remove power from the domain if all devices in it have
1332  * been stopped.
1333  */
1334 static int genpd_poweroff_noirq(struct device *dev)
1335 {
1336         dev_dbg(dev, "%s()\n", __func__);
1337
1338         return genpd_finish_suspend(dev, true);
1339 }
1340
1341 /**
1342  * genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1343  * @dev: Device to resume.
1344  *
1345  * Make sure the domain will be in the same power state as before the
1346  * hibernation the system is resuming from and start the device if necessary.
1347  */
1348 static int genpd_restore_noirq(struct device *dev)
1349 {
1350         struct generic_pm_domain *genpd;
1351         int ret = 0;
1352
1353         dev_dbg(dev, "%s()\n", __func__);
1354
1355         genpd = dev_to_genpd(dev);
1356         if (IS_ERR(genpd))
1357                 return -EINVAL;
1358
1359         /*
1360          * At this point suspended_count == 0 means we are being run for the
1361          * first time for the given domain in the present cycle.
1362          */
1363         genpd_lock(genpd);
1364         if (genpd->suspended_count++ == 0) {
1365                 /*
1366                  * The boot kernel might put the domain into arbitrary state,
1367                  * so make it appear as powered off to genpd_sync_power_on(),
1368                  * so that it tries to power it on in case it was really off.
1369                  */
1370                 genpd->status = GENPD_STATE_OFF;
1371         }
1372
1373         genpd_sync_power_on(genpd, true, 0);
1374         genpd_unlock(genpd);
1375
1376         if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1377             !pm_runtime_status_suspended(dev)) {
1378                 ret = genpd_start_dev(genpd, dev);
1379                 if (ret)
1380                         return ret;
1381         }
1382
1383         return pm_generic_restore_noirq(dev);
1384 }
1385
1386 /**
1387  * genpd_complete - Complete power transition of a device in a power domain.
1388  * @dev: Device to complete the transition of.
1389  *
1390  * Complete a power transition of a device (during a system-wide power
1391  * transition) under the assumption that its pm_domain field points to the
1392  * domain member of an object of type struct generic_pm_domain representing
1393  * a power domain consisting of I/O devices.
1394  */
1395 static void genpd_complete(struct device *dev)
1396 {
1397         struct generic_pm_domain *genpd;
1398
1399         dev_dbg(dev, "%s()\n", __func__);
1400
1401         genpd = dev_to_genpd(dev);
1402         if (IS_ERR(genpd))
1403                 return;
1404
1405         pm_generic_complete(dev);
1406
1407         genpd_lock(genpd);
1408
1409         genpd->prepared_count--;
1410         if (!genpd->prepared_count)
1411                 genpd_queue_power_off_work(genpd);
1412
1413         genpd_unlock(genpd);
1414 }
1415
1416 static void genpd_switch_state(struct device *dev, bool suspend)
1417 {
1418         struct generic_pm_domain *genpd;
1419         bool use_lock;
1420
1421         genpd = dev_to_genpd_safe(dev);
1422         if (!genpd)
1423                 return;
1424
1425         use_lock = genpd_is_irq_safe(genpd);
1426
1427         if (use_lock)
1428                 genpd_lock(genpd);
1429
1430         if (suspend) {
1431                 genpd->suspended_count++;
1432                 genpd_sync_power_off(genpd, use_lock, 0);
1433         } else {
1434                 genpd_sync_power_on(genpd, use_lock, 0);
1435                 genpd->suspended_count--;
1436         }
1437
1438         if (use_lock)
1439                 genpd_unlock(genpd);
1440 }
1441
1442 /**
1443  * dev_pm_genpd_suspend - Synchronously try to suspend the genpd for @dev
1444  * @dev: The device that is attached to the genpd, that can be suspended.
1445  *
1446  * This routine should typically be called for a device that needs to be
1447  * suspended during the syscore suspend phase. It may also be called during
1448  * suspend-to-idle to suspend a corresponding CPU device that is attached to a
1449  * genpd.
1450  */
1451 void dev_pm_genpd_suspend(struct device *dev)
1452 {
1453         genpd_switch_state(dev, true);
1454 }
1455 EXPORT_SYMBOL_GPL(dev_pm_genpd_suspend);
1456
1457 /**
1458  * dev_pm_genpd_resume - Synchronously try to resume the genpd for @dev
1459  * @dev: The device that is attached to the genpd, which needs to be resumed.
1460  *
1461  * This routine should typically be called for a device that needs to be resumed
1462  * during the syscore resume phase. It may also be called during suspend-to-idle
1463  * to resume a corresponding CPU device that is attached to a genpd.
1464  */
1465 void dev_pm_genpd_resume(struct device *dev)
1466 {
1467         genpd_switch_state(dev, false);
1468 }
1469 EXPORT_SYMBOL_GPL(dev_pm_genpd_resume);
1470
1471 #else /* !CONFIG_PM_SLEEP */
1472
1473 #define genpd_prepare           NULL
1474 #define genpd_suspend_noirq     NULL
1475 #define genpd_resume_noirq      NULL
1476 #define genpd_freeze_noirq      NULL
1477 #define genpd_thaw_noirq        NULL
1478 #define genpd_poweroff_noirq    NULL
1479 #define genpd_restore_noirq     NULL
1480 #define genpd_complete          NULL
1481
1482 #endif /* CONFIG_PM_SLEEP */
1483
1484 static struct generic_pm_domain_data *genpd_alloc_dev_data(struct device *dev)
1485 {
1486         struct generic_pm_domain_data *gpd_data;
1487         int ret;
1488
1489         ret = dev_pm_get_subsys_data(dev);
1490         if (ret)
1491                 return ERR_PTR(ret);
1492
1493         gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
1494         if (!gpd_data) {
1495                 ret = -ENOMEM;
1496                 goto err_put;
1497         }
1498
1499         gpd_data->base.dev = dev;
1500         gpd_data->td.constraint_changed = true;
1501         gpd_data->td.effective_constraint_ns = PM_QOS_RESUME_LATENCY_NO_CONSTRAINT_NS;
1502         gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
1503         gpd_data->next_wakeup = KTIME_MAX;
1504
1505         spin_lock_irq(&dev->power.lock);
1506
1507         if (dev->power.subsys_data->domain_data) {
1508                 ret = -EINVAL;
1509                 goto err_free;
1510         }
1511
1512         dev->power.subsys_data->domain_data = &gpd_data->base;
1513
1514         spin_unlock_irq(&dev->power.lock);
1515
1516         return gpd_data;
1517
1518  err_free:
1519         spin_unlock_irq(&dev->power.lock);
1520         kfree(gpd_data);
1521  err_put:
1522         dev_pm_put_subsys_data(dev);
1523         return ERR_PTR(ret);
1524 }
1525
1526 static void genpd_free_dev_data(struct device *dev,
1527                                 struct generic_pm_domain_data *gpd_data)
1528 {
1529         spin_lock_irq(&dev->power.lock);
1530
1531         dev->power.subsys_data->domain_data = NULL;
1532
1533         spin_unlock_irq(&dev->power.lock);
1534
1535         kfree(gpd_data);
1536         dev_pm_put_subsys_data(dev);
1537 }
1538
1539 static void genpd_update_cpumask(struct generic_pm_domain *genpd,
1540                                  int cpu, bool set, unsigned int depth)
1541 {
1542         struct gpd_link *link;
1543
1544         if (!genpd_is_cpu_domain(genpd))
1545                 return;
1546
1547         list_for_each_entry(link, &genpd->child_links, child_node) {
1548                 struct generic_pm_domain *parent = link->parent;
1549
1550                 genpd_lock_nested(parent, depth + 1);
1551                 genpd_update_cpumask(parent, cpu, set, depth + 1);
1552                 genpd_unlock(parent);
1553         }
1554
1555         if (set)
1556                 cpumask_set_cpu(cpu, genpd->cpus);
1557         else
1558                 cpumask_clear_cpu(cpu, genpd->cpus);
1559 }
1560
1561 static void genpd_set_cpumask(struct generic_pm_domain *genpd, int cpu)
1562 {
1563         if (cpu >= 0)
1564                 genpd_update_cpumask(genpd, cpu, true, 0);
1565 }
1566
1567 static void genpd_clear_cpumask(struct generic_pm_domain *genpd, int cpu)
1568 {
1569         if (cpu >= 0)
1570                 genpd_update_cpumask(genpd, cpu, false, 0);
1571 }
1572
1573 static int genpd_get_cpu(struct generic_pm_domain *genpd, struct device *dev)
1574 {
1575         int cpu;
1576
1577         if (!genpd_is_cpu_domain(genpd))
1578                 return -1;
1579
1580         for_each_possible_cpu(cpu) {
1581                 if (get_cpu_device(cpu) == dev)
1582                         return cpu;
1583         }
1584
1585         return -1;
1586 }
1587
1588 static int genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1589                             struct device *base_dev)
1590 {
1591         struct generic_pm_domain_data *gpd_data;
1592         int ret;
1593
1594         dev_dbg(dev, "%s()\n", __func__);
1595
1596         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1597                 return -EINVAL;
1598
1599         gpd_data = genpd_alloc_dev_data(dev);
1600         if (IS_ERR(gpd_data))
1601                 return PTR_ERR(gpd_data);
1602
1603         gpd_data->cpu = genpd_get_cpu(genpd, base_dev);
1604
1605         ret = genpd->attach_dev ? genpd->attach_dev(genpd, dev) : 0;
1606         if (ret)
1607                 goto out;
1608
1609         genpd_lock(genpd);
1610
1611         genpd_set_cpumask(genpd, gpd_data->cpu);
1612         dev_pm_domain_set(dev, &genpd->domain);
1613
1614         genpd->device_count++;
1615         genpd->max_off_time_changed = true;
1616
1617         list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1618
1619         genpd_unlock(genpd);
1620  out:
1621         if (ret)
1622                 genpd_free_dev_data(dev, gpd_data);
1623         else
1624                 dev_pm_qos_add_notifier(dev, &gpd_data->nb,
1625                                         DEV_PM_QOS_RESUME_LATENCY);
1626
1627         return ret;
1628 }
1629
1630 /**
1631  * pm_genpd_add_device - Add a device to an I/O PM domain.
1632  * @genpd: PM domain to add the device to.
1633  * @dev: Device to be added.
1634  */
1635 int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev)
1636 {
1637         int ret;
1638
1639         mutex_lock(&gpd_list_lock);
1640         ret = genpd_add_device(genpd, dev, dev);
1641         mutex_unlock(&gpd_list_lock);
1642
1643         return ret;
1644 }
1645 EXPORT_SYMBOL_GPL(pm_genpd_add_device);
1646
1647 static int genpd_remove_device(struct generic_pm_domain *genpd,
1648                                struct device *dev)
1649 {
1650         struct generic_pm_domain_data *gpd_data;
1651         struct pm_domain_data *pdd;
1652         int ret = 0;
1653
1654         dev_dbg(dev, "%s()\n", __func__);
1655
1656         pdd = dev->power.subsys_data->domain_data;
1657         gpd_data = to_gpd_data(pdd);
1658         dev_pm_qos_remove_notifier(dev, &gpd_data->nb,
1659                                    DEV_PM_QOS_RESUME_LATENCY);
1660
1661         genpd_lock(genpd);
1662
1663         if (genpd->prepared_count > 0) {
1664                 ret = -EAGAIN;
1665                 goto out;
1666         }
1667
1668         genpd->device_count--;
1669         genpd->max_off_time_changed = true;
1670
1671         genpd_clear_cpumask(genpd, gpd_data->cpu);
1672         dev_pm_domain_set(dev, NULL);
1673
1674         list_del_init(&pdd->list_node);
1675
1676         genpd_unlock(genpd);
1677
1678         if (genpd->detach_dev)
1679                 genpd->detach_dev(genpd, dev);
1680
1681         genpd_free_dev_data(dev, gpd_data);
1682
1683         return 0;
1684
1685  out:
1686         genpd_unlock(genpd);
1687         dev_pm_qos_add_notifier(dev, &gpd_data->nb, DEV_PM_QOS_RESUME_LATENCY);
1688
1689         return ret;
1690 }
1691
1692 /**
1693  * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1694  * @dev: Device to be removed.
1695  */
1696 int pm_genpd_remove_device(struct device *dev)
1697 {
1698         struct generic_pm_domain *genpd = dev_to_genpd_safe(dev);
1699
1700         if (!genpd)
1701                 return -EINVAL;
1702
1703         return genpd_remove_device(genpd, dev);
1704 }
1705 EXPORT_SYMBOL_GPL(pm_genpd_remove_device);
1706
1707 /**
1708  * dev_pm_genpd_add_notifier - Add a genpd power on/off notifier for @dev
1709  *
1710  * @dev: Device that should be associated with the notifier
1711  * @nb: The notifier block to register
1712  *
1713  * Users may call this function to add a genpd power on/off notifier for an
1714  * attached @dev. Only one notifier per device is allowed. The notifier is
1715  * sent when genpd is powering on/off the PM domain.
1716  *
1717  * It is assumed that the user guarantee that the genpd wouldn't be detached
1718  * while this routine is getting called.
1719  *
1720  * Returns 0 on success and negative error values on failures.
1721  */
1722 int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb)
1723 {
1724         struct generic_pm_domain *genpd;
1725         struct generic_pm_domain_data *gpd_data;
1726         int ret;
1727
1728         genpd = dev_to_genpd_safe(dev);
1729         if (!genpd)
1730                 return -ENODEV;
1731
1732         if (WARN_ON(!dev->power.subsys_data ||
1733                      !dev->power.subsys_data->domain_data))
1734                 return -EINVAL;
1735
1736         gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
1737         if (gpd_data->power_nb)
1738                 return -EEXIST;
1739
1740         genpd_lock(genpd);
1741         ret = raw_notifier_chain_register(&genpd->power_notifiers, nb);
1742         genpd_unlock(genpd);
1743
1744         if (ret) {
1745                 dev_warn(dev, "failed to add notifier for PM domain %s\n",
1746                          genpd->name);
1747                 return ret;
1748         }
1749
1750         gpd_data->power_nb = nb;
1751         return 0;
1752 }
1753 EXPORT_SYMBOL_GPL(dev_pm_genpd_add_notifier);
1754
1755 /**
1756  * dev_pm_genpd_remove_notifier - Remove a genpd power on/off notifier for @dev
1757  *
1758  * @dev: Device that is associated with the notifier
1759  *
1760  * Users may call this function to remove a genpd power on/off notifier for an
1761  * attached @dev.
1762  *
1763  * It is assumed that the user guarantee that the genpd wouldn't be detached
1764  * while this routine is getting called.
1765  *
1766  * Returns 0 on success and negative error values on failures.
1767  */
1768 int dev_pm_genpd_remove_notifier(struct device *dev)
1769 {
1770         struct generic_pm_domain *genpd;
1771         struct generic_pm_domain_data *gpd_data;
1772         int ret;
1773
1774         genpd = dev_to_genpd_safe(dev);
1775         if (!genpd)
1776                 return -ENODEV;
1777
1778         if (WARN_ON(!dev->power.subsys_data ||
1779                      !dev->power.subsys_data->domain_data))
1780                 return -EINVAL;
1781
1782         gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
1783         if (!gpd_data->power_nb)
1784                 return -ENODEV;
1785
1786         genpd_lock(genpd);
1787         ret = raw_notifier_chain_unregister(&genpd->power_notifiers,
1788                                             gpd_data->power_nb);
1789         genpd_unlock(genpd);
1790
1791         if (ret) {
1792                 dev_warn(dev, "failed to remove notifier for PM domain %s\n",
1793                          genpd->name);
1794                 return ret;
1795         }
1796
1797         gpd_data->power_nb = NULL;
1798         return 0;
1799 }
1800 EXPORT_SYMBOL_GPL(dev_pm_genpd_remove_notifier);
1801
1802 static int genpd_add_subdomain(struct generic_pm_domain *genpd,
1803                                struct generic_pm_domain *subdomain)
1804 {
1805         struct gpd_link *link, *itr;
1806         int ret = 0;
1807
1808         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
1809             || genpd == subdomain)
1810                 return -EINVAL;
1811
1812         /*
1813          * If the domain can be powered on/off in an IRQ safe
1814          * context, ensure that the subdomain can also be
1815          * powered on/off in that context.
1816          */
1817         if (!genpd_is_irq_safe(genpd) && genpd_is_irq_safe(subdomain)) {
1818                 WARN(1, "Parent %s of subdomain %s must be IRQ safe\n",
1819                                 genpd->name, subdomain->name);
1820                 return -EINVAL;
1821         }
1822
1823         link = kzalloc(sizeof(*link), GFP_KERNEL);
1824         if (!link)
1825                 return -ENOMEM;
1826
1827         genpd_lock(subdomain);
1828         genpd_lock_nested(genpd, SINGLE_DEPTH_NESTING);
1829
1830         if (!genpd_status_on(genpd) && genpd_status_on(subdomain)) {
1831                 ret = -EINVAL;
1832                 goto out;
1833         }
1834
1835         list_for_each_entry(itr, &genpd->parent_links, parent_node) {
1836                 if (itr->child == subdomain && itr->parent == genpd) {
1837                         ret = -EINVAL;
1838                         goto out;
1839                 }
1840         }
1841
1842         link->parent = genpd;
1843         list_add_tail(&link->parent_node, &genpd->parent_links);
1844         link->child = subdomain;
1845         list_add_tail(&link->child_node, &subdomain->child_links);
1846         if (genpd_status_on(subdomain))
1847                 genpd_sd_counter_inc(genpd);
1848
1849  out:
1850         genpd_unlock(genpd);
1851         genpd_unlock(subdomain);
1852         if (ret)
1853                 kfree(link);
1854         return ret;
1855 }
1856
1857 /**
1858  * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1859  * @genpd: Leader PM domain to add the subdomain to.
1860  * @subdomain: Subdomain to be added.
1861  */
1862 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1863                            struct generic_pm_domain *subdomain)
1864 {
1865         int ret;
1866
1867         mutex_lock(&gpd_list_lock);
1868         ret = genpd_add_subdomain(genpd, subdomain);
1869         mutex_unlock(&gpd_list_lock);
1870
1871         return ret;
1872 }
1873 EXPORT_SYMBOL_GPL(pm_genpd_add_subdomain);
1874
1875 /**
1876  * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1877  * @genpd: Leader PM domain to remove the subdomain from.
1878  * @subdomain: Subdomain to be removed.
1879  */
1880 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1881                               struct generic_pm_domain *subdomain)
1882 {
1883         struct gpd_link *l, *link;
1884         int ret = -EINVAL;
1885
1886         if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1887                 return -EINVAL;
1888
1889         genpd_lock(subdomain);
1890         genpd_lock_nested(genpd, SINGLE_DEPTH_NESTING);
1891
1892         if (!list_empty(&subdomain->parent_links) || subdomain->device_count) {
1893                 pr_warn("%s: unable to remove subdomain %s\n",
1894                         genpd->name, subdomain->name);
1895                 ret = -EBUSY;
1896                 goto out;
1897         }
1898
1899         list_for_each_entry_safe(link, l, &genpd->parent_links, parent_node) {
1900                 if (link->child != subdomain)
1901                         continue;
1902
1903                 list_del(&link->parent_node);
1904                 list_del(&link->child_node);
1905                 kfree(link);
1906                 if (genpd_status_on(subdomain))
1907                         genpd_sd_counter_dec(genpd);
1908
1909                 ret = 0;
1910                 break;
1911         }
1912
1913 out:
1914         genpd_unlock(genpd);
1915         genpd_unlock(subdomain);
1916
1917         return ret;
1918 }
1919 EXPORT_SYMBOL_GPL(pm_genpd_remove_subdomain);
1920
1921 static void genpd_free_default_power_state(struct genpd_power_state *states,
1922                                            unsigned int state_count)
1923 {
1924         kfree(states);
1925 }
1926
1927 static int genpd_set_default_power_state(struct generic_pm_domain *genpd)
1928 {
1929         struct genpd_power_state *state;
1930
1931         state = kzalloc(sizeof(*state), GFP_KERNEL);
1932         if (!state)
1933                 return -ENOMEM;
1934
1935         genpd->states = state;
1936         genpd->state_count = 1;
1937         genpd->free_states = genpd_free_default_power_state;
1938
1939         return 0;
1940 }
1941
1942 static void genpd_lock_init(struct generic_pm_domain *genpd)
1943 {
1944         if (genpd->flags & GENPD_FLAG_IRQ_SAFE) {
1945                 spin_lock_init(&genpd->slock);
1946                 genpd->lock_ops = &genpd_spin_ops;
1947         } else {
1948                 mutex_init(&genpd->mlock);
1949                 genpd->lock_ops = &genpd_mtx_ops;
1950         }
1951 }
1952
1953 /**
1954  * pm_genpd_init - Initialize a generic I/O PM domain object.
1955  * @genpd: PM domain object to initialize.
1956  * @gov: PM domain governor to associate with the domain (may be NULL).
1957  * @is_off: Initial value of the domain's power_is_off field.
1958  *
1959  * Returns 0 on successful initialization, else a negative error code.
1960  */
1961 int pm_genpd_init(struct generic_pm_domain *genpd,
1962                   struct dev_power_governor *gov, bool is_off)
1963 {
1964         int ret;
1965
1966         if (IS_ERR_OR_NULL(genpd))
1967                 return -EINVAL;
1968
1969         INIT_LIST_HEAD(&genpd->parent_links);
1970         INIT_LIST_HEAD(&genpd->child_links);
1971         INIT_LIST_HEAD(&genpd->dev_list);
1972         RAW_INIT_NOTIFIER_HEAD(&genpd->power_notifiers);
1973         genpd_lock_init(genpd);
1974         genpd->gov = gov;
1975         INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
1976         atomic_set(&genpd->sd_count, 0);
1977         genpd->status = is_off ? GENPD_STATE_OFF : GENPD_STATE_ON;
1978         genpd->device_count = 0;
1979         genpd->max_off_time_ns = -1;
1980         genpd->max_off_time_changed = true;
1981         genpd->provider = NULL;
1982         genpd->has_provider = false;
1983         genpd->accounting_time = ktime_get();
1984         genpd->domain.ops.runtime_suspend = genpd_runtime_suspend;
1985         genpd->domain.ops.runtime_resume = genpd_runtime_resume;
1986         genpd->domain.ops.prepare = genpd_prepare;
1987         genpd->domain.ops.suspend_noirq = genpd_suspend_noirq;
1988         genpd->domain.ops.resume_noirq = genpd_resume_noirq;
1989         genpd->domain.ops.freeze_noirq = genpd_freeze_noirq;
1990         genpd->domain.ops.thaw_noirq = genpd_thaw_noirq;
1991         genpd->domain.ops.poweroff_noirq = genpd_poweroff_noirq;
1992         genpd->domain.ops.restore_noirq = genpd_restore_noirq;
1993         genpd->domain.ops.complete = genpd_complete;
1994         genpd->domain.start = genpd_dev_pm_start;
1995
1996         if (genpd->flags & GENPD_FLAG_PM_CLK) {
1997                 genpd->dev_ops.stop = pm_clk_suspend;
1998                 genpd->dev_ops.start = pm_clk_resume;
1999         }
2000
2001         /* Always-on domains must be powered on at initialization. */
2002         if ((genpd_is_always_on(genpd) || genpd_is_rpm_always_on(genpd)) &&
2003                         !genpd_status_on(genpd))
2004                 return -EINVAL;
2005
2006         if (genpd_is_cpu_domain(genpd) &&
2007             !zalloc_cpumask_var(&genpd->cpus, GFP_KERNEL))
2008                 return -ENOMEM;
2009
2010         /* Use only one "off" state if there were no states declared */
2011         if (genpd->state_count == 0) {
2012                 ret = genpd_set_default_power_state(genpd);
2013                 if (ret) {
2014                         if (genpd_is_cpu_domain(genpd))
2015                                 free_cpumask_var(genpd->cpus);
2016                         return ret;
2017                 }
2018         } else if (!gov && genpd->state_count > 1) {
2019                 pr_warn("%s: no governor for states\n", genpd->name);
2020         }
2021
2022         device_initialize(&genpd->dev);
2023         dev_set_name(&genpd->dev, "%s", genpd->name);
2024
2025         mutex_lock(&gpd_list_lock);
2026         list_add(&genpd->gpd_list_node, &gpd_list);
2027         mutex_unlock(&gpd_list_lock);
2028         genpd_debug_add(genpd);
2029
2030         return 0;
2031 }
2032 EXPORT_SYMBOL_GPL(pm_genpd_init);
2033
2034 static int genpd_remove(struct generic_pm_domain *genpd)
2035 {
2036         struct gpd_link *l, *link;
2037
2038         if (IS_ERR_OR_NULL(genpd))
2039                 return -EINVAL;
2040
2041         genpd_lock(genpd);
2042
2043         if (genpd->has_provider) {
2044                 genpd_unlock(genpd);
2045                 pr_err("Provider present, unable to remove %s\n", genpd->name);
2046                 return -EBUSY;
2047         }
2048
2049         if (!list_empty(&genpd->parent_links) || genpd->device_count) {
2050                 genpd_unlock(genpd);
2051                 pr_err("%s: unable to remove %s\n", __func__, genpd->name);
2052                 return -EBUSY;
2053         }
2054
2055         list_for_each_entry_safe(link, l, &genpd->child_links, child_node) {
2056                 list_del(&link->parent_node);
2057                 list_del(&link->child_node);
2058                 kfree(link);
2059         }
2060
2061         genpd_debug_remove(genpd);
2062         list_del(&genpd->gpd_list_node);
2063         genpd_unlock(genpd);
2064         cancel_work_sync(&genpd->power_off_work);
2065         if (genpd_is_cpu_domain(genpd))
2066                 free_cpumask_var(genpd->cpus);
2067         if (genpd->free_states)
2068                 genpd->free_states(genpd->states, genpd->state_count);
2069
2070         pr_debug("%s: removed %s\n", __func__, genpd->name);
2071
2072         return 0;
2073 }
2074
2075 /**
2076  * pm_genpd_remove - Remove a generic I/O PM domain
2077  * @genpd: Pointer to PM domain that is to be removed.
2078  *
2079  * To remove the PM domain, this function:
2080  *  - Removes the PM domain as a subdomain to any parent domains,
2081  *    if it was added.
2082  *  - Removes the PM domain from the list of registered PM domains.
2083  *
2084  * The PM domain will only be removed, if the associated provider has
2085  * been removed, it is not a parent to any other PM domain and has no
2086  * devices associated with it.
2087  */
2088 int pm_genpd_remove(struct generic_pm_domain *genpd)
2089 {
2090         int ret;
2091
2092         mutex_lock(&gpd_list_lock);
2093         ret = genpd_remove(genpd);
2094         mutex_unlock(&gpd_list_lock);
2095
2096         return ret;
2097 }
2098 EXPORT_SYMBOL_GPL(pm_genpd_remove);
2099
2100 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
2101
2102 /*
2103  * Device Tree based PM domain providers.
2104  *
2105  * The code below implements generic device tree based PM domain providers that
2106  * bind device tree nodes with generic PM domains registered in the system.
2107  *
2108  * Any driver that registers generic PM domains and needs to support binding of
2109  * devices to these domains is supposed to register a PM domain provider, which
2110  * maps a PM domain specifier retrieved from the device tree to a PM domain.
2111  *
2112  * Two simple mapping functions have been provided for convenience:
2113  *  - genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
2114  *  - genpd_xlate_onecell() for mapping of multiple PM domains per node by
2115  *    index.
2116  */
2117
2118 /**
2119  * struct of_genpd_provider - PM domain provider registration structure
2120  * @link: Entry in global list of PM domain providers
2121  * @node: Pointer to device tree node of PM domain provider
2122  * @xlate: Provider-specific xlate callback mapping a set of specifier cells
2123  *         into a PM domain.
2124  * @data: context pointer to be passed into @xlate callback
2125  */
2126 struct of_genpd_provider {
2127         struct list_head link;
2128         struct device_node *node;
2129         genpd_xlate_t xlate;
2130         void *data;
2131 };
2132
2133 /* List of registered PM domain providers. */
2134 static LIST_HEAD(of_genpd_providers);
2135 /* Mutex to protect the list above. */
2136 static DEFINE_MUTEX(of_genpd_mutex);
2137
2138 /**
2139  * genpd_xlate_simple() - Xlate function for direct node-domain mapping
2140  * @genpdspec: OF phandle args to map into a PM domain
2141  * @data: xlate function private data - pointer to struct generic_pm_domain
2142  *
2143  * This is a generic xlate function that can be used to model PM domains that
2144  * have their own device tree nodes. The private data of xlate function needs
2145  * to be a valid pointer to struct generic_pm_domain.
2146  */
2147 static struct generic_pm_domain *genpd_xlate_simple(
2148                                         struct of_phandle_args *genpdspec,
2149                                         void *data)
2150 {
2151         return data;
2152 }
2153
2154 /**
2155  * genpd_xlate_onecell() - Xlate function using a single index.
2156  * @genpdspec: OF phandle args to map into a PM domain
2157  * @data: xlate function private data - pointer to struct genpd_onecell_data
2158  *
2159  * This is a generic xlate function that can be used to model simple PM domain
2160  * controllers that have one device tree node and provide multiple PM domains.
2161  * A single cell is used as an index into an array of PM domains specified in
2162  * the genpd_onecell_data struct when registering the provider.
2163  */
2164 static struct generic_pm_domain *genpd_xlate_onecell(
2165                                         struct of_phandle_args *genpdspec,
2166                                         void *data)
2167 {
2168         struct genpd_onecell_data *genpd_data = data;
2169         unsigned int idx = genpdspec->args[0];
2170
2171         if (genpdspec->args_count != 1)
2172                 return ERR_PTR(-EINVAL);
2173
2174         if (idx >= genpd_data->num_domains) {
2175                 pr_err("%s: invalid domain index %u\n", __func__, idx);
2176                 return ERR_PTR(-EINVAL);
2177         }
2178
2179         if (!genpd_data->domains[idx])
2180                 return ERR_PTR(-ENOENT);
2181
2182         return genpd_data->domains[idx];
2183 }
2184
2185 /**
2186  * genpd_add_provider() - Register a PM domain provider for a node
2187  * @np: Device node pointer associated with the PM domain provider.
2188  * @xlate: Callback for decoding PM domain from phandle arguments.
2189  * @data: Context pointer for @xlate callback.
2190  */
2191 static int genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
2192                               void *data)
2193 {
2194         struct of_genpd_provider *cp;
2195
2196         cp = kzalloc(sizeof(*cp), GFP_KERNEL);
2197         if (!cp)
2198                 return -ENOMEM;
2199
2200         cp->node = of_node_get(np);
2201         cp->data = data;
2202         cp->xlate = xlate;
2203         fwnode_dev_initialized(&np->fwnode, true);
2204
2205         mutex_lock(&of_genpd_mutex);
2206         list_add(&cp->link, &of_genpd_providers);
2207         mutex_unlock(&of_genpd_mutex);
2208         pr_debug("Added domain provider from %pOF\n", np);
2209
2210         return 0;
2211 }
2212
2213 static bool genpd_present(const struct generic_pm_domain *genpd)
2214 {
2215         bool ret = false;
2216         const struct generic_pm_domain *gpd;
2217
2218         mutex_lock(&gpd_list_lock);
2219         list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
2220                 if (gpd == genpd) {
2221                         ret = true;
2222                         break;
2223                 }
2224         }
2225         mutex_unlock(&gpd_list_lock);
2226
2227         return ret;
2228 }
2229
2230 /**
2231  * of_genpd_add_provider_simple() - Register a simple PM domain provider
2232  * @np: Device node pointer associated with the PM domain provider.
2233  * @genpd: Pointer to PM domain associated with the PM domain provider.
2234  */
2235 int of_genpd_add_provider_simple(struct device_node *np,
2236                                  struct generic_pm_domain *genpd)
2237 {
2238         int ret;
2239
2240         if (!np || !genpd)
2241                 return -EINVAL;
2242
2243         if (!genpd_present(genpd))
2244                 return -EINVAL;
2245
2246         genpd->dev.of_node = np;
2247
2248         /* Parse genpd OPP table */
2249         if (genpd->set_performance_state) {
2250                 ret = dev_pm_opp_of_add_table(&genpd->dev);
2251                 if (ret) {
2252                         if (ret != -EPROBE_DEFER)
2253                                 dev_err(&genpd->dev, "Failed to add OPP table: %d\n",
2254                                         ret);
2255                         return ret;
2256                 }
2257
2258                 /*
2259                  * Save table for faster processing while setting performance
2260                  * state.
2261                  */
2262                 genpd->opp_table = dev_pm_opp_get_opp_table(&genpd->dev);
2263                 WARN_ON(IS_ERR(genpd->opp_table));
2264         }
2265
2266         ret = genpd_add_provider(np, genpd_xlate_simple, genpd);
2267         if (ret) {
2268                 if (genpd->set_performance_state) {
2269                         dev_pm_opp_put_opp_table(genpd->opp_table);
2270                         dev_pm_opp_of_remove_table(&genpd->dev);
2271                 }
2272
2273                 return ret;
2274         }
2275
2276         genpd->provider = &np->fwnode;
2277         genpd->has_provider = true;
2278
2279         return 0;
2280 }
2281 EXPORT_SYMBOL_GPL(of_genpd_add_provider_simple);
2282
2283 /**
2284  * of_genpd_add_provider_onecell() - Register a onecell PM domain provider
2285  * @np: Device node pointer associated with the PM domain provider.
2286  * @data: Pointer to the data associated with the PM domain provider.
2287  */
2288 int of_genpd_add_provider_onecell(struct device_node *np,
2289                                   struct genpd_onecell_data *data)
2290 {
2291         struct generic_pm_domain *genpd;
2292         unsigned int i;
2293         int ret = -EINVAL;
2294
2295         if (!np || !data)
2296                 return -EINVAL;
2297
2298         if (!data->xlate)
2299                 data->xlate = genpd_xlate_onecell;
2300
2301         for (i = 0; i < data->num_domains; i++) {
2302                 genpd = data->domains[i];
2303
2304                 if (!genpd)
2305                         continue;
2306                 if (!genpd_present(genpd))
2307                         goto error;
2308
2309                 genpd->dev.of_node = np;
2310
2311                 /* Parse genpd OPP table */
2312                 if (genpd->set_performance_state) {
2313                         ret = dev_pm_opp_of_add_table_indexed(&genpd->dev, i);
2314                         if (ret) {
2315                                 if (ret != -EPROBE_DEFER)
2316                                         dev_err(&genpd->dev, "Failed to add OPP table for index %d: %d\n",
2317                                                 i, ret);
2318                                 goto error;
2319                         }
2320
2321                         /*
2322                          * Save table for faster processing while setting
2323                          * performance state.
2324                          */
2325                         genpd->opp_table = dev_pm_opp_get_opp_table(&genpd->dev);
2326                         WARN_ON(IS_ERR(genpd->opp_table));
2327                 }
2328
2329                 genpd->provider = &np->fwnode;
2330                 genpd->has_provider = true;
2331         }
2332
2333         ret = genpd_add_provider(np, data->xlate, data);
2334         if (ret < 0)
2335                 goto error;
2336
2337         return 0;
2338
2339 error:
2340         while (i--) {
2341                 genpd = data->domains[i];
2342
2343                 if (!genpd)
2344                         continue;
2345
2346                 genpd->provider = NULL;
2347                 genpd->has_provider = false;
2348
2349                 if (genpd->set_performance_state) {
2350                         dev_pm_opp_put_opp_table(genpd->opp_table);
2351                         dev_pm_opp_of_remove_table(&genpd->dev);
2352                 }
2353         }
2354
2355         return ret;
2356 }
2357 EXPORT_SYMBOL_GPL(of_genpd_add_provider_onecell);
2358
2359 /**
2360  * of_genpd_del_provider() - Remove a previously registered PM domain provider
2361  * @np: Device node pointer associated with the PM domain provider
2362  */
2363 void of_genpd_del_provider(struct device_node *np)
2364 {
2365         struct of_genpd_provider *cp, *tmp;
2366         struct generic_pm_domain *gpd;
2367
2368         mutex_lock(&gpd_list_lock);
2369         mutex_lock(&of_genpd_mutex);
2370         list_for_each_entry_safe(cp, tmp, &of_genpd_providers, link) {
2371                 if (cp->node == np) {
2372                         /*
2373                          * For each PM domain associated with the
2374                          * provider, set the 'has_provider' to false
2375                          * so that the PM domain can be safely removed.
2376                          */
2377                         list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
2378                                 if (gpd->provider == &np->fwnode) {
2379                                         gpd->has_provider = false;
2380
2381                                         if (!gpd->set_performance_state)
2382                                                 continue;
2383
2384                                         dev_pm_opp_put_opp_table(gpd->opp_table);
2385                                         dev_pm_opp_of_remove_table(&gpd->dev);
2386                                 }
2387                         }
2388
2389                         fwnode_dev_initialized(&cp->node->fwnode, false);
2390                         list_del(&cp->link);
2391                         of_node_put(cp->node);
2392                         kfree(cp);
2393                         break;
2394                 }
2395         }
2396         mutex_unlock(&of_genpd_mutex);
2397         mutex_unlock(&gpd_list_lock);
2398 }
2399 EXPORT_SYMBOL_GPL(of_genpd_del_provider);
2400
2401 /**
2402  * genpd_get_from_provider() - Look-up PM domain
2403  * @genpdspec: OF phandle args to use for look-up
2404  *
2405  * Looks for a PM domain provider under the node specified by @genpdspec and if
2406  * found, uses xlate function of the provider to map phandle args to a PM
2407  * domain.
2408  *
2409  * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
2410  * on failure.
2411  */
2412 static struct generic_pm_domain *genpd_get_from_provider(
2413                                         struct of_phandle_args *genpdspec)
2414 {
2415         struct generic_pm_domain *genpd = ERR_PTR(-ENOENT);
2416         struct of_genpd_provider *provider;
2417
2418         if (!genpdspec)
2419                 return ERR_PTR(-EINVAL);
2420
2421         mutex_lock(&of_genpd_mutex);
2422
2423         /* Check if we have such a provider in our array */
2424         list_for_each_entry(provider, &of_genpd_providers, link) {
2425                 if (provider->node == genpdspec->np)
2426                         genpd = provider->xlate(genpdspec, provider->data);
2427                 if (!IS_ERR(genpd))
2428                         break;
2429         }
2430
2431         mutex_unlock(&of_genpd_mutex);
2432
2433         return genpd;
2434 }
2435
2436 /**
2437  * of_genpd_add_device() - Add a device to an I/O PM domain
2438  * @genpdspec: OF phandle args to use for look-up PM domain
2439  * @dev: Device to be added.
2440  *
2441  * Looks-up an I/O PM domain based upon phandle args provided and adds
2442  * the device to the PM domain. Returns a negative error code on failure.
2443  */
2444 int of_genpd_add_device(struct of_phandle_args *genpdspec, struct device *dev)
2445 {
2446         struct generic_pm_domain *genpd;
2447         int ret;
2448
2449         mutex_lock(&gpd_list_lock);
2450
2451         genpd = genpd_get_from_provider(genpdspec);
2452         if (IS_ERR(genpd)) {
2453                 ret = PTR_ERR(genpd);
2454                 goto out;
2455         }
2456
2457         ret = genpd_add_device(genpd, dev, dev);
2458
2459 out:
2460         mutex_unlock(&gpd_list_lock);
2461
2462         return ret;
2463 }
2464 EXPORT_SYMBOL_GPL(of_genpd_add_device);
2465
2466 /**
2467  * of_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
2468  * @parent_spec: OF phandle args to use for parent PM domain look-up
2469  * @subdomain_spec: OF phandle args to use for subdomain look-up
2470  *
2471  * Looks-up a parent PM domain and subdomain based upon phandle args
2472  * provided and adds the subdomain to the parent PM domain. Returns a
2473  * negative error code on failure.
2474  */
2475 int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
2476                            struct of_phandle_args *subdomain_spec)
2477 {
2478         struct generic_pm_domain *parent, *subdomain;
2479         int ret;
2480
2481         mutex_lock(&gpd_list_lock);
2482
2483         parent = genpd_get_from_provider(parent_spec);
2484         if (IS_ERR(parent)) {
2485                 ret = PTR_ERR(parent);
2486                 goto out;
2487         }
2488
2489         subdomain = genpd_get_from_provider(subdomain_spec);
2490         if (IS_ERR(subdomain)) {
2491                 ret = PTR_ERR(subdomain);
2492                 goto out;
2493         }
2494
2495         ret = genpd_add_subdomain(parent, subdomain);
2496
2497 out:
2498         mutex_unlock(&gpd_list_lock);
2499
2500         return ret == -ENOENT ? -EPROBE_DEFER : ret;
2501 }
2502 EXPORT_SYMBOL_GPL(of_genpd_add_subdomain);
2503
2504 /**
2505  * of_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
2506  * @parent_spec: OF phandle args to use for parent PM domain look-up
2507  * @subdomain_spec: OF phandle args to use for subdomain look-up
2508  *
2509  * Looks-up a parent PM domain and subdomain based upon phandle args
2510  * provided and removes the subdomain from the parent PM domain. Returns a
2511  * negative error code on failure.
2512  */
2513 int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
2514                               struct of_phandle_args *subdomain_spec)
2515 {
2516         struct generic_pm_domain *parent, *subdomain;
2517         int ret;
2518
2519         mutex_lock(&gpd_list_lock);
2520
2521         parent = genpd_get_from_provider(parent_spec);
2522         if (IS_ERR(parent)) {
2523                 ret = PTR_ERR(parent);
2524                 goto out;
2525         }
2526
2527         subdomain = genpd_get_from_provider(subdomain_spec);
2528         if (IS_ERR(subdomain)) {
2529                 ret = PTR_ERR(subdomain);
2530                 goto out;
2531         }
2532
2533         ret = pm_genpd_remove_subdomain(parent, subdomain);
2534
2535 out:
2536         mutex_unlock(&gpd_list_lock);
2537
2538         return ret;
2539 }
2540 EXPORT_SYMBOL_GPL(of_genpd_remove_subdomain);
2541
2542 /**
2543  * of_genpd_remove_last - Remove the last PM domain registered for a provider
2544  * @np: Pointer to device node associated with provider
2545  *
2546  * Find the last PM domain that was added by a particular provider and
2547  * remove this PM domain from the list of PM domains. The provider is
2548  * identified by the 'provider' device structure that is passed. The PM
2549  * domain will only be removed, if the provider associated with domain
2550  * has been removed.
2551  *
2552  * Returns a valid pointer to struct generic_pm_domain on success or
2553  * ERR_PTR() on failure.
2554  */
2555 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
2556 {
2557         struct generic_pm_domain *gpd, *tmp, *genpd = ERR_PTR(-ENOENT);
2558         int ret;
2559
2560         if (IS_ERR_OR_NULL(np))
2561                 return ERR_PTR(-EINVAL);
2562
2563         mutex_lock(&gpd_list_lock);
2564         list_for_each_entry_safe(gpd, tmp, &gpd_list, gpd_list_node) {
2565                 if (gpd->provider == &np->fwnode) {
2566                         ret = genpd_remove(gpd);
2567                         genpd = ret ? ERR_PTR(ret) : gpd;
2568                         break;
2569                 }
2570         }
2571         mutex_unlock(&gpd_list_lock);
2572
2573         return genpd;
2574 }
2575 EXPORT_SYMBOL_GPL(of_genpd_remove_last);
2576
2577 static void genpd_release_dev(struct device *dev)
2578 {
2579         of_node_put(dev->of_node);
2580         kfree(dev);
2581 }
2582
2583 static struct bus_type genpd_bus_type = {
2584         .name           = "genpd",
2585 };
2586
2587 /**
2588  * genpd_dev_pm_detach - Detach a device from its PM domain.
2589  * @dev: Device to detach.
2590  * @power_off: Currently not used
2591  *
2592  * Try to locate a corresponding generic PM domain, which the device was
2593  * attached to previously. If such is found, the device is detached from it.
2594  */
2595 static void genpd_dev_pm_detach(struct device *dev, bool power_off)
2596 {
2597         struct generic_pm_domain *pd;
2598         unsigned int i;
2599         int ret = 0;
2600
2601         pd = dev_to_genpd(dev);
2602         if (IS_ERR(pd))
2603                 return;
2604
2605         dev_dbg(dev, "removing from PM domain %s\n", pd->name);
2606
2607         /* Drop the default performance state */
2608         if (dev_gpd_data(dev)->default_pstate) {
2609                 dev_pm_genpd_set_performance_state(dev, 0);
2610                 dev_gpd_data(dev)->default_pstate = 0;
2611         }
2612
2613         for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
2614                 ret = genpd_remove_device(pd, dev);
2615                 if (ret != -EAGAIN)
2616                         break;
2617
2618                 mdelay(i);
2619                 cond_resched();
2620         }
2621
2622         if (ret < 0) {
2623                 dev_err(dev, "failed to remove from PM domain %s: %d",
2624                         pd->name, ret);
2625                 return;
2626         }
2627
2628         /* Check if PM domain can be powered off after removing this device. */
2629         genpd_queue_power_off_work(pd);
2630
2631         /* Unregister the device if it was created by genpd. */
2632         if (dev->bus == &genpd_bus_type)
2633                 device_unregister(dev);
2634 }
2635
2636 static void genpd_dev_pm_sync(struct device *dev)
2637 {
2638         struct generic_pm_domain *pd;
2639
2640         pd = dev_to_genpd(dev);
2641         if (IS_ERR(pd))
2642                 return;
2643
2644         genpd_queue_power_off_work(pd);
2645 }
2646
2647 static int __genpd_dev_pm_attach(struct device *dev, struct device *base_dev,
2648                                  unsigned int index, bool power_on)
2649 {
2650         struct of_phandle_args pd_args;
2651         struct generic_pm_domain *pd;
2652         int pstate;
2653         int ret;
2654
2655         ret = of_parse_phandle_with_args(dev->of_node, "power-domains",
2656                                 "#power-domain-cells", index, &pd_args);
2657         if (ret < 0)
2658                 return ret;
2659
2660         mutex_lock(&gpd_list_lock);
2661         pd = genpd_get_from_provider(&pd_args);
2662         of_node_put(pd_args.np);
2663         if (IS_ERR(pd)) {
2664                 mutex_unlock(&gpd_list_lock);
2665                 dev_dbg(dev, "%s() failed to find PM domain: %ld\n",
2666                         __func__, PTR_ERR(pd));
2667                 return driver_deferred_probe_check_state(base_dev);
2668         }
2669
2670         dev_dbg(dev, "adding to PM domain %s\n", pd->name);
2671
2672         ret = genpd_add_device(pd, dev, base_dev);
2673         mutex_unlock(&gpd_list_lock);
2674
2675         if (ret < 0) {
2676                 if (ret != -EPROBE_DEFER)
2677                         dev_err(dev, "failed to add to PM domain %s: %d",
2678                                 pd->name, ret);
2679                 return ret;
2680         }
2681
2682         dev->pm_domain->detach = genpd_dev_pm_detach;
2683         dev->pm_domain->sync = genpd_dev_pm_sync;
2684
2685         if (power_on) {
2686                 genpd_lock(pd);
2687                 ret = genpd_power_on(pd, 0);
2688                 genpd_unlock(pd);
2689         }
2690
2691         if (ret) {
2692                 genpd_remove_device(pd, dev);
2693                 return -EPROBE_DEFER;
2694         }
2695
2696         /* Set the default performance state */
2697         pstate = of_get_required_opp_performance_state(dev->of_node, index);
2698         if (pstate < 0 && pstate != -ENODEV && pstate != -EOPNOTSUPP) {
2699                 ret = pstate;
2700                 goto err;
2701         } else if (pstate > 0) {
2702                 ret = dev_pm_genpd_set_performance_state(dev, pstate);
2703                 if (ret)
2704                         goto err;
2705                 dev_gpd_data(dev)->default_pstate = pstate;
2706         }
2707         return 1;
2708
2709 err:
2710         dev_err(dev, "failed to set required performance state for power-domain %s: %d\n",
2711                 pd->name, ret);
2712         genpd_remove_device(pd, dev);
2713         return ret;
2714 }
2715
2716 /**
2717  * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
2718  * @dev: Device to attach.
2719  *
2720  * Parse device's OF node to find a PM domain specifier. If such is found,
2721  * attaches the device to retrieved pm_domain ops.
2722  *
2723  * Returns 1 on successfully attached PM domain, 0 when the device don't need a
2724  * PM domain or when multiple power-domains exists for it, else a negative error
2725  * code. Note that if a power-domain exists for the device, but it cannot be
2726  * found or turned on, then return -EPROBE_DEFER to ensure that the device is
2727  * not probed and to re-try again later.
2728  */
2729 int genpd_dev_pm_attach(struct device *dev)
2730 {
2731         if (!dev->of_node)
2732                 return 0;
2733
2734         /*
2735          * Devices with multiple PM domains must be attached separately, as we
2736          * can only attach one PM domain per device.
2737          */
2738         if (of_count_phandle_with_args(dev->of_node, "power-domains",
2739                                        "#power-domain-cells") != 1)
2740                 return 0;
2741
2742         return __genpd_dev_pm_attach(dev, dev, 0, true);
2743 }
2744 EXPORT_SYMBOL_GPL(genpd_dev_pm_attach);
2745
2746 /**
2747  * genpd_dev_pm_attach_by_id - Associate a device with one of its PM domains.
2748  * @dev: The device used to lookup the PM domain.
2749  * @index: The index of the PM domain.
2750  *
2751  * Parse device's OF node to find a PM domain specifier at the provided @index.
2752  * If such is found, creates a virtual device and attaches it to the retrieved
2753  * pm_domain ops. To deal with detaching of the virtual device, the ->detach()
2754  * callback in the struct dev_pm_domain are assigned to genpd_dev_pm_detach().
2755  *
2756  * Returns the created virtual device if successfully attached PM domain, NULL
2757  * when the device don't need a PM domain, else an ERR_PTR() in case of
2758  * failures. If a power-domain exists for the device, but cannot be found or
2759  * turned on, then ERR_PTR(-EPROBE_DEFER) is returned to ensure that the device
2760  * is not probed and to re-try again later.
2761  */
2762 struct device *genpd_dev_pm_attach_by_id(struct device *dev,
2763                                          unsigned int index)
2764 {
2765         struct device *virt_dev;
2766         int num_domains;
2767         int ret;
2768
2769         if (!dev->of_node)
2770                 return NULL;
2771
2772         /* Verify that the index is within a valid range. */
2773         num_domains = of_count_phandle_with_args(dev->of_node, "power-domains",
2774                                                  "#power-domain-cells");
2775         if (index >= num_domains)
2776                 return NULL;
2777
2778         /* Allocate and register device on the genpd bus. */
2779         virt_dev = kzalloc(sizeof(*virt_dev), GFP_KERNEL);
2780         if (!virt_dev)
2781                 return ERR_PTR(-ENOMEM);
2782
2783         dev_set_name(virt_dev, "genpd:%u:%s", index, dev_name(dev));
2784         virt_dev->bus = &genpd_bus_type;
2785         virt_dev->release = genpd_release_dev;
2786         virt_dev->of_node = of_node_get(dev->of_node);
2787
2788         ret = device_register(virt_dev);
2789         if (ret) {
2790                 put_device(virt_dev);
2791                 return ERR_PTR(ret);
2792         }
2793
2794         /* Try to attach the device to the PM domain at the specified index. */
2795         ret = __genpd_dev_pm_attach(virt_dev, dev, index, false);
2796         if (ret < 1) {
2797                 device_unregister(virt_dev);
2798                 return ret ? ERR_PTR(ret) : NULL;
2799         }
2800
2801         pm_runtime_enable(virt_dev);
2802         genpd_queue_power_off_work(dev_to_genpd(virt_dev));
2803
2804         return virt_dev;
2805 }
2806 EXPORT_SYMBOL_GPL(genpd_dev_pm_attach_by_id);
2807
2808 /**
2809  * genpd_dev_pm_attach_by_name - Associate a device with one of its PM domains.
2810  * @dev: The device used to lookup the PM domain.
2811  * @name: The name of the PM domain.
2812  *
2813  * Parse device's OF node to find a PM domain specifier using the
2814  * power-domain-names DT property. For further description see
2815  * genpd_dev_pm_attach_by_id().
2816  */
2817 struct device *genpd_dev_pm_attach_by_name(struct device *dev, const char *name)
2818 {
2819         int index;
2820
2821         if (!dev->of_node)
2822                 return NULL;
2823
2824         index = of_property_match_string(dev->of_node, "power-domain-names",
2825                                          name);
2826         if (index < 0)
2827                 return NULL;
2828
2829         return genpd_dev_pm_attach_by_id(dev, index);
2830 }
2831
2832 static const struct of_device_id idle_state_match[] = {
2833         { .compatible = "domain-idle-state", },
2834         { }
2835 };
2836
2837 static int genpd_parse_state(struct genpd_power_state *genpd_state,
2838                                     struct device_node *state_node)
2839 {
2840         int err;
2841         u32 residency;
2842         u32 entry_latency, exit_latency;
2843
2844         err = of_property_read_u32(state_node, "entry-latency-us",
2845                                                 &entry_latency);
2846         if (err) {
2847                 pr_debug(" * %pOF missing entry-latency-us property\n",
2848                          state_node);
2849                 return -EINVAL;
2850         }
2851
2852         err = of_property_read_u32(state_node, "exit-latency-us",
2853                                                 &exit_latency);
2854         if (err) {
2855                 pr_debug(" * %pOF missing exit-latency-us property\n",
2856                          state_node);
2857                 return -EINVAL;
2858         }
2859
2860         err = of_property_read_u32(state_node, "min-residency-us", &residency);
2861         if (!err)
2862                 genpd_state->residency_ns = 1000 * residency;
2863
2864         genpd_state->power_on_latency_ns = 1000 * exit_latency;
2865         genpd_state->power_off_latency_ns = 1000 * entry_latency;
2866         genpd_state->fwnode = &state_node->fwnode;
2867
2868         return 0;
2869 }
2870
2871 static int genpd_iterate_idle_states(struct device_node *dn,
2872                                      struct genpd_power_state *states)
2873 {
2874         int ret;
2875         struct of_phandle_iterator it;
2876         struct device_node *np;
2877         int i = 0;
2878
2879         ret = of_count_phandle_with_args(dn, "domain-idle-states", NULL);
2880         if (ret <= 0)
2881                 return ret == -ENOENT ? 0 : ret;
2882
2883         /* Loop over the phandles until all the requested entry is found */
2884         of_for_each_phandle(&it, ret, dn, "domain-idle-states", NULL, 0) {
2885                 np = it.node;
2886                 if (!of_match_node(idle_state_match, np))
2887                         continue;
2888                 if (states) {
2889                         ret = genpd_parse_state(&states[i], np);
2890                         if (ret) {
2891                                 pr_err("Parsing idle state node %pOF failed with err %d\n",
2892                                        np, ret);
2893                                 of_node_put(np);
2894                                 return ret;
2895                         }
2896                 }
2897                 i++;
2898         }
2899
2900         return i;
2901 }
2902
2903 /**
2904  * of_genpd_parse_idle_states: Return array of idle states for the genpd.
2905  *
2906  * @dn: The genpd device node
2907  * @states: The pointer to which the state array will be saved.
2908  * @n: The count of elements in the array returned from this function.
2909  *
2910  * Returns the device states parsed from the OF node. The memory for the states
2911  * is allocated by this function and is the responsibility of the caller to
2912  * free the memory after use. If any or zero compatible domain idle states is
2913  * found it returns 0 and in case of errors, a negative error code is returned.
2914  */
2915 int of_genpd_parse_idle_states(struct device_node *dn,
2916                         struct genpd_power_state **states, int *n)
2917 {
2918         struct genpd_power_state *st;
2919         int ret;
2920
2921         ret = genpd_iterate_idle_states(dn, NULL);
2922         if (ret < 0)
2923                 return ret;
2924
2925         if (!ret) {
2926                 *states = NULL;
2927                 *n = 0;
2928                 return 0;
2929         }
2930
2931         st = kcalloc(ret, sizeof(*st), GFP_KERNEL);
2932         if (!st)
2933                 return -ENOMEM;
2934
2935         ret = genpd_iterate_idle_states(dn, st);
2936         if (ret <= 0) {
2937                 kfree(st);
2938                 return ret < 0 ? ret : -EINVAL;
2939         }
2940
2941         *states = st;
2942         *n = ret;
2943
2944         return 0;
2945 }
2946 EXPORT_SYMBOL_GPL(of_genpd_parse_idle_states);
2947
2948 /**
2949  * pm_genpd_opp_to_performance_state - Gets performance state of the genpd from its OPP node.
2950  *
2951  * @genpd_dev: Genpd's device for which the performance-state needs to be found.
2952  * @opp: struct dev_pm_opp of the OPP for which we need to find performance
2953  *      state.
2954  *
2955  * Returns performance state encoded in the OPP of the genpd. This calls
2956  * platform specific genpd->opp_to_performance_state() callback to translate
2957  * power domain OPP to performance state.
2958  *
2959  * Returns performance state on success and 0 on failure.
2960  */
2961 unsigned int pm_genpd_opp_to_performance_state(struct device *genpd_dev,
2962                                                struct dev_pm_opp *opp)
2963 {
2964         struct generic_pm_domain *genpd = NULL;
2965         int state;
2966
2967         genpd = container_of(genpd_dev, struct generic_pm_domain, dev);
2968
2969         if (unlikely(!genpd->opp_to_performance_state))
2970                 return 0;
2971
2972         genpd_lock(genpd);
2973         state = genpd->opp_to_performance_state(genpd, opp);
2974         genpd_unlock(genpd);
2975
2976         return state;
2977 }
2978 EXPORT_SYMBOL_GPL(pm_genpd_opp_to_performance_state);
2979
2980 static int __init genpd_bus_init(void)
2981 {
2982         return bus_register(&genpd_bus_type);
2983 }
2984 core_initcall(genpd_bus_init);
2985
2986 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
2987
2988
2989 /***        debugfs support        ***/
2990
2991 #ifdef CONFIG_DEBUG_FS
2992 /*
2993  * TODO: This function is a slightly modified version of rtpm_status_show
2994  * from sysfs.c, so generalize it.
2995  */
2996 static void rtpm_status_str(struct seq_file *s, struct device *dev)
2997 {
2998         static const char * const status_lookup[] = {
2999                 [RPM_ACTIVE] = "active",
3000                 [RPM_RESUMING] = "resuming",
3001                 [RPM_SUSPENDED] = "suspended",
3002                 [RPM_SUSPENDING] = "suspending"
3003         };
3004         const char *p = "";
3005
3006         if (dev->power.runtime_error)
3007                 p = "error";
3008         else if (dev->power.disable_depth)
3009                 p = "unsupported";
3010         else if (dev->power.runtime_status < ARRAY_SIZE(status_lookup))
3011                 p = status_lookup[dev->power.runtime_status];
3012         else
3013                 WARN_ON(1);
3014
3015         seq_printf(s, "%-25s  ", p);
3016 }
3017
3018 static void perf_status_str(struct seq_file *s, struct device *dev)
3019 {
3020         struct generic_pm_domain_data *gpd_data;
3021
3022         gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
3023         seq_put_decimal_ull(s, "", gpd_data->performance_state);
3024 }
3025
3026 static int genpd_summary_one(struct seq_file *s,
3027                         struct generic_pm_domain *genpd)
3028 {
3029         static const char * const status_lookup[] = {
3030                 [GENPD_STATE_ON] = "on",
3031                 [GENPD_STATE_OFF] = "off"
3032         };
3033         struct pm_domain_data *pm_data;
3034         const char *kobj_path;
3035         struct gpd_link *link;
3036         char state[16];
3037         int ret;
3038
3039         ret = genpd_lock_interruptible(genpd);
3040         if (ret)
3041                 return -ERESTARTSYS;
3042
3043         if (WARN_ON(genpd->status >= ARRAY_SIZE(status_lookup)))
3044                 goto exit;
3045         if (!genpd_status_on(genpd))
3046                 snprintf(state, sizeof(state), "%s-%u",
3047                          status_lookup[genpd->status], genpd->state_idx);
3048         else
3049                 snprintf(state, sizeof(state), "%s",
3050                          status_lookup[genpd->status]);
3051         seq_printf(s, "%-30s  %-50s %u", genpd->name, state, genpd->performance_state);
3052
3053         /*
3054          * Modifications on the list require holding locks on both
3055          * parent and child, so we are safe.
3056          * Also genpd->name is immutable.
3057          */
3058         list_for_each_entry(link, &genpd->parent_links, parent_node) {
3059                 if (list_is_first(&link->parent_node, &genpd->parent_links))
3060                         seq_printf(s, "\n%48s", " ");
3061                 seq_printf(s, "%s", link->child->name);
3062                 if (!list_is_last(&link->parent_node, &genpd->parent_links))
3063                         seq_puts(s, ", ");
3064         }
3065
3066         list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
3067                 kobj_path = kobject_get_path(&pm_data->dev->kobj,
3068                                 genpd_is_irq_safe(genpd) ?
3069                                 GFP_ATOMIC : GFP_KERNEL);
3070                 if (kobj_path == NULL)
3071                         continue;
3072
3073                 seq_printf(s, "\n    %-50s  ", kobj_path);
3074                 rtpm_status_str(s, pm_data->dev);
3075                 perf_status_str(s, pm_data->dev);
3076                 kfree(kobj_path);
3077         }
3078
3079         seq_puts(s, "\n");
3080 exit:
3081         genpd_unlock(genpd);
3082
3083         return 0;
3084 }
3085
3086 static int summary_show(struct seq_file *s, void *data)
3087 {
3088         struct generic_pm_domain *genpd;
3089         int ret = 0;
3090
3091         seq_puts(s, "domain                          status          children                           performance\n");
3092         seq_puts(s, "    /device                                             runtime status\n");
3093         seq_puts(s, "----------------------------------------------------------------------------------------------\n");
3094
3095         ret = mutex_lock_interruptible(&gpd_list_lock);
3096         if (ret)
3097                 return -ERESTARTSYS;
3098
3099         list_for_each_entry(genpd, &gpd_list, gpd_list_node) {
3100                 ret = genpd_summary_one(s, genpd);
3101                 if (ret)
3102                         break;
3103         }
3104         mutex_unlock(&gpd_list_lock);
3105
3106         return ret;
3107 }
3108
3109 static int status_show(struct seq_file *s, void *data)
3110 {
3111         static const char * const status_lookup[] = {
3112                 [GENPD_STATE_ON] = "on",
3113                 [GENPD_STATE_OFF] = "off"
3114         };
3115
3116         struct generic_pm_domain *genpd = s->private;
3117         int ret = 0;
3118
3119         ret = genpd_lock_interruptible(genpd);
3120         if (ret)
3121                 return -ERESTARTSYS;
3122
3123         if (WARN_ON_ONCE(genpd->status >= ARRAY_SIZE(status_lookup)))
3124                 goto exit;
3125
3126         if (genpd->status == GENPD_STATE_OFF)
3127                 seq_printf(s, "%s-%u\n", status_lookup[genpd->status],
3128                         genpd->state_idx);
3129         else
3130                 seq_printf(s, "%s\n", status_lookup[genpd->status]);
3131 exit:
3132         genpd_unlock(genpd);
3133         return ret;
3134 }
3135
3136 static int sub_domains_show(struct seq_file *s, void *data)
3137 {
3138         struct generic_pm_domain *genpd = s->private;
3139         struct gpd_link *link;
3140         int ret = 0;
3141
3142         ret = genpd_lock_interruptible(genpd);
3143         if (ret)
3144                 return -ERESTARTSYS;
3145
3146         list_for_each_entry(link, &genpd->parent_links, parent_node)
3147                 seq_printf(s, "%s\n", link->child->name);
3148
3149         genpd_unlock(genpd);
3150         return ret;
3151 }
3152
3153 static int idle_states_show(struct seq_file *s, void *data)
3154 {
3155         struct generic_pm_domain *genpd = s->private;
3156         unsigned int i;
3157         int ret = 0;
3158
3159         ret = genpd_lock_interruptible(genpd);
3160         if (ret)
3161                 return -ERESTARTSYS;
3162
3163         seq_puts(s, "State          Time Spent(ms) Usage          Rejected\n");
3164
3165         for (i = 0; i < genpd->state_count; i++) {
3166                 ktime_t delta = 0;
3167                 s64 msecs;
3168
3169                 if ((genpd->status == GENPD_STATE_OFF) &&
3170                                 (genpd->state_idx == i))
3171                         delta = ktime_sub(ktime_get(), genpd->accounting_time);
3172
3173                 msecs = ktime_to_ms(
3174                         ktime_add(genpd->states[i].idle_time, delta));
3175                 seq_printf(s, "S%-13i %-14lld %-14llu %llu\n", i, msecs,
3176                               genpd->states[i].usage, genpd->states[i].rejected);
3177         }
3178
3179         genpd_unlock(genpd);
3180         return ret;
3181 }
3182
3183 static int active_time_show(struct seq_file *s, void *data)
3184 {
3185         struct generic_pm_domain *genpd = s->private;
3186         ktime_t delta = 0;
3187         int ret = 0;
3188
3189         ret = genpd_lock_interruptible(genpd);
3190         if (ret)
3191                 return -ERESTARTSYS;
3192
3193         if (genpd->status == GENPD_STATE_ON)
3194                 delta = ktime_sub(ktime_get(), genpd->accounting_time);
3195
3196         seq_printf(s, "%lld ms\n", ktime_to_ms(
3197                                 ktime_add(genpd->on_time, delta)));
3198
3199         genpd_unlock(genpd);
3200         return ret;
3201 }
3202
3203 static int total_idle_time_show(struct seq_file *s, void *data)
3204 {
3205         struct generic_pm_domain *genpd = s->private;
3206         ktime_t delta = 0, total = 0;
3207         unsigned int i;
3208         int ret = 0;
3209
3210         ret = genpd_lock_interruptible(genpd);
3211         if (ret)
3212                 return -ERESTARTSYS;
3213
3214         for (i = 0; i < genpd->state_count; i++) {
3215
3216                 if ((genpd->status == GENPD_STATE_OFF) &&
3217                                 (genpd->state_idx == i))
3218                         delta = ktime_sub(ktime_get(), genpd->accounting_time);
3219
3220                 total = ktime_add(total, genpd->states[i].idle_time);
3221         }
3222         total = ktime_add(total, delta);
3223
3224         seq_printf(s, "%lld ms\n", ktime_to_ms(total));
3225
3226         genpd_unlock(genpd);
3227         return ret;
3228 }
3229
3230
3231 static int devices_show(struct seq_file *s, void *data)
3232 {
3233         struct generic_pm_domain *genpd = s->private;
3234         struct pm_domain_data *pm_data;
3235         const char *kobj_path;
3236         int ret = 0;
3237
3238         ret = genpd_lock_interruptible(genpd);
3239         if (ret)
3240                 return -ERESTARTSYS;
3241
3242         list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
3243                 kobj_path = kobject_get_path(&pm_data->dev->kobj,
3244                                 genpd_is_irq_safe(genpd) ?
3245                                 GFP_ATOMIC : GFP_KERNEL);
3246                 if (kobj_path == NULL)
3247                         continue;
3248
3249                 seq_printf(s, "%s\n", kobj_path);
3250                 kfree(kobj_path);
3251         }
3252
3253         genpd_unlock(genpd);
3254         return ret;
3255 }
3256
3257 static int perf_state_show(struct seq_file *s, void *data)
3258 {
3259         struct generic_pm_domain *genpd = s->private;
3260
3261         if (genpd_lock_interruptible(genpd))
3262                 return -ERESTARTSYS;
3263
3264         seq_printf(s, "%u\n", genpd->performance_state);
3265
3266         genpd_unlock(genpd);
3267         return 0;
3268 }
3269
3270 DEFINE_SHOW_ATTRIBUTE(summary);
3271 DEFINE_SHOW_ATTRIBUTE(status);
3272 DEFINE_SHOW_ATTRIBUTE(sub_domains);
3273 DEFINE_SHOW_ATTRIBUTE(idle_states);
3274 DEFINE_SHOW_ATTRIBUTE(active_time);
3275 DEFINE_SHOW_ATTRIBUTE(total_idle_time);
3276 DEFINE_SHOW_ATTRIBUTE(devices);
3277 DEFINE_SHOW_ATTRIBUTE(perf_state);
3278
3279 static void genpd_debug_add(struct generic_pm_domain *genpd)
3280 {
3281         struct dentry *d;
3282
3283         if (!genpd_debugfs_dir)
3284                 return;
3285
3286         d = debugfs_create_dir(genpd->name, genpd_debugfs_dir);
3287
3288         debugfs_create_file("current_state", 0444,
3289                             d, genpd, &status_fops);
3290         debugfs_create_file("sub_domains", 0444,
3291                             d, genpd, &sub_domains_fops);
3292         debugfs_create_file("idle_states", 0444,
3293                             d, genpd, &idle_states_fops);
3294         debugfs_create_file("active_time", 0444,
3295                             d, genpd, &active_time_fops);
3296         debugfs_create_file("total_idle_time", 0444,
3297                             d, genpd, &total_idle_time_fops);
3298         debugfs_create_file("devices", 0444,
3299                             d, genpd, &devices_fops);
3300         if (genpd->set_performance_state)
3301                 debugfs_create_file("perf_state", 0444,
3302                                     d, genpd, &perf_state_fops);
3303 }
3304
3305 static int __init genpd_debug_init(void)
3306 {
3307         struct generic_pm_domain *genpd;
3308
3309         genpd_debugfs_dir = debugfs_create_dir("pm_genpd", NULL);
3310
3311         debugfs_create_file("pm_genpd_summary", S_IRUGO, genpd_debugfs_dir,
3312                             NULL, &summary_fops);
3313
3314         list_for_each_entry(genpd, &gpd_list, gpd_list_node)
3315                 genpd_debug_add(genpd);
3316
3317         return 0;
3318 }
3319 late_initcall(genpd_debug_init);
3320
3321 static void __exit genpd_debug_exit(void)
3322 {
3323         debugfs_remove_recursive(genpd_debugfs_dir);
3324 }
3325 __exitcall(genpd_debug_exit);
3326 #endif /* CONFIG_DEBUG_FS */