PM: Separate hibernation code from suspend code
[linux-2.6.git] / kernel / power / power.h
1 #include <linux/suspend.h>
2 #include <linux/utsname.h>
3
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;
10         unsigned long           pages;
11         unsigned long           size;
12 } __attribute__((aligned(PAGE_SIZE)));
13
14
15
16 #ifdef CONFIG_SOFTWARE_SUSPEND
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)
27
28 extern struct hibernation_ops *hibernation_ops;
29 #endif
30
31 extern int pfn_is_nosave(unsigned long);
32
33 extern struct mutex pm_mutex;
34
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
45 extern struct kset power_subsys;
46
47 /* Preferred image size in bytes (default 500 MB) */
48 extern unsigned long image_size;
49 extern int in_suspend;
50 extern dev_t swsusp_resume_device;
51 extern sector_t swsusp_resume_block;
52
53 extern asmlinkage int swsusp_arch_suspend(void);
54 extern asmlinkage int swsusp_arch_resume(void);
55
56 extern int create_basic_memory_bitmaps(void);
57 extern void free_basic_memory_bitmaps(void);
58 extern unsigned int count_data_pages(void);
59
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
80 struct snapshot_handle {
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                                  */
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                                          */
103 };
104
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  */
109 #define data_of(handle) ((handle).buffer + (handle).buf_offset)
110
111 extern unsigned int snapshot_additional_pages(struct zone *zone);
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);
114 extern void snapshot_write_finalize(struct snapshot_handle *handle);
115 extern int snapshot_image_loaded(struct snapshot_handle *handle);
116
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
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)
138 #define SNAPSHOT_S2RAM                  _IO(SNAPSHOT_IOC_MAGIC, 11)
139 #define SNAPSHOT_PMOPS                  _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
140 #define SNAPSHOT_SET_SWAP_AREA          _IOW(SNAPSHOT_IOC_MAGIC, 13, \
141                                                         struct resume_swap_area)
142 #define SNAPSHOT_IOC_MAXNR      13
143
144 #define PMOPS_PREPARE   1
145 #define PMOPS_ENTER     2
146 #define PMOPS_FINISH    3
147
148 /* If unset, the snapshot device cannot be open. */
149 extern atomic_t snapshot_device_available;
150
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);
154
155 extern int swsusp_check(void);
156 extern int swsusp_shrink_memory(void);
157 extern void swsusp_free(void);
158 extern int swsusp_suspend(void);
159 extern int swsusp_resume(void);
160 extern int swsusp_read(void);
161 extern int swsusp_write(void);
162 extern void swsusp_close(void);
163 extern int suspend_enter(suspend_state_t state);
164
165 struct timeval;
166 extern void swsusp_show_speed(struct timeval *, struct timeval *,
167                                 unsigned int, char *);