include/linux/suspend.h

   1 #ifndef _LINUX_SUSPEND_H
   2 #define _LINUX_SUSPEND_H
   3
   4 #include <linux/swap.h>
   5 #include <linux/notifier.h>
   6 #include <linux/init.h>
   7 #include <linux/pm.h>
   8 #include <linux/mm.h>
   9 #include <linux/freezer.h>
  10 #include <asm/errno.h>
  11
  12 #ifdef CONFIG_VT
  13 extern void pm_set_vt_switch(int);
  14 #else
  15 static inline void pm_set_vt_switch(int do_switch)
  16 {
  17 }
  18 #endif
  19
  20 #ifdef CONFIG_VT_CONSOLE_SLEEP
  21 extern void pm_prepare_console(void);
  22 extern void pm_restore_console(void);
  23 #else
  24 static inline void pm_prepare_console(void)
  25 {
  26 }
  27
  28 static inline void pm_restore_console(void)
  29 {
  30 }
  31 #endif
  32
  33 typedef int __bitwise suspend_state_t;
  34
  35 #define PM_SUSPEND_ON           ((__force suspend_state_t) 0)
  36 #define PM_SUSPEND_FREEZE       ((__force suspend_state_t) 1)
  37 #define PM_SUSPEND_STANDBY      ((__force suspend_state_t) 2)
  38 #define PM_SUSPEND_MEM          ((__force suspend_state_t) 3)
  39 #define PM_SUSPEND_MIN          PM_SUSPEND_FREEZE
  40 #define PM_SUSPEND_MAX          ((__force suspend_state_t) 4)
  41
  42 enum suspend_stat_step {
  43         SUSPEND_FREEZE = 1,
  44         SUSPEND_PREPARE,
  45         SUSPEND_SUSPEND,
  46         SUSPEND_SUSPEND_LATE,
  47         SUSPEND_SUSPEND_NOIRQ,
  48         SUSPEND_RESUME_NOIRQ,
  49         SUSPEND_RESUME_EARLY,
  50         SUSPEND_RESUME
  51 };
  52
  53 struct suspend_stats {
  54         int     success;
  55         int     fail;
  56         int     failed_freeze;
  57         int     failed_prepare;
  58         int     failed_suspend;
  59         int     failed_suspend_late;
  60         int     failed_suspend_noirq;
  61         int     failed_resume;
  62         int     failed_resume_early;
  63         int     failed_resume_noirq;
  64 #define REC_FAILED_NUM  2
  65         int     last_failed_dev;
  66         char    failed_devs[REC_FAILED_NUM][40];
  67         int     last_failed_errno;
  68         int     errno[REC_FAILED_NUM];
  69         int     last_failed_step;
  70         enum suspend_stat_step  failed_steps[REC_FAILED_NUM];
  71 };
  72
  73 extern struct suspend_stats suspend_stats;
  74
  75 static inline void dpm_save_failed_dev(const char *name)
  76 {
  77         strlcpy(suspend_stats.failed_devs[suspend_stats.last_failed_dev],
  78                 name,
  79                 sizeof(suspend_stats.failed_devs[0]));
  80         suspend_stats.last_failed_dev++;
  81         suspend_stats.last_failed_dev %= REC_FAILED_NUM;
  82 }
  83
  84 static inline void dpm_save_failed_errno(int err)
  85 {
  86         suspend_stats.errno[suspend_stats.last_failed_errno] = err;
  87         suspend_stats.last_failed_errno++;
  88         suspend_stats.last_failed_errno %= REC_FAILED_NUM;
  89 }
  90
  91 static inline void dpm_save_failed_step(enum suspend_stat_step step)
  92 {
  93         suspend_stats.failed_steps[suspend_stats.last_failed_step] = step;
  94         suspend_stats.last_failed_step++;
  95         suspend_stats.last_failed_step %= REC_FAILED_NUM;
  96 }
  97
  98 /**
  99  * struct platform_suspend_ops - Callbacks for managing platform dependent
 100  *      system sleep states.
 101  *
 102  * @valid: Callback to determine if given system sleep state is supported by
 103  *      the platform.
 104  *      Valid (ie. supported) states are advertised in /sys/power/state.  Note
 105  *      that it still may be impossible to enter given system sleep state if the
 106  *      conditions aren't right.
 107  *      There is the %suspend_valid_only_mem function available that can be
 108  *      assigned to this if the platform only supports mem sleep.
 109  *
 110  * @begin: Initialise a transition to given system sleep state.
 111  *      @begin() is executed right prior to suspending devices.  The information
 112  *      conveyed to the platform code by @begin() should be disregarded by it as
 113  *      soon as @end() is executed.  If @begin() fails (ie. returns nonzero),
 114  *      @prepare(), @enter() and @finish() will not be called by the PM core.
 115  *      This callback is optional.  However, if it is implemented, the argument
 116  *      passed to @enter() is redundant and should be ignored.
 117  *
 118  * @prepare: Prepare the platform for entering the system sleep state indicated
 119  *      by @begin().
 120  *      @prepare() is called right after devices have been suspended (ie. the
 121  *      appropriate .suspend() method has been executed for each device) and
 122  *      before device drivers' late suspend callbacks are executed.  It returns
 123  *      0 on success or a negative error code otherwise, in which case the
 124  *      system cannot enter the desired sleep state (@prepare_late(), @enter(),
 125  *      and @wake() will not be called in that case).
 126  *
 127  * @prepare_late: Finish preparing the platform for entering the system sleep
 128  *      state indicated by @begin().
 129  *      @prepare_late is called before disabling nonboot CPUs and after
 130  *      device drivers' late suspend callbacks have been executed.  It returns
 131  *      0 on success or a negative error code otherwise, in which case the
 132  *      system cannot enter the desired sleep state (@enter() will not be
 133  *      executed).
 134  *
 135  * @enter: Enter the system sleep state indicated by @begin() or represented by
 136  *      the argument if @begin() is not implemented.
 137  *      This callback is mandatory.  It returns 0 on success or a negative
 138  *      error code otherwise, in which case the system cannot enter the desired
 139  *      sleep state.
 140  *
 141  * @wake: Called when the system has just left a sleep state, right after
 142  *      the nonboot CPUs have been enabled and before device drivers' early
 143  *      resume callbacks are executed.
 144  *      This callback is optional, but should be implemented by the platforms
 145  *      that implement @prepare_late().  If implemented, it is always called
 146  *      after @prepare_late and @enter(), even if one of them fails.
 147  *
 148  * @finish: Finish wake-up of the platform.
 149  *      @finish is called right prior to calling device drivers' regular suspend
 150  *      callbacks.
 151  *      This callback is optional, but should be implemented by the platforms
 152  *      that implement @prepare().  If implemented, it is always called after
 153  *      @enter() and @wake(), even if any of them fails.  It is executed after
 154  *      a failing @prepare.
 155  *
 156  * @suspend_again: Returns whether the system should suspend again (true) or
 157  *      not (false). If the platform wants to poll sensors or execute some
 158  *      code during suspended without invoking userspace and most of devices,
 159  *      suspend_again callback is the place assuming that periodic-wakeup or
 160  *      alarm-wakeup is already setup. This allows to execute some codes while
 161  *      being kept suspended in the view of userland and devices.
 162  *
 163  * @end: Called by the PM core right after resuming devices, to indicate to
 164  *      the platform that the system has returned to the working state or
 165  *      the transition to the sleep state has been aborted.
 166  *      This callback is optional, but should be implemented by the platforms
 167  *      that implement @begin().  Accordingly, platforms implementing @begin()
 168  *      should also provide a @end() which cleans up transitions aborted before
 169  *      @enter().
 170  *
 171  * @recover: Recover the platform from a suspend failure.
 172  *      Called by the PM core if the suspending of devices fails.
 173  *      This callback is optional and should only be implemented by platforms
 174  *      which require special recovery actions in that situation.
 175  */
 176 struct platform_suspend_ops {
 177         int (*valid)(suspend_state_t state);
 178         int (*begin)(suspend_state_t state);
 179         int (*prepare)(void);
 180         int (*prepare_late)(void);
 181         int (*enter)(suspend_state_t state);
 182         void (*wake)(void);
 183         void (*finish)(void);
 184         bool (*suspend_again)(void);
 185         void (*end)(void);
 186         void (*recover)(void);
 187 };
 188
 189 struct platform_freeze_ops {
 190         int (*begin)(void);
 191         int (*prepare)(void);
 192         void (*restore)(void);
 193         void (*end)(void);
 194 };
 195
 196 #ifdef CONFIG_SUSPEND
 197 /**
 198  * suspend_set_ops - set platform dependent suspend operations
 199  * @ops: The new suspend operations to set.
 200  */
 201 extern void suspend_set_ops(const struct platform_suspend_ops *ops);
 202 extern int suspend_valid_only_mem(suspend_state_t state);
 203
 204 extern unsigned int pm_suspend_global_flags;
 205
 206 #define PM_SUSPEND_FLAG_FW_SUSPEND      (1 << 0)
 207 #define PM_SUSPEND_FLAG_FW_RESUME       (1 << 1)
 208
 209 static inline void pm_suspend_clear_flags(void)
 210 {
 211         pm_suspend_global_flags = 0;
 212 }
 213
 214 static inline void pm_set_suspend_via_firmware(void)
 215 {
 216         pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_SUSPEND;
 217 }
 218
 219 static inline void pm_set_resume_via_firmware(void)
 220 {
 221         pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_RESUME;
 222 }
 223
 224 static inline bool pm_suspend_via_firmware(void)
 225 {
 226         return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_SUSPEND);
 227 }
 228
 229 static inline bool pm_resume_via_firmware(void)
 230 {
 231         return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_RESUME);
 232 }
 233
 234 /* Suspend-to-idle state machnine. */
 235 enum freeze_state {
 236         FREEZE_STATE_NONE,      /* Not suspended/suspending. */
 237         FREEZE_STATE_ENTER,     /* Enter suspend-to-idle. */
 238         FREEZE_STATE_WAKE,      /* Wake up from suspend-to-idle. */
 239 };
 240
 241 extern enum freeze_state __read_mostly suspend_freeze_state;
 242
 243 static inline bool idle_should_freeze(void)
 244 {
 245         return unlikely(suspend_freeze_state == FREEZE_STATE_ENTER);
 246 }
 247
 248 extern void freeze_set_ops(const struct platform_freeze_ops *ops);
 249 extern void freeze_wake(void);
 250
 251 /**
 252  * arch_suspend_disable_irqs - disable IRQs for suspend
 253  *
 254  * Disables IRQs (in the default case). This is a weak symbol in the common
 255  * code and thus allows architectures to override it if more needs to be
 256  * done. Not called for suspend to disk.
 257  */
 258 extern void arch_suspend_disable_irqs(void);
 259
 260 /**
 261  * arch_suspend_enable_irqs - enable IRQs after suspend
 262  *
 263  * Enables IRQs (in the default case). This is a weak symbol in the common
 264  * code and thus allows architectures to override it if more needs to be
 265  * done. Not called for suspend to disk.
 266  */
 267 extern void arch_suspend_enable_irqs(void);
 268
 269 extern int pm_suspend(suspend_state_t state);
 270 #else /* !CONFIG_SUSPEND */
 271 #define suspend_valid_only_mem  NULL
 272
 273 static inline void pm_suspend_clear_flags(void) {}
 274 static inline void pm_set_suspend_via_firmware(void) {}
 275 static inline void pm_set_resume_via_firmware(void) {}
 276 static inline bool pm_suspend_via_firmware(void) { return false; }
 277 static inline bool pm_resume_via_firmware(void) { return false; }
 278
 279 static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {}
 280 static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }
 281 static inline bool idle_should_freeze(void) { return false; }
 282 static inline void freeze_set_ops(const struct platform_freeze_ops *ops) {}
 283 static inline void freeze_wake(void) {}
 284 #endif /* !CONFIG_SUSPEND */
 285
 286 /* struct pbe is used for creating lists of pages that should be restored
 287  * atomically during the resume from disk, because the page frames they have
 288  * occupied before the suspend are in use.
 289  */
 290 struct pbe {
 291         void *address;          /* address of the copy */
 292         void *orig_address;     /* original address of a page */
 293         struct pbe *next;
 294 };
 295
 296 /* mm/page_alloc.c */
 297 extern void mark_free_pages(struct zone *zone);
 298
 299 /**
 300  * struct platform_hibernation_ops - hibernation platform support
 301  *
 302  * The methods in this structure allow a platform to carry out special
 303  * operations required by it during a hibernation transition.
 304  *
 305  * All the methods below, except for @recover(), must be implemented.
 306  *
 307  * @begin: Tell the platform driver that we're starting hibernation.
 308  *      Called right after shrinking memory and before freezing devices.
 309  *
 310  * @end: Called by the PM core right after resuming devices, to indicate to
 311  *      the platform that the system has returned to the working state.
 312  *
 313  * @pre_snapshot: Prepare the platform for creating the hibernation image.
 314  *      Called right after devices have been frozen and before the nonboot
 315  *      CPUs are disabled (runs with IRQs on).
 316  *
 317  * @finish: Restore the previous state of the platform after the hibernation
 318  *      image has been created *or* put the platform into the normal operation
 319  *      mode after the hibernation (the same method is executed in both cases).
 320  *      Called right after the nonboot CPUs have been enabled and before
 321  *      thawing devices (runs with IRQs on).
 322  *
 323  * @prepare: Prepare the platform for entering the low power state.
 324  *      Called right after the hibernation image has been saved and before
 325  *      devices are prepared for entering the low power state.
 326  *
 327  * @enter: Put the system into the low power state after the hibernation image
 328  *      has been saved to disk.
 329  *      Called after the nonboot CPUs have been disabled and all of the low
 330  *      level devices have been shut down (runs with IRQs off).
 331  *
 332  * @leave: Perform the first stage of the cleanup after the system sleep state
 333  *      indicated by @set_target() has been left.
 334  *      Called right after the control has been passed from the boot kernel to
 335  *      the image kernel, before the nonboot CPUs are enabled and before devices
 336  *      are resumed.  Executed with interrupts disabled.
 337  *
 338  * @pre_restore: Prepare system for the restoration from a hibernation image.
 339  *      Called right after devices have been frozen and before the nonboot
 340  *      CPUs are disabled (runs with IRQs on).
 341  *
 342  * @restore_cleanup: Clean up after a failing image restoration.
 343  *      Called right after the nonboot CPUs have been enabled and before
 344  *      thawing devices (runs with IRQs on).
 345  *
 346  * @recover: Recover the platform from a failure to suspend devices.
 347  *      Called by the PM core if the suspending of devices during hibernation
 348  *      fails.  This callback is optional and should only be implemented by
 349  *      platforms which require special recovery actions in that situation.
 350  */
 351 struct platform_hibernation_ops {
 352         int (*begin)(void);
 353         void (*end)(void);
 354         int (*pre_snapshot)(void);
 355         void (*finish)(void);
 356         int (*prepare)(void);
 357         int (*enter)(void);
 358         void (*leave)(void);
 359         int (*pre_restore)(void);
 360         void (*restore_cleanup)(void);
 361         void (*recover)(void);
 362 };
 363
 364 #ifdef CONFIG_HIBERNATION
 365 /* kernel/power/snapshot.c */
 366 extern void __register_nosave_region(unsigned long b, unsigned long e, int km);
 367 static inline void __init register_nosave_region(unsigned long b, unsigned long e)
 368 {
 369         __register_nosave_region(b, e, 0);
 370 }
 371 static inline void __init register_nosave_region_late(unsigned long b, unsigned long e)
 372 {
 373         __register_nosave_region(b, e, 1);
 374 }
 375 extern int swsusp_page_is_forbidden(struct page *);
 376 extern void swsusp_set_page_free(struct page *);
 377 extern void swsusp_unset_page_free(struct page *);
 378 extern unsigned long get_safe_page(gfp_t gfp_mask);
 379
 380 extern void hibernation_set_ops(const struct platform_hibernation_ops *ops);
 381 extern int hibernate(void);
 382 extern bool system_entering_hibernation(void);
 383 extern bool hibernation_available(void);
 384 asmlinkage int swsusp_save(void);
 385 extern struct pbe *restore_pblist;
 386 #else /* CONFIG_HIBERNATION */
 387 static inline void register_nosave_region(unsigned long b, unsigned long e) {}
 388 static inline void register_nosave_region_late(unsigned long b, unsigned long e) {}
 389 static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
 390 static inline void swsusp_set_page_free(struct page *p) {}
 391 static inline void swsusp_unset_page_free(struct page *p) {}
 392
 393 static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {}
 394 static inline int hibernate(void) { return -ENOSYS; }
 395 static inline bool system_entering_hibernation(void) { return false; }
 396 static inline bool hibernation_available(void) { return false; }
 397 #endif /* CONFIG_HIBERNATION */
 398
 399 /* Hibernation and suspend events */
 400 #define PM_HIBERNATION_PREPARE  0x0001 /* Going to hibernate */
 401 #define PM_POST_HIBERNATION     0x0002 /* Hibernation finished */
 402 #define PM_SUSPEND_PREPARE      0x0003 /* Going to suspend the system */
 403 #define PM_POST_SUSPEND         0x0004 /* Suspend finished */
 404 #define PM_RESTORE_PREPARE      0x0005 /* Going to restore a saved image */
 405 #define PM_POST_RESTORE         0x0006 /* Restore failed */
 406
 407 extern struct mutex pm_mutex;
 408
 409 #ifdef CONFIG_PM_SLEEP
 410 void save_processor_state(void);
 411 void restore_processor_state(void);
 412
 413 /* kernel/power/main.c */
 414 extern int register_pm_notifier(struct notifier_block *nb);
 415 extern int unregister_pm_notifier(struct notifier_block *nb);
 416
 417 #define pm_notifier(fn, pri) {                          \
 418         static struct notifier_block fn##_nb =                  \
 419                 { .notifier_call = fn, .priority = pri };       \
 420         register_pm_notifier(&fn##_nb);                 \
 421 }
 422
 423 /* drivers/base/power/wakeup.c */
 424 extern bool events_check_enabled;
 425 extern unsigned int pm_wakeup_irq;
 426
 427 extern bool pm_wakeup_pending(void);
 428 extern void pm_system_wakeup(void);
 429 extern void pm_wakeup_clear(void);
 430 extern void pm_system_irq_wakeup(unsigned int irq_number);
 431 extern bool pm_get_wakeup_count(unsigned int *count, bool block);
 432 extern bool pm_save_wakeup_count(unsigned int count);
 433 extern void pm_wakep_autosleep_enabled(bool set);
 434 extern void pm_print_active_wakeup_sources(void);
 435
 436 static inline void lock_system_sleep(void)
 437 {
 438         current->flags |= PF_FREEZER_SKIP;
 439         mutex_lock(&pm_mutex);
 440 }
 441
 442 static inline void unlock_system_sleep(void)
 443 {
 444         /*
 445          * Don't use freezer_count() because we don't want the call to
 446          * try_to_freeze() here.
 447          *
 448          * Reason:
 449          * Fundamentally, we just don't need it, because freezing condition
 450          * doesn't come into effect until we release the pm_mutex lock,
 451          * since the freezer always works with pm_mutex held.
 452          *
 453          * More importantly, in the case of hibernation,
 454          * unlock_system_sleep() gets called in snapshot_read() and
 455          * snapshot_write() when the freezing condition is still in effect.
 456          * Which means, if we use try_to_freeze() here, it would make them
 457          * enter the refrigerator, thus causing hibernation to lockup.
 458          */
 459         current->flags &= ~PF_FREEZER_SKIP;
 460         mutex_unlock(&pm_mutex);
 461 }
 462
 463 #else /* !CONFIG_PM_SLEEP */
 464
 465 static inline int register_pm_notifier(struct notifier_block *nb)
 466 {
 467         return 0;
 468 }
 469
 470 static inline int unregister_pm_notifier(struct notifier_block *nb)
 471 {
 472         return 0;
 473 }
 474
 475 #define pm_notifier(fn, pri)    do { (void)(fn); } while (0)
 476
 477 static inline bool pm_wakeup_pending(void) { return false; }
 478 static inline void pm_system_wakeup(void) {}
 479 static inline void pm_wakeup_clear(void) {}
 480 static inline void pm_system_irq_wakeup(unsigned int irq_number) {}
 481
 482 static inline void lock_system_sleep(void) {}
 483 static inline void unlock_system_sleep(void) {}
 484
 485 #endif /* !CONFIG_PM_SLEEP */
 486
 487 #ifdef CONFIG_PM_SLEEP_DEBUG
 488 extern bool pm_print_times_enabled;
 489 #else
 490 #define pm_print_times_enabled  (false)
 491 #endif
 492
 493 #ifdef CONFIG_PM_AUTOSLEEP
 494
 495 /* kernel/power/autosleep.c */
 496 void queue_up_suspend_work(void);
 497
 498 #else /* !CONFIG_PM_AUTOSLEEP */
 499
 500 static inline void queue_up_suspend_work(void) {}
 501
 502 #endif /* !CONFIG_PM_AUTOSLEEP */
 503
 504 #ifdef CONFIG_ARCH_SAVE_PAGE_KEYS
 505 /*
 506  * The ARCH_SAVE_PAGE_KEYS functions can be used by an architecture
 507  * to save/restore additional information to/from the array of page
 508  * frame numbers in the hibernation image. For s390 this is used to
 509  * save and restore the storage key for each page that is included
 510  * in the hibernation image.
 511  */
 512 unsigned long page_key_additional_pages(unsigned long pages);
 513 int page_key_alloc(unsigned long pages);
 514 void page_key_free(void);
 515 void page_key_read(unsigned long *pfn);
 516 void page_key_memorize(unsigned long *pfn);
 517 void page_key_write(void *address);
 518
 519 #else /* !CONFIG_ARCH_SAVE_PAGE_KEYS */
 520
 521 static inline unsigned long page_key_additional_pages(unsigned long pages)
 522 {
 523         return 0;
 524 }
 525
 526 static inline int  page_key_alloc(unsigned long pages)
 527 {
 528         return 0;
 529 }
 530
 531 static inline void page_key_free(void) {}
 532 static inline void page_key_read(unsigned long *pfn) {}
 533 static inline void page_key_memorize(unsigned long *pfn) {}
 534 static inline void page_key_write(void *address) {}
 535
 536 #endif /* !CONFIG_ARCH_SAVE_PAGE_KEYS */
 537
 538 #endif /* _LINUX_SUSPEND_H */