2 * drivers/base/power/main.c - Where the driver meets power management.
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
7 * This file is released under the GPLv2
10 * The driver model core calls device_pm_add() when a device is registered.
11 * This will initialize the embedded device_pm_info object in the device
12 * and add it to the list of power-controlled devices. sysfs entries for
13 * controlling device power management will also be added.
15 * A separate list is used for keeping track of power info, because the power
16 * domain dependencies may differ from the ancestral dependencies that the
17 * subsystem list maintains.
20 #include <linux/device.h>
21 #include <linux/kallsyms.h>
22 #include <linux/export.h>
23 #include <linux/mutex.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/pm-trace.h>
27 #include <linux/pm_wakeirq.h>
28 #include <linux/interrupt.h>
29 #include <linux/sched.h>
30 #include <linux/async.h>
31 #include <linux/suspend.h>
32 #include <trace/events/power.h>
33 #include <linux/cpufreq.h>
34 #include <linux/cpuidle.h>
35 #include <linux/timer.h>
36 #include <linux/wakeup_reason.h>
41 typedef int (*pm_callback_t)(struct device *);
44 * The entries in the dpm_list list are in a depth first order, simply
45 * because children are guaranteed to be discovered after parents, and
46 * are inserted at the back of the list on discovery.
48 * Since device_pm_add() may be called with a device lock held,
49 * we must never try to acquire a device lock while holding
54 static LIST_HEAD(dpm_prepared_list);
55 static LIST_HEAD(dpm_suspended_list);
56 static LIST_HEAD(dpm_late_early_list);
57 static LIST_HEAD(dpm_noirq_list);
59 struct suspend_stats suspend_stats;
60 static DEFINE_MUTEX(dpm_list_mtx);
61 static pm_message_t pm_transition;
63 static int async_error;
65 static char *pm_verb(int event)
68 case PM_EVENT_SUSPEND:
74 case PM_EVENT_QUIESCE:
76 case PM_EVENT_HIBERNATE:
80 case PM_EVENT_RESTORE:
82 case PM_EVENT_RECOVER:
85 return "(unknown PM event)";
90 * device_pm_sleep_init - Initialize system suspend-related device fields.
91 * @dev: Device object being initialized.
93 void device_pm_sleep_init(struct device *dev)
95 dev->power.is_prepared = false;
96 dev->power.is_suspended = false;
97 dev->power.is_noirq_suspended = false;
98 dev->power.is_late_suspended = false;
99 init_completion(&dev->power.completion);
100 complete_all(&dev->power.completion);
101 dev->power.wakeup = NULL;
102 INIT_LIST_HEAD(&dev->power.entry);
106 * device_pm_lock - Lock the list of active devices used by the PM core.
108 void device_pm_lock(void)
110 mutex_lock(&dpm_list_mtx);
114 * device_pm_unlock - Unlock the list of active devices used by the PM core.
116 void device_pm_unlock(void)
118 mutex_unlock(&dpm_list_mtx);
122 * device_pm_add - Add a device to the PM core's list of active devices.
123 * @dev: Device to add to the list.
125 void device_pm_add(struct device *dev)
127 pr_debug("PM: Adding info for %s:%s\n",
128 dev->bus ? dev->bus->name : "No Bus", dev_name(dev));
129 mutex_lock(&dpm_list_mtx);
130 if (dev->parent && dev->parent->power.is_prepared)
131 dev_warn(dev, "parent %s should not be sleeping\n",
132 dev_name(dev->parent));
133 list_add_tail(&dev->power.entry, &dpm_list);
134 mutex_unlock(&dpm_list_mtx);
138 * device_pm_remove - Remove a device from the PM core's list of active devices.
139 * @dev: Device to be removed from the list.
141 void device_pm_remove(struct device *dev)
143 pr_debug("PM: Removing info for %s:%s\n",
144 dev->bus ? dev->bus->name : "No Bus", dev_name(dev));
145 complete_all(&dev->power.completion);
146 mutex_lock(&dpm_list_mtx);
147 list_del_init(&dev->power.entry);
148 mutex_unlock(&dpm_list_mtx);
149 device_wakeup_disable(dev);
150 pm_runtime_remove(dev);
154 * device_pm_move_before - Move device in the PM core's list of active devices.
155 * @deva: Device to move in dpm_list.
156 * @devb: Device @deva should come before.
158 void device_pm_move_before(struct device *deva, struct device *devb)
160 pr_debug("PM: Moving %s:%s before %s:%s\n",
161 deva->bus ? deva->bus->name : "No Bus", dev_name(deva),
162 devb->bus ? devb->bus->name : "No Bus", dev_name(devb));
163 /* Delete deva from dpm_list and reinsert before devb. */
164 list_move_tail(&deva->power.entry, &devb->power.entry);
168 * device_pm_move_after - Move device in the PM core's list of active devices.
169 * @deva: Device to move in dpm_list.
170 * @devb: Device @deva should come after.
172 void device_pm_move_after(struct device *deva, struct device *devb)
174 pr_debug("PM: Moving %s:%s after %s:%s\n",
175 deva->bus ? deva->bus->name : "No Bus", dev_name(deva),
176 devb->bus ? devb->bus->name : "No Bus", dev_name(devb));
177 /* Delete deva from dpm_list and reinsert after devb. */
178 list_move(&deva->power.entry, &devb->power.entry);
182 * device_pm_move_last - Move device to end of the PM core's list of devices.
183 * @dev: Device to move in dpm_list.
185 void device_pm_move_last(struct device *dev)
187 pr_debug("PM: Moving %s:%s to end of list\n",
188 dev->bus ? dev->bus->name : "No Bus", dev_name(dev));
189 list_move_tail(&dev->power.entry, &dpm_list);
192 static ktime_t initcall_debug_start(struct device *dev)
194 ktime_t calltime = ktime_set(0, 0);
196 if (pm_print_times_enabled) {
197 pr_info("calling %s+ @ %i, parent: %s\n",
198 dev_name(dev), task_pid_nr(current),
199 dev->parent ? dev_name(dev->parent) : "none");
200 calltime = ktime_get();
206 static void initcall_debug_report(struct device *dev, ktime_t calltime,
207 int error, pm_message_t state, char *info)
212 rettime = ktime_get();
213 nsecs = (s64) ktime_to_ns(ktime_sub(rettime, calltime));
215 if (pm_print_times_enabled) {
216 pr_info("call %s+ returned %d after %Ld usecs\n", dev_name(dev),
217 error, (unsigned long long)nsecs >> 10);
222 * dpm_wait - Wait for a PM operation to complete.
223 * @dev: Device to wait for.
224 * @async: If unset, wait only if the device's power.async_suspend flag is set.
226 static void dpm_wait(struct device *dev, bool async)
231 if (async || (pm_async_enabled && dev->power.async_suspend))
232 wait_for_completion(&dev->power.completion);
235 static int dpm_wait_fn(struct device *dev, void *async_ptr)
237 dpm_wait(dev, *((bool *)async_ptr));
241 static void dpm_wait_for_children(struct device *dev, bool async)
243 device_for_each_child(dev, &async, dpm_wait_fn);
247 * pm_op - Return the PM operation appropriate for given PM event.
248 * @ops: PM operations to choose from.
249 * @state: PM transition of the system being carried out.
251 static pm_callback_t pm_op(const struct dev_pm_ops *ops, pm_message_t state)
253 switch (state.event) {
254 #ifdef CONFIG_SUSPEND
255 case PM_EVENT_SUSPEND:
257 case PM_EVENT_RESUME:
259 #endif /* CONFIG_SUSPEND */
260 #ifdef CONFIG_HIBERNATE_CALLBACKS
261 case PM_EVENT_FREEZE:
262 case PM_EVENT_QUIESCE:
264 case PM_EVENT_HIBERNATE:
265 return ops->poweroff;
267 case PM_EVENT_RECOVER:
270 case PM_EVENT_RESTORE:
272 #endif /* CONFIG_HIBERNATE_CALLBACKS */
279 * pm_late_early_op - Return the PM operation appropriate for given PM event.
280 * @ops: PM operations to choose from.
281 * @state: PM transition of the system being carried out.
283 * Runtime PM is disabled for @dev while this function is being executed.
285 static pm_callback_t pm_late_early_op(const struct dev_pm_ops *ops,
288 switch (state.event) {
289 #ifdef CONFIG_SUSPEND
290 case PM_EVENT_SUSPEND:
291 return ops->suspend_late;
292 case PM_EVENT_RESUME:
293 return ops->resume_early;
294 #endif /* CONFIG_SUSPEND */
295 #ifdef CONFIG_HIBERNATE_CALLBACKS
296 case PM_EVENT_FREEZE:
297 case PM_EVENT_QUIESCE:
298 return ops->freeze_late;
299 case PM_EVENT_HIBERNATE:
300 return ops->poweroff_late;
302 case PM_EVENT_RECOVER:
303 return ops->thaw_early;
304 case PM_EVENT_RESTORE:
305 return ops->restore_early;
306 #endif /* CONFIG_HIBERNATE_CALLBACKS */
313 * pm_noirq_op - Return the PM operation appropriate for given PM event.
314 * @ops: PM operations to choose from.
315 * @state: PM transition of the system being carried out.
317 * The driver of @dev will not receive interrupts while this function is being
320 static pm_callback_t pm_noirq_op(const struct dev_pm_ops *ops, pm_message_t state)
322 switch (state.event) {
323 #ifdef CONFIG_SUSPEND
324 case PM_EVENT_SUSPEND:
325 return ops->suspend_noirq;
326 case PM_EVENT_RESUME:
327 return ops->resume_noirq;
328 #endif /* CONFIG_SUSPEND */
329 #ifdef CONFIG_HIBERNATE_CALLBACKS
330 case PM_EVENT_FREEZE:
331 case PM_EVENT_QUIESCE:
332 return ops->freeze_noirq;
333 case PM_EVENT_HIBERNATE:
334 return ops->poweroff_noirq;
336 case PM_EVENT_RECOVER:
337 return ops->thaw_noirq;
338 case PM_EVENT_RESTORE:
339 return ops->restore_noirq;
340 #endif /* CONFIG_HIBERNATE_CALLBACKS */
346 static void pm_dev_dbg(struct device *dev, pm_message_t state, char *info)
348 dev_dbg(dev, "%s%s%s\n", info, pm_verb(state.event),
349 ((state.event & PM_EVENT_SLEEP) && device_may_wakeup(dev)) ?
350 ", may wakeup" : "");
353 static void pm_dev_err(struct device *dev, pm_message_t state, char *info,
356 printk(KERN_ERR "PM: Device %s failed to %s%s: error %d\n",
357 dev_name(dev), pm_verb(state.event), info, error);
360 static void dpm_show_time(ktime_t starttime, pm_message_t state, char *info)
366 calltime = ktime_get();
367 usecs64 = ktime_to_ns(ktime_sub(calltime, starttime));
368 do_div(usecs64, NSEC_PER_USEC);
372 pr_info("PM: %s%s%s of devices complete after %ld.%03ld msecs\n",
373 info ?: "", info ? " " : "", pm_verb(state.event),
374 usecs / USEC_PER_MSEC, usecs % USEC_PER_MSEC);
377 static int dpm_run_callback(pm_callback_t cb, struct device *dev,
378 pm_message_t state, char *info)
386 calltime = initcall_debug_start(dev);
388 pm_dev_dbg(dev, state, info);
389 trace_device_pm_callback_start(dev, info, state.event);
391 trace_device_pm_callback_end(dev, error);
392 suspend_report_result(cb, error);
394 initcall_debug_report(dev, calltime, error, state, info);
399 #ifdef CONFIG_DPM_WATCHDOG
400 struct dpm_watchdog {
402 struct task_struct *tsk;
403 struct timer_list timer;
406 #define DECLARE_DPM_WATCHDOG_ON_STACK(wd) \
407 struct dpm_watchdog wd
410 * dpm_watchdog_handler - Driver suspend / resume watchdog handler.
411 * @data: Watchdog object address.
413 * Called when a driver has timed out suspending or resuming.
414 * There's not much we can do here to recover so panic() to
415 * capture a crash-dump in pstore.
417 static void dpm_watchdog_handler(unsigned long data)
419 struct dpm_watchdog *wd = (void *)data;
421 dev_emerg(wd->dev, "**** DPM device timeout ****\n");
422 show_stack(wd->tsk, NULL);
423 panic("%s %s: unrecoverable failure\n",
424 dev_driver_string(wd->dev), dev_name(wd->dev));
428 * dpm_watchdog_set - Enable pm watchdog for given device.
429 * @wd: Watchdog. Must be allocated on the stack.
430 * @dev: Device to handle.
432 static void dpm_watchdog_set(struct dpm_watchdog *wd, struct device *dev)
434 struct timer_list *timer = &wd->timer;
439 init_timer_on_stack(timer);
440 /* use same timeout value for both suspend and resume */
441 timer->expires = jiffies + HZ * CONFIG_DPM_WATCHDOG_TIMEOUT;
442 timer->function = dpm_watchdog_handler;
443 timer->data = (unsigned long)wd;
448 * dpm_watchdog_clear - Disable suspend/resume watchdog.
449 * @wd: Watchdog to disable.
451 static void dpm_watchdog_clear(struct dpm_watchdog *wd)
453 struct timer_list *timer = &wd->timer;
455 del_timer_sync(timer);
456 destroy_timer_on_stack(timer);
459 #define DECLARE_DPM_WATCHDOG_ON_STACK(wd)
460 #define dpm_watchdog_set(x, y)
461 #define dpm_watchdog_clear(x)
464 /*------------------------- Resume routines -------------------------*/
467 * device_resume_noirq - Execute an "early resume" callback for given device.
468 * @dev: Device to handle.
469 * @state: PM transition of the system being carried out.
470 * @async: If true, the device is being resumed asynchronously.
472 * The driver of @dev will not receive interrupts while this function is being
475 static int device_resume_noirq(struct device *dev, pm_message_t state, bool async)
477 pm_callback_t callback = NULL;
484 if (dev->power.syscore || dev->power.direct_complete)
487 if (!dev->power.is_noirq_suspended)
490 dpm_wait(dev->parent, async);
492 if (dev->pm_domain) {
493 info = "noirq power domain ";
494 callback = pm_noirq_op(&dev->pm_domain->ops, state);
495 } else if (dev->type && dev->type->pm) {
496 info = "noirq type ";
497 callback = pm_noirq_op(dev->type->pm, state);
498 } else if (dev->class && dev->class->pm) {
499 info = "noirq class ";
500 callback = pm_noirq_op(dev->class->pm, state);
501 } else if (dev->bus && dev->bus->pm) {
503 callback = pm_noirq_op(dev->bus->pm, state);
506 if (!callback && dev->driver && dev->driver->pm) {
507 info = "noirq driver ";
508 callback = pm_noirq_op(dev->driver->pm, state);
511 error = dpm_run_callback(callback, dev, state, info);
512 dev->power.is_noirq_suspended = false;
515 complete_all(&dev->power.completion);
520 static bool is_async(struct device *dev)
522 return dev->power.async_suspend && pm_async_enabled
523 && !pm_trace_is_enabled();
526 static void async_resume_noirq(void *data, async_cookie_t cookie)
528 struct device *dev = (struct device *)data;
531 error = device_resume_noirq(dev, pm_transition, true);
533 pm_dev_err(dev, pm_transition, " async", error);
539 * dpm_resume_noirq - Execute "noirq resume" callbacks for all devices.
540 * @state: PM transition of the system being carried out.
542 * Call the "noirq" resume handlers for all devices in dpm_noirq_list and
543 * enable device drivers to receive interrupts.
545 void dpm_resume_noirq(pm_message_t state)
548 ktime_t starttime = ktime_get();
550 trace_suspend_resume(TPS("dpm_resume_noirq"), state.event, true);
551 mutex_lock(&dpm_list_mtx);
552 pm_transition = state;
555 * Advanced the async threads upfront,
556 * in case the starting of async threads is
557 * delayed by non-async resuming devices.
559 list_for_each_entry(dev, &dpm_noirq_list, power.entry) {
560 reinit_completion(&dev->power.completion);
563 async_schedule(async_resume_noirq, dev);
567 while (!list_empty(&dpm_noirq_list)) {
568 dev = to_device(dpm_noirq_list.next);
570 list_move_tail(&dev->power.entry, &dpm_late_early_list);
571 mutex_unlock(&dpm_list_mtx);
573 if (!is_async(dev)) {
576 error = device_resume_noirq(dev, state, false);
578 suspend_stats.failed_resume_noirq++;
579 dpm_save_failed_step(SUSPEND_RESUME_NOIRQ);
580 dpm_save_failed_dev(dev_name(dev));
581 pm_dev_err(dev, state, " noirq", error);
585 mutex_lock(&dpm_list_mtx);
588 mutex_unlock(&dpm_list_mtx);
589 async_synchronize_full();
590 dpm_show_time(starttime, state, "noirq");
591 resume_device_irqs();
592 device_wakeup_disarm_wake_irqs();
594 trace_suspend_resume(TPS("dpm_resume_noirq"), state.event, false);
598 * device_resume_early - Execute an "early resume" callback for given device.
599 * @dev: Device to handle.
600 * @state: PM transition of the system being carried out.
601 * @async: If true, the device is being resumed asynchronously.
603 * Runtime PM is disabled for @dev while this function is being executed.
605 static int device_resume_early(struct device *dev, pm_message_t state, bool async)
607 pm_callback_t callback = NULL;
614 if (dev->power.syscore || dev->power.direct_complete)
617 if (!dev->power.is_late_suspended)
620 dpm_wait(dev->parent, async);
622 if (dev->pm_domain) {
623 info = "early power domain ";
624 callback = pm_late_early_op(&dev->pm_domain->ops, state);
625 } else if (dev->type && dev->type->pm) {
626 info = "early type ";
627 callback = pm_late_early_op(dev->type->pm, state);
628 } else if (dev->class && dev->class->pm) {
629 info = "early class ";
630 callback = pm_late_early_op(dev->class->pm, state);
631 } else if (dev->bus && dev->bus->pm) {
633 callback = pm_late_early_op(dev->bus->pm, state);
636 if (!callback && dev->driver && dev->driver->pm) {
637 info = "early driver ";
638 callback = pm_late_early_op(dev->driver->pm, state);
641 error = dpm_run_callback(callback, dev, state, info);
642 dev->power.is_late_suspended = false;
647 pm_runtime_enable(dev);
648 complete_all(&dev->power.completion);
652 static void async_resume_early(void *data, async_cookie_t cookie)
654 struct device *dev = (struct device *)data;
657 error = device_resume_early(dev, pm_transition, true);
659 pm_dev_err(dev, pm_transition, " async", error);
665 * dpm_resume_early - Execute "early resume" callbacks for all devices.
666 * @state: PM transition of the system being carried out.
668 void dpm_resume_early(pm_message_t state)
671 ktime_t starttime = ktime_get();
673 trace_suspend_resume(TPS("dpm_resume_early"), state.event, true);
674 mutex_lock(&dpm_list_mtx);
675 pm_transition = state;
678 * Advanced the async threads upfront,
679 * in case the starting of async threads is
680 * delayed by non-async resuming devices.
682 list_for_each_entry(dev, &dpm_late_early_list, power.entry) {
683 reinit_completion(&dev->power.completion);
686 async_schedule(async_resume_early, dev);
690 while (!list_empty(&dpm_late_early_list)) {
691 dev = to_device(dpm_late_early_list.next);
693 list_move_tail(&dev->power.entry, &dpm_suspended_list);
694 mutex_unlock(&dpm_list_mtx);
696 if (!is_async(dev)) {
699 error = device_resume_early(dev, state, false);
701 suspend_stats.failed_resume_early++;
702 dpm_save_failed_step(SUSPEND_RESUME_EARLY);
703 dpm_save_failed_dev(dev_name(dev));
704 pm_dev_err(dev, state, " early", error);
707 mutex_lock(&dpm_list_mtx);
710 mutex_unlock(&dpm_list_mtx);
711 async_synchronize_full();
712 dpm_show_time(starttime, state, "early");
713 trace_suspend_resume(TPS("dpm_resume_early"), state.event, false);
717 * dpm_resume_start - Execute "noirq" and "early" device callbacks.
718 * @state: PM transition of the system being carried out.
720 void dpm_resume_start(pm_message_t state)
722 dpm_resume_noirq(state);
723 dpm_resume_early(state);
725 EXPORT_SYMBOL_GPL(dpm_resume_start);
728 * device_resume - Execute "resume" callbacks for given device.
729 * @dev: Device to handle.
730 * @state: PM transition of the system being carried out.
731 * @async: If true, the device is being resumed asynchronously.
733 static int device_resume(struct device *dev, pm_message_t state, bool async)
735 pm_callback_t callback = NULL;
738 DECLARE_DPM_WATCHDOG_ON_STACK(wd);
743 if (dev->power.syscore)
746 if (dev->power.direct_complete) {
747 /* Match the pm_runtime_disable() in __device_suspend(). */
748 pm_runtime_enable(dev);
752 dpm_wait(dev->parent, async);
753 dpm_watchdog_set(&wd, dev);
757 * This is a fib. But we'll allow new children to be added below
758 * a resumed device, even if the device hasn't been completed yet.
760 dev->power.is_prepared = false;
762 if (!dev->power.is_suspended)
765 if (dev->pm_domain) {
766 info = "power domain ";
767 callback = pm_op(&dev->pm_domain->ops, state);
771 if (dev->type && dev->type->pm) {
773 callback = pm_op(dev->type->pm, state);
778 if (dev->class->pm) {
780 callback = pm_op(dev->class->pm, state);
782 } else if (dev->class->resume) {
783 info = "legacy class ";
784 callback = dev->class->resume;
792 callback = pm_op(dev->bus->pm, state);
793 } else if (dev->bus->resume) {
794 info = "legacy bus ";
795 callback = dev->bus->resume;
801 if (!callback && dev->driver && dev->driver->pm) {
803 callback = pm_op(dev->driver->pm, state);
807 error = dpm_run_callback(callback, dev, state, info);
808 dev->power.is_suspended = false;
812 dpm_watchdog_clear(&wd);
815 complete_all(&dev->power.completion);
822 static void async_resume(void *data, async_cookie_t cookie)
824 struct device *dev = (struct device *)data;
827 error = device_resume(dev, pm_transition, true);
829 pm_dev_err(dev, pm_transition, " async", error);
834 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
835 * @state: PM transition of the system being carried out.
837 * Execute the appropriate "resume" callback for all devices whose status
838 * indicates that they are suspended.
840 void dpm_resume(pm_message_t state)
843 ktime_t starttime = ktime_get();
845 trace_suspend_resume(TPS("dpm_resume"), state.event, true);
848 mutex_lock(&dpm_list_mtx);
849 pm_transition = state;
852 list_for_each_entry(dev, &dpm_suspended_list, power.entry) {
853 reinit_completion(&dev->power.completion);
856 async_schedule(async_resume, dev);
860 while (!list_empty(&dpm_suspended_list)) {
861 dev = to_device(dpm_suspended_list.next);
863 if (!is_async(dev)) {
866 mutex_unlock(&dpm_list_mtx);
868 error = device_resume(dev, state, false);
870 suspend_stats.failed_resume++;
871 dpm_save_failed_step(SUSPEND_RESUME);
872 dpm_save_failed_dev(dev_name(dev));
873 pm_dev_err(dev, state, "", error);
876 mutex_lock(&dpm_list_mtx);
878 if (!list_empty(&dev->power.entry))
879 list_move_tail(&dev->power.entry, &dpm_prepared_list);
882 mutex_unlock(&dpm_list_mtx);
883 async_synchronize_full();
884 dpm_show_time(starttime, state, NULL);
887 trace_suspend_resume(TPS("dpm_resume"), state.event, false);
891 * device_complete - Complete a PM transition for given device.
892 * @dev: Device to handle.
893 * @state: PM transition of the system being carried out.
895 static void device_complete(struct device *dev, pm_message_t state)
897 void (*callback)(struct device *) = NULL;
900 if (dev->power.syscore)
905 if (dev->pm_domain) {
906 info = "completing power domain ";
907 callback = dev->pm_domain->ops.complete;
908 } else if (dev->type && dev->type->pm) {
909 info = "completing type ";
910 callback = dev->type->pm->complete;
911 } else if (dev->class && dev->class->pm) {
912 info = "completing class ";
913 callback = dev->class->pm->complete;
914 } else if (dev->bus && dev->bus->pm) {
915 info = "completing bus ";
916 callback = dev->bus->pm->complete;
919 if (!callback && dev->driver && dev->driver->pm) {
920 info = "completing driver ";
921 callback = dev->driver->pm->complete;
925 pm_dev_dbg(dev, state, info);
935 * dpm_complete - Complete a PM transition for all non-sysdev devices.
936 * @state: PM transition of the system being carried out.
938 * Execute the ->complete() callbacks for all devices whose PM status is not
939 * DPM_ON (this allows new devices to be registered).
941 void dpm_complete(pm_message_t state)
943 struct list_head list;
945 trace_suspend_resume(TPS("dpm_complete"), state.event, true);
948 INIT_LIST_HEAD(&list);
949 mutex_lock(&dpm_list_mtx);
950 while (!list_empty(&dpm_prepared_list)) {
951 struct device *dev = to_device(dpm_prepared_list.prev);
954 dev->power.is_prepared = false;
955 list_move(&dev->power.entry, &list);
956 mutex_unlock(&dpm_list_mtx);
958 trace_device_pm_callback_start(dev, "", state.event);
959 device_complete(dev, state);
960 trace_device_pm_callback_end(dev, 0);
962 mutex_lock(&dpm_list_mtx);
965 list_splice(&list, &dpm_list);
966 mutex_unlock(&dpm_list_mtx);
967 trace_suspend_resume(TPS("dpm_complete"), state.event, false);
971 * dpm_resume_end - Execute "resume" callbacks and complete system transition.
972 * @state: PM transition of the system being carried out.
974 * Execute "resume" callbacks for all devices and complete the PM transition of
977 void dpm_resume_end(pm_message_t state)
982 EXPORT_SYMBOL_GPL(dpm_resume_end);
985 /*------------------------- Suspend routines -------------------------*/
988 * resume_event - Return a "resume" message for given "suspend" sleep state.
989 * @sleep_state: PM message representing a sleep state.
991 * Return a PM message representing the resume event corresponding to given
994 static pm_message_t resume_event(pm_message_t sleep_state)
996 switch (sleep_state.event) {
997 case PM_EVENT_SUSPEND:
999 case PM_EVENT_FREEZE:
1000 case PM_EVENT_QUIESCE:
1001 return PMSG_RECOVER;
1002 case PM_EVENT_HIBERNATE:
1003 return PMSG_RESTORE;
1009 * device_suspend_noirq - Execute a "late suspend" callback for given device.
1010 * @dev: Device to handle.
1011 * @state: PM transition of the system being carried out.
1012 * @async: If true, the device is being suspended asynchronously.
1014 * The driver of @dev will not receive interrupts while this function is being
1017 static int __device_suspend_noirq(struct device *dev, pm_message_t state, bool async)
1019 pm_callback_t callback = NULL;
1029 if (pm_wakeup_pending()) {
1030 async_error = -EBUSY;
1034 if (dev->power.syscore || dev->power.direct_complete)
1037 dpm_wait_for_children(dev, async);
1039 if (dev->pm_domain) {
1040 info = "noirq power domain ";
1041 callback = pm_noirq_op(&dev->pm_domain->ops, state);
1042 } else if (dev->type && dev->type->pm) {
1043 info = "noirq type ";
1044 callback = pm_noirq_op(dev->type->pm, state);
1045 } else if (dev->class && dev->class->pm) {
1046 info = "noirq class ";
1047 callback = pm_noirq_op(dev->class->pm, state);
1048 } else if (dev->bus && dev->bus->pm) {
1049 info = "noirq bus ";
1050 callback = pm_noirq_op(dev->bus->pm, state);
1053 if (!callback && dev->driver && dev->driver->pm) {
1054 info = "noirq driver ";
1055 callback = pm_noirq_op(dev->driver->pm, state);
1058 error = dpm_run_callback(callback, dev, state, info);
1060 dev->power.is_noirq_suspended = true;
1062 async_error = error;
1065 complete_all(&dev->power.completion);
1066 TRACE_SUSPEND(error);
1070 static void async_suspend_noirq(void *data, async_cookie_t cookie)
1072 struct device *dev = (struct device *)data;
1075 error = __device_suspend_noirq(dev, pm_transition, true);
1077 dpm_save_failed_dev(dev_name(dev));
1078 pm_dev_err(dev, pm_transition, " async", error);
1084 static int device_suspend_noirq(struct device *dev)
1086 reinit_completion(&dev->power.completion);
1088 if (is_async(dev)) {
1090 async_schedule(async_suspend_noirq, dev);
1093 return __device_suspend_noirq(dev, pm_transition, false);
1097 * dpm_suspend_noirq - Execute "noirq suspend" callbacks for all devices.
1098 * @state: PM transition of the system being carried out.
1100 * Prevent device drivers from receiving interrupts and call the "noirq" suspend
1101 * handlers for all non-sysdev devices.
1103 int dpm_suspend_noirq(pm_message_t state)
1105 ktime_t starttime = ktime_get();
1108 trace_suspend_resume(TPS("dpm_suspend_noirq"), state.event, true);
1110 device_wakeup_arm_wake_irqs();
1111 suspend_device_irqs();
1112 mutex_lock(&dpm_list_mtx);
1113 pm_transition = state;
1116 while (!list_empty(&dpm_late_early_list)) {
1117 struct device *dev = to_device(dpm_late_early_list.prev);
1120 mutex_unlock(&dpm_list_mtx);
1122 error = device_suspend_noirq(dev);
1124 mutex_lock(&dpm_list_mtx);
1126 pm_dev_err(dev, state, " noirq", error);
1127 dpm_save_failed_dev(dev_name(dev));
1131 if (!list_empty(&dev->power.entry))
1132 list_move(&dev->power.entry, &dpm_noirq_list);
1138 mutex_unlock(&dpm_list_mtx);
1139 async_synchronize_full();
1141 error = async_error;
1144 suspend_stats.failed_suspend_noirq++;
1145 dpm_save_failed_step(SUSPEND_SUSPEND_NOIRQ);
1146 dpm_resume_noirq(resume_event(state));
1148 dpm_show_time(starttime, state, "noirq");
1150 trace_suspend_resume(TPS("dpm_suspend_noirq"), state.event, false);
1155 * device_suspend_late - Execute a "late suspend" callback for given device.
1156 * @dev: Device to handle.
1157 * @state: PM transition of the system being carried out.
1158 * @async: If true, the device is being suspended asynchronously.
1160 * Runtime PM is disabled for @dev while this function is being executed.
1162 static int __device_suspend_late(struct device *dev, pm_message_t state, bool async)
1164 pm_callback_t callback = NULL;
1171 __pm_runtime_disable(dev, false);
1176 if (pm_wakeup_pending()) {
1177 async_error = -EBUSY;
1181 if (dev->power.syscore || dev->power.direct_complete)
1184 dpm_wait_for_children(dev, async);
1186 if (dev->pm_domain) {
1187 info = "late power domain ";
1188 callback = pm_late_early_op(&dev->pm_domain->ops, state);
1189 } else if (dev->type && dev->type->pm) {
1190 info = "late type ";
1191 callback = pm_late_early_op(dev->type->pm, state);
1192 } else if (dev->class && dev->class->pm) {
1193 info = "late class ";
1194 callback = pm_late_early_op(dev->class->pm, state);
1195 } else if (dev->bus && dev->bus->pm) {
1197 callback = pm_late_early_op(dev->bus->pm, state);
1200 if (!callback && dev->driver && dev->driver->pm) {
1201 info = "late driver ";
1202 callback = pm_late_early_op(dev->driver->pm, state);
1205 error = dpm_run_callback(callback, dev, state, info);
1207 dev->power.is_late_suspended = true;
1209 async_error = error;
1212 TRACE_SUSPEND(error);
1213 complete_all(&dev->power.completion);
1217 static void async_suspend_late(void *data, async_cookie_t cookie)
1219 struct device *dev = (struct device *)data;
1222 error = __device_suspend_late(dev, pm_transition, true);
1224 dpm_save_failed_dev(dev_name(dev));
1225 pm_dev_err(dev, pm_transition, " async", error);
1230 static int device_suspend_late(struct device *dev)
1232 reinit_completion(&dev->power.completion);
1234 if (is_async(dev)) {
1236 async_schedule(async_suspend_late, dev);
1240 return __device_suspend_late(dev, pm_transition, false);
1244 * dpm_suspend_late - Execute "late suspend" callbacks for all devices.
1245 * @state: PM transition of the system being carried out.
1247 int dpm_suspend_late(pm_message_t state)
1249 ktime_t starttime = ktime_get();
1252 trace_suspend_resume(TPS("dpm_suspend_late"), state.event, true);
1253 mutex_lock(&dpm_list_mtx);
1254 pm_transition = state;
1257 while (!list_empty(&dpm_suspended_list)) {
1258 struct device *dev = to_device(dpm_suspended_list.prev);
1261 mutex_unlock(&dpm_list_mtx);
1263 error = device_suspend_late(dev);
1265 mutex_lock(&dpm_list_mtx);
1267 pm_dev_err(dev, state, " late", error);
1268 dpm_save_failed_dev(dev_name(dev));
1272 if (!list_empty(&dev->power.entry))
1273 list_move(&dev->power.entry, &dpm_late_early_list);
1279 mutex_unlock(&dpm_list_mtx);
1280 async_synchronize_full();
1282 error = async_error;
1284 suspend_stats.failed_suspend_late++;
1285 dpm_save_failed_step(SUSPEND_SUSPEND_LATE);
1286 dpm_resume_early(resume_event(state));
1288 dpm_show_time(starttime, state, "late");
1290 trace_suspend_resume(TPS("dpm_suspend_late"), state.event, false);
1295 * dpm_suspend_end - Execute "late" and "noirq" device suspend callbacks.
1296 * @state: PM transition of the system being carried out.
1298 int dpm_suspend_end(pm_message_t state)
1300 int error = dpm_suspend_late(state);
1304 error = dpm_suspend_noirq(state);
1306 dpm_resume_early(resume_event(state));
1312 EXPORT_SYMBOL_GPL(dpm_suspend_end);
1315 * legacy_suspend - Execute a legacy (bus or class) suspend callback for device.
1316 * @dev: Device to suspend.
1317 * @state: PM transition of the system being carried out.
1318 * @cb: Suspend callback to execute.
1319 * @info: string description of caller.
1321 static int legacy_suspend(struct device *dev, pm_message_t state,
1322 int (*cb)(struct device *dev, pm_message_t state),
1328 calltime = initcall_debug_start(dev);
1330 trace_device_pm_callback_start(dev, info, state.event);
1331 error = cb(dev, state);
1332 trace_device_pm_callback_end(dev, error);
1333 suspend_report_result(cb, error);
1335 initcall_debug_report(dev, calltime, error, state, info);
1341 * device_suspend - Execute "suspend" callbacks for given device.
1342 * @dev: Device to handle.
1343 * @state: PM transition of the system being carried out.
1344 * @async: If true, the device is being suspended asynchronously.
1346 static int __device_suspend(struct device *dev, pm_message_t state, bool async)
1348 pm_callback_t callback = NULL;
1351 char suspend_abort[MAX_SUSPEND_ABORT_LEN];
1352 DECLARE_DPM_WATCHDOG_ON_STACK(wd);
1357 dpm_wait_for_children(dev, async);
1363 * If a device configured to wake up the system from sleep states
1364 * has been suspended at run time and there's a resume request pending
1365 * for it, this is equivalent to the device signaling wakeup, so the
1366 * system suspend operation should be aborted.
1368 if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
1369 pm_wakeup_event(dev, 0);
1371 if (pm_wakeup_pending()) {
1372 pm_get_active_wakeup_sources(suspend_abort,
1373 MAX_SUSPEND_ABORT_LEN);
1374 log_suspend_abort_reason(suspend_abort);
1375 async_error = -EBUSY;
1379 if (dev->power.syscore)
1382 if (dev->power.direct_complete) {
1383 if (pm_runtime_status_suspended(dev)) {
1384 pm_runtime_disable(dev);
1385 if (pm_runtime_status_suspended(dev))
1388 pm_runtime_enable(dev);
1390 dev->power.direct_complete = false;
1393 dpm_watchdog_set(&wd, dev);
1396 if (dev->pm_domain) {
1397 info = "power domain ";
1398 callback = pm_op(&dev->pm_domain->ops, state);
1402 if (dev->type && dev->type->pm) {
1404 callback = pm_op(dev->type->pm, state);
1409 if (dev->class->pm) {
1411 callback = pm_op(dev->class->pm, state);
1413 } else if (dev->class->suspend) {
1414 pm_dev_dbg(dev, state, "legacy class ");
1415 error = legacy_suspend(dev, state, dev->class->suspend,
1424 callback = pm_op(dev->bus->pm, state);
1425 } else if (dev->bus->suspend) {
1426 pm_dev_dbg(dev, state, "legacy bus ");
1427 error = legacy_suspend(dev, state, dev->bus->suspend,
1434 if (!callback && dev->driver && dev->driver->pm) {
1436 callback = pm_op(dev->driver->pm, state);
1439 error = dpm_run_callback(callback, dev, state, info);
1443 struct device *parent = dev->parent;
1445 dev->power.is_suspended = true;
1447 spin_lock_irq(&parent->power.lock);
1449 dev->parent->power.direct_complete = false;
1450 if (dev->power.wakeup_path
1451 && !dev->parent->power.ignore_children)
1452 dev->parent->power.wakeup_path = true;
1454 spin_unlock_irq(&parent->power.lock);
1459 dpm_watchdog_clear(&wd);
1462 complete_all(&dev->power.completion);
1464 async_error = error;
1466 TRACE_SUSPEND(error);
1470 static void async_suspend(void *data, async_cookie_t cookie)
1472 struct device *dev = (struct device *)data;
1475 error = __device_suspend(dev, pm_transition, true);
1477 dpm_save_failed_dev(dev_name(dev));
1478 pm_dev_err(dev, pm_transition, " async", error);
1484 static int device_suspend(struct device *dev)
1486 reinit_completion(&dev->power.completion);
1488 if (is_async(dev)) {
1490 async_schedule(async_suspend, dev);
1494 return __device_suspend(dev, pm_transition, false);
1498 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
1499 * @state: PM transition of the system being carried out.
1501 int dpm_suspend(pm_message_t state)
1503 ktime_t starttime = ktime_get();
1506 trace_suspend_resume(TPS("dpm_suspend"), state.event, true);
1511 mutex_lock(&dpm_list_mtx);
1512 pm_transition = state;
1514 while (!list_empty(&dpm_prepared_list)) {
1515 struct device *dev = to_device(dpm_prepared_list.prev);
1518 mutex_unlock(&dpm_list_mtx);
1520 error = device_suspend(dev);
1522 mutex_lock(&dpm_list_mtx);
1524 pm_dev_err(dev, state, "", error);
1525 dpm_save_failed_dev(dev_name(dev));
1529 if (!list_empty(&dev->power.entry))
1530 list_move(&dev->power.entry, &dpm_suspended_list);
1535 mutex_unlock(&dpm_list_mtx);
1536 async_synchronize_full();
1538 error = async_error;
1540 suspend_stats.failed_suspend++;
1541 dpm_save_failed_step(SUSPEND_SUSPEND);
1543 dpm_show_time(starttime, state, NULL);
1544 trace_suspend_resume(TPS("dpm_suspend"), state.event, false);
1549 * device_prepare - Prepare a device for system power transition.
1550 * @dev: Device to handle.
1551 * @state: PM transition of the system being carried out.
1553 * Execute the ->prepare() callback(s) for given device. No new children of the
1554 * device may be registered after this function has returned.
1556 static int device_prepare(struct device *dev, pm_message_t state)
1558 int (*callback)(struct device *) = NULL;
1562 if (dev->power.syscore)
1566 * If a device's parent goes into runtime suspend at the wrong time,
1567 * it won't be possible to resume the device. To prevent this we
1568 * block runtime suspend here, during the prepare phase, and allow
1569 * it again during the complete phase.
1571 pm_runtime_get_noresume(dev);
1575 dev->power.wakeup_path = device_may_wakeup(dev);
1577 if (dev->pm_domain) {
1578 info = "preparing power domain ";
1579 callback = dev->pm_domain->ops.prepare;
1580 } else if (dev->type && dev->type->pm) {
1581 info = "preparing type ";
1582 callback = dev->type->pm->prepare;
1583 } else if (dev->class && dev->class->pm) {
1584 info = "preparing class ";
1585 callback = dev->class->pm->prepare;
1586 } else if (dev->bus && dev->bus->pm) {
1587 info = "preparing bus ";
1588 callback = dev->bus->pm->prepare;
1591 if (!callback && dev->driver && dev->driver->pm) {
1592 info = "preparing driver ";
1593 callback = dev->driver->pm->prepare;
1597 ret = callback(dev);
1602 suspend_report_result(callback, ret);
1603 pm_runtime_put(dev);
1607 * A positive return value from ->prepare() means "this device appears
1608 * to be runtime-suspended and its state is fine, so if it really is
1609 * runtime-suspended, you can leave it in that state provided that you
1610 * will do the same thing with all of its descendants". This only
1611 * applies to suspend transitions, however.
1613 spin_lock_irq(&dev->power.lock);
1614 dev->power.direct_complete = ret > 0 && state.event == PM_EVENT_SUSPEND;
1615 spin_unlock_irq(&dev->power.lock);
1620 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
1621 * @state: PM transition of the system being carried out.
1623 * Execute the ->prepare() callback(s) for all devices.
1625 int dpm_prepare(pm_message_t state)
1629 trace_suspend_resume(TPS("dpm_prepare"), state.event, true);
1632 mutex_lock(&dpm_list_mtx);
1633 while (!list_empty(&dpm_list)) {
1634 struct device *dev = to_device(dpm_list.next);
1637 mutex_unlock(&dpm_list_mtx);
1639 trace_device_pm_callback_start(dev, "", state.event);
1640 error = device_prepare(dev, state);
1641 trace_device_pm_callback_end(dev, error);
1643 mutex_lock(&dpm_list_mtx);
1645 if (error == -EAGAIN) {
1650 printk(KERN_INFO "PM: Device %s not prepared "
1651 "for power transition: code %d\n",
1652 dev_name(dev), error);
1656 dev->power.is_prepared = true;
1657 if (!list_empty(&dev->power.entry))
1658 list_move_tail(&dev->power.entry, &dpm_prepared_list);
1661 mutex_unlock(&dpm_list_mtx);
1662 trace_suspend_resume(TPS("dpm_prepare"), state.event, false);
1667 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
1668 * @state: PM transition of the system being carried out.
1670 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
1671 * callbacks for them.
1673 int dpm_suspend_start(pm_message_t state)
1677 error = dpm_prepare(state);
1679 suspend_stats.failed_prepare++;
1680 dpm_save_failed_step(SUSPEND_PREPARE);
1682 error = dpm_suspend(state);
1685 EXPORT_SYMBOL_GPL(dpm_suspend_start);
1687 void __suspend_report_result(const char *function, void *fn, int ret)
1690 printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
1692 EXPORT_SYMBOL_GPL(__suspend_report_result);
1695 * device_pm_wait_for_dev - Wait for suspend/resume of a device to complete.
1696 * @dev: Device to wait for.
1697 * @subordinate: Device that needs to wait for @dev.
1699 int device_pm_wait_for_dev(struct device *subordinate, struct device *dev)
1701 dpm_wait(dev, subordinate->power.async_suspend);
1704 EXPORT_SYMBOL_GPL(device_pm_wait_for_dev);
1707 * dpm_for_each_dev - device iterator.
1708 * @data: data for the callback.
1709 * @fn: function to be called for each device.
1711 * Iterate over devices in dpm_list, and call @fn for each device,
1714 void dpm_for_each_dev(void *data, void (*fn)(struct device *, void *))
1722 list_for_each_entry(dev, &dpm_list, power.entry)
1726 EXPORT_SYMBOL_GPL(dpm_for_each_dev);