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