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/resume-trace.h>
25 #include <linux/rwsem.h>
31 * The entries in the dpm_list list are in a depth first order, simply
32 * because children are guaranteed to be discovered after parents, and
33 * are inserted at the back of the list on discovery.
35 * Since device_pm_add() may be called with a device semaphore held,
36 * we must never try to acquire a device semaphore while holding
42 static DEFINE_MUTEX(dpm_list_mtx);
45 * Set once the preparation of devices for a PM transition has started, reset
46 * before starting to resume devices. Protected by dpm_list_mtx.
48 static bool transition_started;
51 * device_pm_lock - lock the list of active devices used by the PM core
53 void device_pm_lock(void)
55 mutex_lock(&dpm_list_mtx);
59 * device_pm_unlock - unlock the list of active devices used by the PM core
61 void device_pm_unlock(void)
63 mutex_unlock(&dpm_list_mtx);
67 * device_pm_add - add a device to the list of active devices
68 * @dev: Device to be added to the list
70 void device_pm_add(struct device *dev)
72 pr_debug("PM: Adding info for %s:%s\n",
73 dev->bus ? dev->bus->name : "No Bus",
74 kobject_name(&dev->kobj));
75 mutex_lock(&dpm_list_mtx);
77 if (dev->parent->power.status >= DPM_SUSPENDING)
78 dev_warn(dev, "parent %s should not be sleeping\n",
80 } else if (transition_started) {
82 * We refuse to register parentless devices while a PM
83 * transition is in progress in order to avoid leaving them
84 * unhandled down the road
89 list_add_tail(&dev->power.entry, &dpm_list);
90 mutex_unlock(&dpm_list_mtx);
94 * device_pm_remove - remove a device from the list of active devices
95 * @dev: Device to be removed from the list
97 * This function also removes the device's PM-related sysfs attributes.
99 void device_pm_remove(struct device *dev)
101 pr_debug("PM: Removing info for %s:%s\n",
102 dev->bus ? dev->bus->name : "No Bus",
103 kobject_name(&dev->kobj));
104 mutex_lock(&dpm_list_mtx);
105 list_del_init(&dev->power.entry);
106 mutex_unlock(&dpm_list_mtx);
110 * pm_op - execute the PM operation appropiate for given PM event
112 * @ops: PM operations to choose from.
113 * @state: PM transition of the system being carried out.
115 static int pm_op(struct device *dev, struct pm_ops *ops, pm_message_t state)
119 switch (state.event) {
120 #ifdef CONFIG_SUSPEND
121 case PM_EVENT_SUSPEND:
123 error = ops->suspend(dev);
124 suspend_report_result(ops->suspend, error);
127 case PM_EVENT_RESUME:
129 error = ops->resume(dev);
130 suspend_report_result(ops->resume, error);
133 #endif /* CONFIG_SUSPEND */
134 #ifdef CONFIG_HIBERNATION
135 case PM_EVENT_FREEZE:
136 case PM_EVENT_QUIESCE:
138 error = ops->freeze(dev);
139 suspend_report_result(ops->freeze, error);
142 case PM_EVENT_HIBERNATE:
144 error = ops->poweroff(dev);
145 suspend_report_result(ops->poweroff, error);
149 case PM_EVENT_RECOVER:
151 error = ops->thaw(dev);
152 suspend_report_result(ops->thaw, error);
155 case PM_EVENT_RESTORE:
157 error = ops->restore(dev);
158 suspend_report_result(ops->restore, error);
161 #endif /* CONFIG_HIBERNATION */
169 * pm_noirq_op - execute the PM operation appropiate for given PM event
171 * @ops: PM operations to choose from.
172 * @state: PM transition of the system being carried out.
174 * The operation is executed with interrupts disabled by the only remaining
175 * functional CPU in the system.
177 static int pm_noirq_op(struct device *dev, struct pm_ext_ops *ops,
182 switch (state.event) {
183 #ifdef CONFIG_SUSPEND
184 case PM_EVENT_SUSPEND:
185 if (ops->suspend_noirq) {
186 error = ops->suspend_noirq(dev);
187 suspend_report_result(ops->suspend_noirq, error);
190 case PM_EVENT_RESUME:
191 if (ops->resume_noirq) {
192 error = ops->resume_noirq(dev);
193 suspend_report_result(ops->resume_noirq, error);
196 #endif /* CONFIG_SUSPEND */
197 #ifdef CONFIG_HIBERNATION
198 case PM_EVENT_FREEZE:
199 case PM_EVENT_QUIESCE:
200 if (ops->freeze_noirq) {
201 error = ops->freeze_noirq(dev);
202 suspend_report_result(ops->freeze_noirq, error);
205 case PM_EVENT_HIBERNATE:
206 if (ops->poweroff_noirq) {
207 error = ops->poweroff_noirq(dev);
208 suspend_report_result(ops->poweroff_noirq, error);
212 case PM_EVENT_RECOVER:
213 if (ops->thaw_noirq) {
214 error = ops->thaw_noirq(dev);
215 suspend_report_result(ops->thaw_noirq, error);
218 case PM_EVENT_RESTORE:
219 if (ops->restore_noirq) {
220 error = ops->restore_noirq(dev);
221 suspend_report_result(ops->restore_noirq, error);
224 #endif /* CONFIG_HIBERNATION */
231 static char *pm_verb(int event)
234 case PM_EVENT_SUSPEND:
236 case PM_EVENT_RESUME:
238 case PM_EVENT_FREEZE:
240 case PM_EVENT_QUIESCE:
242 case PM_EVENT_HIBERNATE:
246 case PM_EVENT_RESTORE:
248 case PM_EVENT_RECOVER:
251 return "(unknown PM event)";
255 static void pm_dev_dbg(struct device *dev, pm_message_t state, char *info)
257 dev_dbg(dev, "%s%s%s\n", info, pm_verb(state.event),
258 ((state.event & PM_EVENT_SLEEP) && device_may_wakeup(dev)) ?
259 ", may wakeup" : "");
262 static void pm_dev_err(struct device *dev, pm_message_t state, char *info,
265 printk(KERN_ERR "PM: Device %s failed to %s%s: error %d\n",
266 kobject_name(&dev->kobj), pm_verb(state.event), info, error);
269 /*------------------------- Resume routines -------------------------*/
272 * resume_device_noirq - Power on one device (early resume).
274 * @state: PM transition of the system being carried out.
276 * Must be called with interrupts disabled.
278 static int resume_device_noirq(struct device *dev, pm_message_t state)
289 pm_dev_dbg(dev, state, "EARLY ");
290 error = pm_noirq_op(dev, dev->bus->pm, state);
291 } else if (dev->bus->resume_early) {
292 pm_dev_dbg(dev, state, "legacy EARLY ");
293 error = dev->bus->resume_early(dev);
301 * dpm_power_up - Power on all regular (non-sysdev) devices.
302 * @state: PM transition of the system being carried out.
304 * Execute the appropriate "noirq resume" callback for all devices marked
307 * Must be called with interrupts disabled and only one CPU running.
309 static void dpm_power_up(pm_message_t state)
313 list_for_each_entry(dev, &dpm_list, power.entry)
314 if (dev->power.status > DPM_OFF) {
317 dev->power.status = DPM_OFF;
318 error = resume_device_noirq(dev, state);
320 pm_dev_err(dev, state, " early", error);
325 * device_power_up - Turn on all devices that need special attention.
326 * @state: PM transition of the system being carried out.
328 * Power on system devices, then devices that required we shut them down
329 * with interrupts disabled.
331 * Must be called with interrupts disabled.
333 void device_power_up(pm_message_t state)
338 EXPORT_SYMBOL_GPL(device_power_up);
341 * resume_device - Restore state for one device.
343 * @state: PM transition of the system being carried out.
345 static int resume_device(struct device *dev, pm_message_t state)
356 pm_dev_dbg(dev, state, "");
357 error = pm_op(dev, &dev->bus->pm->base, state);
358 } else if (dev->bus->resume) {
359 pm_dev_dbg(dev, state, "legacy ");
360 error = dev->bus->resume(dev);
368 pm_dev_dbg(dev, state, "type ");
369 error = pm_op(dev, dev->type->pm, state);
370 } else if (dev->type->resume) {
371 pm_dev_dbg(dev, state, "legacy type ");
372 error = dev->type->resume(dev);
379 if (dev->class->pm) {
380 pm_dev_dbg(dev, state, "class ");
381 error = pm_op(dev, dev->class->pm, state);
382 } else if (dev->class->resume) {
383 pm_dev_dbg(dev, state, "legacy class ");
384 error = dev->class->resume(dev);
395 * dpm_resume - Resume every device.
396 * @state: PM transition of the system being carried out.
398 * Execute the appropriate "resume" callback for all devices the status of
399 * which indicates that they are inactive.
401 static void dpm_resume(pm_message_t state)
403 struct list_head list;
405 INIT_LIST_HEAD(&list);
406 mutex_lock(&dpm_list_mtx);
407 transition_started = false;
408 while (!list_empty(&dpm_list)) {
409 struct device *dev = to_device(dpm_list.next);
412 if (dev->power.status >= DPM_OFF) {
415 dev->power.status = DPM_RESUMING;
416 mutex_unlock(&dpm_list_mtx);
418 error = resume_device(dev, state);
420 mutex_lock(&dpm_list_mtx);
422 pm_dev_err(dev, state, "", error);
423 } else if (dev->power.status == DPM_SUSPENDING) {
424 /* Allow new children of the device to be registered */
425 dev->power.status = DPM_RESUMING;
427 if (!list_empty(&dev->power.entry))
428 list_move_tail(&dev->power.entry, &list);
431 list_splice(&list, &dpm_list);
432 mutex_unlock(&dpm_list_mtx);
436 * complete_device - Complete a PM transition for given device
438 * @state: PM transition of the system being carried out.
440 static void complete_device(struct device *dev, pm_message_t state)
444 if (dev->class && dev->class->pm && dev->class->pm->complete) {
445 pm_dev_dbg(dev, state, "completing class ");
446 dev->class->pm->complete(dev);
449 if (dev->type && dev->type->pm && dev->type->pm->complete) {
450 pm_dev_dbg(dev, state, "completing type ");
451 dev->type->pm->complete(dev);
454 if (dev->bus && dev->bus->pm && dev->bus->pm->base.complete) {
455 pm_dev_dbg(dev, state, "completing ");
456 dev->bus->pm->base.complete(dev);
463 * dpm_complete - Complete a PM transition for all devices.
464 * @state: PM transition of the system being carried out.
466 * Execute the ->complete() callbacks for all devices that are not marked
469 static void dpm_complete(pm_message_t state)
471 struct list_head list;
473 INIT_LIST_HEAD(&list);
474 mutex_lock(&dpm_list_mtx);
475 while (!list_empty(&dpm_list)) {
476 struct device *dev = to_device(dpm_list.prev);
479 if (dev->power.status > DPM_ON) {
480 dev->power.status = DPM_ON;
481 mutex_unlock(&dpm_list_mtx);
483 complete_device(dev, state);
485 mutex_lock(&dpm_list_mtx);
487 if (!list_empty(&dev->power.entry))
488 list_move(&dev->power.entry, &list);
491 list_splice(&list, &dpm_list);
492 mutex_unlock(&dpm_list_mtx);
496 * device_resume - Restore state of each device in system.
497 * @state: PM transition of the system being carried out.
499 * Resume all the devices, unlock them all, and allow new
500 * devices to be registered once again.
502 void device_resume(pm_message_t state)
508 EXPORT_SYMBOL_GPL(device_resume);
511 /*------------------------- Suspend routines -------------------------*/
514 * resume_event - return a PM message representing the resume event
515 * corresponding to given sleep state.
516 * @sleep_state: PM message representing a sleep state.
518 static pm_message_t resume_event(pm_message_t sleep_state)
520 switch (sleep_state.event) {
521 case PM_EVENT_SUSPEND:
523 case PM_EVENT_FREEZE:
524 case PM_EVENT_QUIESCE:
526 case PM_EVENT_HIBERNATE:
533 * suspend_device_noirq - Shut down one device (late suspend).
535 * @state: PM transition of the system being carried out.
537 * This is called with interrupts off and only a single CPU running.
539 static int suspend_device_noirq(struct device *dev, pm_message_t state)
547 pm_dev_dbg(dev, state, "LATE ");
548 error = pm_noirq_op(dev, dev->bus->pm, state);
549 } else if (dev->bus->suspend_late) {
550 pm_dev_dbg(dev, state, "legacy LATE ");
551 error = dev->bus->suspend_late(dev, state);
552 suspend_report_result(dev->bus->suspend_late, error);
558 * device_power_down - Shut down special devices.
559 * @state: PM transition of the system being carried out.
561 * Power down devices that require interrupts to be disabled.
562 * Then power down system devices.
564 * Must be called with interrupts disabled and only one CPU running.
566 int device_power_down(pm_message_t state)
571 list_for_each_entry_reverse(dev, &dpm_list, power.entry) {
572 error = suspend_device_noirq(dev, state);
574 pm_dev_err(dev, state, " late", error);
577 dev->power.status = DPM_OFF_IRQ;
580 error = sysdev_suspend(state);
582 dpm_power_up(resume_event(state));
585 EXPORT_SYMBOL_GPL(device_power_down);
588 * suspend_device - Save state of one device.
590 * @state: PM transition of the system being carried out.
592 static int suspend_device(struct device *dev, pm_message_t state)
599 if (dev->class->pm) {
600 pm_dev_dbg(dev, state, "class ");
601 error = pm_op(dev, dev->class->pm, state);
602 } else if (dev->class->suspend) {
603 pm_dev_dbg(dev, state, "legacy class ");
604 error = dev->class->suspend(dev, state);
605 suspend_report_result(dev->class->suspend, error);
613 pm_dev_dbg(dev, state, "type ");
614 error = pm_op(dev, dev->type->pm, state);
615 } else if (dev->type->suspend) {
616 pm_dev_dbg(dev, state, "legacy type ");
617 error = dev->type->suspend(dev, state);
618 suspend_report_result(dev->type->suspend, error);
626 pm_dev_dbg(dev, state, "");
627 error = pm_op(dev, &dev->bus->pm->base, state);
628 } else if (dev->bus->suspend) {
629 pm_dev_dbg(dev, state, "legacy ");
630 error = dev->bus->suspend(dev, state);
631 suspend_report_result(dev->bus->suspend, error);
641 * dpm_suspend - Suspend every device.
642 * @state: PM transition of the system being carried out.
644 * Execute the appropriate "suspend" callbacks for all devices.
646 static int dpm_suspend(pm_message_t state)
648 struct list_head list;
651 INIT_LIST_HEAD(&list);
652 mutex_lock(&dpm_list_mtx);
653 while (!list_empty(&dpm_list)) {
654 struct device *dev = to_device(dpm_list.prev);
657 mutex_unlock(&dpm_list_mtx);
659 error = suspend_device(dev, state);
661 mutex_lock(&dpm_list_mtx);
663 pm_dev_err(dev, state, "", error);
667 dev->power.status = DPM_OFF;
668 if (!list_empty(&dev->power.entry))
669 list_move(&dev->power.entry, &list);
672 list_splice(&list, dpm_list.prev);
673 mutex_unlock(&dpm_list_mtx);
678 * prepare_device - Execute the ->prepare() callback(s) for given device.
680 * @state: PM transition of the system being carried out.
682 static int prepare_device(struct device *dev, pm_message_t state)
688 if (dev->bus && dev->bus->pm && dev->bus->pm->base.prepare) {
689 pm_dev_dbg(dev, state, "preparing ");
690 error = dev->bus->pm->base.prepare(dev);
691 suspend_report_result(dev->bus->pm->base.prepare, error);
696 if (dev->type && dev->type->pm && dev->type->pm->prepare) {
697 pm_dev_dbg(dev, state, "preparing type ");
698 error = dev->type->pm->prepare(dev);
699 suspend_report_result(dev->type->pm->prepare, error);
704 if (dev->class && dev->class->pm && dev->class->pm->prepare) {
705 pm_dev_dbg(dev, state, "preparing class ");
706 error = dev->class->pm->prepare(dev);
707 suspend_report_result(dev->class->pm->prepare, error);
716 * dpm_prepare - Prepare all devices for a PM transition.
717 * @state: PM transition of the system being carried out.
719 * Execute the ->prepare() callback for all devices.
721 static int dpm_prepare(pm_message_t state)
723 struct list_head list;
726 INIT_LIST_HEAD(&list);
727 mutex_lock(&dpm_list_mtx);
728 transition_started = true;
729 while (!list_empty(&dpm_list)) {
730 struct device *dev = to_device(dpm_list.next);
733 dev->power.status = DPM_PREPARING;
734 mutex_unlock(&dpm_list_mtx);
736 error = prepare_device(dev, state);
738 mutex_lock(&dpm_list_mtx);
740 dev->power.status = DPM_ON;
741 if (error == -EAGAIN) {
745 printk(KERN_ERR "PM: Failed to prepare device %s "
746 "for power transition: error %d\n",
747 kobject_name(&dev->kobj), error);
751 dev->power.status = DPM_SUSPENDING;
752 if (!list_empty(&dev->power.entry))
753 list_move_tail(&dev->power.entry, &list);
756 list_splice(&list, &dpm_list);
757 mutex_unlock(&dpm_list_mtx);
762 * device_suspend - Save state and stop all devices in system.
763 * @state: PM transition of the system being carried out.
765 * Prepare and suspend all devices.
767 int device_suspend(pm_message_t state)
772 error = dpm_prepare(state);
774 error = dpm_suspend(state);
777 EXPORT_SYMBOL_GPL(device_suspend);
779 void __suspend_report_result(const char *function, void *fn, int ret)
782 printk(KERN_ERR "%s(): ", function);
783 print_fn_descriptor_symbol("%s returns ", fn);
787 EXPORT_SYMBOL_GPL(__suspend_report_result);