include/linux/pm.h

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