blob: 1c53f7fad5f7ba9e4fd20cd85e5021755c71ada8 [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>
Barry Song6f8d7022011-10-06 20:34:46 +020017#include <linux/async.h>
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -070018#include <linux/kmod.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/delay.h>
20#include <linux/fs.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070021#include <linux/mount.h>
Eric W. Biederman88d10bb2005-09-22 21:43:46 -070022#include <linux/pm.h>
Rafael J. Wysocki97c78012006-10-11 01:20:45 -070023#include <linux/console.h>
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -070024#include <linux/cpu.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080025#include <linux/freezer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090026#include <linux/gfp.h>
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +010027#include <linux/syscore_ops.h>
Rafael J. Wysockic7510852009-04-12 20:06:56 +020028#include <scsi/scsi_scan.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include "power.h"
31
32
Barry Songd231ff12011-10-11 23:29:18 -070033static int nocompress;
34static int noresume;
35static int resume_wait;
36static int resume_delay;
Adrian Bunk47a460d2008-02-04 22:30:06 -080037static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080039sector_t swsusp_resume_block;
Barry Songd231ff12011-10-11 23:29:18 -070040int in_suspend __nosavedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070042enum {
43 HIBERNATION_INVALID,
44 HIBERNATION_PLATFORM,
45 HIBERNATION_TEST,
46 HIBERNATION_TESTPROC,
47 HIBERNATION_SHUTDOWN,
48 HIBERNATION_REBOOT,
49 /* keep last */
50 __HIBERNATION_AFTER_LAST
51};
52#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
53#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
54
55static int hibernation_mode = HIBERNATION_SHUTDOWN;
56
Lionel Debroux073ef1f2010-11-09 21:48:49 +010057static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070058
59/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020060 * hibernation_set_ops - Set the global hibernate operations.
61 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070062 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010063void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070064{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010065 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
66 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010067 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070068 WARN_ON(1);
69 return;
70 }
71 mutex_lock(&pm_mutex);
72 hibernation_ops = ops;
73 if (ops)
74 hibernation_mode = HIBERNATION_PLATFORM;
75 else if (hibernation_mode == HIBERNATION_PLATFORM)
76 hibernation_mode = HIBERNATION_SHUTDOWN;
77
78 mutex_unlock(&pm_mutex);
79}
80
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010081static bool entering_platform_hibernation;
82
83bool system_entering_hibernation(void)
84{
85 return entering_platform_hibernation;
86}
87EXPORT_SYMBOL(system_entering_hibernation);
88
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010089#ifdef CONFIG_PM_DEBUG
90static void hibernation_debug_sleep(void)
91{
92 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
93 mdelay(5000);
94}
95
96static int hibernation_testmode(int mode)
97{
98 if (hibernation_mode == mode) {
99 hibernation_debug_sleep();
100 return 1;
101 }
102 return 0;
103}
104
105static int hibernation_test(int level)
106{
107 if (pm_test_level == level) {
108 hibernation_debug_sleep();
109 return 1;
110 }
111 return 0;
112}
113#else /* !CONFIG_PM_DEBUG */
114static int hibernation_testmode(int mode) { return 0; }
115static int hibernation_test(int level) { return 0; }
116#endif /* !CONFIG_PM_DEBUG */
117
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700118/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200119 * platform_begin - Call platform to start hibernation.
120 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700121 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100122static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700123{
124 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100125 hibernation_ops->begin() : 0;
126}
127
128/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200129 * platform_end - Call platform to finish transition to the working state.
130 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100131 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100132static void platform_end(int platform_mode)
133{
134 if (platform_mode && hibernation_ops)
135 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700136}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200139 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
140 * @platform_mode: Whether or not to use the platform driver.
141 *
142 * Use the platform driver to prepare the system for creating a hibernate image,
143 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800144 */
145
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700146static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800147{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700148 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700149 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800150}
151
152/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200153 * platform_leave - Call platform to prepare a transition to the working state.
154 * @platform_mode: Whether or not to use the platform driver.
155 *
156 * Use the platform driver prepare to prepare the machine for switching to the
157 * normal mode of operation.
158 *
159 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700160 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700161static void platform_leave(int platform_mode)
162{
163 if (platform_mode && hibernation_ops)
164 hibernation_ops->leave();
165}
166
167/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200168 * platform_finish - Call platform to switch the system to the working state.
169 * @platform_mode: Whether or not to use the platform driver.
170 *
171 * Use the platform driver to switch the machine to the normal mode of
172 * operation.
173 *
174 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700175 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700176static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700177{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700178 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700179 hibernation_ops->finish();
180}
181
182/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200183 * platform_pre_restore - Prepare for hibernate image restoration.
184 * @platform_mode: Whether or not to use the platform driver.
185 *
186 * Use the platform driver to prepare the system for resume from a hibernation
187 * image.
188 *
189 * If the restore fails after this function has been called,
190 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700191 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700192static int platform_pre_restore(int platform_mode)
193{
194 return (platform_mode && hibernation_ops) ?
195 hibernation_ops->pre_restore() : 0;
196}
197
198/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200199 * platform_restore_cleanup - Switch to the working state after failing restore.
200 * @platform_mode: Whether or not to use the platform driver.
201 *
202 * Use the platform driver to switch the system to the normal mode of operation
203 * after a failing restore.
204 *
205 * If platform_pre_restore() has been called before the failing restore, this
206 * function must be called too, regardless of the result of
207 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700208 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700209static void platform_restore_cleanup(int platform_mode)
210{
211 if (platform_mode && hibernation_ops)
212 hibernation_ops->restore_cleanup();
213}
214
215/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200216 * platform_recover - Recover from a failure to suspend devices.
217 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200218 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200219static void platform_recover(int platform_mode)
220{
221 if (platform_mode && hibernation_ops && hibernation_ops->recover)
222 hibernation_ops->recover();
223}
224
225/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200226 * swsusp_show_speed - Print time elapsed between two events during hibernation.
227 * @start: Starting event.
228 * @stop: Final event.
229 * @nr_pages: Number of memory pages processed between @start and @stop.
230 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100231 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100232void swsusp_show_speed(struct timeval *start, struct timeval *stop,
233 unsigned nr_pages, char *msg)
234{
235 s64 elapsed_centisecs64;
236 int centisecs;
237 int k;
238 int kps;
239
240 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
241 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
242 centisecs = elapsed_centisecs64;
243 if (centisecs == 0)
244 centisecs = 1; /* avoid div-by-zero */
245 k = nr_pages * (PAGE_SIZE / 1024);
246 kps = (k * 100) / centisecs;
247 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
248 msg, k,
249 centisecs / 100, centisecs % 100,
250 kps / 1000, (kps % 1000) / 10);
251}
252
253/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200254 * create_image - Create a hibernation image.
255 * @platform_mode: Whether or not to use the platform driver.
256 *
257 * Execute device drivers' .freeze_noirq() callbacks, create a hibernation image
258 * and execute the drivers' .thaw_noirq() callbacks.
259 *
260 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700261 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800262static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700263{
264 int error;
265
Alan Sternd1616302009-05-24 22:05:42 +0200266 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700267 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100268 printk(KERN_ERR "PM: Some devices failed to power down, "
269 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200270 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700271 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100272
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100273 error = platform_pre_snapshot(platform_mode);
274 if (error || hibernation_test(TEST_PLATFORM))
275 goto Platform_finish;
276
277 error = disable_nonboot_cpus();
278 if (error || hibernation_test(TEST_CPUS)
279 || hibernation_testmode(HIBERNATION_TEST))
280 goto Enable_cpus;
281
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100282 local_irq_disable();
283
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200284 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100285 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200286 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100287 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100288 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100289 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700290
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100291 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100292 goto Power_up;
293
294 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700295 save_processor_state();
296 error = swsusp_arch_suspend();
297 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100298 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
299 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700300 /* Restore control flow magically appears here */
301 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200302 if (!in_suspend) {
303 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700304 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200305 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100306
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100307 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100308 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100309
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100310 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100311 local_irq_enable();
312
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100313 Enable_cpus:
314 enable_nonboot_cpus();
315
316 Platform_finish:
317 platform_finish(platform_mode);
318
Alan Sternd1616302009-05-24 22:05:42 +0200319 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200320 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100321
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700322 return error;
323}
324
325/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200326 * hibernation_snapshot - Quiesce devices and create a hibernation image.
327 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700328 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200329 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700330 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700331int hibernation_snapshot(int platform_mode)
332{
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200333 pm_message_t msg = PMSG_RECOVER;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100334 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700335
Zhang Rui3fe03132008-10-26 20:50:26 +0100336 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700337 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200338 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700339
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200340 /* Preallocate image memory before shutting down devices. */
341 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700342 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200343 goto Close;
344
345 error = freeze_kernel_threads();
346 if (error)
347 goto Close;
348
349 error = dpm_prepare(PMSG_FREEZE);
350 if (error)
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200351 goto Complete_devices;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700352
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700353 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100354 pm_restrict_gfp_mask();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200355 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700356 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200357 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700358
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100359 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200360 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700361
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100362 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100363 /*
364 * Control returns here (1) after the image has been created or the
365 * image creation has failed and (2) after a successful restore.
366 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100367
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100368 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200369 /* We may need to release the preallocated image pages here. */
370 if (error || !in_suspend)
371 swsusp_free();
372
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200373 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
374 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100375
376 if (error || !in_suspend)
377 pm_restore_gfp_mask();
378
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700379 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200380
381 Complete_devices:
382 dpm_complete(msg);
383
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100384 Close:
385 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700386 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200387
388 Recover_platform:
389 platform_recover(platform_mode);
390 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700391}
392
393/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200394 * resume_target_kernel - Restore system state from a hibernation image.
395 * @platform_mode: Whether or not to use the platform driver.
396 *
397 * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
398 * highmem that have not been restored yet from the image and run the low-level
399 * code that will restore the remaining contents of memory and switch to the
400 * just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100401 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100402static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100403{
404 int error;
405
Alan Sternd1616302009-05-24 22:05:42 +0200406 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100407 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100408 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100409 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200410 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100411 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100412
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100413 error = platform_pre_restore(platform_mode);
414 if (error)
415 goto Cleanup;
416
417 error = disable_nonboot_cpus();
418 if (error)
419 goto Enable_cpus;
420
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100421 local_irq_disable();
422
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200423 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100424 if (error)
425 goto Enable_irqs;
426
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100427 save_processor_state();
428 error = restore_highmem();
429 if (!error) {
430 error = swsusp_arch_resume();
431 /*
432 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200433 * Otherwise, execution continues at the place where
434 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100435 */
436 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200437 /*
438 * This call to restore_highmem() reverts the changes made by
439 * the previous one.
440 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100441 restore_highmem();
442 }
443 /*
444 * The only reason why swsusp_arch_resume() can fail is memory being
445 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200446 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100447 */
448 swsusp_free();
449 restore_processor_state();
450 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100451
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100452 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100453
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100454 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100455 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100456
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100457 Enable_cpus:
458 enable_nonboot_cpus();
459
460 Cleanup:
461 platform_restore_cleanup(platform_mode);
462
Alan Sternd1616302009-05-24 22:05:42 +0200463 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100464
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100465 return error;
466}
467
468/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200469 * hibernation_restore - Quiesce devices and restore from a hibernation image.
470 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700471 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200472 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200473 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700474 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700475int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700476{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100477 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700478
479 pm_prepare_console();
480 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100481 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200482 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700483 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100484 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200485 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700486 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100487 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700488 resume_console();
489 pm_restore_console();
490 return error;
491}
492
493/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200494 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700495 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700496int hibernation_platform_enter(void)
497{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100498 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700499
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700500 if (!hibernation_ops)
501 return -ENOSYS;
502
503 /*
504 * We have cancelled the power transition by running
505 * hibernation_ops->finish() before saving the image, so we should let
506 * the firmware know that we're going to enter the sleep state after all
507 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100508 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700509 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100510 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700511
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100512 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700513 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200514 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200515 if (error) {
516 if (hibernation_ops->recover)
517 hibernation_ops->recover();
518 goto Resume_devices;
519 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700520
Alan Sternd1616302009-05-24 22:05:42 +0200521 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100522 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200523 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100524
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100525 error = hibernation_ops->prepare();
526 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200527 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100528
529 error = disable_nonboot_cpus();
530 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200531 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100532
533 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100534 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100535 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200536 error = -EAGAIN;
537 goto Power_up;
538 }
539
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100540 hibernation_ops->enter();
541 /* We should never get here */
542 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700543
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200544 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100545 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200546 local_irq_enable();
547 enable_nonboot_cpus();
548
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200549 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700550 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100551
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200552 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100553
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700554 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100555 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200556 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700557 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100558
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100559 Close:
560 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100561
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700562 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700563}
564
565/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200566 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200568 * Use the platform driver, if configured, to put the system into the sleep
569 * state corresponding to hibernation, or try to power it off or reboot,
570 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 */
Johannes Bergfe0c9352007-04-30 15:09:51 -0700572static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700574 switch (hibernation_mode) {
575 case HIBERNATION_TEST:
576 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700577 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700578 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600579 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700581 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700582 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700583 case HIBERNATION_SHUTDOWN:
584 kernel_power_off();
585 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600587 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700588 /*
589 * Valid image is on the disk, if we continue we risk serious data
590 * corruption after resume.
591 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100592 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 while(1);
594}
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596static int prepare_processes(void)
597{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800598 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 if (freeze_processes()) {
601 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100602 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700604 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605}
606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200608 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700610int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
612 int error;
613
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700614 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700615 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700616 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
617 error = -EBUSY;
618 goto Unlock;
619 }
620
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100621 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700622 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
623 if (error)
624 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700625
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700626 error = usermodehelper_disable();
627 if (error)
628 goto Exit;
629
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700630 /* Allocate memory management structures */
631 error = create_basic_memory_bitmaps();
632 if (error)
633 goto Exit;
634
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100635 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700636 sys_sync();
637 printk("done.\n");
638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700640 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700641 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100643 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800644 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100645
646 if (hibernation_testmode(HIBERNATION_TESTPROC))
647 goto Thaw;
648
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700649 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200650 if (error)
651 goto Thaw;
652
653 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700654 unsigned int flags = 0;
655
656 if (hibernation_mode == HIBERNATION_PLATFORM)
657 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200658 if (nocompress)
659 flags |= SF_NOCOMPRESS_MODE;
Bojan Smojver081a9d02011-10-13 23:58:07 +0200660 else
661 flags |= SF_CRC32_MODE;
662
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700664 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700665 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700667 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100668 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100669 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800670 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800672 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200673
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800674 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100675 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700676 Finish:
677 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700678 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700679 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700680 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100681 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700682 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700683 Unlock:
684 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 return error;
686}
687
688
689/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200690 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200692 * This routine is called as a late initcall, when all devices have been
693 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200695 * The image reading code is called to see if there is a hibernation image
696 * available for reading. If that is the case, devices are quiesced and the
697 * contents of memory is restored from the saved image.
698 *
699 * If this is successful, control reappears in the restored target kernel in
700 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
701 * attempts to recover gracefully and make the kernel return to the normal mode
702 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704static int software_resume(void)
705{
706 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700707 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Johannes Berg60a0d232007-11-14 17:00:16 -0800709 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100710 * If the user said "noresume".. bail out early.
711 */
712 if (noresume)
713 return 0;
714
715 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800716 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
717 * is configured into the kernel. Since the regular hibernate
718 * trigger path is via sysfs which takes a buffer mutex before
719 * calling hibernate functions (which take pm_mutex) this can
720 * cause lockdep to complain about a possible ABBA deadlock
721 * which cannot happen since we're in the boot code here and
722 * sysfs can't be invoked yet. Therefore, we use a subclass
723 * here to avoid lockdep complaining.
724 */
725 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200726
727 if (swsusp_resume_device)
728 goto Check_image;
729
730 if (!strlen(resume_file)) {
731 error = -ENOENT;
732 goto Unlock;
733 }
734
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200735 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200736
Barry Songf126f732011-10-10 23:38:41 +0200737 if (resume_delay) {
738 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
739 resume_delay);
740 ssleep(resume_delay);
741 }
742
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200743 /* Check if the device is there */
744 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700745 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100746 /*
747 * Some device discovery might still be in progress; we need
748 * to wait for this to finish.
749 */
750 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200751
752 if (resume_wait) {
753 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
754 msleep(10);
755 async_synchronize_full();
756 }
757
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200758 /*
759 * We can't depend on SCSI devices being available after loading
760 * one of their modules until scsi_complete_async_scans() is
761 * called and the resume device usually is a SCSI one.
762 */
763 scsi_complete_async_scans();
764
Pavel Machek3efa1472005-07-07 17:56:43 -0700765 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200766 if (!swsusp_resume_device) {
767 error = -ENODEV;
768 goto Unlock;
769 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700770 }
771
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200772 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200773 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200774 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200776 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800777 error = swsusp_check();
778 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700779 goto Unlock;
780
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700781 /* The snapshot device should not be opened while we're running */
782 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
783 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200784 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700785 goto Unlock;
786 }
787
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100788 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100789 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
790 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200791 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100792
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700793 error = usermodehelper_disable();
794 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200795 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700796
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700797 error = create_basic_memory_bitmaps();
798 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200799 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
801 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800802 error = prepare_processes();
803 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400804 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700805 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 }
807
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200808 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700810 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200811 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800812 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700813 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200815 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700816 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100817 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700819 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700820 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700821 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100822 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100823 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700824 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700825 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700826 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800827 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200828 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700829 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200830close_finish:
831 swsusp_close(FMODE_READ);
832 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833}
834
835late_initcall(software_resume);
836
837
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700838static const char * const hibernation_modes[] = {
839 [HIBERNATION_PLATFORM] = "platform",
840 [HIBERNATION_SHUTDOWN] = "shutdown",
841 [HIBERNATION_REBOOT] = "reboot",
842 [HIBERNATION_TEST] = "test",
843 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844};
845
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200846/*
847 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200849 * Hibernation can be handled in several ways. There are a few different ways
850 * to put the system into the sleep state: using the platform driver (e.g. ACPI
851 * or other hibernation_ops), powering it off or rebooting it (for testing
852 * mostly), or using one of the two available test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200854 * The sysfs file /sys/power/disk provides an interface for selecting the
855 * hibernation mode to use. Reading from this file causes the available modes
856 * to be printed. There are 5 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 * 'platform'
859 * 'shutdown'
860 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700861 * 'test'
862 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200864 * If a platform hibernation driver is in use, 'platform' will be supported
865 * and will be used by default. Otherwise, 'shutdown' will be used by default.
866 * The selected option (i.e. the one corresponding to the current value of
867 * hibernation_mode) is enclosed by a square bracket.
868 *
869 * To select a given hibernation mode it is necessary to write the mode's
870 * string representation (as returned by reading from /sys/power/disk) back
871 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 */
873
Kay Sievers386f2752007-11-02 13:47:53 +0100874static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
875 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700877 int i;
878 char *start = buf;
879
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700880 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
881 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700882 continue;
883 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700884 case HIBERNATION_SHUTDOWN:
885 case HIBERNATION_REBOOT:
886 case HIBERNATION_TEST:
887 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700888 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700889 case HIBERNATION_PLATFORM:
890 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700891 break;
892 /* not a valid mode, continue with loop */
893 continue;
894 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700895 if (i == hibernation_mode)
896 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700897 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700898 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700899 }
900 buf += sprintf(buf, "\n");
901 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902}
903
Kay Sievers386f2752007-11-02 13:47:53 +0100904static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
905 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906{
907 int error = 0;
908 int i;
909 int len;
910 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700911 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
913 p = memchr(buf, '\n', n);
914 len = p ? p - buf : n;
915
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800916 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700917 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700918 if (len == strlen(hibernation_modes[i])
919 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 mode = i;
921 break;
922 }
923 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700924 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700925 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700926 case HIBERNATION_SHUTDOWN:
927 case HIBERNATION_REBOOT:
928 case HIBERNATION_TEST:
929 case HIBERNATION_TESTPROC:
930 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700931 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700932 case HIBERNATION_PLATFORM:
933 if (hibernation_ops)
934 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 else
936 error = -EINVAL;
937 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700938 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 error = -EINVAL;
940
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700941 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100942 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700943 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800944 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 return error ? error : n;
946}
947
948power_attr(disk);
949
Kay Sievers386f2752007-11-02 13:47:53 +0100950static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
951 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952{
953 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
954 MINOR(swsusp_resume_device));
955}
956
Kay Sievers386f2752007-11-02 13:47:53 +0100957static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
958 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800962 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
Andrew Mortona5762192006-01-06 00:09:50 -0800964 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
965 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966
Andrew Mortona5762192006-01-06 00:09:50 -0800967 res = MKDEV(maj,min);
968 if (maj != MAJOR(res) || min != MINOR(res))
969 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800971 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800972 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800973 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100974 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800975 noresume = 0;
976 software_resume();
977 ret = n;
Rafael J. Wysocki59a49332006-12-06 20:34:44 -0800978 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800979 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980}
981
982power_attr(resume);
983
Kay Sievers386f2752007-11-02 13:47:53 +0100984static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
985 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800986{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800987 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800988}
989
Kay Sievers386f2752007-11-02 13:47:53 +0100990static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
991 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800992{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800993 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800994
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800995 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800996 image_size = size;
997 return n;
998 }
999
1000 return -EINVAL;
1001}
1002
1003power_attr(image_size);
1004
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001005static ssize_t reserved_size_show(struct kobject *kobj,
1006 struct kobj_attribute *attr, char *buf)
1007{
1008 return sprintf(buf, "%lu\n", reserved_size);
1009}
1010
1011static ssize_t reserved_size_store(struct kobject *kobj,
1012 struct kobj_attribute *attr,
1013 const char *buf, size_t n)
1014{
1015 unsigned long size;
1016
1017 if (sscanf(buf, "%lu", &size) == 1) {
1018 reserved_size = size;
1019 return n;
1020 }
1021
1022 return -EINVAL;
1023}
1024
1025power_attr(reserved_size);
1026
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027static struct attribute * g[] = {
1028 &disk_attr.attr,
1029 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001030 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001031 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 NULL,
1033};
1034
1035
1036static struct attribute_group attr_group = {
1037 .attrs = g,
1038};
1039
1040
1041static int __init pm_disk_init(void)
1042{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001043 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044}
1045
1046core_initcall(pm_disk_init);
1047
1048
1049static int __init resume_setup(char *str)
1050{
1051 if (noresume)
1052 return 1;
1053
1054 strncpy( resume_file, str, 255 );
1055 return 1;
1056}
1057
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001058static int __init resume_offset_setup(char *str)
1059{
1060 unsigned long long offset;
1061
1062 if (noresume)
1063 return 1;
1064
1065 if (sscanf(str, "%llu", &offset) == 1)
1066 swsusp_resume_block = offset;
1067
1068 return 1;
1069}
1070
Bojan Smojverf996fc92010-09-09 23:06:23 +02001071static int __init hibernate_setup(char *str)
1072{
1073 if (!strncmp(str, "noresume", 8))
1074 noresume = 1;
1075 else if (!strncmp(str, "nocompress", 10))
1076 nocompress = 1;
1077 return 1;
1078}
1079
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080static int __init noresume_setup(char *str)
1081{
1082 noresume = 1;
1083 return 1;
1084}
1085
Barry Song6f8d7022011-10-06 20:34:46 +02001086static int __init resumewait_setup(char *str)
1087{
1088 resume_wait = 1;
1089 return 1;
1090}
1091
Barry Songf126f732011-10-10 23:38:41 +02001092static int __init resumedelay_setup(char *str)
1093{
1094 resume_delay = simple_strtoul(str, NULL, 0);
1095 return 1;
1096}
1097
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001099__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001101__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001102__setup("resumewait", resumewait_setup);
Barry Songf126f732011-10-10 23:38:41 +02001103__setup("resumedelay=", resumedelay_setup);