2 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
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.
9 * This file is released under the GPLv2.
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>
20 #include <linux/mount.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 #include <asm/suspend.h>
33 static int nocompress = 0;
34 static int noresume = 0;
35 static char resume_file[256] = CONFIG_PM_STD_PARTITION;
36 dev_t swsusp_resume_device;
37 sector_t swsusp_resume_block;
38 int in_suspend __nosavedata = 0;
48 __HIBERNATION_AFTER_LAST
50 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
51 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
53 static int hibernation_mode = HIBERNATION_SHUTDOWN;
55 static const struct platform_hibernation_ops *hibernation_ops;
58 * hibernation_set_ops - set the global hibernate operations
59 * @ops: the hibernation operations to use in subsequent hibernation transitions
62 void hibernation_set_ops(const struct platform_hibernation_ops *ops)
64 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
65 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
66 && ops->restore_cleanup && ops->leave)) {
70 mutex_lock(&pm_mutex);
71 hibernation_ops = ops;
73 hibernation_mode = HIBERNATION_PLATFORM;
74 else if (hibernation_mode == HIBERNATION_PLATFORM)
75 hibernation_mode = HIBERNATION_SHUTDOWN;
77 mutex_unlock(&pm_mutex);
80 static bool entering_platform_hibernation;
82 bool system_entering_hibernation(void)
84 return entering_platform_hibernation;
86 EXPORT_SYMBOL(system_entering_hibernation);
88 #ifdef CONFIG_PM_DEBUG
89 static void hibernation_debug_sleep(void)
91 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
95 static int hibernation_testmode(int mode)
97 if (hibernation_mode == mode) {
98 hibernation_debug_sleep();
104 static int hibernation_test(int level)
106 if (pm_test_level == level) {
107 hibernation_debug_sleep();
112 #else /* !CONFIG_PM_DEBUG */
113 static int hibernation_testmode(int mode) { return 0; }
114 static int hibernation_test(int level) { return 0; }
115 #endif /* !CONFIG_PM_DEBUG */
118 * platform_begin - tell the platform driver that we're starting
122 static int platform_begin(int platform_mode)
124 return (platform_mode && hibernation_ops) ?
125 hibernation_ops->begin() : 0;
129 * platform_end - tell the platform driver that we've entered the
133 static void platform_end(int platform_mode)
135 if (platform_mode && hibernation_ops)
136 hibernation_ops->end();
140 * platform_pre_snapshot - prepare the machine for hibernation using the
141 * platform driver if so configured and return an error code if it fails
144 static int platform_pre_snapshot(int platform_mode)
146 return (platform_mode && hibernation_ops) ?
147 hibernation_ops->pre_snapshot() : 0;
151 * platform_leave - prepare the machine for switching to the normal mode
152 * of operation using the platform driver (called with interrupts disabled)
155 static void platform_leave(int platform_mode)
157 if (platform_mode && hibernation_ops)
158 hibernation_ops->leave();
162 * platform_finish - switch the machine to the normal mode of operation
163 * using the platform driver (must be called after platform_prepare())
166 static void platform_finish(int platform_mode)
168 if (platform_mode && hibernation_ops)
169 hibernation_ops->finish();
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.
178 static int platform_pre_restore(int platform_mode)
180 return (platform_mode && hibernation_ops) ?
181 hibernation_ops->pre_restore() : 0;
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().
191 static void platform_restore_cleanup(int platform_mode)
193 if (platform_mode && hibernation_ops)
194 hibernation_ops->restore_cleanup();
198 * platform_recover - recover the platform from a failure to suspend
202 static void platform_recover(int platform_mode)
204 if (platform_mode && hibernation_ops && hibernation_ops->recover)
205 hibernation_ops->recover();
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
216 void swsusp_show_speed(struct timeval *start, struct timeval *stop,
217 unsigned nr_pages, char *msg)
219 s64 elapsed_centisecs64;
224 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
225 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
226 centisecs = elapsed_centisecs64;
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",
233 centisecs / 100, centisecs % 100,
234 kps / 1000, (kps % 1000) / 10);
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.
243 static int create_image(int platform_mode)
247 error = arch_prepare_suspend();
251 /* At this point, dpm_suspend_start() has been called, but *not*
252 * dpm_suspend_noirq(). We *must* call dpm_suspend_noirq() now.
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.
257 error = dpm_suspend_noirq(PMSG_FREEZE);
259 printk(KERN_ERR "PM: Some devices failed to power down, "
260 "aborting hibernation\n");
264 error = platform_pre_snapshot(platform_mode);
265 if (error || hibernation_test(TEST_PLATFORM))
266 goto Platform_finish;
268 error = disable_nonboot_cpus();
269 if (error || hibernation_test(TEST_CPUS)
270 || hibernation_testmode(HIBERNATION_TEST))
275 error = syscore_suspend();
277 printk(KERN_ERR "PM: Some system devices failed to power down, "
278 "aborting hibernation\n");
282 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
286 save_processor_state();
287 error = swsusp_arch_suspend();
289 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
291 /* Restore control flow magically appears here */
292 restore_processor_state();
294 events_check_enabled = false;
295 platform_leave(platform_mode);
300 /* NOTE: dpm_resume_noirq() is just a resume() for devices
301 * that suspended with irqs off ... no overall powerup.
308 enable_nonboot_cpus();
311 platform_finish(platform_mode);
313 dpm_resume_noirq(in_suspend ?
314 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
320 * hibernation_snapshot - quiesce devices and create the hibernation
322 * @platform_mode - if set, use the platform driver, if available, to
323 * prepare the platform firmware for the power transition.
325 * Must be called with pm_mutex held
328 int hibernation_snapshot(int platform_mode)
330 pm_message_t msg = PMSG_RECOVER;
333 error = platform_begin(platform_mode);
337 error = dpm_prepare(PMSG_FREEZE);
339 goto Complete_devices;
341 /* Preallocate image memory before shutting down devices. */
342 error = hibernate_preallocate_memory();
344 goto Complete_devices;
347 pm_restrict_gfp_mask();
348 error = dpm_suspend(PMSG_FREEZE);
350 goto Recover_platform;
352 if (hibernation_test(TEST_DEVICES))
353 goto Recover_platform;
355 error = create_image(platform_mode);
357 * Control returns here (1) after the image has been created or the
358 * image creation has failed and (2) after a successful restore.
362 /* We may need to release the preallocated image pages here. */
363 if (error || !in_suspend)
366 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
369 if (error || !in_suspend)
370 pm_restore_gfp_mask();
378 platform_end(platform_mode);
382 platform_recover(platform_mode);
387 * resume_target_kernel - prepare devices that need to be suspended with
388 * interrupts off, restore the contents of highmem that have not been
389 * restored yet from the image and run the low level code that will restore
390 * the remaining contents of memory and switch to the just restored target
394 static int resume_target_kernel(bool platform_mode)
398 error = dpm_suspend_noirq(PMSG_QUIESCE);
400 printk(KERN_ERR "PM: Some devices failed to power down, "
401 "aborting resume\n");
405 error = platform_pre_restore(platform_mode);
409 error = disable_nonboot_cpus();
415 error = syscore_suspend();
419 /* We'll ignore saved state, but this gets preempt count (etc) right */
420 save_processor_state();
421 error = restore_highmem();
423 error = swsusp_arch_resume();
425 * The code below is only ever reached in case of a failure.
426 * Otherwise execution continues at place where
427 * swsusp_arch_suspend() was called
430 /* This call to restore_highmem() undos the previous one */
434 * The only reason why swsusp_arch_resume() can fail is memory being
435 * very tight, so we have to free it as soon as we can to avoid
436 * subsequent failures
439 restore_processor_state();
440 touch_softlockup_watchdog();
448 enable_nonboot_cpus();
451 platform_restore_cleanup(platform_mode);
453 dpm_resume_noirq(PMSG_RECOVER);
459 * hibernation_restore - quiesce devices and restore the hibernation
460 * snapshot image. If successful, control returns in hibernation_snaphot()
461 * @platform_mode - if set, use the platform driver, if available, to
462 * prepare the platform firmware for the transition.
464 * Must be called with pm_mutex held
467 int hibernation_restore(int platform_mode)
471 pm_prepare_console();
473 pm_restrict_gfp_mask();
474 error = dpm_suspend_start(PMSG_QUIESCE);
476 error = resume_target_kernel(platform_mode);
477 dpm_resume_end(PMSG_RECOVER);
479 pm_restore_gfp_mask();
481 pm_restore_console();
486 * hibernation_platform_enter - enter the hibernation state using the
487 * platform driver (if available)
490 int hibernation_platform_enter(void)
494 if (!hibernation_ops)
498 * We have cancelled the power transition by running
499 * hibernation_ops->finish() before saving the image, so we should let
500 * the firmware know that we're going to enter the sleep state after all
502 error = hibernation_ops->begin();
506 entering_platform_hibernation = true;
508 error = dpm_suspend_start(PMSG_HIBERNATE);
510 if (hibernation_ops->recover)
511 hibernation_ops->recover();
515 error = dpm_suspend_noirq(PMSG_HIBERNATE);
519 error = hibernation_ops->prepare();
521 goto Platform_finish;
523 error = disable_nonboot_cpus();
525 goto Platform_finish;
529 if (pm_wakeup_pending()) {
534 hibernation_ops->enter();
535 /* We should never get here */
541 enable_nonboot_cpus();
544 hibernation_ops->finish();
546 dpm_resume_noirq(PMSG_RESTORE);
549 entering_platform_hibernation = false;
550 dpm_resume_end(PMSG_RESTORE);
554 hibernation_ops->end();
560 * power_down - Shut the machine down for hibernation.
562 * Use the platform driver, if configured so; otherwise try
563 * to power off or reboot.
566 static void power_down(void)
568 switch (hibernation_mode) {
569 case HIBERNATION_TEST:
570 case HIBERNATION_TESTPROC:
572 case HIBERNATION_REBOOT:
573 kernel_restart(NULL);
575 case HIBERNATION_PLATFORM:
576 hibernation_platform_enter();
577 case HIBERNATION_SHUTDOWN:
583 * Valid image is on the disk, if we continue we risk serious data
584 * corruption after resume.
586 printk(KERN_CRIT "PM: Please power down manually\n");
590 static int prepare_processes(void)
594 if (freeze_processes()) {
602 * hibernate - The granpappy of the built-in hibernation management
609 mutex_lock(&pm_mutex);
610 /* The snapshot device should not be opened while we're running */
611 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
616 pm_prepare_console();
617 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
621 error = usermodehelper_disable();
625 /* Allocate memory management structures */
626 error = create_basic_memory_bitmaps();
630 printk(KERN_INFO "PM: Syncing filesystems ... ");
634 error = prepare_processes();
638 if (hibernation_test(TEST_FREEZER))
641 if (hibernation_testmode(HIBERNATION_TESTPROC))
644 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
649 unsigned int flags = 0;
651 if (hibernation_mode == HIBERNATION_PLATFORM)
652 flags |= SF_PLATFORM_MODE;
654 flags |= SF_NOCOMPRESS_MODE;
655 pr_debug("PM: writing image.\n");
656 error = swsusp_write(flags);
661 pm_restore_gfp_mask();
663 pr_debug("PM: Image restored successfully.\n");
669 free_basic_memory_bitmaps();
670 usermodehelper_enable();
672 pm_notifier_call_chain(PM_POST_HIBERNATION);
673 pm_restore_console();
674 atomic_inc(&snapshot_device_available);
676 mutex_unlock(&pm_mutex);
682 * software_resume - Resume from a saved image.
684 * Called as a late_initcall (so all devices are discovered and
685 * initialized), we call swsusp to see if we have a saved image or not.
686 * If so, we quiesce devices, the restore the saved image. We will
687 * return above (in hibernate() ) if everything goes well.
688 * Otherwise, we fail gracefully and return to the normally
693 static int software_resume(void)
699 * If the user said "noresume".. bail out early.
705 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
706 * is configured into the kernel. Since the regular hibernate
707 * trigger path is via sysfs which takes a buffer mutex before
708 * calling hibernate functions (which take pm_mutex) this can
709 * cause lockdep to complain about a possible ABBA deadlock
710 * which cannot happen since we're in the boot code here and
711 * sysfs can't be invoked yet. Therefore, we use a subclass
712 * here to avoid lockdep complaining.
714 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
716 if (swsusp_resume_device)
719 if (!strlen(resume_file)) {
724 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
726 /* Check if the device is there */
727 swsusp_resume_device = name_to_dev_t(resume_file);
728 if (!swsusp_resume_device) {
730 * Some device discovery might still be in progress; we need
731 * to wait for this to finish.
733 wait_for_device_probe();
735 * We can't depend on SCSI devices being available after loading
736 * one of their modules until scsi_complete_async_scans() is
737 * called and the resume device usually is a SCSI one.
739 scsi_complete_async_scans();
741 swsusp_resume_device = name_to_dev_t(resume_file);
742 if (!swsusp_resume_device) {
749 pr_debug("PM: Hibernation image partition %d:%d present\n",
750 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
752 pr_debug("PM: Looking for hibernation image.\n");
753 error = swsusp_check();
757 /* The snapshot device should not be opened while we're running */
758 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
760 swsusp_close(FMODE_READ);
764 pm_prepare_console();
765 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
769 error = usermodehelper_disable();
773 error = create_basic_memory_bitmaps();
777 pr_debug("PM: Preparing processes for restore.\n");
778 error = prepare_processes();
780 swsusp_close(FMODE_READ);
784 pr_debug("PM: Loading hibernation image.\n");
786 error = swsusp_read(&flags);
787 swsusp_close(FMODE_READ);
789 hibernation_restore(flags & SF_PLATFORM_MODE);
791 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
795 free_basic_memory_bitmaps();
796 usermodehelper_enable();
798 pm_notifier_call_chain(PM_POST_RESTORE);
799 pm_restore_console();
800 atomic_inc(&snapshot_device_available);
801 /* For success case, the suspend path will release the lock */
803 mutex_unlock(&pm_mutex);
804 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
807 swsusp_close(FMODE_READ);
811 late_initcall(software_resume);
814 static const char * const hibernation_modes[] = {
815 [HIBERNATION_PLATFORM] = "platform",
816 [HIBERNATION_SHUTDOWN] = "shutdown",
817 [HIBERNATION_REBOOT] = "reboot",
818 [HIBERNATION_TEST] = "test",
819 [HIBERNATION_TESTPROC] = "testproc",
823 * disk - Control hibernation mode
825 * Suspend-to-disk can be handled in several ways. We have a few options
826 * for putting the system to sleep - using the platform driver (e.g. ACPI
827 * or other hibernation_ops), powering off the system or rebooting the
828 * system (for testing) as well as the two test modes.
830 * The system can support 'platform', and that is known a priori (and
831 * encoded by the presence of hibernation_ops). However, the user may
832 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
833 * test modes, 'test' or 'testproc'.
835 * show() will display what the mode is currently set to.
836 * store() will accept one of
844 * It will only change to 'platform' if the system
845 * supports it (as determined by having hibernation_ops).
848 static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
854 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
855 if (!hibernation_modes[i])
858 case HIBERNATION_SHUTDOWN:
859 case HIBERNATION_REBOOT:
860 case HIBERNATION_TEST:
861 case HIBERNATION_TESTPROC:
863 case HIBERNATION_PLATFORM:
866 /* not a valid mode, continue with loop */
869 if (i == hibernation_mode)
870 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
872 buf += sprintf(buf, "%s ", hibernation_modes[i]);
874 buf += sprintf(buf, "\n");
879 static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
880 const char *buf, size_t n)
886 int mode = HIBERNATION_INVALID;
888 p = memchr(buf, '\n', n);
889 len = p ? p - buf : n;
891 mutex_lock(&pm_mutex);
892 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
893 if (len == strlen(hibernation_modes[i])
894 && !strncmp(buf, hibernation_modes[i], len)) {
899 if (mode != HIBERNATION_INVALID) {
901 case HIBERNATION_SHUTDOWN:
902 case HIBERNATION_REBOOT:
903 case HIBERNATION_TEST:
904 case HIBERNATION_TESTPROC:
905 hibernation_mode = mode;
907 case HIBERNATION_PLATFORM:
909 hibernation_mode = mode;
917 pr_debug("PM: Hibernation mode set to '%s'\n",
918 hibernation_modes[mode]);
919 mutex_unlock(&pm_mutex);
920 return error ? error : n;
925 static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
928 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
929 MINOR(swsusp_resume_device));
932 static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
933 const char *buf, size_t n)
935 unsigned int maj, min;
939 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
942 res = MKDEV(maj,min);
943 if (maj != MAJOR(res) || min != MINOR(res))
946 mutex_lock(&pm_mutex);
947 swsusp_resume_device = res;
948 mutex_unlock(&pm_mutex);
949 printk(KERN_INFO "PM: Starting manual resume from disk\n");
959 static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
962 return sprintf(buf, "%lu\n", image_size);
965 static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
966 const char *buf, size_t n)
970 if (sscanf(buf, "%lu", &size) == 1) {
978 power_attr(image_size);
980 static ssize_t reserved_size_show(struct kobject *kobj,
981 struct kobj_attribute *attr, char *buf)
983 return sprintf(buf, "%lu\n", reserved_size);
986 static ssize_t reserved_size_store(struct kobject *kobj,
987 struct kobj_attribute *attr,
988 const char *buf, size_t n)
992 if (sscanf(buf, "%lu", &size) == 1) {
993 reserved_size = size;
1000 power_attr(reserved_size);
1002 static struct attribute * g[] = {
1005 &image_size_attr.attr,
1006 &reserved_size_attr.attr,
1011 static struct attribute_group attr_group = {
1016 static int __init pm_disk_init(void)
1018 return sysfs_create_group(power_kobj, &attr_group);
1021 core_initcall(pm_disk_init);
1024 static int __init resume_setup(char *str)
1029 strncpy( resume_file, str, 255 );
1033 static int __init resume_offset_setup(char *str)
1035 unsigned long long offset;
1040 if (sscanf(str, "%llu", &offset) == 1)
1041 swsusp_resume_block = offset;
1046 static int __init hibernate_setup(char *str)
1048 if (!strncmp(str, "noresume", 8))
1050 else if (!strncmp(str, "nocompress", 10))
1055 static int __init noresume_setup(char *str)
1061 __setup("noresume", noresume_setup);
1062 __setup("resume_offset=", resume_offset_setup);
1063 __setup("resume=", resume_setup);
1064 __setup("hibernate=", hibernate_setup);