blob: 8f7b1db1ece1b3273f9eebbc128d7c884390c638 [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. Wysocki91e7c752011-05-17 23:26:00 +0200337 error = dpm_prepare(PMSG_FREEZE);
338 if (error)
339 goto Complete_devices;
340
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200341 /* Preallocate image memory before shutting down devices. */
342 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700343 if (error)
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200344 goto Complete_devices;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700345
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700346 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100347 pm_restrict_gfp_mask();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200348 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700349 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200350 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700351
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100352 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200353 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700354
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100355 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100356 /*
357 * Control returns here (1) after the image has been created or the
358 * image creation has failed and (2) after a successful restore.
359 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100360
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100361 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200362 /* We may need to release the preallocated image pages here. */
363 if (error || !in_suspend)
364 swsusp_free();
365
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200366 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
367 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100368
369 if (error || !in_suspend)
370 pm_restore_gfp_mask();
371
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700372 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200373
374 Complete_devices:
375 dpm_complete(msg);
376
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100377 Close:
378 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700379 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200380
381 Recover_platform:
382 platform_recover(platform_mode);
383 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700384}
385
386/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200387 * resume_target_kernel - Restore system state from a hibernation image.
388 * @platform_mode: Whether or not to use the platform driver.
389 *
390 * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
391 * highmem that have not been restored yet from the image and run the low-level
392 * code that will restore the remaining contents of memory and switch to the
393 * just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100394 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100395static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100396{
397 int error;
398
Alan Sternd1616302009-05-24 22:05:42 +0200399 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100400 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100401 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100402 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200403 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100404 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100405
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100406 error = platform_pre_restore(platform_mode);
407 if (error)
408 goto Cleanup;
409
410 error = disable_nonboot_cpus();
411 if (error)
412 goto Enable_cpus;
413
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100414 local_irq_disable();
415
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200416 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100417 if (error)
418 goto Enable_irqs;
419
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100420 save_processor_state();
421 error = restore_highmem();
422 if (!error) {
423 error = swsusp_arch_resume();
424 /*
425 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200426 * Otherwise, execution continues at the place where
427 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100428 */
429 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200430 /*
431 * This call to restore_highmem() reverts the changes made by
432 * the previous one.
433 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100434 restore_highmem();
435 }
436 /*
437 * The only reason why swsusp_arch_resume() can fail is memory being
438 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200439 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100440 */
441 swsusp_free();
442 restore_processor_state();
443 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100444
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100445 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100446
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100447 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100448 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100449
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100450 Enable_cpus:
451 enable_nonboot_cpus();
452
453 Cleanup:
454 platform_restore_cleanup(platform_mode);
455
Alan Sternd1616302009-05-24 22:05:42 +0200456 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100457
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100458 return error;
459}
460
461/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200462 * hibernation_restore - Quiesce devices and restore from a hibernation image.
463 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700464 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200465 * This routine must be called with pm_mutex held. If it is successful, control
466 * reappears in the restored target kernel in hibernation_snaphot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700467 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700468int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700469{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100470 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700471
472 pm_prepare_console();
473 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100474 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200475 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700476 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100477 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200478 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700479 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100480 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700481 resume_console();
482 pm_restore_console();
483 return error;
484}
485
486/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200487 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700488 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700489int hibernation_platform_enter(void)
490{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100491 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700492
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700493 if (!hibernation_ops)
494 return -ENOSYS;
495
496 /*
497 * We have cancelled the power transition by running
498 * hibernation_ops->finish() before saving the image, so we should let
499 * the firmware know that we're going to enter the sleep state after all
500 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100501 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700502 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100503 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700504
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100505 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700506 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200507 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200508 if (error) {
509 if (hibernation_ops->recover)
510 hibernation_ops->recover();
511 goto Resume_devices;
512 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700513
Alan Sternd1616302009-05-24 22:05:42 +0200514 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100515 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200516 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100517
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100518 error = hibernation_ops->prepare();
519 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200520 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100521
522 error = disable_nonboot_cpus();
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 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100527 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100528 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200529 error = -EAGAIN;
530 goto Power_up;
531 }
532
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100533 hibernation_ops->enter();
534 /* We should never get here */
535 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700536
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200537 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100538 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200539 local_irq_enable();
540 enable_nonboot_cpus();
541
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200542 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700543 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100544
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200545 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100546
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700547 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100548 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200549 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700550 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100551
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100552 Close:
553 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100554
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700555 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700556}
557
558/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200559 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200561 * Use the platform driver, if configured, to put the system into the sleep
562 * state corresponding to hibernation, or try to power it off or reboot,
563 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 */
Johannes Bergfe0c9352007-04-30 15:09:51 -0700565static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700567 switch (hibernation_mode) {
568 case HIBERNATION_TEST:
569 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700570 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700571 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600572 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700574 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700575 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700576 case HIBERNATION_SHUTDOWN:
577 kernel_power_off();
578 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600580 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700581 /*
582 * Valid image is on the disk, if we continue we risk serious data
583 * corruption after resume.
584 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100585 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 while(1);
587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589static int prepare_processes(void)
590{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800591 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 if (freeze_processes()) {
594 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100595 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700597 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598}
599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200601 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700603int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604{
605 int error;
606
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700607 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700608 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700609 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
610 error = -EBUSY;
611 goto Unlock;
612 }
613
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100614 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700615 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
616 if (error)
617 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700618
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700619 error = usermodehelper_disable();
620 if (error)
621 goto Exit;
622
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700623 /* Allocate memory management structures */
624 error = create_basic_memory_bitmaps();
625 if (error)
626 goto Exit;
627
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100628 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700629 sys_sync();
630 printk("done.\n");
631
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700633 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700634 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100636 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800637 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100638
639 if (hibernation_testmode(HIBERNATION_TESTPROC))
640 goto Thaw;
641
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700642 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200643 if (error)
644 goto Thaw;
645
646 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700647 unsigned int flags = 0;
648
649 if (hibernation_mode == HIBERNATION_PLATFORM)
650 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200651 if (nocompress)
652 flags |= SF_NOCOMPRESS_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700654 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700655 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700657 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100658 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100659 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800660 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800662 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200663
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800664 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100665 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700666 Finish:
667 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700668 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700669 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700670 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100671 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700672 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700673 Unlock:
674 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 return error;
676}
677
678
679/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200680 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200682 * This routine is called as a late initcall, when all devices have been
683 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200685 * The image reading code is called to see if there is a hibernation image
686 * available for reading. If that is the case, devices are quiesced and the
687 * contents of memory is restored from the saved image.
688 *
689 * If this is successful, control reappears in the restored target kernel in
690 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
691 * attempts to recover gracefully and make the kernel return to the normal mode
692 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694static int software_resume(void)
695{
696 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700697 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Johannes Berg60a0d232007-11-14 17:00:16 -0800699 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100700 * If the user said "noresume".. bail out early.
701 */
702 if (noresume)
703 return 0;
704
705 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800706 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
707 * is configured into the kernel. Since the regular hibernate
708 * trigger path is via sysfs which takes a buffer mutex before
709 * calling hibernate functions (which take pm_mutex) this can
710 * cause lockdep to complain about a possible ABBA deadlock
711 * which cannot happen since we're in the boot code here and
712 * sysfs can't be invoked yet. Therefore, we use a subclass
713 * here to avoid lockdep complaining.
714 */
715 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200716
717 if (swsusp_resume_device)
718 goto Check_image;
719
720 if (!strlen(resume_file)) {
721 error = -ENOENT;
722 goto Unlock;
723 }
724
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200725 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200726
727 /* Check if the device is there */
728 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700729 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100730 /*
731 * Some device discovery might still be in progress; we need
732 * to wait for this to finish.
733 */
734 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200735 /*
736 * We can't depend on SCSI devices being available after loading
737 * one of their modules until scsi_complete_async_scans() is
738 * called and the resume device usually is a SCSI one.
739 */
740 scsi_complete_async_scans();
741
Pavel Machek3efa1472005-07-07 17:56:43 -0700742 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200743 if (!swsusp_resume_device) {
744 error = -ENODEV;
745 goto Unlock;
746 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700747 }
748
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200749 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200750 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200751 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200753 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800754 error = swsusp_check();
755 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700756 goto Unlock;
757
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700758 /* The snapshot device should not be opened while we're running */
759 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
760 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200761 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700762 goto Unlock;
763 }
764
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100765 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100766 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
767 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200768 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100769
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700770 error = usermodehelper_disable();
771 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200772 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700773
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700774 error = create_basic_memory_bitmaps();
775 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200776 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
778 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800779 error = prepare_processes();
780 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400781 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700782 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 }
784
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200785 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700787 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200788 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800789 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700790 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200792 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700793 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100794 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700796 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700797 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700798 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100799 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100800 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700801 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700802 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700803 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800804 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200805 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700806 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200807close_finish:
808 swsusp_close(FMODE_READ);
809 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810}
811
812late_initcall(software_resume);
813
814
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700815static const char * const hibernation_modes[] = {
816 [HIBERNATION_PLATFORM] = "platform",
817 [HIBERNATION_SHUTDOWN] = "shutdown",
818 [HIBERNATION_REBOOT] = "reboot",
819 [HIBERNATION_TEST] = "test",
820 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821};
822
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200823/*
824 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200826 * Hibernation can be handled in several ways. There are a few different ways
827 * to put the system into the sleep state: using the platform driver (e.g. ACPI
828 * or other hibernation_ops), powering it off or rebooting it (for testing
829 * mostly), or using one of the two available test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200831 * The sysfs file /sys/power/disk provides an interface for selecting the
832 * hibernation mode to use. Reading from this file causes the available modes
833 * to be printed. There are 5 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 * 'platform'
836 * 'shutdown'
837 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700838 * 'test'
839 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200841 * If a platform hibernation driver is in use, 'platform' will be supported
842 * and will be used by default. Otherwise, 'shutdown' will be used by default.
843 * The selected option (i.e. the one corresponding to the current value of
844 * hibernation_mode) is enclosed by a square bracket.
845 *
846 * To select a given hibernation mode it is necessary to write the mode's
847 * string representation (as returned by reading from /sys/power/disk) back
848 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 */
850
Kay Sievers386f2752007-11-02 13:47:53 +0100851static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
852 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700854 int i;
855 char *start = buf;
856
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700857 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
858 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700859 continue;
860 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700861 case HIBERNATION_SHUTDOWN:
862 case HIBERNATION_REBOOT:
863 case HIBERNATION_TEST:
864 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700865 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700866 case HIBERNATION_PLATFORM:
867 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700868 break;
869 /* not a valid mode, continue with loop */
870 continue;
871 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700872 if (i == hibernation_mode)
873 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700874 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700875 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700876 }
877 buf += sprintf(buf, "\n");
878 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879}
880
Kay Sievers386f2752007-11-02 13:47:53 +0100881static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
882 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883{
884 int error = 0;
885 int i;
886 int len;
887 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700888 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
890 p = memchr(buf, '\n', n);
891 len = p ? p - buf : n;
892
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800893 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700894 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700895 if (len == strlen(hibernation_modes[i])
896 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 mode = i;
898 break;
899 }
900 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700901 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700902 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700903 case HIBERNATION_SHUTDOWN:
904 case HIBERNATION_REBOOT:
905 case HIBERNATION_TEST:
906 case HIBERNATION_TESTPROC:
907 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700908 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700909 case HIBERNATION_PLATFORM:
910 if (hibernation_ops)
911 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 else
913 error = -EINVAL;
914 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700915 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 error = -EINVAL;
917
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700918 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100919 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700920 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800921 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 return error ? error : n;
923}
924
925power_attr(disk);
926
Kay Sievers386f2752007-11-02 13:47:53 +0100927static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
928 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929{
930 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
931 MINOR(swsusp_resume_device));
932}
933
Kay Sievers386f2752007-11-02 13:47:53 +0100934static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
935 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800939 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Andrew Mortona5762192006-01-06 00:09:50 -0800941 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
942 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
Andrew Mortona5762192006-01-06 00:09:50 -0800944 res = MKDEV(maj,min);
945 if (maj != MAJOR(res) || min != MINOR(res))
946 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800948 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800949 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800950 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100951 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800952 noresume = 0;
953 software_resume();
954 ret = n;
Rafael J. Wysocki59a49332006-12-06 20:34:44 -0800955 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800956 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957}
958
959power_attr(resume);
960
Kay Sievers386f2752007-11-02 13:47:53 +0100961static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
962 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800963{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800964 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800965}
966
Kay Sievers386f2752007-11-02 13:47:53 +0100967static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
968 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800969{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800970 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800971
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800972 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800973 image_size = size;
974 return n;
975 }
976
977 return -EINVAL;
978}
979
980power_attr(image_size);
981
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +0200982static ssize_t reserved_size_show(struct kobject *kobj,
983 struct kobj_attribute *attr, char *buf)
984{
985 return sprintf(buf, "%lu\n", reserved_size);
986}
987
988static ssize_t reserved_size_store(struct kobject *kobj,
989 struct kobj_attribute *attr,
990 const char *buf, size_t n)
991{
992 unsigned long size;
993
994 if (sscanf(buf, "%lu", &size) == 1) {
995 reserved_size = size;
996 return n;
997 }
998
999 return -EINVAL;
1000}
1001
1002power_attr(reserved_size);
1003
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004static struct attribute * g[] = {
1005 &disk_attr.attr,
1006 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001007 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001008 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 NULL,
1010};
1011
1012
1013static struct attribute_group attr_group = {
1014 .attrs = g,
1015};
1016
1017
1018static int __init pm_disk_init(void)
1019{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001020 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021}
1022
1023core_initcall(pm_disk_init);
1024
1025
1026static int __init resume_setup(char *str)
1027{
1028 if (noresume)
1029 return 1;
1030
1031 strncpy( resume_file, str, 255 );
1032 return 1;
1033}
1034
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001035static int __init resume_offset_setup(char *str)
1036{
1037 unsigned long long offset;
1038
1039 if (noresume)
1040 return 1;
1041
1042 if (sscanf(str, "%llu", &offset) == 1)
1043 swsusp_resume_block = offset;
1044
1045 return 1;
1046}
1047
Bojan Smojverf996fc92010-09-09 23:06:23 +02001048static int __init hibernate_setup(char *str)
1049{
1050 if (!strncmp(str, "noresume", 8))
1051 noresume = 1;
1052 else if (!strncmp(str, "nocompress", 10))
1053 nocompress = 1;
1054 return 1;
1055}
1056
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057static int __init noresume_setup(char *str)
1058{
1059 noresume = 1;
1060 return 1;
1061}
1062
1063__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001064__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001066__setup("hibernate=", hibernate_setup);