blob: adaf7d4fbdaf468f6b99131572ec5c95904384a3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#include <linux/suspend.h>
2#include <linux/utsname.h>
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004struct 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. Wysocki7088a5c2006-01-06 00:13:05 -080010 unsigned long pages;
Rafael J. Wysocki6e1819d2006-03-23 03:00:03 -080011 unsigned long size;
Linus Torvalds1da177e2005-04-16 15:20:36 -070012} __attribute__((aligned(PAGE_SIZE)));
13
14
15
16#ifdef CONFIG_SOFTWARE_SUSPEND
17extern int pm_suspend_disk(void);
18
19#else
20static inline int pm_suspend_disk(void)
21{
22 return -EPERM;
23}
24#endif
25extern struct semaphore pm_sem;
26#define power_attr(_name) \
27static struct subsys_attribute _name##_attr = { \
28 .attr = { \
29 .name = __stringify(_name), \
30 .mode = 0644, \
31 }, \
32 .show = _name##_show, \
33 .store = _name##_store, \
34}
35
36extern struct subsystem power_subsys;
37
Rafael J. Wysocki25761b62005-10-30 14:59:56 -080038/* References to section boundaries */
39extern const void __nosave_begin, __nosave_end;
40
Rafael J. Wysocki853609b2006-02-01 03:05:07 -080041/* Preferred image size in bytes (default 500 MB) */
42extern unsigned long image_size;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080043extern int in_suspend;
Rafael J. Wysocki61159a32006-03-23 03:00:00 -080044extern dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080045extern sector_t swsusp_resume_block;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080046
Rafael J. Wysocki25761b62005-10-30 14:59:56 -080047extern asmlinkage int swsusp_arch_suspend(void);
48extern asmlinkage int swsusp_arch_resume(void);
49
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -080050extern unsigned int count_data_pages(void);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080051
Rafael J. Wysockifb13a282006-09-25 23:32:46 -070052/**
53 * Auxiliary structure used for reading the snapshot image data and
54 * metadata from and writing them to the list of page backup entries
55 * (PBEs) which is the main data structure of swsusp.
56 *
57 * Using struct snapshot_handle we can transfer the image, including its
58 * metadata, as a continuous sequence of bytes with the help of
59 * snapshot_read_next() and snapshot_write_next().
60 *
61 * The code that writes the image to a storage or transfers it to
62 * the user land is required to use snapshot_read_next() for this
63 * purpose and it should not make any assumptions regarding the internal
64 * structure of the image. Similarly, the code that reads the image from
65 * a storage or transfers it from the user land is required to use
66 * snapshot_write_next().
67 *
68 * This may allow us to change the internal structure of the image
69 * in the future with considerably less effort.
70 */
71
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080072struct snapshot_handle {
Rafael J. Wysockifb13a282006-09-25 23:32:46 -070073 loff_t offset; /* number of the last byte ready for reading
74 * or writing in the sequence
75 */
76 unsigned int cur; /* number of the block of PAGE_SIZE bytes the
77 * next operation will refer to (ie. current)
78 */
79 unsigned int cur_offset; /* offset with respect to the current
80 * block (for the next operation)
81 */
82 unsigned int prev; /* number of the block of PAGE_SIZE bytes that
83 * was the current one previously
84 */
Rafael J. Wysockifb13a282006-09-25 23:32:46 -070085 void *buffer; /* address of the block to read from
86 * or write to
87 */
88 unsigned int buf_offset; /* location to read from or write to,
89 * given as a displacement from 'buffer'
90 */
91 int sync_read; /* Set to one to notify the caller of
92 * snapshot_write_next() that it may
93 * need to call wait_on_bio_chain()
94 */
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080095};
96
Rafael J. Wysockifb13a282006-09-25 23:32:46 -070097/* This macro returns the address from/to which the caller of
98 * snapshot_read_next()/snapshot_write_next() is allowed to
99 * read/write data after the function returns
100 */
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800101#define data_of(handle) ((handle).buffer + (handle).buf_offset)
102
Rafael J. Wysockib788db72006-09-25 23:32:54 -0700103extern unsigned int snapshot_additional_pages(struct zone *zone);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800104extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
105extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
Rafael J. Wysockib788db72006-09-25 23:32:54 -0700106extern int snapshot_image_loaded(struct snapshot_handle *handle);
Rafael J. Wysocki940864d2006-09-25 23:32:55 -0700107extern void snapshot_free_unused_memory(struct snapshot_handle *handle);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800108
Rafael J. Wysocki6e1819d2006-03-23 03:00:03 -0800109#define SNAPSHOT_IOC_MAGIC '3'
110#define SNAPSHOT_FREEZE _IO(SNAPSHOT_IOC_MAGIC, 1)
111#define SNAPSHOT_UNFREEZE _IO(SNAPSHOT_IOC_MAGIC, 2)
112#define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
113#define SNAPSHOT_ATOMIC_RESTORE _IO(SNAPSHOT_IOC_MAGIC, 4)
114#define SNAPSHOT_FREE _IO(SNAPSHOT_IOC_MAGIC, 5)
115#define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
116#define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
117#define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *)
118#define SNAPSHOT_FREE_SWAP_PAGES _IO(SNAPSHOT_IOC_MAGIC, 9)
119#define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
Luca Tettamanti9b238202006-03-23 03:00:09 -0800120#define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11)
Stefan Seyfried35926952006-12-06 20:34:06 -0800121#define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
122#define SNAPSHOT_IOC_MAXNR 12
123
124#define PMOPS_PREPARE 1
125#define PMOPS_ENTER 2
126#define PMOPS_FINISH 3
Rafael J. Wysocki6e1819d2006-03-23 03:00:03 -0800127
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800128/**
129 * The bitmap is used for tracing allocated swap pages
130 *
131 * The entire bitmap consists of a number of bitmap_page
132 * structures linked with the help of the .next member.
133 * Thus each page can be allocated individually, so we only
134 * need to make 0-order memory allocations to create
135 * the bitmap.
136 */
137
138#define BITMAP_PAGE_SIZE (PAGE_SIZE - sizeof(void *))
139#define BITMAP_PAGE_CHUNKS (BITMAP_PAGE_SIZE / sizeof(long))
140#define BITS_PER_CHUNK (sizeof(long) * 8)
141#define BITMAP_PAGE_BITS (BITMAP_PAGE_CHUNKS * BITS_PER_CHUNK)
142
143struct bitmap_page {
144 unsigned long chunks[BITMAP_PAGE_CHUNKS];
145 struct bitmap_page *next;
146};
147
148extern void free_bitmap(struct bitmap_page *bitmap);
149extern struct bitmap_page *alloc_bitmap(unsigned int nr_bits);
Rafael J. Wysocki3aef83e2006-12-06 20:34:10 -0800150extern sector_t alloc_swapdev_block(int swap, struct bitmap_page *bitmap);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800151extern void free_all_swap_pages(int swap, struct bitmap_page *bitmap);
152
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800153extern int swsusp_check(void);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800154extern int swsusp_shrink_memory(void);
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800155extern void swsusp_free(void);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800156extern int swsusp_suspend(void);
157extern int swsusp_resume(void);
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800158extern int swsusp_read(void);
159extern int swsusp_write(void);
160extern void swsusp_close(void);
Luca Tettamanti9b238202006-03-23 03:00:09 -0800161extern int suspend_enter(suspend_state_t state);