Merge branch 'upstream' of git://ftp.linux-mips.org/pub/scm/upstream-linus
[linux-2.6-block.git] / kernel / power / disk.c
CommitLineData
1da177e4
LT
1/*
2 * kernel/power/disk.c - Suspend-to-disk support.
3 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
6 * Copyright (c) 2004 Pavel Machek <pavel@suse.cz>
7 *
8 * This file is released under the GPLv2.
9 *
10 */
11
12#include <linux/suspend.h>
13#include <linux/syscalls.h>
14#include <linux/reboot.h>
15#include <linux/string.h>
16#include <linux/device.h>
17#include <linux/delay.h>
18#include <linux/fs.h>
d53d9f16 19#include <linux/mount.h>
88d10bba 20#include <linux/pm.h>
97c7801c 21#include <linux/console.h>
e3920fb4 22#include <linux/cpu.h>
7dfb7103 23#include <linux/freezer.h>
d53d9f16 24
1da177e4
LT
25#include "power.h"
26
27
1da177e4
LT
28static int noresume = 0;
29char resume_file[256] = CONFIG_PM_STD_PARTITION;
30dev_t swsusp_resume_device;
9a154d9d 31sector_t swsusp_resume_block;
1da177e4 32
8a05aac2
SS
33/**
34 * platform_prepare - prepare the machine for hibernation using the
35 * platform driver if so configured and return an error code if it fails
36 */
37
38static inline int platform_prepare(void)
39{
40 int error = 0;
41
42 if (pm_disk_mode == PM_DISK_PLATFORM) {
43 if (pm_ops && pm_ops->prepare)
44 error = pm_ops->prepare(PM_SUSPEND_DISK);
45 }
46 return error;
47}
48
1da177e4
LT
49/**
50 * power_down - Shut machine down for hibernate.
51 * @mode: Suspend-to-disk mode
52 *
53 * Use the platform driver, if configured so, and return gracefully if it
54 * fails.
55 * Otherwise, try to power off and reboot. If they fail, halt the machine,
56 * there ain't no turning back.
57 */
58
59static void power_down(suspend_disk_method_t mode)
60{
1da177e4
LT
61 switch(mode) {
62 case PM_DISK_PLATFORM:
9185cfa9
RW
63 if (pm_ops && pm_ops->enter) {
64 kernel_shutdown_prepare(SYSTEM_SUSPEND_DISK);
cfee47f9 65 pm_ops->enter(PM_SUSPEND_DISK);
9185cfa9
RW
66 break;
67 }
1da177e4 68 case PM_DISK_SHUTDOWN:
fdde86ac 69 kernel_power_off();
1da177e4
LT
70 break;
71 case PM_DISK_REBOOT:
fdde86ac 72 kernel_restart(NULL);
1da177e4
LT
73 break;
74 }
fdde86ac 75 kernel_halt();
1da177e4
LT
76 /* Valid image is on the disk, if we continue we risk serious data corruption
77 after resume. */
78 printk(KERN_CRIT "Please power me down manually\n");
79 while(1);
80}
81
1da177e4
LT
82static inline void platform_finish(void)
83{
84 if (pm_disk_mode == PM_DISK_PLATFORM) {
85 if (pm_ops && pm_ops->finish)
86 pm_ops->finish(PM_SUSPEND_DISK);
87 }
88}
89
ed746e3b
RW
90static void unprepare_processes(void)
91{
92 thaw_processes();
93 pm_restore_console();
94}
95
1da177e4
LT
96static int prepare_processes(void)
97{
b918f6e6 98 int error = 0;
1da177e4
LT
99
100 pm_prepare_console();
1da177e4
LT
101 if (freeze_processes()) {
102 error = -EBUSY;
ed746e3b 103 unprepare_processes();
1da177e4 104 }
5a72e04d 105 return error;
1da177e4
LT
106}
107
1da177e4 108/**
f1cc0a89 109 * pm_suspend_disk - The granpappy of hibernation power management.
1da177e4
LT
110 *
111 * If we're going through the firmware, then get it over with quickly.
112 *
113 * If not, then call swsusp to do its thing, then figure out how
114 * to power down the system.
115 */
116
117int pm_suspend_disk(void)
118{
119 int error;
120
121 error = prepare_processes();
5a72e04d
LS
122 if (error)
123 return error;
1da177e4 124
ed746e3b
RW
125 if (pm_disk_mode == PM_DISK_TESTPROC) {
126 printk("swsusp debug: Waiting for 5 seconds.\n");
127 mdelay(5000);
128 goto Thaw;
129 }
130 /* Free memory before shutting down devices. */
131 error = swsusp_shrink_memory();
132 if (error)
133 goto Thaw;
134
135 error = platform_prepare();
136 if (error)
137 goto Thaw;
b918f6e6 138
97c7801c 139 suspend_console();
99dc7d63 140 error = device_suspend(PMSG_FREEZE);
1da177e4 141 if (error) {
ed746e3b
RW
142 printk(KERN_ERR "PM: Some devices failed to suspend\n");
143 goto Resume_devices;
b918f6e6 144 }
ed746e3b
RW
145 error = disable_nonboot_cpus();
146 if (error)
147 goto Enable_cpus;
b918f6e6
RW
148
149 if (pm_disk_mode == PM_DISK_TEST) {
150 printk("swsusp debug: Waiting for 5 seconds.\n");
151 mdelay(5000);
ed746e3b 152 goto Enable_cpus;
1da177e4
LT
153 }
154
1da177e4
LT
155 pr_debug("PM: snapshotting memory.\n");
156 in_suspend = 1;
ed746e3b
RW
157 error = swsusp_suspend();
158 if (error)
159 goto Enable_cpus;
1da177e4
LT
160
161 if (in_suspend) {
ed746e3b
RW
162 enable_nonboot_cpus();
163 platform_finish();
0245b3e7 164 device_resume();
97c7801c 165 resume_console();
1da177e4 166 pr_debug("PM: writing image.\n");
f577eb30 167 error = swsusp_write();
1da177e4
LT
168 if (!error)
169 power_down(pm_disk_mode);
99dc7d63 170 else {
99dc7d63 171 swsusp_free();
b918f6e6 172 goto Thaw;
99dc7d63 173 }
b918f6e6 174 } else {
1da177e4 175 pr_debug("PM: Image restored successfully.\n");
b918f6e6 176 }
99dc7d63 177
1da177e4 178 swsusp_free();
ed746e3b
RW
179 Enable_cpus:
180 enable_nonboot_cpus();
181 Resume_devices:
182 platform_finish();
99dc7d63 183 device_resume();
97c7801c 184 resume_console();
b918f6e6 185 Thaw:
99dc7d63 186 unprepare_processes();
1da177e4
LT
187 return error;
188}
189
190
191/**
192 * software_resume - Resume from a saved image.
193 *
194 * Called as a late_initcall (so all devices are discovered and
195 * initialized), we call swsusp to see if we have a saved image or not.
196 * If so, we quiesce devices, the restore the saved image. We will
197 * return above (in pm_suspend_disk() ) if everything goes well.
198 * Otherwise, we fail gracefully and return to the normally
199 * scheduled program.
200 *
201 */
202
203static int software_resume(void)
204{
205 int error;
206
a6d70980 207 mutex_lock(&pm_mutex);
3efa147a 208 if (!swsusp_resume_device) {
dd5d666b 209 if (!strlen(resume_file)) {
a6d70980 210 mutex_unlock(&pm_mutex);
3efa147a 211 return -ENOENT;
dd5d666b 212 }
3efa147a
PM
213 swsusp_resume_device = name_to_dev_t(resume_file);
214 pr_debug("swsusp: Resume From Partition %s\n", resume_file);
215 } else {
216 pr_debug("swsusp: Resume From Partition %d:%d\n",
217 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
218 }
219
1da177e4
LT
220 if (noresume) {
221 /**
222 * FIXME: If noresume is specified, we need to find the partition
223 * and reset it back to normal swap space.
224 */
a6d70980 225 mutex_unlock(&pm_mutex);
1da177e4
LT
226 return 0;
227 }
228
229 pr_debug("PM: Checking swsusp image.\n");
230
ed746e3b
RW
231 error = swsusp_check();
232 if (error)
1da177e4
LT
233 goto Done;
234
235 pr_debug("PM: Preparing processes for restore.\n");
236
ed746e3b
RW
237 error = prepare_processes();
238 if (error) {
1da177e4 239 swsusp_close();
5a72e04d 240 goto Done;
1da177e4
LT
241 }
242
ed746e3b
RW
243 error = platform_prepare();
244 if (error) {
245 swsusp_free();
246 goto Thaw;
247 }
248
1da177e4
LT
249 pr_debug("PM: Reading swsusp image.\n");
250
ed746e3b
RW
251 error = swsusp_read();
252 if (error) {
2c1b4a5c
RW
253 swsusp_free();
254 goto Thaw;
255 }
1da177e4
LT
256
257 pr_debug("PM: Preparing devices for restore.\n");
258
97c7801c 259 suspend_console();
ed746e3b
RW
260 error = device_suspend(PMSG_PRETHAW);
261 if (error)
262 goto Free;
1da177e4 263
ed746e3b
RW
264 error = disable_nonboot_cpus();
265 if (!error)
266 swsusp_resume();
1da177e4 267
ed746e3b
RW
268 enable_nonboot_cpus();
269 Free:
270 swsusp_free();
271 platform_finish();
99dc7d63 272 device_resume();
97c7801c 273 resume_console();
2c1b4a5c 274 Thaw:
ed746e3b 275 printk(KERN_ERR "PM: Restore failed, recovering.\n");
1da177e4
LT
276 unprepare_processes();
277 Done:
dd5d666b 278 /* For success case, the suspend path will release the lock */
a6d70980 279 mutex_unlock(&pm_mutex);
1da177e4
LT
280 pr_debug("PM: Resume from disk failed.\n");
281 return 0;
282}
283
284late_initcall(software_resume);
285
286
3b364b8d 287static const char * const pm_disk_modes[] = {
1da177e4
LT
288 [PM_DISK_FIRMWARE] = "firmware",
289 [PM_DISK_PLATFORM] = "platform",
290 [PM_DISK_SHUTDOWN] = "shutdown",
291 [PM_DISK_REBOOT] = "reboot",
b918f6e6
RW
292 [PM_DISK_TEST] = "test",
293 [PM_DISK_TESTPROC] = "testproc",
1da177e4
LT
294};
295
296/**
297 * disk - Control suspend-to-disk mode
298 *
299 * Suspend-to-disk can be handled in several ways. The greatest
300 * distinction is who writes memory to disk - the firmware or the OS.
301 * If the firmware does it, we assume that it also handles suspending
302 * the system.
303 * If the OS does it, then we have three options for putting the system
304 * to sleep - using the platform driver (e.g. ACPI or other PM registers),
305 * powering off the system or rebooting the system (for testing).
306 *
307 * The system will support either 'firmware' or 'platform', and that is
308 * known a priori (and encoded in pm_ops). But, the user may choose
309 * 'shutdown' or 'reboot' as alternatives.
310 *
311 * show() will display what the mode is currently set to.
312 * store() will accept one of
313 *
314 * 'firmware'
315 * 'platform'
316 * 'shutdown'
317 * 'reboot'
318 *
319 * It will only change to 'firmware' or 'platform' if the system
320 * supports it (as determined from pm_ops->pm_disk_mode).
321 */
322
323static ssize_t disk_show(struct subsystem * subsys, char * buf)
324{
325 return sprintf(buf, "%s\n", pm_disk_modes[pm_disk_mode]);
326}
327
328
329static ssize_t disk_store(struct subsystem * s, const char * buf, size_t n)
330{
331 int error = 0;
332 int i;
333 int len;
334 char *p;
335 suspend_disk_method_t mode = 0;
336
337 p = memchr(buf, '\n', n);
338 len = p ? p - buf : n;
339
a6d70980 340 mutex_lock(&pm_mutex);
1da177e4
LT
341 for (i = PM_DISK_FIRMWARE; i < PM_DISK_MAX; i++) {
342 if (!strncmp(buf, pm_disk_modes[i], len)) {
343 mode = i;
344 break;
345 }
346 }
347 if (mode) {
b918f6e6
RW
348 if (mode == PM_DISK_SHUTDOWN || mode == PM_DISK_REBOOT ||
349 mode == PM_DISK_TEST || mode == PM_DISK_TESTPROC) {
1da177e4 350 pm_disk_mode = mode;
b918f6e6 351 } else {
1da177e4
LT
352 if (pm_ops && pm_ops->enter &&
353 (mode == pm_ops->pm_disk_mode))
354 pm_disk_mode = mode;
355 else
356 error = -EINVAL;
357 }
b918f6e6 358 } else {
1da177e4 359 error = -EINVAL;
b918f6e6 360 }
1da177e4
LT
361
362 pr_debug("PM: suspend-to-disk mode set to '%s'\n",
363 pm_disk_modes[mode]);
a6d70980 364 mutex_unlock(&pm_mutex);
1da177e4
LT
365 return error ? error : n;
366}
367
368power_attr(disk);
369
370static ssize_t resume_show(struct subsystem * subsys, char *buf)
371{
372 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
373 MINOR(swsusp_resume_device));
374}
375
a576219a 376static ssize_t resume_store(struct subsystem *subsys, const char *buf, size_t n)
1da177e4 377{
1da177e4 378 unsigned int maj, min;
1da177e4 379 dev_t res;
a576219a 380 int ret = -EINVAL;
1da177e4 381
a576219a
AM
382 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
383 goto out;
1da177e4 384
a576219a
AM
385 res = MKDEV(maj,min);
386 if (maj != MAJOR(res) || min != MINOR(res))
387 goto out;
1da177e4 388
a6d70980 389 mutex_lock(&pm_mutex);
a576219a 390 swsusp_resume_device = res;
a6d70980 391 mutex_unlock(&pm_mutex);
a576219a
AM
392 printk("Attempting manual resume\n");
393 noresume = 0;
394 software_resume();
395 ret = n;
59a49335 396 out:
a576219a 397 return ret;
1da177e4
LT
398}
399
400power_attr(resume);
401
ca0aec0f
RW
402static ssize_t image_size_show(struct subsystem * subsys, char *buf)
403{
853609b6 404 return sprintf(buf, "%lu\n", image_size);
ca0aec0f
RW
405}
406
407static ssize_t image_size_store(struct subsystem * subsys, const char * buf, size_t n)
408{
853609b6 409 unsigned long size;
ca0aec0f 410
853609b6 411 if (sscanf(buf, "%lu", &size) == 1) {
ca0aec0f
RW
412 image_size = size;
413 return n;
414 }
415
416 return -EINVAL;
417}
418
419power_attr(image_size);
420
1da177e4
LT
421static struct attribute * g[] = {
422 &disk_attr.attr,
423 &resume_attr.attr,
ca0aec0f 424 &image_size_attr.attr,
1da177e4
LT
425 NULL,
426};
427
428
429static struct attribute_group attr_group = {
430 .attrs = g,
431};
432
433
434static int __init pm_disk_init(void)
435{
436 return sysfs_create_group(&power_subsys.kset.kobj,&attr_group);
437}
438
439core_initcall(pm_disk_init);
440
441
442static int __init resume_setup(char *str)
443{
444 if (noresume)
445 return 1;
446
447 strncpy( resume_file, str, 255 );
448 return 1;
449}
450
9a154d9d
RW
451static int __init resume_offset_setup(char *str)
452{
453 unsigned long long offset;
454
455 if (noresume)
456 return 1;
457
458 if (sscanf(str, "%llu", &offset) == 1)
459 swsusp_resume_block = offset;
460
461 return 1;
462}
463
1da177e4
LT
464static int __init noresume_setup(char *str)
465{
466 noresume = 1;
467 return 1;
468}
469
470__setup("noresume", noresume_setup);
9a154d9d 471__setup("resume_offset=", resume_offset_setup);
1da177e4 472__setup("resume=", resume_setup);