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/delay.h>
19 #include <linux/mount.h>
21 #include <linux/console.h>
22 #include <linux/cpu.h>
23 #include <linux/freezer.h>
28 static int noresume = 0;
29 static char resume_file[256] = CONFIG_PM_STD_PARTITION;
30 dev_t swsusp_resume_device;
31 sector_t swsusp_resume_block;
41 __HIBERNATION_AFTER_LAST
43 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
44 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
46 static int hibernation_mode = HIBERNATION_SHUTDOWN;
48 static struct platform_hibernation_ops *hibernation_ops;
51 * hibernation_set_ops - set the global hibernate operations
52 * @ops: the hibernation operations to use in subsequent hibernation transitions
55 void hibernation_set_ops(struct platform_hibernation_ops *ops)
57 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
58 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
59 && ops->restore_cleanup)) {
63 mutex_lock(&pm_mutex);
64 hibernation_ops = ops;
66 hibernation_mode = HIBERNATION_PLATFORM;
67 else if (hibernation_mode == HIBERNATION_PLATFORM)
68 hibernation_mode = HIBERNATION_SHUTDOWN;
70 mutex_unlock(&pm_mutex);
73 #ifdef CONFIG_PM_DEBUG
74 static void hibernation_debug_sleep(void)
76 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
80 static int hibernation_testmode(int mode)
82 if (hibernation_mode == mode) {
83 hibernation_debug_sleep();
89 static int hibernation_test(int level)
91 if (pm_test_level == level) {
92 hibernation_debug_sleep();
97 #else /* !CONFIG_PM_DEBUG */
98 static int hibernation_testmode(int mode) { return 0; }
99 static int hibernation_test(int level) { return 0; }
100 #endif /* !CONFIG_PM_DEBUG */
103 * platform_begin - tell the platform driver that we're starting
107 static int platform_begin(int platform_mode)
109 return (platform_mode && hibernation_ops) ?
110 hibernation_ops->begin() : 0;
114 * platform_end - tell the platform driver that we've entered the
118 static void platform_end(int platform_mode)
120 if (platform_mode && hibernation_ops)
121 hibernation_ops->end();
125 * platform_pre_snapshot - prepare the machine for hibernation using the
126 * platform driver if so configured and return an error code if it fails
129 static int platform_pre_snapshot(int platform_mode)
131 return (platform_mode && hibernation_ops) ?
132 hibernation_ops->pre_snapshot() : 0;
136 * platform_leave - prepare the machine for switching to the normal mode
137 * of operation using the platform driver (called with interrupts disabled)
140 static void platform_leave(int platform_mode)
142 if (platform_mode && hibernation_ops)
143 hibernation_ops->leave();
147 * platform_finish - switch the machine to the normal mode of operation
148 * using the platform driver (must be called after platform_prepare())
151 static void platform_finish(int platform_mode)
153 if (platform_mode && hibernation_ops)
154 hibernation_ops->finish();
158 * platform_pre_restore - prepare the platform for the restoration from a
159 * hibernation image. If the restore fails after this function has been
160 * called, platform_restore_cleanup() must be called.
163 static int platform_pre_restore(int platform_mode)
165 return (platform_mode && hibernation_ops) ?
166 hibernation_ops->pre_restore() : 0;
170 * platform_restore_cleanup - switch the platform to the normal mode of
171 * operation after a failing restore. If platform_pre_restore() has been
172 * called before the failing restore, this function must be called too,
173 * regardless of the result of platform_pre_restore().
176 static void platform_restore_cleanup(int platform_mode)
178 if (platform_mode && hibernation_ops)
179 hibernation_ops->restore_cleanup();
183 * platform_recover - recover the platform from a failure to suspend
187 static void platform_recover(int platform_mode)
189 if (platform_mode && hibernation_ops && hibernation_ops->recover)
190 hibernation_ops->recover();
194 * create_image - freeze devices that need to be frozen with interrupts
195 * off, create the hibernation image and thaw those devices. Control
196 * reappears in this routine after a restore.
199 static int create_image(int platform_mode)
203 error = arch_prepare_suspend();
209 /* At this point, device_suspend() has been called, but *not*
210 * device_power_down(). We *must* call device_power_down() now.
211 * Otherwise, drivers for some devices (e.g. interrupt controllers)
212 * become desynchronized with the actual state of the hardware
213 * at resume time, and evil weirdness ensues.
215 error = device_power_down(PMSG_FREEZE);
217 printk(KERN_ERR "PM: Some devices failed to power down, "
218 "aborting hibernation\n");
222 if (hibernation_test(TEST_CORE))
226 save_processor_state();
227 error = swsusp_arch_suspend();
229 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
231 /* Restore control flow magically appears here */
232 restore_processor_state();
234 platform_leave(platform_mode);
236 /* NOTE: device_power_up() is just a resume() for devices
237 * that suspended with irqs off ... no overall powerup.
239 device_power_up(in_suspend ?
240 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
248 * hibernation_snapshot - quiesce devices and create the hibernation
250 * @platform_mode - if set, use the platform driver, if available, to
251 * prepare the platform frimware for the power transition.
253 * Must be called with pm_mutex held
256 int hibernation_snapshot(int platform_mode)
260 /* Free memory before shutting down devices. */
261 error = swsusp_shrink_memory();
265 error = platform_begin(platform_mode);
270 error = device_suspend(PMSG_FREEZE);
272 goto Recover_platform;
274 if (hibernation_test(TEST_DEVICES))
275 goto Recover_platform;
277 error = platform_pre_snapshot(platform_mode);
278 if (error || hibernation_test(TEST_PLATFORM))
281 error = disable_nonboot_cpus();
283 if (hibernation_test(TEST_CPUS))
286 if (hibernation_testmode(HIBERNATION_TEST))
289 error = create_image(platform_mode);
290 /* Control returns here after successful restore */
293 enable_nonboot_cpus();
295 platform_finish(platform_mode);
297 device_resume(in_suspend ?
298 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
301 platform_end(platform_mode);
305 platform_recover(platform_mode);
310 * resume_target_kernel - prepare devices that need to be suspended with
311 * interrupts off, restore the contents of highmem that have not been
312 * restored yet from the image and run the low level code that will restore
313 * the remaining contents of memory and switch to the just restored target
317 static int resume_target_kernel(void)
323 error = device_power_down(PMSG_QUIESCE);
325 printk(KERN_ERR "PM: Some devices failed to power down, "
326 "aborting resume\n");
329 /* We'll ignore saved state, but this gets preempt count (etc) right */
330 save_processor_state();
331 error = restore_highmem();
333 error = swsusp_arch_resume();
335 * The code below is only ever reached in case of a failure.
336 * Otherwise execution continues at place where
337 * swsusp_arch_suspend() was called
340 /* This call to restore_highmem() undos the previous one */
344 * The only reason why swsusp_arch_resume() can fail is memory being
345 * very tight, so we have to free it as soon as we can to avoid
346 * subsequent failures
349 restore_processor_state();
350 touch_softlockup_watchdog();
351 device_power_up(PMSG_RECOVER);
359 * hibernation_restore - quiesce devices and restore the hibernation
360 * snapshot image. If successful, control returns in hibernation_snaphot()
361 * @platform_mode - if set, use the platform driver, if available, to
362 * prepare the platform frimware for the transition.
364 * Must be called with pm_mutex held
367 int hibernation_restore(int platform_mode)
371 pm_prepare_console();
373 error = device_suspend(PMSG_QUIESCE);
377 error = platform_pre_restore(platform_mode);
379 error = disable_nonboot_cpus();
381 error = resume_target_kernel();
382 enable_nonboot_cpus();
384 platform_restore_cleanup(platform_mode);
385 device_resume(PMSG_RECOVER);
388 pm_restore_console();
393 * hibernation_platform_enter - enter the hibernation state using the
394 * platform driver (if available)
397 int hibernation_platform_enter(void)
401 if (!hibernation_ops)
405 * We have cancelled the power transition by running
406 * hibernation_ops->finish() before saving the image, so we should let
407 * the firmware know that we're going to enter the sleep state after all
409 error = hibernation_ops->begin();
414 error = device_suspend(PMSG_HIBERNATE);
416 if (hibernation_ops->recover)
417 hibernation_ops->recover();
421 error = hibernation_ops->prepare();
425 error = disable_nonboot_cpus();
431 error = device_power_down(PMSG_HIBERNATE);
433 hibernation_ops->enter();
434 /* We should never get here */
441 * We don't need to reenable the nonboot CPUs or resume consoles, since
442 * the system is going to be halted anyway.
445 hibernation_ops->finish();
447 device_resume(PMSG_RESTORE);
450 hibernation_ops->end();
455 * power_down - Shut the machine down for hibernation.
457 * Use the platform driver, if configured so; otherwise try
458 * to power off or reboot.
461 static void power_down(void)
463 switch (hibernation_mode) {
464 case HIBERNATION_TEST:
465 case HIBERNATION_TESTPROC:
467 case HIBERNATION_REBOOT:
468 kernel_restart(NULL);
470 case HIBERNATION_PLATFORM:
471 hibernation_platform_enter();
472 case HIBERNATION_SHUTDOWN:
478 * Valid image is on the disk, if we continue we risk serious data
479 * corruption after resume.
481 printk(KERN_CRIT "PM: Please power down manually\n");
485 static int prepare_processes(void)
489 if (freeze_processes()) {
497 * hibernate - The granpappy of the built-in hibernation management
504 mutex_lock(&pm_mutex);
505 /* The snapshot device should not be opened while we're running */
506 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
511 pm_prepare_console();
512 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
516 /* Allocate memory management structures */
517 error = create_basic_memory_bitmaps();
521 printk(KERN_INFO "PM: Syncing filesystems ... ");
525 error = prepare_processes();
529 if (hibernation_test(TEST_FREEZER))
532 if (hibernation_testmode(HIBERNATION_TESTPROC))
535 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
536 if (in_suspend && !error) {
537 unsigned int flags = 0;
539 if (hibernation_mode == HIBERNATION_PLATFORM)
540 flags |= SF_PLATFORM_MODE;
541 pr_debug("PM: writing image.\n");
542 error = swsusp_write(flags);
547 pr_debug("PM: Image restored successfully.\n");
553 free_basic_memory_bitmaps();
555 pm_notifier_call_chain(PM_POST_HIBERNATION);
556 pm_restore_console();
557 atomic_inc(&snapshot_device_available);
559 mutex_unlock(&pm_mutex);
565 * software_resume - Resume from a saved image.
567 * Called as a late_initcall (so all devices are discovered and
568 * initialized), we call swsusp to see if we have a saved image or not.
569 * If so, we quiesce devices, the restore the saved image. We will
570 * return above (in hibernate() ) if everything goes well.
571 * Otherwise, we fail gracefully and return to the normally
576 static int software_resume(void)
582 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
583 * is configured into the kernel. Since the regular hibernate
584 * trigger path is via sysfs which takes a buffer mutex before
585 * calling hibernate functions (which take pm_mutex) this can
586 * cause lockdep to complain about a possible ABBA deadlock
587 * which cannot happen since we're in the boot code here and
588 * sysfs can't be invoked yet. Therefore, we use a subclass
589 * here to avoid lockdep complaining.
591 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
592 if (!swsusp_resume_device) {
593 if (!strlen(resume_file)) {
594 mutex_unlock(&pm_mutex);
597 swsusp_resume_device = name_to_dev_t(resume_file);
598 pr_debug("PM: Resume from partition %s\n", resume_file);
600 pr_debug("PM: Resume from partition %d:%d\n",
601 MAJOR(swsusp_resume_device),
602 MINOR(swsusp_resume_device));
607 * FIXME: If noresume is specified, we need to find the
608 * partition and reset it back to normal swap space.
610 mutex_unlock(&pm_mutex);
614 pr_debug("PM: Checking hibernation image.\n");
615 error = swsusp_check();
619 /* The snapshot device should not be opened while we're running */
620 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
625 pm_prepare_console();
626 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
630 error = create_basic_memory_bitmaps();
634 pr_debug("PM: Preparing processes for restore.\n");
635 error = prepare_processes();
641 pr_debug("PM: Reading hibernation image.\n");
643 error = swsusp_read(&flags);
645 hibernation_restore(flags & SF_PLATFORM_MODE);
647 printk(KERN_ERR "PM: Restore failed, recovering.\n");
651 free_basic_memory_bitmaps();
653 pm_notifier_call_chain(PM_POST_RESTORE);
654 pm_restore_console();
655 atomic_inc(&snapshot_device_available);
656 /* For success case, the suspend path will release the lock */
658 mutex_unlock(&pm_mutex);
659 pr_debug("PM: Resume from disk failed.\n");
663 late_initcall(software_resume);
666 static const char * const hibernation_modes[] = {
667 [HIBERNATION_PLATFORM] = "platform",
668 [HIBERNATION_SHUTDOWN] = "shutdown",
669 [HIBERNATION_REBOOT] = "reboot",
670 [HIBERNATION_TEST] = "test",
671 [HIBERNATION_TESTPROC] = "testproc",
675 * disk - Control hibernation mode
677 * Suspend-to-disk can be handled in several ways. We have a few options
678 * for putting the system to sleep - using the platform driver (e.g. ACPI
679 * or other hibernation_ops), powering off the system or rebooting the
680 * system (for testing) as well as the two test modes.
682 * The system can support 'platform', and that is known a priori (and
683 * encoded by the presence of hibernation_ops). However, the user may
684 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
685 * test modes, 'test' or 'testproc'.
687 * show() will display what the mode is currently set to.
688 * store() will accept one of
696 * It will only change to 'platform' if the system
697 * supports it (as determined by having hibernation_ops).
700 static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
706 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
707 if (!hibernation_modes[i])
710 case HIBERNATION_SHUTDOWN:
711 case HIBERNATION_REBOOT:
712 case HIBERNATION_TEST:
713 case HIBERNATION_TESTPROC:
715 case HIBERNATION_PLATFORM:
718 /* not a valid mode, continue with loop */
721 if (i == hibernation_mode)
722 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
724 buf += sprintf(buf, "%s ", hibernation_modes[i]);
726 buf += sprintf(buf, "\n");
731 static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
732 const char *buf, size_t n)
738 int mode = HIBERNATION_INVALID;
740 p = memchr(buf, '\n', n);
741 len = p ? p - buf : n;
743 mutex_lock(&pm_mutex);
744 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
745 if (len == strlen(hibernation_modes[i])
746 && !strncmp(buf, hibernation_modes[i], len)) {
751 if (mode != HIBERNATION_INVALID) {
753 case HIBERNATION_SHUTDOWN:
754 case HIBERNATION_REBOOT:
755 case HIBERNATION_TEST:
756 case HIBERNATION_TESTPROC:
757 hibernation_mode = mode;
759 case HIBERNATION_PLATFORM:
761 hibernation_mode = mode;
769 pr_debug("PM: Hibernation mode set to '%s'\n",
770 hibernation_modes[mode]);
771 mutex_unlock(&pm_mutex);
772 return error ? error : n;
777 static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
780 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
781 MINOR(swsusp_resume_device));
784 static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
785 const char *buf, size_t n)
787 unsigned int maj, min;
791 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
794 res = MKDEV(maj,min);
795 if (maj != MAJOR(res) || min != MINOR(res))
798 mutex_lock(&pm_mutex);
799 swsusp_resume_device = res;
800 mutex_unlock(&pm_mutex);
801 printk(KERN_INFO "PM: Starting manual resume from disk\n");
811 static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
814 return sprintf(buf, "%lu\n", image_size);
817 static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
818 const char *buf, size_t n)
822 if (sscanf(buf, "%lu", &size) == 1) {
830 power_attr(image_size);
832 static struct attribute * g[] = {
835 &image_size_attr.attr,
840 static struct attribute_group attr_group = {
845 static int __init pm_disk_init(void)
847 return sysfs_create_group(power_kobj, &attr_group);
850 core_initcall(pm_disk_init);
853 static int __init resume_setup(char *str)
858 strncpy( resume_file, str, 255 );
862 static int __init resume_offset_setup(char *str)
864 unsigned long long offset;
869 if (sscanf(str, "%llu", &offset) == 1)
870 swsusp_resume_block = offset;
875 static int __init noresume_setup(char *str)
881 __setup("noresume", noresume_setup);
882 __setup("resume_offset=", resume_offset_setup);
883 __setup("resume=", resume_setup);