power.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  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/disk.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 unsigned int count_data_pages(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. loff_t offset; /* number of the last byte ready for reading
  86. * or writing in the sequence
  87. */
  88. unsigned int cur; /* number of the block of PAGE_SIZE bytes the
  89. * next operation will refer to (ie. current)
  90. */
  91. unsigned int cur_offset; /* offset with respect to the current
  92. * block (for the next operation)
  93. */
  94. unsigned int prev; /* number of the block of PAGE_SIZE bytes that
  95. * was the current one previously
  96. */
  97. void *buffer; /* address of the block to read from
  98. * or write to
  99. */
  100. unsigned int buf_offset; /* location to read from or write to,
  101. * given as a displacement from 'buffer'
  102. */
  103. int sync_read; /* Set to one to notify the caller of
  104. * snapshot_write_next() that it may
  105. * need to call wait_on_bio_chain()
  106. */
  107. };
  108. /* This macro returns the address from/to which the caller of
  109. * snapshot_read_next()/snapshot_write_next() is allowed to
  110. * read/write data after the function returns
  111. */
  112. #define data_of(handle) ((handle).buffer + (handle).buf_offset)
  113. extern unsigned int snapshot_additional_pages(struct zone *zone);
  114. extern unsigned long snapshot_get_image_size(void);
  115. extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
  116. extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
  117. extern void snapshot_write_finalize(struct snapshot_handle *handle);
  118. extern int snapshot_image_loaded(struct snapshot_handle *handle);
  119. /* If unset, the snapshot device cannot be open. */
  120. extern atomic_t snapshot_device_available;
  121. extern sector_t alloc_swapdev_block(int swap);
  122. extern void free_all_swap_pages(int swap);
  123. extern int swsusp_swap_in_use(void);
  124. /*
  125. * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
  126. * the image header.
  127. */
  128. #define SF_PLATFORM_MODE 1
  129. /* kernel/power/disk.c */
  130. extern int swsusp_check(void);
  131. extern int swsusp_shrink_memory(void);
  132. extern void swsusp_free(void);
  133. extern int swsusp_read(unsigned int *flags_p);
  134. extern int swsusp_write(unsigned int flags);
  135. extern void swsusp_close(fmode_t);
  136. struct timeval;
  137. /* kernel/power/swsusp.c */
  138. extern void swsusp_show_speed(struct timeval *, struct timeval *,
  139. unsigned int, char *);
  140. #ifdef CONFIG_SUSPEND
  141. /* kernel/power/main.c */
  142. extern int suspend_devices_and_enter(suspend_state_t state);
  143. #else /* !CONFIG_SUSPEND */
  144. static inline int suspend_devices_and_enter(suspend_state_t state)
  145. {
  146. return -ENOSYS;
  147. }
  148. #endif /* !CONFIG_SUSPEND */
  149. #ifdef CONFIG_PM_SLEEP
  150. /* kernel/power/main.c */
  151. extern int pm_notifier_call_chain(unsigned long val);
  152. #endif
  153. #ifdef CONFIG_HIGHMEM
  154. unsigned int count_highmem_pages(void);
  155. int restore_highmem(void);
  156. #else
  157. static inline unsigned int count_highmem_pages(void) { return 0; }
  158. static inline int restore_highmem(void) { return 0; }
  159. #endif
  160. /*
  161. * Suspend test levels
  162. */
  163. enum {
  164. /* keep first */
  165. TEST_NONE,
  166. TEST_CORE,
  167. TEST_CPUS,
  168. TEST_PLATFORM,
  169. TEST_DEVICES,
  170. TEST_FREEZER,
  171. /* keep last */
  172. __TEST_AFTER_LAST
  173. };
  174. #define TEST_FIRST TEST_NONE
  175. #define TEST_MAX (__TEST_AFTER_LAST - 1)
  176. extern int pm_test_level;
  177. #ifdef CONFIG_SUSPEND_FREEZER
  178. static inline int suspend_freeze_processes(void)
  179. {
  180. return freeze_processes();
  181. }
  182. static inline void suspend_thaw_processes(void)
  183. {
  184. thaw_processes();
  185. }
  186. #else
  187. static inline int suspend_freeze_processes(void)
  188. {
  189. return 0;
  190. }
  191. static inline void suspend_thaw_processes(void)
  192. {
  193. }
  194. #endif