2 * kernel/power/disk.c - 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@suse.cz>
8 * 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>
29 static int noresume = 0;
30 static char resume_file[256] = CONFIG_PM_STD_PARTITION;
31 dev_t swsusp_resume_device;
32 sector_t swsusp_resume_block;
42 __HIBERNATION_AFTER_LAST
44 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
45 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
47 static int hibernation_mode = HIBERNATION_SHUTDOWN;
49 static struct platform_hibernation_ops *hibernation_ops;
52 * hibernation_set_ops - set the global hibernate operations
53 * @ops: the hibernation operations to use in subsequent hibernation transitions
56 void hibernation_set_ops(struct platform_hibernation_ops *ops)
58 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
59 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
60 && ops->restore_cleanup)) {
64 mutex_lock(&pm_mutex);
65 hibernation_ops = ops;
67 hibernation_mode = HIBERNATION_PLATFORM;
68 else if (hibernation_mode == HIBERNATION_PLATFORM)
69 hibernation_mode = HIBERNATION_SHUTDOWN;
71 mutex_unlock(&pm_mutex);
74 static bool entering_platform_hibernation;
76 bool system_entering_hibernation(void)
78 return entering_platform_hibernation;
80 EXPORT_SYMBOL(system_entering_hibernation);
82 #ifdef CONFIG_PM_DEBUG
83 static void hibernation_debug_sleep(void)
85 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
89 static int hibernation_testmode(int mode)
91 if (hibernation_mode == mode) {
92 hibernation_debug_sleep();
98 static int hibernation_test(int level)
100 if (pm_test_level == level) {
101 hibernation_debug_sleep();
106 #else /* !CONFIG_PM_DEBUG */
107 static int hibernation_testmode(int mode) { return 0; }
108 static int hibernation_test(int level) { return 0; }
109 #endif /* !CONFIG_PM_DEBUG */
112 * platform_begin - tell the platform driver that we're starting
116 static int platform_begin(int platform_mode)
118 return (platform_mode && hibernation_ops) ?
119 hibernation_ops->begin() : 0;
123 * platform_end - tell the platform driver that we've entered the
127 static void platform_end(int platform_mode)
129 if (platform_mode && hibernation_ops)
130 hibernation_ops->end();
134 * platform_pre_snapshot - prepare the machine for hibernation using the
135 * platform driver if so configured and return an error code if it fails
138 static int platform_pre_snapshot(int platform_mode)
140 return (platform_mode && hibernation_ops) ?
141 hibernation_ops->pre_snapshot() : 0;
145 * platform_leave - prepare the machine for switching to the normal mode
146 * of operation using the platform driver (called with interrupts disabled)
149 static void platform_leave(int platform_mode)
151 if (platform_mode && hibernation_ops)
152 hibernation_ops->leave();
156 * platform_finish - switch the machine to the normal mode of operation
157 * using the platform driver (must be called after platform_prepare())
160 static void platform_finish(int platform_mode)
162 if (platform_mode && hibernation_ops)
163 hibernation_ops->finish();
167 * platform_pre_restore - prepare the platform for the restoration from a
168 * hibernation image. If the restore fails after this function has been
169 * called, platform_restore_cleanup() must be called.
172 static int platform_pre_restore(int platform_mode)
174 return (platform_mode && hibernation_ops) ?
175 hibernation_ops->pre_restore() : 0;
179 * platform_restore_cleanup - switch the platform to the normal mode of
180 * operation after a failing restore. If platform_pre_restore() has been
181 * called before the failing restore, this function must be called too,
182 * regardless of the result of platform_pre_restore().
185 static void platform_restore_cleanup(int platform_mode)
187 if (platform_mode && hibernation_ops)
188 hibernation_ops->restore_cleanup();
192 * platform_recover - recover the platform from a failure to suspend
196 static void platform_recover(int platform_mode)
198 if (platform_mode && hibernation_ops && hibernation_ops->recover)
199 hibernation_ops->recover();
203 * create_image - freeze devices that need to be frozen with interrupts
204 * off, create the hibernation image and thaw those devices. Control
205 * reappears in this routine after a restore.
208 static int create_image(int platform_mode)
212 error = arch_prepare_suspend();
218 /* At this point, device_suspend() has been called, but *not*
219 * device_power_down(). We *must* call device_power_down() now.
220 * Otherwise, drivers for some devices (e.g. interrupt controllers)
221 * become desynchronized with the actual state of the hardware
222 * at resume time, and evil weirdness ensues.
224 error = device_power_down(PMSG_FREEZE);
226 printk(KERN_ERR "PM: Some devices failed to power down, "
227 "aborting hibernation\n");
231 error = platform_pre_snapshot(platform_mode);
232 if (error || hibernation_test(TEST_PLATFORM))
233 goto Platform_finish;
235 error = disable_nonboot_cpus();
236 if (error || hibernation_test(TEST_CPUS)
237 || hibernation_testmode(HIBERNATION_TEST))
242 sysdev_suspend(PMSG_FREEZE);
244 printk(KERN_ERR "PM: Some devices failed to power down, "
245 "aborting hibernation\n");
249 if (hibernation_test(TEST_CORE))
253 save_processor_state();
254 error = swsusp_arch_suspend();
256 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
258 /* Restore control flow magically appears here */
259 restore_processor_state();
261 platform_leave(platform_mode);
265 /* NOTE: device_power_up() is just a resume() for devices
266 * that suspended with irqs off ... no overall powerup.
273 enable_nonboot_cpus();
276 platform_finish(platform_mode);
278 device_power_up(in_suspend ?
279 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
288 * hibernation_snapshot - quiesce devices and create the hibernation
290 * @platform_mode - if set, use the platform driver, if available, to
291 * prepare the platform frimware for the power transition.
293 * Must be called with pm_mutex held
296 int hibernation_snapshot(int platform_mode)
300 error = platform_begin(platform_mode);
304 /* Free memory before shutting down devices. */
305 error = swsusp_shrink_memory();
310 error = device_suspend(PMSG_FREEZE);
312 goto Recover_platform;
314 if (hibernation_test(TEST_DEVICES))
315 goto Recover_platform;
317 error = create_image(platform_mode);
318 /* Control returns here after successful restore */
321 device_resume(in_suspend ?
322 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
325 platform_end(platform_mode);
329 platform_recover(platform_mode);
334 * resume_target_kernel - prepare devices that need to be suspended with
335 * interrupts off, restore the contents of highmem that have not been
336 * restored yet from the image and run the low level code that will restore
337 * the remaining contents of memory and switch to the just restored target
341 static int resume_target_kernel(bool platform_mode)
347 error = device_power_down(PMSG_QUIESCE);
349 printk(KERN_ERR "PM: Some devices failed to power down, "
350 "aborting resume\n");
354 error = platform_pre_restore(platform_mode);
358 error = disable_nonboot_cpus();
364 error = sysdev_suspend(PMSG_QUIESCE);
368 /* We'll ignore saved state, but this gets preempt count (etc) right */
369 save_processor_state();
370 error = restore_highmem();
372 error = swsusp_arch_resume();
374 * The code below is only ever reached in case of a failure.
375 * Otherwise execution continues at place where
376 * swsusp_arch_suspend() was called
379 /* This call to restore_highmem() undos the previous one */
383 * The only reason why swsusp_arch_resume() can fail is memory being
384 * very tight, so we have to free it as soon as we can to avoid
385 * subsequent failures
388 restore_processor_state();
389 touch_softlockup_watchdog();
397 enable_nonboot_cpus();
400 platform_restore_cleanup(platform_mode);
402 device_power_up(PMSG_RECOVER);
411 * hibernation_restore - quiesce devices and restore the hibernation
412 * snapshot image. If successful, control returns in hibernation_snaphot()
413 * @platform_mode - if set, use the platform driver, if available, to
414 * prepare the platform frimware for the transition.
416 * Must be called with pm_mutex held
419 int hibernation_restore(int platform_mode)
423 pm_prepare_console();
425 error = device_suspend(PMSG_QUIESCE);
427 error = resume_target_kernel(platform_mode);
428 device_resume(PMSG_RECOVER);
431 pm_restore_console();
436 * hibernation_platform_enter - enter the hibernation state using the
437 * platform driver (if available)
440 int hibernation_platform_enter(void)
444 if (!hibernation_ops)
448 * We have cancelled the power transition by running
449 * hibernation_ops->finish() before saving the image, so we should let
450 * the firmware know that we're going to enter the sleep state after all
452 error = hibernation_ops->begin();
456 entering_platform_hibernation = true;
458 error = device_suspend(PMSG_HIBERNATE);
460 if (hibernation_ops->recover)
461 hibernation_ops->recover();
467 error = device_power_down(PMSG_HIBERNATE);
471 error = hibernation_ops->prepare();
473 goto Platofrm_finish;
475 error = disable_nonboot_cpus();
477 goto Platofrm_finish;
480 sysdev_suspend(PMSG_HIBERNATE);
481 hibernation_ops->enter();
482 /* We should never get here */
486 * We don't need to reenable the nonboot CPUs or resume consoles, since
487 * the system is going to be halted anyway.
490 hibernation_ops->finish();
492 device_power_up(PMSG_RESTORE);
498 entering_platform_hibernation = false;
499 device_resume(PMSG_RESTORE);
503 hibernation_ops->end();
509 * power_down - Shut the machine down for hibernation.
511 * Use the platform driver, if configured so; otherwise try
512 * to power off or reboot.
515 static void power_down(void)
517 switch (hibernation_mode) {
518 case HIBERNATION_TEST:
519 case HIBERNATION_TESTPROC:
521 case HIBERNATION_REBOOT:
522 kernel_restart(NULL);
524 case HIBERNATION_PLATFORM:
525 hibernation_platform_enter();
526 case HIBERNATION_SHUTDOWN:
532 * Valid image is on the disk, if we continue we risk serious data
533 * corruption after resume.
535 printk(KERN_CRIT "PM: Please power down manually\n");
539 static int prepare_processes(void)
543 if (freeze_processes()) {
551 * hibernate - The granpappy of the built-in hibernation management
558 mutex_lock(&pm_mutex);
559 /* The snapshot device should not be opened while we're running */
560 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
565 pm_prepare_console();
566 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
570 error = usermodehelper_disable();
574 /* Allocate memory management structures */
575 error = create_basic_memory_bitmaps();
579 printk(KERN_INFO "PM: Syncing filesystems ... ");
583 error = prepare_processes();
587 if (hibernation_test(TEST_FREEZER))
590 if (hibernation_testmode(HIBERNATION_TESTPROC))
593 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
594 if (in_suspend && !error) {
595 unsigned int flags = 0;
597 if (hibernation_mode == HIBERNATION_PLATFORM)
598 flags |= SF_PLATFORM_MODE;
599 pr_debug("PM: writing image.\n");
600 error = swsusp_write(flags);
605 pr_debug("PM: Image restored successfully.\n");
611 free_basic_memory_bitmaps();
612 usermodehelper_enable();
614 pm_notifier_call_chain(PM_POST_HIBERNATION);
615 pm_restore_console();
616 atomic_inc(&snapshot_device_available);
618 mutex_unlock(&pm_mutex);
624 * software_resume - Resume from a saved image.
626 * Called as a late_initcall (so all devices are discovered and
627 * initialized), we call swsusp to see if we have a saved image or not.
628 * If so, we quiesce devices, the restore the saved image. We will
629 * return above (in hibernate() ) if everything goes well.
630 * Otherwise, we fail gracefully and return to the normally
635 static int software_resume(void)
641 * If the user said "noresume".. bail out early.
647 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
648 * is configured into the kernel. Since the regular hibernate
649 * trigger path is via sysfs which takes a buffer mutex before
650 * calling hibernate functions (which take pm_mutex) this can
651 * cause lockdep to complain about a possible ABBA deadlock
652 * which cannot happen since we're in the boot code here and
653 * sysfs can't be invoked yet. Therefore, we use a subclass
654 * here to avoid lockdep complaining.
656 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
657 if (!swsusp_resume_device) {
658 if (!strlen(resume_file)) {
659 mutex_unlock(&pm_mutex);
663 * Some device discovery might still be in progress; we need
664 * to wait for this to finish.
666 wait_for_device_probe();
667 swsusp_resume_device = name_to_dev_t(resume_file);
668 pr_debug("PM: Resume from partition %s\n", resume_file);
670 pr_debug("PM: Resume from partition %d:%d\n",
671 MAJOR(swsusp_resume_device),
672 MINOR(swsusp_resume_device));
677 * FIXME: If noresume is specified, we need to find the
678 * partition and reset it back to normal swap space.
680 mutex_unlock(&pm_mutex);
684 pr_debug("PM: Checking hibernation image.\n");
685 error = swsusp_check();
689 /* The snapshot device should not be opened while we're running */
690 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
695 pm_prepare_console();
696 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
700 error = usermodehelper_disable();
704 error = create_basic_memory_bitmaps();
708 pr_debug("PM: Preparing processes for restore.\n");
709 error = prepare_processes();
711 swsusp_close(FMODE_READ);
715 pr_debug("PM: Reading hibernation image.\n");
717 error = swsusp_read(&flags);
719 hibernation_restore(flags & SF_PLATFORM_MODE);
721 printk(KERN_ERR "PM: Restore failed, recovering.\n");
725 free_basic_memory_bitmaps();
726 usermodehelper_enable();
728 pm_notifier_call_chain(PM_POST_RESTORE);
729 pm_restore_console();
730 atomic_inc(&snapshot_device_available);
731 /* For success case, the suspend path will release the lock */
733 mutex_unlock(&pm_mutex);
734 pr_debug("PM: Resume from disk failed.\n");
738 late_initcall(software_resume);
741 static const char * const hibernation_modes[] = {
742 [HIBERNATION_PLATFORM] = "platform",
743 [HIBERNATION_SHUTDOWN] = "shutdown",
744 [HIBERNATION_REBOOT] = "reboot",
745 [HIBERNATION_TEST] = "test",
746 [HIBERNATION_TESTPROC] = "testproc",
750 * disk - Control hibernation mode
752 * Suspend-to-disk can be handled in several ways. We have a few options
753 * for putting the system to sleep - using the platform driver (e.g. ACPI
754 * or other hibernation_ops), powering off the system or rebooting the
755 * system (for testing) as well as the two test modes.
757 * The system can support 'platform', and that is known a priori (and
758 * encoded by the presence of hibernation_ops). However, the user may
759 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
760 * test modes, 'test' or 'testproc'.
762 * show() will display what the mode is currently set to.
763 * store() will accept one of
771 * It will only change to 'platform' if the system
772 * supports it (as determined by having hibernation_ops).
775 static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
781 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
782 if (!hibernation_modes[i])
785 case HIBERNATION_SHUTDOWN:
786 case HIBERNATION_REBOOT:
787 case HIBERNATION_TEST:
788 case HIBERNATION_TESTPROC:
790 case HIBERNATION_PLATFORM:
793 /* not a valid mode, continue with loop */
796 if (i == hibernation_mode)
797 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
799 buf += sprintf(buf, "%s ", hibernation_modes[i]);
801 buf += sprintf(buf, "\n");
806 static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
807 const char *buf, size_t n)
813 int mode = HIBERNATION_INVALID;
815 p = memchr(buf, '\n', n);
816 len = p ? p - buf : n;
818 mutex_lock(&pm_mutex);
819 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
820 if (len == strlen(hibernation_modes[i])
821 && !strncmp(buf, hibernation_modes[i], len)) {
826 if (mode != HIBERNATION_INVALID) {
828 case HIBERNATION_SHUTDOWN:
829 case HIBERNATION_REBOOT:
830 case HIBERNATION_TEST:
831 case HIBERNATION_TESTPROC:
832 hibernation_mode = mode;
834 case HIBERNATION_PLATFORM:
836 hibernation_mode = mode;
844 pr_debug("PM: Hibernation mode set to '%s'\n",
845 hibernation_modes[mode]);
846 mutex_unlock(&pm_mutex);
847 return error ? error : n;
852 static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
855 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
856 MINOR(swsusp_resume_device));
859 static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
860 const char *buf, size_t n)
862 unsigned int maj, min;
866 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
869 res = MKDEV(maj,min);
870 if (maj != MAJOR(res) || min != MINOR(res))
873 mutex_lock(&pm_mutex);
874 swsusp_resume_device = res;
875 mutex_unlock(&pm_mutex);
876 printk(KERN_INFO "PM: Starting manual resume from disk\n");
886 static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
889 return sprintf(buf, "%lu\n", image_size);
892 static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
893 const char *buf, size_t n)
897 if (sscanf(buf, "%lu", &size) == 1) {
905 power_attr(image_size);
907 static struct attribute * g[] = {
910 &image_size_attr.attr,
915 static struct attribute_group attr_group = {
920 static int __init pm_disk_init(void)
922 return sysfs_create_group(power_kobj, &attr_group);
925 core_initcall(pm_disk_init);
928 static int __init resume_setup(char *str)
933 strncpy( resume_file, str, 255 );
937 static int __init resume_offset_setup(char *str)
939 unsigned long long offset;
944 if (sscanf(str, "%llu", &offset) == 1)
945 swsusp_resume_block = offset;
950 static int __init noresume_setup(char *str)
956 __setup("noresume", noresume_setup);
957 __setup("resume_offset=", resume_offset_setup);
958 __setup("resume=", resume_setup);