power.h 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  1. #include <linux/suspend.h>
  2. #include <linux/utsname.h>
  3. struct swsusp_info {
  4. struct new_utsname uts;
  5. u32 version_code;
  6. unsigned long num_physpages;
  7. int cpus;
  8. unsigned long image_pages;
  9. unsigned long pages;
  10. unsigned long size;
  11. } __attribute__((aligned(PAGE_SIZE)));
  12. #ifdef CONFIG_SOFTWARE_SUSPEND
  13. /*
  14. * Keep some memory free so that I/O operations can succeed without paging
  15. * [Might this be more than 4 MB?]
  16. */
  17. #define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
  18. /*
  19. * Keep 1 MB of memory free so that device drivers can allocate some pages in
  20. * their .suspend() routines without breaking the suspend to disk.
  21. */
  22. #define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
  23. /* kernel/power/disk.c */
  24. extern int hibernation_snapshot(int platform_mode);
  25. extern int hibernation_restore(int platform_mode);
  26. extern int hibernation_platform_enter(void);
  27. #endif
  28. extern int pfn_is_nosave(unsigned long);
  29. extern struct mutex pm_mutex;
  30. #define power_attr(_name) \
  31. static struct subsys_attribute _name##_attr = { \
  32. .attr = { \
  33. .name = __stringify(_name), \
  34. .mode = 0644, \
  35. }, \
  36. .show = _name##_show, \
  37. .store = _name##_store, \
  38. }
  39. extern struct kset power_subsys;
  40. /* Preferred image size in bytes (default 500 MB) */
  41. extern unsigned long image_size;
  42. extern int in_suspend;
  43. extern dev_t swsusp_resume_device;
  44. extern sector_t swsusp_resume_block;
  45. extern asmlinkage int swsusp_arch_suspend(void);
  46. extern asmlinkage int swsusp_arch_resume(void);
  47. extern int create_basic_memory_bitmaps(void);
  48. extern void free_basic_memory_bitmaps(void);
  49. extern unsigned int count_data_pages(void);
  50. /**
  51. * Auxiliary structure used for reading the snapshot image data and
  52. * metadata from and writing them to the list of page backup entries
  53. * (PBEs) which is the main data structure of swsusp.
  54. *
  55. * Using struct snapshot_handle we can transfer the image, including its
  56. * metadata, as a continuous sequence of bytes with the help of
  57. * snapshot_read_next() and snapshot_write_next().
  58. *
  59. * The code that writes the image to a storage or transfers it to
  60. * the user land is required to use snapshot_read_next() for this
  61. * purpose and it should not make any assumptions regarding the internal
  62. * structure of the image. Similarly, the code that reads the image from
  63. * a storage or transfers it from the user land is required to use
  64. * snapshot_write_next().
  65. *
  66. * This may allow us to change the internal structure of the image
  67. * in the future with considerably less effort.
  68. */
  69. struct snapshot_handle {
  70. loff_t offset; /* number of the last byte ready for reading
  71. * or writing in the sequence
  72. */
  73. unsigned int cur; /* number of the block of PAGE_SIZE bytes the
  74. * next operation will refer to (ie. current)
  75. */
  76. unsigned int cur_offset; /* offset with respect to the current
  77. * block (for the next operation)
  78. */
  79. unsigned int prev; /* number of the block of PAGE_SIZE bytes that
  80. * was the current one previously
  81. */
  82. void *buffer; /* address of the block to read from
  83. * or write to
  84. */
  85. unsigned int buf_offset; /* location to read from or write to,
  86. * given as a displacement from 'buffer'
  87. */
  88. int sync_read; /* Set to one to notify the caller of
  89. * snapshot_write_next() that it may
  90. * need to call wait_on_bio_chain()
  91. */
  92. };
  93. /* This macro returns the address from/to which the caller of
  94. * snapshot_read_next()/snapshot_write_next() is allowed to
  95. * read/write data after the function returns
  96. */
  97. #define data_of(handle) ((handle).buffer + (handle).buf_offset)
  98. extern unsigned int snapshot_additional_pages(struct zone *zone);
  99. extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
  100. extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
  101. extern void snapshot_write_finalize(struct snapshot_handle *handle);
  102. extern int snapshot_image_loaded(struct snapshot_handle *handle);
  103. /*
  104. * This structure is used to pass the values needed for the identification
  105. * of the resume swap area from a user space to the kernel via the
  106. * SNAPSHOT_SET_SWAP_AREA ioctl
  107. */
  108. struct resume_swap_area {
  109. loff_t offset;
  110. u_int32_t dev;
  111. } __attribute__((packed));
  112. #define SNAPSHOT_IOC_MAGIC '3'
  113. #define SNAPSHOT_FREEZE _IO(SNAPSHOT_IOC_MAGIC, 1)
  114. #define SNAPSHOT_UNFREEZE _IO(SNAPSHOT_IOC_MAGIC, 2)
  115. #define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
  116. #define SNAPSHOT_ATOMIC_RESTORE _IO(SNAPSHOT_IOC_MAGIC, 4)
  117. #define SNAPSHOT_FREE _IO(SNAPSHOT_IOC_MAGIC, 5)
  118. #define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
  119. #define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
  120. #define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *)
  121. #define SNAPSHOT_FREE_SWAP_PAGES _IO(SNAPSHOT_IOC_MAGIC, 9)
  122. #define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
  123. #define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11)
  124. #define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
  125. #define SNAPSHOT_SET_SWAP_AREA _IOW(SNAPSHOT_IOC_MAGIC, 13, \
  126. struct resume_swap_area)
  127. #define SNAPSHOT_IOC_MAXNR 13
  128. #define PMOPS_PREPARE 1
  129. #define PMOPS_ENTER 2
  130. #define PMOPS_FINISH 3
  131. /* If unset, the snapshot device cannot be open. */
  132. extern atomic_t snapshot_device_available;
  133. extern sector_t alloc_swapdev_block(int swap);
  134. extern void free_all_swap_pages(int swap);
  135. extern int swsusp_swap_in_use(void);
  136. /*
  137. * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
  138. * the image header.
  139. */
  140. #define SF_PLATFORM_MODE 1
  141. /* kernel/power/disk.c */
  142. extern int swsusp_check(void);
  143. extern int swsusp_shrink_memory(void);
  144. extern void swsusp_free(void);
  145. extern int swsusp_suspend(void);
  146. extern int swsusp_resume(void);
  147. extern int swsusp_read(unsigned int *flags_p);
  148. extern int swsusp_write(unsigned int flags);
  149. extern void swsusp_close(void);
  150. struct timeval;
  151. /* kernel/power/swsusp.c */
  152. extern void swsusp_show_speed(struct timeval *, struct timeval *,
  153. unsigned int, char *);
  154. /* kernel/power/main.c */
  155. extern int suspend_enter(suspend_state_t state);
  156. extern int suspend_devices_and_enter(suspend_state_t state);
  157. extern struct blocking_notifier_head pm_chain_head;
  158. static inline int pm_notifier_call_chain(unsigned long val)
  159. {
  160. return (blocking_notifier_call_chain(&pm_chain_head, val, NULL)
  161. == NOTIFY_BAD) ? -EINVAL : 0;
  162. }