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