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