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