Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
1da177e4 | 24 | #include <linux/list.h> |
5e928f77 RW |
25 | #include <linux/workqueue.h> |
26 | #include <linux/spinlock.h> | |
27 | #include <linux/wait.h> | |
28 | #include <linux/timer.h> | |
5af84b82 | 29 | #include <linux/completion.h> |
1da177e4 | 30 | |
1da177e4 LT |
31 | /* |
32 | * Callbacks for platform drivers to implement. | |
33 | */ | |
34 | extern void (*pm_idle)(void); | |
35 | extern void (*pm_power_off)(void); | |
bd804eba | 36 | extern void (*pm_power_off_prepare)(void); |
1da177e4 | 37 | |
1da177e4 LT |
38 | /* |
39 | * Device power management | |
40 | */ | |
41 | ||
42 | struct device; | |
43 | ||
7490e442 AS |
44 | #ifdef CONFIG_PM |
45 | extern const char power_group_name[]; /* = "power" */ | |
dbf37414 RW |
46 | |
47 | extern void dev_pm_syscore_device(struct device *dev, bool val); | |
7490e442 AS |
48 | #else |
49 | #define power_group_name NULL | |
dbf37414 RW |
50 | |
51 | static inline void dev_pm_syscore_device(struct device *dev, bool val) {} | |
7490e442 AS |
52 | #endif |
53 | ||
ca078bae PM |
54 | typedef struct pm_message { |
55 | int event; | |
56 | } pm_message_t; | |
1da177e4 | 57 | |
1eede070 | 58 | /** |
adf09493 | 59 | * struct dev_pm_ops - device PM callbacks |
1eede070 | 60 | * |
f7bc83d8 | 61 | * Several device power state transitions are externally visible, affecting |
82bb67f2 DB |
62 | * the state of pending I/O queues and (for drivers that touch hardware) |
63 | * interrupts, wakeups, DMA, and other hardware state. There may also be | |
f7bc83d8 | 64 | * internal transitions to various low-power modes which are transparent |
82bb67f2 DB |
65 | * to the rest of the driver stack (such as a driver that's ON gating off |
66 | * clocks which are not in active use). | |
1da177e4 | 67 | * |
f7bc83d8 RW |
68 | * The externally visible transitions are handled with the help of callbacks |
69 | * included in this structure in such a way that two levels of callbacks are | |
70 | * involved. First, the PM core executes callbacks provided by PM domains, | |
71 | * device types, classes and bus types. They are the subsystem-level callbacks | |
72 | * supposed to execute callbacks provided by device drivers, although they may | |
73 | * choose not to do that. If the driver callbacks are executed, they have to | |
74 | * collaborate with the subsystem-level callbacks to achieve the goals | |
75 | * appropriate for the given system transition, given transition phase and the | |
76 | * subsystem the device belongs to. | |
77 | * | |
78 | * @prepare: The principal role of this callback is to prevent new children of | |
79 | * the device from being registered after it has returned (the driver's | |
80 | * subsystem and generally the rest of the kernel is supposed to prevent | |
81 | * new calls to the probe method from being made too once @prepare() has | |
82 | * succeeded). If @prepare() detects a situation it cannot handle (e.g. | |
83 | * registration of a child already in progress), it may return -EAGAIN, so | |
84 | * that the PM core can execute it once again (e.g. after a new child has | |
85 | * been registered) to recover from the race condition. | |
86 | * This method is executed for all kinds of suspend transitions and is | |
87 | * followed by one of the suspend callbacks: @suspend(), @freeze(), or | |
88 | * @poweroff(). The PM core executes subsystem-level @prepare() for all | |
89 | * devices before starting to invoke suspend callbacks for any of them, so | |
90 | * generally devices may be assumed to be functional or to respond to | |
91 | * runtime resume requests while @prepare() is being executed. However, | |
92 | * device drivers may NOT assume anything about the availability of user | |
93 | * space at that time and it is NOT valid to request firmware from within | |
94 | * @prepare() (it's too late to do that). It also is NOT valid to allocate | |
95 | * substantial amounts of memory from @prepare() in the GFP_KERNEL mode. | |
96 | * [To work around these limitations, drivers may register suspend and | |
97 | * hibernation notifiers to be executed before the freezing of tasks.] | |
1eede070 RW |
98 | * |
99 | * @complete: Undo the changes made by @prepare(). This method is executed for | |
100 | * all kinds of resume transitions, following one of the resume callbacks: | |
101 | * @resume(), @thaw(), @restore(). Also called if the state transition | |
f7bc83d8 RW |
102 | * fails before the driver's suspend callback: @suspend(), @freeze() or |
103 | * @poweroff(), can be executed (e.g. if the suspend callback fails for one | |
1eede070 RW |
104 | * of the other devices that the PM core has unsuccessfully attempted to |
105 | * suspend earlier). | |
f7bc83d8 RW |
106 | * The PM core executes subsystem-level @complete() after it has executed |
107 | * the appropriate resume callbacks for all devices. | |
1eede070 RW |
108 | * |
109 | * @suspend: Executed before putting the system into a sleep state in which the | |
f7bc83d8 RW |
110 | * contents of main memory are preserved. The exact action to perform |
111 | * depends on the device's subsystem (PM domain, device type, class or bus | |
112 | * type), but generally the device must be quiescent after subsystem-level | |
113 | * @suspend() has returned, so that it doesn't do any I/O or DMA. | |
114 | * Subsystem-level @suspend() is executed for all devices after invoking | |
115 | * subsystem-level @prepare() for all of them. | |
1eede070 | 116 | * |
cf579dfb RW |
117 | * @suspend_late: Continue operations started by @suspend(). For a number of |
118 | * devices @suspend_late() may point to the same callback routine as the | |
119 | * runtime suspend callback. | |
120 | * | |
1eede070 | 121 | * @resume: Executed after waking the system up from a sleep state in which the |
f7bc83d8 RW |
122 | * contents of main memory were preserved. The exact action to perform |
123 | * depends on the device's subsystem, but generally the driver is expected | |
124 | * to start working again, responding to hardware events and software | |
125 | * requests (the device itself may be left in a low-power state, waiting | |
126 | * for a runtime resume to occur). The state of the device at the time its | |
127 | * driver's @resume() callback is run depends on the platform and subsystem | |
128 | * the device belongs to. On most platforms, there are no restrictions on | |
129 | * availability of resources like clocks during @resume(). | |
130 | * Subsystem-level @resume() is executed for all devices after invoking | |
131 | * subsystem-level @resume_noirq() for all of them. | |
1eede070 | 132 | * |
cf579dfb RW |
133 | * @resume_early: Prepare to execute @resume(). For a number of devices |
134 | * @resume_early() may point to the same callback routine as the runtime | |
135 | * resume callback. | |
136 | * | |
1eede070 | 137 | * @freeze: Hibernation-specific, executed before creating a hibernation image. |
f7bc83d8 RW |
138 | * Analogous to @suspend(), but it should not enable the device to signal |
139 | * wakeup events or change its power state. The majority of subsystems | |
140 | * (with the notable exception of the PCI bus type) expect the driver-level | |
141 | * @freeze() to save the device settings in memory to be used by @restore() | |
142 | * during the subsequent resume from hibernation. | |
143 | * Subsystem-level @freeze() is executed for all devices after invoking | |
144 | * subsystem-level @prepare() for all of them. | |
1eede070 | 145 | * |
cf579dfb RW |
146 | * @freeze_late: Continue operations started by @freeze(). Analogous to |
147 | * @suspend_late(), but it should not enable the device to signal wakeup | |
148 | * events or change its power state. | |
149 | * | |
1eede070 | 150 | * @thaw: Hibernation-specific, executed after creating a hibernation image OR |
f7bc83d8 | 151 | * if the creation of an image has failed. Also executed after a failing |
1eede070 RW |
152 | * attempt to restore the contents of main memory from such an image. |
153 | * Undo the changes made by the preceding @freeze(), so the device can be | |
154 | * operated in the same way as immediately before the call to @freeze(). | |
f7bc83d8 RW |
155 | * Subsystem-level @thaw() is executed for all devices after invoking |
156 | * subsystem-level @thaw_noirq() for all of them. It also may be executed | |
157 | * directly after @freeze() in case of a transition error. | |
1eede070 | 158 | * |
cf579dfb RW |
159 | * @thaw_early: Prepare to execute @thaw(). Undo the changes made by the |
160 | * preceding @freeze_late(). | |
161 | * | |
1eede070 | 162 | * @poweroff: Hibernation-specific, executed after saving a hibernation image. |
f7bc83d8 RW |
163 | * Analogous to @suspend(), but it need not save the device's settings in |
164 | * memory. | |
165 | * Subsystem-level @poweroff() is executed for all devices after invoking | |
166 | * subsystem-level @prepare() for all of them. | |
1eede070 | 167 | * |
cf579dfb RW |
168 | * @poweroff_late: Continue operations started by @poweroff(). Analogous to |
169 | * @suspend_late(), but it need not save the device's settings in memory. | |
170 | * | |
1eede070 | 171 | * @restore: Hibernation-specific, executed after restoring the contents of main |
f7bc83d8 RW |
172 | * memory from a hibernation image, analogous to @resume(). |
173 | * | |
cf579dfb RW |
174 | * @restore_early: Prepare to execute @restore(), analogous to @resume_early(). |
175 | * | |
f7bc83d8 RW |
176 | * @suspend_noirq: Complete the actions started by @suspend(). Carry out any |
177 | * additional operations required for suspending the device that might be | |
178 | * racing with its driver's interrupt handler, which is guaranteed not to | |
179 | * run while @suspend_noirq() is being executed. | |
180 | * It generally is expected that the device will be in a low-power state | |
181 | * (appropriate for the target system sleep state) after subsystem-level | |
182 | * @suspend_noirq() has returned successfully. If the device can generate | |
183 | * system wakeup signals and is enabled to wake up the system, it should be | |
184 | * configured to do so at that time. However, depending on the platform | |
cf579dfb RW |
185 | * and device's subsystem, @suspend() or @suspend_late() may be allowed to |
186 | * put the device into the low-power state and configure it to generate | |
187 | * wakeup signals, in which case it generally is not necessary to define | |
188 | * @suspend_noirq(). | |
f7bc83d8 RW |
189 | * |
190 | * @resume_noirq: Prepare for the execution of @resume() by carrying out any | |
191 | * operations required for resuming the device that might be racing with | |
192 | * its driver's interrupt handler, which is guaranteed not to run while | |
193 | * @resume_noirq() is being executed. | |
194 | * | |
195 | * @freeze_noirq: Complete the actions started by @freeze(). Carry out any | |
196 | * additional operations required for freezing the device that might be | |
197 | * racing with its driver's interrupt handler, which is guaranteed not to | |
198 | * run while @freeze_noirq() is being executed. | |
cf579dfb RW |
199 | * The power state of the device should not be changed by either @freeze(), |
200 | * or @freeze_late(), or @freeze_noirq() and it should not be configured to | |
201 | * signal system wakeup by any of these callbacks. | |
f7bc83d8 RW |
202 | * |
203 | * @thaw_noirq: Prepare for the execution of @thaw() by carrying out any | |
204 | * operations required for thawing the device that might be racing with its | |
205 | * driver's interrupt handler, which is guaranteed not to run while | |
206 | * @thaw_noirq() is being executed. | |
207 | * | |
208 | * @poweroff_noirq: Complete the actions started by @poweroff(). Analogous to | |
209 | * @suspend_noirq(), but it need not save the device's settings in memory. | |
210 | * | |
211 | * @restore_noirq: Prepare for the execution of @restore() by carrying out any | |
212 | * operations required for thawing the device that might be racing with its | |
213 | * driver's interrupt handler, which is guaranteed not to run while | |
214 | * @restore_noirq() is being executed. Analogous to @resume_noirq(). | |
1eede070 | 215 | * |
adf09493 RW |
216 | * All of the above callbacks, except for @complete(), return error codes. |
217 | * However, the error codes returned by the resume operations, @resume(), | |
f7bc83d8 | 218 | * @thaw(), @restore(), @resume_noirq(), @thaw_noirq(), and @restore_noirq(), do |
adf09493 | 219 | * not cause the PM core to abort the resume transition during which they are |
f7bc83d8 | 220 | * returned. The error codes returned in those cases are only printed by the PM |
adf09493 RW |
221 | * core to the system logs for debugging purposes. Still, it is recommended |
222 | * that drivers only return error codes from their resume methods in case of an | |
223 | * unrecoverable failure (i.e. when the device being handled refuses to resume | |
224 | * and becomes unusable) to allow us to modify the PM core in the future, so | |
225 | * that it can avoid attempting to handle devices that failed to resume and | |
226 | * their children. | |
227 | * | |
228 | * It is allowed to unregister devices while the above callbacks are being | |
f7bc83d8 RW |
229 | * executed. However, a callback routine must NOT try to unregister the device |
230 | * it was called for, although it may unregister children of that device (for | |
231 | * example, if it detects that a child was unplugged while the system was | |
232 | * asleep). | |
233 | * | |
234 | * Refer to Documentation/power/devices.txt for more information about the role | |
235 | * of the above callbacks in the system suspend process. | |
5e928f77 | 236 | * |
f7bc83d8 RW |
237 | * There also are callbacks related to runtime power management of devices. |
238 | * Again, these callbacks are executed by the PM core only for subsystems | |
239 | * (PM domains, device types, classes and bus types) and the subsystem-level | |
240 | * callbacks are supposed to invoke the driver callbacks. Moreover, the exact | |
241 | * actions to be performed by a device driver's callbacks generally depend on | |
242 | * the platform and subsystem the device belongs to. | |
5e928f77 RW |
243 | * |
244 | * @runtime_suspend: Prepare the device for a condition in which it won't be | |
245 | * able to communicate with the CPU(s) and RAM due to power management. | |
f7bc83d8 | 246 | * This need not mean that the device should be put into a low-power state. |
5e928f77 RW |
247 | * For example, if the device is behind a link which is about to be turned |
248 | * off, the device may remain at full power. If the device does go to low | |
f7bc83d8 RW |
249 | * power and is capable of generating runtime wakeup events, remote wakeup |
250 | * (i.e., a hardware mechanism allowing the device to request a change of | |
251 | * its power state via an interrupt) should be enabled for it. | |
5e928f77 RW |
252 | * |
253 | * @runtime_resume: Put the device into the fully active state in response to a | |
f7bc83d8 RW |
254 | * wakeup event generated by hardware or at the request of software. If |
255 | * necessary, put the device into the full-power state and restore its | |
5e928f77 RW |
256 | * registers, so that it is fully operational. |
257 | * | |
f7bc83d8 RW |
258 | * @runtime_idle: Device appears to be inactive and it might be put into a |
259 | * low-power state if all of the necessary conditions are satisfied. Check | |
5e928f77 RW |
260 | * these conditions and handle the device as appropriate, possibly queueing |
261 | * a suspend request for it. The return value is ignored by the PM core. | |
f7bc83d8 RW |
262 | * |
263 | * Refer to Documentation/power/runtime_pm.txt for more information about the | |
264 | * role of the above callbacks in device runtime power management. | |
265 | * | |
1eede070 RW |
266 | */ |
267 | ||
adf09493 RW |
268 | struct dev_pm_ops { |
269 | int (*prepare)(struct device *dev); | |
270 | void (*complete)(struct device *dev); | |
271 | int (*suspend)(struct device *dev); | |
272 | int (*resume)(struct device *dev); | |
273 | int (*freeze)(struct device *dev); | |
274 | int (*thaw)(struct device *dev); | |
275 | int (*poweroff)(struct device *dev); | |
276 | int (*restore)(struct device *dev); | |
cf579dfb RW |
277 | int (*suspend_late)(struct device *dev); |
278 | int (*resume_early)(struct device *dev); | |
279 | int (*freeze_late)(struct device *dev); | |
280 | int (*thaw_early)(struct device *dev); | |
281 | int (*poweroff_late)(struct device *dev); | |
282 | int (*restore_early)(struct device *dev); | |
1eede070 RW |
283 | int (*suspend_noirq)(struct device *dev); |
284 | int (*resume_noirq)(struct device *dev); | |
285 | int (*freeze_noirq)(struct device *dev); | |
286 | int (*thaw_noirq)(struct device *dev); | |
287 | int (*poweroff_noirq)(struct device *dev); | |
288 | int (*restore_noirq)(struct device *dev); | |
5e928f77 RW |
289 | int (*runtime_suspend)(struct device *dev); |
290 | int (*runtime_resume)(struct device *dev); | |
291 | int (*runtime_idle)(struct device *dev); | |
1eede070 RW |
292 | }; |
293 | ||
d690b2cd RW |
294 | #ifdef CONFIG_PM_SLEEP |
295 | #define SET_SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \ | |
296 | .suspend = suspend_fn, \ | |
297 | .resume = resume_fn, \ | |
298 | .freeze = suspend_fn, \ | |
299 | .thaw = resume_fn, \ | |
300 | .poweroff = suspend_fn, \ | |
301 | .restore = resume_fn, | |
302 | #else | |
303 | #define SET_SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) | |
304 | #endif | |
305 | ||
306 | #ifdef CONFIG_PM_RUNTIME | |
307 | #define SET_RUNTIME_PM_OPS(suspend_fn, resume_fn, idle_fn) \ | |
308 | .runtime_suspend = suspend_fn, \ | |
309 | .runtime_resume = resume_fn, \ | |
310 | .runtime_idle = idle_fn, | |
311 | #else | |
312 | #define SET_RUNTIME_PM_OPS(suspend_fn, resume_fn, idle_fn) | |
313 | #endif | |
314 | ||
9d62ec6c AT |
315 | /* |
316 | * Use this if you want to use the same suspend and resume callbacks for suspend | |
317 | * to RAM and hibernation. | |
318 | */ | |
319 | #define SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn) \ | |
47145210 | 320 | const struct dev_pm_ops name = { \ |
d690b2cd RW |
321 | SET_SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \ |
322 | } | |
323 | ||
324 | /* | |
325 | * Use this for defining a set of PM operations to be used in all situations | |
326 | * (sustem suspend, hibernation or runtime PM). | |
c4882525 RW |
327 | * NOTE: In general, system suspend callbacks, .suspend() and .resume(), should |
328 | * be different from the corresponding runtime PM callbacks, .runtime_suspend(), | |
329 | * and .runtime_resume(), because .runtime_suspend() always works on an already | |
330 | * quiescent device, while .suspend() should assume that the device may be doing | |
331 | * something when it is called (it should ensure that the device will be | |
332 | * quiescent after it has returned). Therefore it's better to point the "late" | |
333 | * suspend and "early" resume callback pointers, .suspend_late() and | |
334 | * .resume_early(), to the same routines as .runtime_suspend() and | |
335 | * .runtime_resume(), respectively (and analogously for hibernation). | |
d690b2cd RW |
336 | */ |
337 | #define UNIVERSAL_DEV_PM_OPS(name, suspend_fn, resume_fn, idle_fn) \ | |
338 | const struct dev_pm_ops name = { \ | |
339 | SET_SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \ | |
340 | SET_RUNTIME_PM_OPS(suspend_fn, resume_fn, idle_fn) \ | |
9d62ec6c AT |
341 | } |
342 | ||
1eede070 RW |
343 | /** |
344 | * PM_EVENT_ messages | |
345 | * | |
346 | * The following PM_EVENT_ messages are defined for the internal use of the PM | |
347 | * core, in order to provide a mechanism allowing the high level suspend and | |
348 | * hibernation code to convey the necessary information to the device PM core | |
349 | * code: | |
350 | * | |
351 | * ON No transition. | |
352 | * | |
353 | * FREEZE System is going to hibernate, call ->prepare() and ->freeze() | |
354 | * for all devices. | |
355 | * | |
356 | * SUSPEND System is going to suspend, call ->prepare() and ->suspend() | |
357 | * for all devices. | |
358 | * | |
359 | * HIBERNATE Hibernation image has been saved, call ->prepare() and | |
360 | * ->poweroff() for all devices. | |
361 | * | |
362 | * QUIESCE Contents of main memory are going to be restored from a (loaded) | |
363 | * hibernation image, call ->prepare() and ->freeze() for all | |
364 | * devices. | |
365 | * | |
366 | * RESUME System is resuming, call ->resume() and ->complete() for all | |
367 | * devices. | |
368 | * | |
369 | * THAW Hibernation image has been created, call ->thaw() and | |
370 | * ->complete() for all devices. | |
371 | * | |
372 | * RESTORE Contents of main memory have been restored from a hibernation | |
373 | * image, call ->restore() and ->complete() for all devices. | |
374 | * | |
375 | * RECOVER Creation of a hibernation image or restoration of the main | |
376 | * memory contents from a hibernation image has failed, call | |
377 | * ->thaw() and ->complete() for all devices. | |
8111d1b5 AS |
378 | * |
379 | * The following PM_EVENT_ messages are defined for internal use by | |
380 | * kernel subsystems. They are never issued by the PM core. | |
381 | * | |
382 | * USER_SUSPEND Manual selective suspend was issued by userspace. | |
383 | * | |
384 | * USER_RESUME Manual selective resume was issued by userspace. | |
385 | * | |
386 | * REMOTE_WAKEUP Remote-wakeup request was received from the device. | |
387 | * | |
388 | * AUTO_SUSPEND Automatic (device idle) runtime suspend was | |
389 | * initiated by the subsystem. | |
390 | * | |
391 | * AUTO_RESUME Automatic (device needed) runtime resume was | |
392 | * requested by a driver. | |
1eede070 RW |
393 | */ |
394 | ||
1a9a9152 | 395 | #define PM_EVENT_INVALID (-1) |
1eede070 RW |
396 | #define PM_EVENT_ON 0x0000 |
397 | #define PM_EVENT_FREEZE 0x0001 | |
398 | #define PM_EVENT_SUSPEND 0x0002 | |
399 | #define PM_EVENT_HIBERNATE 0x0004 | |
400 | #define PM_EVENT_QUIESCE 0x0008 | |
401 | #define PM_EVENT_RESUME 0x0010 | |
402 | #define PM_EVENT_THAW 0x0020 | |
403 | #define PM_EVENT_RESTORE 0x0040 | |
404 | #define PM_EVENT_RECOVER 0x0080 | |
8111d1b5 AS |
405 | #define PM_EVENT_USER 0x0100 |
406 | #define PM_EVENT_REMOTE 0x0200 | |
407 | #define PM_EVENT_AUTO 0x0400 | |
1eede070 | 408 | |
8111d1b5 AS |
409 | #define PM_EVENT_SLEEP (PM_EVENT_SUSPEND | PM_EVENT_HIBERNATE) |
410 | #define PM_EVENT_USER_SUSPEND (PM_EVENT_USER | PM_EVENT_SUSPEND) | |
411 | #define PM_EVENT_USER_RESUME (PM_EVENT_USER | PM_EVENT_RESUME) | |
7f4f5d45 | 412 | #define PM_EVENT_REMOTE_RESUME (PM_EVENT_REMOTE | PM_EVENT_RESUME) |
8111d1b5 AS |
413 | #define PM_EVENT_AUTO_SUSPEND (PM_EVENT_AUTO | PM_EVENT_SUSPEND) |
414 | #define PM_EVENT_AUTO_RESUME (PM_EVENT_AUTO | PM_EVENT_RESUME) | |
1eede070 | 415 | |
1a9a9152 | 416 | #define PMSG_INVALID ((struct pm_message){ .event = PM_EVENT_INVALID, }) |
8111d1b5 | 417 | #define PMSG_ON ((struct pm_message){ .event = PM_EVENT_ON, }) |
1eede070 RW |
418 | #define PMSG_FREEZE ((struct pm_message){ .event = PM_EVENT_FREEZE, }) |
419 | #define PMSG_QUIESCE ((struct pm_message){ .event = PM_EVENT_QUIESCE, }) | |
420 | #define PMSG_SUSPEND ((struct pm_message){ .event = PM_EVENT_SUSPEND, }) | |
421 | #define PMSG_HIBERNATE ((struct pm_message){ .event = PM_EVENT_HIBERNATE, }) | |
422 | #define PMSG_RESUME ((struct pm_message){ .event = PM_EVENT_RESUME, }) | |
423 | #define PMSG_THAW ((struct pm_message){ .event = PM_EVENT_THAW, }) | |
424 | #define PMSG_RESTORE ((struct pm_message){ .event = PM_EVENT_RESTORE, }) | |
425 | #define PMSG_RECOVER ((struct pm_message){ .event = PM_EVENT_RECOVER, }) | |
7f4f5d45 | 426 | #define PMSG_USER_SUSPEND ((struct pm_message) \ |
8111d1b5 | 427 | { .event = PM_EVENT_USER_SUSPEND, }) |
7f4f5d45 | 428 | #define PMSG_USER_RESUME ((struct pm_message) \ |
8111d1b5 | 429 | { .event = PM_EVENT_USER_RESUME, }) |
7f4f5d45 | 430 | #define PMSG_REMOTE_RESUME ((struct pm_message) \ |
8111d1b5 | 431 | { .event = PM_EVENT_REMOTE_RESUME, }) |
7f4f5d45 | 432 | #define PMSG_AUTO_SUSPEND ((struct pm_message) \ |
8111d1b5 | 433 | { .event = PM_EVENT_AUTO_SUSPEND, }) |
7f4f5d45 | 434 | #define PMSG_AUTO_RESUME ((struct pm_message) \ |
8111d1b5 | 435 | { .event = PM_EVENT_AUTO_RESUME, }) |
1eede070 | 436 | |
5b1b0b81 AS |
437 | #define PMSG_IS_AUTO(msg) (((msg).event & PM_EVENT_AUTO) != 0) |
438 | ||
5e928f77 RW |
439 | /** |
440 | * Device run-time power management status. | |
441 | * | |
442 | * These status labels are used internally by the PM core to indicate the | |
443 | * current status of a device with respect to the PM core operations. They do | |
444 | * not reflect the actual power state of the device or its status as seen by the | |
445 | * driver. | |
446 | * | |
447 | * RPM_ACTIVE Device is fully operational. Indicates that the device | |
448 | * bus type's ->runtime_resume() callback has completed | |
449 | * successfully. | |
450 | * | |
451 | * RPM_SUSPENDED Device bus type's ->runtime_suspend() callback has | |
452 | * completed successfully. The device is regarded as | |
453 | * suspended. | |
454 | * | |
455 | * RPM_RESUMING Device bus type's ->runtime_resume() callback is being | |
456 | * executed. | |
457 | * | |
458 | * RPM_SUSPENDING Device bus type's ->runtime_suspend() callback is being | |
459 | * executed. | |
460 | */ | |
461 | ||
462 | enum rpm_status { | |
463 | RPM_ACTIVE = 0, | |
464 | RPM_RESUMING, | |
465 | RPM_SUSPENDED, | |
466 | RPM_SUSPENDING, | |
467 | }; | |
468 | ||
469 | /** | |
470 | * Device run-time power management request types. | |
471 | * | |
472 | * RPM_REQ_NONE Do nothing. | |
473 | * | |
474 | * RPM_REQ_IDLE Run the device bus type's ->runtime_idle() callback | |
475 | * | |
476 | * RPM_REQ_SUSPEND Run the device bus type's ->runtime_suspend() callback | |
477 | * | |
15bcb91d AS |
478 | * RPM_REQ_AUTOSUSPEND Same as RPM_REQ_SUSPEND, but not until the device has |
479 | * been inactive for as long as power.autosuspend_delay | |
480 | * | |
5e928f77 RW |
481 | * RPM_REQ_RESUME Run the device bus type's ->runtime_resume() callback |
482 | */ | |
483 | ||
484 | enum rpm_request { | |
485 | RPM_REQ_NONE = 0, | |
486 | RPM_REQ_IDLE, | |
487 | RPM_REQ_SUSPEND, | |
15bcb91d | 488 | RPM_REQ_AUTOSUSPEND, |
5e928f77 RW |
489 | RPM_REQ_RESUME, |
490 | }; | |
491 | ||
074037ec RW |
492 | struct wakeup_source; |
493 | ||
4605ab65 RW |
494 | struct pm_domain_data { |
495 | struct list_head list_node; | |
496 | struct device *dev; | |
4605ab65 RW |
497 | }; |
498 | ||
5c095a0e RW |
499 | struct pm_subsys_data { |
500 | spinlock_t lock; | |
ef27bed1 | 501 | unsigned int refcount; |
5c095a0e RW |
502 | #ifdef CONFIG_PM_CLK |
503 | struct list_head clock_list; | |
504 | #endif | |
4605ab65 | 505 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
cd0ea672 | 506 | struct pm_domain_data *domain_data; |
4605ab65 | 507 | #endif |
5c095a0e RW |
508 | }; |
509 | ||
1eede070 RW |
510 | struct dev_pm_info { |
511 | pm_message_t power_state; | |
5e928f77 | 512 | unsigned int can_wakeup:1; |
b8c76f6a | 513 | unsigned int async_suspend:1; |
f76b168b | 514 | bool is_prepared:1; /* Owned by the PM core */ |
6d0e0e84 | 515 | bool is_suspended:1; /* Ditto */ |
8b258cc8 | 516 | bool ignore_children:1; |
bed2b42d | 517 | bool early_init:1; /* Owned by the PM core */ |
dbf37414 | 518 | bool syscore:1; |
074037ec | 519 | spinlock_t lock; |
5e928f77 | 520 | #ifdef CONFIG_PM_SLEEP |
1eede070 | 521 | struct list_head entry; |
5af84b82 | 522 | struct completion completion; |
074037ec | 523 | struct wakeup_source *wakeup; |
4ca46ff3 | 524 | bool wakeup_path:1; |
805bdaec RW |
525 | #else |
526 | unsigned int should_wakeup:1; | |
1eede070 | 527 | #endif |
5e928f77 RW |
528 | #ifdef CONFIG_PM_RUNTIME |
529 | struct timer_list suspend_timer; | |
530 | unsigned long timer_expires; | |
531 | struct work_struct work; | |
532 | wait_queue_head_t wait_queue; | |
5e928f77 RW |
533 | atomic_t usage_count; |
534 | atomic_t child_count; | |
535 | unsigned int disable_depth:3; | |
5e928f77 RW |
536 | unsigned int idle_notification:1; |
537 | unsigned int request_pending:1; | |
538 | unsigned int deferred_resume:1; | |
7a1a8eb5 | 539 | unsigned int run_wake:1; |
53823639 | 540 | unsigned int runtime_auto:1; |
7490e442 | 541 | unsigned int no_callbacks:1; |
c7b61de5 | 542 | unsigned int irq_safe:1; |
15bcb91d AS |
543 | unsigned int use_autosuspend:1; |
544 | unsigned int timer_autosuspends:1; | |
5e928f77 RW |
545 | enum rpm_request request; |
546 | enum rpm_status runtime_status; | |
547 | int runtime_error; | |
15bcb91d AS |
548 | int autosuspend_delay; |
549 | unsigned long last_busy; | |
8d4b9d1b AV |
550 | unsigned long active_jiffies; |
551 | unsigned long suspended_jiffies; | |
552 | unsigned long accounting_timestamp; | |
85dc0b8a | 553 | struct dev_pm_qos_request *pq_req; |
5e928f77 | 554 | #endif |
5c095a0e | 555 | struct pm_subsys_data *subsys_data; /* Owned by the subsystem. */ |
91ff4cb8 | 556 | struct pm_qos_constraints *constraints; |
1eede070 RW |
557 | }; |
558 | ||
8d4b9d1b | 559 | extern void update_pm_runtime_accounting(struct device *dev); |
ef27bed1 RW |
560 | extern int dev_pm_get_subsys_data(struct device *dev); |
561 | extern int dev_pm_put_subsys_data(struct device *dev); | |
8d4b9d1b | 562 | |
7538e3db RW |
563 | /* |
564 | * Power domains provide callbacks that are executed during system suspend, | |
565 | * hibernation, system resume and during runtime PM transitions along with | |
566 | * subsystem-level and driver-level callbacks. | |
567 | */ | |
564b905a | 568 | struct dev_pm_domain { |
7538e3db RW |
569 | struct dev_pm_ops ops; |
570 | }; | |
8d4b9d1b | 571 | |
1eede070 RW |
572 | /* |
573 | * The PM_EVENT_ messages are also used by drivers implementing the legacy | |
574 | * suspend framework, based on the ->suspend() and ->resume() callbacks common | |
575 | * for suspend and hibernation transitions, according to the rules below. | |
576 | */ | |
577 | ||
578 | /* Necessary, because several drivers use PM_EVENT_PRETHAW */ | |
579 | #define PM_EVENT_PRETHAW PM_EVENT_QUIESCE | |
580 | ||
581 | /* | |
82bb67f2 DB |
582 | * One transition is triggered by resume(), after a suspend() call; the |
583 | * message is implicit: | |
584 | * | |
585 | * ON Driver starts working again, responding to hardware events | |
586 | * and software requests. The hardware may have gone through | |
587 | * a power-off reset, or it may have maintained state from the | |
588 | * previous suspend() which the driver will rely on while | |
589 | * resuming. On most platforms, there are no restrictions on | |
590 | * availability of resources like clocks during resume(). | |
591 | * | |
592 | * Other transitions are triggered by messages sent using suspend(). All | |
593 | * these transitions quiesce the driver, so that I/O queues are inactive. | |
594 | * That commonly entails turning off IRQs and DMA; there may be rules | |
595 | * about how to quiesce that are specific to the bus or the device's type. | |
596 | * (For example, network drivers mark the link state.) Other details may | |
597 | * differ according to the message: | |
598 | * | |
599 | * SUSPEND Quiesce, enter a low power device state appropriate for | |
600 | * the upcoming system state (such as PCI_D3hot), and enable | |
601 | * wakeup events as appropriate. | |
602 | * | |
3a2d5b70 RW |
603 | * HIBERNATE Enter a low power device state appropriate for the hibernation |
604 | * state (eg. ACPI S4) and enable wakeup events as appropriate. | |
605 | * | |
82bb67f2 DB |
606 | * FREEZE Quiesce operations so that a consistent image can be saved; |
607 | * but do NOT otherwise enter a low power device state, and do | |
608 | * NOT emit system wakeup events. | |
609 | * | |
610 | * PRETHAW Quiesce as if for FREEZE; additionally, prepare for restoring | |
611 | * the system from a snapshot taken after an earlier FREEZE. | |
612 | * Some drivers will need to reset their hardware state instead | |
613 | * of preserving it, to ensure that it's never mistaken for the | |
614 | * state which that earlier snapshot had set up. | |
615 | * | |
616 | * A minimally power-aware driver treats all messages as SUSPEND, fully | |
617 | * reinitializes its device during resume() -- whether or not it was reset | |
618 | * during the suspend/resume cycle -- and can't issue wakeup events. | |
619 | * | |
620 | * More power-aware drivers may also use low power states at runtime as | |
621 | * well as during system sleep states like PM_SUSPEND_STANDBY. They may | |
622 | * be able to use wakeup events to exit from runtime low-power states, | |
623 | * or from system low-power states such as standby or suspend-to-RAM. | |
1da177e4 LT |
624 | */ |
625 | ||
1eede070 | 626 | #ifdef CONFIG_PM_SLEEP |
d47d81c0 | 627 | extern void device_pm_lock(void); |
cf579dfb | 628 | extern void dpm_resume_start(pm_message_t state); |
d1616302 | 629 | extern void dpm_resume_end(pm_message_t state); |
91e7c75b RW |
630 | extern void dpm_resume(pm_message_t state); |
631 | extern void dpm_complete(pm_message_t state); | |
1da177e4 | 632 | |
1eede070 | 633 | extern void device_pm_unlock(void); |
cf579dfb | 634 | extern int dpm_suspend_end(pm_message_t state); |
d1616302 | 635 | extern int dpm_suspend_start(pm_message_t state); |
91e7c75b RW |
636 | extern int dpm_suspend(pm_message_t state); |
637 | extern int dpm_prepare(pm_message_t state); | |
0ac85241 | 638 | |
02669492 AM |
639 | extern void __suspend_report_result(const char *function, void *fn, int ret); |
640 | ||
641 | #define suspend_report_result(fn, ret) \ | |
642 | do { \ | |
d5c003b4 | 643 | __suspend_report_result(__func__, fn, ret); \ |
02669492 | 644 | } while (0) |
9a7834d0 | 645 | |
098dff73 | 646 | extern int device_pm_wait_for_dev(struct device *sub, struct device *dev); |
6538df80 RW |
647 | |
648 | extern int pm_generic_prepare(struct device *dev); | |
e470d066 | 649 | extern int pm_generic_suspend_late(struct device *dev); |
e5291928 | 650 | extern int pm_generic_suspend_noirq(struct device *dev); |
6538df80 | 651 | extern int pm_generic_suspend(struct device *dev); |
e470d066 | 652 | extern int pm_generic_resume_early(struct device *dev); |
e5291928 | 653 | extern int pm_generic_resume_noirq(struct device *dev); |
6538df80 | 654 | extern int pm_generic_resume(struct device *dev); |
e5291928 | 655 | extern int pm_generic_freeze_noirq(struct device *dev); |
e470d066 | 656 | extern int pm_generic_freeze_late(struct device *dev); |
6538df80 | 657 | extern int pm_generic_freeze(struct device *dev); |
e5291928 | 658 | extern int pm_generic_thaw_noirq(struct device *dev); |
e470d066 | 659 | extern int pm_generic_thaw_early(struct device *dev); |
6538df80 | 660 | extern int pm_generic_thaw(struct device *dev); |
e5291928 | 661 | extern int pm_generic_restore_noirq(struct device *dev); |
e470d066 | 662 | extern int pm_generic_restore_early(struct device *dev); |
6538df80 | 663 | extern int pm_generic_restore(struct device *dev); |
e5291928 | 664 | extern int pm_generic_poweroff_noirq(struct device *dev); |
e470d066 | 665 | extern int pm_generic_poweroff_late(struct device *dev); |
6538df80 RW |
666 | extern int pm_generic_poweroff(struct device *dev); |
667 | extern void pm_generic_complete(struct device *dev); | |
668 | ||
d288e47c AS |
669 | #else /* !CONFIG_PM_SLEEP */ |
670 | ||
ffa6a705 CH |
671 | #define device_pm_lock() do {} while (0) |
672 | #define device_pm_unlock() do {} while (0) | |
673 | ||
d1616302 | 674 | static inline int dpm_suspend_start(pm_message_t state) |
d288e47c AS |
675 | { |
676 | return 0; | |
677 | } | |
678 | ||
9a3df1f7 | 679 | #define suspend_report_result(fn, ret) do {} while (0) |
d288e47c | 680 | |
098dff73 RW |
681 | static inline int device_pm_wait_for_dev(struct device *a, struct device *b) |
682 | { | |
683 | return 0; | |
684 | } | |
6538df80 RW |
685 | |
686 | #define pm_generic_prepare NULL | |
687 | #define pm_generic_suspend NULL | |
688 | #define pm_generic_resume NULL | |
689 | #define pm_generic_freeze NULL | |
690 | #define pm_generic_thaw NULL | |
691 | #define pm_generic_restore NULL | |
692 | #define pm_generic_poweroff NULL | |
693 | #define pm_generic_complete NULL | |
d288e47c AS |
694 | #endif /* !CONFIG_PM_SLEEP */ |
695 | ||
ffa6a705 CH |
696 | /* How to reorder dpm_list after device_move() */ |
697 | enum dpm_order { | |
698 | DPM_ORDER_NONE, | |
699 | DPM_ORDER_DEV_AFTER_PARENT, | |
700 | DPM_ORDER_PARENT_BEFORE_DEV, | |
701 | DPM_ORDER_DEV_LAST, | |
702 | }; | |
703 | ||
1da177e4 | 704 | #endif /* _LINUX_PM_H */ |