2 * drivers/base/power/domain.c - Common code related to device power domains.
4 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
6 * This file is released under the GPLv2.
9 #include <linux/delay.h>
10 #include <linux/kernel.h>
12 #include <linux/platform_device.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/pm_domain.h>
15 #include <linux/pm_qos.h>
16 #include <linux/pm_clock.h>
17 #include <linux/slab.h>
18 #include <linux/err.h>
19 #include <linux/sched.h>
20 #include <linux/suspend.h>
21 #include <linux/export.h>
23 #define GENPD_RETRY_MAX_MS 250 /* Approximate */
25 #define GENPD_DEV_CALLBACK(genpd, type, callback, dev) \
27 type (*__routine)(struct device *__d); \
28 type __ret = (type)0; \
30 __routine = genpd->dev_ops.callback; \
32 __ret = __routine(dev); \
37 static LIST_HEAD(gpd_list
);
38 static DEFINE_MUTEX(gpd_list_lock
);
41 * Get the generic PM domain for a particular struct device.
42 * This validates the struct device pointer, the PM domain pointer,
43 * and checks that the PM domain pointer is a real generic PM domain.
44 * Any failure results in NULL being returned.
46 struct generic_pm_domain
*pm_genpd_lookup_dev(struct device
*dev
)
48 struct generic_pm_domain
*genpd
= NULL
, *gpd
;
50 if (IS_ERR_OR_NULL(dev
) || IS_ERR_OR_NULL(dev
->pm_domain
))
53 mutex_lock(&gpd_list_lock
);
54 list_for_each_entry(gpd
, &gpd_list
, gpd_list_node
) {
55 if (&gpd
->domain
== dev
->pm_domain
) {
60 mutex_unlock(&gpd_list_lock
);
66 * This should only be used where we are certain that the pm_domain
67 * attached to the device is a genpd domain.
69 static struct generic_pm_domain
*dev_to_genpd(struct device
*dev
)
71 if (IS_ERR_OR_NULL(dev
->pm_domain
))
72 return ERR_PTR(-EINVAL
);
74 return pd_to_genpd(dev
->pm_domain
);
77 static int genpd_stop_dev(struct generic_pm_domain
*genpd
, struct device
*dev
)
79 return GENPD_DEV_CALLBACK(genpd
, int, stop
, dev
);
82 static int genpd_start_dev(struct generic_pm_domain
*genpd
, struct device
*dev
)
84 return GENPD_DEV_CALLBACK(genpd
, int, start
, dev
);
87 static bool genpd_sd_counter_dec(struct generic_pm_domain
*genpd
)
91 if (!WARN_ON(atomic_read(&genpd
->sd_count
) == 0))
92 ret
= !!atomic_dec_and_test(&genpd
->sd_count
);
97 static void genpd_sd_counter_inc(struct generic_pm_domain
*genpd
)
99 atomic_inc(&genpd
->sd_count
);
100 smp_mb__after_atomic();
103 static int genpd_power_on(struct generic_pm_domain
*genpd
, bool timed
)
109 if (!genpd
->power_on
)
113 return genpd
->power_on(genpd
);
115 time_start
= ktime_get();
116 ret
= genpd
->power_on(genpd
);
120 elapsed_ns
= ktime_to_ns(ktime_sub(ktime_get(), time_start
));
121 if (elapsed_ns
<= genpd
->power_on_latency_ns
)
124 genpd
->power_on_latency_ns
= elapsed_ns
;
125 genpd
->max_off_time_changed
= true;
126 pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
127 genpd
->name
, "on", elapsed_ns
);
132 static int genpd_power_off(struct generic_pm_domain
*genpd
, bool timed
)
138 if (!genpd
->power_off
)
142 return genpd
->power_off(genpd
);
144 time_start
= ktime_get();
145 ret
= genpd
->power_off(genpd
);
149 elapsed_ns
= ktime_to_ns(ktime_sub(ktime_get(), time_start
));
150 if (elapsed_ns
<= genpd
->power_off_latency_ns
)
153 genpd
->power_off_latency_ns
= elapsed_ns
;
154 genpd
->max_off_time_changed
= true;
155 pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
156 genpd
->name
, "off", elapsed_ns
);
162 * genpd_queue_power_off_work - Queue up the execution of genpd_poweroff().
163 * @genpd: PM domait to power off.
165 * Queue up the execution of genpd_poweroff() unless it's already been done
168 static void genpd_queue_power_off_work(struct generic_pm_domain
*genpd
)
170 queue_work(pm_wq
, &genpd
->power_off_work
);
173 static int genpd_poweron(struct generic_pm_domain
*genpd
);
176 * __genpd_poweron - Restore power to a given PM domain and its masters.
177 * @genpd: PM domain to power up.
179 * Restore power to @genpd and all of its masters so that it is possible to
180 * resume a device belonging to it.
182 static int __genpd_poweron(struct generic_pm_domain
*genpd
)
184 struct gpd_link
*link
;
187 if (genpd
->status
== GPD_STATE_ACTIVE
188 || (genpd
->prepared_count
> 0 && genpd
->suspend_power_off
))
192 * The list is guaranteed not to change while the loop below is being
193 * executed, unless one of the masters' .power_on() callbacks fiddles
196 list_for_each_entry(link
, &genpd
->slave_links
, slave_node
) {
197 genpd_sd_counter_inc(link
->master
);
199 ret
= genpd_poweron(link
->master
);
201 genpd_sd_counter_dec(link
->master
);
206 ret
= genpd_power_on(genpd
, true);
210 genpd
->status
= GPD_STATE_ACTIVE
;
214 list_for_each_entry_continue_reverse(link
,
217 genpd_sd_counter_dec(link
->master
);
218 genpd_queue_power_off_work(link
->master
);
225 * genpd_poweron - Restore power to a given PM domain and its masters.
226 * @genpd: PM domain to power up.
228 static int genpd_poweron(struct generic_pm_domain
*genpd
)
232 mutex_lock(&genpd
->lock
);
233 ret
= __genpd_poweron(genpd
);
234 mutex_unlock(&genpd
->lock
);
238 static int genpd_save_dev(struct generic_pm_domain
*genpd
, struct device
*dev
)
240 return GENPD_DEV_CALLBACK(genpd
, int, save_state
, dev
);
243 static int genpd_restore_dev(struct generic_pm_domain
*genpd
,
246 return GENPD_DEV_CALLBACK(genpd
, int, restore_state
, dev
);
249 static int genpd_dev_pm_qos_notifier(struct notifier_block
*nb
,
250 unsigned long val
, void *ptr
)
252 struct generic_pm_domain_data
*gpd_data
;
255 gpd_data
= container_of(nb
, struct generic_pm_domain_data
, nb
);
256 dev
= gpd_data
->base
.dev
;
259 struct generic_pm_domain
*genpd
;
260 struct pm_domain_data
*pdd
;
262 spin_lock_irq(&dev
->power
.lock
);
264 pdd
= dev
->power
.subsys_data
?
265 dev
->power
.subsys_data
->domain_data
: NULL
;
266 if (pdd
&& pdd
->dev
) {
267 to_gpd_data(pdd
)->td
.constraint_changed
= true;
268 genpd
= dev_to_genpd(dev
);
270 genpd
= ERR_PTR(-ENODATA
);
273 spin_unlock_irq(&dev
->power
.lock
);
275 if (!IS_ERR(genpd
)) {
276 mutex_lock(&genpd
->lock
);
277 genpd
->max_off_time_changed
= true;
278 mutex_unlock(&genpd
->lock
);
282 if (!dev
|| dev
->power
.ignore_children
)
290 * genpd_poweroff - Remove power from a given PM domain.
291 * @genpd: PM domain to power down.
292 * @is_async: PM domain is powered down from a scheduled work
294 * If all of the @genpd's devices have been suspended and all of its subdomains
295 * have been powered down, remove power from @genpd.
297 static int genpd_poweroff(struct generic_pm_domain
*genpd
, bool is_async
)
299 struct pm_domain_data
*pdd
;
300 struct gpd_link
*link
;
301 unsigned int not_suspended
= 0;
304 * Do not try to power off the domain in the following situations:
305 * (1) The domain is already in the "power off" state.
306 * (2) System suspend is in progress.
308 if (genpd
->status
== GPD_STATE_POWER_OFF
309 || genpd
->prepared_count
> 0)
312 if (atomic_read(&genpd
->sd_count
) > 0)
315 list_for_each_entry(pdd
, &genpd
->dev_list
, list_node
) {
316 enum pm_qos_flags_status stat
;
318 stat
= dev_pm_qos_flags(pdd
->dev
,
319 PM_QOS_FLAG_NO_POWER_OFF
320 | PM_QOS_FLAG_REMOTE_WAKEUP
);
321 if (stat
> PM_QOS_FLAGS_NONE
)
324 if (!pm_runtime_suspended(pdd
->dev
) || pdd
->dev
->power
.irq_safe
)
328 if (not_suspended
> 1 || (not_suspended
== 1 && is_async
))
331 if (genpd
->gov
&& genpd
->gov
->power_down_ok
) {
332 if (!genpd
->gov
->power_down_ok(&genpd
->domain
))
336 if (genpd
->power_off
) {
339 if (atomic_read(&genpd
->sd_count
) > 0)
343 * If sd_count > 0 at this point, one of the subdomains hasn't
344 * managed to call genpd_poweron() for the master yet after
345 * incrementing it. In that case genpd_poweron() will wait
346 * for us to drop the lock, so we can call .power_off() and let
347 * the genpd_poweron() restore power for us (this shouldn't
348 * happen very often).
350 ret
= genpd_power_off(genpd
, true);
355 genpd
->status
= GPD_STATE_POWER_OFF
;
357 list_for_each_entry(link
, &genpd
->slave_links
, slave_node
) {
358 genpd_sd_counter_dec(link
->master
);
359 genpd_queue_power_off_work(link
->master
);
366 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
367 * @work: Work structure used for scheduling the execution of this function.
369 static void genpd_power_off_work_fn(struct work_struct
*work
)
371 struct generic_pm_domain
*genpd
;
373 genpd
= container_of(work
, struct generic_pm_domain
, power_off_work
);
375 mutex_lock(&genpd
->lock
);
376 genpd_poweroff(genpd
, true);
377 mutex_unlock(&genpd
->lock
);
381 * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
382 * @dev: Device to suspend.
384 * Carry out a runtime suspend of a device under the assumption that its
385 * pm_domain field points to the domain member of an object of type
386 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
388 static int pm_genpd_runtime_suspend(struct device
*dev
)
390 struct generic_pm_domain
*genpd
;
391 bool (*stop_ok
)(struct device
*__dev
);
392 struct gpd_timing_data
*td
= &dev_gpd_data(dev
)->td
;
393 bool runtime_pm
= pm_runtime_enabled(dev
);
398 dev_dbg(dev
, "%s()\n", __func__
);
400 genpd
= dev_to_genpd(dev
);
405 * A runtime PM centric subsystem/driver may re-use the runtime PM
406 * callbacks for other purposes than runtime PM. In those scenarios
407 * runtime PM is disabled. Under these circumstances, we shall skip
408 * validating/measuring the PM QoS latency.
410 stop_ok
= genpd
->gov
? genpd
->gov
->stop_ok
: NULL
;
411 if (runtime_pm
&& stop_ok
&& !stop_ok(dev
))
414 /* Measure suspend latency. */
416 time_start
= ktime_get();
418 ret
= genpd_save_dev(genpd
, dev
);
422 ret
= genpd_stop_dev(genpd
, dev
);
424 genpd_restore_dev(genpd
, dev
);
428 /* Update suspend latency value if the measured time exceeds it. */
430 elapsed_ns
= ktime_to_ns(ktime_sub(ktime_get(), time_start
));
431 if (elapsed_ns
> td
->suspend_latency_ns
) {
432 td
->suspend_latency_ns
= elapsed_ns
;
433 dev_dbg(dev
, "suspend latency exceeded, %lld ns\n",
435 genpd
->max_off_time_changed
= true;
436 td
->constraint_changed
= true;
441 * If power.irq_safe is set, this routine will be run with interrupts
442 * off, so it can't use mutexes.
444 if (dev
->power
.irq_safe
)
447 mutex_lock(&genpd
->lock
);
448 genpd_poweroff(genpd
, false);
449 mutex_unlock(&genpd
->lock
);
455 * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
456 * @dev: Device to resume.
458 * Carry out a runtime resume of a device under the assumption that its
459 * pm_domain field points to the domain member of an object of type
460 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
462 static int pm_genpd_runtime_resume(struct device
*dev
)
464 struct generic_pm_domain
*genpd
;
465 struct gpd_timing_data
*td
= &dev_gpd_data(dev
)->td
;
466 bool runtime_pm
= pm_runtime_enabled(dev
);
472 dev_dbg(dev
, "%s()\n", __func__
);
474 genpd
= dev_to_genpd(dev
);
478 /* If power.irq_safe, the PM domain is never powered off. */
479 if (dev
->power
.irq_safe
) {
484 mutex_lock(&genpd
->lock
);
485 ret
= __genpd_poweron(genpd
);
486 mutex_unlock(&genpd
->lock
);
492 /* Measure resume latency. */
493 if (timed
&& runtime_pm
)
494 time_start
= ktime_get();
496 genpd_start_dev(genpd
, dev
);
497 genpd_restore_dev(genpd
, dev
);
499 /* Update resume latency value if the measured time exceeds it. */
500 if (timed
&& runtime_pm
) {
501 elapsed_ns
= ktime_to_ns(ktime_sub(ktime_get(), time_start
));
502 if (elapsed_ns
> td
->resume_latency_ns
) {
503 td
->resume_latency_ns
= elapsed_ns
;
504 dev_dbg(dev
, "resume latency exceeded, %lld ns\n",
506 genpd
->max_off_time_changed
= true;
507 td
->constraint_changed
= true;
514 static bool pd_ignore_unused
;
515 static int __init
pd_ignore_unused_setup(char *__unused
)
517 pd_ignore_unused
= true;
520 __setup("pd_ignore_unused", pd_ignore_unused_setup
);
523 * genpd_poweroff_unused - Power off all PM domains with no devices in use.
525 static int __init
genpd_poweroff_unused(void)
527 struct generic_pm_domain
*genpd
;
529 if (pd_ignore_unused
) {
530 pr_warn("genpd: Not disabling unused power domains\n");
534 mutex_lock(&gpd_list_lock
);
536 list_for_each_entry(genpd
, &gpd_list
, gpd_list_node
)
537 genpd_queue_power_off_work(genpd
);
539 mutex_unlock(&gpd_list_lock
);
543 late_initcall(genpd_poweroff_unused
);
545 #ifdef CONFIG_PM_SLEEP
548 * pm_genpd_present - Check if the given PM domain has been initialized.
549 * @genpd: PM domain to check.
551 static bool pm_genpd_present(const struct generic_pm_domain
*genpd
)
553 const struct generic_pm_domain
*gpd
;
555 if (IS_ERR_OR_NULL(genpd
))
558 list_for_each_entry(gpd
, &gpd_list
, gpd_list_node
)
565 static bool genpd_dev_active_wakeup(struct generic_pm_domain
*genpd
,
568 return GENPD_DEV_CALLBACK(genpd
, bool, active_wakeup
, dev
);
572 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
573 * @genpd: PM domain to power off, if possible.
574 * @timed: True if latency measurements are allowed.
576 * Check if the given PM domain can be powered off (during system suspend or
577 * hibernation) and do that if so. Also, in that case propagate to its masters.
579 * This function is only called in "noirq" and "syscore" stages of system power
580 * transitions, so it need not acquire locks (all of the "noirq" callbacks are
581 * executed sequentially, so it is guaranteed that it will never run twice in
584 static void pm_genpd_sync_poweroff(struct generic_pm_domain
*genpd
,
587 struct gpd_link
*link
;
589 if (genpd
->status
== GPD_STATE_POWER_OFF
)
592 if (genpd
->suspended_count
!= genpd
->device_count
593 || atomic_read(&genpd
->sd_count
) > 0)
596 genpd_power_off(genpd
, timed
);
598 genpd
->status
= GPD_STATE_POWER_OFF
;
600 list_for_each_entry(link
, &genpd
->slave_links
, slave_node
) {
601 genpd_sd_counter_dec(link
->master
);
602 pm_genpd_sync_poweroff(link
->master
, timed
);
607 * pm_genpd_sync_poweron - Synchronously power on a PM domain and its masters.
608 * @genpd: PM domain to power on.
609 * @timed: True if latency measurements are allowed.
611 * This function is only called in "noirq" and "syscore" stages of system power
612 * transitions, so it need not acquire locks (all of the "noirq" callbacks are
613 * executed sequentially, so it is guaranteed that it will never run twice in
616 static void pm_genpd_sync_poweron(struct generic_pm_domain
*genpd
,
619 struct gpd_link
*link
;
621 if (genpd
->status
== GPD_STATE_ACTIVE
)
624 list_for_each_entry(link
, &genpd
->slave_links
, slave_node
) {
625 pm_genpd_sync_poweron(link
->master
, timed
);
626 genpd_sd_counter_inc(link
->master
);
629 genpd_power_on(genpd
, timed
);
631 genpd
->status
= GPD_STATE_ACTIVE
;
635 * resume_needed - Check whether to resume a device before system suspend.
636 * @dev: Device to check.
637 * @genpd: PM domain the device belongs to.
639 * There are two cases in which a device that can wake up the system from sleep
640 * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
641 * to wake up the system and it has to remain active for this purpose while the
642 * system is in the sleep state and (2) if the device is not enabled to wake up
643 * the system from sleep states and it generally doesn't generate wakeup signals
644 * by itself (those signals are generated on its behalf by other parts of the
645 * system). In the latter case it may be necessary to reconfigure the device's
646 * wakeup settings during system suspend, because it may have been set up to
647 * signal remote wakeup from the system's working state as needed by runtime PM.
648 * Return 'true' in either of the above cases.
650 static bool resume_needed(struct device
*dev
, struct generic_pm_domain
*genpd
)
654 if (!device_can_wakeup(dev
))
657 active_wakeup
= genpd_dev_active_wakeup(genpd
, dev
);
658 return device_may_wakeup(dev
) ? active_wakeup
: !active_wakeup
;
662 * pm_genpd_prepare - Start power transition of a device in a PM domain.
663 * @dev: Device to start the transition of.
665 * Start a power transition of a device (during a system-wide power transition)
666 * under the assumption that its pm_domain field points to the domain member of
667 * an object of type struct generic_pm_domain representing a PM domain
668 * consisting of I/O devices.
670 static int pm_genpd_prepare(struct device
*dev
)
672 struct generic_pm_domain
*genpd
;
675 dev_dbg(dev
, "%s()\n", __func__
);
677 genpd
= dev_to_genpd(dev
);
682 * If a wakeup request is pending for the device, it should be woken up
683 * at this point and a system wakeup event should be reported if it's
684 * set up to wake up the system from sleep states.
686 pm_runtime_get_noresume(dev
);
687 if (pm_runtime_barrier(dev
) && device_may_wakeup(dev
))
688 pm_wakeup_event(dev
, 0);
690 if (pm_wakeup_pending()) {
695 if (resume_needed(dev
, genpd
))
696 pm_runtime_resume(dev
);
698 mutex_lock(&genpd
->lock
);
700 if (genpd
->prepared_count
++ == 0) {
701 genpd
->suspended_count
= 0;
702 genpd
->suspend_power_off
= genpd
->status
== GPD_STATE_POWER_OFF
;
705 mutex_unlock(&genpd
->lock
);
707 if (genpd
->suspend_power_off
) {
708 pm_runtime_put_noidle(dev
);
713 * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
714 * so genpd_poweron() will return immediately, but if the device
715 * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
716 * to make it operational.
718 pm_runtime_resume(dev
);
719 __pm_runtime_disable(dev
, false);
721 ret
= pm_generic_prepare(dev
);
723 mutex_lock(&genpd
->lock
);
725 if (--genpd
->prepared_count
== 0)
726 genpd
->suspend_power_off
= false;
728 mutex_unlock(&genpd
->lock
);
729 pm_runtime_enable(dev
);
737 * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
738 * @dev: Device to suspend.
740 * Suspend a device under the assumption that its pm_domain field points to the
741 * domain member of an object of type struct generic_pm_domain representing
742 * a PM domain consisting of I/O devices.
744 static int pm_genpd_suspend(struct device
*dev
)
746 struct generic_pm_domain
*genpd
;
748 dev_dbg(dev
, "%s()\n", __func__
);
750 genpd
= dev_to_genpd(dev
);
754 return genpd
->suspend_power_off
? 0 : pm_generic_suspend(dev
);
758 * pm_genpd_suspend_late - Late suspend of a device from an I/O PM domain.
759 * @dev: Device to suspend.
761 * Carry out a late suspend of a device under the assumption that its
762 * pm_domain field points to the domain member of an object of type
763 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
765 static int pm_genpd_suspend_late(struct device
*dev
)
767 struct generic_pm_domain
*genpd
;
769 dev_dbg(dev
, "%s()\n", __func__
);
771 genpd
= dev_to_genpd(dev
);
775 return genpd
->suspend_power_off
? 0 : pm_generic_suspend_late(dev
);
779 * pm_genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
780 * @dev: Device to suspend.
782 * Stop the device and remove power from the domain if all devices in it have
785 static int pm_genpd_suspend_noirq(struct device
*dev
)
787 struct generic_pm_domain
*genpd
;
789 dev_dbg(dev
, "%s()\n", __func__
);
791 genpd
= dev_to_genpd(dev
);
795 if (genpd
->suspend_power_off
796 || (dev
->power
.wakeup_path
&& genpd_dev_active_wakeup(genpd
, dev
)))
799 genpd_stop_dev(genpd
, dev
);
802 * Since all of the "noirq" callbacks are executed sequentially, it is
803 * guaranteed that this function will never run twice in parallel for
804 * the same PM domain, so it is not necessary to use locking here.
806 genpd
->suspended_count
++;
807 pm_genpd_sync_poweroff(genpd
, true);
813 * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
814 * @dev: Device to resume.
816 * Restore power to the device's PM domain, if necessary, and start the device.
818 static int pm_genpd_resume_noirq(struct device
*dev
)
820 struct generic_pm_domain
*genpd
;
822 dev_dbg(dev
, "%s()\n", __func__
);
824 genpd
= dev_to_genpd(dev
);
828 if (genpd
->suspend_power_off
829 || (dev
->power
.wakeup_path
&& genpd_dev_active_wakeup(genpd
, dev
)))
833 * Since all of the "noirq" callbacks are executed sequentially, it is
834 * guaranteed that this function will never run twice in parallel for
835 * the same PM domain, so it is not necessary to use locking here.
837 pm_genpd_sync_poweron(genpd
, true);
838 genpd
->suspended_count
--;
840 return genpd_start_dev(genpd
, dev
);
844 * pm_genpd_resume_early - Early resume of a device in an I/O PM domain.
845 * @dev: Device to resume.
847 * Carry out an early resume of a device under the assumption that its
848 * pm_domain field points to the domain member of an object of type
849 * struct generic_pm_domain representing a power domain consisting of I/O
852 static int pm_genpd_resume_early(struct device
*dev
)
854 struct generic_pm_domain
*genpd
;
856 dev_dbg(dev
, "%s()\n", __func__
);
858 genpd
= dev_to_genpd(dev
);
862 return genpd
->suspend_power_off
? 0 : pm_generic_resume_early(dev
);
866 * pm_genpd_resume - Resume of device in an I/O PM domain.
867 * @dev: Device to resume.
869 * Resume a device under the assumption that its pm_domain field points to the
870 * domain member of an object of type struct generic_pm_domain representing
871 * a power domain consisting of I/O devices.
873 static int pm_genpd_resume(struct device
*dev
)
875 struct generic_pm_domain
*genpd
;
877 dev_dbg(dev
, "%s()\n", __func__
);
879 genpd
= dev_to_genpd(dev
);
883 return genpd
->suspend_power_off
? 0 : pm_generic_resume(dev
);
887 * pm_genpd_freeze - Freezing a device in an I/O PM domain.
888 * @dev: Device to freeze.
890 * Freeze a device under the assumption that its pm_domain field points to the
891 * domain member of an object of type struct generic_pm_domain representing
892 * a power domain consisting of I/O devices.
894 static int pm_genpd_freeze(struct device
*dev
)
896 struct generic_pm_domain
*genpd
;
898 dev_dbg(dev
, "%s()\n", __func__
);
900 genpd
= dev_to_genpd(dev
);
904 return genpd
->suspend_power_off
? 0 : pm_generic_freeze(dev
);
908 * pm_genpd_freeze_late - Late freeze of a device in an I/O PM domain.
909 * @dev: Device to freeze.
911 * Carry out a late freeze of a device under the assumption that its
912 * pm_domain field points to the domain member of an object of type
913 * struct generic_pm_domain representing a power domain consisting of I/O
916 static int pm_genpd_freeze_late(struct device
*dev
)
918 struct generic_pm_domain
*genpd
;
920 dev_dbg(dev
, "%s()\n", __func__
);
922 genpd
= dev_to_genpd(dev
);
926 return genpd
->suspend_power_off
? 0 : pm_generic_freeze_late(dev
);
930 * pm_genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
931 * @dev: Device to freeze.
933 * Carry out a late freeze of a device under the assumption that its
934 * pm_domain field points to the domain member of an object of type
935 * struct generic_pm_domain representing a power domain consisting of I/O
938 static int pm_genpd_freeze_noirq(struct device
*dev
)
940 struct generic_pm_domain
*genpd
;
942 dev_dbg(dev
, "%s()\n", __func__
);
944 genpd
= dev_to_genpd(dev
);
948 return genpd
->suspend_power_off
? 0 : genpd_stop_dev(genpd
, dev
);
952 * pm_genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
953 * @dev: Device to thaw.
955 * Start the device, unless power has been removed from the domain already
956 * before the system transition.
958 static int pm_genpd_thaw_noirq(struct device
*dev
)
960 struct generic_pm_domain
*genpd
;
962 dev_dbg(dev
, "%s()\n", __func__
);
964 genpd
= dev_to_genpd(dev
);
968 return genpd
->suspend_power_off
?
969 0 : genpd_start_dev(genpd
, dev
);
973 * pm_genpd_thaw_early - Early thaw of device in an I/O PM domain.
974 * @dev: Device to thaw.
976 * Carry out an early thaw of a device under the assumption that its
977 * pm_domain field points to the domain member of an object of type
978 * struct generic_pm_domain representing a power domain consisting of I/O
981 static int pm_genpd_thaw_early(struct device
*dev
)
983 struct generic_pm_domain
*genpd
;
985 dev_dbg(dev
, "%s()\n", __func__
);
987 genpd
= dev_to_genpd(dev
);
991 return genpd
->suspend_power_off
? 0 : pm_generic_thaw_early(dev
);
995 * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
996 * @dev: Device to thaw.
998 * Thaw a device under the assumption that its pm_domain field points to the
999 * domain member of an object of type struct generic_pm_domain representing
1000 * a power domain consisting of I/O devices.
1002 static int pm_genpd_thaw(struct device
*dev
)
1004 struct generic_pm_domain
*genpd
;
1006 dev_dbg(dev
, "%s()\n", __func__
);
1008 genpd
= dev_to_genpd(dev
);
1012 return genpd
->suspend_power_off
? 0 : pm_generic_thaw(dev
);
1016 * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1017 * @dev: Device to resume.
1019 * Make sure the domain will be in the same power state as before the
1020 * hibernation the system is resuming from and start the device if necessary.
1022 static int pm_genpd_restore_noirq(struct device
*dev
)
1024 struct generic_pm_domain
*genpd
;
1026 dev_dbg(dev
, "%s()\n", __func__
);
1028 genpd
= dev_to_genpd(dev
);
1033 * Since all of the "noirq" callbacks are executed sequentially, it is
1034 * guaranteed that this function will never run twice in parallel for
1035 * the same PM domain, so it is not necessary to use locking here.
1037 * At this point suspended_count == 0 means we are being run for the
1038 * first time for the given domain in the present cycle.
1040 if (genpd
->suspended_count
++ == 0) {
1042 * The boot kernel might put the domain into arbitrary state,
1043 * so make it appear as powered off to pm_genpd_sync_poweron(),
1044 * so that it tries to power it on in case it was really off.
1046 genpd
->status
= GPD_STATE_POWER_OFF
;
1047 if (genpd
->suspend_power_off
) {
1049 * If the domain was off before the hibernation, make
1050 * sure it will be off going forward.
1052 genpd_power_off(genpd
, true);
1058 if (genpd
->suspend_power_off
)
1061 pm_genpd_sync_poweron(genpd
, true);
1063 return genpd_start_dev(genpd
, dev
);
1067 * pm_genpd_complete - Complete power transition of a device in a power domain.
1068 * @dev: Device to complete the transition of.
1070 * Complete a power transition of a device (during a system-wide power
1071 * transition) under the assumption that its pm_domain field points to the
1072 * domain member of an object of type struct generic_pm_domain representing
1073 * a power domain consisting of I/O devices.
1075 static void pm_genpd_complete(struct device
*dev
)
1077 struct generic_pm_domain
*genpd
;
1080 dev_dbg(dev
, "%s()\n", __func__
);
1082 genpd
= dev_to_genpd(dev
);
1086 mutex_lock(&genpd
->lock
);
1088 run_complete
= !genpd
->suspend_power_off
;
1089 if (--genpd
->prepared_count
== 0)
1090 genpd
->suspend_power_off
= false;
1092 mutex_unlock(&genpd
->lock
);
1095 pm_generic_complete(dev
);
1096 pm_runtime_set_active(dev
);
1097 pm_runtime_enable(dev
);
1098 pm_request_idle(dev
);
1103 * genpd_syscore_switch - Switch power during system core suspend or resume.
1104 * @dev: Device that normally is marked as "always on" to switch power for.
1106 * This routine may only be called during the system core (syscore) suspend or
1107 * resume phase for devices whose "always on" flags are set.
1109 static void genpd_syscore_switch(struct device
*dev
, bool suspend
)
1111 struct generic_pm_domain
*genpd
;
1113 genpd
= dev_to_genpd(dev
);
1114 if (!pm_genpd_present(genpd
))
1118 genpd
->suspended_count
++;
1119 pm_genpd_sync_poweroff(genpd
, false);
1121 pm_genpd_sync_poweron(genpd
, false);
1122 genpd
->suspended_count
--;
1126 void pm_genpd_syscore_poweroff(struct device
*dev
)
1128 genpd_syscore_switch(dev
, true);
1130 EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweroff
);
1132 void pm_genpd_syscore_poweron(struct device
*dev
)
1134 genpd_syscore_switch(dev
, false);
1136 EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweron
);
1138 #else /* !CONFIG_PM_SLEEP */
1140 #define pm_genpd_prepare NULL
1141 #define pm_genpd_suspend NULL
1142 #define pm_genpd_suspend_late NULL
1143 #define pm_genpd_suspend_noirq NULL
1144 #define pm_genpd_resume_early NULL
1145 #define pm_genpd_resume_noirq NULL
1146 #define pm_genpd_resume NULL
1147 #define pm_genpd_freeze NULL
1148 #define pm_genpd_freeze_late NULL
1149 #define pm_genpd_freeze_noirq NULL
1150 #define pm_genpd_thaw_early NULL
1151 #define pm_genpd_thaw_noirq NULL
1152 #define pm_genpd_thaw NULL
1153 #define pm_genpd_restore_noirq NULL
1154 #define pm_genpd_complete NULL
1156 #endif /* CONFIG_PM_SLEEP */
1158 static struct generic_pm_domain_data
*genpd_alloc_dev_data(struct device
*dev
,
1159 struct generic_pm_domain
*genpd
,
1160 struct gpd_timing_data
*td
)
1162 struct generic_pm_domain_data
*gpd_data
;
1165 ret
= dev_pm_get_subsys_data(dev
);
1167 return ERR_PTR(ret
);
1169 gpd_data
= kzalloc(sizeof(*gpd_data
), GFP_KERNEL
);
1178 gpd_data
->base
.dev
= dev
;
1179 gpd_data
->td
.constraint_changed
= true;
1180 gpd_data
->td
.effective_constraint_ns
= -1;
1181 gpd_data
->nb
.notifier_call
= genpd_dev_pm_qos_notifier
;
1183 spin_lock_irq(&dev
->power
.lock
);
1185 if (dev
->power
.subsys_data
->domain_data
) {
1190 dev
->power
.subsys_data
->domain_data
= &gpd_data
->base
;
1192 spin_unlock_irq(&dev
->power
.lock
);
1197 spin_unlock_irq(&dev
->power
.lock
);
1200 dev_pm_put_subsys_data(dev
);
1201 return ERR_PTR(ret
);
1204 static void genpd_free_dev_data(struct device
*dev
,
1205 struct generic_pm_domain_data
*gpd_data
)
1207 spin_lock_irq(&dev
->power
.lock
);
1209 dev
->power
.subsys_data
->domain_data
= NULL
;
1211 spin_unlock_irq(&dev
->power
.lock
);
1214 dev_pm_put_subsys_data(dev
);
1218 * __pm_genpd_add_device - Add a device to an I/O PM domain.
1219 * @genpd: PM domain to add the device to.
1220 * @dev: Device to be added.
1221 * @td: Set of PM QoS timing parameters to attach to the device.
1223 int __pm_genpd_add_device(struct generic_pm_domain
*genpd
, struct device
*dev
,
1224 struct gpd_timing_data
*td
)
1226 struct generic_pm_domain_data
*gpd_data
;
1229 dev_dbg(dev
, "%s()\n", __func__
);
1231 if (IS_ERR_OR_NULL(genpd
) || IS_ERR_OR_NULL(dev
))
1234 gpd_data
= genpd_alloc_dev_data(dev
, genpd
, td
);
1235 if (IS_ERR(gpd_data
))
1236 return PTR_ERR(gpd_data
);
1238 mutex_lock(&genpd
->lock
);
1240 if (genpd
->prepared_count
> 0) {
1245 ret
= genpd
->attach_dev
? genpd
->attach_dev(genpd
, dev
) : 0;
1249 dev
->pm_domain
= &genpd
->domain
;
1251 genpd
->device_count
++;
1252 genpd
->max_off_time_changed
= true;
1254 list_add_tail(&gpd_data
->base
.list_node
, &genpd
->dev_list
);
1257 mutex_unlock(&genpd
->lock
);
1260 genpd_free_dev_data(dev
, gpd_data
);
1262 dev_pm_qos_add_notifier(dev
, &gpd_data
->nb
);
1268 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1269 * @genpd: PM domain to remove the device from.
1270 * @dev: Device to be removed.
1272 int pm_genpd_remove_device(struct generic_pm_domain
*genpd
,
1275 struct generic_pm_domain_data
*gpd_data
;
1276 struct pm_domain_data
*pdd
;
1279 dev_dbg(dev
, "%s()\n", __func__
);
1281 if (!genpd
|| genpd
!= pm_genpd_lookup_dev(dev
))
1284 /* The above validation also means we have existing domain_data. */
1285 pdd
= dev
->power
.subsys_data
->domain_data
;
1286 gpd_data
= to_gpd_data(pdd
);
1287 dev_pm_qos_remove_notifier(dev
, &gpd_data
->nb
);
1289 mutex_lock(&genpd
->lock
);
1291 if (genpd
->prepared_count
> 0) {
1296 genpd
->device_count
--;
1297 genpd
->max_off_time_changed
= true;
1299 if (genpd
->detach_dev
)
1300 genpd
->detach_dev(genpd
, dev
);
1302 dev
->pm_domain
= NULL
;
1304 list_del_init(&pdd
->list_node
);
1306 mutex_unlock(&genpd
->lock
);
1308 genpd_free_dev_data(dev
, gpd_data
);
1313 mutex_unlock(&genpd
->lock
);
1314 dev_pm_qos_add_notifier(dev
, &gpd_data
->nb
);
1320 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1321 * @genpd: Master PM domain to add the subdomain to.
1322 * @subdomain: Subdomain to be added.
1324 int pm_genpd_add_subdomain(struct generic_pm_domain
*genpd
,
1325 struct generic_pm_domain
*subdomain
)
1327 struct gpd_link
*link
, *itr
;
1330 if (IS_ERR_OR_NULL(genpd
) || IS_ERR_OR_NULL(subdomain
)
1331 || genpd
== subdomain
)
1334 link
= kzalloc(sizeof(*link
), GFP_KERNEL
);
1338 mutex_lock(&genpd
->lock
);
1339 mutex_lock_nested(&subdomain
->lock
, SINGLE_DEPTH_NESTING
);
1341 if (genpd
->status
== GPD_STATE_POWER_OFF
1342 && subdomain
->status
!= GPD_STATE_POWER_OFF
) {
1347 list_for_each_entry(itr
, &genpd
->master_links
, master_node
) {
1348 if (itr
->slave
== subdomain
&& itr
->master
== genpd
) {
1354 link
->master
= genpd
;
1355 list_add_tail(&link
->master_node
, &genpd
->master_links
);
1356 link
->slave
= subdomain
;
1357 list_add_tail(&link
->slave_node
, &subdomain
->slave_links
);
1358 if (subdomain
->status
!= GPD_STATE_POWER_OFF
)
1359 genpd_sd_counter_inc(genpd
);
1362 mutex_unlock(&subdomain
->lock
);
1363 mutex_unlock(&genpd
->lock
);
1368 EXPORT_SYMBOL_GPL(pm_genpd_add_subdomain
);
1371 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1372 * @genpd: Master PM domain to remove the subdomain from.
1373 * @subdomain: Subdomain to be removed.
1375 int pm_genpd_remove_subdomain(struct generic_pm_domain
*genpd
,
1376 struct generic_pm_domain
*subdomain
)
1378 struct gpd_link
*l
, *link
;
1381 if (IS_ERR_OR_NULL(genpd
) || IS_ERR_OR_NULL(subdomain
))
1384 mutex_lock(&genpd
->lock
);
1386 if (!list_empty(&subdomain
->master_links
) || subdomain
->device_count
) {
1387 pr_warn("%s: unable to remove subdomain %s\n", genpd
->name
,
1393 list_for_each_entry_safe(link
, l
, &genpd
->master_links
, master_node
) {
1394 if (link
->slave
!= subdomain
)
1397 mutex_lock_nested(&subdomain
->lock
, SINGLE_DEPTH_NESTING
);
1399 list_del(&link
->master_node
);
1400 list_del(&link
->slave_node
);
1402 if (subdomain
->status
!= GPD_STATE_POWER_OFF
)
1403 genpd_sd_counter_dec(genpd
);
1405 mutex_unlock(&subdomain
->lock
);
1412 mutex_unlock(&genpd
->lock
);
1416 EXPORT_SYMBOL_GPL(pm_genpd_remove_subdomain
);
1418 /* Default device callbacks for generic PM domains. */
1421 * pm_genpd_default_save_state - Default "save device state" for PM domains.
1422 * @dev: Device to handle.
1424 static int pm_genpd_default_save_state(struct device
*dev
)
1426 int (*cb
)(struct device
*__dev
);
1428 if (dev
->type
&& dev
->type
->pm
)
1429 cb
= dev
->type
->pm
->runtime_suspend
;
1430 else if (dev
->class && dev
->class->pm
)
1431 cb
= dev
->class->pm
->runtime_suspend
;
1432 else if (dev
->bus
&& dev
->bus
->pm
)
1433 cb
= dev
->bus
->pm
->runtime_suspend
;
1437 if (!cb
&& dev
->driver
&& dev
->driver
->pm
)
1438 cb
= dev
->driver
->pm
->runtime_suspend
;
1440 return cb
? cb(dev
) : 0;
1444 * pm_genpd_default_restore_state - Default PM domains "restore device state".
1445 * @dev: Device to handle.
1447 static int pm_genpd_default_restore_state(struct device
*dev
)
1449 int (*cb
)(struct device
*__dev
);
1451 if (dev
->type
&& dev
->type
->pm
)
1452 cb
= dev
->type
->pm
->runtime_resume
;
1453 else if (dev
->class && dev
->class->pm
)
1454 cb
= dev
->class->pm
->runtime_resume
;
1455 else if (dev
->bus
&& dev
->bus
->pm
)
1456 cb
= dev
->bus
->pm
->runtime_resume
;
1460 if (!cb
&& dev
->driver
&& dev
->driver
->pm
)
1461 cb
= dev
->driver
->pm
->runtime_resume
;
1463 return cb
? cb(dev
) : 0;
1467 * pm_genpd_init - Initialize a generic I/O PM domain object.
1468 * @genpd: PM domain object to initialize.
1469 * @gov: PM domain governor to associate with the domain (may be NULL).
1470 * @is_off: Initial value of the domain's power_is_off field.
1472 void pm_genpd_init(struct generic_pm_domain
*genpd
,
1473 struct dev_power_governor
*gov
, bool is_off
)
1475 if (IS_ERR_OR_NULL(genpd
))
1478 INIT_LIST_HEAD(&genpd
->master_links
);
1479 INIT_LIST_HEAD(&genpd
->slave_links
);
1480 INIT_LIST_HEAD(&genpd
->dev_list
);
1481 mutex_init(&genpd
->lock
);
1483 INIT_WORK(&genpd
->power_off_work
, genpd_power_off_work_fn
);
1484 atomic_set(&genpd
->sd_count
, 0);
1485 genpd
->status
= is_off
? GPD_STATE_POWER_OFF
: GPD_STATE_ACTIVE
;
1486 genpd
->device_count
= 0;
1487 genpd
->max_off_time_ns
= -1;
1488 genpd
->max_off_time_changed
= true;
1489 genpd
->domain
.ops
.runtime_suspend
= pm_genpd_runtime_suspend
;
1490 genpd
->domain
.ops
.runtime_resume
= pm_genpd_runtime_resume
;
1491 genpd
->domain
.ops
.prepare
= pm_genpd_prepare
;
1492 genpd
->domain
.ops
.suspend
= pm_genpd_suspend
;
1493 genpd
->domain
.ops
.suspend_late
= pm_genpd_suspend_late
;
1494 genpd
->domain
.ops
.suspend_noirq
= pm_genpd_suspend_noirq
;
1495 genpd
->domain
.ops
.resume_noirq
= pm_genpd_resume_noirq
;
1496 genpd
->domain
.ops
.resume_early
= pm_genpd_resume_early
;
1497 genpd
->domain
.ops
.resume
= pm_genpd_resume
;
1498 genpd
->domain
.ops
.freeze
= pm_genpd_freeze
;
1499 genpd
->domain
.ops
.freeze_late
= pm_genpd_freeze_late
;
1500 genpd
->domain
.ops
.freeze_noirq
= pm_genpd_freeze_noirq
;
1501 genpd
->domain
.ops
.thaw_noirq
= pm_genpd_thaw_noirq
;
1502 genpd
->domain
.ops
.thaw_early
= pm_genpd_thaw_early
;
1503 genpd
->domain
.ops
.thaw
= pm_genpd_thaw
;
1504 genpd
->domain
.ops
.poweroff
= pm_genpd_suspend
;
1505 genpd
->domain
.ops
.poweroff_late
= pm_genpd_suspend_late
;
1506 genpd
->domain
.ops
.poweroff_noirq
= pm_genpd_suspend_noirq
;
1507 genpd
->domain
.ops
.restore_noirq
= pm_genpd_restore_noirq
;
1508 genpd
->domain
.ops
.restore_early
= pm_genpd_resume_early
;
1509 genpd
->domain
.ops
.restore
= pm_genpd_resume
;
1510 genpd
->domain
.ops
.complete
= pm_genpd_complete
;
1511 genpd
->dev_ops
.save_state
= pm_genpd_default_save_state
;
1512 genpd
->dev_ops
.restore_state
= pm_genpd_default_restore_state
;
1514 if (genpd
->flags
& GENPD_FLAG_PM_CLK
) {
1515 genpd
->dev_ops
.stop
= pm_clk_suspend
;
1516 genpd
->dev_ops
.start
= pm_clk_resume
;
1519 mutex_lock(&gpd_list_lock
);
1520 list_add(&genpd
->gpd_list_node
, &gpd_list
);
1521 mutex_unlock(&gpd_list_lock
);
1523 EXPORT_SYMBOL_GPL(pm_genpd_init
);
1525 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
1527 * Device Tree based PM domain providers.
1529 * The code below implements generic device tree based PM domain providers that
1530 * bind device tree nodes with generic PM domains registered in the system.
1532 * Any driver that registers generic PM domains and needs to support binding of
1533 * devices to these domains is supposed to register a PM domain provider, which
1534 * maps a PM domain specifier retrieved from the device tree to a PM domain.
1536 * Two simple mapping functions have been provided for convenience:
1537 * - __of_genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
1538 * - __of_genpd_xlate_onecell() for mapping of multiple PM domains per node by
1543 * struct of_genpd_provider - PM domain provider registration structure
1544 * @link: Entry in global list of PM domain providers
1545 * @node: Pointer to device tree node of PM domain provider
1546 * @xlate: Provider-specific xlate callback mapping a set of specifier cells
1548 * @data: context pointer to be passed into @xlate callback
1550 struct of_genpd_provider
{
1551 struct list_head link
;
1552 struct device_node
*node
;
1553 genpd_xlate_t xlate
;
1557 /* List of registered PM domain providers. */
1558 static LIST_HEAD(of_genpd_providers
);
1559 /* Mutex to protect the list above. */
1560 static DEFINE_MUTEX(of_genpd_mutex
);
1563 * __of_genpd_xlate_simple() - Xlate function for direct node-domain mapping
1564 * @genpdspec: OF phandle args to map into a PM domain
1565 * @data: xlate function private data - pointer to struct generic_pm_domain
1567 * This is a generic xlate function that can be used to model PM domains that
1568 * have their own device tree nodes. The private data of xlate function needs
1569 * to be a valid pointer to struct generic_pm_domain.
1571 struct generic_pm_domain
*__of_genpd_xlate_simple(
1572 struct of_phandle_args
*genpdspec
,
1575 if (genpdspec
->args_count
!= 0)
1576 return ERR_PTR(-EINVAL
);
1579 EXPORT_SYMBOL_GPL(__of_genpd_xlate_simple
);
1582 * __of_genpd_xlate_onecell() - Xlate function using a single index.
1583 * @genpdspec: OF phandle args to map into a PM domain
1584 * @data: xlate function private data - pointer to struct genpd_onecell_data
1586 * This is a generic xlate function that can be used to model simple PM domain
1587 * controllers that have one device tree node and provide multiple PM domains.
1588 * A single cell is used as an index into an array of PM domains specified in
1589 * the genpd_onecell_data struct when registering the provider.
1591 struct generic_pm_domain
*__of_genpd_xlate_onecell(
1592 struct of_phandle_args
*genpdspec
,
1595 struct genpd_onecell_data
*genpd_data
= data
;
1596 unsigned int idx
= genpdspec
->args
[0];
1598 if (genpdspec
->args_count
!= 1)
1599 return ERR_PTR(-EINVAL
);
1601 if (idx
>= genpd_data
->num_domains
) {
1602 pr_err("%s: invalid domain index %u\n", __func__
, idx
);
1603 return ERR_PTR(-EINVAL
);
1606 if (!genpd_data
->domains
[idx
])
1607 return ERR_PTR(-ENOENT
);
1609 return genpd_data
->domains
[idx
];
1611 EXPORT_SYMBOL_GPL(__of_genpd_xlate_onecell
);
1614 * __of_genpd_add_provider() - Register a PM domain provider for a node
1615 * @np: Device node pointer associated with the PM domain provider.
1616 * @xlate: Callback for decoding PM domain from phandle arguments.
1617 * @data: Context pointer for @xlate callback.
1619 int __of_genpd_add_provider(struct device_node
*np
, genpd_xlate_t xlate
,
1622 struct of_genpd_provider
*cp
;
1624 cp
= kzalloc(sizeof(*cp
), GFP_KERNEL
);
1628 cp
->node
= of_node_get(np
);
1632 mutex_lock(&of_genpd_mutex
);
1633 list_add(&cp
->link
, &of_genpd_providers
);
1634 mutex_unlock(&of_genpd_mutex
);
1635 pr_debug("Added domain provider from %s\n", np
->full_name
);
1639 EXPORT_SYMBOL_GPL(__of_genpd_add_provider
);
1642 * of_genpd_del_provider() - Remove a previously registered PM domain provider
1643 * @np: Device node pointer associated with the PM domain provider
1645 void of_genpd_del_provider(struct device_node
*np
)
1647 struct of_genpd_provider
*cp
, *tmp
;
1649 mutex_lock(&of_genpd_mutex
);
1650 list_for_each_entry_safe(cp
, tmp
, &of_genpd_providers
, link
) {
1651 if (cp
->node
== np
) {
1652 list_del(&cp
->link
);
1653 of_node_put(cp
->node
);
1658 mutex_unlock(&of_genpd_mutex
);
1660 EXPORT_SYMBOL_GPL(of_genpd_del_provider
);
1663 * of_genpd_get_from_provider() - Look-up PM domain
1664 * @genpdspec: OF phandle args to use for look-up
1666 * Looks for a PM domain provider under the node specified by @genpdspec and if
1667 * found, uses xlate function of the provider to map phandle args to a PM
1670 * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
1673 struct generic_pm_domain
*of_genpd_get_from_provider(
1674 struct of_phandle_args
*genpdspec
)
1676 struct generic_pm_domain
*genpd
= ERR_PTR(-ENOENT
);
1677 struct of_genpd_provider
*provider
;
1679 mutex_lock(&of_genpd_mutex
);
1681 /* Check if we have such a provider in our array */
1682 list_for_each_entry(provider
, &of_genpd_providers
, link
) {
1683 if (provider
->node
== genpdspec
->np
)
1684 genpd
= provider
->xlate(genpdspec
, provider
->data
);
1689 mutex_unlock(&of_genpd_mutex
);
1693 EXPORT_SYMBOL_GPL(of_genpd_get_from_provider
);
1696 * genpd_dev_pm_detach - Detach a device from its PM domain.
1697 * @dev: Device to detach.
1698 * @power_off: Currently not used
1700 * Try to locate a corresponding generic PM domain, which the device was
1701 * attached to previously. If such is found, the device is detached from it.
1703 static void genpd_dev_pm_detach(struct device
*dev
, bool power_off
)
1705 struct generic_pm_domain
*pd
;
1709 pd
= pm_genpd_lookup_dev(dev
);
1713 dev_dbg(dev
, "removing from PM domain %s\n", pd
->name
);
1715 for (i
= 1; i
< GENPD_RETRY_MAX_MS
; i
<<= 1) {
1716 ret
= pm_genpd_remove_device(pd
, dev
);
1725 dev_err(dev
, "failed to remove from PM domain %s: %d",
1730 /* Check if PM domain can be powered off after removing this device. */
1731 genpd_queue_power_off_work(pd
);
1734 static void genpd_dev_pm_sync(struct device
*dev
)
1736 struct generic_pm_domain
*pd
;
1738 pd
= dev_to_genpd(dev
);
1742 genpd_queue_power_off_work(pd
);
1746 * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
1747 * @dev: Device to attach.
1749 * Parse device's OF node to find a PM domain specifier. If such is found,
1750 * attaches the device to retrieved pm_domain ops.
1752 * Both generic and legacy Samsung-specific DT bindings are supported to keep
1753 * backwards compatibility with existing DTBs.
1755 * Returns 0 on successfully attached PM domain or negative error code. Note
1756 * that if a power-domain exists for the device, but it cannot be found or
1757 * turned on, then return -EPROBE_DEFER to ensure that the device is not
1758 * probed and to re-try again later.
1760 int genpd_dev_pm_attach(struct device
*dev
)
1762 struct of_phandle_args pd_args
;
1763 struct generic_pm_domain
*pd
;
1773 ret
= of_parse_phandle_with_args(dev
->of_node
, "power-domains",
1774 "#power-domain-cells", 0, &pd_args
);
1780 * Try legacy Samsung-specific bindings
1781 * (for backwards compatibility of DT ABI)
1783 pd_args
.args_count
= 0;
1784 pd_args
.np
= of_parse_phandle(dev
->of_node
,
1785 "samsung,power-domain", 0);
1790 pd
= of_genpd_get_from_provider(&pd_args
);
1791 of_node_put(pd_args
.np
);
1793 dev_dbg(dev
, "%s() failed to find PM domain: %ld\n",
1794 __func__
, PTR_ERR(pd
));
1795 return -EPROBE_DEFER
;
1798 dev_dbg(dev
, "adding to PM domain %s\n", pd
->name
);
1800 for (i
= 1; i
< GENPD_RETRY_MAX_MS
; i
<<= 1) {
1801 ret
= pm_genpd_add_device(pd
, dev
);
1810 dev_err(dev
, "failed to add to PM domain %s: %d",
1815 dev
->pm_domain
->detach
= genpd_dev_pm_detach
;
1816 dev
->pm_domain
->sync
= genpd_dev_pm_sync
;
1817 ret
= genpd_poweron(pd
);
1820 return ret
? -EPROBE_DEFER
: 0;
1822 EXPORT_SYMBOL_GPL(genpd_dev_pm_attach
);
1823 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
1826 /*** debugfs support ***/
1828 #ifdef CONFIG_PM_ADVANCED_DEBUG
1829 #include <linux/pm.h>
1830 #include <linux/device.h>
1831 #include <linux/debugfs.h>
1832 #include <linux/seq_file.h>
1833 #include <linux/init.h>
1834 #include <linux/kobject.h>
1835 static struct dentry
*pm_genpd_debugfs_dir
;
1838 * TODO: This function is a slightly modified version of rtpm_status_show
1839 * from sysfs.c, so generalize it.
1841 static void rtpm_status_str(struct seq_file
*s
, struct device
*dev
)
1843 static const char * const status_lookup
[] = {
1844 [RPM_ACTIVE
] = "active",
1845 [RPM_RESUMING
] = "resuming",
1846 [RPM_SUSPENDED
] = "suspended",
1847 [RPM_SUSPENDING
] = "suspending"
1851 if (dev
->power
.runtime_error
)
1853 else if (dev
->power
.disable_depth
)
1855 else if (dev
->power
.runtime_status
< ARRAY_SIZE(status_lookup
))
1856 p
= status_lookup
[dev
->power
.runtime_status
];
1863 static int pm_genpd_summary_one(struct seq_file
*s
,
1864 struct generic_pm_domain
*genpd
)
1866 static const char * const status_lookup
[] = {
1867 [GPD_STATE_ACTIVE
] = "on",
1868 [GPD_STATE_POWER_OFF
] = "off"
1870 struct pm_domain_data
*pm_data
;
1871 const char *kobj_path
;
1872 struct gpd_link
*link
;
1875 ret
= mutex_lock_interruptible(&genpd
->lock
);
1877 return -ERESTARTSYS
;
1879 if (WARN_ON(genpd
->status
>= ARRAY_SIZE(status_lookup
)))
1881 seq_printf(s
, "%-30s %-15s ", genpd
->name
, status_lookup
[genpd
->status
]);
1884 * Modifications on the list require holding locks on both
1885 * master and slave, so we are safe.
1886 * Also genpd->name is immutable.
1888 list_for_each_entry(link
, &genpd
->master_links
, master_node
) {
1889 seq_printf(s
, "%s", link
->slave
->name
);
1890 if (!list_is_last(&link
->master_node
, &genpd
->master_links
))
1894 list_for_each_entry(pm_data
, &genpd
->dev_list
, list_node
) {
1895 kobj_path
= kobject_get_path(&pm_data
->dev
->kobj
, GFP_KERNEL
);
1896 if (kobj_path
== NULL
)
1899 seq_printf(s
, "\n %-50s ", kobj_path
);
1900 rtpm_status_str(s
, pm_data
->dev
);
1906 mutex_unlock(&genpd
->lock
);
1911 static int pm_genpd_summary_show(struct seq_file
*s
, void *data
)
1913 struct generic_pm_domain
*genpd
;
1916 seq_puts(s
, "domain status slaves\n");
1917 seq_puts(s
, " /device runtime status\n");
1918 seq_puts(s
, "----------------------------------------------------------------------\n");
1920 ret
= mutex_lock_interruptible(&gpd_list_lock
);
1922 return -ERESTARTSYS
;
1924 list_for_each_entry(genpd
, &gpd_list
, gpd_list_node
) {
1925 ret
= pm_genpd_summary_one(s
, genpd
);
1929 mutex_unlock(&gpd_list_lock
);
1934 static int pm_genpd_summary_open(struct inode
*inode
, struct file
*file
)
1936 return single_open(file
, pm_genpd_summary_show
, NULL
);
1939 static const struct file_operations pm_genpd_summary_fops
= {
1940 .open
= pm_genpd_summary_open
,
1942 .llseek
= seq_lseek
,
1943 .release
= single_release
,
1946 static int __init
pm_genpd_debug_init(void)
1950 pm_genpd_debugfs_dir
= debugfs_create_dir("pm_genpd", NULL
);
1952 if (!pm_genpd_debugfs_dir
)
1955 d
= debugfs_create_file("pm_genpd_summary", S_IRUGO
,
1956 pm_genpd_debugfs_dir
, NULL
, &pm_genpd_summary_fops
);
1962 late_initcall(pm_genpd_debug_init
);
1964 static void __exit
pm_genpd_debug_exit(void)
1966 debugfs_remove_recursive(pm_genpd_debugfs_dir
);
1968 __exitcall(pm_genpd_debug_exit
);
1969 #endif /* CONFIG_PM_ADVANCED_DEBUG */