rtc: hctosys: use function name in the error log
[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
3fe0313e 342 error = platform_begin(platform_mode);
7777fab9 343 if (error)
d074ee02 344 goto Close;
7777fab9 345
64a473cb
RW
346 /* Preallocate image memory before shutting down devices. */
347 error = hibernate_preallocate_memory();
2aede851
RW
348 if (error)
349 goto Close;
350
351 error = freeze_kernel_threads();
352 if (error)
bb58dd5d 353 goto Cleanup;
2aede851 354
48580ab8 355 if (hibernation_test(TEST_FREEZER)) {
aa9a7b11
SB
356
357 /*
358 * Indicate to the caller that we are returning due to a
359 * successful freezer test.
360 */
361 freezer_test_done = true;
51d6ff7a 362 goto Thaw;
aa9a7b11
SB
363 }
364
2aede851 365 error = dpm_prepare(PMSG_FREEZE);
bb58dd5d 366 if (error) {
953a2063 367 dpm_complete(PMSG_RECOVER);
51d6ff7a 368 goto Thaw;
bb58dd5d 369 }
74f270af 370
7777fab9 371 suspend_console();
c9e664f1 372 pm_restrict_gfp_mask();
953a2063 373
91e7c75b 374 error = dpm_suspend(PMSG_FREEZE);
10a1803d 375
953a2063
SB
376 if (error || hibernation_test(TEST_DEVICES))
377 platform_recover(platform_mode);
378 else
379 error = create_image(platform_mode);
7777fab9 380
c9e664f1 381 /*
953a2063
SB
382 * In the case that we call create_image() above, the control
383 * returns here (1) after the image has been created or the
c9e664f1
RW
384 * image creation has failed and (2) after a successful restore.
385 */
4cc79776 386
64a473cb
RW
387 /* We may need to release the preallocated image pages here. */
388 if (error || !in_suspend)
389 swsusp_free();
390
91e7c75b
RW
391 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
392 dpm_resume(msg);
c9e664f1
RW
393
394 if (error || !in_suspend)
395 pm_restore_gfp_mask();
396
7777fab9 397 resume_console();
91e7c75b
RW
398 dpm_complete(msg);
399
caea99ef
RW
400 Close:
401 platform_end(platform_mode);
7777fab9 402 return error;
d8f3de0d 403
51d6ff7a
SB
404 Thaw:
405 thaw_kernel_threads();
bb58dd5d
RW
406 Cleanup:
407 swsusp_free();
408 goto Close;
7777fab9
RW
409}
410
72df68ca 411/**
f42a9813
RW
412 * resume_target_kernel - Restore system state from a hibernation image.
413 * @platform_mode: Whether or not to use the platform driver.
414 *
cf579dfb
RW
415 * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
416 * contents of highmem that have not been restored yet from the image and run
417 * the low-level code that will restore the remaining contents of memory and
418 * switch to the just restored target kernel.
72df68ca 419 */
4aecd671 420static int resume_target_kernel(bool platform_mode)
72df68ca
RW
421{
422 int error;
423
cf579dfb 424 error = dpm_suspend_end(PMSG_QUIESCE);
72df68ca 425 if (error) {
23976728 426 printk(KERN_ERR "PM: Some devices failed to power down, "
72df68ca 427 "aborting resume\n");
32bdfac5 428 return error;
72df68ca 429 }
2ed8d2b3 430
4aecd671
RW
431 error = platform_pre_restore(platform_mode);
432 if (error)
433 goto Cleanup;
434
435 error = disable_nonboot_cpus();
436 if (error)
437 goto Enable_cpus;
438
2ed8d2b3
RW
439 local_irq_disable();
440
2e711c04 441 error = syscore_suspend();
4aecd671
RW
442 if (error)
443 goto Enable_irqs;
444
72df68ca
RW
445 save_processor_state();
446 error = restore_highmem();
447 if (!error) {
448 error = swsusp_arch_resume();
449 /*
450 * The code below is only ever reached in case of a failure.
4e2d9491
RW
451 * Otherwise, execution continues at the place where
452 * swsusp_arch_suspend() was called.
72df68ca
RW
453 */
454 BUG_ON(!error);
4e2d9491
RW
455 /*
456 * This call to restore_highmem() reverts the changes made by
457 * the previous one.
458 */
72df68ca
RW
459 restore_highmem();
460 }
461 /*
462 * The only reason why swsusp_arch_resume() can fail is memory being
463 * very tight, so we have to free it as soon as we can to avoid
4e2d9491 464 * subsequent failures.
72df68ca
RW
465 */
466 swsusp_free();
467 restore_processor_state();
468 touch_softlockup_watchdog();
2ed8d2b3 469
40dc166c 470 syscore_resume();
2ed8d2b3 471
4aecd671 472 Enable_irqs:
72df68ca 473 local_irq_enable();
2ed8d2b3 474
4aecd671
RW
475 Enable_cpus:
476 enable_nonboot_cpus();
477
478 Cleanup:
479 platform_restore_cleanup(platform_mode);
480
cf579dfb 481 dpm_resume_start(PMSG_RECOVER);
2ed8d2b3 482
72df68ca
RW
483 return error;
484}
485
7777fab9 486/**
f42a9813
RW
487 * hibernation_restore - Quiesce devices and restore from a hibernation image.
488 * @platform_mode: If set, use platform driver to prepare for the transition.
7777fab9 489 *
f42a9813 490 * This routine must be called with pm_mutex held. If it is successful, control
21e82808 491 * reappears in the restored target kernel in hibernation_snapshot().
7777fab9 492 */
a634cc10 493int hibernation_restore(int platform_mode)
7777fab9 494{
cbe2f5a6 495 int error;
7777fab9
RW
496
497 pm_prepare_console();
498 suspend_console();
c9e664f1 499 pm_restrict_gfp_mask();
d1616302 500 error = dpm_suspend_start(PMSG_QUIESCE);
a634cc10 501 if (!error) {
4aecd671 502 error = resume_target_kernel(platform_mode);
94fb823f
ID
503 /*
504 * The above should either succeed and jump to the new kernel,
505 * or return with an error. Otherwise things are just
506 * undefined, so let's be paranoid.
507 */
508 BUG_ON(!error);
a634cc10 509 }
94fb823f 510 dpm_resume_end(PMSG_RECOVER);
c9e664f1 511 pm_restore_gfp_mask();
7777fab9
RW
512 resume_console();
513 pm_restore_console();
514 return error;
515}
516
517/**
f42a9813 518 * hibernation_platform_enter - Power off the system using the platform driver.
7777fab9 519 */
7777fab9
RW
520int hibernation_platform_enter(void)
521{
cbe2f5a6 522 int error;
b1457bcc 523
9cd9a005
RW
524 if (!hibernation_ops)
525 return -ENOSYS;
526
527 /*
528 * We have cancelled the power transition by running
529 * hibernation_ops->finish() before saving the image, so we should let
530 * the firmware know that we're going to enter the sleep state after all
531 */
caea99ef 532 error = hibernation_ops->begin();
9cd9a005 533 if (error)
caea99ef 534 goto Close;
9cd9a005 535
abfe2d7b 536 entering_platform_hibernation = true;
9cd9a005 537 suspend_console();
d1616302 538 error = dpm_suspend_start(PMSG_HIBERNATE);
d8f3de0d
RW
539 if (error) {
540 if (hibernation_ops->recover)
541 hibernation_ops->recover();
542 goto Resume_devices;
543 }
9cd9a005 544
cf579dfb 545 error = dpm_suspend_end(PMSG_HIBERNATE);
4aecd671 546 if (error)
32bdfac5 547 goto Resume_devices;
4aecd671 548
9cd9a005
RW
549 error = hibernation_ops->prepare();
550 if (error)
e681c9dd 551 goto Platform_finish;
9cd9a005
RW
552
553 error = disable_nonboot_cpus();
554 if (error)
e681c9dd 555 goto Platform_finish;
2ed8d2b3 556
4aecd671 557 local_irq_disable();
40dc166c 558 syscore_suspend();
a2867e08 559 if (pm_wakeup_pending()) {
c125e96f
RW
560 error = -EAGAIN;
561 goto Power_up;
562 }
563
4aecd671
RW
564 hibernation_ops->enter();
565 /* We should never get here */
566 while (1);
9cd9a005 567
c125e96f 568 Power_up:
40dc166c 569 syscore_resume();
c125e96f
RW
570 local_irq_enable();
571 enable_nonboot_cpus();
572
e681c9dd 573 Platform_finish:
9cd9a005 574 hibernation_ops->finish();
2ed8d2b3 575
cf579dfb 576 dpm_resume_start(PMSG_RESTORE);
4aecd671 577
9cd9a005 578 Resume_devices:
abfe2d7b 579 entering_platform_hibernation = false;
d1616302 580 dpm_resume_end(PMSG_RESTORE);
9cd9a005 581 resume_console();
2ed8d2b3 582
caea99ef
RW
583 Close:
584 hibernation_ops->end();
2ed8d2b3 585
b1457bcc 586 return error;
7777fab9
RW
587}
588
1da177e4 589/**
f42a9813 590 * power_down - Shut the machine down for hibernation.
1da177e4 591 *
f42a9813
RW
592 * Use the platform driver, if configured, to put the system into the sleep
593 * state corresponding to hibernation, or try to power it off or reboot,
594 * depending on the value of hibernation_mode.
1da177e4 595 */
fe0c935a 596static void power_down(void)
1da177e4 597{
62c552cc
BS
598#ifdef CONFIG_SUSPEND
599 int error;
600#endif
601
a3d25c27 602 switch (hibernation_mode) {
a3d25c27 603 case HIBERNATION_REBOOT:
fdde86ac 604 kernel_restart(NULL);
1da177e4 605 break;
a3d25c27 606 case HIBERNATION_PLATFORM:
7777fab9 607 hibernation_platform_enter();
9cd9a005 608 case HIBERNATION_SHUTDOWN:
2c730785
SC
609 if (pm_power_off)
610 kernel_power_off();
9cd9a005 611 break;
62c552cc
BS
612#ifdef CONFIG_SUSPEND
613 case HIBERNATION_SUSPEND:
614 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
615 if (error) {
616 if (hibernation_ops)
617 hibernation_mode = HIBERNATION_PLATFORM;
618 else
619 hibernation_mode = HIBERNATION_SHUTDOWN;
620 power_down();
621 }
622 /*
623 * Restore swap signature.
624 */
625 error = swsusp_unmark();
626 if (error)
627 printk(KERN_ERR "PM: Swap will be unusable! "
628 "Try swapon -a.\n");
629 return;
630#endif
1da177e4 631 }
fdde86ac 632 kernel_halt();
fe0c935a
JB
633 /*
634 * Valid image is on the disk, if we continue we risk serious data
635 * corruption after resume.
636 */
23976728 637 printk(KERN_CRIT "PM: Please power down manually\n");
2c730785
SC
638 while (1)
639 cpu_relax();
1da177e4
LT
640}
641
1da177e4 642/**
f42a9813 643 * hibernate - Carry out system hibernation, including saving the image.
1da177e4 644 */
a3d25c27 645int hibernate(void)
1da177e4
LT
646{
647 int error;
648
a6e15a39
KC
649 if (!hibernation_available()) {
650 pr_debug("PM: Hibernation not available.\n");
651 return -EPERM;
652 }
653
bcda53fa 654 lock_system_sleep();
0709db60 655 /* The snapshot device should not be opened while we're running */
b10d9117
RW
656 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
657 error = -EBUSY;
658 goto Unlock;
659 }
660
5a0a2f30 661 pm_prepare_console();
b10d9117
RW
662 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
663 if (error)
664 goto Exit;
0709db60 665
23976728 666 printk(KERN_INFO "PM: Syncing filesystems ... ");
232b1432
RW
667 sys_sync();
668 printk("done.\n");
669
03afed8b 670 error = freeze_processes();
5a72e04d 671 if (error)
8fd37a4c
RW
672 goto Exit;
673
942f4015 674 lock_device_hotplug();
8fd37a4c
RW
675 /* Allocate memory management structures */
676 error = create_basic_memory_bitmaps();
677 if (error)
678 goto Thaw;
1da177e4 679
7777fab9 680 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
a556d5b5 681 if (error || freezer_test_done)
8fd37a4c 682 goto Free_bitmaps;
64a473cb
RW
683
684 if (in_suspend) {
a634cc10
RW
685 unsigned int flags = 0;
686
687 if (hibernation_mode == HIBERNATION_PLATFORM)
688 flags |= SF_PLATFORM_MODE;
f996fc96
BS
689 if (nocompress)
690 flags |= SF_NOCOMPRESS_MODE;
081a9d04
BS
691 else
692 flags |= SF_CRC32_MODE;
693
1da177e4 694 pr_debug("PM: writing image.\n");
a634cc10 695 error = swsusp_write(flags);
7777fab9 696 swsusp_free();
1da177e4 697 if (!error)
fe0c935a 698 power_down();
5262a475 699 in_suspend = 0;
c9e664f1 700 pm_restore_gfp_mask();
b918f6e6 701 } else {
1da177e4 702 pr_debug("PM: Image restored successfully.\n");
b918f6e6 703 }
64a473cb 704
8fd37a4c
RW
705 Free_bitmaps:
706 free_basic_memory_bitmaps();
b918f6e6 707 Thaw:
942f4015 708 unlock_device_hotplug();
5a0a2f30 709 thaw_processes();
a556d5b5
SB
710
711 /* Don't bother checking whether freezer_test_done is true */
712 freezer_test_done = false;
0709db60 713 Exit:
b10d9117 714 pm_notifier_call_chain(PM_POST_HIBERNATION);
5a0a2f30 715 pm_restore_console();
0709db60 716 atomic_inc(&snapshot_device_available);
b10d9117 717 Unlock:
bcda53fa 718 unlock_system_sleep();
1da177e4
LT
719 return error;
720}
721
722
723/**
f42a9813
RW
724 * software_resume - Resume from a saved hibernation image.
725 *
726 * This routine is called as a late initcall, when all devices have been
727 * discovered and initialized already.
1da177e4 728 *
f42a9813
RW
729 * The image reading code is called to see if there is a hibernation image
730 * available for reading. If that is the case, devices are quiesced and the
731 * contents of memory is restored from the saved image.
1da177e4 732 *
f42a9813
RW
733 * If this is successful, control reappears in the restored target kernel in
734 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
735 * attempts to recover gracefully and make the kernel return to the normal mode
736 * of operation.
1da177e4 737 */
1da177e4
LT
738static int software_resume(void)
739{
740 int error;
a634cc10 741 unsigned int flags;
1da177e4 742
eed3ee08
AV
743 /*
744 * If the user said "noresume".. bail out early.
745 */
a6e15a39 746 if (noresume || !hibernation_available())
eed3ee08
AV
747 return 0;
748
60a0d233
JB
749 /*
750 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
751 * is configured into the kernel. Since the regular hibernate
752 * trigger path is via sysfs which takes a buffer mutex before
753 * calling hibernate functions (which take pm_mutex) this can
754 * cause lockdep to complain about a possible ABBA deadlock
755 * which cannot happen since we're in the boot code here and
756 * sysfs can't be invoked yet. Therefore, we use a subclass
757 * here to avoid lockdep complaining.
758 */
759 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
0c8454f5
RW
760
761 if (swsusp_resume_device)
762 goto Check_image;
763
764 if (!strlen(resume_file)) {
765 error = -ENOENT;
766 goto Unlock;
767 }
768
d0941ead 769 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
0c8454f5 770
f126f733
BS
771 if (resume_delay) {
772 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
773 resume_delay);
774 ssleep(resume_delay);
775 }
776
0c8454f5
RW
777 /* Check if the device is there */
778 swsusp_resume_device = name_to_dev_t(resume_file);
2df83fa4
MB
779
780 /*
781 * name_to_dev_t is ineffective to verify parition if resume_file is in
782 * integer format. (e.g. major:minor)
783 */
784 if (isdigit(resume_file[0]) && resume_wait) {
785 int partno;
786 while (!get_gendisk(swsusp_resume_device, &partno))
787 msleep(10);
788 }
789
3efa147a 790 if (!swsusp_resume_device) {
eed3ee08
AV
791 /*
792 * Some device discovery might still be in progress; we need
793 * to wait for this to finish.
794 */
795 wait_for_device_probe();
6f8d7022
BS
796
797 if (resume_wait) {
798 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
799 msleep(10);
800 async_synchronize_full();
801 }
802
3efa147a 803 swsusp_resume_device = name_to_dev_t(resume_file);
0c8454f5
RW
804 if (!swsusp_resume_device) {
805 error = -ENODEV;
806 goto Unlock;
807 }
3efa147a
PM
808 }
809
0c8454f5 810 Check_image:
d0941ead 811 pr_debug("PM: Hibernation image partition %d:%d present\n",
0c8454f5 812 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
1da177e4 813
d0941ead 814 pr_debug("PM: Looking for hibernation image.\n");
ed746e3b
RW
815 error = swsusp_check();
816 if (error)
74dfd666 817 goto Unlock;
1da177e4 818
0709db60
RW
819 /* The snapshot device should not be opened while we're running */
820 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
821 error = -EBUSY;
76b57e61 822 swsusp_close(FMODE_READ);
0709db60
RW
823 goto Unlock;
824 }
825
5a0a2f30 826 pm_prepare_console();
c3e94d89
AS
827 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
828 if (error)
8fd37a4c 829 goto Close_Finish;
1bfcf130 830
74dfd666 831 pr_debug("PM: Preparing processes for restore.\n");
03afed8b 832 error = freeze_processes();
8fd37a4c
RW
833 if (error)
834 goto Close_Finish;
1da177e4 835
d0941ead 836 pr_debug("PM: Loading hibernation image.\n");
1da177e4 837
942f4015 838 lock_device_hotplug();
8fd37a4c
RW
839 error = create_basic_memory_bitmaps();
840 if (error)
841 goto Thaw;
842
a634cc10 843 error = swsusp_read(&flags);
76b57e61 844 swsusp_close(FMODE_READ);
ed746e3b 845 if (!error)
a634cc10 846 hibernation_restore(flags & SF_PLATFORM_MODE);
1da177e4 847
d0941ead 848 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
7777fab9 849 swsusp_free();
7b5179ac 850 free_basic_memory_bitmaps();
8fd37a4c 851 Thaw:
942f4015 852 unlock_device_hotplug();
8fd37a4c 853 thaw_processes();
0709db60 854 Finish:
c3e94d89 855 pm_notifier_call_chain(PM_POST_RESTORE);
5a0a2f30 856 pm_restore_console();
0709db60 857 atomic_inc(&snapshot_device_available);
dd5d666b 858 /* For success case, the suspend path will release the lock */
74dfd666 859 Unlock:
a6d70980 860 mutex_unlock(&pm_mutex);
d0941ead 861 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
7777fab9 862 return error;
8fd37a4c 863 Close_Finish:
76b57e61
JS
864 swsusp_close(FMODE_READ);
865 goto Finish;
1da177e4
LT
866}
867
d3c345db 868late_initcall_sync(software_resume);
1da177e4
LT
869
870
a3d25c27
RW
871static const char * const hibernation_modes[] = {
872 [HIBERNATION_PLATFORM] = "platform",
873 [HIBERNATION_SHUTDOWN] = "shutdown",
874 [HIBERNATION_REBOOT] = "reboot",
62c552cc
BS
875#ifdef CONFIG_SUSPEND
876 [HIBERNATION_SUSPEND] = "suspend",
877#endif
1da177e4
LT
878};
879
f42a9813
RW
880/*
881 * /sys/power/disk - Control hibernation mode.
1da177e4 882 *
f42a9813
RW
883 * Hibernation can be handled in several ways. There are a few different ways
884 * to put the system into the sleep state: using the platform driver (e.g. ACPI
885 * or other hibernation_ops), powering it off or rebooting it (for testing
48580ab8 886 * mostly).
1da177e4 887 *
f42a9813
RW
888 * The sysfs file /sys/power/disk provides an interface for selecting the
889 * hibernation mode to use. Reading from this file causes the available modes
48580ab8 890 * to be printed. There are 3 modes that can be supported:
1da177e4 891 *
1da177e4
LT
892 * 'platform'
893 * 'shutdown'
894 * 'reboot'
895 *
f42a9813
RW
896 * If a platform hibernation driver is in use, 'platform' will be supported
897 * and will be used by default. Otherwise, 'shutdown' will be used by default.
898 * The selected option (i.e. the one corresponding to the current value of
899 * hibernation_mode) is enclosed by a square bracket.
900 *
901 * To select a given hibernation mode it is necessary to write the mode's
902 * string representation (as returned by reading from /sys/power/disk) back
903 * into /sys/power/disk.
1da177e4
LT
904 */
905
386f275f
KS
906static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
907 char *buf)
1da177e4 908{
f0ced9b2
JB
909 int i;
910 char *start = buf;
911
a6e15a39
KC
912 if (!hibernation_available())
913 return sprintf(buf, "[disabled]\n");
914
a3d25c27
RW
915 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
916 if (!hibernation_modes[i])
f0ced9b2
JB
917 continue;
918 switch (i) {
a3d25c27
RW
919 case HIBERNATION_SHUTDOWN:
920 case HIBERNATION_REBOOT:
62c552cc
BS
921#ifdef CONFIG_SUSPEND
922 case HIBERNATION_SUSPEND:
923#endif
f0ced9b2 924 break;
a3d25c27
RW
925 case HIBERNATION_PLATFORM:
926 if (hibernation_ops)
f0ced9b2
JB
927 break;
928 /* not a valid mode, continue with loop */
929 continue;
930 }
a3d25c27
RW
931 if (i == hibernation_mode)
932 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
f0ced9b2 933 else
a3d25c27 934 buf += sprintf(buf, "%s ", hibernation_modes[i]);
f0ced9b2
JB
935 }
936 buf += sprintf(buf, "\n");
937 return buf-start;
1da177e4
LT
938}
939
386f275f
KS
940static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
941 const char *buf, size_t n)
1da177e4
LT
942{
943 int error = 0;
944 int i;
945 int len;
946 char *p;
a3d25c27 947 int mode = HIBERNATION_INVALID;
1da177e4 948
a6e15a39
KC
949 if (!hibernation_available())
950 return -EPERM;
951
1da177e4
LT
952 p = memchr(buf, '\n', n);
953 len = p ? p - buf : n;
954
bcda53fa 955 lock_system_sleep();
a3d25c27 956 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
8d98a690
RW
957 if (len == strlen(hibernation_modes[i])
958 && !strncmp(buf, hibernation_modes[i], len)) {
1da177e4
LT
959 mode = i;
960 break;
961 }
962 }
a3d25c27 963 if (mode != HIBERNATION_INVALID) {
fe0c935a 964 switch (mode) {
a3d25c27
RW
965 case HIBERNATION_SHUTDOWN:
966 case HIBERNATION_REBOOT:
62c552cc
BS
967#ifdef CONFIG_SUSPEND
968 case HIBERNATION_SUSPEND:
969#endif
a3d25c27 970 hibernation_mode = mode;
fe0c935a 971 break;
a3d25c27
RW
972 case HIBERNATION_PLATFORM:
973 if (hibernation_ops)
974 hibernation_mode = mode;
1da177e4
LT
975 else
976 error = -EINVAL;
977 }
a3d25c27 978 } else
1da177e4
LT
979 error = -EINVAL;
980
a3d25c27 981 if (!error)
23976728 982 pr_debug("PM: Hibernation mode set to '%s'\n",
a3d25c27 983 hibernation_modes[mode]);
bcda53fa 984 unlock_system_sleep();
1da177e4
LT
985 return error ? error : n;
986}
987
988power_attr(disk);
989
386f275f
KS
990static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
991 char *buf)
1da177e4
LT
992{
993 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
994 MINOR(swsusp_resume_device));
995}
996
386f275f
KS
997static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
998 const char *buf, size_t n)
1da177e4 999{
1da177e4 1000 dev_t res;
421a5fa1
SC
1001 int len = n;
1002 char *name;
1da177e4 1003
421a5fa1
SC
1004 if (len && buf[len-1] == '\n')
1005 len--;
1006 name = kstrndup(buf, len, GFP_KERNEL);
1007 if (!name)
1008 return -ENOMEM;
1da177e4 1009
421a5fa1
SC
1010 res = name_to_dev_t(name);
1011 kfree(name);
1012 if (!res)
1013 return -EINVAL;
1da177e4 1014
bcda53fa 1015 lock_system_sleep();
a576219a 1016 swsusp_resume_device = res;
bcda53fa 1017 unlock_system_sleep();
23976728 1018 printk(KERN_INFO "PM: Starting manual resume from disk\n");
a576219a
AM
1019 noresume = 0;
1020 software_resume();
421a5fa1 1021 return n;
1da177e4
LT
1022}
1023
1024power_attr(resume);
1025
386f275f
KS
1026static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
1027 char *buf)
ca0aec0f 1028{
853609b6 1029 return sprintf(buf, "%lu\n", image_size);
ca0aec0f
RW
1030}
1031
386f275f
KS
1032static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1033 const char *buf, size_t n)
ca0aec0f 1034{
853609b6 1035 unsigned long size;
ca0aec0f 1036
853609b6 1037 if (sscanf(buf, "%lu", &size) == 1) {
ca0aec0f
RW
1038 image_size = size;
1039 return n;
1040 }
1041
1042 return -EINVAL;
1043}
1044
1045power_attr(image_size);
1046
ddeb6487
RW
1047static ssize_t reserved_size_show(struct kobject *kobj,
1048 struct kobj_attribute *attr, char *buf)
1049{
1050 return sprintf(buf, "%lu\n", reserved_size);
1051}
1052
1053static ssize_t reserved_size_store(struct kobject *kobj,
1054 struct kobj_attribute *attr,
1055 const char *buf, size_t n)
1056{
1057 unsigned long size;
1058
1059 if (sscanf(buf, "%lu", &size) == 1) {
1060 reserved_size = size;
1061 return n;
1062 }
1063
1064 return -EINVAL;
1065}
1066
1067power_attr(reserved_size);
1068
1da177e4
LT
1069static struct attribute * g[] = {
1070 &disk_attr.attr,
1071 &resume_attr.attr,
ca0aec0f 1072 &image_size_attr.attr,
ddeb6487 1073 &reserved_size_attr.attr,
1da177e4
LT
1074 NULL,
1075};
1076
1077
1078static struct attribute_group attr_group = {
1079 .attrs = g,
1080};
1081
1082
1083static int __init pm_disk_init(void)
1084{
d76e15fb 1085 return sysfs_create_group(power_kobj, &attr_group);
1da177e4
LT
1086}
1087
1088core_initcall(pm_disk_init);
1089
1090
1091static int __init resume_setup(char *str)
1092{
1093 if (noresume)
1094 return 1;
1095
1096 strncpy( resume_file, str, 255 );
1097 return 1;
1098}
1099
9a154d9d
RW
1100static int __init resume_offset_setup(char *str)
1101{
1102 unsigned long long offset;
1103
1104 if (noresume)
1105 return 1;
1106
1107 if (sscanf(str, "%llu", &offset) == 1)
1108 swsusp_resume_block = offset;
1109
1110 return 1;
1111}
1112
f996fc96
BS
1113static int __init hibernate_setup(char *str)
1114{
1115 if (!strncmp(str, "noresume", 8))
1116 noresume = 1;
1117 else if (!strncmp(str, "nocompress", 10))
1118 nocompress = 1;
a6e15a39
KC
1119 else if (!strncmp(str, "no", 2)) {
1120 noresume = 1;
1121 nohibernate = 1;
1122 }
f996fc96
BS
1123 return 1;
1124}
1125
1da177e4
LT
1126static int __init noresume_setup(char *str)
1127{
1128 noresume = 1;
1129 return 1;
1130}
1131
6f8d7022
BS
1132static int __init resumewait_setup(char *str)
1133{
1134 resume_wait = 1;
1135 return 1;
1136}
1137
f126f733
BS
1138static int __init resumedelay_setup(char *str)
1139{
f6514be5 1140 int rc = kstrtouint(str, 0, &resume_delay);
317cf7e5
FF
1141
1142 if (rc)
1143 return rc;
f126f733
BS
1144 return 1;
1145}
1146
a6e15a39
KC
1147static int __init nohibernate_setup(char *str)
1148{
1149 noresume = 1;
1150 nohibernate = 1;
1151 return 1;
1152}
1153
24f2e027
KC
1154static int __init kaslr_nohibernate_setup(char *str)
1155{
1156 return nohibernate_setup(str);
1157}
1158
1da177e4 1159__setup("noresume", noresume_setup);
9a154d9d 1160__setup("resume_offset=", resume_offset_setup);
1da177e4 1161__setup("resume=", resume_setup);
f996fc96 1162__setup("hibernate=", hibernate_setup);
6f8d7022 1163__setup("resumewait", resumewait_setup);
f126f733 1164__setup("resumedelay=", resumedelay_setup);
a6e15a39 1165__setup("nohibernate", nohibernate_setup);
24f2e027 1166__setup("kaslr", kaslr_nohibernate_setup);