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