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