blob: 7f44e5c269712a96c582f177df5152c19603e996 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02002 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
Pavel Macheka2531292010-07-18 14:27:13 +02006 * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02007 * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
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>
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -070017#include <linux/kmod.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/delay.h>
19#include <linux/fs.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070020#include <linux/mount.h>
Eric W. Biederman88d10bb2005-09-22 21:43:46 -070021#include <linux/pm.h>
Rafael J. Wysocki97c78012006-10-11 01:20:45 -070022#include <linux/console.h>
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -070023#include <linux/cpu.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080024#include <linux/freezer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/gfp.h>
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +010026#include <linux/syscore_ops.h>
Rafael J. Wysockic7510852009-04-12 20:06:56 +020027#include <scsi/scsi_scan.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070028
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include "power.h"
30
31
Bojan Smojverf996fc92010-09-09 23:06:23 +020032static int nocompress = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033static int noresume = 0;
Adrian Bunk47a460d2008-02-04 22:30:06 -080034static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080036sector_t swsusp_resume_block;
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +010037int in_suspend __nosavedata = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070039enum {
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
52static int hibernation_mode = HIBERNATION_SHUTDOWN;
53
Lionel Debroux073ef1f2010-11-09 21:48:49 +010054static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070055
56/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020057 * hibernation_set_ops - Set the global hibernate operations.
58 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070059 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010060void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070061{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010062 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
63 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010064 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070065 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
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010078static bool entering_platform_hibernation;
79
80bool system_entering_hibernation(void)
81{
82 return entering_platform_hibernation;
83}
84EXPORT_SYMBOL(system_entering_hibernation);
85
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010086#ifdef CONFIG_PM_DEBUG
87static void hibernation_debug_sleep(void)
88{
89 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
90 mdelay(5000);
91}
92
93static int hibernation_testmode(int mode)
94{
95 if (hibernation_mode == mode) {
96 hibernation_debug_sleep();
97 return 1;
98 }
99 return 0;
100}
101
102static 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 */
111static int hibernation_testmode(int mode) { return 0; }
112static int hibernation_test(int level) { return 0; }
113#endif /* !CONFIG_PM_DEBUG */
114
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700115/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200116 * platform_begin - Call platform to start hibernation.
117 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700118 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100119static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700120{
121 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100122 hibernation_ops->begin() : 0;
123}
124
125/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200126 * platform_end - Call platform to finish transition to the working state.
127 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100128 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100129static void platform_end(int platform_mode)
130{
131 if (platform_mode && hibernation_ops)
132 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700133}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200136 * 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.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800141 */
142
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700143static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800144{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700145 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700146 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800147}
148
149/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200150 * 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.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700157 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700158static void platform_leave(int platform_mode)
159{
160 if (platform_mode && hibernation_ops)
161 hibernation_ops->leave();
162}
163
164/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200165 * 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().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700172 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700173static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700174{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700175 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700176 hibernation_ops->finish();
177}
178
179/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200180 * 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.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700188 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700189static int platform_pre_restore(int platform_mode)
190{
191 return (platform_mode && hibernation_ops) ?
192 hibernation_ops->pre_restore() : 0;
193}
194
195/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200196 * 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().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700205 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700206static void platform_restore_cleanup(int platform_mode)
207{
208 if (platform_mode && hibernation_ops)
209 hibernation_ops->restore_cleanup();
210}
211
212/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200213 * platform_recover - Recover from a failure to suspend devices.
214 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200215 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200216static void platform_recover(int platform_mode)
217{
218 if (platform_mode && hibernation_ops && hibernation_ops->recover)
219 hibernation_ops->recover();
220}
221
222/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200223 * 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.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100228 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100229void 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/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200251 * 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.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700258 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800259static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700260{
261 int error;
262
Alan Sternd1616302009-05-24 22:05:42 +0200263 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700264 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100265 printk(KERN_ERR "PM: Some devices failed to power down, "
266 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200267 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700268 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100269
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100270 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
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100279 local_irq_disable();
280
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200281 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100282 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200283 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100284 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100285 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100286 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700287
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100288 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100289 goto Power_up;
290
291 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700292 save_processor_state();
293 error = swsusp_arch_suspend();
294 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100295 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
296 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700297 /* Restore control flow magically appears here */
298 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200299 if (!in_suspend) {
300 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700301 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200302 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100303
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100304 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100305 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100306
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100307 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100308 local_irq_enable();
309
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100310 Enable_cpus:
311 enable_nonboot_cpus();
312
313 Platform_finish:
314 platform_finish(platform_mode);
315
Alan Sternd1616302009-05-24 22:05:42 +0200316 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200317 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100318
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700319 return error;
320}
321
322/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200323 * hibernation_snapshot - Quiesce devices and create a hibernation image.
324 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700325 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200326 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700327 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700328int hibernation_snapshot(int platform_mode)
329{
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200330 pm_message_t msg = PMSG_RECOVER;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100331 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700332
Zhang Rui3fe03132008-10-26 20:50:26 +0100333 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700334 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200335 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700336
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200337 /* Preallocate image memory before shutting down devices. */
338 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700339 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200340 goto Close;
341
342 error = freeze_kernel_threads();
343 if (error)
344 goto Close;
345
346 error = dpm_prepare(PMSG_FREEZE);
347 if (error)
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200348 goto Complete_devices;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700349
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700350 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100351 pm_restrict_gfp_mask();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200352 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700353 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200354 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700355
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100356 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200357 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700358
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100359 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100360 /*
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 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100364
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100365 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200366 /* We may need to release the preallocated image pages here. */
367 if (error || !in_suspend)
368 swsusp_free();
369
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200370 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
371 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100372
373 if (error || !in_suspend)
374 pm_restore_gfp_mask();
375
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700376 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200377
378 Complete_devices:
379 dpm_complete(msg);
380
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100381 Close:
382 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700383 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200384
385 Recover_platform:
386 platform_recover(platform_mode);
387 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700388}
389
390/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200391 * 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.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100398 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100399static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100400{
401 int error;
402
Alan Sternd1616302009-05-24 22:05:42 +0200403 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100404 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100405 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100406 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200407 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100408 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100409
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100410 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
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100418 local_irq_disable();
419
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200420 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100421 if (error)
422 goto Enable_irqs;
423
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100424 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.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200430 * Otherwise, execution continues at the place where
431 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100432 */
433 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200434 /*
435 * This call to restore_highmem() reverts the changes made by
436 * the previous one.
437 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100438 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
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200443 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100444 */
445 swsusp_free();
446 restore_processor_state();
447 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100448
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100449 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100450
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100451 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100452 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100453
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100454 Enable_cpus:
455 enable_nonboot_cpus();
456
457 Cleanup:
458 platform_restore_cleanup(platform_mode);
459
Alan Sternd1616302009-05-24 22:05:42 +0200460 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100461
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100462 return error;
463}
464
465/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200466 * hibernation_restore - Quiesce devices and restore from a hibernation image.
467 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700468 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200469 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200470 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700471 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700472int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700473{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100474 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700475
476 pm_prepare_console();
477 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100478 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200479 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700480 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100481 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200482 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700483 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100484 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700485 resume_console();
486 pm_restore_console();
487 return error;
488}
489
490/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200491 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700492 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700493int hibernation_platform_enter(void)
494{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100495 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700496
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700497 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 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100505 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700506 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100507 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700508
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100509 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700510 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200511 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200512 if (error) {
513 if (hibernation_ops->recover)
514 hibernation_ops->recover();
515 goto Resume_devices;
516 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700517
Alan Sternd1616302009-05-24 22:05:42 +0200518 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100519 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200520 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100521
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100522 error = hibernation_ops->prepare();
523 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200524 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100525
526 error = disable_nonboot_cpus();
527 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200528 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100529
530 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100531 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100532 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200533 error = -EAGAIN;
534 goto Power_up;
535 }
536
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100537 hibernation_ops->enter();
538 /* We should never get here */
539 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700540
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200541 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100542 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200543 local_irq_enable();
544 enable_nonboot_cpus();
545
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200546 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700547 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100548
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200549 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100550
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700551 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100552 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200553 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700554 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100555
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100556 Close:
557 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100558
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700559 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700560}
561
562/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200563 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200565 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 */
Johannes Bergfe0c9352007-04-30 15:09:51 -0700569static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700571 switch (hibernation_mode) {
572 case HIBERNATION_TEST:
573 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700574 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700575 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600576 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700578 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700579 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700580 case HIBERNATION_SHUTDOWN:
581 kernel_power_off();
582 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600584 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700585 /*
586 * Valid image is on the disk, if we continue we risk serious data
587 * corruption after resume.
588 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100589 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 while(1);
591}
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593static int prepare_processes(void)
594{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800595 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 if (freeze_processes()) {
598 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100599 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700601 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602}
603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200605 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700607int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608{
609 int error;
610
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700611 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700612 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700613 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
614 error = -EBUSY;
615 goto Unlock;
616 }
617
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100618 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700619 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
620 if (error)
621 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700622
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700623 error = usermodehelper_disable();
624 if (error)
625 goto Exit;
626
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700627 /* Allocate memory management structures */
628 error = create_basic_memory_bitmaps();
629 if (error)
630 goto Exit;
631
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100632 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700633 sys_sync();
634 printk("done.\n");
635
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700637 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700638 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100640 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800641 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100642
643 if (hibernation_testmode(HIBERNATION_TESTPROC))
644 goto Thaw;
645
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700646 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200647 if (error)
648 goto Thaw;
649
650 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700651 unsigned int flags = 0;
652
653 if (hibernation_mode == HIBERNATION_PLATFORM)
654 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200655 if (nocompress)
656 flags |= SF_NOCOMPRESS_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700658 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700659 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700661 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100662 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100663 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800664 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800666 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200667
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800668 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100669 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700670 Finish:
671 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700672 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700673 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700674 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100675 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700676 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700677 Unlock:
678 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 return error;
680}
681
682
683/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200684 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200686 * This routine is called as a late initcall, when all devices have been
687 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200689 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698static int software_resume(void)
699{
700 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700701 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Johannes Berg60a0d232007-11-14 17:00:16 -0800703 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100704 * If the user said "noresume".. bail out early.
705 */
706 if (noresume)
707 return 0;
708
709 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800710 * 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);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200720
721 if (swsusp_resume_device)
722 goto Check_image;
723
724 if (!strlen(resume_file)) {
725 error = -ENOENT;
726 goto Unlock;
727 }
728
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200729 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200730
731 /* Check if the device is there */
732 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700733 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100734 /*
735 * Some device discovery might still be in progress; we need
736 * to wait for this to finish.
737 */
738 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200739 /*
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
Pavel Machek3efa1472005-07-07 17:56:43 -0700746 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200747 if (!swsusp_resume_device) {
748 error = -ENODEV;
749 goto Unlock;
750 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700751 }
752
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200753 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200754 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200755 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200757 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800758 error = swsusp_check();
759 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700760 goto Unlock;
761
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700762 /* The snapshot device should not be opened while we're running */
763 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
764 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200765 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700766 goto Unlock;
767 }
768
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100769 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100770 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
771 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200772 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100773
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700774 error = usermodehelper_disable();
775 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200776 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700777
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700778 error = create_basic_memory_bitmaps();
779 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200780 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
782 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800783 error = prepare_processes();
784 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400785 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700786 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 }
788
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200789 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700791 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200792 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800793 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700794 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200796 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700797 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100798 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700800 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700801 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700802 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100803 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100804 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700805 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700806 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700807 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800808 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200809 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700810 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200811close_finish:
812 swsusp_close(FMODE_READ);
813 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814}
815
816late_initcall(software_resume);
817
818
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700819static 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",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825};
826
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200827/*
828 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200830 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200835 * 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:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 * 'platform'
840 * 'shutdown'
841 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700842 * 'test'
843 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200845 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 */
854
Kay Sievers386f2752007-11-02 13:47:53 +0100855static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
856 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700858 int i;
859 char *start = buf;
860
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700861 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
862 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700863 continue;
864 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700865 case HIBERNATION_SHUTDOWN:
866 case HIBERNATION_REBOOT:
867 case HIBERNATION_TEST:
868 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700869 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700870 case HIBERNATION_PLATFORM:
871 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700872 break;
873 /* not a valid mode, continue with loop */
874 continue;
875 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700876 if (i == hibernation_mode)
877 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700878 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700879 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700880 }
881 buf += sprintf(buf, "\n");
882 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883}
884
Kay Sievers386f2752007-11-02 13:47:53 +0100885static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
886 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887{
888 int error = 0;
889 int i;
890 int len;
891 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700892 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
894 p = memchr(buf, '\n', n);
895 len = p ? p - buf : n;
896
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800897 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700898 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700899 if (len == strlen(hibernation_modes[i])
900 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 mode = i;
902 break;
903 }
904 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700905 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700906 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700907 case HIBERNATION_SHUTDOWN:
908 case HIBERNATION_REBOOT:
909 case HIBERNATION_TEST:
910 case HIBERNATION_TESTPROC:
911 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700912 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700913 case HIBERNATION_PLATFORM:
914 if (hibernation_ops)
915 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 else
917 error = -EINVAL;
918 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700919 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 error = -EINVAL;
921
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700922 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100923 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700924 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800925 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 return error ? error : n;
927}
928
929power_attr(disk);
930
Kay Sievers386f2752007-11-02 13:47:53 +0100931static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
932 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933{
934 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
935 MINOR(swsusp_resume_device));
936}
937
Kay Sievers386f2752007-11-02 13:47:53 +0100938static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
939 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800943 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
Andrew Mortona5762192006-01-06 00:09:50 -0800945 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
946 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
Andrew Mortona5762192006-01-06 00:09:50 -0800948 res = MKDEV(maj,min);
949 if (maj != MAJOR(res) || min != MINOR(res))
950 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800952 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800953 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800954 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100955 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800956 noresume = 0;
957 software_resume();
958 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800959 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800960 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961}
962
963power_attr(resume);
964
Kay Sievers386f2752007-11-02 13:47:53 +0100965static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
966 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800967{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800968 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800969}
970
Kay Sievers386f2752007-11-02 13:47:53 +0100971static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
972 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800973{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800974 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800975
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800976 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800977 image_size = size;
978 return n;
979 }
980
981 return -EINVAL;
982}
983
984power_attr(image_size);
985
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +0200986static 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
992static 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
1006power_attr(reserved_size);
1007
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008static struct attribute * g[] = {
1009 &disk_attr.attr,
1010 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001011 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001012 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 NULL,
1014};
1015
1016
1017static struct attribute_group attr_group = {
1018 .attrs = g,
1019};
1020
1021
1022static int __init pm_disk_init(void)
1023{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001024 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025}
1026
1027core_initcall(pm_disk_init);
1028
1029
1030static 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
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001039static 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
Bojan Smojverf996fc92010-09-09 23:06:23 +02001052static 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
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061static int __init noresume_setup(char *str)
1062{
1063 noresume = 1;
1064 return 1;
1065}
1066
1067__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001068__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001070__setup("hibernate=", hibernate_setup);