power.h 8.6 KB

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