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