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@suse.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 <scsi/scsi_scan.h>
27 #include <asm/suspend.h>
32 static int noresume
= 0;
33 static char resume_file
[256] = CONFIG_PM_STD_PARTITION
;
34 dev_t swsusp_resume_device
;
35 sector_t swsusp_resume_block
;
36 int in_suspend __nosavedata
= 0;
46 __HIBERNATION_AFTER_LAST
48 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
49 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
51 static int hibernation_mode
= HIBERNATION_SHUTDOWN
;
53 static struct platform_hibernation_ops
*hibernation_ops
;
56 * hibernation_set_ops - set the global hibernate operations
57 * @ops: the hibernation operations to use in subsequent hibernation transitions
60 void hibernation_set_ops(struct platform_hibernation_ops
*ops
)
62 if (ops
&& !(ops
->begin
&& ops
->end
&& ops
->pre_snapshot
63 && ops
->prepare
&& ops
->finish
&& ops
->enter
&& ops
->pre_restore
64 && ops
->restore_cleanup
)) {
68 mutex_lock(&pm_mutex
);
69 hibernation_ops
= ops
;
71 hibernation_mode
= HIBERNATION_PLATFORM
;
72 else if (hibernation_mode
== HIBERNATION_PLATFORM
)
73 hibernation_mode
= HIBERNATION_SHUTDOWN
;
75 mutex_unlock(&pm_mutex
);
78 static bool entering_platform_hibernation
;
80 bool system_entering_hibernation(void)
82 return entering_platform_hibernation
;
84 EXPORT_SYMBOL(system_entering_hibernation
);
86 #ifdef CONFIG_PM_DEBUG
87 static void hibernation_debug_sleep(void)
89 printk(KERN_INFO
"hibernation debug: Waiting for 5 seconds.\n");
93 static int hibernation_testmode(int mode
)
95 if (hibernation_mode
== mode
) {
96 hibernation_debug_sleep();
102 static int hibernation_test(int level
)
104 if (pm_test_level
== level
) {
105 hibernation_debug_sleep();
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 */
116 * platform_begin - tell the platform driver that we're starting
120 static int platform_begin(int platform_mode
)
122 return (platform_mode
&& hibernation_ops
) ?
123 hibernation_ops
->begin() : 0;
127 * platform_end - tell the platform driver that we've entered the
131 static void platform_end(int platform_mode
)
133 if (platform_mode
&& hibernation_ops
)
134 hibernation_ops
->end();
138 * platform_pre_snapshot - prepare the machine for hibernation using the
139 * platform driver if so configured and return an error code if it fails
142 static int platform_pre_snapshot(int platform_mode
)
144 return (platform_mode
&& hibernation_ops
) ?
145 hibernation_ops
->pre_snapshot() : 0;
149 * platform_leave - prepare the machine for switching to the normal mode
150 * of operation using the platform driver (called with interrupts disabled)
153 static void platform_leave(int platform_mode
)
155 if (platform_mode
&& hibernation_ops
)
156 hibernation_ops
->leave();
160 * platform_finish - switch the machine to the normal mode of operation
161 * using the platform driver (must be called after platform_prepare())
164 static void platform_finish(int platform_mode
)
166 if (platform_mode
&& hibernation_ops
)
167 hibernation_ops
->finish();
171 * platform_pre_restore - prepare the platform for the restoration from a
172 * hibernation image. If the restore fails after this function has been
173 * called, platform_restore_cleanup() must be called.
176 static int platform_pre_restore(int platform_mode
)
178 return (platform_mode
&& hibernation_ops
) ?
179 hibernation_ops
->pre_restore() : 0;
183 * platform_restore_cleanup - switch the platform to the normal mode of
184 * operation after a failing restore. If platform_pre_restore() has been
185 * called before the failing restore, this function must be called too,
186 * regardless of the result of platform_pre_restore().
189 static void platform_restore_cleanup(int platform_mode
)
191 if (platform_mode
&& hibernation_ops
)
192 hibernation_ops
->restore_cleanup();
196 * platform_recover - recover the platform from a failure to suspend
200 static void platform_recover(int platform_mode
)
202 if (platform_mode
&& hibernation_ops
&& hibernation_ops
->recover
)
203 hibernation_ops
->recover();
207 * swsusp_show_speed - print the time elapsed between two events.
208 * @start: Starting event.
209 * @stop: Final event.
210 * @nr_pages - number of pages processed between @start and @stop
211 * @msg - introductory message to print
214 void swsusp_show_speed(struct timeval
*start
, struct timeval
*stop
,
215 unsigned nr_pages
, char *msg
)
217 s64 elapsed_centisecs64
;
222 elapsed_centisecs64
= timeval_to_ns(stop
) - timeval_to_ns(start
);
223 do_div(elapsed_centisecs64
, NSEC_PER_SEC
/ 100);
224 centisecs
= elapsed_centisecs64
;
226 centisecs
= 1; /* avoid div-by-zero */
227 k
= nr_pages
* (PAGE_SIZE
/ 1024);
228 kps
= (k
* 100) / centisecs
;
229 printk(KERN_INFO
"PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
231 centisecs
/ 100, centisecs
% 100,
232 kps
/ 1000, (kps
% 1000) / 10);
236 * create_image - freeze devices that need to be frozen with interrupts
237 * off, create the hibernation image and thaw those devices. Control
238 * reappears in this routine after a restore.
241 static int create_image(int platform_mode
)
245 error
= arch_prepare_suspend();
249 /* At this point, dpm_suspend_start() has been called, but *not*
250 * dpm_suspend_noirq(). We *must* call dpm_suspend_noirq() now.
251 * Otherwise, drivers for some devices (e.g. interrupt controllers)
252 * become desynchronized with the actual state of the hardware
253 * at resume time, and evil weirdness ensues.
255 error
= dpm_suspend_noirq(PMSG_FREEZE
);
257 printk(KERN_ERR
"PM: Some devices failed to power down, "
258 "aborting hibernation\n");
262 error
= platform_pre_snapshot(platform_mode
);
263 if (error
|| hibernation_test(TEST_PLATFORM
))
264 goto Platform_finish
;
266 error
= disable_nonboot_cpus();
267 if (error
|| hibernation_test(TEST_CPUS
)
268 || hibernation_testmode(HIBERNATION_TEST
))
273 error
= sysdev_suspend(PMSG_FREEZE
);
275 printk(KERN_ERR
"PM: Some system devices failed to power down, "
276 "aborting hibernation\n");
280 if (hibernation_test(TEST_CORE
))
284 save_processor_state();
285 error
= swsusp_arch_suspend();
287 printk(KERN_ERR
"PM: Error %d creating hibernation image\n",
289 /* Restore control flow magically appears here */
290 restore_processor_state();
292 platform_leave(platform_mode
);
296 /* NOTE: dpm_resume_noirq() is just a resume() for devices
297 * that suspended with irqs off ... no overall powerup.
304 enable_nonboot_cpus();
307 platform_finish(platform_mode
);
309 dpm_resume_noirq(in_suspend
?
310 (error
? PMSG_RECOVER
: PMSG_THAW
) : PMSG_RESTORE
);
316 * hibernation_snapshot - quiesce devices and create the hibernation
318 * @platform_mode - if set, use the platform driver, if available, to
319 * prepare the platform firmware for the power transition.
321 * Must be called with pm_mutex held
324 int hibernation_snapshot(int platform_mode
)
329 error
= platform_begin(platform_mode
);
333 /* Preallocate image memory before shutting down devices. */
334 error
= hibernate_preallocate_memory();
339 saved_mask
= clear_gfp_allowed_mask(GFP_IOFS
);
340 error
= dpm_suspend_start(PMSG_FREEZE
);
342 goto Recover_platform
;
344 if (hibernation_test(TEST_DEVICES
))
345 goto Recover_platform
;
347 error
= create_image(platform_mode
);
348 /* Control returns here after successful restore */
351 /* We may need to release the preallocated image pages here. */
352 if (error
|| !in_suspend
)
355 dpm_resume_end(in_suspend
?
356 (error
? PMSG_RECOVER
: PMSG_THAW
) : PMSG_RESTORE
);
357 set_gfp_allowed_mask(saved_mask
);
360 platform_end(platform_mode
);
364 platform_recover(platform_mode
);
369 * resume_target_kernel - prepare devices that need to be suspended with
370 * interrupts off, restore the contents of highmem that have not been
371 * restored yet from the image and run the low level code that will restore
372 * the remaining contents of memory and switch to the just restored target
376 static int resume_target_kernel(bool platform_mode
)
380 error
= dpm_suspend_noirq(PMSG_QUIESCE
);
382 printk(KERN_ERR
"PM: Some devices failed to power down, "
383 "aborting resume\n");
387 error
= platform_pre_restore(platform_mode
);
391 error
= disable_nonboot_cpus();
397 error
= sysdev_suspend(PMSG_QUIESCE
);
401 /* We'll ignore saved state, but this gets preempt count (etc) right */
402 save_processor_state();
403 error
= restore_highmem();
405 error
= swsusp_arch_resume();
407 * The code below is only ever reached in case of a failure.
408 * Otherwise execution continues at place where
409 * swsusp_arch_suspend() was called
412 /* This call to restore_highmem() undos the previous one */
416 * The only reason why swsusp_arch_resume() can fail is memory being
417 * very tight, so we have to free it as soon as we can to avoid
418 * subsequent failures
421 restore_processor_state();
422 touch_softlockup_watchdog();
430 enable_nonboot_cpus();
433 platform_restore_cleanup(platform_mode
);
435 dpm_resume_noirq(PMSG_RECOVER
);
441 * hibernation_restore - quiesce devices and restore the hibernation
442 * snapshot image. If successful, control returns in hibernation_snaphot()
443 * @platform_mode - if set, use the platform driver, if available, to
444 * prepare the platform firmware for the transition.
446 * Must be called with pm_mutex held
449 int hibernation_restore(int platform_mode
)
454 pm_prepare_console();
456 saved_mask
= clear_gfp_allowed_mask(GFP_IOFS
);
457 error
= dpm_suspend_start(PMSG_QUIESCE
);
459 error
= resume_target_kernel(platform_mode
);
460 dpm_resume_end(PMSG_RECOVER
);
462 set_gfp_allowed_mask(saved_mask
);
464 pm_restore_console();
469 * hibernation_platform_enter - enter the hibernation state using the
470 * platform driver (if available)
473 int hibernation_platform_enter(void)
478 if (!hibernation_ops
)
482 * We have cancelled the power transition by running
483 * hibernation_ops->finish() before saving the image, so we should let
484 * the firmware know that we're going to enter the sleep state after all
486 error
= hibernation_ops
->begin();
490 entering_platform_hibernation
= true;
492 saved_mask
= clear_gfp_allowed_mask(GFP_IOFS
);
493 error
= dpm_suspend_start(PMSG_HIBERNATE
);
495 if (hibernation_ops
->recover
)
496 hibernation_ops
->recover();
500 error
= dpm_suspend_noirq(PMSG_HIBERNATE
);
504 error
= hibernation_ops
->prepare();
506 goto Platform_finish
;
508 error
= disable_nonboot_cpus();
510 goto Platform_finish
;
513 sysdev_suspend(PMSG_HIBERNATE
);
514 hibernation_ops
->enter();
515 /* We should never get here */
519 * We don't need to reenable the nonboot CPUs or resume consoles, since
520 * the system is going to be halted anyway.
523 hibernation_ops
->finish();
525 dpm_suspend_noirq(PMSG_RESTORE
);
528 entering_platform_hibernation
= false;
529 dpm_resume_end(PMSG_RESTORE
);
530 set_gfp_allowed_mask(saved_mask
);
534 hibernation_ops
->end();
540 * power_down - Shut the machine down for hibernation.
542 * Use the platform driver, if configured so; otherwise try
543 * to power off or reboot.
546 static void power_down(void)
548 switch (hibernation_mode
) {
549 case HIBERNATION_TEST
:
550 case HIBERNATION_TESTPROC
:
552 case HIBERNATION_REBOOT
:
553 kernel_restart(NULL
);
555 case HIBERNATION_PLATFORM
:
556 hibernation_platform_enter();
557 case HIBERNATION_SHUTDOWN
:
563 * Valid image is on the disk, if we continue we risk serious data
564 * corruption after resume.
566 printk(KERN_CRIT
"PM: Please power down manually\n");
570 static int prepare_processes(void)
574 if (freeze_processes()) {
582 * hibernate - The granpappy of the built-in hibernation management
589 mutex_lock(&pm_mutex
);
590 /* The snapshot device should not be opened while we're running */
591 if (!atomic_add_unless(&snapshot_device_available
, -1, 0)) {
596 pm_prepare_console();
597 error
= pm_notifier_call_chain(PM_HIBERNATION_PREPARE
);
601 error
= usermodehelper_disable();
605 /* Allocate memory management structures */
606 error
= create_basic_memory_bitmaps();
610 printk(KERN_INFO
"PM: Syncing filesystems ... ");
614 error
= prepare_processes();
618 if (hibernation_test(TEST_FREEZER
))
621 if (hibernation_testmode(HIBERNATION_TESTPROC
))
624 error
= hibernation_snapshot(hibernation_mode
== HIBERNATION_PLATFORM
);
629 unsigned int flags
= 0;
631 if (hibernation_mode
== HIBERNATION_PLATFORM
)
632 flags
|= SF_PLATFORM_MODE
;
633 pr_debug("PM: writing image.\n");
634 error
= swsusp_write(flags
);
639 pr_debug("PM: Image restored successfully.\n");
645 free_basic_memory_bitmaps();
646 usermodehelper_enable();
648 pm_notifier_call_chain(PM_POST_HIBERNATION
);
649 pm_restore_console();
650 atomic_inc(&snapshot_device_available
);
652 mutex_unlock(&pm_mutex
);
658 * software_resume - Resume from a saved image.
660 * Called as a late_initcall (so all devices are discovered and
661 * initialized), we call swsusp to see if we have a saved image or not.
662 * If so, we quiesce devices, the restore the saved image. We will
663 * return above (in hibernate() ) if everything goes well.
664 * Otherwise, we fail gracefully and return to the normally
669 static int software_resume(void)
675 * If the user said "noresume".. bail out early.
681 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
682 * is configured into the kernel. Since the regular hibernate
683 * trigger path is via sysfs which takes a buffer mutex before
684 * calling hibernate functions (which take pm_mutex) this can
685 * cause lockdep to complain about a possible ABBA deadlock
686 * which cannot happen since we're in the boot code here and
687 * sysfs can't be invoked yet. Therefore, we use a subclass
688 * here to avoid lockdep complaining.
690 mutex_lock_nested(&pm_mutex
, SINGLE_DEPTH_NESTING
);
692 if (swsusp_resume_device
)
695 if (!strlen(resume_file
)) {
700 pr_debug("PM: Checking image partition %s\n", resume_file
);
702 /* Check if the device is there */
703 swsusp_resume_device
= name_to_dev_t(resume_file
);
704 if (!swsusp_resume_device
) {
706 * Some device discovery might still be in progress; we need
707 * to wait for this to finish.
709 wait_for_device_probe();
711 * We can't depend on SCSI devices being available after loading
712 * one of their modules until scsi_complete_async_scans() is
713 * called and the resume device usually is a SCSI one.
715 scsi_complete_async_scans();
717 swsusp_resume_device
= name_to_dev_t(resume_file
);
718 if (!swsusp_resume_device
) {
725 pr_debug("PM: Resume from partition %d:%d\n",
726 MAJOR(swsusp_resume_device
), MINOR(swsusp_resume_device
));
728 pr_debug("PM: Checking hibernation image.\n");
729 error
= swsusp_check();
733 /* The snapshot device should not be opened while we're running */
734 if (!atomic_add_unless(&snapshot_device_available
, -1, 0)) {
736 swsusp_close(FMODE_READ
);
740 pm_prepare_console();
741 error
= pm_notifier_call_chain(PM_RESTORE_PREPARE
);
745 error
= usermodehelper_disable();
749 error
= create_basic_memory_bitmaps();
753 pr_debug("PM: Preparing processes for restore.\n");
754 error
= prepare_processes();
756 swsusp_close(FMODE_READ
);
760 pr_debug("PM: Reading hibernation image.\n");
762 error
= swsusp_read(&flags
);
763 swsusp_close(FMODE_READ
);
765 hibernation_restore(flags
& SF_PLATFORM_MODE
);
767 printk(KERN_ERR
"PM: Restore failed, recovering.\n");
771 free_basic_memory_bitmaps();
772 usermodehelper_enable();
774 pm_notifier_call_chain(PM_POST_RESTORE
);
775 pm_restore_console();
776 atomic_inc(&snapshot_device_available
);
777 /* For success case, the suspend path will release the lock */
779 mutex_unlock(&pm_mutex
);
780 pr_debug("PM: Resume from disk failed.\n");
783 swsusp_close(FMODE_READ
);
787 late_initcall(software_resume
);
790 static const char * const hibernation_modes
[] = {
791 [HIBERNATION_PLATFORM
] = "platform",
792 [HIBERNATION_SHUTDOWN
] = "shutdown",
793 [HIBERNATION_REBOOT
] = "reboot",
794 [HIBERNATION_TEST
] = "test",
795 [HIBERNATION_TESTPROC
] = "testproc",
799 * disk - Control hibernation mode
801 * Suspend-to-disk can be handled in several ways. We have a few options
802 * for putting the system to sleep - using the platform driver (e.g. ACPI
803 * or other hibernation_ops), powering off the system or rebooting the
804 * system (for testing) as well as the two test modes.
806 * The system can support 'platform', and that is known a priori (and
807 * encoded by the presence of hibernation_ops). However, the user may
808 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
809 * test modes, 'test' or 'testproc'.
811 * show() will display what the mode is currently set to.
812 * store() will accept one of
820 * It will only change to 'platform' if the system
821 * supports it (as determined by having hibernation_ops).
824 static ssize_t
disk_show(struct kobject
*kobj
, struct kobj_attribute
*attr
,
830 for (i
= HIBERNATION_FIRST
; i
<= HIBERNATION_MAX
; i
++) {
831 if (!hibernation_modes
[i
])
834 case HIBERNATION_SHUTDOWN
:
835 case HIBERNATION_REBOOT
:
836 case HIBERNATION_TEST
:
837 case HIBERNATION_TESTPROC
:
839 case HIBERNATION_PLATFORM
:
842 /* not a valid mode, continue with loop */
845 if (i
== hibernation_mode
)
846 buf
+= sprintf(buf
, "[%s] ", hibernation_modes
[i
]);
848 buf
+= sprintf(buf
, "%s ", hibernation_modes
[i
]);
850 buf
+= sprintf(buf
, "\n");
855 static ssize_t
disk_store(struct kobject
*kobj
, struct kobj_attribute
*attr
,
856 const char *buf
, size_t n
)
862 int mode
= HIBERNATION_INVALID
;
864 p
= memchr(buf
, '\n', n
);
865 len
= p
? p
- buf
: n
;
867 mutex_lock(&pm_mutex
);
868 for (i
= HIBERNATION_FIRST
; i
<= HIBERNATION_MAX
; i
++) {
869 if (len
== strlen(hibernation_modes
[i
])
870 && !strncmp(buf
, hibernation_modes
[i
], len
)) {
875 if (mode
!= HIBERNATION_INVALID
) {
877 case HIBERNATION_SHUTDOWN
:
878 case HIBERNATION_REBOOT
:
879 case HIBERNATION_TEST
:
880 case HIBERNATION_TESTPROC
:
881 hibernation_mode
= mode
;
883 case HIBERNATION_PLATFORM
:
885 hibernation_mode
= mode
;
893 pr_debug("PM: Hibernation mode set to '%s'\n",
894 hibernation_modes
[mode
]);
895 mutex_unlock(&pm_mutex
);
896 return error
? error
: n
;
901 static ssize_t
resume_show(struct kobject
*kobj
, struct kobj_attribute
*attr
,
904 return sprintf(buf
,"%d:%d\n", MAJOR(swsusp_resume_device
),
905 MINOR(swsusp_resume_device
));
908 static ssize_t
resume_store(struct kobject
*kobj
, struct kobj_attribute
*attr
,
909 const char *buf
, size_t n
)
911 unsigned int maj
, min
;
915 if (sscanf(buf
, "%u:%u", &maj
, &min
) != 2)
918 res
= MKDEV(maj
,min
);
919 if (maj
!= MAJOR(res
) || min
!= MINOR(res
))
922 mutex_lock(&pm_mutex
);
923 swsusp_resume_device
= res
;
924 mutex_unlock(&pm_mutex
);
925 printk(KERN_INFO
"PM: Starting manual resume from disk\n");
935 static ssize_t
image_size_show(struct kobject
*kobj
, struct kobj_attribute
*attr
,
938 return sprintf(buf
, "%lu\n", image_size
);
941 static ssize_t
image_size_store(struct kobject
*kobj
, struct kobj_attribute
*attr
,
942 const char *buf
, size_t n
)
946 if (sscanf(buf
, "%lu", &size
) == 1) {
954 power_attr(image_size
);
956 static struct attribute
* g
[] = {
959 &image_size_attr
.attr
,
964 static struct attribute_group attr_group
= {
969 static int __init
pm_disk_init(void)
971 return sysfs_create_group(power_kobj
, &attr_group
);
974 core_initcall(pm_disk_init
);
977 static int __init
resume_setup(char *str
)
982 strncpy( resume_file
, str
, 255 );
986 static int __init
resume_offset_setup(char *str
)
988 unsigned long long offset
;
993 if (sscanf(str
, "%llu", &offset
) == 1)
994 swsusp_resume_block
= offset
;
999 static int __init
noresume_setup(char *str
)
1005 __setup("noresume", noresume_setup
);
1006 __setup("resume_offset=", resume_offset_setup
);
1007 __setup("resume=", resume_setup
);