Merge back earlier 'pm-sleep' material.
[deliverable/linux.git] / kernel / power / hibernate.c
CommitLineData
1da177e4 1/*
8b759b84 2 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
1da177e4
LT
3 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
a2531293 6 * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
8b759b84 7 * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
62c552cc 8 * Copyright (C) 2012 Bojan Smojver <bojan@rexursive.com>
1da177e4
LT
9 *
10 * This file is released under the GPLv2.
1da177e4
LT
11 */
12
6e5fdeed 13#include <linux/export.h>
1da177e4
LT
14#include <linux/suspend.h>
15#include <linux/syscalls.h>
16#include <linux/reboot.h>
17#include <linux/string.h>
18#include <linux/device.h>
6f8d7022 19#include <linux/async.h>
1da177e4
LT
20#include <linux/delay.h>
21#include <linux/fs.h>
d53d9f16 22#include <linux/mount.h>
88d10bba 23#include <linux/pm.h>
97c7801c 24#include <linux/console.h>
e3920fb4 25#include <linux/cpu.h>
7dfb7103 26#include <linux/freezer.h>
5a0e3ad6 27#include <linux/gfp.h>
40dc166c 28#include <linux/syscore_ops.h>
2df83fa4
MB
29#include <linux/ctype.h>
30#include <linux/genhd.h>
d53d9f16 31
1da177e4
LT
32#include "power.h"
33
34
d231ff1a
BS
35static int nocompress;
36static int noresume;
37static int resume_wait;
38static int resume_delay;
47a460d5 39static char resume_file[256] = CONFIG_PM_STD_PARTITION;
1da177e4 40dev_t swsusp_resume_device;
9a154d9d 41sector_t swsusp_resume_block;
d6efc2f7 42__visible int in_suspend __nosavedata;
1da177e4 43
a3d25c27
RW
44enum {
45 HIBERNATION_INVALID,
46 HIBERNATION_PLATFORM,
a3d25c27
RW
47 HIBERNATION_SHUTDOWN,
48 HIBERNATION_REBOOT,
62c552cc
BS
49#ifdef CONFIG_SUSPEND
50 HIBERNATION_SUSPEND,
51#endif
a3d25c27
RW
52 /* keep last */
53 __HIBERNATION_AFTER_LAST
54};
55#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
56#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
57
58static int hibernation_mode = HIBERNATION_SHUTDOWN;
59
97819a26 60bool freezer_test_done;
aa9a7b11 61
073ef1f6 62static const struct platform_hibernation_ops *hibernation_ops;
a3d25c27
RW
63
64/**
f42a9813
RW
65 * hibernation_set_ops - Set the global hibernate operations.
66 * @ops: Hibernation operations to use in subsequent hibernation transitions.
a3d25c27 67 */
073ef1f6 68void hibernation_set_ops(const struct platform_hibernation_ops *ops)
a3d25c27 69{
caea99ef
RW
70 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
71 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
5729c63a 72 && ops->restore_cleanup && ops->leave)) {
a3d25c27
RW
73 WARN_ON(1);
74 return;
75 }
bcda53fa 76 lock_system_sleep();
a3d25c27
RW
77 hibernation_ops = ops;
78 if (ops)
79 hibernation_mode = HIBERNATION_PLATFORM;
80 else if (hibernation_mode == HIBERNATION_PLATFORM)
81 hibernation_mode = HIBERNATION_SHUTDOWN;
82
bcda53fa 83 unlock_system_sleep();
a3d25c27 84}
e0c7855e 85EXPORT_SYMBOL_GPL(hibernation_set_ops);
a3d25c27 86
abfe2d7b
RW
87static bool entering_platform_hibernation;
88
89bool system_entering_hibernation(void)
90{
91 return entering_platform_hibernation;
92}
93EXPORT_SYMBOL(system_entering_hibernation);
94
4cc79776
RW
95#ifdef CONFIG_PM_DEBUG
96static void hibernation_debug_sleep(void)
97{
98 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
99 mdelay(5000);
100}
101
4cc79776
RW
102static int hibernation_test(int level)
103{
104 if (pm_test_level == level) {
105 hibernation_debug_sleep();
106 return 1;
107 }
108 return 0;
109}
110#else /* !CONFIG_PM_DEBUG */
4cc79776
RW
111static int hibernation_test(int level) { return 0; }
112#endif /* !CONFIG_PM_DEBUG */
113
74f270af 114/**
f42a9813
RW
115 * platform_begin - Call platform to start hibernation.
116 * @platform_mode: Whether or not to use the platform driver.
74f270af 117 */
caea99ef 118static int platform_begin(int platform_mode)
74f270af
RW
119{
120 return (platform_mode && hibernation_ops) ?
caea99ef
RW
121 hibernation_ops->begin() : 0;
122}
123
124/**
f42a9813
RW
125 * platform_end - Call platform to finish transition to the working state.
126 * @platform_mode: Whether or not to use the platform driver.
caea99ef 127 */
caea99ef
RW
128static void platform_end(int platform_mode)
129{
130 if (platform_mode && hibernation_ops)
131 hibernation_ops->end();
74f270af 132}
a3d25c27 133
8a05aac2 134/**
f42a9813
RW
135 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
136 * @platform_mode: Whether or not to use the platform driver.
137 *
138 * Use the platform driver to prepare the system for creating a hibernate image,
139 * if so configured, and return an error code if that fails.
8a05aac2
SS
140 */
141
74f270af 142static int platform_pre_snapshot(int platform_mode)
8a05aac2 143{
7777fab9 144 return (platform_mode && hibernation_ops) ?
74f270af 145 hibernation_ops->pre_snapshot() : 0;
a3d25c27 146}
8a05aac2 147
c7e0831d 148/**
f42a9813
RW
149 * platform_leave - Call platform to prepare a transition to the working state.
150 * @platform_mode: Whether or not to use the platform driver.
151 *
152 * Use the platform driver prepare to prepare the machine for switching to the
153 * normal mode of operation.
154 *
155 * This routine is called on one CPU with interrupts disabled.
c7e0831d 156 */
c7e0831d
RW
157static void platform_leave(int platform_mode)
158{
159 if (platform_mode && hibernation_ops)
160 hibernation_ops->leave();
161}
162
a3d25c27 163/**
f42a9813
RW
164 * platform_finish - Call platform to switch the system to the working state.
165 * @platform_mode: Whether or not to use the platform driver.
166 *
167 * Use the platform driver to switch the machine to the normal mode of
168 * operation.
169 *
170 * This routine must be called after platform_prepare().
a3d25c27 171 */
7777fab9 172static void platform_finish(int platform_mode)
a3d25c27 173{
7777fab9 174 if (platform_mode && hibernation_ops)
a3d25c27 175 hibernation_ops->finish();
8a05aac2
SS
176}
177
a634cc10 178/**
f42a9813
RW
179 * platform_pre_restore - Prepare for hibernate image restoration.
180 * @platform_mode: Whether or not to use the platform driver.
181 *
182 * Use the platform driver to prepare the system for resume from a hibernation
183 * image.
184 *
185 * If the restore fails after this function has been called,
186 * platform_restore_cleanup() must be called.
a634cc10 187 */
a634cc10
RW
188static int platform_pre_restore(int platform_mode)
189{
190 return (platform_mode && hibernation_ops) ?
191 hibernation_ops->pre_restore() : 0;
192}
193
194/**
f42a9813
RW
195 * platform_restore_cleanup - Switch to the working state after failing restore.
196 * @platform_mode: Whether or not to use the platform driver.
197 *
198 * Use the platform driver to switch the system to the normal mode of operation
199 * after a failing restore.
200 *
201 * If platform_pre_restore() has been called before the failing restore, this
202 * function must be called too, regardless of the result of
203 * platform_pre_restore().
a634cc10 204 */
a634cc10
RW
205static void platform_restore_cleanup(int platform_mode)
206{
207 if (platform_mode && hibernation_ops)
208 hibernation_ops->restore_cleanup();
209}
210
d8f3de0d 211/**
f42a9813
RW
212 * platform_recover - Recover from a failure to suspend devices.
213 * @platform_mode: Whether or not to use the platform driver.
d8f3de0d 214 */
d8f3de0d
RW
215static void platform_recover(int platform_mode)
216{
217 if (platform_mode && hibernation_ops && hibernation_ops->recover)
218 hibernation_ops->recover();
219}
220
8e60c6a1 221/**
f42a9813
RW
222 * swsusp_show_speed - Print time elapsed between two events during hibernation.
223 * @start: Starting event.
224 * @stop: Final event.
225 * @nr_pages: Number of memory pages processed between @start and @stop.
226 * @msg: Additional diagnostic message to print.
8e60c6a1 227 */
8e60c6a1
NC
228void swsusp_show_speed(struct timeval *start, struct timeval *stop,
229 unsigned nr_pages, char *msg)
230{
231 s64 elapsed_centisecs64;
232 int centisecs;
233 int k;
234 int kps;
235
236 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
237 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
238 centisecs = elapsed_centisecs64;
239 if (centisecs == 0)
240 centisecs = 1; /* avoid div-by-zero */
241 k = nr_pages * (PAGE_SIZE / 1024);
242 kps = (k * 100) / centisecs;
243 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
244 msg, k,
245 centisecs / 100, centisecs % 100,
246 kps / 1000, (kps % 1000) / 10);
247}
248
c7e0831d 249/**
f42a9813
RW
250 * create_image - Create a hibernation image.
251 * @platform_mode: Whether or not to use the platform driver.
252 *
cf579dfb
RW
253 * Execute device drivers' "late" and "noirq" freeze callbacks, create a
254 * hibernation image and run the drivers' "noirq" and "early" thaw callbacks.
f42a9813
RW
255 *
256 * Control reappears in this routine after the subsequent restore.
c7e0831d 257 */
47a460d5 258static int create_image(int platform_mode)
c7e0831d
RW
259{
260 int error;
261
cf579dfb 262 error = dpm_suspend_end(PMSG_FREEZE);
c7e0831d 263 if (error) {
23976728
RW
264 printk(KERN_ERR "PM: Some devices failed to power down, "
265 "aborting hibernation\n");
32bdfac5 266 return error;
c7e0831d 267 }
2ed8d2b3 268
4aecd671
RW
269 error = platform_pre_snapshot(platform_mode);
270 if (error || hibernation_test(TEST_PLATFORM))
271 goto Platform_finish;
272
273 error = disable_nonboot_cpus();
48580ab8 274 if (error || hibernation_test(TEST_CPUS))
4aecd671
RW
275 goto Enable_cpus;
276
2ed8d2b3
RW
277 local_irq_disable();
278
2e711c04 279 error = syscore_suspend();
770824bd 280 if (error) {
4484079d 281 printk(KERN_ERR "PM: Some system devices failed to power down, "
770824bd 282 "aborting hibernation\n");
4aecd671 283 goto Enable_irqs;
770824bd 284 }
c7e0831d 285
a2867e08 286 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
4cc79776
RW
287 goto Power_up;
288
289 in_suspend = 1;
c7e0831d
RW
290 save_processor_state();
291 error = swsusp_arch_suspend();
292 if (error)
23976728
RW
293 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
294 error);
c7e0831d
RW
295 /* Restore control flow magically appears here */
296 restore_processor_state();
c125e96f
RW
297 if (!in_suspend) {
298 events_check_enabled = false;
c7e0831d 299 platform_leave(platform_mode);
c125e96f 300 }
4aecd671 301
4cc79776 302 Power_up:
40dc166c 303 syscore_resume();
2ed8d2b3 304
4aecd671 305 Enable_irqs:
2ed8d2b3
RW
306 local_irq_enable();
307
4aecd671
RW
308 Enable_cpus:
309 enable_nonboot_cpus();
310
311 Platform_finish:
312 platform_finish(platform_mode);
313
cf579dfb 314 dpm_resume_start(in_suspend ?
1eede070 315 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
2ed8d2b3 316
c7e0831d
RW
317 return error;
318}
319
7777fab9 320/**
f42a9813
RW
321 * hibernation_snapshot - Quiesce devices and create a hibernation image.
322 * @platform_mode: If set, use platform driver to prepare for the transition.
7777fab9 323 *
f42a9813 324 * This routine must be called with pm_mutex held.
7777fab9 325 */
7777fab9
RW
326int hibernation_snapshot(int platform_mode)
327{
953a2063 328 pm_message_t msg;
cbe2f5a6 329 int error;
7777fab9 330
3fe0313e 331 error = platform_begin(platform_mode);
7777fab9 332 if (error)
d074ee02 333 goto Close;
7777fab9 334
64a473cb
RW
335 /* Preallocate image memory before shutting down devices. */
336 error = hibernate_preallocate_memory();
2aede851
RW
337 if (error)
338 goto Close;
339
340 error = freeze_kernel_threads();
341 if (error)
bb58dd5d 342 goto Cleanup;
2aede851 343
48580ab8 344 if (hibernation_test(TEST_FREEZER)) {
aa9a7b11
SB
345
346 /*
347 * Indicate to the caller that we are returning due to a
348 * successful freezer test.
349 */
350 freezer_test_done = true;
51d6ff7a 351 goto Thaw;
aa9a7b11
SB
352 }
353
2aede851 354 error = dpm_prepare(PMSG_FREEZE);
bb58dd5d 355 if (error) {
953a2063 356 dpm_complete(PMSG_RECOVER);
51d6ff7a 357 goto Thaw;
bb58dd5d 358 }
74f270af 359
7777fab9 360 suspend_console();
443772d4 361 ftrace_stop();
c9e664f1 362 pm_restrict_gfp_mask();
953a2063 363
91e7c75b 364 error = dpm_suspend(PMSG_FREEZE);
10a1803d 365
953a2063
SB
366 if (error || hibernation_test(TEST_DEVICES))
367 platform_recover(platform_mode);
368 else
369 error = create_image(platform_mode);
7777fab9 370
c9e664f1 371 /*
953a2063
SB
372 * In the case that we call create_image() above, the control
373 * returns here (1) after the image has been created or the
c9e664f1
RW
374 * image creation has failed and (2) after a successful restore.
375 */
4cc79776 376
64a473cb
RW
377 /* We may need to release the preallocated image pages here. */
378 if (error || !in_suspend)
379 swsusp_free();
380
91e7c75b
RW
381 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
382 dpm_resume(msg);
c9e664f1
RW
383
384 if (error || !in_suspend)
385 pm_restore_gfp_mask();
386
443772d4 387 ftrace_start();
7777fab9 388 resume_console();
91e7c75b
RW
389 dpm_complete(msg);
390
caea99ef
RW
391 Close:
392 platform_end(platform_mode);
7777fab9 393 return error;
d8f3de0d 394
51d6ff7a
SB
395 Thaw:
396 thaw_kernel_threads();
bb58dd5d
RW
397 Cleanup:
398 swsusp_free();
399 goto Close;
7777fab9
RW
400}
401
72df68ca 402/**
f42a9813
RW
403 * resume_target_kernel - Restore system state from a hibernation image.
404 * @platform_mode: Whether or not to use the platform driver.
405 *
cf579dfb
RW
406 * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
407 * contents of highmem that have not been restored yet from the image and run
408 * the low-level code that will restore the remaining contents of memory and
409 * switch to the just restored target kernel.
72df68ca 410 */
4aecd671 411static int resume_target_kernel(bool platform_mode)
72df68ca
RW
412{
413 int error;
414
cf579dfb 415 error = dpm_suspend_end(PMSG_QUIESCE);
72df68ca 416 if (error) {
23976728 417 printk(KERN_ERR "PM: Some devices failed to power down, "
72df68ca 418 "aborting resume\n");
32bdfac5 419 return error;
72df68ca 420 }
2ed8d2b3 421
4aecd671
RW
422 error = platform_pre_restore(platform_mode);
423 if (error)
424 goto Cleanup;
425
426 error = disable_nonboot_cpus();
427 if (error)
428 goto Enable_cpus;
429
2ed8d2b3
RW
430 local_irq_disable();
431
2e711c04 432 error = syscore_suspend();
4aecd671
RW
433 if (error)
434 goto Enable_irqs;
435
72df68ca
RW
436 save_processor_state();
437 error = restore_highmem();
438 if (!error) {
439 error = swsusp_arch_resume();
440 /*
441 * The code below is only ever reached in case of a failure.
4e2d9491
RW
442 * Otherwise, execution continues at the place where
443 * swsusp_arch_suspend() was called.
72df68ca
RW
444 */
445 BUG_ON(!error);
4e2d9491
RW
446 /*
447 * This call to restore_highmem() reverts the changes made by
448 * the previous one.
449 */
72df68ca
RW
450 restore_highmem();
451 }
452 /*
453 * The only reason why swsusp_arch_resume() can fail is memory being
454 * very tight, so we have to free it as soon as we can to avoid
4e2d9491 455 * subsequent failures.
72df68ca
RW
456 */
457 swsusp_free();
458 restore_processor_state();
459 touch_softlockup_watchdog();
2ed8d2b3 460
40dc166c 461 syscore_resume();
2ed8d2b3 462
4aecd671 463 Enable_irqs:
72df68ca 464 local_irq_enable();
2ed8d2b3 465
4aecd671
RW
466 Enable_cpus:
467 enable_nonboot_cpus();
468
469 Cleanup:
470 platform_restore_cleanup(platform_mode);
471
cf579dfb 472 dpm_resume_start(PMSG_RECOVER);
2ed8d2b3 473
72df68ca
RW
474 return error;
475}
476
7777fab9 477/**
f42a9813
RW
478 * hibernation_restore - Quiesce devices and restore from a hibernation image.
479 * @platform_mode: If set, use platform driver to prepare for the transition.
7777fab9 480 *
f42a9813 481 * This routine must be called with pm_mutex held. If it is successful, control
21e82808 482 * reappears in the restored target kernel in hibernation_snapshot().
7777fab9 483 */
a634cc10 484int hibernation_restore(int platform_mode)
7777fab9 485{
cbe2f5a6 486 int error;
7777fab9
RW
487
488 pm_prepare_console();
489 suspend_console();
443772d4 490 ftrace_stop();
c9e664f1 491 pm_restrict_gfp_mask();
d1616302 492 error = dpm_suspend_start(PMSG_QUIESCE);
a634cc10 493 if (!error) {
4aecd671 494 error = resume_target_kernel(platform_mode);
d1616302 495 dpm_resume_end(PMSG_RECOVER);
a634cc10 496 }
c9e664f1 497 pm_restore_gfp_mask();
443772d4 498 ftrace_start();
7777fab9
RW
499 resume_console();
500 pm_restore_console();
501 return error;
502}
503
504/**
f42a9813 505 * hibernation_platform_enter - Power off the system using the platform driver.
7777fab9 506 */
7777fab9
RW
507int hibernation_platform_enter(void)
508{
cbe2f5a6 509 int error;
b1457bcc 510
9cd9a005
RW
511 if (!hibernation_ops)
512 return -ENOSYS;
513
514 /*
515 * We have cancelled the power transition by running
516 * hibernation_ops->finish() before saving the image, so we should let
517 * the firmware know that we're going to enter the sleep state after all
518 */
caea99ef 519 error = hibernation_ops->begin();
9cd9a005 520 if (error)
caea99ef 521 goto Close;
9cd9a005 522
abfe2d7b 523 entering_platform_hibernation = true;
9cd9a005 524 suspend_console();
443772d4 525 ftrace_stop();
d1616302 526 error = dpm_suspend_start(PMSG_HIBERNATE);
d8f3de0d
RW
527 if (error) {
528 if (hibernation_ops->recover)
529 hibernation_ops->recover();
530 goto Resume_devices;
531 }
9cd9a005 532
cf579dfb 533 error = dpm_suspend_end(PMSG_HIBERNATE);
4aecd671 534 if (error)
32bdfac5 535 goto Resume_devices;
4aecd671 536
9cd9a005
RW
537 error = hibernation_ops->prepare();
538 if (error)
e681c9dd 539 goto Platform_finish;
9cd9a005
RW
540
541 error = disable_nonboot_cpus();
542 if (error)
e681c9dd 543 goto Platform_finish;
2ed8d2b3 544
4aecd671 545 local_irq_disable();
40dc166c 546 syscore_suspend();
a2867e08 547 if (pm_wakeup_pending()) {
c125e96f
RW
548 error = -EAGAIN;
549 goto Power_up;
550 }
551
4aecd671
RW
552 hibernation_ops->enter();
553 /* We should never get here */
554 while (1);
9cd9a005 555
c125e96f 556 Power_up:
40dc166c 557 syscore_resume();
c125e96f
RW
558 local_irq_enable();
559 enable_nonboot_cpus();
560
e681c9dd 561 Platform_finish:
9cd9a005 562 hibernation_ops->finish();
2ed8d2b3 563
cf579dfb 564 dpm_resume_start(PMSG_RESTORE);
4aecd671 565
9cd9a005 566 Resume_devices:
abfe2d7b 567 entering_platform_hibernation = false;
d1616302 568 dpm_resume_end(PMSG_RESTORE);
443772d4 569 ftrace_start();
9cd9a005 570 resume_console();
2ed8d2b3 571
caea99ef
RW
572 Close:
573 hibernation_ops->end();
2ed8d2b3 574
b1457bcc 575 return error;
7777fab9
RW
576}
577
1da177e4 578/**
f42a9813 579 * power_down - Shut the machine down for hibernation.
1da177e4 580 *
f42a9813
RW
581 * Use the platform driver, if configured, to put the system into the sleep
582 * state corresponding to hibernation, or try to power it off or reboot,
583 * depending on the value of hibernation_mode.
1da177e4 584 */
fe0c935a 585static void power_down(void)
1da177e4 586{
62c552cc
BS
587#ifdef CONFIG_SUSPEND
588 int error;
589#endif
590
a3d25c27 591 switch (hibernation_mode) {
a3d25c27 592 case HIBERNATION_REBOOT:
fdde86ac 593 kernel_restart(NULL);
1da177e4 594 break;
a3d25c27 595 case HIBERNATION_PLATFORM:
7777fab9 596 hibernation_platform_enter();
9cd9a005
RW
597 case HIBERNATION_SHUTDOWN:
598 kernel_power_off();
599 break;
62c552cc
BS
600#ifdef CONFIG_SUSPEND
601 case HIBERNATION_SUSPEND:
602 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
603 if (error) {
604 if (hibernation_ops)
605 hibernation_mode = HIBERNATION_PLATFORM;
606 else
607 hibernation_mode = HIBERNATION_SHUTDOWN;
608 power_down();
609 }
610 /*
611 * Restore swap signature.
612 */
613 error = swsusp_unmark();
614 if (error)
615 printk(KERN_ERR "PM: Swap will be unusable! "
616 "Try swapon -a.\n");
617 return;
618#endif
1da177e4 619 }
fdde86ac 620 kernel_halt();
fe0c935a
JB
621 /*
622 * Valid image is on the disk, if we continue we risk serious data
623 * corruption after resume.
624 */
23976728 625 printk(KERN_CRIT "PM: Please power down manually\n");
1da177e4
LT
626 while(1);
627}
628
1da177e4 629/**
f42a9813 630 * hibernate - Carry out system hibernation, including saving the image.
1da177e4 631 */
a3d25c27 632int hibernate(void)
1da177e4
LT
633{
634 int error;
635
bcda53fa 636 lock_system_sleep();
0709db60 637 /* The snapshot device should not be opened while we're running */
b10d9117
RW
638 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
639 error = -EBUSY;
640 goto Unlock;
641 }
642
5a0a2f30 643 pm_prepare_console();
b10d9117
RW
644 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
645 if (error)
646 goto Exit;
0709db60 647
23976728 648 printk(KERN_INFO "PM: Syncing filesystems ... ");
232b1432
RW
649 sys_sync();
650 printk("done.\n");
651
03afed8b 652 error = freeze_processes();
5a72e04d 653 if (error)
8fd37a4c
RW
654 goto Exit;
655
942f4015 656 lock_device_hotplug();
8fd37a4c
RW
657 /* Allocate memory management structures */
658 error = create_basic_memory_bitmaps();
659 if (error)
660 goto Thaw;
1da177e4 661
7777fab9 662 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
a556d5b5 663 if (error || freezer_test_done)
8fd37a4c 664 goto Free_bitmaps;
64a473cb
RW
665
666 if (in_suspend) {
a634cc10
RW
667 unsigned int flags = 0;
668
669 if (hibernation_mode == HIBERNATION_PLATFORM)
670 flags |= SF_PLATFORM_MODE;
f996fc96
BS
671 if (nocompress)
672 flags |= SF_NOCOMPRESS_MODE;
081a9d04
BS
673 else
674 flags |= SF_CRC32_MODE;
675
1da177e4 676 pr_debug("PM: writing image.\n");
a634cc10 677 error = swsusp_write(flags);
7777fab9 678 swsusp_free();
1da177e4 679 if (!error)
fe0c935a 680 power_down();
5262a475 681 in_suspend = 0;
c9e664f1 682 pm_restore_gfp_mask();
b918f6e6 683 } else {
1da177e4 684 pr_debug("PM: Image restored successfully.\n");
b918f6e6 685 }
64a473cb 686
8fd37a4c
RW
687 Free_bitmaps:
688 free_basic_memory_bitmaps();
b918f6e6 689 Thaw:
942f4015 690 unlock_device_hotplug();
5a0a2f30 691 thaw_processes();
a556d5b5
SB
692
693 /* Don't bother checking whether freezer_test_done is true */
694 freezer_test_done = false;
0709db60 695 Exit:
b10d9117 696 pm_notifier_call_chain(PM_POST_HIBERNATION);
5a0a2f30 697 pm_restore_console();
0709db60 698 atomic_inc(&snapshot_device_available);
b10d9117 699 Unlock:
bcda53fa 700 unlock_system_sleep();
1da177e4
LT
701 return error;
702}
703
704
705/**
f42a9813
RW
706 * software_resume - Resume from a saved hibernation image.
707 *
708 * This routine is called as a late initcall, when all devices have been
709 * discovered and initialized already.
1da177e4 710 *
f42a9813
RW
711 * The image reading code is called to see if there is a hibernation image
712 * available for reading. If that is the case, devices are quiesced and the
713 * contents of memory is restored from the saved image.
1da177e4 714 *
f42a9813
RW
715 * If this is successful, control reappears in the restored target kernel in
716 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
717 * attempts to recover gracefully and make the kernel return to the normal mode
718 * of operation.
1da177e4 719 */
1da177e4
LT
720static int software_resume(void)
721{
722 int error;
a634cc10 723 unsigned int flags;
1da177e4 724
eed3ee08
AV
725 /*
726 * If the user said "noresume".. bail out early.
727 */
728 if (noresume)
729 return 0;
730
60a0d233
JB
731 /*
732 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
733 * is configured into the kernel. Since the regular hibernate
734 * trigger path is via sysfs which takes a buffer mutex before
735 * calling hibernate functions (which take pm_mutex) this can
736 * cause lockdep to complain about a possible ABBA deadlock
737 * which cannot happen since we're in the boot code here and
738 * sysfs can't be invoked yet. Therefore, we use a subclass
739 * here to avoid lockdep complaining.
740 */
741 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
0c8454f5
RW
742
743 if (swsusp_resume_device)
744 goto Check_image;
745
746 if (!strlen(resume_file)) {
747 error = -ENOENT;
748 goto Unlock;
749 }
750
d0941ead 751 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
0c8454f5 752
f126f733
BS
753 if (resume_delay) {
754 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
755 resume_delay);
756 ssleep(resume_delay);
757 }
758
0c8454f5
RW
759 /* Check if the device is there */
760 swsusp_resume_device = name_to_dev_t(resume_file);
2df83fa4
MB
761
762 /*
763 * name_to_dev_t is ineffective to verify parition if resume_file is in
764 * integer format. (e.g. major:minor)
765 */
766 if (isdigit(resume_file[0]) && resume_wait) {
767 int partno;
768 while (!get_gendisk(swsusp_resume_device, &partno))
769 msleep(10);
770 }
771
3efa147a 772 if (!swsusp_resume_device) {
eed3ee08
AV
773 /*
774 * Some device discovery might still be in progress; we need
775 * to wait for this to finish.
776 */
777 wait_for_device_probe();
6f8d7022
BS
778
779 if (resume_wait) {
780 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
781 msleep(10);
782 async_synchronize_full();
783 }
784
3efa147a 785 swsusp_resume_device = name_to_dev_t(resume_file);
0c8454f5
RW
786 if (!swsusp_resume_device) {
787 error = -ENODEV;
788 goto Unlock;
789 }
3efa147a
PM
790 }
791
0c8454f5 792 Check_image:
d0941ead 793 pr_debug("PM: Hibernation image partition %d:%d present\n",
0c8454f5 794 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
1da177e4 795
d0941ead 796 pr_debug("PM: Looking for hibernation image.\n");
ed746e3b
RW
797 error = swsusp_check();
798 if (error)
74dfd666 799 goto Unlock;
1da177e4 800
0709db60
RW
801 /* The snapshot device should not be opened while we're running */
802 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
803 error = -EBUSY;
76b57e61 804 swsusp_close(FMODE_READ);
0709db60
RW
805 goto Unlock;
806 }
807
5a0a2f30 808 pm_prepare_console();
c3e94d89
AS
809 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
810 if (error)
8fd37a4c 811 goto Close_Finish;
1bfcf130 812
74dfd666 813 pr_debug("PM: Preparing processes for restore.\n");
03afed8b 814 error = freeze_processes();
8fd37a4c
RW
815 if (error)
816 goto Close_Finish;
1da177e4 817
d0941ead 818 pr_debug("PM: Loading hibernation image.\n");
1da177e4 819
942f4015 820 lock_device_hotplug();
8fd37a4c
RW
821 error = create_basic_memory_bitmaps();
822 if (error)
823 goto Thaw;
824
a634cc10 825 error = swsusp_read(&flags);
76b57e61 826 swsusp_close(FMODE_READ);
ed746e3b 827 if (!error)
a634cc10 828 hibernation_restore(flags & SF_PLATFORM_MODE);
1da177e4 829
d0941ead 830 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
7777fab9 831 swsusp_free();
7b5179ac 832 free_basic_memory_bitmaps();
8fd37a4c 833 Thaw:
942f4015 834 unlock_device_hotplug();
8fd37a4c 835 thaw_processes();
0709db60 836 Finish:
c3e94d89 837 pm_notifier_call_chain(PM_POST_RESTORE);
5a0a2f30 838 pm_restore_console();
0709db60 839 atomic_inc(&snapshot_device_available);
dd5d666b 840 /* For success case, the suspend path will release the lock */
74dfd666 841 Unlock:
a6d70980 842 mutex_unlock(&pm_mutex);
d0941ead 843 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
7777fab9 844 return error;
8fd37a4c 845 Close_Finish:
76b57e61
JS
846 swsusp_close(FMODE_READ);
847 goto Finish;
1da177e4
LT
848}
849
d3c345db 850late_initcall_sync(software_resume);
1da177e4
LT
851
852
a3d25c27
RW
853static const char * const hibernation_modes[] = {
854 [HIBERNATION_PLATFORM] = "platform",
855 [HIBERNATION_SHUTDOWN] = "shutdown",
856 [HIBERNATION_REBOOT] = "reboot",
62c552cc
BS
857#ifdef CONFIG_SUSPEND
858 [HIBERNATION_SUSPEND] = "suspend",
859#endif
1da177e4
LT
860};
861
f42a9813
RW
862/*
863 * /sys/power/disk - Control hibernation mode.
1da177e4 864 *
f42a9813
RW
865 * Hibernation can be handled in several ways. There are a few different ways
866 * to put the system into the sleep state: using the platform driver (e.g. ACPI
867 * or other hibernation_ops), powering it off or rebooting it (for testing
48580ab8 868 * mostly).
1da177e4 869 *
f42a9813
RW
870 * The sysfs file /sys/power/disk provides an interface for selecting the
871 * hibernation mode to use. Reading from this file causes the available modes
48580ab8 872 * to be printed. There are 3 modes that can be supported:
1da177e4 873 *
1da177e4
LT
874 * 'platform'
875 * 'shutdown'
876 * 'reboot'
877 *
f42a9813
RW
878 * If a platform hibernation driver is in use, 'platform' will be supported
879 * and will be used by default. Otherwise, 'shutdown' will be used by default.
880 * The selected option (i.e. the one corresponding to the current value of
881 * hibernation_mode) is enclosed by a square bracket.
882 *
883 * To select a given hibernation mode it is necessary to write the mode's
884 * string representation (as returned by reading from /sys/power/disk) back
885 * into /sys/power/disk.
1da177e4
LT
886 */
887
386f275f
KS
888static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
889 char *buf)
1da177e4 890{
f0ced9b2
JB
891 int i;
892 char *start = buf;
893
a3d25c27
RW
894 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
895 if (!hibernation_modes[i])
f0ced9b2
JB
896 continue;
897 switch (i) {
a3d25c27
RW
898 case HIBERNATION_SHUTDOWN:
899 case HIBERNATION_REBOOT:
62c552cc
BS
900#ifdef CONFIG_SUSPEND
901 case HIBERNATION_SUSPEND:
902#endif
f0ced9b2 903 break;
a3d25c27
RW
904 case HIBERNATION_PLATFORM:
905 if (hibernation_ops)
f0ced9b2
JB
906 break;
907 /* not a valid mode, continue with loop */
908 continue;
909 }
a3d25c27
RW
910 if (i == hibernation_mode)
911 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
f0ced9b2 912 else
a3d25c27 913 buf += sprintf(buf, "%s ", hibernation_modes[i]);
f0ced9b2
JB
914 }
915 buf += sprintf(buf, "\n");
916 return buf-start;
1da177e4
LT
917}
918
386f275f
KS
919static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
920 const char *buf, size_t n)
1da177e4
LT
921{
922 int error = 0;
923 int i;
924 int len;
925 char *p;
a3d25c27 926 int mode = HIBERNATION_INVALID;
1da177e4
LT
927
928 p = memchr(buf, '\n', n);
929 len = p ? p - buf : n;
930
bcda53fa 931 lock_system_sleep();
a3d25c27 932 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
8d98a690
RW
933 if (len == strlen(hibernation_modes[i])
934 && !strncmp(buf, hibernation_modes[i], len)) {
1da177e4
LT
935 mode = i;
936 break;
937 }
938 }
a3d25c27 939 if (mode != HIBERNATION_INVALID) {
fe0c935a 940 switch (mode) {
a3d25c27
RW
941 case HIBERNATION_SHUTDOWN:
942 case HIBERNATION_REBOOT:
62c552cc
BS
943#ifdef CONFIG_SUSPEND
944 case HIBERNATION_SUSPEND:
945#endif
a3d25c27 946 hibernation_mode = mode;
fe0c935a 947 break;
a3d25c27
RW
948 case HIBERNATION_PLATFORM:
949 if (hibernation_ops)
950 hibernation_mode = mode;
1da177e4
LT
951 else
952 error = -EINVAL;
953 }
a3d25c27 954 } else
1da177e4
LT
955 error = -EINVAL;
956
a3d25c27 957 if (!error)
23976728 958 pr_debug("PM: Hibernation mode set to '%s'\n",
a3d25c27 959 hibernation_modes[mode]);
bcda53fa 960 unlock_system_sleep();
1da177e4
LT
961 return error ? error : n;
962}
963
964power_attr(disk);
965
386f275f
KS
966static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
967 char *buf)
1da177e4
LT
968{
969 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
970 MINOR(swsusp_resume_device));
971}
972
386f275f
KS
973static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
974 const char *buf, size_t n)
1da177e4 975{
1da177e4 976 unsigned int maj, min;
1da177e4 977 dev_t res;
a576219a 978 int ret = -EINVAL;
1da177e4 979
a576219a
AM
980 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
981 goto out;
1da177e4 982
a576219a
AM
983 res = MKDEV(maj,min);
984 if (maj != MAJOR(res) || min != MINOR(res))
985 goto out;
1da177e4 986
bcda53fa 987 lock_system_sleep();
a576219a 988 swsusp_resume_device = res;
bcda53fa 989 unlock_system_sleep();
23976728 990 printk(KERN_INFO "PM: Starting manual resume from disk\n");
a576219a
AM
991 noresume = 0;
992 software_resume();
993 ret = n;
59a49335 994 out:
a576219a 995 return ret;
1da177e4
LT
996}
997
998power_attr(resume);
999
386f275f
KS
1000static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
1001 char *buf)
ca0aec0f 1002{
853609b6 1003 return sprintf(buf, "%lu\n", image_size);
ca0aec0f
RW
1004}
1005
386f275f
KS
1006static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1007 const char *buf, size_t n)
ca0aec0f 1008{
853609b6 1009 unsigned long size;
ca0aec0f 1010
853609b6 1011 if (sscanf(buf, "%lu", &size) == 1) {
ca0aec0f
RW
1012 image_size = size;
1013 return n;
1014 }
1015
1016 return -EINVAL;
1017}
1018
1019power_attr(image_size);
1020
ddeb6487
RW
1021static ssize_t reserved_size_show(struct kobject *kobj,
1022 struct kobj_attribute *attr, char *buf)
1023{
1024 return sprintf(buf, "%lu\n", reserved_size);
1025}
1026
1027static ssize_t reserved_size_store(struct kobject *kobj,
1028 struct kobj_attribute *attr,
1029 const char *buf, size_t n)
1030{
1031 unsigned long size;
1032
1033 if (sscanf(buf, "%lu", &size) == 1) {
1034 reserved_size = size;
1035 return n;
1036 }
1037
1038 return -EINVAL;
1039}
1040
1041power_attr(reserved_size);
1042
1da177e4
LT
1043static struct attribute * g[] = {
1044 &disk_attr.attr,
1045 &resume_attr.attr,
ca0aec0f 1046 &image_size_attr.attr,
ddeb6487 1047 &reserved_size_attr.attr,
1da177e4
LT
1048 NULL,
1049};
1050
1051
1052static struct attribute_group attr_group = {
1053 .attrs = g,
1054};
1055
1056
1057static int __init pm_disk_init(void)
1058{
d76e15fb 1059 return sysfs_create_group(power_kobj, &attr_group);
1da177e4
LT
1060}
1061
1062core_initcall(pm_disk_init);
1063
1064
1065static int __init resume_setup(char *str)
1066{
1067 if (noresume)
1068 return 1;
1069
1070 strncpy( resume_file, str, 255 );
1071 return 1;
1072}
1073
9a154d9d
RW
1074static int __init resume_offset_setup(char *str)
1075{
1076 unsigned long long offset;
1077
1078 if (noresume)
1079 return 1;
1080
1081 if (sscanf(str, "%llu", &offset) == 1)
1082 swsusp_resume_block = offset;
1083
1084 return 1;
1085}
1086
f996fc96
BS
1087static int __init hibernate_setup(char *str)
1088{
1089 if (!strncmp(str, "noresume", 8))
1090 noresume = 1;
1091 else if (!strncmp(str, "nocompress", 10))
1092 nocompress = 1;
1093 return 1;
1094}
1095
1da177e4
LT
1096static int __init noresume_setup(char *str)
1097{
1098 noresume = 1;
1099 return 1;
1100}
1101
6f8d7022
BS
1102static int __init resumewait_setup(char *str)
1103{
1104 resume_wait = 1;
1105 return 1;
1106}
1107
f126f733
BS
1108static int __init resumedelay_setup(char *str)
1109{
1110 resume_delay = simple_strtoul(str, NULL, 0);
1111 return 1;
1112}
1113
1da177e4 1114__setup("noresume", noresume_setup);
9a154d9d 1115__setup("resume_offset=", resume_offset_setup);
1da177e4 1116__setup("resume=", resume_setup);
f996fc96 1117__setup("hibernate=", hibernate_setup);
6f8d7022 1118__setup("resumewait", resumewait_setup);
f126f733 1119__setup("resumedelay=", resumedelay_setup);
This page took 1.043829 seconds and 5 git commands to generate.