Merge branch 'master' into next
[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>
1bfcf130 17#include <linux/kmod.h>
1da177e4
LT
18#include <linux/delay.h>
19#include <linux/fs.h>
d53d9f16 20#include <linux/mount.h>
88d10bba 21#include <linux/pm.h>
97c7801c 22#include <linux/console.h>
e3920fb4 23#include <linux/cpu.h>
7dfb7103 24#include <linux/freezer.h>
5a0e3ad6 25#include <linux/gfp.h>
40dc166c 26#include <linux/syscore_ops.h>
c7510859 27#include <scsi/scsi_scan.h>
a8af7898 28#include <asm/suspend.h>
d53d9f16 29
1da177e4
LT
30#include "power.h"
31
32
f996fc96 33static int nocompress = 0;
1da177e4 34static int noresume = 0;
47a460d5 35static char resume_file[256] = CONFIG_PM_STD_PARTITION;
1da177e4 36dev_t swsusp_resume_device;
9a154d9d 37sector_t swsusp_resume_block;
8e60c6a1 38int in_suspend __nosavedata = 0;
1da177e4 39
a3d25c27
RW
40enum {
41 HIBERNATION_INVALID,
42 HIBERNATION_PLATFORM,
43 HIBERNATION_TEST,
44 HIBERNATION_TESTPROC,
45 HIBERNATION_SHUTDOWN,
46 HIBERNATION_REBOOT,
47 /* keep last */
48 __HIBERNATION_AFTER_LAST
49};
50#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
51#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
52
53static int hibernation_mode = HIBERNATION_SHUTDOWN;
54
073ef1f6 55static const struct platform_hibernation_ops *hibernation_ops;
a3d25c27
RW
56
57/**
58 * hibernation_set_ops - set the global hibernate operations
59 * @ops: the hibernation operations to use in subsequent hibernation transitions
60 */
61
073ef1f6 62void hibernation_set_ops(const struct platform_hibernation_ops *ops)
a3d25c27 63{
caea99ef
RW
64 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
65 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
5729c63a 66 && ops->restore_cleanup && ops->leave)) {
a3d25c27
RW
67 WARN_ON(1);
68 return;
69 }
70 mutex_lock(&pm_mutex);
71 hibernation_ops = ops;
72 if (ops)
73 hibernation_mode = HIBERNATION_PLATFORM;
74 else if (hibernation_mode == HIBERNATION_PLATFORM)
75 hibernation_mode = HIBERNATION_SHUTDOWN;
76
77 mutex_unlock(&pm_mutex);
78}
79
abfe2d7b
RW
80static bool entering_platform_hibernation;
81
82bool system_entering_hibernation(void)
83{
84 return entering_platform_hibernation;
85}
86EXPORT_SYMBOL(system_entering_hibernation);
87
4cc79776
RW
88#ifdef CONFIG_PM_DEBUG
89static void hibernation_debug_sleep(void)
90{
91 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
92 mdelay(5000);
93}
94
95static int hibernation_testmode(int mode)
96{
97 if (hibernation_mode == mode) {
98 hibernation_debug_sleep();
99 return 1;
100 }
101 return 0;
102}
103
104static int hibernation_test(int level)
105{
106 if (pm_test_level == level) {
107 hibernation_debug_sleep();
108 return 1;
109 }
110 return 0;
111}
112#else /* !CONFIG_PM_DEBUG */
113static int hibernation_testmode(int mode) { return 0; }
114static int hibernation_test(int level) { return 0; }
115#endif /* !CONFIG_PM_DEBUG */
116
74f270af 117/**
caea99ef 118 * platform_begin - tell the platform driver that we're starting
74f270af
RW
119 * hibernation
120 */
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/**
129 * platform_end - tell the platform driver that we've entered the
130 * working state
131 */
132
133static void platform_end(int platform_mode)
134{
135 if (platform_mode && hibernation_ops)
136 hibernation_ops->end();
74f270af 137}
a3d25c27 138
8a05aac2 139/**
74f270af 140 * platform_pre_snapshot - prepare the machine for hibernation using the
8a05aac2
SS
141 * platform driver if so configured and return an error code if it fails
142 */
143
74f270af 144static int platform_pre_snapshot(int platform_mode)
8a05aac2 145{
7777fab9 146 return (platform_mode && hibernation_ops) ?
74f270af 147 hibernation_ops->pre_snapshot() : 0;
a3d25c27 148}
8a05aac2 149
c7e0831d
RW
150/**
151 * platform_leave - prepare the machine for switching to the normal mode
152 * of operation using the platform driver (called with interrupts disabled)
153 */
154
155static void platform_leave(int platform_mode)
156{
157 if (platform_mode && hibernation_ops)
158 hibernation_ops->leave();
159}
160
a3d25c27
RW
161/**
162 * platform_finish - switch the machine to the normal mode of operation
163 * using the platform driver (must be called after platform_prepare())
164 */
165
7777fab9 166static void platform_finish(int platform_mode)
a3d25c27 167{
7777fab9 168 if (platform_mode && hibernation_ops)
a3d25c27 169 hibernation_ops->finish();
8a05aac2
SS
170}
171
a634cc10
RW
172/**
173 * platform_pre_restore - prepare the platform for the restoration from a
174 * hibernation image. If the restore fails after this function has been
175 * called, platform_restore_cleanup() must be called.
176 */
177
178static int platform_pre_restore(int platform_mode)
179{
180 return (platform_mode && hibernation_ops) ?
181 hibernation_ops->pre_restore() : 0;
182}
183
184/**
185 * platform_restore_cleanup - switch the platform to the normal mode of
186 * operation after a failing restore. If platform_pre_restore() has been
187 * called before the failing restore, this function must be called too,
188 * regardless of the result of platform_pre_restore().
189 */
190
191static void platform_restore_cleanup(int platform_mode)
192{
193 if (platform_mode && hibernation_ops)
194 hibernation_ops->restore_cleanup();
195}
196
d8f3de0d
RW
197/**
198 * platform_recover - recover the platform from a failure to suspend
199 * devices.
200 */
201
202static void platform_recover(int platform_mode)
203{
204 if (platform_mode && hibernation_ops && hibernation_ops->recover)
205 hibernation_ops->recover();
206}
207
8e60c6a1
NC
208/**
209 * swsusp_show_speed - print the time elapsed between two events.
210 * @start: Starting event.
211 * @stop: Final event.
212 * @nr_pages - number of pages processed between @start and @stop
213 * @msg - introductory message to print
214 */
215
216void swsusp_show_speed(struct timeval *start, struct timeval *stop,
217 unsigned nr_pages, char *msg)
218{
219 s64 elapsed_centisecs64;
220 int centisecs;
221 int k;
222 int kps;
223
224 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
225 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
226 centisecs = elapsed_centisecs64;
227 if (centisecs == 0)
228 centisecs = 1; /* avoid div-by-zero */
229 k = nr_pages * (PAGE_SIZE / 1024);
230 kps = (k * 100) / centisecs;
231 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
232 msg, k,
233 centisecs / 100, centisecs % 100,
234 kps / 1000, (kps % 1000) / 10);
235}
236
c7e0831d
RW
237/**
238 * create_image - freeze devices that need to be frozen with interrupts
239 * off, create the hibernation image and thaw those devices. Control
240 * reappears in this routine after a restore.
241 */
242
47a460d5 243static int create_image(int platform_mode)
c7e0831d
RW
244{
245 int error;
246
247 error = arch_prepare_suspend();
248 if (error)
249 return error;
250
d1616302
AS
251 /* At this point, dpm_suspend_start() has been called, but *not*
252 * dpm_suspend_noirq(). We *must* call dpm_suspend_noirq() now.
c7e0831d
RW
253 * Otherwise, drivers for some devices (e.g. interrupt controllers)
254 * become desynchronized with the actual state of the hardware
255 * at resume time, and evil weirdness ensues.
256 */
d1616302 257 error = dpm_suspend_noirq(PMSG_FREEZE);
c7e0831d 258 if (error) {
23976728
RW
259 printk(KERN_ERR "PM: Some devices failed to power down, "
260 "aborting hibernation\n");
32bdfac5 261 return error;
c7e0831d 262 }
2ed8d2b3 263
4aecd671
RW
264 error = platform_pre_snapshot(platform_mode);
265 if (error || hibernation_test(TEST_PLATFORM))
266 goto Platform_finish;
267
268 error = disable_nonboot_cpus();
269 if (error || hibernation_test(TEST_CPUS)
270 || hibernation_testmode(HIBERNATION_TEST))
271 goto Enable_cpus;
272
2ed8d2b3
RW
273 local_irq_disable();
274
4484079d 275 error = sysdev_suspend(PMSG_FREEZE);
2ca6f62f 276 if (!error) {
40dc166c 277 error = syscore_suspend();
2ca6f62f
RW
278 if (error)
279 sysdev_resume();
280 }
770824bd 281 if (error) {
4484079d 282 printk(KERN_ERR "PM: Some system devices failed to power down, "
770824bd 283 "aborting hibernation\n");
4aecd671 284 goto Enable_irqs;
770824bd 285 }
c7e0831d 286
a2867e08 287 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
4cc79776
RW
288 goto Power_up;
289
290 in_suspend = 1;
c7e0831d
RW
291 save_processor_state();
292 error = swsusp_arch_suspend();
293 if (error)
23976728
RW
294 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
295 error);
c7e0831d
RW
296 /* Restore control flow magically appears here */
297 restore_processor_state();
c125e96f
RW
298 if (!in_suspend) {
299 events_check_enabled = false;
c7e0831d 300 platform_leave(platform_mode);
c125e96f 301 }
4aecd671 302
4cc79776 303 Power_up:
40dc166c 304 syscore_resume();
770824bd 305 sysdev_resume();
d1616302 306 /* NOTE: dpm_resume_noirq() is just a resume() for devices
c7e0831d
RW
307 * that suspended with irqs off ... no overall powerup.
308 */
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
RW
325/**
326 * hibernation_snapshot - quiesce devices and create the hibernation
327 * snapshot image.
328 * @platform_mode - if set, use the platform driver, if available, to
877d0310 329 * prepare the platform firmware for the power transition.
7777fab9
RW
330 *
331 * Must be called with pm_mutex held
332 */
333
334int hibernation_snapshot(int platform_mode)
335{
cbe2f5a6 336 int error;
7777fab9 337
3fe0313e 338 error = platform_begin(platform_mode);
7777fab9 339 if (error)
d074ee02 340 goto Close;
7777fab9 341
64a473cb
RW
342 /* Preallocate image memory before shutting down devices. */
343 error = hibernate_preallocate_memory();
74f270af 344 if (error)
caea99ef 345 goto Close;
74f270af 346
7777fab9 347 suspend_console();
c9e664f1 348 pm_restrict_gfp_mask();
d1616302 349 error = dpm_suspend_start(PMSG_FREEZE);
10a1803d 350 if (error)
d8f3de0d 351 goto Recover_platform;
10a1803d 352
4cc79776 353 if (hibernation_test(TEST_DEVICES))
d8f3de0d 354 goto Recover_platform;
7777fab9 355
4aecd671 356 error = create_image(platform_mode);
c9e664f1
RW
357 /*
358 * Control returns here (1) after the image has been created or the
359 * image creation has failed and (2) after a successful restore.
360 */
4cc79776 361
4cc79776 362 Resume_devices:
64a473cb
RW
363 /* We may need to release the preallocated image pages here. */
364 if (error || !in_suspend)
365 swsusp_free();
366
d1616302 367 dpm_resume_end(in_suspend ?
1eede070 368 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
c9e664f1
RW
369
370 if (error || !in_suspend)
371 pm_restore_gfp_mask();
372
7777fab9 373 resume_console();
caea99ef
RW
374 Close:
375 platform_end(platform_mode);
7777fab9 376 return error;
d8f3de0d
RW
377
378 Recover_platform:
379 platform_recover(platform_mode);
380 goto Resume_devices;
7777fab9
RW
381}
382
72df68ca
RW
383/**
384 * resume_target_kernel - prepare devices that need to be suspended with
385 * interrupts off, restore the contents of highmem that have not been
386 * restored yet from the image and run the low level code that will restore
387 * the remaining contents of memory and switch to the just restored target
388 * kernel.
389 */
390
4aecd671 391static int resume_target_kernel(bool platform_mode)
72df68ca
RW
392{
393 int error;
394
d1616302 395 error = dpm_suspend_noirq(PMSG_QUIESCE);
72df68ca 396 if (error) {
23976728 397 printk(KERN_ERR "PM: Some devices failed to power down, "
72df68ca 398 "aborting resume\n");
32bdfac5 399 return error;
72df68ca 400 }
2ed8d2b3 401
4aecd671
RW
402 error = platform_pre_restore(platform_mode);
403 if (error)
404 goto Cleanup;
405
406 error = disable_nonboot_cpus();
407 if (error)
408 goto Enable_cpus;
409
2ed8d2b3
RW
410 local_irq_disable();
411
4aecd671 412 error = sysdev_suspend(PMSG_QUIESCE);
2ca6f62f 413 if (!error) {
40dc166c 414 error = syscore_suspend();
2ca6f62f
RW
415 if (error)
416 sysdev_resume();
417 }
4aecd671
RW
418 if (error)
419 goto Enable_irqs;
420
72df68ca
RW
421 /* We'll ignore saved state, but this gets preempt count (etc) right */
422 save_processor_state();
423 error = restore_highmem();
424 if (!error) {
425 error = swsusp_arch_resume();
426 /*
427 * The code below is only ever reached in case of a failure.
428 * Otherwise execution continues at place where
429 * swsusp_arch_suspend() was called
430 */
431 BUG_ON(!error);
432 /* This call to restore_highmem() undos the previous one */
433 restore_highmem();
434 }
435 /*
436 * The only reason why swsusp_arch_resume() can fail is memory being
437 * very tight, so we have to free it as soon as we can to avoid
438 * subsequent failures
439 */
440 swsusp_free();
441 restore_processor_state();
442 touch_softlockup_watchdog();
2ed8d2b3 443
40dc166c 444 syscore_resume();
770824bd 445 sysdev_resume();
2ed8d2b3 446
4aecd671 447 Enable_irqs:
72df68ca 448 local_irq_enable();
2ed8d2b3 449
4aecd671
RW
450 Enable_cpus:
451 enable_nonboot_cpus();
452
453 Cleanup:
454 platform_restore_cleanup(platform_mode);
455
d1616302 456 dpm_resume_noirq(PMSG_RECOVER);
2ed8d2b3 457
72df68ca
RW
458 return error;
459}
460
7777fab9
RW
461/**
462 * hibernation_restore - quiesce devices and restore the hibernation
463 * snapshot image. If successful, control returns in hibernation_snaphot()
a634cc10 464 * @platform_mode - if set, use the platform driver, if available, to
877d0310 465 * prepare the platform firmware for the transition.
7777fab9
RW
466 *
467 * Must be called with pm_mutex held
468 */
469
a634cc10 470int hibernation_restore(int platform_mode)
7777fab9 471{
cbe2f5a6 472 int error;
7777fab9
RW
473
474 pm_prepare_console();
475 suspend_console();
c9e664f1 476 pm_restrict_gfp_mask();
d1616302 477 error = dpm_suspend_start(PMSG_QUIESCE);
a634cc10 478 if (!error) {
4aecd671 479 error = resume_target_kernel(platform_mode);
d1616302 480 dpm_resume_end(PMSG_RECOVER);
a634cc10 481 }
c9e664f1 482 pm_restore_gfp_mask();
7777fab9
RW
483 resume_console();
484 pm_restore_console();
485 return error;
486}
487
488/**
489 * hibernation_platform_enter - enter the hibernation state using the
490 * platform driver (if available)
491 */
492
493int hibernation_platform_enter(void)
494{
cbe2f5a6 495 int error;
b1457bcc 496
9cd9a005
RW
497 if (!hibernation_ops)
498 return -ENOSYS;
499
500 /*
501 * We have cancelled the power transition by running
502 * hibernation_ops->finish() before saving the image, so we should let
503 * the firmware know that we're going to enter the sleep state after all
504 */
caea99ef 505 error = hibernation_ops->begin();
9cd9a005 506 if (error)
caea99ef 507 goto Close;
9cd9a005 508
abfe2d7b 509 entering_platform_hibernation = true;
9cd9a005 510 suspend_console();
d1616302 511 error = dpm_suspend_start(PMSG_HIBERNATE);
d8f3de0d
RW
512 if (error) {
513 if (hibernation_ops->recover)
514 hibernation_ops->recover();
515 goto Resume_devices;
516 }
9cd9a005 517
d1616302 518 error = dpm_suspend_noirq(PMSG_HIBERNATE);
4aecd671 519 if (error)
32bdfac5 520 goto Resume_devices;
4aecd671 521
9cd9a005
RW
522 error = hibernation_ops->prepare();
523 if (error)
e681c9dd 524 goto Platform_finish;
9cd9a005
RW
525
526 error = disable_nonboot_cpus();
527 if (error)
e681c9dd 528 goto Platform_finish;
2ed8d2b3 529
4aecd671
RW
530 local_irq_disable();
531 sysdev_suspend(PMSG_HIBERNATE);
40dc166c 532 syscore_suspend();
a2867e08 533 if (pm_wakeup_pending()) {
c125e96f
RW
534 error = -EAGAIN;
535 goto Power_up;
536 }
537
4aecd671
RW
538 hibernation_ops->enter();
539 /* We should never get here */
540 while (1);
9cd9a005 541
c125e96f 542 Power_up:
40dc166c 543 syscore_resume();
c125e96f
RW
544 sysdev_resume();
545 local_irq_enable();
546 enable_nonboot_cpus();
547
e681c9dd 548 Platform_finish:
9cd9a005 549 hibernation_ops->finish();
2ed8d2b3 550
f6f71f18 551 dpm_resume_noirq(PMSG_RESTORE);
4aecd671 552
9cd9a005 553 Resume_devices:
abfe2d7b 554 entering_platform_hibernation = false;
d1616302 555 dpm_resume_end(PMSG_RESTORE);
9cd9a005 556 resume_console();
2ed8d2b3 557
caea99ef
RW
558 Close:
559 hibernation_ops->end();
2ed8d2b3 560
b1457bcc 561 return error;
7777fab9
RW
562}
563
1da177e4 564/**
a3d25c27 565 * power_down - Shut the machine down for hibernation.
1da177e4 566 *
fe0c935a
JB
567 * Use the platform driver, if configured so; otherwise try
568 * to power off or reboot.
1da177e4
LT
569 */
570
fe0c935a 571static void power_down(void)
1da177e4 572{
a3d25c27
RW
573 switch (hibernation_mode) {
574 case HIBERNATION_TEST:
575 case HIBERNATION_TESTPROC:
fe0c935a 576 break;
a3d25c27 577 case HIBERNATION_REBOOT:
fdde86ac 578 kernel_restart(NULL);
1da177e4 579 break;
a3d25c27 580 case HIBERNATION_PLATFORM:
7777fab9 581 hibernation_platform_enter();
9cd9a005
RW
582 case HIBERNATION_SHUTDOWN:
583 kernel_power_off();
584 break;
1da177e4 585 }
fdde86ac 586 kernel_halt();
fe0c935a
JB
587 /*
588 * Valid image is on the disk, if we continue we risk serious data
589 * corruption after resume.
590 */
23976728 591 printk(KERN_CRIT "PM: Please power down manually\n");
1da177e4
LT
592 while(1);
593}
594
1da177e4
LT
595static int prepare_processes(void)
596{
b918f6e6 597 int error = 0;
1da177e4 598
1da177e4
LT
599 if (freeze_processes()) {
600 error = -EBUSY;
5a0a2f30 601 thaw_processes();
1da177e4 602 }
5a72e04d 603 return error;
1da177e4
LT
604}
605
1da177e4 606/**
a3d25c27 607 * hibernate - The granpappy of the built-in hibernation management
1da177e4
LT
608 */
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/**
687 * software_resume - Resume from a saved image.
688 *
689 * Called as a late_initcall (so all devices are discovered and
690 * initialized), we call swsusp to see if we have a saved image or not.
691 * If so, we quiesce devices, the restore the saved image. We will
a3d25c27 692 * return above (in hibernate() ) if everything goes well.
1da177e4
LT
693 * Otherwise, we fail gracefully and return to the normally
694 * scheduled program.
695 *
696 */
697
698static int software_resume(void)
699{
700 int error;
a634cc10 701 unsigned int flags;
1da177e4 702
eed3ee08
AV
703 /*
704 * If the user said "noresume".. bail out early.
705 */
706 if (noresume)
707 return 0;
708
60a0d233
JB
709 /*
710 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
711 * is configured into the kernel. Since the regular hibernate
712 * trigger path is via sysfs which takes a buffer mutex before
713 * calling hibernate functions (which take pm_mutex) this can
714 * cause lockdep to complain about a possible ABBA deadlock
715 * which cannot happen since we're in the boot code here and
716 * sysfs can't be invoked yet. Therefore, we use a subclass
717 * here to avoid lockdep complaining.
718 */
719 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
0c8454f5
RW
720
721 if (swsusp_resume_device)
722 goto Check_image;
723
724 if (!strlen(resume_file)) {
725 error = -ENOENT;
726 goto Unlock;
727 }
728
d0941ead 729 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
0c8454f5
RW
730
731 /* Check if the device is there */
732 swsusp_resume_device = name_to_dev_t(resume_file);
3efa147a 733 if (!swsusp_resume_device) {
eed3ee08
AV
734 /*
735 * Some device discovery might still be in progress; we need
736 * to wait for this to finish.
737 */
738 wait_for_device_probe();
0c8454f5
RW
739 /*
740 * We can't depend on SCSI devices being available after loading
741 * one of their modules until scsi_complete_async_scans() is
742 * called and the resume device usually is a SCSI one.
743 */
744 scsi_complete_async_scans();
745
3efa147a 746 swsusp_resume_device = name_to_dev_t(resume_file);
0c8454f5
RW
747 if (!swsusp_resume_device) {
748 error = -ENODEV;
749 goto Unlock;
750 }
3efa147a
PM
751 }
752
0c8454f5 753 Check_image:
d0941ead 754 pr_debug("PM: Hibernation image partition %d:%d present\n",
0c8454f5 755 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
1da177e4 756
d0941ead 757 pr_debug("PM: Looking for hibernation image.\n");
ed746e3b
RW
758 error = swsusp_check();
759 if (error)
74dfd666 760 goto Unlock;
1da177e4 761
0709db60
RW
762 /* The snapshot device should not be opened while we're running */
763 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
764 error = -EBUSY;
76b57e61 765 swsusp_close(FMODE_READ);
0709db60
RW
766 goto Unlock;
767 }
768
5a0a2f30 769 pm_prepare_console();
c3e94d89
AS
770 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
771 if (error)
76b57e61 772 goto close_finish;
c3e94d89 773
1bfcf130
RW
774 error = usermodehelper_disable();
775 if (error)
76b57e61 776 goto close_finish;
1bfcf130 777
74dfd666
RW
778 error = create_basic_memory_bitmaps();
779 if (error)
76b57e61 780 goto close_finish;
1da177e4 781
74dfd666 782 pr_debug("PM: Preparing processes for restore.\n");
ed746e3b
RW
783 error = prepare_processes();
784 if (error) {
c2dd0dae 785 swsusp_close(FMODE_READ);
5a72e04d 786 goto Done;
1da177e4
LT
787 }
788
d0941ead 789 pr_debug("PM: Loading hibernation image.\n");
1da177e4 790
a634cc10 791 error = swsusp_read(&flags);
76b57e61 792 swsusp_close(FMODE_READ);
ed746e3b 793 if (!error)
a634cc10 794 hibernation_restore(flags & SF_PLATFORM_MODE);
1da177e4 795
d0941ead 796 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
7777fab9 797 swsusp_free();
5a0a2f30 798 thaw_processes();
1da177e4 799 Done:
74dfd666 800 free_basic_memory_bitmaps();
1bfcf130 801 usermodehelper_enable();
0709db60 802 Finish:
c3e94d89 803 pm_notifier_call_chain(PM_POST_RESTORE);
5a0a2f30 804 pm_restore_console();
0709db60 805 atomic_inc(&snapshot_device_available);
dd5d666b 806 /* For success case, the suspend path will release the lock */
74dfd666 807 Unlock:
a6d70980 808 mutex_unlock(&pm_mutex);
d0941ead 809 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
7777fab9 810 return error;
76b57e61
JS
811close_finish:
812 swsusp_close(FMODE_READ);
813 goto Finish;
1da177e4
LT
814}
815
816late_initcall(software_resume);
817
818
a3d25c27
RW
819static const char * const hibernation_modes[] = {
820 [HIBERNATION_PLATFORM] = "platform",
821 [HIBERNATION_SHUTDOWN] = "shutdown",
822 [HIBERNATION_REBOOT] = "reboot",
823 [HIBERNATION_TEST] = "test",
824 [HIBERNATION_TESTPROC] = "testproc",
1da177e4
LT
825};
826
827/**
a3d25c27 828 * disk - Control hibernation mode
1da177e4 829 *
11d77d0c
JB
830 * Suspend-to-disk can be handled in several ways. We have a few options
831 * for putting the system to sleep - using the platform driver (e.g. ACPI
a3d25c27
RW
832 * or other hibernation_ops), powering off the system or rebooting the
833 * system (for testing) as well as the two test modes.
1da177e4 834 *
11d77d0c 835 * The system can support 'platform', and that is known a priori (and
a3d25c27
RW
836 * encoded by the presence of hibernation_ops). However, the user may
837 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
838 * test modes, 'test' or 'testproc'.
1da177e4
LT
839 *
840 * show() will display what the mode is currently set to.
841 * store() will accept one of
842 *
1da177e4
LT
843 * 'platform'
844 * 'shutdown'
845 * 'reboot'
11d77d0c
JB
846 * 'test'
847 * 'testproc'
1da177e4 848 *
11d77d0c 849 * It will only change to 'platform' if the system
a3d25c27 850 * supports it (as determined by having hibernation_ops).
1da177e4
LT
851 */
852
386f275f
KS
853static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
854 char *buf)
1da177e4 855{
f0ced9b2
JB
856 int i;
857 char *start = buf;
858
a3d25c27
RW
859 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
860 if (!hibernation_modes[i])
f0ced9b2
JB
861 continue;
862 switch (i) {
a3d25c27
RW
863 case HIBERNATION_SHUTDOWN:
864 case HIBERNATION_REBOOT:
865 case HIBERNATION_TEST:
866 case HIBERNATION_TESTPROC:
f0ced9b2 867 break;
a3d25c27
RW
868 case HIBERNATION_PLATFORM:
869 if (hibernation_ops)
f0ced9b2
JB
870 break;
871 /* not a valid mode, continue with loop */
872 continue;
873 }
a3d25c27
RW
874 if (i == hibernation_mode)
875 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
f0ced9b2 876 else
a3d25c27 877 buf += sprintf(buf, "%s ", hibernation_modes[i]);
f0ced9b2
JB
878 }
879 buf += sprintf(buf, "\n");
880 return buf-start;
1da177e4
LT
881}
882
883
386f275f
KS
884static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
885 const char *buf, size_t n)
1da177e4
LT
886{
887 int error = 0;
888 int i;
889 int len;
890 char *p;
a3d25c27 891 int mode = HIBERNATION_INVALID;
1da177e4
LT
892
893 p = memchr(buf, '\n', n);
894 len = p ? p - buf : n;
895
a6d70980 896 mutex_lock(&pm_mutex);
a3d25c27 897 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
8d98a690
RW
898 if (len == strlen(hibernation_modes[i])
899 && !strncmp(buf, hibernation_modes[i], len)) {
1da177e4
LT
900 mode = i;
901 break;
902 }
903 }
a3d25c27 904 if (mode != HIBERNATION_INVALID) {
fe0c935a 905 switch (mode) {
a3d25c27
RW
906 case HIBERNATION_SHUTDOWN:
907 case HIBERNATION_REBOOT:
908 case HIBERNATION_TEST:
909 case HIBERNATION_TESTPROC:
910 hibernation_mode = mode;
fe0c935a 911 break;
a3d25c27
RW
912 case HIBERNATION_PLATFORM:
913 if (hibernation_ops)
914 hibernation_mode = mode;
1da177e4
LT
915 else
916 error = -EINVAL;
917 }
a3d25c27 918 } else
1da177e4
LT
919 error = -EINVAL;
920
a3d25c27 921 if (!error)
23976728 922 pr_debug("PM: Hibernation mode set to '%s'\n",
a3d25c27 923 hibernation_modes[mode]);
a6d70980 924 mutex_unlock(&pm_mutex);
1da177e4
LT
925 return error ? error : n;
926}
927
928power_attr(disk);
929
386f275f
KS
930static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
931 char *buf)
1da177e4
LT
932{
933 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
934 MINOR(swsusp_resume_device));
935}
936
386f275f
KS
937static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
938 const char *buf, size_t n)
1da177e4 939{
1da177e4 940 unsigned int maj, min;
1da177e4 941 dev_t res;
a576219a 942 int ret = -EINVAL;
1da177e4 943
a576219a
AM
944 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
945 goto out;
1da177e4 946
a576219a
AM
947 res = MKDEV(maj,min);
948 if (maj != MAJOR(res) || min != MINOR(res))
949 goto out;
1da177e4 950
a6d70980 951 mutex_lock(&pm_mutex);
a576219a 952 swsusp_resume_device = res;
a6d70980 953 mutex_unlock(&pm_mutex);
23976728 954 printk(KERN_INFO "PM: Starting manual resume from disk\n");
a576219a
AM
955 noresume = 0;
956 software_resume();
957 ret = n;
59a49335 958 out:
a576219a 959 return ret;
1da177e4
LT
960}
961
962power_attr(resume);
963
386f275f
KS
964static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
965 char *buf)
ca0aec0f 966{
853609b6 967 return sprintf(buf, "%lu\n", image_size);
ca0aec0f
RW
968}
969
386f275f
KS
970static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
971 const char *buf, size_t n)
ca0aec0f 972{
853609b6 973 unsigned long size;
ca0aec0f 974
853609b6 975 if (sscanf(buf, "%lu", &size) == 1) {
ca0aec0f
RW
976 image_size = size;
977 return n;
978 }
979
980 return -EINVAL;
981}
982
983power_attr(image_size);
984
1da177e4
LT
985static struct attribute * g[] = {
986 &disk_attr.attr,
987 &resume_attr.attr,
ca0aec0f 988 &image_size_attr.attr,
1da177e4
LT
989 NULL,
990};
991
992
993static struct attribute_group attr_group = {
994 .attrs = g,
995};
996
997
998static int __init pm_disk_init(void)
999{
d76e15fb 1000 return sysfs_create_group(power_kobj, &attr_group);
1da177e4
LT
1001}
1002
1003core_initcall(pm_disk_init);
1004
1005
1006static int __init resume_setup(char *str)
1007{
1008 if (noresume)
1009 return 1;
1010
1011 strncpy( resume_file, str, 255 );
1012 return 1;
1013}
1014
9a154d9d
RW
1015static int __init resume_offset_setup(char *str)
1016{
1017 unsigned long long offset;
1018
1019 if (noresume)
1020 return 1;
1021
1022 if (sscanf(str, "%llu", &offset) == 1)
1023 swsusp_resume_block = offset;
1024
1025 return 1;
1026}
1027
f996fc96
BS
1028static int __init hibernate_setup(char *str)
1029{
1030 if (!strncmp(str, "noresume", 8))
1031 noresume = 1;
1032 else if (!strncmp(str, "nocompress", 10))
1033 nocompress = 1;
1034 return 1;
1035}
1036
1da177e4
LT
1037static int __init noresume_setup(char *str)
1038{
1039 noresume = 1;
1040 return 1;
1041}
1042
1043__setup("noresume", noresume_setup);
9a154d9d 1044__setup("resume_offset=", resume_offset_setup);
1da177e4 1045__setup("resume=", resume_setup);
f996fc96 1046__setup("hibernate=", hibernate_setup);