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