include/linux/pm.h

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