Merge branch 'for-linus' of git://one.firstfloor.org/home/andi/git/linux-2.6
[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 extern int pm_suspend_disk(void);
18
19 #else
20 static inline int pm_suspend_disk(void)
21 {
22         return -EPERM;
23 }
24 #endif
25
26 extern int pfn_is_nosave(unsigned long);
27
28 extern struct mutex pm_mutex;
29
30 #define power_attr(_name) \
31 static struct subsys_attribute _name##_attr = { \
32         .attr   = {                             \
33                 .name = __stringify(_name),     \
34                 .mode = 0644,                   \
35         },                                      \
36         .show   = _name##_show,                 \
37         .store  = _name##_store,                \
38 }
39
40 extern struct kset power_subsys;
41
42 /* Preferred image size in bytes (default 500 MB) */
43 extern unsigned long image_size;
44 extern int in_suspend;
45 extern dev_t swsusp_resume_device;
46 extern sector_t swsusp_resume_block;
47
48 extern asmlinkage int swsusp_arch_suspend(void);
49 extern asmlinkage int swsusp_arch_resume(void);
50
51 extern unsigned int count_data_pages(void);
52
53 /**
54  *      Auxiliary structure used for reading the snapshot image data and
55  *      metadata from and writing them to the list of page backup entries
56  *      (PBEs) which is the main data structure of swsusp.
57  *
58  *      Using struct snapshot_handle we can transfer the image, including its
59  *      metadata, as a continuous sequence of bytes with the help of
60  *      snapshot_read_next() and snapshot_write_next().
61  *
62  *      The code that writes the image to a storage or transfers it to
63  *      the user land is required to use snapshot_read_next() for this
64  *      purpose and it should not make any assumptions regarding the internal
65  *      structure of the image.  Similarly, the code that reads the image from
66  *      a storage or transfers it from the user land is required to use
67  *      snapshot_write_next().
68  *
69  *      This may allow us to change the internal structure of the image
70  *      in the future with considerably less effort.
71  */
72
73 struct snapshot_handle {
74         loff_t          offset; /* number of the last byte ready for reading
75                                  * or writing in the sequence
76                                  */
77         unsigned int    cur;    /* number of the block of PAGE_SIZE bytes the
78                                  * next operation will refer to (ie. current)
79                                  */
80         unsigned int    cur_offset;     /* offset with respect to the current
81                                          * block (for the next operation)
82                                          */
83         unsigned int    prev;   /* number of the block of PAGE_SIZE bytes that
84                                  * was the current one previously
85                                  */
86         void            *buffer;        /* address of the block to read from
87                                          * or write to
88                                          */
89         unsigned int    buf_offset;     /* location to read from or write to,
90                                          * given as a displacement from 'buffer'
91                                          */
92         int             sync_read;      /* Set to one to notify the caller of
93                                          * snapshot_write_next() that it may
94                                          * need to call wait_on_bio_chain()
95                                          */
96 };
97
98 /* This macro returns the address from/to which the caller of
99  * snapshot_read_next()/snapshot_write_next() is allowed to
100  * read/write data after the function returns
101  */
102 #define data_of(handle) ((handle).buffer + (handle).buf_offset)
103
104 extern unsigned int snapshot_additional_pages(struct zone *zone);
105 extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
106 extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
107 extern void snapshot_write_finalize(struct snapshot_handle *handle);
108 extern int snapshot_image_loaded(struct snapshot_handle *handle);
109
110 /*
111  * This structure is used to pass the values needed for the identification
112  * of the resume swap area from a user space to the kernel via the
113  * SNAPSHOT_SET_SWAP_AREA ioctl
114  */
115 struct resume_swap_area {
116         loff_t offset;
117         u_int32_t dev;
118 } __attribute__((packed));
119
120 #define SNAPSHOT_IOC_MAGIC      '3'
121 #define SNAPSHOT_FREEZE                 _IO(SNAPSHOT_IOC_MAGIC, 1)
122 #define SNAPSHOT_UNFREEZE               _IO(SNAPSHOT_IOC_MAGIC, 2)
123 #define SNAPSHOT_ATOMIC_SNAPSHOT        _IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
124 #define SNAPSHOT_ATOMIC_RESTORE         _IO(SNAPSHOT_IOC_MAGIC, 4)
125 #define SNAPSHOT_FREE                   _IO(SNAPSHOT_IOC_MAGIC, 5)
126 #define SNAPSHOT_SET_IMAGE_SIZE         _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
127 #define SNAPSHOT_AVAIL_SWAP             _IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
128 #define SNAPSHOT_GET_SWAP_PAGE          _IOR(SNAPSHOT_IOC_MAGIC, 8, void *)
129 #define SNAPSHOT_FREE_SWAP_PAGES        _IO(SNAPSHOT_IOC_MAGIC, 9)
130 #define SNAPSHOT_SET_SWAP_FILE          _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
131 #define SNAPSHOT_S2RAM                  _IO(SNAPSHOT_IOC_MAGIC, 11)
132 #define SNAPSHOT_PMOPS                  _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
133 #define SNAPSHOT_SET_SWAP_AREA          _IOW(SNAPSHOT_IOC_MAGIC, 13, \
134                                                         struct resume_swap_area)
135 #define SNAPSHOT_IOC_MAXNR      13
136
137 #define PMOPS_PREPARE   1
138 #define PMOPS_ENTER     2
139 #define PMOPS_FINISH    3
140
141 /**
142  *      The bitmap is used for tracing allocated swap pages
143  *
144  *      The entire bitmap consists of a number of bitmap_page
145  *      structures linked with the help of the .next member.
146  *      Thus each page can be allocated individually, so we only
147  *      need to make 0-order memory allocations to create
148  *      the bitmap.
149  */
150
151 #define BITMAP_PAGE_SIZE        (PAGE_SIZE - sizeof(void *))
152 #define BITMAP_PAGE_CHUNKS      (BITMAP_PAGE_SIZE / sizeof(long))
153 #define BITS_PER_CHUNK          (sizeof(long) * 8)
154 #define BITMAP_PAGE_BITS        (BITMAP_PAGE_CHUNKS * BITS_PER_CHUNK)
155
156 struct bitmap_page {
157         unsigned long           chunks[BITMAP_PAGE_CHUNKS];
158         struct bitmap_page      *next;
159 };
160
161 extern void free_bitmap(struct bitmap_page *bitmap);
162 extern struct bitmap_page *alloc_bitmap(unsigned int nr_bits);
163 extern sector_t alloc_swapdev_block(int swap, struct bitmap_page *bitmap);
164 extern void free_all_swap_pages(int swap, struct bitmap_page *bitmap);
165
166 extern int swsusp_check(void);
167 extern int swsusp_shrink_memory(void);
168 extern void swsusp_free(void);
169 extern int swsusp_suspend(void);
170 extern int swsusp_resume(void);
171 extern int swsusp_read(void);
172 extern int swsusp_write(void);
173 extern void swsusp_close(void);
174 extern int suspend_enter(suspend_state_t state);
175
176 struct timeval;
177 extern void swsusp_show_speed(struct timeval *, struct timeval *,
178                                 unsigned int, char *);