blob: 196c01268ebd73d50c0a5f4d52d913c9aff8bd8b [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
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +010058static bool freezer_test_done;
59
Lionel Debroux073ef1f2010-11-09 21:48:49 +010060static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070061
62/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020063 * hibernation_set_ops - Set the global hibernate operations.
64 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070065 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010066void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070067{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010068 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
69 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010070 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070071 WARN_ON(1);
72 return;
73 }
74 mutex_lock(&pm_mutex);
75 hibernation_ops = ops;
76 if (ops)
77 hibernation_mode = HIBERNATION_PLATFORM;
78 else if (hibernation_mode == HIBERNATION_PLATFORM)
79 hibernation_mode = HIBERNATION_SHUTDOWN;
80
81 mutex_unlock(&pm_mutex);
82}
83
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010084static bool entering_platform_hibernation;
85
86bool system_entering_hibernation(void)
87{
88 return entering_platform_hibernation;
89}
90EXPORT_SYMBOL(system_entering_hibernation);
91
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010092#ifdef CONFIG_PM_DEBUG
93static void hibernation_debug_sleep(void)
94{
95 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
96 mdelay(5000);
97}
98
99static int hibernation_testmode(int mode)
100{
101 if (hibernation_mode == mode) {
102 hibernation_debug_sleep();
103 return 1;
104 }
105 return 0;
106}
107
108static int hibernation_test(int level)
109{
110 if (pm_test_level == level) {
111 hibernation_debug_sleep();
112 return 1;
113 }
114 return 0;
115}
116#else /* !CONFIG_PM_DEBUG */
117static int hibernation_testmode(int mode) { return 0; }
118static int hibernation_test(int level) { return 0; }
119#endif /* !CONFIG_PM_DEBUG */
120
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700121/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200122 * platform_begin - Call platform to start hibernation.
123 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700124 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100125static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700126{
127 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100128 hibernation_ops->begin() : 0;
129}
130
131/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200132 * platform_end - Call platform to finish transition to the working state.
133 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100134 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100135static void platform_end(int platform_mode)
136{
137 if (platform_mode && hibernation_ops)
138 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700139}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200142 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
143 * @platform_mode: Whether or not to use the platform driver.
144 *
145 * Use the platform driver to prepare the system for creating a hibernate image,
146 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800147 */
148
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700149static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800150{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700151 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700152 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800153}
154
155/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200156 * platform_leave - Call platform to prepare a transition to the working state.
157 * @platform_mode: Whether or not to use the platform driver.
158 *
159 * Use the platform driver prepare to prepare the machine for switching to the
160 * normal mode of operation.
161 *
162 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700163 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700164static void platform_leave(int platform_mode)
165{
166 if (platform_mode && hibernation_ops)
167 hibernation_ops->leave();
168}
169
170/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200171 * platform_finish - Call platform to switch the system to the working state.
172 * @platform_mode: Whether or not to use the platform driver.
173 *
174 * Use the platform driver to switch the machine to the normal mode of
175 * operation.
176 *
177 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700178 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700179static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700180{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700181 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700182 hibernation_ops->finish();
183}
184
185/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200186 * platform_pre_restore - Prepare for hibernate image restoration.
187 * @platform_mode: Whether or not to use the platform driver.
188 *
189 * Use the platform driver to prepare the system for resume from a hibernation
190 * image.
191 *
192 * If the restore fails after this function has been called,
193 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700194 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700195static int platform_pre_restore(int platform_mode)
196{
197 return (platform_mode && hibernation_ops) ?
198 hibernation_ops->pre_restore() : 0;
199}
200
201/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200202 * platform_restore_cleanup - Switch to the working state after failing restore.
203 * @platform_mode: Whether or not to use the platform driver.
204 *
205 * Use the platform driver to switch the system to the normal mode of operation
206 * after a failing restore.
207 *
208 * If platform_pre_restore() has been called before the failing restore, this
209 * function must be called too, regardless of the result of
210 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700211 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700212static void platform_restore_cleanup(int platform_mode)
213{
214 if (platform_mode && hibernation_ops)
215 hibernation_ops->restore_cleanup();
216}
217
218/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200219 * platform_recover - Recover from a failure to suspend devices.
220 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200221 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200222static void platform_recover(int platform_mode)
223{
224 if (platform_mode && hibernation_ops && hibernation_ops->recover)
225 hibernation_ops->recover();
226}
227
228/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200229 * swsusp_show_speed - Print time elapsed between two events during hibernation.
230 * @start: Starting event.
231 * @stop: Final event.
232 * @nr_pages: Number of memory pages processed between @start and @stop.
233 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100234 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100235void swsusp_show_speed(struct timeval *start, struct timeval *stop,
236 unsigned nr_pages, char *msg)
237{
238 s64 elapsed_centisecs64;
239 int centisecs;
240 int k;
241 int kps;
242
243 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
244 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
245 centisecs = elapsed_centisecs64;
246 if (centisecs == 0)
247 centisecs = 1; /* avoid div-by-zero */
248 k = nr_pages * (PAGE_SIZE / 1024);
249 kps = (k * 100) / centisecs;
250 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
251 msg, k,
252 centisecs / 100, centisecs % 100,
253 kps / 1000, (kps % 1000) / 10);
254}
255
256/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200257 * create_image - Create a hibernation image.
258 * @platform_mode: Whether or not to use the platform driver.
259 *
260 * Execute device drivers' .freeze_noirq() callbacks, create a hibernation image
261 * and execute the drivers' .thaw_noirq() callbacks.
262 *
263 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700264 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800265static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700266{
267 int error;
268
Alan Sternd1616302009-05-24 22:05:42 +0200269 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700270 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100271 printk(KERN_ERR "PM: Some devices failed to power down, "
272 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200273 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700274 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100275
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100276 error = platform_pre_snapshot(platform_mode);
277 if (error || hibernation_test(TEST_PLATFORM))
278 goto Platform_finish;
279
280 error = disable_nonboot_cpus();
281 if (error || hibernation_test(TEST_CPUS)
282 || hibernation_testmode(HIBERNATION_TEST))
283 goto Enable_cpus;
284
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100285 local_irq_disable();
286
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200287 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100288 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200289 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100290 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100291 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100292 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700293
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100294 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100295 goto Power_up;
296
297 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700298 save_processor_state();
299 error = swsusp_arch_suspend();
300 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100301 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
302 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700303 /* Restore control flow magically appears here */
304 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200305 if (!in_suspend) {
306 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700307 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200308 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100309
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100310 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100311 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100312
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100313 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100314 local_irq_enable();
315
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100316 Enable_cpus:
317 enable_nonboot_cpus();
318
319 Platform_finish:
320 platform_finish(platform_mode);
321
Alan Sternd1616302009-05-24 22:05:42 +0200322 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200323 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100324
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700325 return error;
326}
327
328/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200329 * hibernation_snapshot - Quiesce devices and create a hibernation image.
330 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700331 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200332 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700333 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700334int hibernation_snapshot(int platform_mode)
335{
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200336 pm_message_t msg = PMSG_RECOVER;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100337 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700338
Zhang Rui3fe03132008-10-26 20:50:26 +0100339 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700340 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200341 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700342
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200343 /* Preallocate image memory before shutting down devices. */
344 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700345 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200346 goto Close;
347
348 error = freeze_kernel_threads();
349 if (error)
350 goto Close;
351
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100352 if (hibernation_test(TEST_FREEZER) ||
353 hibernation_testmode(HIBERNATION_TESTPROC)) {
354
355 /*
356 * Indicate to the caller that we are returning due to a
357 * successful freezer test.
358 */
359 freezer_test_done = true;
360 goto Close;
361 }
362
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200363 error = dpm_prepare(PMSG_FREEZE);
364 if (error)
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200365 goto Complete_devices;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700366
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700367 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100368 pm_restrict_gfp_mask();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200369 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700370 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200371 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700372
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100373 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200374 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700375
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100376 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100377 /*
378 * Control returns here (1) after the image has been created or the
379 * image creation has failed and (2) after a successful restore.
380 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100381
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100382 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200383 /* We may need to release the preallocated image pages here. */
384 if (error || !in_suspend)
385 swsusp_free();
386
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200387 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
388 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100389
390 if (error || !in_suspend)
391 pm_restore_gfp_mask();
392
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700393 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200394
395 Complete_devices:
396 dpm_complete(msg);
397
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100398 Close:
399 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700400 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200401
402 Recover_platform:
403 platform_recover(platform_mode);
404 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700405}
406
407/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200408 * resume_target_kernel - Restore system state from a hibernation image.
409 * @platform_mode: Whether or not to use the platform driver.
410 *
411 * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
412 * highmem that have not been restored yet from the image and run the low-level
413 * code that will restore the remaining contents of memory and switch to the
414 * just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100415 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100416static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100417{
418 int error;
419
Alan Sternd1616302009-05-24 22:05:42 +0200420 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100421 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100422 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100423 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200424 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100425 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100426
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100427 error = platform_pre_restore(platform_mode);
428 if (error)
429 goto Cleanup;
430
431 error = disable_nonboot_cpus();
432 if (error)
433 goto Enable_cpus;
434
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100435 local_irq_disable();
436
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200437 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100438 if (error)
439 goto Enable_irqs;
440
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100441 save_processor_state();
442 error = restore_highmem();
443 if (!error) {
444 error = swsusp_arch_resume();
445 /*
446 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200447 * Otherwise, execution continues at the place where
448 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100449 */
450 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200451 /*
452 * This call to restore_highmem() reverts the changes made by
453 * the previous one.
454 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100455 restore_highmem();
456 }
457 /*
458 * The only reason why swsusp_arch_resume() can fail is memory being
459 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200460 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100461 */
462 swsusp_free();
463 restore_processor_state();
464 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100465
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100466 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100467
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100468 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100469 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100470
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100471 Enable_cpus:
472 enable_nonboot_cpus();
473
474 Cleanup:
475 platform_restore_cleanup(platform_mode);
476
Alan Sternd1616302009-05-24 22:05:42 +0200477 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100478
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100479 return error;
480}
481
482/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200483 * hibernation_restore - Quiesce devices and restore from a hibernation image.
484 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700485 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200486 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200487 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700488 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700489int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700490{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100491 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700492
493 pm_prepare_console();
494 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100495 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200496 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700497 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100498 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200499 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700500 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100501 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700502 resume_console();
503 pm_restore_console();
504 return error;
505}
506
507/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200508 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700509 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700510int hibernation_platform_enter(void)
511{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100512 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700513
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700514 if (!hibernation_ops)
515 return -ENOSYS;
516
517 /*
518 * We have cancelled the power transition by running
519 * hibernation_ops->finish() before saving the image, so we should let
520 * the firmware know that we're going to enter the sleep state after all
521 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100522 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700523 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100524 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700525
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100526 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700527 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200528 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200529 if (error) {
530 if (hibernation_ops->recover)
531 hibernation_ops->recover();
532 goto Resume_devices;
533 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700534
Alan Sternd1616302009-05-24 22:05:42 +0200535 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100536 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200537 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100538
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100539 error = hibernation_ops->prepare();
540 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200541 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100542
543 error = disable_nonboot_cpus();
544 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200545 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100546
547 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100548 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100549 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200550 error = -EAGAIN;
551 goto Power_up;
552 }
553
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100554 hibernation_ops->enter();
555 /* We should never get here */
556 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700557
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200558 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100559 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200560 local_irq_enable();
561 enable_nonboot_cpus();
562
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200563 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700564 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100565
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200566 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100567
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700568 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100569 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200570 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700571 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100572
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100573 Close:
574 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100575
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700576 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700577}
578
579/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200580 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200582 * Use the platform driver, if configured, to put the system into the sleep
583 * state corresponding to hibernation, or try to power it off or reboot,
584 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 */
Johannes Bergfe0c9352007-04-30 15:09:51 -0700586static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700588 switch (hibernation_mode) {
589 case HIBERNATION_TEST:
590 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700591 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700592 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600593 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700595 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700596 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700597 case HIBERNATION_SHUTDOWN:
598 kernel_power_off();
599 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600601 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700602 /*
603 * Valid image is on the disk, if we continue we risk serious data
604 * corruption after resume.
605 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100606 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 while(1);
608}
609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610static int prepare_processes(void)
611{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800612 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 if (freeze_processes()) {
615 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100616 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700618 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619}
620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200622 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700624int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625{
626 int error;
627
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700628 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700629 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700630 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
631 error = -EBUSY;
632 goto Unlock;
633 }
634
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100635 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700636 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
637 if (error)
638 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700639
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700640 error = usermodehelper_disable();
641 if (error)
642 goto Exit;
643
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700644 /* Allocate memory management structures */
645 error = create_basic_memory_bitmaps();
646 if (error)
647 goto Exit;
648
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100649 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700650 sys_sync();
651 printk("done.\n");
652
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700654 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700655 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700657 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200658 if (error)
659 goto Thaw;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100660 if (freezer_test_done) {
661 freezer_test_done = false;
662 goto Thaw;
663 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200664
665 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700666 unsigned int flags = 0;
667
668 if (hibernation_mode == HIBERNATION_PLATFORM)
669 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200670 if (nocompress)
671 flags |= SF_NOCOMPRESS_MODE;
Bojan Smojver081a9d02011-10-13 23:58:07 +0200672 else
673 flags |= SF_CRC32_MODE;
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700676 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700677 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700679 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100680 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100681 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800682 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800684 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200685
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800686 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100687 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700688 Finish:
689 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700690 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700691 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700692 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100693 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700694 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700695 Unlock:
696 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 return error;
698}
699
700
701/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200702 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200704 * This routine is called as a late initcall, when all devices have been
705 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200707 * The image reading code is called to see if there is a hibernation image
708 * available for reading. If that is the case, devices are quiesced and the
709 * contents of memory is restored from the saved image.
710 *
711 * If this is successful, control reappears in the restored target kernel in
712 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
713 * attempts to recover gracefully and make the kernel return to the normal mode
714 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716static int software_resume(void)
717{
718 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700719 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
Johannes Berg60a0d232007-11-14 17:00:16 -0800721 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100722 * If the user said "noresume".. bail out early.
723 */
724 if (noresume)
725 return 0;
726
727 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800728 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
729 * is configured into the kernel. Since the regular hibernate
730 * trigger path is via sysfs which takes a buffer mutex before
731 * calling hibernate functions (which take pm_mutex) this can
732 * cause lockdep to complain about a possible ABBA deadlock
733 * which cannot happen since we're in the boot code here and
734 * sysfs can't be invoked yet. Therefore, we use a subclass
735 * here to avoid lockdep complaining.
736 */
737 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200738
739 if (swsusp_resume_device)
740 goto Check_image;
741
742 if (!strlen(resume_file)) {
743 error = -ENOENT;
744 goto Unlock;
745 }
746
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200747 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200748
Barry Songf126f732011-10-10 23:38:41 +0200749 if (resume_delay) {
750 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
751 resume_delay);
752 ssleep(resume_delay);
753 }
754
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200755 /* Check if the device is there */
756 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700757 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100758 /*
759 * Some device discovery might still be in progress; we need
760 * to wait for this to finish.
761 */
762 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200763
764 if (resume_wait) {
765 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
766 msleep(10);
767 async_synchronize_full();
768 }
769
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200770 /*
771 * We can't depend on SCSI devices being available after loading
772 * one of their modules until scsi_complete_async_scans() is
773 * called and the resume device usually is a SCSI one.
774 */
775 scsi_complete_async_scans();
776
Pavel Machek3efa1472005-07-07 17:56:43 -0700777 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200778 if (!swsusp_resume_device) {
779 error = -ENODEV;
780 goto Unlock;
781 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700782 }
783
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200784 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200785 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200786 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200788 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800789 error = swsusp_check();
790 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700791 goto Unlock;
792
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700793 /* The snapshot device should not be opened while we're running */
794 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
795 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200796 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700797 goto Unlock;
798 }
799
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100800 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100801 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
802 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200803 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100804
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700805 error = usermodehelper_disable();
806 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200807 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700808
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700809 error = create_basic_memory_bitmaps();
810 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200811 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
813 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800814 error = prepare_processes();
815 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400816 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700817 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 }
819
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200820 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700822 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200823 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800824 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700825 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200827 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700828 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100829 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700831 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700832 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700833 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100834 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100835 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700836 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700837 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700838 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800839 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200840 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700841 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200842close_finish:
843 swsusp_close(FMODE_READ);
844 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845}
846
847late_initcall(software_resume);
848
849
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700850static const char * const hibernation_modes[] = {
851 [HIBERNATION_PLATFORM] = "platform",
852 [HIBERNATION_SHUTDOWN] = "shutdown",
853 [HIBERNATION_REBOOT] = "reboot",
854 [HIBERNATION_TEST] = "test",
855 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856};
857
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200858/*
859 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200861 * Hibernation can be handled in several ways. There are a few different ways
862 * to put the system into the sleep state: using the platform driver (e.g. ACPI
863 * or other hibernation_ops), powering it off or rebooting it (for testing
864 * mostly), or using one of the two available test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200866 * The sysfs file /sys/power/disk provides an interface for selecting the
867 * hibernation mode to use. Reading from this file causes the available modes
868 * to be printed. There are 5 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 * 'platform'
871 * 'shutdown'
872 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700873 * 'test'
874 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200876 * If a platform hibernation driver is in use, 'platform' will be supported
877 * and will be used by default. Otherwise, 'shutdown' will be used by default.
878 * The selected option (i.e. the one corresponding to the current value of
879 * hibernation_mode) is enclosed by a square bracket.
880 *
881 * To select a given hibernation mode it is necessary to write the mode's
882 * string representation (as returned by reading from /sys/power/disk) back
883 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 */
885
Kay Sievers386f2752007-11-02 13:47:53 +0100886static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
887 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700889 int i;
890 char *start = buf;
891
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700892 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
893 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700894 continue;
895 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700896 case HIBERNATION_SHUTDOWN:
897 case HIBERNATION_REBOOT:
898 case HIBERNATION_TEST:
899 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700900 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700901 case HIBERNATION_PLATFORM:
902 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700903 break;
904 /* not a valid mode, continue with loop */
905 continue;
906 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700907 if (i == hibernation_mode)
908 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700909 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700910 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700911 }
912 buf += sprintf(buf, "\n");
913 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914}
915
Kay Sievers386f2752007-11-02 13:47:53 +0100916static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
917 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918{
919 int error = 0;
920 int i;
921 int len;
922 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700923 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
925 p = memchr(buf, '\n', n);
926 len = p ? p - buf : n;
927
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800928 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700929 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700930 if (len == strlen(hibernation_modes[i])
931 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 mode = i;
933 break;
934 }
935 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700936 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700937 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700938 case HIBERNATION_SHUTDOWN:
939 case HIBERNATION_REBOOT:
940 case HIBERNATION_TEST:
941 case HIBERNATION_TESTPROC:
942 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700943 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700944 case HIBERNATION_PLATFORM:
945 if (hibernation_ops)
946 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 else
948 error = -EINVAL;
949 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700950 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 error = -EINVAL;
952
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700953 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100954 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700955 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800956 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 return error ? error : n;
958}
959
960power_attr(disk);
961
Kay Sievers386f2752007-11-02 13:47:53 +0100962static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
963 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964{
965 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
966 MINOR(swsusp_resume_device));
967}
968
Kay Sievers386f2752007-11-02 13:47:53 +0100969static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
970 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800974 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
Andrew Mortona5762192006-01-06 00:09:50 -0800976 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
977 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978
Andrew Mortona5762192006-01-06 00:09:50 -0800979 res = MKDEV(maj,min);
980 if (maj != MAJOR(res) || min != MINOR(res))
981 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800983 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800984 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800985 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100986 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800987 noresume = 0;
988 software_resume();
989 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800990 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800991 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992}
993
994power_attr(resume);
995
Kay Sievers386f2752007-11-02 13:47:53 +0100996static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
997 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800998{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800999 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001000}
1001
Kay Sievers386f2752007-11-02 13:47:53 +01001002static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1003 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001004{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001005 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001006
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001007 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001008 image_size = size;
1009 return n;
1010 }
1011
1012 return -EINVAL;
1013}
1014
1015power_attr(image_size);
1016
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001017static ssize_t reserved_size_show(struct kobject *kobj,
1018 struct kobj_attribute *attr, char *buf)
1019{
1020 return sprintf(buf, "%lu\n", reserved_size);
1021}
1022
1023static ssize_t reserved_size_store(struct kobject *kobj,
1024 struct kobj_attribute *attr,
1025 const char *buf, size_t n)
1026{
1027 unsigned long size;
1028
1029 if (sscanf(buf, "%lu", &size) == 1) {
1030 reserved_size = size;
1031 return n;
1032 }
1033
1034 return -EINVAL;
1035}
1036
1037power_attr(reserved_size);
1038
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039static struct attribute * g[] = {
1040 &disk_attr.attr,
1041 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001042 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001043 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 NULL,
1045};
1046
1047
1048static struct attribute_group attr_group = {
1049 .attrs = g,
1050};
1051
1052
1053static int __init pm_disk_init(void)
1054{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001055 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056}
1057
1058core_initcall(pm_disk_init);
1059
1060
1061static int __init resume_setup(char *str)
1062{
1063 if (noresume)
1064 return 1;
1065
1066 strncpy( resume_file, str, 255 );
1067 return 1;
1068}
1069
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001070static int __init resume_offset_setup(char *str)
1071{
1072 unsigned long long offset;
1073
1074 if (noresume)
1075 return 1;
1076
1077 if (sscanf(str, "%llu", &offset) == 1)
1078 swsusp_resume_block = offset;
1079
1080 return 1;
1081}
1082
Bojan Smojverf996fc92010-09-09 23:06:23 +02001083static int __init hibernate_setup(char *str)
1084{
1085 if (!strncmp(str, "noresume", 8))
1086 noresume = 1;
1087 else if (!strncmp(str, "nocompress", 10))
1088 nocompress = 1;
1089 return 1;
1090}
1091
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092static int __init noresume_setup(char *str)
1093{
1094 noresume = 1;
1095 return 1;
1096}
1097
Barry Song6f8d7022011-10-06 20:34:46 +02001098static int __init resumewait_setup(char *str)
1099{
1100 resume_wait = 1;
1101 return 1;
1102}
1103
Barry Songf126f732011-10-10 23:38:41 +02001104static int __init resumedelay_setup(char *str)
1105{
1106 resume_delay = simple_strtoul(str, NULL, 0);
1107 return 1;
1108}
1109
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001111__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001113__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001114__setup("resumewait", resumewait_setup);
Barry Songf126f732011-10-10 23:38:41 +02001115__setup("resumedelay=", resumedelay_setup);