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