blob: b4511b6d3ef93ef5e2d12a097c3a63fa058de423 [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
Paul Gortmaker6e5fdee2011-05-26 16:00:52 -040012#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/suspend.h>
14#include <linux/syscalls.h>
15#include <linux/reboot.h>
16#include <linux/string.h>
17#include <linux/device.h>
Barry Song6f8d7022011-10-06 20:34:46 +020018#include <linux/async.h>
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -070019#include <linux/kmod.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/delay.h>
21#include <linux/fs.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070022#include <linux/mount.h>
Eric W. Biederman88d10bb2005-09-22 21:43:46 -070023#include <linux/pm.h>
Rafael J. Wysocki97c78012006-10-11 01:20:45 -070024#include <linux/console.h>
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -070025#include <linux/cpu.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080026#include <linux/freezer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090027#include <linux/gfp.h>
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +010028#include <linux/syscore_ops.h>
Rafael J. Wysockic7510852009-04-12 20:06:56 +020029#include <scsi/scsi_scan.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070030
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include "power.h"
32
33
Barry Songd231ff12011-10-11 23:29:18 -070034static int nocompress;
35static int noresume;
36static int resume_wait;
37static int resume_delay;
Adrian Bunk47a460d2008-02-04 22:30:06 -080038static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080040sector_t swsusp_resume_block;
Barry Songd231ff12011-10-11 23:29:18 -070041int in_suspend __nosavedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070043enum {
44 HIBERNATION_INVALID,
45 HIBERNATION_PLATFORM,
46 HIBERNATION_TEST,
47 HIBERNATION_TESTPROC,
48 HIBERNATION_SHUTDOWN,
49 HIBERNATION_REBOOT,
50 /* keep last */
51 __HIBERNATION_AFTER_LAST
52};
53#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
54#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
55
56static int hibernation_mode = HIBERNATION_SHUTDOWN;
57
Lionel Debroux073ef1f2010-11-09 21:48:49 +010058static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070059
60/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020061 * hibernation_set_ops - Set the global hibernate operations.
62 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070063 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010064void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070065{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010066 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
67 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010068 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070069 WARN_ON(1);
70 return;
71 }
72 mutex_lock(&pm_mutex);
73 hibernation_ops = ops;
74 if (ops)
75 hibernation_mode = HIBERNATION_PLATFORM;
76 else if (hibernation_mode == HIBERNATION_PLATFORM)
77 hibernation_mode = HIBERNATION_SHUTDOWN;
78
79 mutex_unlock(&pm_mutex);
80}
81
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010082static bool entering_platform_hibernation;
83
84bool system_entering_hibernation(void)
85{
86 return entering_platform_hibernation;
87}
88EXPORT_SYMBOL(system_entering_hibernation);
89
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010090#ifdef CONFIG_PM_DEBUG
91static void hibernation_debug_sleep(void)
92{
93 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
94 mdelay(5000);
95}
96
97static int hibernation_testmode(int mode)
98{
99 if (hibernation_mode == mode) {
100 hibernation_debug_sleep();
101 return 1;
102 }
103 return 0;
104}
105
106static int hibernation_test(int level)
107{
108 if (pm_test_level == level) {
109 hibernation_debug_sleep();
110 return 1;
111 }
112 return 0;
113}
114#else /* !CONFIG_PM_DEBUG */
115static int hibernation_testmode(int mode) { return 0; }
116static int hibernation_test(int level) { return 0; }
117#endif /* !CONFIG_PM_DEBUG */
118
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700119/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200120 * platform_begin - Call platform to start hibernation.
121 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700122 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100123static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700124{
125 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100126 hibernation_ops->begin() : 0;
127}
128
129/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200130 * platform_end - Call platform to finish transition to the working state.
131 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100132 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100133static void platform_end(int platform_mode)
134{
135 if (platform_mode && hibernation_ops)
136 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700137}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200140 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
141 * @platform_mode: Whether or not to use the platform driver.
142 *
143 * Use the platform driver to prepare the system for creating a hibernate image,
144 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800145 */
146
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700147static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800148{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700149 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700150 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800151}
152
153/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200154 * platform_leave - Call platform to prepare a transition to the working state.
155 * @platform_mode: Whether or not to use the platform driver.
156 *
157 * Use the platform driver prepare to prepare the machine for switching to the
158 * normal mode of operation.
159 *
160 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700161 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700162static void platform_leave(int platform_mode)
163{
164 if (platform_mode && hibernation_ops)
165 hibernation_ops->leave();
166}
167
168/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200169 * platform_finish - Call platform to switch the system to the working state.
170 * @platform_mode: Whether or not to use the platform driver.
171 *
172 * Use the platform driver to switch the machine to the normal mode of
173 * operation.
174 *
175 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700176 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700177static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700178{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700179 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700180 hibernation_ops->finish();
181}
182
183/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200184 * platform_pre_restore - Prepare for hibernate image restoration.
185 * @platform_mode: Whether or not to use the platform driver.
186 *
187 * Use the platform driver to prepare the system for resume from a hibernation
188 * image.
189 *
190 * If the restore fails after this function has been called,
191 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700192 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700193static int platform_pre_restore(int platform_mode)
194{
195 return (platform_mode && hibernation_ops) ?
196 hibernation_ops->pre_restore() : 0;
197}
198
199/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200200 * platform_restore_cleanup - Switch to the working state after failing restore.
201 * @platform_mode: Whether or not to use the platform driver.
202 *
203 * Use the platform driver to switch the system to the normal mode of operation
204 * after a failing restore.
205 *
206 * If platform_pre_restore() has been called before the failing restore, this
207 * function must be called too, regardless of the result of
208 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700209 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700210static void platform_restore_cleanup(int platform_mode)
211{
212 if (platform_mode && hibernation_ops)
213 hibernation_ops->restore_cleanup();
214}
215
216/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200217 * platform_recover - Recover from a failure to suspend devices.
218 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200219 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200220static void platform_recover(int platform_mode)
221{
222 if (platform_mode && hibernation_ops && hibernation_ops->recover)
223 hibernation_ops->recover();
224}
225
226/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200227 * swsusp_show_speed - Print time elapsed between two events during hibernation.
228 * @start: Starting event.
229 * @stop: Final event.
230 * @nr_pages: Number of memory pages processed between @start and @stop.
231 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100232 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100233void swsusp_show_speed(struct timeval *start, struct timeval *stop,
234 unsigned nr_pages, char *msg)
235{
236 s64 elapsed_centisecs64;
237 int centisecs;
238 int k;
239 int kps;
240
241 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
242 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
243 centisecs = elapsed_centisecs64;
244 if (centisecs == 0)
245 centisecs = 1; /* avoid div-by-zero */
246 k = nr_pages * (PAGE_SIZE / 1024);
247 kps = (k * 100) / centisecs;
248 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
249 msg, k,
250 centisecs / 100, centisecs % 100,
251 kps / 1000, (kps % 1000) / 10);
252}
253
254/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200255 * create_image - Create a hibernation image.
256 * @platform_mode: Whether or not to use the platform driver.
257 *
258 * Execute device drivers' .freeze_noirq() callbacks, create a hibernation image
259 * and execute the drivers' .thaw_noirq() callbacks.
260 *
261 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700262 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800263static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700264{
265 int error;
266
Alan Sternd1616302009-05-24 22:05:42 +0200267 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700268 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100269 printk(KERN_ERR "PM: Some devices failed to power down, "
270 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200271 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700272 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100273
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100274 error = platform_pre_snapshot(platform_mode);
275 if (error || hibernation_test(TEST_PLATFORM))
276 goto Platform_finish;
277
278 error = disable_nonboot_cpus();
279 if (error || hibernation_test(TEST_CPUS)
280 || hibernation_testmode(HIBERNATION_TEST))
281 goto Enable_cpus;
282
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100283 local_irq_disable();
284
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200285 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100286 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200287 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100288 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100289 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100290 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700291
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100292 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100293 goto Power_up;
294
295 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700296 save_processor_state();
297 error = swsusp_arch_suspend();
298 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100299 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
300 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700301 /* Restore control flow magically appears here */
302 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200303 if (!in_suspend) {
304 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700305 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200306 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100307
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100308 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100309 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100310
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100311 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100312 local_irq_enable();
313
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100314 Enable_cpus:
315 enable_nonboot_cpus();
316
317 Platform_finish:
318 platform_finish(platform_mode);
319
Alan Sternd1616302009-05-24 22:05:42 +0200320 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200321 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100322
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700323 return error;
324}
325
326/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200327 * hibernation_snapshot - Quiesce devices and create a hibernation image.
328 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700329 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200330 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700331 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700332int hibernation_snapshot(int platform_mode)
333{
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200334 pm_message_t msg = PMSG_RECOVER;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100335 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700336
Zhang Rui3fe03132008-10-26 20:50:26 +0100337 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700338 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200339 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700340
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. Wysocki2aede852011-09-26 20:32:27 +0200344 goto Close;
345
346 error = freeze_kernel_threads();
347 if (error)
348 goto Close;
349
350 error = dpm_prepare(PMSG_FREEZE);
351 if (error)
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200352 goto Complete_devices;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700353
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700354 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100355 pm_restrict_gfp_mask();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200356 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700357 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200358 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700359
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100360 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200361 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700362
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100363 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100364 /*
365 * Control returns here (1) after the image has been created or the
366 * image creation has failed and (2) after a successful restore.
367 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100368
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100369 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200370 /* We may need to release the preallocated image pages here. */
371 if (error || !in_suspend)
372 swsusp_free();
373
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200374 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
375 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100376
377 if (error || !in_suspend)
378 pm_restore_gfp_mask();
379
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700380 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200381
382 Complete_devices:
383 dpm_complete(msg);
384
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100385 Close:
386 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700387 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200388
389 Recover_platform:
390 platform_recover(platform_mode);
391 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700392}
393
394/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200395 * resume_target_kernel - Restore system state from a hibernation image.
396 * @platform_mode: Whether or not to use the platform driver.
397 *
398 * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
399 * highmem that have not been restored yet from the image and run the low-level
400 * code that will restore the remaining contents of memory and switch to the
401 * just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100402 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100403static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100404{
405 int error;
406
Alan Sternd1616302009-05-24 22:05:42 +0200407 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100408 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100409 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100410 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200411 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100412 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100413
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100414 error = platform_pre_restore(platform_mode);
415 if (error)
416 goto Cleanup;
417
418 error = disable_nonboot_cpus();
419 if (error)
420 goto Enable_cpus;
421
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100422 local_irq_disable();
423
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200424 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100425 if (error)
426 goto Enable_irqs;
427
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100428 save_processor_state();
429 error = restore_highmem();
430 if (!error) {
431 error = swsusp_arch_resume();
432 /*
433 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200434 * Otherwise, execution continues at the place where
435 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100436 */
437 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200438 /*
439 * This call to restore_highmem() reverts the changes made by
440 * the previous one.
441 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100442 restore_highmem();
443 }
444 /*
445 * The only reason why swsusp_arch_resume() can fail is memory being
446 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200447 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100448 */
449 swsusp_free();
450 restore_processor_state();
451 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100452
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100453 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100454
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100455 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100456 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100457
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100458 Enable_cpus:
459 enable_nonboot_cpus();
460
461 Cleanup:
462 platform_restore_cleanup(platform_mode);
463
Alan Sternd1616302009-05-24 22:05:42 +0200464 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100465
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100466 return error;
467}
468
469/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200470 * hibernation_restore - Quiesce devices and restore from a hibernation image.
471 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700472 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200473 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200474 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700475 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700476int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700477{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100478 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700479
480 pm_prepare_console();
481 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100482 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200483 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700484 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100485 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200486 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700487 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100488 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700489 resume_console();
490 pm_restore_console();
491 return error;
492}
493
494/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200495 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700496 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700497int hibernation_platform_enter(void)
498{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100499 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700500
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700501 if (!hibernation_ops)
502 return -ENOSYS;
503
504 /*
505 * We have cancelled the power transition by running
506 * hibernation_ops->finish() before saving the image, so we should let
507 * the firmware know that we're going to enter the sleep state after all
508 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100509 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700510 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100511 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700512
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100513 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700514 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200515 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200516 if (error) {
517 if (hibernation_ops->recover)
518 hibernation_ops->recover();
519 goto Resume_devices;
520 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700521
Alan Sternd1616302009-05-24 22:05:42 +0200522 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100523 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200524 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100525
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100526 error = hibernation_ops->prepare();
527 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200528 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100529
530 error = disable_nonboot_cpus();
531 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200532 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100533
534 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100535 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100536 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200537 error = -EAGAIN;
538 goto Power_up;
539 }
540
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100541 hibernation_ops->enter();
542 /* We should never get here */
543 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700544
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200545 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100546 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200547 local_irq_enable();
548 enable_nonboot_cpus();
549
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200550 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700551 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100552
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200553 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100554
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700555 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100556 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200557 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700558 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100559
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100560 Close:
561 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100562
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700563 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700564}
565
566/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200567 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200569 * Use the platform driver, if configured, to put the system into the sleep
570 * state corresponding to hibernation, or try to power it off or reboot,
571 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 */
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700573static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700575 switch (hibernation_mode) {
576 case HIBERNATION_TEST:
577 case HIBERNATION_TESTPROC:
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700578 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700579 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600580 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700582 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700583 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700584 case HIBERNATION_SHUTDOWN:
585 kernel_power_off();
586 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600588 kernel_halt();
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700589 /*
590 * Valid image is on the disk, if we continue we risk serious data
591 * corruption after resume.
592 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100593 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 while(1);
595}
596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597static int prepare_processes(void)
598{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800599 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 if (freeze_processes()) {
602 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100603 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700605 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606}
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200609 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700611int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612{
613 int error;
614
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700615 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700616 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700617 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
618 error = -EBUSY;
619 goto Unlock;
620 }
621
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100622 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700623 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
624 if (error)
625 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700626
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700627 error = usermodehelper_disable();
628 if (error)
629 goto Exit;
630
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700631 /* Allocate memory management structures */
632 error = create_basic_memory_bitmaps();
633 if (error)
634 goto Exit;
635
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100636 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700637 sys_sync();
638 printk("done.\n");
639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700641 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700642 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100644 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800645 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100646
647 if (hibernation_testmode(HIBERNATION_TESTPROC))
648 goto Thaw;
649
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700650 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200651 if (error)
652 goto Thaw;
653
654 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700655 unsigned int flags = 0;
656
657 if (hibernation_mode == HIBERNATION_PLATFORM)
658 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200659 if (nocompress)
660 flags |= SF_NOCOMPRESS_MODE;
Bojan Smojver081a9d02011-10-13 23:58:07 +0200661 else
662 flags |= SF_CRC32_MODE;
663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700665 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700666 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 if (!error)
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700668 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100669 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100670 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800671 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800673 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200674
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800675 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100676 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700677 Finish:
678 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700679 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700680 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700681 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100682 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700683 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700684 Unlock:
685 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 return error;
687}
688
689
690/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200691 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200693 * This routine is called as a late initcall, when all devices have been
694 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200696 * The image reading code is called to see if there is a hibernation image
697 * available for reading. If that is the case, devices are quiesced and the
698 * contents of memory is restored from the saved image.
699 *
700 * If this is successful, control reappears in the restored target kernel in
701 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
702 * attempts to recover gracefully and make the kernel return to the normal mode
703 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705static int software_resume(void)
706{
707 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700708 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Johannes Berg60a0d232007-11-14 17:00:16 -0800710 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100711 * If the user said "noresume".. bail out early.
712 */
713 if (noresume)
714 return 0;
715
716 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800717 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
718 * is configured into the kernel. Since the regular hibernate
719 * trigger path is via sysfs which takes a buffer mutex before
720 * calling hibernate functions (which take pm_mutex) this can
721 * cause lockdep to complain about a possible ABBA deadlock
722 * which cannot happen since we're in the boot code here and
723 * sysfs can't be invoked yet. Therefore, we use a subclass
724 * here to avoid lockdep complaining.
725 */
726 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200727
728 if (swsusp_resume_device)
729 goto Check_image;
730
731 if (!strlen(resume_file)) {
732 error = -ENOENT;
733 goto Unlock;
734 }
735
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200736 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200737
Barry Songf126f732011-10-10 23:38:41 +0200738 if (resume_delay) {
739 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
740 resume_delay);
741 ssleep(resume_delay);
742 }
743
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200744 /* Check if the device is there */
745 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700746 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100747 /*
748 * Some device discovery might still be in progress; we need
749 * to wait for this to finish.
750 */
751 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200752
753 if (resume_wait) {
754 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
755 msleep(10);
756 async_synchronize_full();
757 }
758
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200759 /*
760 * We can't depend on SCSI devices being available after loading
761 * one of their modules until scsi_complete_async_scans() is
762 * called and the resume device usually is a SCSI one.
763 */
764 scsi_complete_async_scans();
765
Pavel Machek3efa1472005-07-07 17:56:43 -0700766 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200767 if (!swsusp_resume_device) {
768 error = -ENODEV;
769 goto Unlock;
770 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700771 }
772
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200773 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200774 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200775 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200777 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800778 error = swsusp_check();
779 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700780 goto Unlock;
781
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700782 /* The snapshot device should not be opened while we're running */
783 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
784 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200785 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700786 goto Unlock;
787 }
788
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100789 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100790 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
791 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200792 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100793
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700794 error = usermodehelper_disable();
795 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200796 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700797
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700798 error = create_basic_memory_bitmaps();
799 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200800 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
802 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800803 error = prepare_processes();
804 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400805 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700806 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 }
808
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200809 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700811 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200812 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800813 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700814 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200816 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700817 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100818 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700820 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700821 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700822 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100823 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100824 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700825 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700826 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700827 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800828 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200829 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700830 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200831close_finish:
832 swsusp_close(FMODE_READ);
833 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
836late_initcall(software_resume);
837
838
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700839static const char * const hibernation_modes[] = {
840 [HIBERNATION_PLATFORM] = "platform",
841 [HIBERNATION_SHUTDOWN] = "shutdown",
842 [HIBERNATION_REBOOT] = "reboot",
843 [HIBERNATION_TEST] = "test",
844 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845};
846
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200847/*
848 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200850 * Hibernation can be handled in several ways. There are a few different ways
851 * to put the system into the sleep state: using the platform driver (e.g. ACPI
852 * or other hibernation_ops), powering it off or rebooting it (for testing
853 * mostly), or using one of the two available test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200855 * The sysfs file /sys/power/disk provides an interface for selecting the
856 * hibernation mode to use. Reading from this file causes the available modes
857 * to be printed. There are 5 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 * 'platform'
860 * 'shutdown'
861 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700862 * 'test'
863 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200865 * If a platform hibernation driver is in use, 'platform' will be supported
866 * and will be used by default. Otherwise, 'shutdown' will be used by default.
867 * The selected option (i.e. the one corresponding to the current value of
868 * hibernation_mode) is enclosed by a square bracket.
869 *
870 * To select a given hibernation mode it is necessary to write the mode's
871 * string representation (as returned by reading from /sys/power/disk) back
872 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 */
874
Kay Sievers386f2752007-11-02 13:47:53 +0100875static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
876 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700878 int i;
879 char *start = buf;
880
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700881 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
882 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700883 continue;
884 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700885 case HIBERNATION_SHUTDOWN:
886 case HIBERNATION_REBOOT:
887 case HIBERNATION_TEST:
888 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700889 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700890 case HIBERNATION_PLATFORM:
891 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700892 break;
893 /* not a valid mode, continue with loop */
894 continue;
895 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700896 if (i == hibernation_mode)
897 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700898 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700899 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700900 }
901 buf += sprintf(buf, "\n");
902 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903}
904
Kay Sievers386f2752007-11-02 13:47:53 +0100905static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
906 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907{
908 int error = 0;
909 int i;
910 int len;
911 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700912 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
914 p = memchr(buf, '\n', n);
915 len = p ? p - buf : n;
916
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800917 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700918 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700919 if (len == strlen(hibernation_modes[i])
920 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 mode = i;
922 break;
923 }
924 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700925 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700926 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700927 case HIBERNATION_SHUTDOWN:
928 case HIBERNATION_REBOOT:
929 case HIBERNATION_TEST:
930 case HIBERNATION_TESTPROC:
931 hibernation_mode = mode;
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700932 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700933 case HIBERNATION_PLATFORM:
934 if (hibernation_ops)
935 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 else
937 error = -EINVAL;
938 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700939 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 error = -EINVAL;
941
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700942 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100943 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700944 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800945 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 return error ? error : n;
947}
948
949power_attr(disk);
950
Kay Sievers386f2752007-11-02 13:47:53 +0100951static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
952 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953{
954 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
955 MINOR(swsusp_resume_device));
956}
957
Kay Sievers386f2752007-11-02 13:47:53 +0100958static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
959 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800963 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Andrew Mortona5762192006-01-06 00:09:50 -0800965 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
966 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Andrew Mortona5762192006-01-06 00:09:50 -0800968 res = MKDEV(maj,min);
969 if (maj != MAJOR(res) || min != MINOR(res))
970 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800972 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800973 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800974 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100975 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800976 noresume = 0;
977 software_resume();
978 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800979 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800980 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981}
982
983power_attr(resume);
984
Kay Sievers386f2752007-11-02 13:47:53 +0100985static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
986 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800987{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800988 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800989}
990
Kay Sievers386f2752007-11-02 13:47:53 +0100991static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
992 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800993{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800994 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800995
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800996 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800997 image_size = size;
998 return n;
999 }
1000
1001 return -EINVAL;
1002}
1003
1004power_attr(image_size);
1005
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001006static ssize_t reserved_size_show(struct kobject *kobj,
1007 struct kobj_attribute *attr, char *buf)
1008{
1009 return sprintf(buf, "%lu\n", reserved_size);
1010}
1011
1012static ssize_t reserved_size_store(struct kobject *kobj,
1013 struct kobj_attribute *attr,
1014 const char *buf, size_t n)
1015{
1016 unsigned long size;
1017
1018 if (sscanf(buf, "%lu", &size) == 1) {
1019 reserved_size = size;
1020 return n;
1021 }
1022
1023 return -EINVAL;
1024}
1025
1026power_attr(reserved_size);
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028static struct attribute * g[] = {
1029 &disk_attr.attr,
1030 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001031 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001032 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 NULL,
1034};
1035
1036
1037static struct attribute_group attr_group = {
1038 .attrs = g,
1039};
1040
1041
1042static int __init pm_disk_init(void)
1043{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001044 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045}
1046
1047core_initcall(pm_disk_init);
1048
1049
1050static int __init resume_setup(char *str)
1051{
1052 if (noresume)
1053 return 1;
1054
1055 strncpy( resume_file, str, 255 );
1056 return 1;
1057}
1058
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001059static int __init resume_offset_setup(char *str)
1060{
1061 unsigned long long offset;
1062
1063 if (noresume)
1064 return 1;
1065
1066 if (sscanf(str, "%llu", &offset) == 1)
1067 swsusp_resume_block = offset;
1068
1069 return 1;
1070}
1071
Bojan Smojverf996fc92010-09-09 23:06:23 +02001072static int __init hibernate_setup(char *str)
1073{
1074 if (!strncmp(str, "noresume", 8))
1075 noresume = 1;
1076 else if (!strncmp(str, "nocompress", 10))
1077 nocompress = 1;
1078 return 1;
1079}
1080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081static int __init noresume_setup(char *str)
1082{
1083 noresume = 1;
1084 return 1;
1085}
1086
Barry Song6f8d7022011-10-06 20:34:46 +02001087static int __init resumewait_setup(char *str)
1088{
1089 resume_wait = 1;
1090 return 1;
1091}
1092
Barry Songf126f732011-10-10 23:38:41 +02001093static int __init resumedelay_setup(char *str)
1094{
1095 resume_delay = simple_strtoul(str, NULL, 0);
1096 return 1;
1097}
1098
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001100__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001102__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001103__setup("resumewait", resumewait_setup);
Barry Songf126f732011-10-10 23:38:41 +02001104__setup("resumedelay=", resumedelay_setup);