[PATCH] introduce .valid callback for pm_ops
[linux-2.6.git] / include / linux / pm.h
1 /*
2  *  pm.h - Power management interface
3  *
4  *  Copyright (C) 2000 Andrew Henroid
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef _LINUX_PM_H
22 #define _LINUX_PM_H
23
24 #ifdef __KERNEL__
25
26 #include <linux/config.h>
27 #include <linux/list.h>
28 #include <asm/atomic.h>
29
30 /*
31  * Power management requests... these are passed to pm_send_all() and friends.
32  *
33  * these functions are old and deprecated, see below.
34  */
35 typedef int __bitwise pm_request_t;
36
37 #define PM_SUSPEND      ((__force pm_request_t) 1)      /* enter D1-D3 */
38 #define PM_RESUME       ((__force pm_request_t) 2)      /* enter D0 */
39
40
41 /*
42  * Device types... these are passed to pm_register
43  */
44 typedef int __bitwise pm_dev_t;
45
46 #define PM_UNKNOWN_DEV  ((__force pm_dev_t) 0)  /* generic */
47 #define PM_SYS_DEV      ((__force pm_dev_t) 1)  /* system device (fan, KB controller, ...) */
48 #define PM_PCI_DEV      ((__force pm_dev_t) 2)  /* PCI device */
49 #define PM_USB_DEV      ((__force pm_dev_t) 3)  /* USB device */
50 #define PM_SCSI_DEV     ((__force pm_dev_t) 4)  /* SCSI device */
51 #define PM_ISA_DEV      ((__force pm_dev_t) 5)  /* ISA device */
52 #define PM_MTD_DEV      ((__force pm_dev_t) 6)  /* Memory Technology Device */
53
54 /*
55  * System device hardware ID (PnP) values
56  */
57 enum
58 {
59         PM_SYS_UNKNOWN = 0x00000000, /* generic */
60         PM_SYS_KBC =     0x41d00303, /* keyboard controller */
61         PM_SYS_COM =     0x41d00500, /* serial port */
62         PM_SYS_IRDA =    0x41d00510, /* IRDA controller */
63         PM_SYS_FDC =     0x41d00700, /* floppy controller */
64         PM_SYS_VGA =     0x41d00900, /* VGA controller */
65         PM_SYS_PCMCIA =  0x41d00e00, /* PCMCIA controller */
66 };
67
68 /*
69  * Device identifier
70  */
71 #define PM_PCI_ID(dev) ((dev)->bus->number << 16 | (dev)->devfn)
72
73 /*
74  * Request handler callback
75  */
76 struct pm_dev;
77
78 typedef int (*pm_callback)(struct pm_dev *dev, pm_request_t rqst, void *data);
79
80 /*
81  * Dynamic device information
82  */
83 struct pm_dev
84 {
85         pm_dev_t         type;
86         unsigned long    id;
87         pm_callback      callback;
88         void            *data;
89
90         unsigned long    flags;
91         unsigned long    state;
92         unsigned long    prev_state;
93
94         struct list_head entry;
95 };
96
97 #ifdef CONFIG_PM
98
99 extern int pm_active;
100
101 #define PM_IS_ACTIVE() (pm_active != 0)
102
103 /*
104  * Register a device with power management
105  */
106 struct pm_dev __deprecated *
107 pm_register(pm_dev_t type, unsigned long id, pm_callback callback);
108
109 /*
110  * Unregister a device with power management
111  */
112 void __deprecated pm_unregister(struct pm_dev *dev);
113
114 /*
115  * Unregister all devices with matching callback
116  */
117 void __deprecated pm_unregister_all(pm_callback callback);
118
119 /*
120  * Send a request to all devices
121  */
122 int __deprecated pm_send_all(pm_request_t rqst, void *data);
123
124 #else /* CONFIG_PM */
125
126 #define PM_IS_ACTIVE() 0
127
128 static inline struct pm_dev *pm_register(pm_dev_t type,
129                                          unsigned long id,
130                                          pm_callback callback)
131 {
132         return NULL;
133 }
134
135 static inline void pm_unregister(struct pm_dev *dev) {}
136
137 static inline void pm_unregister_all(pm_callback callback) {}
138
139 static inline int pm_send_all(pm_request_t rqst, void *data)
140 {
141         return 0;
142 }
143
144 #endif /* CONFIG_PM */
145
146 /* Functions above this comment are list-based old-style power
147  * managment. Please avoid using them.  */
148
149 /*
150  * Callbacks for platform drivers to implement.
151  */
152 extern void (*pm_idle)(void);
153 extern void (*pm_power_off)(void);
154
155 typedef int __bitwise suspend_state_t;
156
157 #define PM_SUSPEND_ON           ((__force suspend_state_t) 0)
158 #define PM_SUSPEND_STANDBY      ((__force suspend_state_t) 1)
159 #define PM_SUSPEND_MEM          ((__force suspend_state_t) 3)
160 #define PM_SUSPEND_DISK         ((__force suspend_state_t) 4)
161 #define PM_SUSPEND_MAX          ((__force suspend_state_t) 5)
162
163 typedef int __bitwise suspend_disk_method_t;
164
165 #define PM_DISK_FIRMWARE        ((__force suspend_disk_method_t) 1)
166 #define PM_DISK_PLATFORM        ((__force suspend_disk_method_t) 2)
167 #define PM_DISK_SHUTDOWN        ((__force suspend_disk_method_t) 3)
168 #define PM_DISK_REBOOT          ((__force suspend_disk_method_t) 4)
169 #define PM_DISK_MAX             ((__force suspend_disk_method_t) 5)
170
171 struct pm_ops {
172         suspend_disk_method_t pm_disk_mode;
173         int (*valid)(suspend_state_t state);
174         int (*prepare)(suspend_state_t state);
175         int (*enter)(suspend_state_t state);
176         int (*finish)(suspend_state_t state);
177 };
178
179 extern void pm_set_ops(struct pm_ops *);
180 extern struct pm_ops *pm_ops;
181 extern int pm_suspend(suspend_state_t state);
182
183
184 /*
185  * Device power management
186  */
187
188 struct device;
189
190 typedef struct pm_message {
191         int event;
192 } pm_message_t;
193
194 /*
195  * There are 4 important states driver can be in:
196  * ON     -- driver is working
197  * FREEZE -- stop operations and apply whatever policy is applicable to a
198  *           suspended driver of that class, freeze queues for block like IDE
199  *           does, drop packets for ethernet, etc... stop DMA engine too etc...
200  *           so a consistent image can be saved; but do not power any hardware
201  *           down.
202  * SUSPEND - like FREEZE, but hardware is doing as much powersaving as
203  *           possible. Roughly pci D3.
204  *
205  * Unfortunately, current drivers only recognize numeric values 0 (ON) and 3
206  * (SUSPEND).  We'll need to fix the drivers. So yes, putting 3 to all different
207  * defines is intentional, and will go away as soon as drivers are fixed.  Also
208  * note that typedef is neccessary, we'll probably want to switch to
209  *   typedef struct pm_message_t { int event; int flags; } pm_message_t
210  * or something similar soon.
211  */
212
213 #define PM_EVENT_ON 0
214 #define PM_EVENT_FREEZE 1
215 #define PM_EVENT_SUSPEND 2
216
217 #define PMSG_FREEZE     ((struct pm_message){ .event = PM_EVENT_FREEZE, })
218 #define PMSG_SUSPEND    ((struct pm_message){ .event = PM_EVENT_SUSPEND, })
219 #define PMSG_ON         ((struct pm_message){ .event = PM_EVENT_ON, })
220
221 struct dev_pm_info {
222         pm_message_t            power_state;
223         unsigned                can_wakeup:1;
224 #ifdef  CONFIG_PM
225         unsigned                should_wakeup:1;
226         pm_message_t            prev_state;
227         void                    * saved_state;
228         struct device           * pm_parent;
229         struct list_head        entry;
230 #endif
231 };
232
233 extern void device_pm_set_parent(struct device * dev, struct device * parent);
234
235 extern int device_power_down(pm_message_t state);
236 extern void device_power_up(void);
237 extern void device_resume(void);
238
239 #ifdef CONFIG_PM
240 extern int device_suspend(pm_message_t state);
241
242 #define device_set_wakeup_enable(dev,val) \
243         ((dev)->power.should_wakeup = !!(val))
244 #define device_may_wakeup(dev) \
245         (device_can_wakeup(dev) && (dev)->power.should_wakeup)
246
247 extern int dpm_runtime_suspend(struct device *, pm_message_t);
248 extern void dpm_runtime_resume(struct device *);
249
250 #else /* !CONFIG_PM */
251
252 static inline int device_suspend(pm_message_t state)
253 {
254         return 0;
255 }
256
257 #define device_set_wakeup_enable(dev,val)       do{}while(0)
258 #define device_may_wakeup(dev)                  (0)
259
260 static inline int dpm_runtime_suspend(struct device * dev, pm_message_t state)
261 {
262         return 0;
263 }
264
265 static inline void dpm_runtime_resume(struct device * dev)
266 {
267
268 }
269
270 #endif
271
272 /* changes to device_may_wakeup take effect on the next pm state change.
273  * by default, devices should wakeup if they can.
274  */
275 #define device_can_wakeup(dev) \
276         ((dev)->power.can_wakeup)
277 #define device_init_wakeup(dev,val) \
278         do { \
279                 device_can_wakeup(dev) = !!(val); \
280                 device_set_wakeup_enable(dev,val); \
281         } while(0)
282
283 #endif /* __KERNEL__ */
284
285 #endif /* _LINUX_PM_H */