blob: 51381487103ff405263cb48983db8102ce7f73f8 [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
Rafael J. Wysocki56f99bc2007-05-06 14:50:52 -070017/*
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 Torvalds1da177e2005-04-16 15:20:36 -070027
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070028extern struct hibernation_ops *hibernation_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#endif
Stephen Hemmingera6d70982006-12-06 20:34:35 -080030
Vivek Goyal49c3df62007-05-02 19:27:07 +020031extern int pfn_is_nosave(unsigned long);
32
Stephen Hemmingera6d70982006-12-06 20:34:35 -080033extern struct mutex pm_mutex;
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define power_attr(_name) \
36static 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-Hartman823bccf2007-04-13 13:15:19 -070045extern struct kset power_subsys;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Rafael J. Wysocki853609b2006-02-01 03:05:07 -080047/* Preferred image size in bytes (default 500 MB) */
48extern unsigned long image_size;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080049extern int in_suspend;
Rafael J. Wysocki61159a32006-03-23 03:00:00 -080050extern dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080051extern sector_t swsusp_resume_block;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080052
Rafael J. Wysocki25761b62005-10-30 14:59:56 -080053extern asmlinkage int swsusp_arch_suspend(void);
54extern asmlinkage int swsusp_arch_resume(void);
55
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -070056extern int create_basic_memory_bitmaps(void);
57extern void free_basic_memory_bitmaps(void);
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -080058extern unsigned int count_data_pages(void);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080059
Rafael J. Wysockifb13a282006-09-25 23:32:46 -070060/**
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. Wysockif577eb32006-03-23 02:59:59 -080080struct snapshot_handle {
Rafael J. Wysockifb13a282006-09-25 23:32:46 -070081 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. Wysockifb13a282006-09-25 23:32:46 -070093 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. Wysockif577eb32006-03-23 02:59:59 -0800103};
104
Rafael J. Wysockifb13a282006-09-25 23:32:46 -0700105/* 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. Wysockif577eb32006-03-23 02:59:59 -0800109#define data_of(handle) ((handle).buffer + (handle).buf_offset)
110
Rafael J. Wysockib788db72006-09-25 23:32:54 -0700111extern unsigned int snapshot_additional_pages(struct zone *zone);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800112extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
113extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800114extern void snapshot_write_finalize(struct snapshot_handle *handle);
Rafael J. Wysockib788db72006-09-25 23:32:54 -0700115extern int snapshot_image_loaded(struct snapshot_handle *handle);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800116
Rafael J. Wysocki37b2ba12006-12-06 20:34:15 -0800117/*
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 */
122struct resume_swap_area {
123 loff_t offset;
124 u_int32_t dev;
125} __attribute__((packed));
126
Rafael J. Wysocki6e1819d2006-03-23 03:00:03 -0800127#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 Tettamanti9b238202006-03-23 03:00:09 -0800138#define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11)
Stefan Seyfried35926952006-12-06 20:34:06 -0800139#define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
Rafael J. Wysocki37b2ba12006-12-06 20:34:15 -0800140#define SNAPSHOT_SET_SWAP_AREA _IOW(SNAPSHOT_IOC_MAGIC, 13, \
141 struct resume_swap_area)
142#define SNAPSHOT_IOC_MAXNR 13
Stefan Seyfried35926952006-12-06 20:34:06 -0800143
144#define PMOPS_PREPARE 1
145#define PMOPS_ENTER 2
146#define PMOPS_FINISH 3
Rafael J. Wysocki6e1819d2006-03-23 03:00:03 -0800147
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700148/* If unset, the snapshot device cannot be open. */
149extern atomic_t snapshot_device_available;
150
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700151extern sector_t alloc_swapdev_block(int swap);
152extern void free_all_swap_pages(int swap);
153extern int swsusp_swap_in_use(void);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800154
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800155extern int swsusp_check(void);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800156extern int swsusp_shrink_memory(void);
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800157extern void swsusp_free(void);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800158extern int swsusp_suspend(void);
159extern int swsusp_resume(void);
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800160extern int swsusp_read(void);
161extern int swsusp_write(void);
162extern void swsusp_close(void);
Luca Tettamanti9b238202006-03-23 03:00:09 -0800163extern int suspend_enter(suspend_state_t state);
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800164
165struct timeval;
166extern void swsusp_show_speed(struct timeval *, struct timeval *,
167 unsigned int, char *);