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/init.h>
10 #include <linux/kernel.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/pm_domain.h>
14 #include <linux/pm_qos.h>
15 #include <linux/slab.h>
16 #include <linux/err.h>
17 #include <linux/sched.h>
18 #include <linux/suspend.h>
19 #include <linux/export.h>
21 #define GENPD_DEV_CALLBACK(genpd, type, callback, dev) \
23 type (*__routine)(struct device *__d); \
24 type __ret = (type)0; \
26 __routine = genpd->dev_ops.callback; \
28 __ret = __routine(dev); \
30 __routine = dev_gpd_data(dev)->ops.callback; \
32 __ret = __routine(dev); \
37 #define GENPD_DEV_TIMED_CALLBACK(genpd, type, callback, dev, field, name) \
39 ktime_t __start = ktime_get(); \
40 type __retval = GENPD_DEV_CALLBACK(genpd, type, callback, dev); \
41 s64 __elapsed = ktime_to_ns(ktime_sub(ktime_get(), __start)); \
42 struct gpd_timing_data *__td = &dev_gpd_data(dev)->td; \
43 if (!__retval && __elapsed > __td->field) { \
44 __td->field = __elapsed; \
45 dev_warn(dev, name " latency exceeded, new value %lld ns\n", \
47 genpd->max_off_time_changed = true; \
48 __td->constraint_changed = true; \
53 static LIST_HEAD(gpd_list);
54 static DEFINE_MUTEX(gpd_list_lock);
56 static struct generic_pm_domain *pm_genpd_lookup_name(const char *domain_name)
58 struct generic_pm_domain *genpd = NULL, *gpd;
60 if (IS_ERR_OR_NULL(domain_name))
63 mutex_lock(&gpd_list_lock);
64 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
65 if (!strcmp(gpd->name, domain_name)) {
70 mutex_unlock(&gpd_list_lock);
76 struct generic_pm_domain *dev_to_genpd(struct device *dev)
78 if (IS_ERR_OR_NULL(dev->pm_domain))
79 return ERR_PTR(-EINVAL);
81 return pd_to_genpd(dev->pm_domain);
84 static int genpd_stop_dev(struct generic_pm_domain *genpd, struct device *dev)
86 return GENPD_DEV_TIMED_CALLBACK(genpd, int, stop, dev,
87 stop_latency_ns, "stop");
90 static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev)
92 return GENPD_DEV_TIMED_CALLBACK(genpd, int, start, dev,
93 start_latency_ns, "start");
96 static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
100 if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
101 ret = !!atomic_dec_and_test(&genpd->sd_count);
106 static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
108 atomic_inc(&genpd->sd_count);
109 smp_mb__after_atomic_inc();
112 static void genpd_acquire_lock(struct generic_pm_domain *genpd)
116 mutex_lock(&genpd->lock);
118 * Wait for the domain to transition into either the active,
119 * or the power off state.
122 prepare_to_wait(&genpd->status_wait_queue, &wait,
123 TASK_UNINTERRUPTIBLE);
124 if (genpd->status == GPD_STATE_ACTIVE
125 || genpd->status == GPD_STATE_POWER_OFF)
127 mutex_unlock(&genpd->lock);
131 mutex_lock(&genpd->lock);
133 finish_wait(&genpd->status_wait_queue, &wait);
136 static void genpd_release_lock(struct generic_pm_domain *genpd)
138 mutex_unlock(&genpd->lock);
141 static void genpd_set_active(struct generic_pm_domain *genpd)
143 if (genpd->resume_count == 0)
144 genpd->status = GPD_STATE_ACTIVE;
147 static void genpd_recalc_cpu_exit_latency(struct generic_pm_domain *genpd)
151 if (!genpd->cpu_data)
154 usecs64 = genpd->power_on_latency_ns;
155 do_div(usecs64, NSEC_PER_USEC);
156 usecs64 += genpd->cpu_data->saved_exit_latency;
157 genpd->cpu_data->idle_state->exit_latency = usecs64;
161 * __pm_genpd_poweron - Restore power to a given PM domain and its masters.
162 * @genpd: PM domain to power up.
164 * Restore power to @genpd and all of its masters so that it is possible to
165 * resume a device belonging to it.
167 static int __pm_genpd_poweron(struct generic_pm_domain *genpd)
168 __releases(&genpd->lock) __acquires(&genpd->lock)
170 struct gpd_link *link;
174 /* If the domain's master is being waited for, we have to wait too. */
176 prepare_to_wait(&genpd->status_wait_queue, &wait,
177 TASK_UNINTERRUPTIBLE);
178 if (genpd->status != GPD_STATE_WAIT_MASTER)
180 mutex_unlock(&genpd->lock);
184 mutex_lock(&genpd->lock);
186 finish_wait(&genpd->status_wait_queue, &wait);
188 if (genpd->status == GPD_STATE_ACTIVE
189 || (genpd->prepared_count > 0 && genpd->suspend_power_off))
192 if (genpd->status != GPD_STATE_POWER_OFF) {
193 genpd_set_active(genpd);
197 if (genpd->cpu_data) {
198 cpuidle_pause_and_lock();
199 genpd->cpu_data->idle_state->disabled = true;
200 cpuidle_resume_and_unlock();
205 * The list is guaranteed not to change while the loop below is being
206 * executed, unless one of the masters' .power_on() callbacks fiddles
209 list_for_each_entry(link, &genpd->slave_links, slave_node) {
210 genpd_sd_counter_inc(link->master);
211 genpd->status = GPD_STATE_WAIT_MASTER;
213 mutex_unlock(&genpd->lock);
215 ret = pm_genpd_poweron(link->master);
217 mutex_lock(&genpd->lock);
220 * The "wait for parent" status is guaranteed not to change
221 * while the master is powering on.
223 genpd->status = GPD_STATE_POWER_OFF;
224 wake_up_all(&genpd->status_wait_queue);
226 genpd_sd_counter_dec(link->master);
231 if (genpd->power_on) {
232 ktime_t time_start = ktime_get();
235 ret = genpd->power_on(genpd);
239 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
240 if (elapsed_ns > genpd->power_on_latency_ns) {
241 genpd->power_on_latency_ns = elapsed_ns;
242 genpd->max_off_time_changed = true;
243 genpd_recalc_cpu_exit_latency(genpd);
245 pr_warning("%s: Power-on latency exceeded, "
246 "new value %lld ns\n", genpd->name,
252 genpd_set_active(genpd);
257 list_for_each_entry_continue_reverse(link, &genpd->slave_links, slave_node)
258 genpd_sd_counter_dec(link->master);
264 * pm_genpd_poweron - Restore power to a given PM domain and its masters.
265 * @genpd: PM domain to power up.
267 int pm_genpd_poweron(struct generic_pm_domain *genpd)
271 mutex_lock(&genpd->lock);
272 ret = __pm_genpd_poweron(genpd);
273 mutex_unlock(&genpd->lock);
278 * pm_genpd_name_poweron - Restore power to a given PM domain and its masters.
279 * @domain_name: Name of the PM domain to power up.
281 int pm_genpd_name_poweron(const char *domain_name)
283 struct generic_pm_domain *genpd;
285 genpd = pm_genpd_lookup_name(domain_name);
286 return genpd ? pm_genpd_poweron(genpd) : -EINVAL;
289 #endif /* CONFIG_PM */
291 #ifdef CONFIG_PM_RUNTIME
293 static int genpd_start_dev_no_timing(struct generic_pm_domain *genpd,
296 return GENPD_DEV_CALLBACK(genpd, int, start, dev);
299 static int genpd_save_dev(struct generic_pm_domain *genpd, struct device *dev)
301 return GENPD_DEV_TIMED_CALLBACK(genpd, int, save_state, dev,
302 save_state_latency_ns, "state save");
305 static int genpd_restore_dev(struct generic_pm_domain *genpd, struct device *dev)
307 return GENPD_DEV_TIMED_CALLBACK(genpd, int, restore_state, dev,
308 restore_state_latency_ns,
312 static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
313 unsigned long val, void *ptr)
315 struct generic_pm_domain_data *gpd_data;
318 gpd_data = container_of(nb, struct generic_pm_domain_data, nb);
320 mutex_lock(&gpd_data->lock);
321 dev = gpd_data->base.dev;
323 mutex_unlock(&gpd_data->lock);
326 mutex_unlock(&gpd_data->lock);
329 struct generic_pm_domain *genpd;
330 struct pm_domain_data *pdd;
332 spin_lock_irq(&dev->power.lock);
334 pdd = dev->power.subsys_data ?
335 dev->power.subsys_data->domain_data : NULL;
336 if (pdd && pdd->dev) {
337 to_gpd_data(pdd)->td.constraint_changed = true;
338 genpd = dev_to_genpd(dev);
340 genpd = ERR_PTR(-ENODATA);
343 spin_unlock_irq(&dev->power.lock);
345 if (!IS_ERR(genpd)) {
346 mutex_lock(&genpd->lock);
347 genpd->max_off_time_changed = true;
348 mutex_unlock(&genpd->lock);
352 if (!dev || dev->power.ignore_children)
360 * __pm_genpd_save_device - Save the pre-suspend state of a device.
361 * @pdd: Domain data of the device to save the state of.
362 * @genpd: PM domain the device belongs to.
364 static int __pm_genpd_save_device(struct pm_domain_data *pdd,
365 struct generic_pm_domain *genpd)
366 __releases(&genpd->lock) __acquires(&genpd->lock)
368 struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
369 struct device *dev = pdd->dev;
372 if (gpd_data->need_restore)
375 mutex_unlock(&genpd->lock);
377 genpd_start_dev(genpd, dev);
378 ret = genpd_save_dev(genpd, dev);
379 genpd_stop_dev(genpd, dev);
381 mutex_lock(&genpd->lock);
384 gpd_data->need_restore = true;
390 * __pm_genpd_restore_device - Restore the pre-suspend state of a device.
391 * @pdd: Domain data of the device to restore the state of.
392 * @genpd: PM domain the device belongs to.
394 static void __pm_genpd_restore_device(struct pm_domain_data *pdd,
395 struct generic_pm_domain *genpd)
396 __releases(&genpd->lock) __acquires(&genpd->lock)
398 struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
399 struct device *dev = pdd->dev;
400 bool need_restore = gpd_data->need_restore;
402 gpd_data->need_restore = false;
403 mutex_unlock(&genpd->lock);
405 genpd_start_dev(genpd, dev);
407 genpd_restore_dev(genpd, dev);
409 mutex_lock(&genpd->lock);
413 * genpd_abort_poweroff - Check if a PM domain power off should be aborted.
414 * @genpd: PM domain to check.
416 * Return true if a PM domain's status changed to GPD_STATE_ACTIVE during
417 * a "power off" operation, which means that a "power on" has occured in the
418 * meantime, or if its resume_count field is different from zero, which means
419 * that one of its devices has been resumed in the meantime.
421 static bool genpd_abort_poweroff(struct generic_pm_domain *genpd)
423 return genpd->status == GPD_STATE_WAIT_MASTER
424 || genpd->status == GPD_STATE_ACTIVE || genpd->resume_count > 0;
428 * genpd_queue_power_off_work - Queue up the execution of pm_genpd_poweroff().
429 * @genpd: PM domait to power off.
431 * Queue up the execution of pm_genpd_poweroff() unless it's already been done
434 void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
436 if (!work_pending(&genpd->power_off_work))
437 queue_work(pm_wq, &genpd->power_off_work);
441 * pm_genpd_poweroff - Remove power from a given PM domain.
442 * @genpd: PM domain to power down.
444 * If all of the @genpd's devices have been suspended and all of its subdomains
445 * have been powered down, run the runtime suspend callbacks provided by all of
446 * the @genpd's devices' drivers and remove power from @genpd.
448 static int pm_genpd_poweroff(struct generic_pm_domain *genpd)
449 __releases(&genpd->lock) __acquires(&genpd->lock)
451 struct pm_domain_data *pdd;
452 struct gpd_link *link;
453 unsigned int not_suspended;
458 * Do not try to power off the domain in the following situations:
459 * (1) The domain is already in the "power off" state.
460 * (2) The domain is waiting for its master to power up.
461 * (3) One of the domain's devices is being resumed right now.
462 * (4) System suspend is in progress.
464 if (genpd->status == GPD_STATE_POWER_OFF
465 || genpd->status == GPD_STATE_WAIT_MASTER
466 || genpd->resume_count > 0 || genpd->prepared_count > 0)
469 if (atomic_read(&genpd->sd_count) > 0)
473 list_for_each_entry(pdd, &genpd->dev_list, list_node) {
474 enum pm_qos_flags_status stat;
476 stat = dev_pm_qos_flags(pdd->dev,
477 PM_QOS_FLAG_NO_POWER_OFF
478 | PM_QOS_FLAG_REMOTE_WAKEUP);
479 if (stat > PM_QOS_FLAGS_NONE)
482 if (pdd->dev->driver && (!pm_runtime_suspended(pdd->dev)
483 || pdd->dev->power.irq_safe))
487 if (not_suspended > genpd->in_progress)
490 if (genpd->poweroff_task) {
492 * Another instance of pm_genpd_poweroff() is executing
493 * callbacks, so tell it to start over and return.
495 genpd->status = GPD_STATE_REPEAT;
499 if (genpd->gov && genpd->gov->power_down_ok) {
500 if (!genpd->gov->power_down_ok(&genpd->domain))
504 genpd->status = GPD_STATE_BUSY;
505 genpd->poweroff_task = current;
507 list_for_each_entry_reverse(pdd, &genpd->dev_list, list_node) {
508 ret = atomic_read(&genpd->sd_count) == 0 ?
509 __pm_genpd_save_device(pdd, genpd) : -EBUSY;
511 if (genpd_abort_poweroff(genpd))
515 genpd_set_active(genpd);
519 if (genpd->status == GPD_STATE_REPEAT) {
520 genpd->poweroff_task = NULL;
525 if (genpd->cpu_data) {
527 * If cpu_data is set, cpuidle should turn the domain off when
528 * the CPU in it is idle. In that case we don't decrement the
529 * subdomain counts of the master domains, so that power is not
530 * removed from the current domain prematurely as a result of
531 * cutting off the masters' power.
533 genpd->status = GPD_STATE_POWER_OFF;
534 cpuidle_pause_and_lock();
535 genpd->cpu_data->idle_state->disabled = false;
536 cpuidle_resume_and_unlock();
540 if (genpd->power_off) {
544 if (atomic_read(&genpd->sd_count) > 0) {
549 time_start = ktime_get();
552 * If sd_count > 0 at this point, one of the subdomains hasn't
553 * managed to call pm_genpd_poweron() for the master yet after
554 * incrementing it. In that case pm_genpd_poweron() will wait
555 * for us to drop the lock, so we can call .power_off() and let
556 * the pm_genpd_poweron() restore power for us (this shouldn't
557 * happen very often).
559 ret = genpd->power_off(genpd);
561 genpd_set_active(genpd);
565 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
566 if (elapsed_ns > genpd->power_off_latency_ns) {
567 genpd->power_off_latency_ns = elapsed_ns;
568 genpd->max_off_time_changed = true;
570 pr_warning("%s: Power-off latency exceeded, "
571 "new value %lld ns\n", genpd->name,
576 genpd->status = GPD_STATE_POWER_OFF;
578 list_for_each_entry(link, &genpd->slave_links, slave_node) {
579 genpd_sd_counter_dec(link->master);
580 genpd_queue_power_off_work(link->master);
584 genpd->poweroff_task = NULL;
585 wake_up_all(&genpd->status_wait_queue);
590 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
591 * @work: Work structure used for scheduling the execution of this function.
593 static void genpd_power_off_work_fn(struct work_struct *work)
595 struct generic_pm_domain *genpd;
597 genpd = container_of(work, struct generic_pm_domain, power_off_work);
599 genpd_acquire_lock(genpd);
600 pm_genpd_poweroff(genpd);
601 genpd_release_lock(genpd);
605 * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
606 * @dev: Device to suspend.
608 * Carry out a runtime suspend of a device under the assumption that its
609 * pm_domain field points to the domain member of an object of type
610 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
612 static int pm_genpd_runtime_suspend(struct device *dev)
614 struct generic_pm_domain *genpd;
615 bool (*stop_ok)(struct device *__dev);
618 dev_dbg(dev, "%s()\n", __func__);
620 genpd = dev_to_genpd(dev);
624 might_sleep_if(!genpd->dev_irq_safe);
626 stop_ok = genpd->gov ? genpd->gov->stop_ok : NULL;
627 if (stop_ok && !stop_ok(dev))
630 ret = genpd_stop_dev(genpd, dev);
635 * If power.irq_safe is set, this routine will be run with interrupts
636 * off, so it can't use mutexes.
638 if (dev->power.irq_safe)
641 mutex_lock(&genpd->lock);
642 genpd->in_progress++;
643 pm_genpd_poweroff(genpd);
644 genpd->in_progress--;
645 mutex_unlock(&genpd->lock);
651 * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
652 * @dev: Device to resume.
654 * Carry out a runtime resume of a device under the assumption that its
655 * pm_domain field points to the domain member of an object of type
656 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
658 static int pm_genpd_runtime_resume(struct device *dev)
660 struct generic_pm_domain *genpd;
664 dev_dbg(dev, "%s()\n", __func__);
666 genpd = dev_to_genpd(dev);
670 might_sleep_if(!genpd->dev_irq_safe);
672 /* If power.irq_safe, the PM domain is never powered off. */
673 if (dev->power.irq_safe)
674 return genpd_start_dev_no_timing(genpd, dev);
676 mutex_lock(&genpd->lock);
677 ret = __pm_genpd_poweron(genpd);
679 mutex_unlock(&genpd->lock);
682 genpd->status = GPD_STATE_BUSY;
683 genpd->resume_count++;
685 prepare_to_wait(&genpd->status_wait_queue, &wait,
686 TASK_UNINTERRUPTIBLE);
688 * If current is the powering off task, we have been called
689 * reentrantly from one of the device callbacks, so we should
692 if (!genpd->poweroff_task || genpd->poweroff_task == current)
694 mutex_unlock(&genpd->lock);
698 mutex_lock(&genpd->lock);
700 finish_wait(&genpd->status_wait_queue, &wait);
701 __pm_genpd_restore_device(dev->power.subsys_data->domain_data, genpd);
702 genpd->resume_count--;
703 genpd_set_active(genpd);
704 wake_up_all(&genpd->status_wait_queue);
705 mutex_unlock(&genpd->lock);
711 * pm_genpd_poweroff_unused - Power off all PM domains with no devices in use.
713 void pm_genpd_poweroff_unused(void)
715 struct generic_pm_domain *genpd;
717 mutex_lock(&gpd_list_lock);
719 list_for_each_entry(genpd, &gpd_list, gpd_list_node)
720 genpd_queue_power_off_work(genpd);
722 mutex_unlock(&gpd_list_lock);
727 static inline int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
728 unsigned long val, void *ptr)
733 static inline void genpd_power_off_work_fn(struct work_struct *work) {}
735 #define pm_genpd_runtime_suspend NULL
736 #define pm_genpd_runtime_resume NULL
738 #endif /* CONFIG_PM_RUNTIME */
740 #ifdef CONFIG_PM_SLEEP
743 * pm_genpd_present - Check if the given PM domain has been initialized.
744 * @genpd: PM domain to check.
746 static bool pm_genpd_present(struct generic_pm_domain *genpd)
748 struct generic_pm_domain *gpd;
750 if (IS_ERR_OR_NULL(genpd))
753 list_for_each_entry(gpd, &gpd_list, gpd_list_node)
760 static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
763 return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
766 static int genpd_suspend_dev(struct generic_pm_domain *genpd, struct device *dev)
768 return GENPD_DEV_CALLBACK(genpd, int, suspend, dev);
771 static int genpd_suspend_late(struct generic_pm_domain *genpd, struct device *dev)
773 return GENPD_DEV_CALLBACK(genpd, int, suspend_late, dev);
776 static int genpd_resume_early(struct generic_pm_domain *genpd, struct device *dev)
778 return GENPD_DEV_CALLBACK(genpd, int, resume_early, dev);
781 static int genpd_resume_dev(struct generic_pm_domain *genpd, struct device *dev)
783 return GENPD_DEV_CALLBACK(genpd, int, resume, dev);
786 static int genpd_freeze_dev(struct generic_pm_domain *genpd, struct device *dev)
788 return GENPD_DEV_CALLBACK(genpd, int, freeze, dev);
791 static int genpd_freeze_late(struct generic_pm_domain *genpd, struct device *dev)
793 return GENPD_DEV_CALLBACK(genpd, int, freeze_late, dev);
796 static int genpd_thaw_early(struct generic_pm_domain *genpd, struct device *dev)
798 return GENPD_DEV_CALLBACK(genpd, int, thaw_early, dev);
801 static int genpd_thaw_dev(struct generic_pm_domain *genpd, struct device *dev)
803 return GENPD_DEV_CALLBACK(genpd, int, thaw, dev);
807 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
808 * @genpd: PM domain to power off, if possible.
810 * Check if the given PM domain can be powered off (during system suspend or
811 * hibernation) and do that if so. Also, in that case propagate to its masters.
813 * This function is only called in "noirq" and "syscore" stages of system power
814 * transitions, so it need not acquire locks (all of the "noirq" callbacks are
815 * executed sequentially, so it is guaranteed that it will never run twice in
818 static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd)
820 struct gpd_link *link;
822 if (genpd->status == GPD_STATE_POWER_OFF)
825 if (genpd->suspended_count != genpd->device_count
826 || atomic_read(&genpd->sd_count) > 0)
829 if (genpd->power_off)
830 genpd->power_off(genpd);
832 genpd->status = GPD_STATE_POWER_OFF;
834 list_for_each_entry(link, &genpd->slave_links, slave_node) {
835 genpd_sd_counter_dec(link->master);
836 pm_genpd_sync_poweroff(link->master);
841 * pm_genpd_sync_poweron - Synchronously power on a PM domain and its masters.
842 * @genpd: PM domain to power on.
844 * This function is only called in "noirq" and "syscore" stages of system power
845 * transitions, so it need not acquire locks (all of the "noirq" callbacks are
846 * executed sequentially, so it is guaranteed that it will never run twice in
849 static void pm_genpd_sync_poweron(struct generic_pm_domain *genpd)
851 struct gpd_link *link;
853 if (genpd->status != GPD_STATE_POWER_OFF)
856 list_for_each_entry(link, &genpd->slave_links, slave_node) {
857 pm_genpd_sync_poweron(link->master);
858 genpd_sd_counter_inc(link->master);
862 genpd->power_on(genpd);
864 genpd->status = GPD_STATE_ACTIVE;
868 * resume_needed - Check whether to resume a device before system suspend.
869 * @dev: Device to check.
870 * @genpd: PM domain the device belongs to.
872 * There are two cases in which a device that can wake up the system from sleep
873 * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
874 * to wake up the system and it has to remain active for this purpose while the
875 * system is in the sleep state and (2) if the device is not enabled to wake up
876 * the system from sleep states and it generally doesn't generate wakeup signals
877 * by itself (those signals are generated on its behalf by other parts of the
878 * system). In the latter case it may be necessary to reconfigure the device's
879 * wakeup settings during system suspend, because it may have been set up to
880 * signal remote wakeup from the system's working state as needed by runtime PM.
881 * Return 'true' in either of the above cases.
883 static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
887 if (!device_can_wakeup(dev))
890 active_wakeup = genpd_dev_active_wakeup(genpd, dev);
891 return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
895 * pm_genpd_prepare - Start power transition of a device in a PM domain.
896 * @dev: Device to start the transition of.
898 * Start a power transition of a device (during a system-wide power transition)
899 * under the assumption that its pm_domain field points to the domain member of
900 * an object of type struct generic_pm_domain representing a PM domain
901 * consisting of I/O devices.
903 static int pm_genpd_prepare(struct device *dev)
905 struct generic_pm_domain *genpd;
908 dev_dbg(dev, "%s()\n", __func__);
910 genpd = dev_to_genpd(dev);
915 * If a wakeup request is pending for the device, it should be woken up
916 * at this point and a system wakeup event should be reported if it's
917 * set up to wake up the system from sleep states.
919 pm_runtime_get_noresume(dev);
920 if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
921 pm_wakeup_event(dev, 0);
923 if (pm_wakeup_pending()) {
924 pm_runtime_put_sync(dev);
928 if (resume_needed(dev, genpd))
929 pm_runtime_resume(dev);
931 genpd_acquire_lock(genpd);
933 if (genpd->prepared_count++ == 0) {
934 genpd->suspended_count = 0;
935 genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
938 genpd_release_lock(genpd);
940 if (genpd->suspend_power_off) {
941 pm_runtime_put_noidle(dev);
946 * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
947 * so pm_genpd_poweron() will return immediately, but if the device
948 * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
949 * to make it operational.
951 pm_runtime_resume(dev);
952 __pm_runtime_disable(dev, false);
954 ret = pm_generic_prepare(dev);
956 mutex_lock(&genpd->lock);
958 if (--genpd->prepared_count == 0)
959 genpd->suspend_power_off = false;
961 mutex_unlock(&genpd->lock);
962 pm_runtime_enable(dev);
965 pm_runtime_put_sync(dev);
970 * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
971 * @dev: Device to suspend.
973 * Suspend a device under the assumption that its pm_domain field points to the
974 * domain member of an object of type struct generic_pm_domain representing
975 * a PM domain consisting of I/O devices.
977 static int pm_genpd_suspend(struct device *dev)
979 struct generic_pm_domain *genpd;
981 dev_dbg(dev, "%s()\n", __func__);
983 genpd = dev_to_genpd(dev);
987 return genpd->suspend_power_off ? 0 : genpd_suspend_dev(genpd, dev);
991 * pm_genpd_suspend_late - Late suspend of a device from an I/O PM domain.
992 * @dev: Device to suspend.
994 * Carry out a late suspend of a device under the assumption that its
995 * pm_domain field points to the domain member of an object of type
996 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
998 static int pm_genpd_suspend_late(struct device *dev)
1000 struct generic_pm_domain *genpd;
1002 dev_dbg(dev, "%s()\n", __func__);
1004 genpd = dev_to_genpd(dev);
1008 return genpd->suspend_power_off ? 0 : genpd_suspend_late(genpd, dev);
1012 * pm_genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
1013 * @dev: Device to suspend.
1015 * Stop the device and remove power from the domain if all devices in it have
1018 static int pm_genpd_suspend_noirq(struct device *dev)
1020 struct generic_pm_domain *genpd;
1022 dev_dbg(dev, "%s()\n", __func__);
1024 genpd = dev_to_genpd(dev);
1028 if (genpd->suspend_power_off
1029 || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
1032 genpd_stop_dev(genpd, dev);
1035 * Since all of the "noirq" callbacks are executed sequentially, it is
1036 * guaranteed that this function will never run twice in parallel for
1037 * the same PM domain, so it is not necessary to use locking here.
1039 genpd->suspended_count++;
1040 pm_genpd_sync_poweroff(genpd);
1046 * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
1047 * @dev: Device to resume.
1049 * Restore power to the device's PM domain, if necessary, and start the device.
1051 static int pm_genpd_resume_noirq(struct device *dev)
1053 struct generic_pm_domain *genpd;
1055 dev_dbg(dev, "%s()\n", __func__);
1057 genpd = dev_to_genpd(dev);
1061 if (genpd->suspend_power_off
1062 || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
1066 * Since all of the "noirq" callbacks are executed sequentially, it is
1067 * guaranteed that this function will never run twice in parallel for
1068 * the same PM domain, so it is not necessary to use locking here.
1070 pm_genpd_sync_poweron(genpd);
1071 genpd->suspended_count--;
1073 return genpd_start_dev(genpd, dev);
1077 * pm_genpd_resume_early - Early resume of a device in an I/O PM domain.
1078 * @dev: Device to resume.
1080 * Carry out an early resume of a device under the assumption that its
1081 * pm_domain field points to the domain member of an object of type
1082 * struct generic_pm_domain representing a power domain consisting of I/O
1085 static int pm_genpd_resume_early(struct device *dev)
1087 struct generic_pm_domain *genpd;
1089 dev_dbg(dev, "%s()\n", __func__);
1091 genpd = dev_to_genpd(dev);
1095 return genpd->suspend_power_off ? 0 : genpd_resume_early(genpd, dev);
1099 * pm_genpd_resume - Resume of device in an I/O PM domain.
1100 * @dev: Device to resume.
1102 * Resume a device under the assumption that its pm_domain field points to the
1103 * domain member of an object of type struct generic_pm_domain representing
1104 * a power domain consisting of I/O devices.
1106 static int pm_genpd_resume(struct device *dev)
1108 struct generic_pm_domain *genpd;
1110 dev_dbg(dev, "%s()\n", __func__);
1112 genpd = dev_to_genpd(dev);
1116 return genpd->suspend_power_off ? 0 : genpd_resume_dev(genpd, dev);
1120 * pm_genpd_freeze - Freezing a device in an I/O PM domain.
1121 * @dev: Device to freeze.
1123 * Freeze a device under the assumption that its pm_domain field points to the
1124 * domain member of an object of type struct generic_pm_domain representing
1125 * a power domain consisting of I/O devices.
1127 static int pm_genpd_freeze(struct device *dev)
1129 struct generic_pm_domain *genpd;
1131 dev_dbg(dev, "%s()\n", __func__);
1133 genpd = dev_to_genpd(dev);
1137 return genpd->suspend_power_off ? 0 : genpd_freeze_dev(genpd, dev);
1141 * pm_genpd_freeze_late - Late freeze of a device in an I/O PM domain.
1142 * @dev: Device to freeze.
1144 * Carry out a late freeze of a device under the assumption that its
1145 * pm_domain field points to the domain member of an object of type
1146 * struct generic_pm_domain representing a power domain consisting of I/O
1149 static int pm_genpd_freeze_late(struct device *dev)
1151 struct generic_pm_domain *genpd;
1153 dev_dbg(dev, "%s()\n", __func__);
1155 genpd = dev_to_genpd(dev);
1159 return genpd->suspend_power_off ? 0 : genpd_freeze_late(genpd, dev);
1163 * pm_genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
1164 * @dev: Device to freeze.
1166 * Carry out a late freeze of a device under the assumption that its
1167 * pm_domain field points to the domain member of an object of type
1168 * struct generic_pm_domain representing a power domain consisting of I/O
1171 static int pm_genpd_freeze_noirq(struct device *dev)
1173 struct generic_pm_domain *genpd;
1175 dev_dbg(dev, "%s()\n", __func__);
1177 genpd = dev_to_genpd(dev);
1181 return genpd->suspend_power_off ? 0 : genpd_stop_dev(genpd, dev);
1185 * pm_genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
1186 * @dev: Device to thaw.
1188 * Start the device, unless power has been removed from the domain already
1189 * before the system transition.
1191 static int pm_genpd_thaw_noirq(struct device *dev)
1193 struct generic_pm_domain *genpd;
1195 dev_dbg(dev, "%s()\n", __func__);
1197 genpd = dev_to_genpd(dev);
1201 return genpd->suspend_power_off ? 0 : genpd_start_dev(genpd, dev);
1205 * pm_genpd_thaw_early - Early thaw of device in an I/O PM domain.
1206 * @dev: Device to thaw.
1208 * Carry out an early thaw of a device under the assumption that its
1209 * pm_domain field points to the domain member of an object of type
1210 * struct generic_pm_domain representing a power domain consisting of I/O
1213 static int pm_genpd_thaw_early(struct device *dev)
1215 struct generic_pm_domain *genpd;
1217 dev_dbg(dev, "%s()\n", __func__);
1219 genpd = dev_to_genpd(dev);
1223 return genpd->suspend_power_off ? 0 : genpd_thaw_early(genpd, dev);
1227 * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
1228 * @dev: Device to thaw.
1230 * Thaw a device under the assumption that its pm_domain field points to the
1231 * domain member of an object of type struct generic_pm_domain representing
1232 * a power domain consisting of I/O devices.
1234 static int pm_genpd_thaw(struct device *dev)
1236 struct generic_pm_domain *genpd;
1238 dev_dbg(dev, "%s()\n", __func__);
1240 genpd = dev_to_genpd(dev);
1244 return genpd->suspend_power_off ? 0 : genpd_thaw_dev(genpd, dev);
1248 * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1249 * @dev: Device to resume.
1251 * Make sure the domain will be in the same power state as before the
1252 * hibernation the system is resuming from and start the device if necessary.
1254 static int pm_genpd_restore_noirq(struct device *dev)
1256 struct generic_pm_domain *genpd;
1258 dev_dbg(dev, "%s()\n", __func__);
1260 genpd = dev_to_genpd(dev);
1265 * Since all of the "noirq" callbacks are executed sequentially, it is
1266 * guaranteed that this function will never run twice in parallel for
1267 * the same PM domain, so it is not necessary to use locking here.
1269 * At this point suspended_count == 0 means we are being run for the
1270 * first time for the given domain in the present cycle.
1272 if (genpd->suspended_count++ == 0) {
1274 * The boot kernel might put the domain into arbitrary state,
1275 * so make it appear as powered off to pm_genpd_sync_poweron(),
1276 * so that it tries to power it on in case it was really off.
1278 genpd->status = GPD_STATE_POWER_OFF;
1279 if (genpd->suspend_power_off) {
1281 * If the domain was off before the hibernation, make
1282 * sure it will be off going forward.
1284 if (genpd->power_off)
1285 genpd->power_off(genpd);
1291 if (genpd->suspend_power_off)
1294 pm_genpd_sync_poweron(genpd);
1296 return genpd_start_dev(genpd, dev);
1300 * pm_genpd_complete - Complete power transition of a device in a power domain.
1301 * @dev: Device to complete the transition of.
1303 * Complete a power transition of a device (during a system-wide power
1304 * transition) under the assumption that its pm_domain field points to the
1305 * domain member of an object of type struct generic_pm_domain representing
1306 * a power domain consisting of I/O devices.
1308 static void pm_genpd_complete(struct device *dev)
1310 struct generic_pm_domain *genpd;
1313 dev_dbg(dev, "%s()\n", __func__);
1315 genpd = dev_to_genpd(dev);
1319 mutex_lock(&genpd->lock);
1321 run_complete = !genpd->suspend_power_off;
1322 if (--genpd->prepared_count == 0)
1323 genpd->suspend_power_off = false;
1325 mutex_unlock(&genpd->lock);
1328 pm_generic_complete(dev);
1329 pm_runtime_set_active(dev);
1330 pm_runtime_enable(dev);
1331 pm_runtime_idle(dev);
1336 * pm_genpd_syscore_switch - Switch power during system core suspend or resume.
1337 * @dev: Device that normally is marked as "always on" to switch power for.
1339 * This routine may only be called during the system core (syscore) suspend or
1340 * resume phase for devices whose "always on" flags are set.
1342 void pm_genpd_syscore_switch(struct device *dev, bool suspend)
1344 struct generic_pm_domain *genpd;
1346 genpd = dev_to_genpd(dev);
1347 if (!pm_genpd_present(genpd))
1351 genpd->suspended_count++;
1352 pm_genpd_sync_poweroff(genpd);
1354 pm_genpd_sync_poweron(genpd);
1355 genpd->suspended_count--;
1358 EXPORT_SYMBOL_GPL(pm_genpd_syscore_switch);
1362 #define pm_genpd_prepare NULL
1363 #define pm_genpd_suspend NULL
1364 #define pm_genpd_suspend_late NULL
1365 #define pm_genpd_suspend_noirq NULL
1366 #define pm_genpd_resume_early NULL
1367 #define pm_genpd_resume_noirq NULL
1368 #define pm_genpd_resume NULL
1369 #define pm_genpd_freeze NULL
1370 #define pm_genpd_freeze_late NULL
1371 #define pm_genpd_freeze_noirq NULL
1372 #define pm_genpd_thaw_early NULL
1373 #define pm_genpd_thaw_noirq NULL
1374 #define pm_genpd_thaw NULL
1375 #define pm_genpd_restore_noirq NULL
1376 #define pm_genpd_complete NULL
1378 #endif /* CONFIG_PM_SLEEP */
1380 static struct generic_pm_domain_data *__pm_genpd_alloc_dev_data(struct device *dev)
1382 struct generic_pm_domain_data *gpd_data;
1384 gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
1388 mutex_init(&gpd_data->lock);
1389 gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
1390 dev_pm_qos_add_notifier(dev, &gpd_data->nb);
1394 static void __pm_genpd_free_dev_data(struct device *dev,
1395 struct generic_pm_domain_data *gpd_data)
1397 dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
1402 * __pm_genpd_add_device - Add a device to an I/O PM domain.
1403 * @genpd: PM domain to add the device to.
1404 * @dev: Device to be added.
1405 * @td: Set of PM QoS timing parameters to attach to the device.
1407 int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1408 struct gpd_timing_data *td)
1410 struct generic_pm_domain_data *gpd_data_new, *gpd_data = NULL;
1411 struct pm_domain_data *pdd;
1414 dev_dbg(dev, "%s()\n", __func__);
1416 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1419 gpd_data_new = __pm_genpd_alloc_dev_data(dev);
1423 genpd_acquire_lock(genpd);
1425 if (genpd->prepared_count > 0) {
1430 list_for_each_entry(pdd, &genpd->dev_list, list_node)
1431 if (pdd->dev == dev) {
1436 ret = dev_pm_get_subsys_data(dev);
1440 genpd->device_count++;
1441 genpd->max_off_time_changed = true;
1443 spin_lock_irq(&dev->power.lock);
1445 dev->pm_domain = &genpd->domain;
1446 if (dev->power.subsys_data->domain_data) {
1447 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
1449 gpd_data = gpd_data_new;
1450 dev->power.subsys_data->domain_data = &gpd_data->base;
1452 gpd_data->refcount++;
1456 spin_unlock_irq(&dev->power.lock);
1458 mutex_lock(&gpd_data->lock);
1459 gpd_data->base.dev = dev;
1460 list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1461 gpd_data->need_restore = genpd->status == GPD_STATE_POWER_OFF;
1462 gpd_data->td.constraint_changed = true;
1463 gpd_data->td.effective_constraint_ns = -1;
1464 mutex_unlock(&gpd_data->lock);
1467 genpd_release_lock(genpd);
1469 if (gpd_data != gpd_data_new)
1470 __pm_genpd_free_dev_data(dev, gpd_data_new);
1476 * __pm_genpd_of_add_device - Add a device to an I/O PM domain.
1477 * @genpd_node: Device tree node pointer representing a PM domain to which the
1478 * the device is added to.
1479 * @dev: Device to be added.
1480 * @td: Set of PM QoS timing parameters to attach to the device.
1482 int __pm_genpd_of_add_device(struct device_node *genpd_node, struct device *dev,
1483 struct gpd_timing_data *td)
1485 struct generic_pm_domain *genpd = NULL, *gpd;
1487 dev_dbg(dev, "%s()\n", __func__);
1489 if (IS_ERR_OR_NULL(genpd_node) || IS_ERR_OR_NULL(dev))
1492 mutex_lock(&gpd_list_lock);
1493 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
1494 if (gpd->of_node == genpd_node) {
1499 mutex_unlock(&gpd_list_lock);
1504 return __pm_genpd_add_device(genpd, dev, td);
1509 * __pm_genpd_name_add_device - Find I/O PM domain and add a device to it.
1510 * @domain_name: Name of the PM domain to add the device to.
1511 * @dev: Device to be added.
1512 * @td: Set of PM QoS timing parameters to attach to the device.
1514 int __pm_genpd_name_add_device(const char *domain_name, struct device *dev,
1515 struct gpd_timing_data *td)
1517 return __pm_genpd_add_device(pm_genpd_lookup_name(domain_name), dev, td);
1521 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1522 * @genpd: PM domain to remove the device from.
1523 * @dev: Device to be removed.
1525 int pm_genpd_remove_device(struct generic_pm_domain *genpd,
1528 struct generic_pm_domain_data *gpd_data;
1529 struct pm_domain_data *pdd;
1530 bool remove = false;
1533 dev_dbg(dev, "%s()\n", __func__);
1535 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev)
1536 || IS_ERR_OR_NULL(dev->pm_domain)
1537 || pd_to_genpd(dev->pm_domain) != genpd)
1540 genpd_acquire_lock(genpd);
1542 if (genpd->prepared_count > 0) {
1547 genpd->device_count--;
1548 genpd->max_off_time_changed = true;
1550 spin_lock_irq(&dev->power.lock);
1552 dev->pm_domain = NULL;
1553 pdd = dev->power.subsys_data->domain_data;
1554 list_del_init(&pdd->list_node);
1555 gpd_data = to_gpd_data(pdd);
1556 if (--gpd_data->refcount == 0) {
1557 dev->power.subsys_data->domain_data = NULL;
1561 spin_unlock_irq(&dev->power.lock);
1563 mutex_lock(&gpd_data->lock);
1565 mutex_unlock(&gpd_data->lock);
1567 genpd_release_lock(genpd);
1569 dev_pm_put_subsys_data(dev);
1571 __pm_genpd_free_dev_data(dev, gpd_data);
1576 genpd_release_lock(genpd);
1582 * pm_genpd_dev_need_restore - Set/unset the device's "need restore" flag.
1583 * @dev: Device to set/unset the flag for.
1584 * @val: The new value of the device's "need restore" flag.
1586 void pm_genpd_dev_need_restore(struct device *dev, bool val)
1588 struct pm_subsys_data *psd;
1589 unsigned long flags;
1591 spin_lock_irqsave(&dev->power.lock, flags);
1593 psd = dev_to_psd(dev);
1594 if (psd && psd->domain_data)
1595 to_gpd_data(psd->domain_data)->need_restore = val;
1597 spin_unlock_irqrestore(&dev->power.lock, flags);
1599 EXPORT_SYMBOL_GPL(pm_genpd_dev_need_restore);
1602 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1603 * @genpd: Master PM domain to add the subdomain to.
1604 * @subdomain: Subdomain to be added.
1606 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1607 struct generic_pm_domain *subdomain)
1609 struct gpd_link *link;
1612 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
1613 || genpd == subdomain)
1617 genpd_acquire_lock(genpd);
1618 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1620 if (subdomain->status != GPD_STATE_POWER_OFF
1621 && subdomain->status != GPD_STATE_ACTIVE) {
1622 mutex_unlock(&subdomain->lock);
1623 genpd_release_lock(genpd);
1627 if (genpd->status == GPD_STATE_POWER_OFF
1628 && subdomain->status != GPD_STATE_POWER_OFF) {
1633 list_for_each_entry(link, &genpd->master_links, master_node) {
1634 if (link->slave == subdomain && link->master == genpd) {
1640 link = kzalloc(sizeof(*link), GFP_KERNEL);
1645 link->master = genpd;
1646 list_add_tail(&link->master_node, &genpd->master_links);
1647 link->slave = subdomain;
1648 list_add_tail(&link->slave_node, &subdomain->slave_links);
1649 if (subdomain->status != GPD_STATE_POWER_OFF)
1650 genpd_sd_counter_inc(genpd);
1653 mutex_unlock(&subdomain->lock);
1654 genpd_release_lock(genpd);
1660 * pm_genpd_add_subdomain_names - Add a subdomain to an I/O PM domain.
1661 * @master_name: Name of the master PM domain to add the subdomain to.
1662 * @subdomain_name: Name of the subdomain to be added.
1664 int pm_genpd_add_subdomain_names(const char *master_name,
1665 const char *subdomain_name)
1667 struct generic_pm_domain *master = NULL, *subdomain = NULL, *gpd;
1669 if (IS_ERR_OR_NULL(master_name) || IS_ERR_OR_NULL(subdomain_name))
1672 mutex_lock(&gpd_list_lock);
1673 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
1674 if (!master && !strcmp(gpd->name, master_name))
1677 if (!subdomain && !strcmp(gpd->name, subdomain_name))
1680 if (master && subdomain)
1683 mutex_unlock(&gpd_list_lock);
1685 return pm_genpd_add_subdomain(master, subdomain);
1689 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1690 * @genpd: Master PM domain to remove the subdomain from.
1691 * @subdomain: Subdomain to be removed.
1693 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1694 struct generic_pm_domain *subdomain)
1696 struct gpd_link *link;
1699 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1703 genpd_acquire_lock(genpd);
1705 list_for_each_entry(link, &genpd->master_links, master_node) {
1706 if (link->slave != subdomain)
1709 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1711 if (subdomain->status != GPD_STATE_POWER_OFF
1712 && subdomain->status != GPD_STATE_ACTIVE) {
1713 mutex_unlock(&subdomain->lock);
1714 genpd_release_lock(genpd);
1718 list_del(&link->master_node);
1719 list_del(&link->slave_node);
1721 if (subdomain->status != GPD_STATE_POWER_OFF)
1722 genpd_sd_counter_dec(genpd);
1724 mutex_unlock(&subdomain->lock);
1730 genpd_release_lock(genpd);
1736 * pm_genpd_add_callbacks - Add PM domain callbacks to a given device.
1737 * @dev: Device to add the callbacks to.
1738 * @ops: Set of callbacks to add.
1739 * @td: Timing data to add to the device along with the callbacks (optional).
1741 * Every call to this routine should be balanced with a call to
1742 * __pm_genpd_remove_callbacks() and they must not be nested.
1744 int pm_genpd_add_callbacks(struct device *dev, struct gpd_dev_ops *ops,
1745 struct gpd_timing_data *td)
1747 struct generic_pm_domain_data *gpd_data_new, *gpd_data = NULL;
1753 gpd_data_new = __pm_genpd_alloc_dev_data(dev);
1757 pm_runtime_disable(dev);
1760 ret = dev_pm_get_subsys_data(dev);
1764 spin_lock_irq(&dev->power.lock);
1766 if (dev->power.subsys_data->domain_data) {
1767 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
1769 gpd_data = gpd_data_new;
1770 dev->power.subsys_data->domain_data = &gpd_data->base;
1772 gpd_data->refcount++;
1773 gpd_data->ops = *ops;
1777 spin_unlock_irq(&dev->power.lock);
1781 pm_runtime_enable(dev);
1783 if (gpd_data != gpd_data_new)
1784 __pm_genpd_free_dev_data(dev, gpd_data_new);
1788 EXPORT_SYMBOL_GPL(pm_genpd_add_callbacks);
1791 * __pm_genpd_remove_callbacks - Remove PM domain callbacks from a given device.
1792 * @dev: Device to remove the callbacks from.
1793 * @clear_td: If set, clear the device's timing data too.
1795 * This routine can only be called after pm_genpd_add_callbacks().
1797 int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
1799 struct generic_pm_domain_data *gpd_data = NULL;
1800 bool remove = false;
1803 if (!(dev && dev->power.subsys_data))
1806 pm_runtime_disable(dev);
1809 spin_lock_irq(&dev->power.lock);
1811 if (dev->power.subsys_data->domain_data) {
1812 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
1813 gpd_data->ops = (struct gpd_dev_ops){ NULL };
1815 gpd_data->td = (struct gpd_timing_data){ 0 };
1817 if (--gpd_data->refcount == 0) {
1818 dev->power.subsys_data->domain_data = NULL;
1825 spin_unlock_irq(&dev->power.lock);
1828 pm_runtime_enable(dev);
1833 dev_pm_put_subsys_data(dev);
1835 __pm_genpd_free_dev_data(dev, gpd_data);
1839 EXPORT_SYMBOL_GPL(__pm_genpd_remove_callbacks);
1842 * pm_genpd_attach_cpuidle - Connect the given PM domain with cpuidle.
1843 * @genpd: PM domain to be connected with cpuidle.
1844 * @state: cpuidle state this domain can disable/enable.
1846 * Make a PM domain behave as though it contained a CPU core, that is, instead
1847 * of calling its power down routine it will enable the given cpuidle state so
1848 * that the cpuidle subsystem can power it down (if possible and desirable).
1850 int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state)
1852 struct cpuidle_driver *cpuidle_drv;
1853 struct gpd_cpu_data *cpu_data;
1854 struct cpuidle_state *idle_state;
1857 if (IS_ERR_OR_NULL(genpd) || state < 0)
1860 genpd_acquire_lock(genpd);
1862 if (genpd->cpu_data) {
1866 cpu_data = kzalloc(sizeof(*cpu_data), GFP_KERNEL);
1871 cpuidle_drv = cpuidle_driver_ref();
1876 if (cpuidle_drv->state_count <= state) {
1880 idle_state = &cpuidle_drv->states[state];
1881 if (!idle_state->disabled) {
1885 cpu_data->idle_state = idle_state;
1886 cpu_data->saved_exit_latency = idle_state->exit_latency;
1887 genpd->cpu_data = cpu_data;
1888 genpd_recalc_cpu_exit_latency(genpd);
1891 genpd_release_lock(genpd);
1895 cpuidle_driver_unref();
1903 * pm_genpd_name_attach_cpuidle - Find PM domain and connect cpuidle to it.
1904 * @name: Name of the domain to connect to cpuidle.
1905 * @state: cpuidle state this domain can manipulate.
1907 int pm_genpd_name_attach_cpuidle(const char *name, int state)
1909 return pm_genpd_attach_cpuidle(pm_genpd_lookup_name(name), state);
1913 * pm_genpd_detach_cpuidle - Remove the cpuidle connection from a PM domain.
1914 * @genpd: PM domain to remove the cpuidle connection from.
1916 * Remove the cpuidle connection set up by pm_genpd_attach_cpuidle() from the
1919 int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
1921 struct gpd_cpu_data *cpu_data;
1922 struct cpuidle_state *idle_state;
1925 if (IS_ERR_OR_NULL(genpd))
1928 genpd_acquire_lock(genpd);
1930 cpu_data = genpd->cpu_data;
1935 idle_state = cpu_data->idle_state;
1936 if (!idle_state->disabled) {
1940 idle_state->exit_latency = cpu_data->saved_exit_latency;
1941 cpuidle_driver_unref();
1942 genpd->cpu_data = NULL;
1946 genpd_release_lock(genpd);
1951 * pm_genpd_name_detach_cpuidle - Find PM domain and disconnect cpuidle from it.
1952 * @name: Name of the domain to disconnect cpuidle from.
1954 int pm_genpd_name_detach_cpuidle(const char *name)
1956 return pm_genpd_detach_cpuidle(pm_genpd_lookup_name(name));
1959 /* Default device callbacks for generic PM domains. */
1962 * pm_genpd_default_save_state - Default "save device state" for PM domians.
1963 * @dev: Device to handle.
1965 static int pm_genpd_default_save_state(struct device *dev)
1967 int (*cb)(struct device *__dev);
1969 cb = dev_gpd_data(dev)->ops.save_state;
1973 if (dev->type && dev->type->pm)
1974 cb = dev->type->pm->runtime_suspend;
1975 else if (dev->class && dev->class->pm)
1976 cb = dev->class->pm->runtime_suspend;
1977 else if (dev->bus && dev->bus->pm)
1978 cb = dev->bus->pm->runtime_suspend;
1982 if (!cb && dev->driver && dev->driver->pm)
1983 cb = dev->driver->pm->runtime_suspend;
1985 return cb ? cb(dev) : 0;
1989 * pm_genpd_default_restore_state - Default PM domians "restore device state".
1990 * @dev: Device to handle.
1992 static int pm_genpd_default_restore_state(struct device *dev)
1994 int (*cb)(struct device *__dev);
1996 cb = dev_gpd_data(dev)->ops.restore_state;
2000 if (dev->type && dev->type->pm)
2001 cb = dev->type->pm->runtime_resume;
2002 else if (dev->class && dev->class->pm)
2003 cb = dev->class->pm->runtime_resume;
2004 else if (dev->bus && dev->bus->pm)
2005 cb = dev->bus->pm->runtime_resume;
2009 if (!cb && dev->driver && dev->driver->pm)
2010 cb = dev->driver->pm->runtime_resume;
2012 return cb ? cb(dev) : 0;
2015 #ifdef CONFIG_PM_SLEEP
2018 * pm_genpd_default_suspend - Default "device suspend" for PM domians.
2019 * @dev: Device to handle.
2021 static int pm_genpd_default_suspend(struct device *dev)
2023 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.suspend;
2025 return cb ? cb(dev) : pm_generic_suspend(dev);
2029 * pm_genpd_default_suspend_late - Default "late device suspend" for PM domians.
2030 * @dev: Device to handle.
2032 static int pm_genpd_default_suspend_late(struct device *dev)
2034 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.suspend_late;
2036 return cb ? cb(dev) : pm_generic_suspend_late(dev);
2040 * pm_genpd_default_resume_early - Default "early device resume" for PM domians.
2041 * @dev: Device to handle.
2043 static int pm_genpd_default_resume_early(struct device *dev)
2045 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.resume_early;
2047 return cb ? cb(dev) : pm_generic_resume_early(dev);
2051 * pm_genpd_default_resume - Default "device resume" for PM domians.
2052 * @dev: Device to handle.
2054 static int pm_genpd_default_resume(struct device *dev)
2056 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.resume;
2058 return cb ? cb(dev) : pm_generic_resume(dev);
2062 * pm_genpd_default_freeze - Default "device freeze" for PM domians.
2063 * @dev: Device to handle.
2065 static int pm_genpd_default_freeze(struct device *dev)
2067 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.freeze;
2069 return cb ? cb(dev) : pm_generic_freeze(dev);
2073 * pm_genpd_default_freeze_late - Default "late device freeze" for PM domians.
2074 * @dev: Device to handle.
2076 static int pm_genpd_default_freeze_late(struct device *dev)
2078 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.freeze_late;
2080 return cb ? cb(dev) : pm_generic_freeze_late(dev);
2084 * pm_genpd_default_thaw_early - Default "early device thaw" for PM domians.
2085 * @dev: Device to handle.
2087 static int pm_genpd_default_thaw_early(struct device *dev)
2089 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.thaw_early;
2091 return cb ? cb(dev) : pm_generic_thaw_early(dev);
2095 * pm_genpd_default_thaw - Default "device thaw" for PM domians.
2096 * @dev: Device to handle.
2098 static int pm_genpd_default_thaw(struct device *dev)
2100 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.thaw;
2102 return cb ? cb(dev) : pm_generic_thaw(dev);
2105 #else /* !CONFIG_PM_SLEEP */
2107 #define pm_genpd_default_suspend NULL
2108 #define pm_genpd_default_suspend_late NULL
2109 #define pm_genpd_default_resume_early NULL
2110 #define pm_genpd_default_resume NULL
2111 #define pm_genpd_default_freeze NULL
2112 #define pm_genpd_default_freeze_late NULL
2113 #define pm_genpd_default_thaw_early NULL
2114 #define pm_genpd_default_thaw NULL
2116 #endif /* !CONFIG_PM_SLEEP */
2119 * pm_genpd_init - Initialize a generic I/O PM domain object.
2120 * @genpd: PM domain object to initialize.
2121 * @gov: PM domain governor to associate with the domain (may be NULL).
2122 * @is_off: Initial value of the domain's power_is_off field.
2124 void pm_genpd_init(struct generic_pm_domain *genpd,
2125 struct dev_power_governor *gov, bool is_off)
2127 if (IS_ERR_OR_NULL(genpd))
2130 INIT_LIST_HEAD(&genpd->master_links);
2131 INIT_LIST_HEAD(&genpd->slave_links);
2132 INIT_LIST_HEAD(&genpd->dev_list);
2133 mutex_init(&genpd->lock);
2135 INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
2136 genpd->in_progress = 0;
2137 atomic_set(&genpd->sd_count, 0);
2138 genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
2139 init_waitqueue_head(&genpd->status_wait_queue);
2140 genpd->poweroff_task = NULL;
2141 genpd->resume_count = 0;
2142 genpd->device_count = 0;
2143 genpd->max_off_time_ns = -1;
2144 genpd->max_off_time_changed = true;
2145 genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
2146 genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
2147 genpd->domain.ops.runtime_idle = pm_generic_runtime_idle;
2148 genpd->domain.ops.prepare = pm_genpd_prepare;
2149 genpd->domain.ops.suspend = pm_genpd_suspend;
2150 genpd->domain.ops.suspend_late = pm_genpd_suspend_late;
2151 genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
2152 genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
2153 genpd->domain.ops.resume_early = pm_genpd_resume_early;
2154 genpd->domain.ops.resume = pm_genpd_resume;
2155 genpd->domain.ops.freeze = pm_genpd_freeze;
2156 genpd->domain.ops.freeze_late = pm_genpd_freeze_late;
2157 genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
2158 genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
2159 genpd->domain.ops.thaw_early = pm_genpd_thaw_early;
2160 genpd->domain.ops.thaw = pm_genpd_thaw;
2161 genpd->domain.ops.poweroff = pm_genpd_suspend;
2162 genpd->domain.ops.poweroff_late = pm_genpd_suspend_late;
2163 genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
2164 genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
2165 genpd->domain.ops.restore_early = pm_genpd_resume_early;
2166 genpd->domain.ops.restore = pm_genpd_resume;
2167 genpd->domain.ops.complete = pm_genpd_complete;
2168 genpd->dev_ops.save_state = pm_genpd_default_save_state;
2169 genpd->dev_ops.restore_state = pm_genpd_default_restore_state;
2170 genpd->dev_ops.suspend = pm_genpd_default_suspend;
2171 genpd->dev_ops.suspend_late = pm_genpd_default_suspend_late;
2172 genpd->dev_ops.resume_early = pm_genpd_default_resume_early;
2173 genpd->dev_ops.resume = pm_genpd_default_resume;
2174 genpd->dev_ops.freeze = pm_genpd_default_freeze;
2175 genpd->dev_ops.freeze_late = pm_genpd_default_freeze_late;
2176 genpd->dev_ops.thaw_early = pm_genpd_default_thaw_early;
2177 genpd->dev_ops.thaw = pm_genpd_default_thaw;
2178 mutex_lock(&gpd_list_lock);
2179 list_add(&genpd->gpd_list_node, &gpd_list);
2180 mutex_unlock(&gpd_list_lock);