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