power.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. #include <linux/suspend.h>
  2. #include <linux/suspend_ioctls.h>
  3. #include <linux/utsname.h>
  4. #include <linux/freezer.h>
  5. struct swsusp_info {
  6. struct new_utsname uts;
  7. u32 version_code;
  8. unsigned long num_physpages;
  9. int cpus;
  10. unsigned long image_pages;
  11. unsigned long pages;
  12. unsigned long size;
  13. } __attribute__((aligned(PAGE_SIZE)));
  14. #ifdef CONFIG_HIBERNATION
  15. #ifdef CONFIG_ARCH_HIBERNATION_HEADER
  16. /* Maximum size of architecture specific data in a hibernation header */
  17. #define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
  18. extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
  19. extern int arch_hibernation_header_restore(void *addr);
  20. static inline int init_header_complete(struct swsusp_info *info)
  21. {
  22. return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
  23. }
  24. static inline char *check_image_kernel(struct swsusp_info *info)
  25. {
  26. return arch_hibernation_header_restore(info) ?
  27. "architecture specific data" : NULL;
  28. }
  29. #endif /* CONFIG_ARCH_HIBERNATION_HEADER */
  30. /*
  31. * Keep some memory free so that I/O operations can succeed without paging
  32. * [Might this be more than 4 MB?]
  33. */
  34. #define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
  35. /*
  36. * Keep 1 MB of memory free so that device drivers can allocate some pages in
  37. * their .suspend() routines without breaking the suspend to disk.
  38. */
  39. #define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
  40. /* kernel/power/hibernate.c */
  41. extern int hibernation_snapshot(int platform_mode);
  42. extern int hibernation_restore(int platform_mode);
  43. extern int hibernation_platform_enter(void);
  44. #endif
  45. extern int pfn_is_nosave(unsigned long);
  46. #define power_attr(_name) \
  47. static struct kobj_attribute _name##_attr = { \
  48. .attr = { \
  49. .name = __stringify(_name), \
  50. .mode = 0644, \
  51. }, \
  52. .show = _name##_show, \
  53. .store = _name##_store, \
  54. }
  55. /* Preferred image size in bytes (default 500 MB) */
  56. extern unsigned long image_size;
  57. extern int in_suspend;
  58. extern dev_t swsusp_resume_device;
  59. extern sector_t swsusp_resume_block;
  60. extern asmlinkage int swsusp_arch_suspend(void);
  61. extern asmlinkage int swsusp_arch_resume(void);
  62. extern int create_basic_memory_bitmaps(void);
  63. extern void free_basic_memory_bitmaps(void);
  64. extern int hibernate_preallocate_memory(void);
  65. /**
  66. * Auxiliary structure used for reading the snapshot image data and
  67. * metadata from and writing them to the list of page backup entries
  68. * (PBEs) which is the main data structure of swsusp.
  69. *
  70. * Using struct snapshot_handle we can transfer the image, including its
  71. * metadata, as a continuous sequence of bytes with the help of
  72. * snapshot_read_next() and snapshot_write_next().
  73. *
  74. * The code that writes the image to a storage or transfers it to
  75. * the user land is required to use snapshot_read_next() for this
  76. * purpose and it should not make any assumptions regarding the internal
  77. * structure of the image. Similarly, the code that reads the image from
  78. * a storage or transfers it from the user land is required to use
  79. * snapshot_write_next().
  80. *
  81. * This may allow us to change the internal structure of the image
  82. * in the future with considerably less effort.
  83. */
  84. struct snapshot_handle {
  85. unsigned int cur; /* number of the block of PAGE_SIZE bytes the
  86. * next operation will refer to (ie. current)
  87. */
  88. void *buffer; /* address of the block to read from
  89. * or write to
  90. */
  91. int sync_read; /* Set to one to notify the caller of
  92. * snapshot_write_next() that it may
  93. * need to call wait_on_bio_chain()
  94. */
  95. };
  96. /* This macro returns the address from/to which the caller of
  97. * snapshot_read_next()/snapshot_write_next() is allowed to
  98. * read/write data after the function returns
  99. */
  100. #define data_of(handle) ((handle).buffer)
  101. extern unsigned int snapshot_additional_pages(struct zone *zone);
  102. extern unsigned long snapshot_get_image_size(void);
  103. extern int snapshot_read_next(struct snapshot_handle *handle);
  104. extern int snapshot_write_next(struct snapshot_handle *handle);
  105. extern void snapshot_write_finalize(struct snapshot_handle *handle);
  106. extern int snapshot_image_loaded(struct snapshot_handle *handle);
  107. /* If unset, the snapshot device cannot be open. */
  108. extern atomic_t snapshot_device_available;
  109. extern sector_t alloc_swapdev_block(int swap);
  110. extern void free_all_swap_pages(int swap);
  111. extern int swsusp_swap_in_use(void);
  112. /*
  113. * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
  114. * the image header.
  115. */
  116. #define SF_PLATFORM_MODE 1
  117. /* kernel/power/hibernate.c */
  118. extern int swsusp_check(void);
  119. extern void swsusp_free(void);
  120. extern int swsusp_read(unsigned int *flags_p);
  121. extern int swsusp_write(unsigned int flags);
  122. extern void swsusp_close(fmode_t);
  123. /* kernel/power/block_io.c */
  124. extern struct block_device *hib_resume_bdev;
  125. extern int hib_bio_read_page(pgoff_t page_off, void *addr,
  126. struct bio **bio_chain);
  127. extern int hib_bio_write_page(pgoff_t page_off, void *addr,
  128. struct bio **bio_chain);
  129. extern int hib_wait_on_bio_chain(struct bio **bio_chain);
  130. struct timeval;
  131. /* kernel/power/swsusp.c */
  132. extern void swsusp_show_speed(struct timeval *, struct timeval *,
  133. unsigned int, char *);
  134. #ifdef CONFIG_SUSPEND
  135. /* kernel/power/suspend.c */
  136. extern const char *const pm_states[];
  137. extern bool valid_state(suspend_state_t state);
  138. extern int suspend_devices_and_enter(suspend_state_t state);
  139. extern int enter_state(suspend_state_t state);
  140. #else /* !CONFIG_SUSPEND */
  141. static inline int suspend_devices_and_enter(suspend_state_t state)
  142. {
  143. return -ENOSYS;
  144. }
  145. static inline int enter_state(suspend_state_t state) { return -ENOSYS; }
  146. static inline bool valid_state(suspend_state_t state) { return false; }
  147. #endif /* !CONFIG_SUSPEND */
  148. #ifdef CONFIG_PM_TEST_SUSPEND
  149. /* kernel/power/suspend_test.c */
  150. extern void suspend_test_start(void);
  151. extern void suspend_test_finish(const char *label);
  152. #else /* !CONFIG_PM_TEST_SUSPEND */
  153. static inline void suspend_test_start(void) {}
  154. static inline void suspend_test_finish(const char *label) {}
  155. #endif /* !CONFIG_PM_TEST_SUSPEND */
  156. #ifdef CONFIG_PM_SLEEP
  157. /* kernel/power/main.c */
  158. extern int pm_notifier_call_chain(unsigned long val);
  159. #endif
  160. #ifdef CONFIG_HIGHMEM
  161. int restore_highmem(void);
  162. #else
  163. static inline unsigned int count_highmem_pages(void) { return 0; }
  164. static inline int restore_highmem(void) { return 0; }
  165. #endif
  166. /*
  167. * Suspend test levels
  168. */
  169. enum {
  170. /* keep first */
  171. TEST_NONE,
  172. TEST_CORE,
  173. TEST_CPUS,
  174. TEST_PLATFORM,
  175. TEST_DEVICES,
  176. TEST_FREEZER,
  177. /* keep last */
  178. __TEST_AFTER_LAST
  179. };
  180. #define TEST_FIRST TEST_NONE
  181. #define TEST_MAX (__TEST_AFTER_LAST - 1)
  182. extern int pm_test_level;
  183. #ifdef CONFIG_SUSPEND_FREEZER
  184. static inline int suspend_freeze_processes(void)
  185. {
  186. return freeze_processes();
  187. }
  188. static inline void suspend_thaw_processes(void)
  189. {
  190. thaw_processes();
  191. }
  192. #else
  193. static inline int suspend_freeze_processes(void)
  194. {
  195. return 0;
  196. }
  197. static inline void suspend_thaw_processes(void)
  198. {
  199. }
  200. #endif