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 intialize 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/mutex.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/resume-trace.h>
26 #include <linux/rwsem.h>
27 #include <linux/interrupt.h>
33 * The entries in the dpm_list list are in a depth first order, simply
34 * because children are guaranteed to be discovered after parents, and
35 * are inserted at the back of the list on discovery.
37 * Since device_pm_add() may be called with a device semaphore held,
38 * we must never try to acquire a device semaphore while holding
44 static DEFINE_MUTEX(dpm_list_mtx);
47 * Set once the preparation of devices for a PM transition has started, reset
48 * before starting to resume devices. Protected by dpm_list_mtx.
50 static bool transition_started;
53 * device_pm_init - Initialize the PM-related part of a device object
54 * @dev: Device object being initialized.
56 void device_pm_init(struct device *dev)
58 dev->power.status = DPM_ON;
63 * device_pm_lock - lock the list of active devices used by the PM core
65 void device_pm_lock(void)
67 mutex_lock(&dpm_list_mtx);
71 * device_pm_unlock - unlock the list of active devices used by the PM core
73 void device_pm_unlock(void)
75 mutex_unlock(&dpm_list_mtx);
79 * device_pm_add - add a device to the list of active devices
80 * @dev: Device to be added to the list
82 void device_pm_add(struct device *dev)
84 pr_debug("PM: Adding info for %s:%s\n",
85 dev->bus ? dev->bus->name : "No Bus",
86 kobject_name(&dev->kobj));
87 mutex_lock(&dpm_list_mtx);
89 if (dev->parent->power.status >= DPM_SUSPENDING)
90 dev_warn(dev, "parent %s should not be sleeping\n",
91 dev_name(dev->parent));
92 } else if (transition_started) {
94 * We refuse to register parentless devices while a PM
95 * transition is in progress in order to avoid leaving them
96 * unhandled down the road
98 dev_WARN(dev, "Parentless device registered during a PM transaction\n");
101 list_add_tail(&dev->power.entry, &dpm_list);
102 mutex_unlock(&dpm_list_mtx);
106 * device_pm_remove - remove a device from the list of active devices
107 * @dev: Device to be removed from the list
109 * This function also removes the device's PM-related sysfs attributes.
111 void device_pm_remove(struct device *dev)
113 pr_debug("PM: Removing info for %s:%s\n",
114 dev->bus ? dev->bus->name : "No Bus",
115 kobject_name(&dev->kobj));
116 mutex_lock(&dpm_list_mtx);
117 list_del_init(&dev->power.entry);
118 mutex_unlock(&dpm_list_mtx);
119 pm_runtime_remove(dev);
123 * device_pm_move_before - move device in dpm_list
124 * @deva: Device to move in dpm_list
125 * @devb: Device @deva should come before
127 void device_pm_move_before(struct device *deva, struct device *devb)
129 pr_debug("PM: Moving %s:%s before %s:%s\n",
130 deva->bus ? deva->bus->name : "No Bus",
131 kobject_name(&deva->kobj),
132 devb->bus ? devb->bus->name : "No Bus",
133 kobject_name(&devb->kobj));
134 /* Delete deva from dpm_list and reinsert before devb. */
135 list_move_tail(&deva->power.entry, &devb->power.entry);
139 * device_pm_move_after - move device in dpm_list
140 * @deva: Device to move in dpm_list
141 * @devb: Device @deva should come after
143 void device_pm_move_after(struct device *deva, struct device *devb)
145 pr_debug("PM: Moving %s:%s after %s:%s\n",
146 deva->bus ? deva->bus->name : "No Bus",
147 kobject_name(&deva->kobj),
148 devb->bus ? devb->bus->name : "No Bus",
149 kobject_name(&devb->kobj));
150 /* Delete deva from dpm_list and reinsert after devb. */
151 list_move(&deva->power.entry, &devb->power.entry);
155 * device_pm_move_last - move device to end of dpm_list
156 * @dev: Device to move in dpm_list
158 void device_pm_move_last(struct device *dev)
160 pr_debug("PM: Moving %s:%s to end of list\n",
161 dev->bus ? dev->bus->name : "No Bus",
162 kobject_name(&dev->kobj));
163 list_move_tail(&dev->power.entry, &dpm_list);
167 * pm_op - execute the PM operation appropiate for given PM event
169 * @ops: PM operations to choose from.
170 * @state: PM transition of the system being carried out.
172 static int pm_op(struct device *dev,
173 const struct dev_pm_ops *ops,
178 switch (state.event) {
179 #ifdef CONFIG_SUSPEND
180 case PM_EVENT_SUSPEND:
182 error = ops->suspend(dev);
183 suspend_report_result(ops->suspend, error);
186 case PM_EVENT_RESUME:
188 error = ops->resume(dev);
189 suspend_report_result(ops->resume, error);
192 #endif /* CONFIG_SUSPEND */
193 #ifdef CONFIG_HIBERNATION
194 case PM_EVENT_FREEZE:
195 case PM_EVENT_QUIESCE:
197 error = ops->freeze(dev);
198 suspend_report_result(ops->freeze, error);
201 case PM_EVENT_HIBERNATE:
203 error = ops->poweroff(dev);
204 suspend_report_result(ops->poweroff, error);
208 case PM_EVENT_RECOVER:
210 error = ops->thaw(dev);
211 suspend_report_result(ops->thaw, error);
214 case PM_EVENT_RESTORE:
216 error = ops->restore(dev);
217 suspend_report_result(ops->restore, error);
220 #endif /* CONFIG_HIBERNATION */
228 * pm_noirq_op - execute the PM operation appropiate for given PM event
230 * @ops: PM operations to choose from.
231 * @state: PM transition of the system being carried out.
233 * The operation is executed with interrupts disabled by the only remaining
234 * functional CPU in the system.
236 static int pm_noirq_op(struct device *dev,
237 const struct dev_pm_ops *ops,
242 switch (state.event) {
243 #ifdef CONFIG_SUSPEND
244 case PM_EVENT_SUSPEND:
245 if (ops->suspend_noirq) {
246 error = ops->suspend_noirq(dev);
247 suspend_report_result(ops->suspend_noirq, error);
250 case PM_EVENT_RESUME:
251 if (ops->resume_noirq) {
252 error = ops->resume_noirq(dev);
253 suspend_report_result(ops->resume_noirq, error);
256 #endif /* CONFIG_SUSPEND */
257 #ifdef CONFIG_HIBERNATION
258 case PM_EVENT_FREEZE:
259 case PM_EVENT_QUIESCE:
260 if (ops->freeze_noirq) {
261 error = ops->freeze_noirq(dev);
262 suspend_report_result(ops->freeze_noirq, error);
265 case PM_EVENT_HIBERNATE:
266 if (ops->poweroff_noirq) {
267 error = ops->poweroff_noirq(dev);
268 suspend_report_result(ops->poweroff_noirq, error);
272 case PM_EVENT_RECOVER:
273 if (ops->thaw_noirq) {
274 error = ops->thaw_noirq(dev);
275 suspend_report_result(ops->thaw_noirq, error);
278 case PM_EVENT_RESTORE:
279 if (ops->restore_noirq) {
280 error = ops->restore_noirq(dev);
281 suspend_report_result(ops->restore_noirq, error);
284 #endif /* CONFIG_HIBERNATION */
291 static char *pm_verb(int event)
294 case PM_EVENT_SUSPEND:
296 case PM_EVENT_RESUME:
298 case PM_EVENT_FREEZE:
300 case PM_EVENT_QUIESCE:
302 case PM_EVENT_HIBERNATE:
306 case PM_EVENT_RESTORE:
308 case PM_EVENT_RECOVER:
311 return "(unknown PM event)";
315 static void pm_dev_dbg(struct device *dev, pm_message_t state, char *info)
317 dev_dbg(dev, "%s%s%s\n", info, pm_verb(state.event),
318 ((state.event & PM_EVENT_SLEEP) && device_may_wakeup(dev)) ?
319 ", may wakeup" : "");
322 static void pm_dev_err(struct device *dev, pm_message_t state, char *info,
325 printk(KERN_ERR "PM: Device %s failed to %s%s: error %d\n",
326 kobject_name(&dev->kobj), pm_verb(state.event), info, error);
329 /*------------------------- Resume routines -------------------------*/
332 * device_resume_noirq - Power on one device (early resume).
334 * @state: PM transition of the system being carried out.
336 * Must be called with interrupts disabled.
338 static int device_resume_noirq(struct device *dev, pm_message_t state)
349 pm_dev_dbg(dev, state, "EARLY ");
350 error = pm_noirq_op(dev, dev->bus->pm, state);
358 * dpm_resume_noirq - Power on all regular (non-sysdev) devices.
359 * @state: PM transition of the system being carried out.
361 * Call the "noirq" resume handlers for all devices marked as
362 * DPM_OFF_IRQ and enable device drivers to receive interrupts.
364 * Must be called under dpm_list_mtx. Device drivers should not receive
365 * interrupts while it's being executed.
367 void dpm_resume_noirq(pm_message_t state)
371 mutex_lock(&dpm_list_mtx);
372 list_for_each_entry(dev, &dpm_list, power.entry)
373 if (dev->power.status > DPM_OFF) {
376 dev->power.status = DPM_OFF;
377 error = device_resume_noirq(dev, state);
379 pm_dev_err(dev, state, " early", error);
381 mutex_unlock(&dpm_list_mtx);
382 resume_device_irqs();
384 EXPORT_SYMBOL_GPL(dpm_resume_noirq);
387 * device_resume - Restore state for one device.
389 * @state: PM transition of the system being carried out.
391 static int device_resume(struct device *dev, pm_message_t state)
402 pm_dev_dbg(dev, state, "");
403 error = pm_op(dev, dev->bus->pm, state);
404 } else if (dev->bus->resume) {
405 pm_dev_dbg(dev, state, "legacy ");
406 error = dev->bus->resume(dev);
414 pm_dev_dbg(dev, state, "type ");
415 error = pm_op(dev, dev->type->pm, state);
422 if (dev->class->pm) {
423 pm_dev_dbg(dev, state, "class ");
424 error = pm_op(dev, dev->class->pm, state);
425 } else if (dev->class->resume) {
426 pm_dev_dbg(dev, state, "legacy class ");
427 error = dev->class->resume(dev);
438 * dpm_resume - Resume every device.
439 * @state: PM transition of the system being carried out.
441 * Execute the appropriate "resume" callback for all devices the status of
442 * which indicates that they are inactive.
444 static void dpm_resume(pm_message_t state)
446 struct list_head list;
448 INIT_LIST_HEAD(&list);
449 mutex_lock(&dpm_list_mtx);
450 transition_started = false;
451 while (!list_empty(&dpm_list)) {
452 struct device *dev = to_device(dpm_list.next);
455 if (dev->power.status >= DPM_OFF) {
458 dev->power.status = DPM_RESUMING;
459 mutex_unlock(&dpm_list_mtx);
461 error = device_resume(dev, state);
463 mutex_lock(&dpm_list_mtx);
465 pm_dev_err(dev, state, "", error);
466 } else if (dev->power.status == DPM_SUSPENDING) {
467 /* Allow new children of the device to be registered */
468 dev->power.status = DPM_RESUMING;
470 if (!list_empty(&dev->power.entry))
471 list_move_tail(&dev->power.entry, &list);
474 list_splice(&list, &dpm_list);
475 mutex_unlock(&dpm_list_mtx);
479 * device_complete - Complete a PM transition for given device
481 * @state: PM transition of the system being carried out.
483 static void device_complete(struct device *dev, pm_message_t state)
487 if (dev->class && dev->class->pm && dev->class->pm->complete) {
488 pm_dev_dbg(dev, state, "completing class ");
489 dev->class->pm->complete(dev);
492 if (dev->type && dev->type->pm && dev->type->pm->complete) {
493 pm_dev_dbg(dev, state, "completing type ");
494 dev->type->pm->complete(dev);
497 if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
498 pm_dev_dbg(dev, state, "completing ");
499 dev->bus->pm->complete(dev);
506 * dpm_complete - Complete a PM transition for all devices.
507 * @state: PM transition of the system being carried out.
509 * Execute the ->complete() callbacks for all devices that are not marked
512 static void dpm_complete(pm_message_t state)
514 struct list_head list;
516 INIT_LIST_HEAD(&list);
517 mutex_lock(&dpm_list_mtx);
518 while (!list_empty(&dpm_list)) {
519 struct device *dev = to_device(dpm_list.prev);
522 if (dev->power.status > DPM_ON) {
523 dev->power.status = DPM_ON;
524 mutex_unlock(&dpm_list_mtx);
526 device_complete(dev, state);
527 pm_runtime_put_noidle(dev);
529 mutex_lock(&dpm_list_mtx);
531 if (!list_empty(&dev->power.entry))
532 list_move(&dev->power.entry, &list);
535 list_splice(&list, &dpm_list);
536 mutex_unlock(&dpm_list_mtx);
540 * dpm_resume_end - Restore state of each device in system.
541 * @state: PM transition of the system being carried out.
543 * Resume all the devices, unlock them all, and allow new
544 * devices to be registered once again.
546 void dpm_resume_end(pm_message_t state)
552 EXPORT_SYMBOL_GPL(dpm_resume_end);
555 /*------------------------- Suspend routines -------------------------*/
558 * resume_event - return a PM message representing the resume event
559 * corresponding to given sleep state.
560 * @sleep_state: PM message representing a sleep state.
562 static pm_message_t resume_event(pm_message_t sleep_state)
564 switch (sleep_state.event) {
565 case PM_EVENT_SUSPEND:
567 case PM_EVENT_FREEZE:
568 case PM_EVENT_QUIESCE:
570 case PM_EVENT_HIBERNATE:
577 * device_suspend_noirq - Shut down one device (late suspend).
579 * @state: PM transition of the system being carried out.
581 * This is called with interrupts off and only a single CPU running.
583 static int device_suspend_noirq(struct device *dev, pm_message_t state)
591 pm_dev_dbg(dev, state, "LATE ");
592 error = pm_noirq_op(dev, dev->bus->pm, state);
598 * dpm_suspend_noirq - Power down all regular (non-sysdev) devices.
599 * @state: PM transition of the system being carried out.
601 * Prevent device drivers from receiving interrupts and call the "noirq"
604 * Must be called under dpm_list_mtx.
606 int dpm_suspend_noirq(pm_message_t state)
611 suspend_device_irqs();
612 mutex_lock(&dpm_list_mtx);
613 list_for_each_entry_reverse(dev, &dpm_list, power.entry) {
614 error = device_suspend_noirq(dev, state);
616 pm_dev_err(dev, state, " late", error);
619 dev->power.status = DPM_OFF_IRQ;
621 mutex_unlock(&dpm_list_mtx);
623 dpm_resume_noirq(resume_event(state));
626 EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
629 * device_suspend - Save state of one device.
631 * @state: PM transition of the system being carried out.
633 static int device_suspend(struct device *dev, pm_message_t state)
640 if (dev->class->pm) {
641 pm_dev_dbg(dev, state, "class ");
642 error = pm_op(dev, dev->class->pm, state);
643 } else if (dev->class->suspend) {
644 pm_dev_dbg(dev, state, "legacy class ");
645 error = dev->class->suspend(dev, state);
646 suspend_report_result(dev->class->suspend, error);
654 pm_dev_dbg(dev, state, "type ");
655 error = pm_op(dev, dev->type->pm, state);
663 pm_dev_dbg(dev, state, "");
664 error = pm_op(dev, dev->bus->pm, state);
665 } else if (dev->bus->suspend) {
666 pm_dev_dbg(dev, state, "legacy ");
667 error = dev->bus->suspend(dev, state);
668 suspend_report_result(dev->bus->suspend, error);
678 * dpm_suspend - Suspend every device.
679 * @state: PM transition of the system being carried out.
681 * Execute the appropriate "suspend" callbacks for all devices.
683 static int dpm_suspend(pm_message_t state)
685 struct list_head list;
688 INIT_LIST_HEAD(&list);
689 mutex_lock(&dpm_list_mtx);
690 while (!list_empty(&dpm_list)) {
691 struct device *dev = to_device(dpm_list.prev);
694 mutex_unlock(&dpm_list_mtx);
696 error = device_suspend(dev, state);
698 mutex_lock(&dpm_list_mtx);
700 pm_dev_err(dev, state, "", error);
704 dev->power.status = DPM_OFF;
705 if (!list_empty(&dev->power.entry))
706 list_move(&dev->power.entry, &list);
709 list_splice(&list, dpm_list.prev);
710 mutex_unlock(&dpm_list_mtx);
715 * device_prepare - Execute the ->prepare() callback(s) for given device.
717 * @state: PM transition of the system being carried out.
719 static int device_prepare(struct device *dev, pm_message_t state)
725 if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
726 pm_dev_dbg(dev, state, "preparing ");
727 error = dev->bus->pm->prepare(dev);
728 suspend_report_result(dev->bus->pm->prepare, error);
733 if (dev->type && dev->type->pm && dev->type->pm->prepare) {
734 pm_dev_dbg(dev, state, "preparing type ");
735 error = dev->type->pm->prepare(dev);
736 suspend_report_result(dev->type->pm->prepare, error);
741 if (dev->class && dev->class->pm && dev->class->pm->prepare) {
742 pm_dev_dbg(dev, state, "preparing class ");
743 error = dev->class->pm->prepare(dev);
744 suspend_report_result(dev->class->pm->prepare, error);
753 * dpm_prepare - Prepare all devices for a PM transition.
754 * @state: PM transition of the system being carried out.
756 * Execute the ->prepare() callback for all devices.
758 static int dpm_prepare(pm_message_t state)
760 struct list_head list;
763 INIT_LIST_HEAD(&list);
764 mutex_lock(&dpm_list_mtx);
765 transition_started = true;
766 while (!list_empty(&dpm_list)) {
767 struct device *dev = to_device(dpm_list.next);
770 dev->power.status = DPM_PREPARING;
771 mutex_unlock(&dpm_list_mtx);
773 pm_runtime_get_noresume(dev);
774 if (pm_runtime_barrier(dev) && device_may_wakeup(dev)) {
775 /* Wake-up requested during system sleep transition. */
776 pm_runtime_put_noidle(dev);
779 error = device_prepare(dev, state);
782 mutex_lock(&dpm_list_mtx);
784 dev->power.status = DPM_ON;
785 if (error == -EAGAIN) {
790 printk(KERN_ERR "PM: Failed to prepare device %s "
791 "for power transition: error %d\n",
792 kobject_name(&dev->kobj), error);
796 dev->power.status = DPM_SUSPENDING;
797 if (!list_empty(&dev->power.entry))
798 list_move_tail(&dev->power.entry, &list);
801 list_splice(&list, &dpm_list);
802 mutex_unlock(&dpm_list_mtx);
807 * dpm_suspend_start - Save state and stop all devices in system.
808 * @state: PM transition of the system being carried out.
810 * Prepare and suspend all devices.
812 int dpm_suspend_start(pm_message_t state)
817 error = dpm_prepare(state);
819 error = dpm_suspend(state);
822 EXPORT_SYMBOL_GPL(dpm_suspend_start);
824 void __suspend_report_result(const char *function, void *fn, int ret)
827 printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
829 EXPORT_SYMBOL_GPL(__suspend_report_result);