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/kernel.h>
11 #include <linux/platform_device.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/pm_domain.h>
14 #include <linux/pm_qos.h>
15 #include <linux/pm_clock.h>
16 #include <linux/slab.h>
17 #include <linux/err.h>
18 #include <linux/sched.h>
19 #include <linux/suspend.h>
20 #include <linux/export.h>
22 #define GENPD_DEV_CALLBACK(genpd, type, callback, dev) \
24 type (*__routine)(struct device *__d); \
25 type __ret = (type)0; \
27 __routine = genpd->dev_ops.callback; \
29 __ret = __routine(dev); \
34 #define GENPD_DEV_TIMED_CALLBACK(genpd, type, callback, dev, field, name) \
36 ktime_t __start = ktime_get(); \
37 type __retval = GENPD_DEV_CALLBACK(genpd, type, callback, dev); \
38 s64 __elapsed = ktime_to_ns(ktime_sub(ktime_get(), __start)); \
39 struct gpd_timing_data *__td = &dev_gpd_data(dev)->td; \
40 if (!__retval && __elapsed > __td->field) { \
41 __td->field = __elapsed; \
42 dev_dbg(dev, name " latency exceeded, new value %lld ns\n", \
44 genpd->max_off_time_changed = true; \
45 __td->constraint_changed = true; \
50 static LIST_HEAD(gpd_list);
51 static DEFINE_MUTEX(gpd_list_lock);
53 static struct generic_pm_domain *pm_genpd_lookup_name(const char *domain_name)
55 struct generic_pm_domain *genpd = NULL, *gpd;
57 if (IS_ERR_OR_NULL(domain_name))
60 mutex_lock(&gpd_list_lock);
61 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
62 if (!strcmp(gpd->name, domain_name)) {
67 mutex_unlock(&gpd_list_lock);
71 struct generic_pm_domain *dev_to_genpd(struct device *dev)
73 if (IS_ERR_OR_NULL(dev->pm_domain))
74 return ERR_PTR(-EINVAL);
76 return pd_to_genpd(dev->pm_domain);
79 static int genpd_stop_dev(struct generic_pm_domain *genpd, struct device *dev)
81 return GENPD_DEV_TIMED_CALLBACK(genpd, int, stop, dev,
82 stop_latency_ns, "stop");
85 static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev)
87 return GENPD_DEV_TIMED_CALLBACK(genpd, int, start, dev,
88 start_latency_ns, "start");
91 static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
95 if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
96 ret = !!atomic_dec_and_test(&genpd->sd_count);
101 static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
103 atomic_inc(&genpd->sd_count);
104 smp_mb__after_atomic();
107 static void genpd_acquire_lock(struct generic_pm_domain *genpd)
111 mutex_lock(&genpd->lock);
113 * Wait for the domain to transition into either the active,
114 * or the power off state.
117 prepare_to_wait(&genpd->status_wait_queue, &wait,
118 TASK_UNINTERRUPTIBLE);
119 if (genpd->status == GPD_STATE_ACTIVE
120 || genpd->status == GPD_STATE_POWER_OFF)
122 mutex_unlock(&genpd->lock);
126 mutex_lock(&genpd->lock);
128 finish_wait(&genpd->status_wait_queue, &wait);
131 static void genpd_release_lock(struct generic_pm_domain *genpd)
133 mutex_unlock(&genpd->lock);
136 static void genpd_set_active(struct generic_pm_domain *genpd)
138 if (genpd->resume_count == 0)
139 genpd->status = GPD_STATE_ACTIVE;
142 static void genpd_recalc_cpu_exit_latency(struct generic_pm_domain *genpd)
146 if (!genpd->cpuidle_data)
149 usecs64 = genpd->power_on_latency_ns;
150 do_div(usecs64, NSEC_PER_USEC);
151 usecs64 += genpd->cpuidle_data->saved_exit_latency;
152 genpd->cpuidle_data->idle_state->exit_latency = usecs64;
155 static int genpd_power_on(struct generic_pm_domain *genpd)
161 if (!genpd->power_on)
164 time_start = ktime_get();
165 ret = genpd->power_on(genpd);
169 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
170 if (elapsed_ns <= genpd->power_on_latency_ns)
173 genpd->power_on_latency_ns = elapsed_ns;
174 genpd->max_off_time_changed = true;
175 genpd_recalc_cpu_exit_latency(genpd);
176 pr_warn("%s: Power-%s latency exceeded, new value %lld ns\n",
177 genpd->name, "on", elapsed_ns);
182 static int genpd_power_off(struct generic_pm_domain *genpd)
188 if (!genpd->power_off)
191 time_start = ktime_get();
192 ret = genpd->power_off(genpd);
196 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
197 if (elapsed_ns <= genpd->power_off_latency_ns)
200 genpd->power_off_latency_ns = elapsed_ns;
201 genpd->max_off_time_changed = true;
202 pr_warn("%s: Power-%s latency exceeded, new value %lld ns\n",
203 genpd->name, "off", elapsed_ns);
209 * __pm_genpd_poweron - Restore power to a given PM domain and its masters.
210 * @genpd: PM domain to power up.
212 * Restore power to @genpd and all of its masters so that it is possible to
213 * resume a device belonging to it.
215 static int __pm_genpd_poweron(struct generic_pm_domain *genpd)
216 __releases(&genpd->lock) __acquires(&genpd->lock)
218 struct gpd_link *link;
222 /* If the domain's master is being waited for, we have to wait too. */
224 prepare_to_wait(&genpd->status_wait_queue, &wait,
225 TASK_UNINTERRUPTIBLE);
226 if (genpd->status != GPD_STATE_WAIT_MASTER)
228 mutex_unlock(&genpd->lock);
232 mutex_lock(&genpd->lock);
234 finish_wait(&genpd->status_wait_queue, &wait);
236 if (genpd->status == GPD_STATE_ACTIVE
237 || (genpd->prepared_count > 0 && genpd->suspend_power_off))
240 if (genpd->status != GPD_STATE_POWER_OFF) {
241 genpd_set_active(genpd);
245 if (genpd->cpuidle_data) {
246 cpuidle_pause_and_lock();
247 genpd->cpuidle_data->idle_state->disabled = true;
248 cpuidle_resume_and_unlock();
253 * The list is guaranteed not to change while the loop below is being
254 * executed, unless one of the masters' .power_on() callbacks fiddles
257 list_for_each_entry(link, &genpd->slave_links, slave_node) {
258 genpd_sd_counter_inc(link->master);
259 genpd->status = GPD_STATE_WAIT_MASTER;
261 mutex_unlock(&genpd->lock);
263 ret = pm_genpd_poweron(link->master);
265 mutex_lock(&genpd->lock);
268 * The "wait for parent" status is guaranteed not to change
269 * while the master is powering on.
271 genpd->status = GPD_STATE_POWER_OFF;
272 wake_up_all(&genpd->status_wait_queue);
274 genpd_sd_counter_dec(link->master);
279 ret = genpd_power_on(genpd);
284 genpd_set_active(genpd);
289 list_for_each_entry_continue_reverse(link, &genpd->slave_links, slave_node)
290 genpd_sd_counter_dec(link->master);
296 * pm_genpd_poweron - Restore power to a given PM domain and its masters.
297 * @genpd: PM domain to power up.
299 int pm_genpd_poweron(struct generic_pm_domain *genpd)
303 mutex_lock(&genpd->lock);
304 ret = __pm_genpd_poweron(genpd);
305 mutex_unlock(&genpd->lock);
310 * pm_genpd_name_poweron - Restore power to a given PM domain and its masters.
311 * @domain_name: Name of the PM domain to power up.
313 int pm_genpd_name_poweron(const char *domain_name)
315 struct generic_pm_domain *genpd;
317 genpd = pm_genpd_lookup_name(domain_name);
318 return genpd ? pm_genpd_poweron(genpd) : -EINVAL;
321 static int genpd_start_dev_no_timing(struct generic_pm_domain *genpd,
324 return GENPD_DEV_CALLBACK(genpd, int, start, dev);
327 static int genpd_save_dev(struct generic_pm_domain *genpd, struct device *dev)
329 return GENPD_DEV_TIMED_CALLBACK(genpd, int, save_state, dev,
330 save_state_latency_ns, "state save");
333 static int genpd_restore_dev(struct generic_pm_domain *genpd, struct device *dev)
335 return GENPD_DEV_TIMED_CALLBACK(genpd, int, restore_state, dev,
336 restore_state_latency_ns,
340 static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
341 unsigned long val, void *ptr)
343 struct generic_pm_domain_data *gpd_data;
346 gpd_data = container_of(nb, struct generic_pm_domain_data, nb);
348 mutex_lock(&gpd_data->lock);
349 dev = gpd_data->base.dev;
351 mutex_unlock(&gpd_data->lock);
354 mutex_unlock(&gpd_data->lock);
357 struct generic_pm_domain *genpd;
358 struct pm_domain_data *pdd;
360 spin_lock_irq(&dev->power.lock);
362 pdd = dev->power.subsys_data ?
363 dev->power.subsys_data->domain_data : NULL;
364 if (pdd && pdd->dev) {
365 to_gpd_data(pdd)->td.constraint_changed = true;
366 genpd = dev_to_genpd(dev);
368 genpd = ERR_PTR(-ENODATA);
371 spin_unlock_irq(&dev->power.lock);
373 if (!IS_ERR(genpd)) {
374 mutex_lock(&genpd->lock);
375 genpd->max_off_time_changed = true;
376 mutex_unlock(&genpd->lock);
380 if (!dev || dev->power.ignore_children)
388 * __pm_genpd_save_device - Save the pre-suspend state of a device.
389 * @pdd: Domain data of the device to save the state of.
390 * @genpd: PM domain the device belongs to.
392 static int __pm_genpd_save_device(struct pm_domain_data *pdd,
393 struct generic_pm_domain *genpd)
394 __releases(&genpd->lock) __acquires(&genpd->lock)
396 struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
397 struct device *dev = pdd->dev;
400 if (gpd_data->need_restore > 0)
404 * If the value of the need_restore flag is still unknown at this point,
405 * we trust that pm_genpd_poweroff() has verified that the device is
406 * already runtime PM suspended.
408 if (gpd_data->need_restore < 0) {
409 gpd_data->need_restore = 1;
413 mutex_unlock(&genpd->lock);
415 genpd_start_dev(genpd, dev);
416 ret = genpd_save_dev(genpd, dev);
417 genpd_stop_dev(genpd, dev);
419 mutex_lock(&genpd->lock);
422 gpd_data->need_restore = 1;
428 * __pm_genpd_restore_device - Restore the pre-suspend state of a device.
429 * @pdd: Domain data of the device to restore the state of.
430 * @genpd: PM domain the device belongs to.
432 static void __pm_genpd_restore_device(struct pm_domain_data *pdd,
433 struct generic_pm_domain *genpd)
434 __releases(&genpd->lock) __acquires(&genpd->lock)
436 struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
437 struct device *dev = pdd->dev;
438 int need_restore = gpd_data->need_restore;
440 gpd_data->need_restore = 0;
441 mutex_unlock(&genpd->lock);
443 genpd_start_dev(genpd, dev);
446 * Call genpd_restore_dev() for recently added devices too (need_restore
450 genpd_restore_dev(genpd, dev);
452 mutex_lock(&genpd->lock);
456 * genpd_abort_poweroff - Check if a PM domain power off should be aborted.
457 * @genpd: PM domain to check.
459 * Return true if a PM domain's status changed to GPD_STATE_ACTIVE during
460 * a "power off" operation, which means that a "power on" has occured in the
461 * meantime, or if its resume_count field is different from zero, which means
462 * that one of its devices has been resumed in the meantime.
464 static bool genpd_abort_poweroff(struct generic_pm_domain *genpd)
466 return genpd->status == GPD_STATE_WAIT_MASTER
467 || genpd->status == GPD_STATE_ACTIVE || genpd->resume_count > 0;
471 * genpd_queue_power_off_work - Queue up the execution of pm_genpd_poweroff().
472 * @genpd: PM domait to power off.
474 * Queue up the execution of pm_genpd_poweroff() unless it's already been done
477 static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
479 queue_work(pm_wq, &genpd->power_off_work);
483 * pm_genpd_poweroff - Remove power from a given PM domain.
484 * @genpd: PM domain to power down.
486 * If all of the @genpd's devices have been suspended and all of its subdomains
487 * have been powered down, run the runtime suspend callbacks provided by all of
488 * the @genpd's devices' drivers and remove power from @genpd.
490 static int pm_genpd_poweroff(struct generic_pm_domain *genpd)
491 __releases(&genpd->lock) __acquires(&genpd->lock)
493 struct pm_domain_data *pdd;
494 struct gpd_link *link;
495 unsigned int not_suspended;
500 * Do not try to power off the domain in the following situations:
501 * (1) The domain is already in the "power off" state.
502 * (2) The domain is waiting for its master to power up.
503 * (3) One of the domain's devices is being resumed right now.
504 * (4) System suspend is in progress.
506 if (genpd->status == GPD_STATE_POWER_OFF
507 || genpd->status == GPD_STATE_WAIT_MASTER
508 || genpd->resume_count > 0 || genpd->prepared_count > 0)
511 if (atomic_read(&genpd->sd_count) > 0)
515 list_for_each_entry(pdd, &genpd->dev_list, list_node) {
516 enum pm_qos_flags_status stat;
518 stat = dev_pm_qos_flags(pdd->dev,
519 PM_QOS_FLAG_NO_POWER_OFF
520 | PM_QOS_FLAG_REMOTE_WAKEUP);
521 if (stat > PM_QOS_FLAGS_NONE)
524 if (pdd->dev->driver && (!pm_runtime_suspended(pdd->dev)
525 || pdd->dev->power.irq_safe))
529 if (not_suspended > genpd->in_progress)
532 if (genpd->poweroff_task) {
534 * Another instance of pm_genpd_poweroff() is executing
535 * callbacks, so tell it to start over and return.
537 genpd->status = GPD_STATE_REPEAT;
541 if (genpd->gov && genpd->gov->power_down_ok) {
542 if (!genpd->gov->power_down_ok(&genpd->domain))
546 genpd->status = GPD_STATE_BUSY;
547 genpd->poweroff_task = current;
549 list_for_each_entry_reverse(pdd, &genpd->dev_list, list_node) {
550 ret = atomic_read(&genpd->sd_count) == 0 ?
551 __pm_genpd_save_device(pdd, genpd) : -EBUSY;
553 if (genpd_abort_poweroff(genpd))
557 genpd_set_active(genpd);
561 if (genpd->status == GPD_STATE_REPEAT) {
562 genpd->poweroff_task = NULL;
567 if (genpd->cpuidle_data) {
569 * If cpuidle_data is set, cpuidle should turn the domain off
570 * when the CPU in it is idle. In that case we don't decrement
571 * the subdomain counts of the master domains, so that power is
572 * not removed from the current domain prematurely as a result
573 * of cutting off the masters' power.
575 genpd->status = GPD_STATE_POWER_OFF;
576 cpuidle_pause_and_lock();
577 genpd->cpuidle_data->idle_state->disabled = false;
578 cpuidle_resume_and_unlock();
582 if (genpd->power_off) {
583 if (atomic_read(&genpd->sd_count) > 0) {
589 * If sd_count > 0 at this point, one of the subdomains hasn't
590 * managed to call pm_genpd_poweron() for the master yet after
591 * incrementing it. In that case pm_genpd_poweron() will wait
592 * for us to drop the lock, so we can call .power_off() and let
593 * the pm_genpd_poweron() restore power for us (this shouldn't
594 * happen very often).
596 ret = genpd_power_off(genpd);
598 genpd_set_active(genpd);
603 genpd->status = GPD_STATE_POWER_OFF;
605 list_for_each_entry(link, &genpd->slave_links, slave_node) {
606 genpd_sd_counter_dec(link->master);
607 genpd_queue_power_off_work(link->master);
611 genpd->poweroff_task = NULL;
612 wake_up_all(&genpd->status_wait_queue);
617 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
618 * @work: Work structure used for scheduling the execution of this function.
620 static void genpd_power_off_work_fn(struct work_struct *work)
622 struct generic_pm_domain *genpd;
624 genpd = container_of(work, struct generic_pm_domain, power_off_work);
626 genpd_acquire_lock(genpd);
627 pm_genpd_poweroff(genpd);
628 genpd_release_lock(genpd);
632 * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
633 * @dev: Device to suspend.
635 * Carry out a runtime suspend of a device under the assumption that its
636 * pm_domain field points to the domain member of an object of type
637 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
639 static int pm_genpd_runtime_suspend(struct device *dev)
641 struct generic_pm_domain *genpd;
642 struct generic_pm_domain_data *gpd_data;
643 bool (*stop_ok)(struct device *__dev);
646 dev_dbg(dev, "%s()\n", __func__);
648 genpd = dev_to_genpd(dev);
652 stop_ok = genpd->gov ? genpd->gov->stop_ok : NULL;
653 if (stop_ok && !stop_ok(dev))
656 ret = genpd_stop_dev(genpd, dev);
661 * If power.irq_safe is set, this routine will be run with interrupts
662 * off, so it can't use mutexes.
664 if (dev->power.irq_safe)
667 mutex_lock(&genpd->lock);
670 * If we have an unknown state of the need_restore flag, it means none
671 * of the runtime PM callbacks has been invoked yet. Let's update the
672 * flag to reflect that the current state is active.
674 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
675 if (gpd_data->need_restore < 0)
676 gpd_data->need_restore = 0;
678 genpd->in_progress++;
679 pm_genpd_poweroff(genpd);
680 genpd->in_progress--;
681 mutex_unlock(&genpd->lock);
687 * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
688 * @dev: Device to resume.
690 * Carry out a runtime resume of a device under the assumption that its
691 * pm_domain field points to the domain member of an object of type
692 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
694 static int pm_genpd_runtime_resume(struct device *dev)
696 struct generic_pm_domain *genpd;
700 dev_dbg(dev, "%s()\n", __func__);
702 genpd = dev_to_genpd(dev);
706 /* If power.irq_safe, the PM domain is never powered off. */
707 if (dev->power.irq_safe)
708 return genpd_start_dev_no_timing(genpd, dev);
710 mutex_lock(&genpd->lock);
711 ret = __pm_genpd_poweron(genpd);
713 mutex_unlock(&genpd->lock);
716 genpd->status = GPD_STATE_BUSY;
717 genpd->resume_count++;
719 prepare_to_wait(&genpd->status_wait_queue, &wait,
720 TASK_UNINTERRUPTIBLE);
722 * If current is the powering off task, we have been called
723 * reentrantly from one of the device callbacks, so we should
726 if (!genpd->poweroff_task || genpd->poweroff_task == current)
728 mutex_unlock(&genpd->lock);
732 mutex_lock(&genpd->lock);
734 finish_wait(&genpd->status_wait_queue, &wait);
735 __pm_genpd_restore_device(dev->power.subsys_data->domain_data, genpd);
736 genpd->resume_count--;
737 genpd_set_active(genpd);
738 wake_up_all(&genpd->status_wait_queue);
739 mutex_unlock(&genpd->lock);
744 static bool pd_ignore_unused;
745 static int __init pd_ignore_unused_setup(char *__unused)
747 pd_ignore_unused = true;
750 __setup("pd_ignore_unused", pd_ignore_unused_setup);
753 * pm_genpd_poweroff_unused - Power off all PM domains with no devices in use.
755 void pm_genpd_poweroff_unused(void)
757 struct generic_pm_domain *genpd;
759 if (pd_ignore_unused) {
760 pr_warn("genpd: Not disabling unused power domains\n");
764 mutex_lock(&gpd_list_lock);
766 list_for_each_entry(genpd, &gpd_list, gpd_list_node)
767 genpd_queue_power_off_work(genpd);
769 mutex_unlock(&gpd_list_lock);
772 static int __init genpd_poweroff_unused(void)
774 pm_genpd_poweroff_unused();
777 late_initcall(genpd_poweroff_unused);
779 #ifdef CONFIG_PM_SLEEP
782 * pm_genpd_present - Check if the given PM domain has been initialized.
783 * @genpd: PM domain to check.
785 static bool pm_genpd_present(const struct generic_pm_domain *genpd)
787 const struct generic_pm_domain *gpd;
789 if (IS_ERR_OR_NULL(genpd))
792 list_for_each_entry(gpd, &gpd_list, gpd_list_node)
799 static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
802 return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
806 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
807 * @genpd: PM domain to power off, if possible.
809 * Check if the given PM domain can be powered off (during system suspend or
810 * hibernation) and do that if so. Also, in that case propagate to its masters.
812 * This function is only called in "noirq" and "syscore" stages of system power
813 * transitions, so it need not acquire locks (all of the "noirq" callbacks are
814 * executed sequentially, so it is guaranteed that it will never run twice in
817 static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd)
819 struct gpd_link *link;
821 if (genpd->status == GPD_STATE_POWER_OFF)
824 if (genpd->suspended_count != genpd->device_count
825 || atomic_read(&genpd->sd_count) > 0)
828 genpd_power_off(genpd);
830 genpd->status = GPD_STATE_POWER_OFF;
832 list_for_each_entry(link, &genpd->slave_links, slave_node) {
833 genpd_sd_counter_dec(link->master);
834 pm_genpd_sync_poweroff(link->master);
839 * pm_genpd_sync_poweron - Synchronously power on a PM domain and its masters.
840 * @genpd: PM domain to power on.
842 * This function is only called in "noirq" and "syscore" stages of system power
843 * transitions, so it need not acquire locks (all of the "noirq" callbacks are
844 * executed sequentially, so it is guaranteed that it will never run twice in
847 static void pm_genpd_sync_poweron(struct generic_pm_domain *genpd)
849 struct gpd_link *link;
851 if (genpd->status != GPD_STATE_POWER_OFF)
854 list_for_each_entry(link, &genpd->slave_links, slave_node) {
855 pm_genpd_sync_poweron(link->master);
856 genpd_sd_counter_inc(link->master);
859 genpd_power_on(genpd);
861 genpd->status = GPD_STATE_ACTIVE;
865 * resume_needed - Check whether to resume a device before system suspend.
866 * @dev: Device to check.
867 * @genpd: PM domain the device belongs to.
869 * There are two cases in which a device that can wake up the system from sleep
870 * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
871 * to wake up the system and it has to remain active for this purpose while the
872 * system is in the sleep state and (2) if the device is not enabled to wake up
873 * the system from sleep states and it generally doesn't generate wakeup signals
874 * by itself (those signals are generated on its behalf by other parts of the
875 * system). In the latter case it may be necessary to reconfigure the device's
876 * wakeup settings during system suspend, because it may have been set up to
877 * signal remote wakeup from the system's working state as needed by runtime PM.
878 * Return 'true' in either of the above cases.
880 static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
884 if (!device_can_wakeup(dev))
887 active_wakeup = genpd_dev_active_wakeup(genpd, dev);
888 return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
892 * pm_genpd_prepare - Start power transition of a device in a PM domain.
893 * @dev: Device to start the transition of.
895 * Start a power transition of a device (during a system-wide power transition)
896 * under the assumption that its pm_domain field points to the domain member of
897 * an object of type struct generic_pm_domain representing a PM domain
898 * consisting of I/O devices.
900 static int pm_genpd_prepare(struct device *dev)
902 struct generic_pm_domain *genpd;
905 dev_dbg(dev, "%s()\n", __func__);
907 genpd = dev_to_genpd(dev);
912 * If a wakeup request is pending for the device, it should be woken up
913 * at this point and a system wakeup event should be reported if it's
914 * set up to wake up the system from sleep states.
916 pm_runtime_get_noresume(dev);
917 if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
918 pm_wakeup_event(dev, 0);
920 if (pm_wakeup_pending()) {
925 if (resume_needed(dev, genpd))
926 pm_runtime_resume(dev);
928 genpd_acquire_lock(genpd);
930 if (genpd->prepared_count++ == 0) {
931 genpd->suspended_count = 0;
932 genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
935 genpd_release_lock(genpd);
937 if (genpd->suspend_power_off) {
938 pm_runtime_put_noidle(dev);
943 * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
944 * so pm_genpd_poweron() will return immediately, but if the device
945 * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
946 * to make it operational.
948 pm_runtime_resume(dev);
949 __pm_runtime_disable(dev, false);
951 ret = pm_generic_prepare(dev);
953 mutex_lock(&genpd->lock);
955 if (--genpd->prepared_count == 0)
956 genpd->suspend_power_off = false;
958 mutex_unlock(&genpd->lock);
959 pm_runtime_enable(dev);
967 * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
968 * @dev: Device to suspend.
970 * Suspend a device under the assumption that its pm_domain field points to the
971 * domain member of an object of type struct generic_pm_domain representing
972 * a PM domain consisting of I/O devices.
974 static int pm_genpd_suspend(struct device *dev)
976 struct generic_pm_domain *genpd;
978 dev_dbg(dev, "%s()\n", __func__);
980 genpd = dev_to_genpd(dev);
984 return genpd->suspend_power_off ? 0 : pm_generic_suspend(dev);
988 * pm_genpd_suspend_late - Late suspend of a device from an I/O PM domain.
989 * @dev: Device to suspend.
991 * Carry out a late suspend of a device under the assumption that its
992 * pm_domain field points to the domain member of an object of type
993 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
995 static int pm_genpd_suspend_late(struct device *dev)
997 struct generic_pm_domain *genpd;
999 dev_dbg(dev, "%s()\n", __func__);
1001 genpd = dev_to_genpd(dev);
1005 return genpd->suspend_power_off ? 0 : pm_generic_suspend_late(dev);
1009 * pm_genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
1010 * @dev: Device to suspend.
1012 * Stop the device and remove power from the domain if all devices in it have
1015 static int pm_genpd_suspend_noirq(struct device *dev)
1017 struct generic_pm_domain *genpd;
1019 dev_dbg(dev, "%s()\n", __func__);
1021 genpd = dev_to_genpd(dev);
1025 if (genpd->suspend_power_off
1026 || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
1029 genpd_stop_dev(genpd, dev);
1032 * Since all of the "noirq" callbacks are executed sequentially, it is
1033 * guaranteed that this function will never run twice in parallel for
1034 * the same PM domain, so it is not necessary to use locking here.
1036 genpd->suspended_count++;
1037 pm_genpd_sync_poweroff(genpd);
1043 * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
1044 * @dev: Device to resume.
1046 * Restore power to the device's PM domain, if necessary, and start the device.
1048 static int pm_genpd_resume_noirq(struct device *dev)
1050 struct generic_pm_domain *genpd;
1052 dev_dbg(dev, "%s()\n", __func__);
1054 genpd = dev_to_genpd(dev);
1058 if (genpd->suspend_power_off
1059 || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
1063 * Since all of the "noirq" callbacks are executed sequentially, it is
1064 * guaranteed that this function will never run twice in parallel for
1065 * the same PM domain, so it is not necessary to use locking here.
1067 pm_genpd_sync_poweron(genpd);
1068 genpd->suspended_count--;
1070 return genpd_start_dev(genpd, dev);
1074 * pm_genpd_resume_early - Early resume of a device in an I/O PM domain.
1075 * @dev: Device to resume.
1077 * Carry out an early resume of a device under the assumption that its
1078 * pm_domain field points to the domain member of an object of type
1079 * struct generic_pm_domain representing a power domain consisting of I/O
1082 static int pm_genpd_resume_early(struct device *dev)
1084 struct generic_pm_domain *genpd;
1086 dev_dbg(dev, "%s()\n", __func__);
1088 genpd = dev_to_genpd(dev);
1092 return genpd->suspend_power_off ? 0 : pm_generic_resume_early(dev);
1096 * pm_genpd_resume - Resume of device in an I/O PM domain.
1097 * @dev: Device to resume.
1099 * Resume a device under the assumption that its pm_domain field points to the
1100 * domain member of an object of type struct generic_pm_domain representing
1101 * a power domain consisting of I/O devices.
1103 static int pm_genpd_resume(struct device *dev)
1105 struct generic_pm_domain *genpd;
1107 dev_dbg(dev, "%s()\n", __func__);
1109 genpd = dev_to_genpd(dev);
1113 return genpd->suspend_power_off ? 0 : pm_generic_resume(dev);
1117 * pm_genpd_freeze - Freezing a device in an I/O PM domain.
1118 * @dev: Device to freeze.
1120 * Freeze a device under the assumption that its pm_domain field points to the
1121 * domain member of an object of type struct generic_pm_domain representing
1122 * a power domain consisting of I/O devices.
1124 static int pm_genpd_freeze(struct device *dev)
1126 struct generic_pm_domain *genpd;
1128 dev_dbg(dev, "%s()\n", __func__);
1130 genpd = dev_to_genpd(dev);
1134 return genpd->suspend_power_off ? 0 : pm_generic_freeze(dev);
1138 * pm_genpd_freeze_late - Late freeze of a device in an I/O PM domain.
1139 * @dev: Device to freeze.
1141 * Carry out a late freeze of a device under the assumption that its
1142 * pm_domain field points to the domain member of an object of type
1143 * struct generic_pm_domain representing a power domain consisting of I/O
1146 static int pm_genpd_freeze_late(struct device *dev)
1148 struct generic_pm_domain *genpd;
1150 dev_dbg(dev, "%s()\n", __func__);
1152 genpd = dev_to_genpd(dev);
1156 return genpd->suspend_power_off ? 0 : pm_generic_freeze_late(dev);
1160 * pm_genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
1161 * @dev: Device to freeze.
1163 * Carry out a late freeze of a device under the assumption that its
1164 * pm_domain field points to the domain member of an object of type
1165 * struct generic_pm_domain representing a power domain consisting of I/O
1168 static int pm_genpd_freeze_noirq(struct device *dev)
1170 struct generic_pm_domain *genpd;
1172 dev_dbg(dev, "%s()\n", __func__);
1174 genpd = dev_to_genpd(dev);
1178 return genpd->suspend_power_off ? 0 : genpd_stop_dev(genpd, dev);
1182 * pm_genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
1183 * @dev: Device to thaw.
1185 * Start the device, unless power has been removed from the domain already
1186 * before the system transition.
1188 static int pm_genpd_thaw_noirq(struct device *dev)
1190 struct generic_pm_domain *genpd;
1192 dev_dbg(dev, "%s()\n", __func__);
1194 genpd = dev_to_genpd(dev);
1198 return genpd->suspend_power_off ? 0 : genpd_start_dev(genpd, dev);
1202 * pm_genpd_thaw_early - Early thaw of device in an I/O PM domain.
1203 * @dev: Device to thaw.
1205 * Carry out an early thaw of a device under the assumption that its
1206 * pm_domain field points to the domain member of an object of type
1207 * struct generic_pm_domain representing a power domain consisting of I/O
1210 static int pm_genpd_thaw_early(struct device *dev)
1212 struct generic_pm_domain *genpd;
1214 dev_dbg(dev, "%s()\n", __func__);
1216 genpd = dev_to_genpd(dev);
1220 return genpd->suspend_power_off ? 0 : pm_generic_thaw_early(dev);
1224 * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
1225 * @dev: Device to thaw.
1227 * Thaw a device under the assumption that its pm_domain field points to the
1228 * domain member of an object of type struct generic_pm_domain representing
1229 * a power domain consisting of I/O devices.
1231 static int pm_genpd_thaw(struct device *dev)
1233 struct generic_pm_domain *genpd;
1235 dev_dbg(dev, "%s()\n", __func__);
1237 genpd = dev_to_genpd(dev);
1241 return genpd->suspend_power_off ? 0 : pm_generic_thaw(dev);
1245 * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1246 * @dev: Device to resume.
1248 * Make sure the domain will be in the same power state as before the
1249 * hibernation the system is resuming from and start the device if necessary.
1251 static int pm_genpd_restore_noirq(struct device *dev)
1253 struct generic_pm_domain *genpd;
1255 dev_dbg(dev, "%s()\n", __func__);
1257 genpd = dev_to_genpd(dev);
1262 * Since all of the "noirq" callbacks are executed sequentially, it is
1263 * guaranteed that this function will never run twice in parallel for
1264 * the same PM domain, so it is not necessary to use locking here.
1266 * At this point suspended_count == 0 means we are being run for the
1267 * first time for the given domain in the present cycle.
1269 if (genpd->suspended_count++ == 0) {
1271 * The boot kernel might put the domain into arbitrary state,
1272 * so make it appear as powered off to pm_genpd_sync_poweron(),
1273 * so that it tries to power it on in case it was really off.
1275 genpd->status = GPD_STATE_POWER_OFF;
1276 if (genpd->suspend_power_off) {
1278 * If the domain was off before the hibernation, make
1279 * sure it will be off going forward.
1281 genpd_power_off(genpd);
1287 if (genpd->suspend_power_off)
1290 pm_genpd_sync_poweron(genpd);
1292 return genpd_start_dev(genpd, dev);
1296 * pm_genpd_complete - Complete power transition of a device in a power domain.
1297 * @dev: Device to complete the transition of.
1299 * Complete a power transition of a device (during a system-wide power
1300 * transition) under the assumption that its pm_domain field points to the
1301 * domain member of an object of type struct generic_pm_domain representing
1302 * a power domain consisting of I/O devices.
1304 static void pm_genpd_complete(struct device *dev)
1306 struct generic_pm_domain *genpd;
1309 dev_dbg(dev, "%s()\n", __func__);
1311 genpd = dev_to_genpd(dev);
1315 mutex_lock(&genpd->lock);
1317 run_complete = !genpd->suspend_power_off;
1318 if (--genpd->prepared_count == 0)
1319 genpd->suspend_power_off = false;
1321 mutex_unlock(&genpd->lock);
1324 pm_generic_complete(dev);
1325 pm_runtime_set_active(dev);
1326 pm_runtime_enable(dev);
1327 pm_request_idle(dev);
1332 * genpd_syscore_switch - Switch power during system core suspend or resume.
1333 * @dev: Device that normally is marked as "always on" to switch power for.
1335 * This routine may only be called during the system core (syscore) suspend or
1336 * resume phase for devices whose "always on" flags are set.
1338 static void genpd_syscore_switch(struct device *dev, bool suspend)
1340 struct generic_pm_domain *genpd;
1342 genpd = dev_to_genpd(dev);
1343 if (!pm_genpd_present(genpd))
1347 genpd->suspended_count++;
1348 pm_genpd_sync_poweroff(genpd);
1350 pm_genpd_sync_poweron(genpd);
1351 genpd->suspended_count--;
1355 void pm_genpd_syscore_poweroff(struct device *dev)
1357 genpd_syscore_switch(dev, true);
1359 EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweroff);
1361 void pm_genpd_syscore_poweron(struct device *dev)
1363 genpd_syscore_switch(dev, false);
1365 EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweron);
1367 #else /* !CONFIG_PM_SLEEP */
1369 #define pm_genpd_prepare NULL
1370 #define pm_genpd_suspend NULL
1371 #define pm_genpd_suspend_late NULL
1372 #define pm_genpd_suspend_noirq NULL
1373 #define pm_genpd_resume_early NULL
1374 #define pm_genpd_resume_noirq NULL
1375 #define pm_genpd_resume NULL
1376 #define pm_genpd_freeze NULL
1377 #define pm_genpd_freeze_late NULL
1378 #define pm_genpd_freeze_noirq NULL
1379 #define pm_genpd_thaw_early NULL
1380 #define pm_genpd_thaw_noirq NULL
1381 #define pm_genpd_thaw NULL
1382 #define pm_genpd_restore_noirq NULL
1383 #define pm_genpd_complete NULL
1385 #endif /* CONFIG_PM_SLEEP */
1387 static struct generic_pm_domain_data *__pm_genpd_alloc_dev_data(struct device *dev)
1389 struct generic_pm_domain_data *gpd_data;
1391 gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
1395 mutex_init(&gpd_data->lock);
1396 gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
1397 dev_pm_qos_add_notifier(dev, &gpd_data->nb);
1401 static void __pm_genpd_free_dev_data(struct device *dev,
1402 struct generic_pm_domain_data *gpd_data)
1404 dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
1409 * __pm_genpd_add_device - Add a device to an I/O PM domain.
1410 * @genpd: PM domain to add the device to.
1411 * @dev: Device to be added.
1412 * @td: Set of PM QoS timing parameters to attach to the device.
1414 int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1415 struct gpd_timing_data *td)
1417 struct generic_pm_domain_data *gpd_data_new, *gpd_data = NULL;
1418 struct pm_domain_data *pdd;
1421 dev_dbg(dev, "%s()\n", __func__);
1423 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1426 gpd_data_new = __pm_genpd_alloc_dev_data(dev);
1430 genpd_acquire_lock(genpd);
1432 if (genpd->prepared_count > 0) {
1437 list_for_each_entry(pdd, &genpd->dev_list, list_node)
1438 if (pdd->dev == dev) {
1443 ret = dev_pm_get_subsys_data(dev);
1447 genpd->device_count++;
1448 genpd->max_off_time_changed = true;
1450 spin_lock_irq(&dev->power.lock);
1452 dev->pm_domain = &genpd->domain;
1453 if (dev->power.subsys_data->domain_data) {
1454 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
1456 gpd_data = gpd_data_new;
1457 dev->power.subsys_data->domain_data = &gpd_data->base;
1459 gpd_data->refcount++;
1463 spin_unlock_irq(&dev->power.lock);
1465 if (genpd->attach_dev)
1466 genpd->attach_dev(genpd, dev);
1468 mutex_lock(&gpd_data->lock);
1469 gpd_data->base.dev = dev;
1470 list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1471 gpd_data->need_restore = -1;
1472 gpd_data->td.constraint_changed = true;
1473 gpd_data->td.effective_constraint_ns = -1;
1474 mutex_unlock(&gpd_data->lock);
1477 genpd_release_lock(genpd);
1479 if (gpd_data != gpd_data_new)
1480 __pm_genpd_free_dev_data(dev, gpd_data_new);
1486 * __pm_genpd_name_add_device - Find I/O PM domain and add a device to it.
1487 * @domain_name: Name of the PM domain to add the device to.
1488 * @dev: Device to be added.
1489 * @td: Set of PM QoS timing parameters to attach to the device.
1491 int __pm_genpd_name_add_device(const char *domain_name, struct device *dev,
1492 struct gpd_timing_data *td)
1494 return __pm_genpd_add_device(pm_genpd_lookup_name(domain_name), dev, td);
1498 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1499 * @genpd: PM domain to remove the device from.
1500 * @dev: Device to be removed.
1502 int pm_genpd_remove_device(struct generic_pm_domain *genpd,
1505 struct generic_pm_domain_data *gpd_data;
1506 struct pm_domain_data *pdd;
1507 bool remove = false;
1510 dev_dbg(dev, "%s()\n", __func__);
1512 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev)
1513 || IS_ERR_OR_NULL(dev->pm_domain)
1514 || pd_to_genpd(dev->pm_domain) != genpd)
1517 genpd_acquire_lock(genpd);
1519 if (genpd->prepared_count > 0) {
1524 genpd->device_count--;
1525 genpd->max_off_time_changed = true;
1527 if (genpd->detach_dev)
1528 genpd->detach_dev(genpd, dev);
1530 spin_lock_irq(&dev->power.lock);
1532 dev->pm_domain = NULL;
1533 pdd = dev->power.subsys_data->domain_data;
1534 list_del_init(&pdd->list_node);
1535 gpd_data = to_gpd_data(pdd);
1536 if (--gpd_data->refcount == 0) {
1537 dev->power.subsys_data->domain_data = NULL;
1541 spin_unlock_irq(&dev->power.lock);
1543 mutex_lock(&gpd_data->lock);
1545 mutex_unlock(&gpd_data->lock);
1547 genpd_release_lock(genpd);
1549 dev_pm_put_subsys_data(dev);
1551 __pm_genpd_free_dev_data(dev, gpd_data);
1556 genpd_release_lock(genpd);
1562 * pm_genpd_dev_need_restore - Set/unset the device's "need restore" flag.
1563 * @dev: Device to set/unset the flag for.
1564 * @val: The new value of the device's "need restore" flag.
1566 void pm_genpd_dev_need_restore(struct device *dev, bool val)
1568 struct pm_subsys_data *psd;
1569 unsigned long flags;
1571 spin_lock_irqsave(&dev->power.lock, flags);
1573 psd = dev_to_psd(dev);
1574 if (psd && psd->domain_data)
1575 to_gpd_data(psd->domain_data)->need_restore = val ? 1 : 0;
1577 spin_unlock_irqrestore(&dev->power.lock, flags);
1579 EXPORT_SYMBOL_GPL(pm_genpd_dev_need_restore);
1582 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1583 * @genpd: Master PM domain to add the subdomain to.
1584 * @subdomain: Subdomain to be added.
1586 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1587 struct generic_pm_domain *subdomain)
1589 struct gpd_link *link;
1592 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
1593 || genpd == subdomain)
1597 genpd_acquire_lock(genpd);
1598 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1600 if (subdomain->status != GPD_STATE_POWER_OFF
1601 && subdomain->status != GPD_STATE_ACTIVE) {
1602 mutex_unlock(&subdomain->lock);
1603 genpd_release_lock(genpd);
1607 if (genpd->status == GPD_STATE_POWER_OFF
1608 && subdomain->status != GPD_STATE_POWER_OFF) {
1613 list_for_each_entry(link, &genpd->master_links, master_node) {
1614 if (link->slave == subdomain && link->master == genpd) {
1620 link = kzalloc(sizeof(*link), GFP_KERNEL);
1625 link->master = genpd;
1626 list_add_tail(&link->master_node, &genpd->master_links);
1627 link->slave = subdomain;
1628 list_add_tail(&link->slave_node, &subdomain->slave_links);
1629 if (subdomain->status != GPD_STATE_POWER_OFF)
1630 genpd_sd_counter_inc(genpd);
1633 mutex_unlock(&subdomain->lock);
1634 genpd_release_lock(genpd);
1640 * pm_genpd_add_subdomain_names - Add a subdomain to an I/O PM domain.
1641 * @master_name: Name of the master PM domain to add the subdomain to.
1642 * @subdomain_name: Name of the subdomain to be added.
1644 int pm_genpd_add_subdomain_names(const char *master_name,
1645 const char *subdomain_name)
1647 struct generic_pm_domain *master = NULL, *subdomain = NULL, *gpd;
1649 if (IS_ERR_OR_NULL(master_name) || IS_ERR_OR_NULL(subdomain_name))
1652 mutex_lock(&gpd_list_lock);
1653 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
1654 if (!master && !strcmp(gpd->name, master_name))
1657 if (!subdomain && !strcmp(gpd->name, subdomain_name))
1660 if (master && subdomain)
1663 mutex_unlock(&gpd_list_lock);
1665 return pm_genpd_add_subdomain(master, subdomain);
1669 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1670 * @genpd: Master PM domain to remove the subdomain from.
1671 * @subdomain: Subdomain to be removed.
1673 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1674 struct generic_pm_domain *subdomain)
1676 struct gpd_link *link;
1679 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1683 genpd_acquire_lock(genpd);
1685 list_for_each_entry(link, &genpd->master_links, master_node) {
1686 if (link->slave != subdomain)
1689 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1691 if (subdomain->status != GPD_STATE_POWER_OFF
1692 && subdomain->status != GPD_STATE_ACTIVE) {
1693 mutex_unlock(&subdomain->lock);
1694 genpd_release_lock(genpd);
1698 list_del(&link->master_node);
1699 list_del(&link->slave_node);
1701 if (subdomain->status != GPD_STATE_POWER_OFF)
1702 genpd_sd_counter_dec(genpd);
1704 mutex_unlock(&subdomain->lock);
1710 genpd_release_lock(genpd);
1716 * pm_genpd_attach_cpuidle - Connect the given PM domain with cpuidle.
1717 * @genpd: PM domain to be connected with cpuidle.
1718 * @state: cpuidle state this domain can disable/enable.
1720 * Make a PM domain behave as though it contained a CPU core, that is, instead
1721 * of calling its power down routine it will enable the given cpuidle state so
1722 * that the cpuidle subsystem can power it down (if possible and desirable).
1724 int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state)
1726 struct cpuidle_driver *cpuidle_drv;
1727 struct gpd_cpuidle_data *cpuidle_data;
1728 struct cpuidle_state *idle_state;
1731 if (IS_ERR_OR_NULL(genpd) || state < 0)
1734 genpd_acquire_lock(genpd);
1736 if (genpd->cpuidle_data) {
1740 cpuidle_data = kzalloc(sizeof(*cpuidle_data), GFP_KERNEL);
1741 if (!cpuidle_data) {
1745 cpuidle_drv = cpuidle_driver_ref();
1750 if (cpuidle_drv->state_count <= state) {
1754 idle_state = &cpuidle_drv->states[state];
1755 if (!idle_state->disabled) {
1759 cpuidle_data->idle_state = idle_state;
1760 cpuidle_data->saved_exit_latency = idle_state->exit_latency;
1761 genpd->cpuidle_data = cpuidle_data;
1762 genpd_recalc_cpu_exit_latency(genpd);
1765 genpd_release_lock(genpd);
1769 cpuidle_driver_unref();
1772 kfree(cpuidle_data);
1777 * pm_genpd_name_attach_cpuidle - Find PM domain and connect cpuidle to it.
1778 * @name: Name of the domain to connect to cpuidle.
1779 * @state: cpuidle state this domain can manipulate.
1781 int pm_genpd_name_attach_cpuidle(const char *name, int state)
1783 return pm_genpd_attach_cpuidle(pm_genpd_lookup_name(name), state);
1787 * pm_genpd_detach_cpuidle - Remove the cpuidle connection from a PM domain.
1788 * @genpd: PM domain to remove the cpuidle connection from.
1790 * Remove the cpuidle connection set up by pm_genpd_attach_cpuidle() from the
1793 int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
1795 struct gpd_cpuidle_data *cpuidle_data;
1796 struct cpuidle_state *idle_state;
1799 if (IS_ERR_OR_NULL(genpd))
1802 genpd_acquire_lock(genpd);
1804 cpuidle_data = genpd->cpuidle_data;
1805 if (!cpuidle_data) {
1809 idle_state = cpuidle_data->idle_state;
1810 if (!idle_state->disabled) {
1814 idle_state->exit_latency = cpuidle_data->saved_exit_latency;
1815 cpuidle_driver_unref();
1816 genpd->cpuidle_data = NULL;
1817 kfree(cpuidle_data);
1820 genpd_release_lock(genpd);
1825 * pm_genpd_name_detach_cpuidle - Find PM domain and disconnect cpuidle from it.
1826 * @name: Name of the domain to disconnect cpuidle from.
1828 int pm_genpd_name_detach_cpuidle(const char *name)
1830 return pm_genpd_detach_cpuidle(pm_genpd_lookup_name(name));
1833 /* Default device callbacks for generic PM domains. */
1836 * pm_genpd_default_save_state - Default "save device state" for PM domains.
1837 * @dev: Device to handle.
1839 static int pm_genpd_default_save_state(struct device *dev)
1841 int (*cb)(struct device *__dev);
1843 if (dev->type && dev->type->pm)
1844 cb = dev->type->pm->runtime_suspend;
1845 else if (dev->class && dev->class->pm)
1846 cb = dev->class->pm->runtime_suspend;
1847 else if (dev->bus && dev->bus->pm)
1848 cb = dev->bus->pm->runtime_suspend;
1852 if (!cb && dev->driver && dev->driver->pm)
1853 cb = dev->driver->pm->runtime_suspend;
1855 return cb ? cb(dev) : 0;
1859 * pm_genpd_default_restore_state - Default PM domains "restore device state".
1860 * @dev: Device to handle.
1862 static int pm_genpd_default_restore_state(struct device *dev)
1864 int (*cb)(struct device *__dev);
1866 if (dev->type && dev->type->pm)
1867 cb = dev->type->pm->runtime_resume;
1868 else if (dev->class && dev->class->pm)
1869 cb = dev->class->pm->runtime_resume;
1870 else if (dev->bus && dev->bus->pm)
1871 cb = dev->bus->pm->runtime_resume;
1875 if (!cb && dev->driver && dev->driver->pm)
1876 cb = dev->driver->pm->runtime_resume;
1878 return cb ? cb(dev) : 0;
1882 * pm_genpd_init - Initialize a generic I/O PM domain object.
1883 * @genpd: PM domain object to initialize.
1884 * @gov: PM domain governor to associate with the domain (may be NULL).
1885 * @is_off: Initial value of the domain's power_is_off field.
1887 void pm_genpd_init(struct generic_pm_domain *genpd,
1888 struct dev_power_governor *gov, bool is_off)
1890 if (IS_ERR_OR_NULL(genpd))
1893 INIT_LIST_HEAD(&genpd->master_links);
1894 INIT_LIST_HEAD(&genpd->slave_links);
1895 INIT_LIST_HEAD(&genpd->dev_list);
1896 mutex_init(&genpd->lock);
1898 INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
1899 genpd->in_progress = 0;
1900 atomic_set(&genpd->sd_count, 0);
1901 genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
1902 init_waitqueue_head(&genpd->status_wait_queue);
1903 genpd->poweroff_task = NULL;
1904 genpd->resume_count = 0;
1905 genpd->device_count = 0;
1906 genpd->max_off_time_ns = -1;
1907 genpd->max_off_time_changed = true;
1908 genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
1909 genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
1910 genpd->domain.ops.prepare = pm_genpd_prepare;
1911 genpd->domain.ops.suspend = pm_genpd_suspend;
1912 genpd->domain.ops.suspend_late = pm_genpd_suspend_late;
1913 genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
1914 genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1915 genpd->domain.ops.resume_early = pm_genpd_resume_early;
1916 genpd->domain.ops.resume = pm_genpd_resume;
1917 genpd->domain.ops.freeze = pm_genpd_freeze;
1918 genpd->domain.ops.freeze_late = pm_genpd_freeze_late;
1919 genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
1920 genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1921 genpd->domain.ops.thaw_early = pm_genpd_thaw_early;
1922 genpd->domain.ops.thaw = pm_genpd_thaw;
1923 genpd->domain.ops.poweroff = pm_genpd_suspend;
1924 genpd->domain.ops.poweroff_late = pm_genpd_suspend_late;
1925 genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
1926 genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
1927 genpd->domain.ops.restore_early = pm_genpd_resume_early;
1928 genpd->domain.ops.restore = pm_genpd_resume;
1929 genpd->domain.ops.complete = pm_genpd_complete;
1930 genpd->dev_ops.save_state = pm_genpd_default_save_state;
1931 genpd->dev_ops.restore_state = pm_genpd_default_restore_state;
1933 if (genpd->flags & GENPD_FLAG_PM_CLK) {
1934 genpd->dev_ops.stop = pm_clk_suspend;
1935 genpd->dev_ops.start = pm_clk_resume;
1938 mutex_lock(&gpd_list_lock);
1939 list_add(&genpd->gpd_list_node, &gpd_list);
1940 mutex_unlock(&gpd_list_lock);
1943 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
1945 * Device Tree based PM domain providers.
1947 * The code below implements generic device tree based PM domain providers that
1948 * bind device tree nodes with generic PM domains registered in the system.
1950 * Any driver that registers generic PM domains and needs to support binding of
1951 * devices to these domains is supposed to register a PM domain provider, which
1952 * maps a PM domain specifier retrieved from the device tree to a PM domain.
1954 * Two simple mapping functions have been provided for convenience:
1955 * - __of_genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
1956 * - __of_genpd_xlate_onecell() for mapping of multiple PM domains per node by
1961 * struct of_genpd_provider - PM domain provider registration structure
1962 * @link: Entry in global list of PM domain providers
1963 * @node: Pointer to device tree node of PM domain provider
1964 * @xlate: Provider-specific xlate callback mapping a set of specifier cells
1966 * @data: context pointer to be passed into @xlate callback
1968 struct of_genpd_provider {
1969 struct list_head link;
1970 struct device_node *node;
1971 genpd_xlate_t xlate;
1975 /* List of registered PM domain providers. */
1976 static LIST_HEAD(of_genpd_providers);
1977 /* Mutex to protect the list above. */
1978 static DEFINE_MUTEX(of_genpd_mutex);
1981 * __of_genpd_xlate_simple() - Xlate function for direct node-domain mapping
1982 * @genpdspec: OF phandle args to map into a PM domain
1983 * @data: xlate function private data - pointer to struct generic_pm_domain
1985 * This is a generic xlate function that can be used to model PM domains that
1986 * have their own device tree nodes. The private data of xlate function needs
1987 * to be a valid pointer to struct generic_pm_domain.
1989 struct generic_pm_domain *__of_genpd_xlate_simple(
1990 struct of_phandle_args *genpdspec,
1993 if (genpdspec->args_count != 0)
1994 return ERR_PTR(-EINVAL);
1997 EXPORT_SYMBOL_GPL(__of_genpd_xlate_simple);
2000 * __of_genpd_xlate_onecell() - Xlate function using a single index.
2001 * @genpdspec: OF phandle args to map into a PM domain
2002 * @data: xlate function private data - pointer to struct genpd_onecell_data
2004 * This is a generic xlate function that can be used to model simple PM domain
2005 * controllers that have one device tree node and provide multiple PM domains.
2006 * A single cell is used as an index into an array of PM domains specified in
2007 * the genpd_onecell_data struct when registering the provider.
2009 struct generic_pm_domain *__of_genpd_xlate_onecell(
2010 struct of_phandle_args *genpdspec,
2013 struct genpd_onecell_data *genpd_data = data;
2014 unsigned int idx = genpdspec->args[0];
2016 if (genpdspec->args_count != 1)
2017 return ERR_PTR(-EINVAL);
2019 if (idx >= genpd_data->num_domains) {
2020 pr_err("%s: invalid domain index %u\n", __func__, idx);
2021 return ERR_PTR(-EINVAL);
2024 if (!genpd_data->domains[idx])
2025 return ERR_PTR(-ENOENT);
2027 return genpd_data->domains[idx];
2029 EXPORT_SYMBOL_GPL(__of_genpd_xlate_onecell);
2032 * __of_genpd_add_provider() - Register a PM domain provider for a node
2033 * @np: Device node pointer associated with the PM domain provider.
2034 * @xlate: Callback for decoding PM domain from phandle arguments.
2035 * @data: Context pointer for @xlate callback.
2037 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
2040 struct of_genpd_provider *cp;
2042 cp = kzalloc(sizeof(*cp), GFP_KERNEL);
2046 cp->node = of_node_get(np);
2050 mutex_lock(&of_genpd_mutex);
2051 list_add(&cp->link, &of_genpd_providers);
2052 mutex_unlock(&of_genpd_mutex);
2053 pr_debug("Added domain provider from %s\n", np->full_name);
2057 EXPORT_SYMBOL_GPL(__of_genpd_add_provider);
2060 * of_genpd_del_provider() - Remove a previously registered PM domain provider
2061 * @np: Device node pointer associated with the PM domain provider
2063 void of_genpd_del_provider(struct device_node *np)
2065 struct of_genpd_provider *cp;
2067 mutex_lock(&of_genpd_mutex);
2068 list_for_each_entry(cp, &of_genpd_providers, link) {
2069 if (cp->node == np) {
2070 list_del(&cp->link);
2071 of_node_put(cp->node);
2076 mutex_unlock(&of_genpd_mutex);
2078 EXPORT_SYMBOL_GPL(of_genpd_del_provider);
2081 * of_genpd_get_from_provider() - Look-up PM domain
2082 * @genpdspec: OF phandle args to use for look-up
2084 * Looks for a PM domain provider under the node specified by @genpdspec and if
2085 * found, uses xlate function of the provider to map phandle args to a PM
2088 * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
2091 struct generic_pm_domain *of_genpd_get_from_provider(
2092 struct of_phandle_args *genpdspec)
2094 struct generic_pm_domain *genpd = ERR_PTR(-ENOENT);
2095 struct of_genpd_provider *provider;
2097 mutex_lock(&of_genpd_mutex);
2099 /* Check if we have such a provider in our array */
2100 list_for_each_entry(provider, &of_genpd_providers, link) {
2101 if (provider->node == genpdspec->np)
2102 genpd = provider->xlate(genpdspec, provider->data);
2107 mutex_unlock(&of_genpd_mutex);
2111 EXPORT_SYMBOL_GPL(of_genpd_get_from_provider);
2114 * genpd_dev_pm_detach - Detach a device from its PM domain.
2115 * @dev: Device to attach.
2116 * @power_off: Currently not used
2118 * Try to locate a corresponding generic PM domain, which the device was
2119 * attached to previously. If such is found, the device is detached from it.
2121 static void genpd_dev_pm_detach(struct device *dev, bool power_off)
2123 struct generic_pm_domain *pd = NULL, *gpd;
2126 if (!dev->pm_domain)
2129 mutex_lock(&gpd_list_lock);
2130 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
2131 if (&gpd->domain == dev->pm_domain) {
2136 mutex_unlock(&gpd_list_lock);
2141 dev_dbg(dev, "removing from PM domain %s\n", pd->name);
2144 ret = pm_genpd_remove_device(pd, dev);
2151 dev_err(dev, "failed to remove from PM domain %s: %d",
2156 /* Check if PM domain can be powered off after removing this device. */
2157 genpd_queue_power_off_work(pd);
2161 * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
2162 * @dev: Device to attach.
2164 * Parse device's OF node to find a PM domain specifier. If such is found,
2165 * attaches the device to retrieved pm_domain ops.
2167 * Both generic and legacy Samsung-specific DT bindings are supported to keep
2168 * backwards compatibility with existing DTBs.
2170 * Returns 0 on successfully attached PM domain or negative error code.
2172 int genpd_dev_pm_attach(struct device *dev)
2174 struct of_phandle_args pd_args;
2175 struct generic_pm_domain *pd;
2184 ret = of_parse_phandle_with_args(dev->of_node, "power-domains",
2185 "#power-domain-cells", 0, &pd_args);
2191 * Try legacy Samsung-specific bindings
2192 * (for backwards compatibility of DT ABI)
2194 pd_args.args_count = 0;
2195 pd_args.np = of_parse_phandle(dev->of_node,
2196 "samsung,power-domain", 0);
2201 pd = of_genpd_get_from_provider(&pd_args);
2203 dev_dbg(dev, "%s() failed to find PM domain: %ld\n",
2204 __func__, PTR_ERR(pd));
2205 of_node_put(dev->of_node);
2209 dev_dbg(dev, "adding to PM domain %s\n", pd->name);
2212 ret = pm_genpd_add_device(pd, dev);
2219 dev_err(dev, "failed to add to PM domain %s: %d",
2221 of_node_put(dev->of_node);
2225 dev->pm_domain->detach = genpd_dev_pm_detach;
2226 pm_genpd_poweron(pd);
2230 EXPORT_SYMBOL_GPL(genpd_dev_pm_attach);
2231 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
2234 /*** debugfs support ***/
2236 #ifdef CONFIG_PM_ADVANCED_DEBUG
2237 #include <linux/pm.h>
2238 #include <linux/device.h>
2239 #include <linux/debugfs.h>
2240 #include <linux/seq_file.h>
2241 #include <linux/init.h>
2242 #include <linux/kobject.h>
2243 static struct dentry *pm_genpd_debugfs_dir;
2246 * TODO: This function is a slightly modified version of rtpm_status_show
2247 * from sysfs.c, so generalize it.
2249 static void rtpm_status_str(struct seq_file *s, struct device *dev)
2251 static const char * const status_lookup[] = {
2252 [RPM_ACTIVE] = "active",
2253 [RPM_RESUMING] = "resuming",
2254 [RPM_SUSPENDED] = "suspended",
2255 [RPM_SUSPENDING] = "suspending"
2259 if (dev->power.runtime_error)
2261 else if (dev->power.disable_depth)
2263 else if (dev->power.runtime_status < ARRAY_SIZE(status_lookup))
2264 p = status_lookup[dev->power.runtime_status];
2271 static int pm_genpd_summary_one(struct seq_file *s,
2272 struct generic_pm_domain *gpd)
2274 static const char * const status_lookup[] = {
2275 [GPD_STATE_ACTIVE] = "on",
2276 [GPD_STATE_WAIT_MASTER] = "wait-master",
2277 [GPD_STATE_BUSY] = "busy",
2278 [GPD_STATE_REPEAT] = "off-in-progress",
2279 [GPD_STATE_POWER_OFF] = "off"
2281 struct pm_domain_data *pm_data;
2282 const char *kobj_path;
2283 struct gpd_link *link;
2286 ret = mutex_lock_interruptible(&gpd->lock);
2288 return -ERESTARTSYS;
2290 if (WARN_ON(gpd->status >= ARRAY_SIZE(status_lookup)))
2292 seq_printf(s, "%-30s %-15s ", gpd->name, status_lookup[gpd->status]);
2295 * Modifications on the list require holding locks on both
2296 * master and slave, so we are safe.
2297 * Also gpd->name is immutable.
2299 list_for_each_entry(link, &gpd->master_links, master_node) {
2300 seq_printf(s, "%s", link->slave->name);
2301 if (!list_is_last(&link->master_node, &gpd->master_links))
2305 list_for_each_entry(pm_data, &gpd->dev_list, list_node) {
2306 kobj_path = kobject_get_path(&pm_data->dev->kobj, GFP_KERNEL);
2307 if (kobj_path == NULL)
2310 seq_printf(s, "\n %-50s ", kobj_path);
2311 rtpm_status_str(s, pm_data->dev);
2317 mutex_unlock(&gpd->lock);
2322 static int pm_genpd_summary_show(struct seq_file *s, void *data)
2324 struct generic_pm_domain *gpd;
2327 seq_puts(s, " domain status slaves\n");
2328 seq_puts(s, " /device runtime status\n");
2329 seq_puts(s, "----------------------------------------------------------------------\n");
2331 ret = mutex_lock_interruptible(&gpd_list_lock);
2333 return -ERESTARTSYS;
2335 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
2336 ret = pm_genpd_summary_one(s, gpd);
2340 mutex_unlock(&gpd_list_lock);
2345 static int pm_genpd_summary_open(struct inode *inode, struct file *file)
2347 return single_open(file, pm_genpd_summary_show, NULL);
2350 static const struct file_operations pm_genpd_summary_fops = {
2351 .open = pm_genpd_summary_open,
2353 .llseek = seq_lseek,
2354 .release = single_release,
2357 static int __init pm_genpd_debug_init(void)
2361 pm_genpd_debugfs_dir = debugfs_create_dir("pm_genpd", NULL);
2363 if (!pm_genpd_debugfs_dir)
2366 d = debugfs_create_file("pm_genpd_summary", S_IRUGO,
2367 pm_genpd_debugfs_dir, NULL, &pm_genpd_summary_fops);
2373 late_initcall(pm_genpd_debug_init);
2375 static void __exit pm_genpd_debug_exit(void)
2377 debugfs_remove_recursive(pm_genpd_debugfs_dir);
2379 __exitcall(pm_genpd_debug_exit);
2380 #endif /* CONFIG_PM_ADVANCED_DEBUG */