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