rework pm_ops pm_disk_mode, kill misuse
[linux-3.10.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/list.h>
27 #include <asm/atomic.h>
28
29 /*
30  * Power management requests... these are passed to pm_send_all() and friends.
31  *
32  * these functions are old and deprecated, see below.
33  */
34 typedef int __bitwise pm_request_t;
35
36 #define PM_SUSPEND      ((__force pm_request_t) 1)      /* enter D1-D3 */
37 #define PM_RESUME       ((__force pm_request_t) 2)      /* enter D0 */
38
39
40 /*
41  * Device types... these are passed to pm_register
42  */
43 typedef int __bitwise pm_dev_t;
44
45 #define PM_UNKNOWN_DEV  ((__force pm_dev_t) 0)  /* generic */
46 #define PM_SYS_DEV      ((__force pm_dev_t) 1)  /* system device (fan, KB controller, ...) */
47 #define PM_PCI_DEV      ((__force pm_dev_t) 2)  /* PCI device */
48 #define PM_USB_DEV      ((__force pm_dev_t) 3)  /* USB device */
49 #define PM_SCSI_DEV     ((__force pm_dev_t) 4)  /* SCSI device */
50 #define PM_ISA_DEV      ((__force pm_dev_t) 5)  /* ISA device */
51 #define PM_MTD_DEV      ((__force pm_dev_t) 6)  /* Memory Technology Device */
52
53 /*
54  * System device hardware ID (PnP) values
55  */
56 enum
57 {
58         PM_SYS_UNKNOWN = 0x00000000, /* generic */
59         PM_SYS_KBC =     0x41d00303, /* keyboard controller */
60         PM_SYS_COM =     0x41d00500, /* serial port */
61         PM_SYS_IRDA =    0x41d00510, /* IRDA controller */
62         PM_SYS_FDC =     0x41d00700, /* floppy controller */
63         PM_SYS_VGA =     0x41d00900, /* VGA controller */
64         PM_SYS_PCMCIA =  0x41d00e00, /* PCMCIA controller */
65 };
66
67 /*
68  * Device identifier
69  */
70 #define PM_PCI_ID(dev) ((dev)->bus->number << 16 | (dev)->devfn)
71
72 /*
73  * Request handler callback
74  */
75 struct pm_dev;
76
77 typedef int (*pm_callback)(struct pm_dev *dev, pm_request_t rqst, void *data);
78
79 /*
80  * Dynamic device information
81  */
82 struct pm_dev
83 {
84         pm_dev_t         type;
85         unsigned long    id;
86         pm_callback      callback;
87         void            *data;
88
89         unsigned long    flags;
90         unsigned long    state;
91         unsigned long    prev_state;
92
93         struct list_head entry;
94 };
95
96 /* Functions above this comment are list-based old-style power
97  * managment. Please avoid using them.  */
98
99 /*
100  * Callbacks for platform drivers to implement.
101  */
102 extern void (*pm_idle)(void);
103 extern void (*pm_power_off)(void);
104
105 typedef int __bitwise suspend_state_t;
106
107 #define PM_SUSPEND_ON           ((__force suspend_state_t) 0)
108 #define PM_SUSPEND_STANDBY      ((__force suspend_state_t) 1)
109 #define PM_SUSPEND_MEM          ((__force suspend_state_t) 3)
110 #define PM_SUSPEND_DISK         ((__force suspend_state_t) 4)
111 #define PM_SUSPEND_MAX          ((__force suspend_state_t) 5)
112
113 typedef int __bitwise suspend_disk_method_t;
114
115 /* invalid must be 0 so struct pm_ops initialisers can leave it out */
116 #define PM_DISK_INVALID         ((__force suspend_disk_method_t) 0)
117 #define PM_DISK_FIRMWARE        ((__force suspend_disk_method_t) 1)
118 #define PM_DISK_PLATFORM        ((__force suspend_disk_method_t) 2)
119 #define PM_DISK_SHUTDOWN        ((__force suspend_disk_method_t) 3)
120 #define PM_DISK_REBOOT          ((__force suspend_disk_method_t) 4)
121 #define PM_DISK_TEST            ((__force suspend_disk_method_t) 5)
122 #define PM_DISK_TESTPROC        ((__force suspend_disk_method_t) 6)
123 #define PM_DISK_MAX             ((__force suspend_disk_method_t) 7)
124
125 /**
126  * struct pm_ops - Callbacks for managing platform dependent suspend states.
127  * @valid: Callback to determine whether the given state can be entered.
128  *      If %CONFIG_SOFTWARE_SUSPEND is set then %PM_SUSPEND_DISK is
129  *      always valid and never passed to this call.
130  *      If not assigned, all suspend states are advertised as valid
131  *      in /sys/power/state (but can still be rejected by prepare or enter.)
132  *
133  * @prepare: Prepare the platform for the given suspend state. Can return a
134  *      negative error code if necessary.
135  *
136  * @enter: Enter the given suspend state, must be assigned. Can return a
137  *      negative error code if necessary.
138  *
139  * @finish: Called when the system has left the given state and all devices
140  *      are resumed. The return value is ignored.
141  *
142  * @pm_disk_mode: The generic code always allows one of the shutdown methods
143  *      %PM_DISK_SHUTDOWN, %PM_DISK_REBOOT, %PM_DISK_TEST and
144  *      %PM_DISK_TESTPROC. If this variable is set, the mode it is set
145  *      to is allowed in addition to those modes and is also made default.
146  *      When this mode is sent selected, the @prepare call will be called
147  *      before suspending to disk (if present), the @enter call should be
148  *      present and will be called after all state has been saved and the
149  *      machine is ready to be powered off; the @finish callback is called
150  *      after state has been restored. All these calls are called with
151  *      %PM_SUSPEND_DISK as the state.
152  */
153 struct pm_ops {
154         int (*valid)(suspend_state_t state);
155         int (*prepare)(suspend_state_t state);
156         int (*enter)(suspend_state_t state);
157         int (*finish)(suspend_state_t state);
158         suspend_disk_method_t pm_disk_mode;
159 };
160
161 /**
162  * pm_set_ops - set platform dependent power management ops
163  * @pm_ops: The new power management operations to set.
164  */
165 extern void pm_set_ops(struct pm_ops *pm_ops);
166 extern struct pm_ops *pm_ops;
167 extern int pm_suspend(suspend_state_t state);
168
169
170 /**
171  * arch_suspend_disable_irqs - disable IRQs for suspend
172  *
173  * Disables IRQs (in the default case). This is a weak symbol in the common
174  * code and thus allows architectures to override it if more needs to be
175  * done. Not called for suspend to disk.
176  */
177 extern void arch_suspend_disable_irqs(void);
178
179 /**
180  * arch_suspend_enable_irqs - enable IRQs after suspend
181  *
182  * Enables IRQs (in the default case). This is a weak symbol in the common
183  * code and thus allows architectures to override it if more needs to be
184  * done. Not called for suspend to disk.
185  */
186 extern void arch_suspend_enable_irqs(void);
187
188 /*
189  * Device power management
190  */
191
192 struct device;
193
194 typedef struct pm_message {
195         int event;
196 } pm_message_t;
197
198 /*
199  * Several driver power state transitions are externally visible, affecting
200  * the state of pending I/O queues and (for drivers that touch hardware)
201  * interrupts, wakeups, DMA, and other hardware state.  There may also be
202  * internal transitions to various low power modes, which are transparent
203  * to the rest of the driver stack (such as a driver that's ON gating off
204  * clocks which are not in active use).
205  *
206  * One transition is triggered by resume(), after a suspend() call; the
207  * message is implicit:
208  *
209  * ON           Driver starts working again, responding to hardware events
210  *              and software requests.  The hardware may have gone through
211  *              a power-off reset, or it may have maintained state from the
212  *              previous suspend() which the driver will rely on while
213  *              resuming.  On most platforms, there are no restrictions on
214  *              availability of resources like clocks during resume().
215  *
216  * Other transitions are triggered by messages sent using suspend().  All
217  * these transitions quiesce the driver, so that I/O queues are inactive.
218  * That commonly entails turning off IRQs and DMA; there may be rules
219  * about how to quiesce that are specific to the bus or the device's type.
220  * (For example, network drivers mark the link state.)  Other details may
221  * differ according to the message:
222  *
223  * SUSPEND      Quiesce, enter a low power device state appropriate for
224  *              the upcoming system state (such as PCI_D3hot), and enable
225  *              wakeup events as appropriate.
226  *
227  * FREEZE       Quiesce operations so that a consistent image can be saved;
228  *              but do NOT otherwise enter a low power device state, and do
229  *              NOT emit system wakeup events.
230  *
231  * PRETHAW      Quiesce as if for FREEZE; additionally, prepare for restoring
232  *              the system from a snapshot taken after an earlier FREEZE.
233  *              Some drivers will need to reset their hardware state instead
234  *              of preserving it, to ensure that it's never mistaken for the
235  *              state which that earlier snapshot had set up.
236  *
237  * A minimally power-aware driver treats all messages as SUSPEND, fully
238  * reinitializes its device during resume() -- whether or not it was reset
239  * during the suspend/resume cycle -- and can't issue wakeup events.
240  *
241  * More power-aware drivers may also use low power states at runtime as
242  * well as during system sleep states like PM_SUSPEND_STANDBY.  They may
243  * be able to use wakeup events to exit from runtime low-power states,
244  * or from system low-power states such as standby or suspend-to-RAM.
245  */
246
247 #define PM_EVENT_ON 0
248 #define PM_EVENT_FREEZE 1
249 #define PM_EVENT_SUSPEND 2
250 #define PM_EVENT_PRETHAW 3
251
252 #define PMSG_FREEZE     ((struct pm_message){ .event = PM_EVENT_FREEZE, })
253 #define PMSG_PRETHAW    ((struct pm_message){ .event = PM_EVENT_PRETHAW, })
254 #define PMSG_SUSPEND    ((struct pm_message){ .event = PM_EVENT_SUSPEND, })
255 #define PMSG_ON         ((struct pm_message){ .event = PM_EVENT_ON, })
256
257 struct dev_pm_info {
258         pm_message_t            power_state;
259         unsigned                can_wakeup:1;
260 #ifdef  CONFIG_PM
261         unsigned                should_wakeup:1;
262         pm_message_t            prev_state;
263         void                    * saved_state;
264         struct device           * pm_parent;
265         struct list_head        entry;
266 #endif
267 };
268
269 extern void device_pm_set_parent(struct device * dev, struct device * parent);
270
271 extern int device_power_down(pm_message_t state);
272 extern void device_power_up(void);
273 extern void device_resume(void);
274
275 #ifdef CONFIG_PM
276 extern suspend_disk_method_t pm_disk_mode;
277
278 extern int device_suspend(pm_message_t state);
279 extern int device_prepare_suspend(pm_message_t state);
280
281 #define device_set_wakeup_enable(dev,val) \
282         ((dev)->power.should_wakeup = !!(val))
283 #define device_may_wakeup(dev) \
284         (device_can_wakeup(dev) && (dev)->power.should_wakeup)
285
286 extern int dpm_runtime_suspend(struct device *, pm_message_t);
287 extern void dpm_runtime_resume(struct device *);
288 extern void __suspend_report_result(const char *function, void *fn, int ret);
289
290 #define suspend_report_result(fn, ret)                                  \
291         do {                                                            \
292                 __suspend_report_result(__FUNCTION__, fn, ret);         \
293         } while (0)
294
295 /*
296  * Platform hook to activate device wakeup capability, if that's not already
297  * handled by enable_irq_wake() etc.
298  * Returns zero on success, else negative errno
299  */
300 extern int (*platform_enable_wakeup)(struct device *dev, int is_on);
301
302 static inline int call_platform_enable_wakeup(struct device *dev, int is_on)
303 {
304         if (platform_enable_wakeup)
305                 return (*platform_enable_wakeup)(dev, is_on);
306         return 0;
307 }
308
309 #else /* !CONFIG_PM */
310
311 static inline int device_suspend(pm_message_t state)
312 {
313         return 0;
314 }
315
316 #define device_set_wakeup_enable(dev,val)       do{}while(0)
317 #define device_may_wakeup(dev)                  (0)
318
319 static inline int dpm_runtime_suspend(struct device * dev, pm_message_t state)
320 {
321         return 0;
322 }
323
324 static inline void dpm_runtime_resume(struct device * dev)
325 {
326 }
327
328 #define suspend_report_result(fn, ret) do { } while (0)
329
330 static inline int call_platform_enable_wakeup(struct device *dev, int is_on)
331 {
332         return -EIO;
333 }
334
335 #endif
336
337 /* changes to device_may_wakeup take effect on the next pm state change.
338  * by default, devices should wakeup if they can.
339  */
340 #define device_can_wakeup(dev) \
341         ((dev)->power.can_wakeup)
342 #define device_init_wakeup(dev,val) \
343         do { \
344                 device_can_wakeup(dev) = !!(val); \
345                 device_set_wakeup_enable(dev,val); \
346         } while(0)
347
348 #endif /* __KERNEL__ */
349
350 #endif /* _LINUX_PM_H */