Merge branch 'mini2440-dev-unlikely' into mini2440-dev
[linux-2.6/mini2440.git] / drivers / base / power / main.c
blob8aa2443182d517ddec760d594f8781029a3e9fe5
1 /*
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>
23 #include <linux/pm.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/resume-trace.h>
26 #include <linux/rwsem.h>
27 #include <linux/interrupt.h>
29 #include "../base.h"
30 #include "power.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
39 * dpm_list_mutex.
42 LIST_HEAD(dpm_list);
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;
52 /**
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;
59 pm_runtime_init(dev);
62 /**
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);
70 /**
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);
78 /**
79 * device_pm_add - Add a device to the PM core's list of active devices.
80 * @dev: Device to add 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);
88 if (dev->parent) {
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 PM core's list of active devices.
107 * @dev: Device to be removed from the list.
109 void device_pm_remove(struct device *dev)
111 pr_debug("PM: Removing info for %s:%s\n",
112 dev->bus ? dev->bus->name : "No Bus",
113 kobject_name(&dev->kobj));
114 mutex_lock(&dpm_list_mtx);
115 list_del_init(&dev->power.entry);
116 mutex_unlock(&dpm_list_mtx);
117 pm_runtime_remove(dev);
121 * device_pm_move_before - Move device in the PM core's list of active devices.
122 * @deva: Device to move in dpm_list.
123 * @devb: Device @deva should come before.
125 void device_pm_move_before(struct device *deva, struct device *devb)
127 pr_debug("PM: Moving %s:%s before %s:%s\n",
128 deva->bus ? deva->bus->name : "No Bus",
129 kobject_name(&deva->kobj),
130 devb->bus ? devb->bus->name : "No Bus",
131 kobject_name(&devb->kobj));
132 /* Delete deva from dpm_list and reinsert before devb. */
133 list_move_tail(&deva->power.entry, &devb->power.entry);
137 * device_pm_move_after - Move device in the PM core's list of active devices.
138 * @deva: Device to move in dpm_list.
139 * @devb: Device @deva should come after.
141 void device_pm_move_after(struct device *deva, struct device *devb)
143 pr_debug("PM: Moving %s:%s after %s:%s\n",
144 deva->bus ? deva->bus->name : "No Bus",
145 kobject_name(&deva->kobj),
146 devb->bus ? devb->bus->name : "No Bus",
147 kobject_name(&devb->kobj));
148 /* Delete deva from dpm_list and reinsert after devb. */
149 list_move(&deva->power.entry, &devb->power.entry);
153 * device_pm_move_last - Move device to end of the PM core's list of devices.
154 * @dev: Device to move in dpm_list.
156 void device_pm_move_last(struct device *dev)
158 pr_debug("PM: Moving %s:%s to end of list\n",
159 dev->bus ? dev->bus->name : "No Bus",
160 kobject_name(&dev->kobj));
161 list_move_tail(&dev->power.entry, &dpm_list);
165 * pm_op - Execute the PM operation appropriate for given PM event.
166 * @dev: Device to handle.
167 * @ops: PM operations to choose from.
168 * @state: PM transition of the system being carried out.
170 static int pm_op(struct device *dev,
171 const struct dev_pm_ops *ops,
172 pm_message_t state)
174 int error = 0;
176 switch (state.event) {
177 #ifdef CONFIG_SUSPEND
178 case PM_EVENT_SUSPEND:
179 if (ops->suspend) {
180 error = ops->suspend(dev);
181 suspend_report_result(ops->suspend, error);
183 break;
184 case PM_EVENT_RESUME:
185 if (ops->resume) {
186 error = ops->resume(dev);
187 suspend_report_result(ops->resume, error);
189 break;
190 #endif /* CONFIG_SUSPEND */
191 #ifdef CONFIG_HIBERNATION
192 case PM_EVENT_FREEZE:
193 case PM_EVENT_QUIESCE:
194 if (ops->freeze) {
195 error = ops->freeze(dev);
196 suspend_report_result(ops->freeze, error);
198 break;
199 case PM_EVENT_HIBERNATE:
200 if (ops->poweroff) {
201 error = ops->poweroff(dev);
202 suspend_report_result(ops->poweroff, error);
204 break;
205 case PM_EVENT_THAW:
206 case PM_EVENT_RECOVER:
207 if (ops->thaw) {
208 error = ops->thaw(dev);
209 suspend_report_result(ops->thaw, error);
211 break;
212 case PM_EVENT_RESTORE:
213 if (ops->restore) {
214 error = ops->restore(dev);
215 suspend_report_result(ops->restore, error);
217 break;
218 #endif /* CONFIG_HIBERNATION */
219 default:
220 error = -EINVAL;
222 return error;
226 * pm_noirq_op - Execute the PM operation appropriate for given PM event.
227 * @dev: Device to handle.
228 * @ops: PM operations to choose from.
229 * @state: PM transition of the system being carried out.
231 * The driver of @dev will not receive interrupts while this function is being
232 * executed.
234 static int pm_noirq_op(struct device *dev,
235 const struct dev_pm_ops *ops,
236 pm_message_t state)
238 int error = 0;
240 switch (state.event) {
241 #ifdef CONFIG_SUSPEND
242 case PM_EVENT_SUSPEND:
243 if (ops->suspend_noirq) {
244 error = ops->suspend_noirq(dev);
245 suspend_report_result(ops->suspend_noirq, error);
247 break;
248 case PM_EVENT_RESUME:
249 if (ops->resume_noirq) {
250 error = ops->resume_noirq(dev);
251 suspend_report_result(ops->resume_noirq, error);
253 break;
254 #endif /* CONFIG_SUSPEND */
255 #ifdef CONFIG_HIBERNATION
256 case PM_EVENT_FREEZE:
257 case PM_EVENT_QUIESCE:
258 if (ops->freeze_noirq) {
259 error = ops->freeze_noirq(dev);
260 suspend_report_result(ops->freeze_noirq, error);
262 break;
263 case PM_EVENT_HIBERNATE:
264 if (ops->poweroff_noirq) {
265 error = ops->poweroff_noirq(dev);
266 suspend_report_result(ops->poweroff_noirq, error);
268 break;
269 case PM_EVENT_THAW:
270 case PM_EVENT_RECOVER:
271 if (ops->thaw_noirq) {
272 error = ops->thaw_noirq(dev);
273 suspend_report_result(ops->thaw_noirq, error);
275 break;
276 case PM_EVENT_RESTORE:
277 if (ops->restore_noirq) {
278 error = ops->restore_noirq(dev);
279 suspend_report_result(ops->restore_noirq, error);
281 break;
282 #endif /* CONFIG_HIBERNATION */
283 default:
284 error = -EINVAL;
286 return error;
289 static char *pm_verb(int event)
291 switch (event) {
292 case PM_EVENT_SUSPEND:
293 return "suspend";
294 case PM_EVENT_RESUME:
295 return "resume";
296 case PM_EVENT_FREEZE:
297 return "freeze";
298 case PM_EVENT_QUIESCE:
299 return "quiesce";
300 case PM_EVENT_HIBERNATE:
301 return "hibernate";
302 case PM_EVENT_THAW:
303 return "thaw";
304 case PM_EVENT_RESTORE:
305 return "restore";
306 case PM_EVENT_RECOVER:
307 return "recover";
308 default:
309 return "(unknown PM event)";
313 static void pm_dev_dbg(struct device *dev, pm_message_t state, char *info)
315 dev_dbg(dev, "%s%s%s\n", info, pm_verb(state.event),
316 ((state.event & PM_EVENT_SLEEP) && device_may_wakeup(dev)) ?
317 ", may wakeup" : "");
320 static void pm_dev_err(struct device *dev, pm_message_t state, char *info,
321 int error)
323 printk(KERN_ERR "PM: Device %s failed to %s%s: error %d\n",
324 kobject_name(&dev->kobj), pm_verb(state.event), info, error);
327 /*------------------------- Resume routines -------------------------*/
330 * device_resume_noirq - Execute an "early resume" callback for given device.
331 * @dev: Device to handle.
332 * @state: PM transition of the system being carried out.
334 * The driver of @dev will not receive interrupts while this function is being
335 * executed.
337 static int device_resume_noirq(struct device *dev, pm_message_t state)
339 int error = 0;
341 TRACE_DEVICE(dev);
342 TRACE_RESUME(0);
344 if (!dev->bus)
345 goto End;
347 if (dev->bus->pm) {
348 pm_dev_dbg(dev, state, "EARLY ");
349 error = pm_noirq_op(dev, dev->bus->pm, state);
351 End:
352 TRACE_RESUME(error);
353 return error;
357 * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
358 * @state: PM transition of the system being carried out.
360 * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
361 * enable device drivers to receive interrupts.
363 void dpm_resume_noirq(pm_message_t state)
365 struct device *dev;
367 mutex_lock(&dpm_list_mtx);
368 transition_started = false;
369 list_for_each_entry(dev, &dpm_list, power.entry)
370 if (dev->power.status > DPM_OFF) {
371 int error;
373 dev->power.status = DPM_OFF;
374 error = device_resume_noirq(dev, state);
375 if (error)
376 pm_dev_err(dev, state, " early", error);
378 mutex_unlock(&dpm_list_mtx);
379 resume_device_irqs();
381 EXPORT_SYMBOL_GPL(dpm_resume_noirq);
384 * device_resume - Execute "resume" callbacks for given device.
385 * @dev: Device to handle.
386 * @state: PM transition of the system being carried out.
388 static int device_resume(struct device *dev, pm_message_t state)
390 int error = 0;
392 TRACE_DEVICE(dev);
393 TRACE_RESUME(0);
395 down(&dev->sem);
397 if (dev->bus) {
398 if (dev->bus->pm) {
399 pm_dev_dbg(dev, state, "");
400 error = pm_op(dev, dev->bus->pm, state);
401 } else if (dev->bus->resume) {
402 pm_dev_dbg(dev, state, "legacy ");
403 error = dev->bus->resume(dev);
405 if (error)
406 goto End;
409 if (dev->type) {
410 if (dev->type->pm) {
411 pm_dev_dbg(dev, state, "type ");
412 error = pm_op(dev, dev->type->pm, state);
414 if (error)
415 goto End;
418 if (dev->class) {
419 if (dev->class->pm) {
420 pm_dev_dbg(dev, state, "class ");
421 error = pm_op(dev, dev->class->pm, state);
422 } else if (dev->class->resume) {
423 pm_dev_dbg(dev, state, "legacy class ");
424 error = dev->class->resume(dev);
427 End:
428 up(&dev->sem);
430 TRACE_RESUME(error);
431 return error;
435 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
436 * @state: PM transition of the system being carried out.
438 * Execute the appropriate "resume" callback for all devices whose status
439 * indicates that they are suspended.
441 static void dpm_resume(pm_message_t state)
443 struct list_head list;
445 INIT_LIST_HEAD(&list);
446 mutex_lock(&dpm_list_mtx);
447 while (!list_empty(&dpm_list)) {
448 struct device *dev = to_device(dpm_list.next);
450 get_device(dev);
451 if (dev->power.status >= DPM_OFF) {
452 int error;
454 dev->power.status = DPM_RESUMING;
455 mutex_unlock(&dpm_list_mtx);
457 error = device_resume(dev, state);
459 mutex_lock(&dpm_list_mtx);
460 if (error)
461 pm_dev_err(dev, state, "", error);
462 } else if (dev->power.status == DPM_SUSPENDING) {
463 /* Allow new children of the device to be registered */
464 dev->power.status = DPM_RESUMING;
466 if (!list_empty(&dev->power.entry))
467 list_move_tail(&dev->power.entry, &list);
468 put_device(dev);
470 list_splice(&list, &dpm_list);
471 mutex_unlock(&dpm_list_mtx);
475 * device_complete - Complete a PM transition for given device.
476 * @dev: Device to handle.
477 * @state: PM transition of the system being carried out.
479 static void device_complete(struct device *dev, pm_message_t state)
481 down(&dev->sem);
483 if (dev->class && dev->class->pm && dev->class->pm->complete) {
484 pm_dev_dbg(dev, state, "completing class ");
485 dev->class->pm->complete(dev);
488 if (dev->type && dev->type->pm && dev->type->pm->complete) {
489 pm_dev_dbg(dev, state, "completing type ");
490 dev->type->pm->complete(dev);
493 if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
494 pm_dev_dbg(dev, state, "completing ");
495 dev->bus->pm->complete(dev);
498 up(&dev->sem);
502 * dpm_complete - Complete a PM transition for all non-sysdev devices.
503 * @state: PM transition of the system being carried out.
505 * Execute the ->complete() callbacks for all devices whose PM status is not
506 * DPM_ON (this allows new devices to be registered).
508 static void dpm_complete(pm_message_t state)
510 struct list_head list;
512 INIT_LIST_HEAD(&list);
513 mutex_lock(&dpm_list_mtx);
514 transition_started = false;
515 while (!list_empty(&dpm_list)) {
516 struct device *dev = to_device(dpm_list.prev);
518 get_device(dev);
519 if (dev->power.status > DPM_ON) {
520 dev->power.status = DPM_ON;
521 mutex_unlock(&dpm_list_mtx);
523 device_complete(dev, state);
524 pm_runtime_put_noidle(dev);
526 mutex_lock(&dpm_list_mtx);
528 if (!list_empty(&dev->power.entry))
529 list_move(&dev->power.entry, &list);
530 put_device(dev);
532 list_splice(&list, &dpm_list);
533 mutex_unlock(&dpm_list_mtx);
537 * dpm_resume_end - Execute "resume" callbacks and complete system transition.
538 * @state: PM transition of the system being carried out.
540 * Execute "resume" callbacks for all devices and complete the PM transition of
541 * the system.
543 void dpm_resume_end(pm_message_t state)
545 might_sleep();
546 dpm_resume(state);
547 dpm_complete(state);
549 EXPORT_SYMBOL_GPL(dpm_resume_end);
552 /*------------------------- Suspend routines -------------------------*/
555 * resume_event - Return a "resume" message for given "suspend" sleep state.
556 * @sleep_state: PM message representing a sleep state.
558 * Return a PM message representing the resume event corresponding to given
559 * sleep state.
561 static pm_message_t resume_event(pm_message_t sleep_state)
563 switch (sleep_state.event) {
564 case PM_EVENT_SUSPEND:
565 return PMSG_RESUME;
566 case PM_EVENT_FREEZE:
567 case PM_EVENT_QUIESCE:
568 return PMSG_RECOVER;
569 case PM_EVENT_HIBERNATE:
570 return PMSG_RESTORE;
572 return PMSG_ON;
576 * device_suspend_noirq - Execute a "late suspend" callback for given device.
577 * @dev: Device to handle.
578 * @state: PM transition of the system being carried out.
580 * The driver of @dev will not receive interrupts while this function is being
581 * executed.
583 static int device_suspend_noirq(struct device *dev, pm_message_t state)
585 int error = 0;
587 if (!dev->bus)
588 return 0;
590 if (dev->bus->pm) {
591 pm_dev_dbg(dev, state, "LATE ");
592 error = pm_noirq_op(dev, dev->bus->pm, state);
594 return error;
598 * dpm_suspend_noirq - Execute "late suspend" callbacks for non-sysdev devices.
599 * @state: PM transition of the system being carried out.
601 * Prevent device drivers from receiving interrupts and call the "noirq" suspend
602 * handlers for all non-sysdev devices.
604 int dpm_suspend_noirq(pm_message_t state)
606 struct device *dev;
607 int error = 0;
609 suspend_device_irqs();
610 mutex_lock(&dpm_list_mtx);
611 list_for_each_entry_reverse(dev, &dpm_list, power.entry) {
612 error = device_suspend_noirq(dev, state);
613 if (error) {
614 pm_dev_err(dev, state, " late", error);
615 break;
617 dev->power.status = DPM_OFF_IRQ;
619 mutex_unlock(&dpm_list_mtx);
620 if (error)
621 dpm_resume_noirq(resume_event(state));
622 return error;
624 EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
627 * device_suspend - Execute "suspend" callbacks for given device.
628 * @dev: Device to handle.
629 * @state: PM transition of the system being carried out.
631 static int device_suspend(struct device *dev, pm_message_t state)
633 int error = 0;
635 down(&dev->sem);
637 if (dev->class) {
638 if (dev->class->pm) {
639 pm_dev_dbg(dev, state, "class ");
640 error = pm_op(dev, dev->class->pm, state);
641 } else if (dev->class->suspend) {
642 pm_dev_dbg(dev, state, "legacy class ");
643 error = dev->class->suspend(dev, state);
644 suspend_report_result(dev->class->suspend, error);
646 if (error)
647 goto End;
650 if (dev->type) {
651 if (dev->type->pm) {
652 pm_dev_dbg(dev, state, "type ");
653 error = pm_op(dev, dev->type->pm, state);
655 if (error)
656 goto End;
659 if (dev->bus) {
660 if (dev->bus->pm) {
661 pm_dev_dbg(dev, state, "");
662 error = pm_op(dev, dev->bus->pm, state);
663 } else if (dev->bus->suspend) {
664 pm_dev_dbg(dev, state, "legacy ");
665 error = dev->bus->suspend(dev, state);
666 suspend_report_result(dev->bus->suspend, error);
669 End:
670 up(&dev->sem);
672 return error;
676 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
677 * @state: PM transition of the system being carried out.
679 static int dpm_suspend(pm_message_t state)
681 struct list_head list;
682 int error = 0;
684 INIT_LIST_HEAD(&list);
685 mutex_lock(&dpm_list_mtx);
686 while (!list_empty(&dpm_list)) {
687 struct device *dev = to_device(dpm_list.prev);
689 get_device(dev);
690 mutex_unlock(&dpm_list_mtx);
692 error = device_suspend(dev, state);
694 mutex_lock(&dpm_list_mtx);
695 if (error) {
696 pm_dev_err(dev, state, "", error);
697 put_device(dev);
698 break;
700 dev->power.status = DPM_OFF;
701 if (!list_empty(&dev->power.entry))
702 list_move(&dev->power.entry, &list);
703 put_device(dev);
705 list_splice(&list, dpm_list.prev);
706 mutex_unlock(&dpm_list_mtx);
707 return error;
711 * device_prepare - Prepare a device for system power transition.
712 * @dev: Device to handle.
713 * @state: PM transition of the system being carried out.
715 * Execute the ->prepare() callback(s) for given device. No new children of the
716 * device may be registered after this function has returned.
718 static int device_prepare(struct device *dev, pm_message_t state)
720 int error = 0;
722 down(&dev->sem);
724 if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
725 pm_dev_dbg(dev, state, "preparing ");
726 error = dev->bus->pm->prepare(dev);
727 suspend_report_result(dev->bus->pm->prepare, error);
728 if (error)
729 goto End;
732 if (dev->type && dev->type->pm && dev->type->pm->prepare) {
733 pm_dev_dbg(dev, state, "preparing type ");
734 error = dev->type->pm->prepare(dev);
735 suspend_report_result(dev->type->pm->prepare, error);
736 if (error)
737 goto End;
740 if (dev->class && dev->class->pm && dev->class->pm->prepare) {
741 pm_dev_dbg(dev, state, "preparing class ");
742 error = dev->class->pm->prepare(dev);
743 suspend_report_result(dev->class->pm->prepare, error);
745 End:
746 up(&dev->sem);
748 return error;
752 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
753 * @state: PM transition of the system being carried out.
755 * Execute the ->prepare() callback(s) for all devices.
757 static int dpm_prepare(pm_message_t state)
759 struct list_head list;
760 int error = 0;
762 INIT_LIST_HEAD(&list);
763 mutex_lock(&dpm_list_mtx);
764 transition_started = true;
765 while (!list_empty(&dpm_list)) {
766 struct device *dev = to_device(dpm_list.next);
768 get_device(dev);
769 dev->power.status = DPM_PREPARING;
770 mutex_unlock(&dpm_list_mtx);
772 pm_runtime_get_noresume(dev);
773 if (pm_runtime_barrier(dev) && device_may_wakeup(dev)) {
774 /* Wake-up requested during system sleep transition. */
775 pm_runtime_put_noidle(dev);
776 error = -EBUSY;
777 } else {
778 error = device_prepare(dev, state);
781 mutex_lock(&dpm_list_mtx);
782 if (error) {
783 dev->power.status = DPM_ON;
784 if (error == -EAGAIN) {
785 put_device(dev);
786 error = 0;
787 continue;
789 printk(KERN_ERR "PM: Failed to prepare device %s "
790 "for power transition: error %d\n",
791 kobject_name(&dev->kobj), error);
792 put_device(dev);
793 break;
795 dev->power.status = DPM_SUSPENDING;
796 if (!list_empty(&dev->power.entry))
797 list_move_tail(&dev->power.entry, &list);
798 put_device(dev);
800 list_splice(&list, &dpm_list);
801 mutex_unlock(&dpm_list_mtx);
802 return error;
806 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
807 * @state: PM transition of the system being carried out.
809 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
810 * callbacks for them.
812 int dpm_suspend_start(pm_message_t state)
814 int error;
816 might_sleep();
817 error = dpm_prepare(state);
818 if (!error)
819 error = dpm_suspend(state);
820 return error;
822 EXPORT_SYMBOL_GPL(dpm_suspend_start);
824 void __suspend_report_result(const char *function, void *fn, int ret)
826 if (ret)
827 printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
829 EXPORT_SYMBOL_GPL(__suspend_report_result);