Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #include <linux/suspend.h> |
| 2 | #include <linux/utsname.h> |
| 3 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 4 | struct swsusp_info { |
| 5 | struct new_utsname uts; |
| 6 | u32 version_code; |
| 7 | unsigned long num_physpages; |
| 8 | int cpus; |
| 9 | unsigned long image_pages; |
Rafael J. Wysocki | 7088a5c | 2006-01-06 00:13:05 -0800 | [diff] [blame] | 10 | unsigned long pages; |
Rafael J. Wysocki | 6e1819d | 2006-03-23 03:00:03 -0800 | [diff] [blame] | 11 | unsigned long size; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 12 | } __attribute__((aligned(PAGE_SIZE))); |
| 13 | |
| 14 | |
| 15 | |
| 16 | #ifdef CONFIG_SOFTWARE_SUSPEND |
Rafael J. Wysocki | 56f99bc | 2007-05-06 14:50:52 -0700 | [diff] [blame] | 17 | /* |
| 18 | * Keep some memory free so that I/O operations can succeed without paging |
| 19 | * [Might this be more than 4 MB?] |
| 20 | */ |
| 21 | #define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT) |
| 22 | /* |
| 23 | * Keep 1 MB of memory free so that device drivers can allocate some pages in |
| 24 | * their .suspend() routines without breaking the suspend to disk. |
| 25 | */ |
| 26 | #define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 28 | extern struct hibernation_ops *hibernation_ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | #endif |
Stephen Hemminger | a6d7098 | 2006-12-06 20:34:35 -0800 | [diff] [blame] | 30 | |
Vivek Goyal | 49c3df6 | 2007-05-02 19:27:07 +0200 | [diff] [blame] | 31 | extern int pfn_is_nosave(unsigned long); |
| 32 | |
Stephen Hemminger | a6d7098 | 2006-12-06 20:34:35 -0800 | [diff] [blame] | 33 | extern struct mutex pm_mutex; |
| 34 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | #define power_attr(_name) \ |
| 36 | static struct subsys_attribute _name##_attr = { \ |
| 37 | .attr = { \ |
| 38 | .name = __stringify(_name), \ |
| 39 | .mode = 0644, \ |
| 40 | }, \ |
| 41 | .show = _name##_show, \ |
| 42 | .store = _name##_store, \ |
| 43 | } |
| 44 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 45 | extern struct kset power_subsys; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | |
Rafael J. Wysocki | 853609b | 2006-02-01 03:05:07 -0800 | [diff] [blame] | 47 | /* Preferred image size in bytes (default 500 MB) */ |
| 48 | extern unsigned long image_size; |
Rafael J. Wysocki | f577eb3 | 2006-03-23 02:59:59 -0800 | [diff] [blame] | 49 | extern int in_suspend; |
Rafael J. Wysocki | 61159a3 | 2006-03-23 03:00:00 -0800 | [diff] [blame] | 50 | extern dev_t swsusp_resume_device; |
Rafael J. Wysocki | 9a154d9 | 2006-12-06 20:34:12 -0800 | [diff] [blame] | 51 | extern sector_t swsusp_resume_block; |
Rafael J. Wysocki | f577eb3 | 2006-03-23 02:59:59 -0800 | [diff] [blame] | 52 | |
Rafael J. Wysocki | 25761b6 | 2005-10-30 14:59:56 -0800 | [diff] [blame] | 53 | extern asmlinkage int swsusp_arch_suspend(void); |
| 54 | extern asmlinkage int swsusp_arch_resume(void); |
| 55 | |
Rafael J. Wysocki | 74dfd66 | 2007-05-06 14:50:43 -0700 | [diff] [blame] | 56 | extern int create_basic_memory_bitmaps(void); |
| 57 | extern void free_basic_memory_bitmaps(void); |
Rafael J. Wysocki | 72a97e0 | 2006-01-06 00:13:46 -0800 | [diff] [blame] | 58 | extern unsigned int count_data_pages(void); |
Rafael J. Wysocki | f577eb3 | 2006-03-23 02:59:59 -0800 | [diff] [blame] | 59 | |
Rafael J. Wysocki | fb13a28 | 2006-09-25 23:32:46 -0700 | [diff] [blame] | 60 | /** |
| 61 | * Auxiliary structure used for reading the snapshot image data and |
| 62 | * metadata from and writing them to the list of page backup entries |
| 63 | * (PBEs) which is the main data structure of swsusp. |
| 64 | * |
| 65 | * Using struct snapshot_handle we can transfer the image, including its |
| 66 | * metadata, as a continuous sequence of bytes with the help of |
| 67 | * snapshot_read_next() and snapshot_write_next(). |
| 68 | * |
| 69 | * The code that writes the image to a storage or transfers it to |
| 70 | * the user land is required to use snapshot_read_next() for this |
| 71 | * purpose and it should not make any assumptions regarding the internal |
| 72 | * structure of the image. Similarly, the code that reads the image from |
| 73 | * a storage or transfers it from the user land is required to use |
| 74 | * snapshot_write_next(). |
| 75 | * |
| 76 | * This may allow us to change the internal structure of the image |
| 77 | * in the future with considerably less effort. |
| 78 | */ |
| 79 | |
Rafael J. Wysocki | f577eb3 | 2006-03-23 02:59:59 -0800 | [diff] [blame] | 80 | struct snapshot_handle { |
Rafael J. Wysocki | fb13a28 | 2006-09-25 23:32:46 -0700 | [diff] [blame] | 81 | loff_t offset; /* number of the last byte ready for reading |
| 82 | * or writing in the sequence |
| 83 | */ |
| 84 | unsigned int cur; /* number of the block of PAGE_SIZE bytes the |
| 85 | * next operation will refer to (ie. current) |
| 86 | */ |
| 87 | unsigned int cur_offset; /* offset with respect to the current |
| 88 | * block (for the next operation) |
| 89 | */ |
| 90 | unsigned int prev; /* number of the block of PAGE_SIZE bytes that |
| 91 | * was the current one previously |
| 92 | */ |
Rafael J. Wysocki | fb13a28 | 2006-09-25 23:32:46 -0700 | [diff] [blame] | 93 | void *buffer; /* address of the block to read from |
| 94 | * or write to |
| 95 | */ |
| 96 | unsigned int buf_offset; /* location to read from or write to, |
| 97 | * given as a displacement from 'buffer' |
| 98 | */ |
| 99 | int sync_read; /* Set to one to notify the caller of |
| 100 | * snapshot_write_next() that it may |
| 101 | * need to call wait_on_bio_chain() |
| 102 | */ |
Rafael J. Wysocki | f577eb3 | 2006-03-23 02:59:59 -0800 | [diff] [blame] | 103 | }; |
| 104 | |
Rafael J. Wysocki | fb13a28 | 2006-09-25 23:32:46 -0700 | [diff] [blame] | 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 | */ |
Rafael J. Wysocki | f577eb3 | 2006-03-23 02:59:59 -0800 | [diff] [blame] | 109 | #define data_of(handle) ((handle).buffer + (handle).buf_offset) |
| 110 | |
Rafael J. Wysocki | b788db7 | 2006-09-25 23:32:54 -0700 | [diff] [blame] | 111 | extern unsigned int snapshot_additional_pages(struct zone *zone); |
Rafael J. Wysocki | f577eb3 | 2006-03-23 02:59:59 -0800 | [diff] [blame] | 112 | extern int snapshot_read_next(struct snapshot_handle *handle, size_t count); |
| 113 | extern int snapshot_write_next(struct snapshot_handle *handle, size_t count); |
Rafael J. Wysocki | 8357376 | 2006-12-06 20:34:18 -0800 | [diff] [blame] | 114 | extern void snapshot_write_finalize(struct snapshot_handle *handle); |
Rafael J. Wysocki | b788db7 | 2006-09-25 23:32:54 -0700 | [diff] [blame] | 115 | extern int snapshot_image_loaded(struct snapshot_handle *handle); |
Rafael J. Wysocki | 61159a3 | 2006-03-23 03:00:00 -0800 | [diff] [blame] | 116 | |
Rafael J. Wysocki | 37b2ba1 | 2006-12-06 20:34:15 -0800 | [diff] [blame] | 117 | /* |
| 118 | * This structure is used to pass the values needed for the identification |
| 119 | * of the resume swap area from a user space to the kernel via the |
| 120 | * SNAPSHOT_SET_SWAP_AREA ioctl |
| 121 | */ |
| 122 | struct resume_swap_area { |
| 123 | loff_t offset; |
| 124 | u_int32_t dev; |
| 125 | } __attribute__((packed)); |
| 126 | |
Rafael J. Wysocki | 6e1819d | 2006-03-23 03:00:03 -0800 | [diff] [blame] | 127 | #define SNAPSHOT_IOC_MAGIC '3' |
| 128 | #define SNAPSHOT_FREEZE _IO(SNAPSHOT_IOC_MAGIC, 1) |
| 129 | #define SNAPSHOT_UNFREEZE _IO(SNAPSHOT_IOC_MAGIC, 2) |
| 130 | #define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *) |
| 131 | #define SNAPSHOT_ATOMIC_RESTORE _IO(SNAPSHOT_IOC_MAGIC, 4) |
| 132 | #define SNAPSHOT_FREE _IO(SNAPSHOT_IOC_MAGIC, 5) |
| 133 | #define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long) |
| 134 | #define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *) |
| 135 | #define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *) |
| 136 | #define SNAPSHOT_FREE_SWAP_PAGES _IO(SNAPSHOT_IOC_MAGIC, 9) |
| 137 | #define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int) |
Luca Tettamanti | 9b23820 | 2006-03-23 03:00:09 -0800 | [diff] [blame] | 138 | #define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11) |
Stefan Seyfried | 3592695 | 2006-12-06 20:34:06 -0800 | [diff] [blame] | 139 | #define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int) |
Rafael J. Wysocki | 37b2ba1 | 2006-12-06 20:34:15 -0800 | [diff] [blame] | 140 | #define SNAPSHOT_SET_SWAP_AREA _IOW(SNAPSHOT_IOC_MAGIC, 13, \ |
| 141 | struct resume_swap_area) |
| 142 | #define SNAPSHOT_IOC_MAXNR 13 |
Stefan Seyfried | 3592695 | 2006-12-06 20:34:06 -0800 | [diff] [blame] | 143 | |
| 144 | #define PMOPS_PREPARE 1 |
| 145 | #define PMOPS_ENTER 2 |
| 146 | #define PMOPS_FINISH 3 |
Rafael J. Wysocki | 6e1819d | 2006-03-23 03:00:03 -0800 | [diff] [blame] | 147 | |
Rafael J. Wysocki | 0709db6 | 2007-05-06 14:50:45 -0700 | [diff] [blame] | 148 | /* If unset, the snapshot device cannot be open. */ |
| 149 | extern atomic_t snapshot_device_available; |
| 150 | |
Rafael J. Wysocki | d1d241c | 2007-05-06 14:50:47 -0700 | [diff] [blame] | 151 | extern sector_t alloc_swapdev_block(int swap); |
| 152 | extern void free_all_swap_pages(int swap); |
| 153 | extern int swsusp_swap_in_use(void); |
Rafael J. Wysocki | 61159a3 | 2006-03-23 03:00:00 -0800 | [diff] [blame] | 154 | |
Randy Dunlap | 74c7e2e | 2006-03-23 03:00:01 -0800 | [diff] [blame] | 155 | extern int swsusp_check(void); |
Rafael J. Wysocki | 61159a3 | 2006-03-23 03:00:00 -0800 | [diff] [blame] | 156 | extern int swsusp_shrink_memory(void); |
Randy Dunlap | 74c7e2e | 2006-03-23 03:00:01 -0800 | [diff] [blame] | 157 | extern void swsusp_free(void); |
Rafael J. Wysocki | 61159a3 | 2006-03-23 03:00:00 -0800 | [diff] [blame] | 158 | extern int swsusp_suspend(void); |
| 159 | extern int swsusp_resume(void); |
Randy Dunlap | 74c7e2e | 2006-03-23 03:00:01 -0800 | [diff] [blame] | 160 | extern int swsusp_read(void); |
| 161 | extern int swsusp_write(void); |
| 162 | extern void swsusp_close(void); |
Luca Tettamanti | 9b23820 | 2006-03-23 03:00:09 -0800 | [diff] [blame] | 163 | extern int suspend_enter(suspend_state_t state); |
Rafael J. Wysocki | 0d3a9ab | 2006-12-06 20:34:32 -0800 | [diff] [blame] | 164 | |
| 165 | struct timeval; |
| 166 | extern void swsusp_show_speed(struct timeval *, struct timeval *, |
| 167 | unsigned int, char *); |