ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / base / power / suspend.c
1 /*
2  * suspend.c - Functions for putting devices to sleep. 
3  *
4  * Copyright (c) 2003 Patrick Mochel
5  * Copyright (c) 2003 Open Source Development Labs
6  *
7  * This file is released under the GPLv2
8  *
9  */
10
11 #include <linux/device.h>
12 #include "power.h"
13  
14 extern int sysdev_suspend(u32 state);
15
16 /*
17  * The entries in the dpm_active list are in a depth first order, simply
18  * because children are guaranteed to be discovered after parents, and 
19  * are inserted at the back of the list on discovery. 
20  * 
21  * All list on the suspend path are done in reverse order, so we operate
22  * on the leaves of the device tree (or forests, depending on how you want
23  * to look at it ;) first. As nodes are removed from the back of the list, 
24  * they are inserted into the front of their destintation lists. 
25  *
26  * Things are the reverse on the resume path - iterations are done in
27  * forward order, and nodes are inserted at the back of their destination
28  * lists. This way, the ancestors will be accessed before their descendents.
29  */
30
31
32 /**
33  *      suspend_device - Save state of one device.
34  *      @dev:   Device.
35  *      @state: Power state device is entering.
36  */
37
38 int suspend_device(struct device * dev, u32 state)
39 {
40         int error = 0;
41
42         if (dev->bus && dev->bus->suspend)
43                 error = dev->bus->suspend(dev,state);
44
45         if (!error) {
46                 list_del(&dev->power.entry);
47                 list_add(&dev->power.entry,&dpm_off);
48         } else if (error == -EAGAIN) {
49                 list_del(&dev->power.entry);
50                 list_add(&dev->power.entry,&dpm_off_irq);
51         }
52         return error;
53 }
54
55
56 /**
57  *      device_suspend - Save state and stop all devices in system.
58  *      @state:         Power state to put each device in. 
59  *
60  *      Walk the dpm_active list, call ->suspend() for each device, and move
61  *      it to dpm_off. 
62  *      Check the return value for each. If it returns 0, then we move the
63  *      the device to the dpm_off list. If it returns -EAGAIN, we move it to 
64  *      the dpm_off_irq list. If we get a different error, try and back out. 
65  *
66  *      If we hit a failure with any of the devices, call device_resume()
67  *      above to bring the suspended devices back to life. 
68  *
69  *      Note this function leaves dpm_sem held to
70  *      a) block other devices from registering.
71  *      b) prevent other PM operations from happening after we've begun.
72  *      c) make sure we're exclusive when we disable interrupts.
73  *
74  */
75
76 int device_suspend(u32 state)
77 {
78         int error = 0;
79
80         down(&dpm_sem);
81         while(!list_empty(&dpm_active)) {
82                 struct list_head * entry = dpm_active.prev;
83                 struct device * dev = to_device(entry);
84                 if ((error = suspend_device(dev,state))) {
85                         if (error != -EAGAIN)
86                                 goto Error;
87                         else
88                                 error = 0;
89                 }
90         }
91  Done:
92         up(&dpm_sem);
93         return error;
94  Error:
95         dpm_resume();
96         goto Done;
97 }
98
99 EXPORT_SYMBOL(device_suspend);
100
101
102 /**
103  *      device_power_down - Shut down special devices.
104  *      @state:         Power state to enter.
105  *
106  *      Walk the dpm_off_irq list, calling ->power_down() for each device that
107  *      couldn't power down the device with interrupts enabled. When we're 
108  *      done, power down system devices. 
109  */
110
111 int device_power_down(u32 state)
112 {
113         int error = 0;
114         struct device * dev;
115
116         list_for_each_entry_reverse(dev,&dpm_off_irq,power.entry) {
117                 if ((error = suspend_device(dev,state)))
118                         break;
119         } 
120         if (error)
121                 goto Error;
122         if ((error = sysdev_suspend(state)))
123                 goto Error;
124  Done:
125         return error;
126  Error:
127         dpm_power_up();
128         goto Done;
129 }
130
131 EXPORT_SYMBOL(device_power_down);
132