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