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