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