power.h 7.9 KB

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