blob: 195dc4611764b08a65780976a6231aaf004889fe [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
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +020014#ifdef CONFIG_HIBERNATION
Rafael J. Wysockid307c4a2007-10-18 03:04:52 -070015#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
19extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
20extern int arch_hibernation_header_restore(void *addr);
21
22static inline int init_header_complete(struct swsusp_info *info)
23{
24 return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
25}
26
27static inline char *check_image_kernel(struct swsusp_info *info)
28{
29 return arch_hibernation_header_restore(info) ?
30 "architecture specific data" : NULL;
31}
32#endif /* CONFIG_ARCH_HIBERNATION_HEADER */
33
Rafael J. Wysocki56f99bc2007-05-06 14:50:52 -070034/*
35 * Keep some memory free so that I/O operations can succeed without paging
36 * [Might this be more than 4 MB?]
37 */
38#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
Rafael J. Wysockid307c4a2007-10-18 03:04:52 -070039
Rafael J. Wysocki56f99bc2007-05-06 14:50:52 -070040/*
41 * Keep 1 MB of memory free so that device drivers can allocate some pages in
42 * their .suspend() routines without breaking the suspend to disk.
43 */
44#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -070046/* kernel/power/disk.c */
47extern int hibernation_snapshot(int platform_mode);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -070048extern int hibernation_restore(int platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -070049extern int hibernation_platform_enter(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#endif
Stephen Hemmingera6d70982006-12-06 20:34:35 -080051
Vivek Goyal49c3df62007-05-02 19:27:07 +020052extern int pfn_is_nosave(unsigned long);
53
Stephen Hemmingera6d70982006-12-06 20:34:35 -080054extern struct mutex pm_mutex;
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#define power_attr(_name) \
57static struct subsys_attribute _name##_attr = { \
58 .attr = { \
59 .name = __stringify(_name), \
60 .mode = 0644, \
61 }, \
62 .show = _name##_show, \
63 .store = _name##_store, \
64}
65
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -070066extern struct kset power_subsys;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Rafael J. Wysocki853609b2006-02-01 03:05:07 -080068/* Preferred image size in bytes (default 500 MB) */
69extern unsigned long image_size;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080070extern int in_suspend;
Rafael J. Wysocki61159a32006-03-23 03:00:00 -080071extern dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080072extern sector_t swsusp_resume_block;
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080073
Rafael J. Wysocki25761b62005-10-30 14:59:56 -080074extern asmlinkage int swsusp_arch_suspend(void);
75extern asmlinkage int swsusp_arch_resume(void);
76
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -070077extern int create_basic_memory_bitmaps(void);
78extern void free_basic_memory_bitmaps(void);
Rafael J. Wysocki72a97e02006-01-06 00:13:46 -080079extern unsigned int count_data_pages(void);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -080080
Rafael J. Wysockifb13a282006-09-25 23:32:46 -070081/**
82 * Auxiliary structure used for reading the snapshot image data and
83 * metadata from and writing them to the list of page backup entries
84 * (PBEs) which is the main data structure of swsusp.
85 *
86 * Using struct snapshot_handle we can transfer the image, including its
87 * metadata, as a continuous sequence of bytes with the help of
88 * snapshot_read_next() and snapshot_write_next().
89 *
90 * The code that writes the image to a storage or transfers it to
91 * the user land is required to use snapshot_read_next() for this
92 * purpose and it should not make any assumptions regarding the internal
93 * structure of the image. Similarly, the code that reads the image from
94 * a storage or transfers it from the user land is required to use
95 * snapshot_write_next().
96 *
97 * This may allow us to change the internal structure of the image
98 * in the future with considerably less effort.
99 */
100
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800101struct snapshot_handle {
Rafael J. Wysockifb13a282006-09-25 23:32:46 -0700102 loff_t offset; /* number of the last byte ready for reading
103 * or writing in the sequence
104 */
105 unsigned int cur; /* number of the block of PAGE_SIZE bytes the
106 * next operation will refer to (ie. current)
107 */
108 unsigned int cur_offset; /* offset with respect to the current
109 * block (for the next operation)
110 */
111 unsigned int prev; /* number of the block of PAGE_SIZE bytes that
112 * was the current one previously
113 */
Rafael J. Wysockifb13a282006-09-25 23:32:46 -0700114 void *buffer; /* address of the block to read from
115 * or write to
116 */
117 unsigned int buf_offset; /* location to read from or write to,
118 * given as a displacement from 'buffer'
119 */
120 int sync_read; /* Set to one to notify the caller of
121 * snapshot_write_next() that it may
122 * need to call wait_on_bio_chain()
123 */
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800124};
125
Rafael J. Wysockifb13a282006-09-25 23:32:46 -0700126/* This macro returns the address from/to which the caller of
127 * snapshot_read_next()/snapshot_write_next() is allowed to
128 * read/write data after the function returns
129 */
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800130#define data_of(handle) ((handle).buffer + (handle).buf_offset)
131
Rafael J. Wysockib788db72006-09-25 23:32:54 -0700132extern unsigned int snapshot_additional_pages(struct zone *zone);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800133extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
134extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800135extern void snapshot_write_finalize(struct snapshot_handle *handle);
Rafael J. Wysockib788db72006-09-25 23:32:54 -0700136extern int snapshot_image_loaded(struct snapshot_handle *handle);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800137
Rafael J. Wysocki37b2ba12006-12-06 20:34:15 -0800138/*
139 * This structure is used to pass the values needed for the identification
140 * of the resume swap area from a user space to the kernel via the
141 * SNAPSHOT_SET_SWAP_AREA ioctl
142 */
143struct resume_swap_area {
144 loff_t offset;
145 u_int32_t dev;
146} __attribute__((packed));
147
Rafael J. Wysocki6e1819d2006-03-23 03:00:03 -0800148#define SNAPSHOT_IOC_MAGIC '3'
149#define SNAPSHOT_FREEZE _IO(SNAPSHOT_IOC_MAGIC, 1)
150#define SNAPSHOT_UNFREEZE _IO(SNAPSHOT_IOC_MAGIC, 2)
151#define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
152#define SNAPSHOT_ATOMIC_RESTORE _IO(SNAPSHOT_IOC_MAGIC, 4)
153#define SNAPSHOT_FREE _IO(SNAPSHOT_IOC_MAGIC, 5)
154#define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
155#define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
156#define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *)
157#define SNAPSHOT_FREE_SWAP_PAGES _IO(SNAPSHOT_IOC_MAGIC, 9)
158#define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
Luca Tettamanti9b238202006-03-23 03:00:09 -0800159#define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11)
Stefan Seyfried35926952006-12-06 20:34:06 -0800160#define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
Rafael J. Wysocki37b2ba12006-12-06 20:34:15 -0800161#define SNAPSHOT_SET_SWAP_AREA _IOW(SNAPSHOT_IOC_MAGIC, 13, \
162 struct resume_swap_area)
163#define SNAPSHOT_IOC_MAXNR 13
Stefan Seyfried35926952006-12-06 20:34:06 -0800164
165#define PMOPS_PREPARE 1
166#define PMOPS_ENTER 2
167#define PMOPS_FINISH 3
Rafael J. Wysocki6e1819d2006-03-23 03:00:03 -0800168
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700169/* If unset, the snapshot device cannot be open. */
170extern atomic_t snapshot_device_available;
171
Rafael J. Wysockid1d241c2007-05-06 14:50:47 -0700172extern sector_t alloc_swapdev_block(int swap);
173extern void free_all_swap_pages(int swap);
174extern int swsusp_swap_in_use(void);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800175
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700176/*
177 * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
178 * the image header.
179 */
180#define SF_PLATFORM_MODE 1
181
182/* kernel/power/disk.c */
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800183extern int swsusp_check(void);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800184extern int swsusp_shrink_memory(void);
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800185extern void swsusp_free(void);
Rafael J. Wysocki61159a32006-03-23 03:00:00 -0800186extern int swsusp_resume(void);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700187extern int swsusp_read(unsigned int *flags_p);
188extern int swsusp_write(unsigned int flags);
Randy Dunlap74c7e2e2006-03-23 03:00:01 -0800189extern void swsusp_close(void);
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800190
191struct timeval;
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700192/* kernel/power/swsusp.c */
Rafael J. Wysocki0d3a9ab2006-12-06 20:34:32 -0800193extern void swsusp_show_speed(struct timeval *, struct timeval *,
194 unsigned int, char *);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700195
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200196#ifdef CONFIG_SUSPEND
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700197/* kernel/power/main.c */
Rafael J. Wysocki6c961df2007-07-19 01:47:38 -0700198extern int suspend_devices_and_enter(suspend_state_t state);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200199#else /* !CONFIG_SUSPEND */
200static inline int suspend_devices_and_enter(suspend_state_t state)
201{
202 return -ENOSYS;
203}
204#endif /* !CONFIG_SUSPEND */
205
206/* kernel/power/common.c */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700207extern struct blocking_notifier_head pm_chain_head;
208
209static inline int pm_notifier_call_chain(unsigned long val)
210{
211 return (blocking_notifier_call_chain(&pm_chain_head, val, NULL)
212 == NOTIFY_BAD) ? -EINVAL : 0;
213}