blob: 0f8785080cde7b75162b2d302cc179811172aaf4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02002 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
Pavel Macheka2531292010-07-18 14:27:13 +02006 * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02007 * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11
12#include <linux/suspend.h>
13#include <linux/syscalls.h>
14#include <linux/reboot.h>
15#include <linux/string.h>
16#include <linux/device.h>
Barry Song6f8d7022011-10-06 20:34:46 +020017#include <linux/async.h>
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -070018#include <linux/kmod.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/delay.h>
20#include <linux/fs.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070021#include <linux/mount.h>
Eric W. Biederman88d10bb2005-09-22 21:43:46 -070022#include <linux/pm.h>
Rafael J. Wysocki97c78012006-10-11 01:20:45 -070023#include <linux/console.h>
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -070024#include <linux/cpu.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080025#include <linux/freezer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090026#include <linux/gfp.h>
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +010027#include <linux/syscore_ops.h>
Rafael J. Wysockic7510852009-04-12 20:06:56 +020028#include <scsi/scsi_scan.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include "power.h"
31
32
Bojan Smojverf996fc92010-09-09 23:06:23 +020033static int nocompress = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034static int noresume = 0;
Barry Song6f8d7022011-10-06 20:34:46 +020035static int resume_wait = 0;
Adrian Bunk47a460d2008-02-04 22:30:06 -080036static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080038sector_t swsusp_resume_block;
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +010039int in_suspend __nosavedata = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070041enum {
42 HIBERNATION_INVALID,
43 HIBERNATION_PLATFORM,
44 HIBERNATION_TEST,
45 HIBERNATION_TESTPROC,
46 HIBERNATION_SHUTDOWN,
47 HIBERNATION_REBOOT,
48 /* keep last */
49 __HIBERNATION_AFTER_LAST
50};
51#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
52#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
53
54static int hibernation_mode = HIBERNATION_SHUTDOWN;
55
Lionel Debroux073ef1f2010-11-09 21:48:49 +010056static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070057
58/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020059 * hibernation_set_ops - Set the global hibernate operations.
60 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070061 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010062void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070063{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010064 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
65 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010066 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070067 WARN_ON(1);
68 return;
69 }
70 mutex_lock(&pm_mutex);
71 hibernation_ops = ops;
72 if (ops)
73 hibernation_mode = HIBERNATION_PLATFORM;
74 else if (hibernation_mode == HIBERNATION_PLATFORM)
75 hibernation_mode = HIBERNATION_SHUTDOWN;
76
77 mutex_unlock(&pm_mutex);
78}
79
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010080static bool entering_platform_hibernation;
81
82bool system_entering_hibernation(void)
83{
84 return entering_platform_hibernation;
85}
86EXPORT_SYMBOL(system_entering_hibernation);
87
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010088#ifdef CONFIG_PM_DEBUG
89static void hibernation_debug_sleep(void)
90{
91 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
92 mdelay(5000);
93}
94
95static int hibernation_testmode(int mode)
96{
97 if (hibernation_mode == mode) {
98 hibernation_debug_sleep();
99 return 1;
100 }
101 return 0;
102}
103
104static int hibernation_test(int level)
105{
106 if (pm_test_level == level) {
107 hibernation_debug_sleep();
108 return 1;
109 }
110 return 0;
111}
112#else /* !CONFIG_PM_DEBUG */
113static int hibernation_testmode(int mode) { return 0; }
114static int hibernation_test(int level) { return 0; }
115#endif /* !CONFIG_PM_DEBUG */
116
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700117/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200118 * platform_begin - Call platform to start hibernation.
119 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700120 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100121static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700122{
123 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100124 hibernation_ops->begin() : 0;
125}
126
127/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200128 * platform_end - Call platform to finish transition to the working state.
129 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100130 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100131static void platform_end(int platform_mode)
132{
133 if (platform_mode && hibernation_ops)
134 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700135}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200138 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
139 * @platform_mode: Whether or not to use the platform driver.
140 *
141 * Use the platform driver to prepare the system for creating a hibernate image,
142 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800143 */
144
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700145static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800146{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700147 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700148 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800149}
150
151/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200152 * platform_leave - Call platform to prepare a transition to the working state.
153 * @platform_mode: Whether or not to use the platform driver.
154 *
155 * Use the platform driver prepare to prepare the machine for switching to the
156 * normal mode of operation.
157 *
158 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700159 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700160static void platform_leave(int platform_mode)
161{
162 if (platform_mode && hibernation_ops)
163 hibernation_ops->leave();
164}
165
166/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200167 * platform_finish - Call platform to switch the system to the working state.
168 * @platform_mode: Whether or not to use the platform driver.
169 *
170 * Use the platform driver to switch the machine to the normal mode of
171 * operation.
172 *
173 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700174 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700175static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700176{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700177 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700178 hibernation_ops->finish();
179}
180
181/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200182 * platform_pre_restore - Prepare for hibernate image restoration.
183 * @platform_mode: Whether or not to use the platform driver.
184 *
185 * Use the platform driver to prepare the system for resume from a hibernation
186 * image.
187 *
188 * If the restore fails after this function has been called,
189 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700190 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700191static int platform_pre_restore(int platform_mode)
192{
193 return (platform_mode && hibernation_ops) ?
194 hibernation_ops->pre_restore() : 0;
195}
196
197/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200198 * platform_restore_cleanup - Switch to the working state after failing restore.
199 * @platform_mode: Whether or not to use the platform driver.
200 *
201 * Use the platform driver to switch the system to the normal mode of operation
202 * after a failing restore.
203 *
204 * If platform_pre_restore() has been called before the failing restore, this
205 * function must be called too, regardless of the result of
206 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700207 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700208static void platform_restore_cleanup(int platform_mode)
209{
210 if (platform_mode && hibernation_ops)
211 hibernation_ops->restore_cleanup();
212}
213
214/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200215 * platform_recover - Recover from a failure to suspend devices.
216 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200217 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200218static void platform_recover(int platform_mode)
219{
220 if (platform_mode && hibernation_ops && hibernation_ops->recover)
221 hibernation_ops->recover();
222}
223
224/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200225 * swsusp_show_speed - Print time elapsed between two events during hibernation.
226 * @start: Starting event.
227 * @stop: Final event.
228 * @nr_pages: Number of memory pages processed between @start and @stop.
229 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100230 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100231void swsusp_show_speed(struct timeval *start, struct timeval *stop,
232 unsigned nr_pages, char *msg)
233{
234 s64 elapsed_centisecs64;
235 int centisecs;
236 int k;
237 int kps;
238
239 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
240 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
241 centisecs = elapsed_centisecs64;
242 if (centisecs == 0)
243 centisecs = 1; /* avoid div-by-zero */
244 k = nr_pages * (PAGE_SIZE / 1024);
245 kps = (k * 100) / centisecs;
246 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
247 msg, k,
248 centisecs / 100, centisecs % 100,
249 kps / 1000, (kps % 1000) / 10);
250}
251
252/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200253 * create_image - Create a hibernation image.
254 * @platform_mode: Whether or not to use the platform driver.
255 *
256 * Execute device drivers' .freeze_noirq() callbacks, create a hibernation image
257 * and execute the drivers' .thaw_noirq() callbacks.
258 *
259 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700260 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800261static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700262{
263 int error;
264
Alan Sternd1616302009-05-24 22:05:42 +0200265 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700266 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100267 printk(KERN_ERR "PM: Some devices failed to power down, "
268 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200269 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700270 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100271
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100272 error = platform_pre_snapshot(platform_mode);
273 if (error || hibernation_test(TEST_PLATFORM))
274 goto Platform_finish;
275
276 error = disable_nonboot_cpus();
277 if (error || hibernation_test(TEST_CPUS)
278 || hibernation_testmode(HIBERNATION_TEST))
279 goto Enable_cpus;
280
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100281 local_irq_disable();
282
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200283 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100284 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200285 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100286 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100287 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100288 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700289
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100290 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100291 goto Power_up;
292
293 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700294 save_processor_state();
295 error = swsusp_arch_suspend();
296 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100297 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
298 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700299 /* Restore control flow magically appears here */
300 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200301 if (!in_suspend) {
302 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700303 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200304 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100305
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100306 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100307 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100308
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100309 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100310 local_irq_enable();
311
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100312 Enable_cpus:
313 enable_nonboot_cpus();
314
315 Platform_finish:
316 platform_finish(platform_mode);
317
Alan Sternd1616302009-05-24 22:05:42 +0200318 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200319 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100320
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700321 return error;
322}
323
324/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200325 * hibernation_snapshot - Quiesce devices and create a hibernation image.
326 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700327 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200328 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700329 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700330int hibernation_snapshot(int platform_mode)
331{
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200332 pm_message_t msg = PMSG_RECOVER;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100333 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700334
Zhang Rui3fe03132008-10-26 20:50:26 +0100335 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700336 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200337 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700338
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200339 /* Preallocate image memory before shutting down devices. */
340 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700341 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200342 goto Close;
343
344 error = freeze_kernel_threads();
345 if (error)
346 goto Close;
347
348 error = dpm_prepare(PMSG_FREEZE);
349 if (error)
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200350 goto Complete_devices;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700351
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700352 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100353 pm_restrict_gfp_mask();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200354 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700355 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200356 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700357
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100358 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200359 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700360
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100361 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100362 /*
363 * Control returns here (1) after the image has been created or the
364 * image creation has failed and (2) after a successful restore.
365 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100366
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100367 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200368 /* We may need to release the preallocated image pages here. */
369 if (error || !in_suspend)
370 swsusp_free();
371
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200372 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
373 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100374
375 if (error || !in_suspend)
376 pm_restore_gfp_mask();
377
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700378 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200379
380 Complete_devices:
381 dpm_complete(msg);
382
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100383 Close:
384 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700385 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200386
387 Recover_platform:
388 platform_recover(platform_mode);
389 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700390}
391
392/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200393 * resume_target_kernel - Restore system state from a hibernation image.
394 * @platform_mode: Whether or not to use the platform driver.
395 *
396 * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
397 * highmem that have not been restored yet from the image and run the low-level
398 * code that will restore the remaining contents of memory and switch to the
399 * just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100400 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100401static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100402{
403 int error;
404
Alan Sternd1616302009-05-24 22:05:42 +0200405 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100406 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100407 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100408 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200409 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100410 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100411
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100412 error = platform_pre_restore(platform_mode);
413 if (error)
414 goto Cleanup;
415
416 error = disable_nonboot_cpus();
417 if (error)
418 goto Enable_cpus;
419
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100420 local_irq_disable();
421
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200422 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100423 if (error)
424 goto Enable_irqs;
425
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100426 save_processor_state();
427 error = restore_highmem();
428 if (!error) {
429 error = swsusp_arch_resume();
430 /*
431 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200432 * Otherwise, execution continues at the place where
433 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100434 */
435 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200436 /*
437 * This call to restore_highmem() reverts the changes made by
438 * the previous one.
439 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100440 restore_highmem();
441 }
442 /*
443 * The only reason why swsusp_arch_resume() can fail is memory being
444 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200445 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100446 */
447 swsusp_free();
448 restore_processor_state();
449 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100450
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100451 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100452
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100453 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100454 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100455
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100456 Enable_cpus:
457 enable_nonboot_cpus();
458
459 Cleanup:
460 platform_restore_cleanup(platform_mode);
461
Alan Sternd1616302009-05-24 22:05:42 +0200462 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100463
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100464 return error;
465}
466
467/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200468 * hibernation_restore - Quiesce devices and restore from a hibernation image.
469 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700470 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200471 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200472 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700473 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700474int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700475{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100476 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700477
478 pm_prepare_console();
479 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100480 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200481 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700482 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100483 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200484 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700485 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100486 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700487 resume_console();
488 pm_restore_console();
489 return error;
490}
491
492/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200493 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700494 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700495int hibernation_platform_enter(void)
496{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100497 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700498
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700499 if (!hibernation_ops)
500 return -ENOSYS;
501
502 /*
503 * We have cancelled the power transition by running
504 * hibernation_ops->finish() before saving the image, so we should let
505 * the firmware know that we're going to enter the sleep state after all
506 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100507 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700508 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100509 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700510
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100511 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700512 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200513 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200514 if (error) {
515 if (hibernation_ops->recover)
516 hibernation_ops->recover();
517 goto Resume_devices;
518 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700519
Alan Sternd1616302009-05-24 22:05:42 +0200520 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100521 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200522 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100523
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100524 error = hibernation_ops->prepare();
525 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200526 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100527
528 error = disable_nonboot_cpus();
529 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200530 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100531
532 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100533 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100534 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200535 error = -EAGAIN;
536 goto Power_up;
537 }
538
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100539 hibernation_ops->enter();
540 /* We should never get here */
541 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700542
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200543 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100544 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200545 local_irq_enable();
546 enable_nonboot_cpus();
547
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200548 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700549 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100550
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200551 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100552
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700553 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100554 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200555 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700556 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100557
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100558 Close:
559 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100560
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700561 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700562}
563
564/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200565 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200567 * Use the platform driver, if configured, to put the system into the sleep
568 * state corresponding to hibernation, or try to power it off or reboot,
569 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 */
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700571static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700573 switch (hibernation_mode) {
574 case HIBERNATION_TEST:
575 case HIBERNATION_TESTPROC:
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700576 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700577 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600578 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700580 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700581 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700582 case HIBERNATION_SHUTDOWN:
583 kernel_power_off();
584 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600586 kernel_halt();
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700587 /*
588 * Valid image is on the disk, if we continue we risk serious data
589 * corruption after resume.
590 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100591 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 while(1);
593}
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595static int prepare_processes(void)
596{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800597 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 if (freeze_processes()) {
600 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100601 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700603 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604}
605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200607 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700609int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
611 int error;
612
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700613 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700614 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700615 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
616 error = -EBUSY;
617 goto Unlock;
618 }
619
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100620 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700621 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
622 if (error)
623 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700624
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700625 error = usermodehelper_disable();
626 if (error)
627 goto Exit;
628
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700629 /* Allocate memory management structures */
630 error = create_basic_memory_bitmaps();
631 if (error)
632 goto Exit;
633
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100634 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700635 sys_sync();
636 printk("done.\n");
637
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700639 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700640 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100642 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800643 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100644
645 if (hibernation_testmode(HIBERNATION_TESTPROC))
646 goto Thaw;
647
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700648 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200649 if (error)
650 goto Thaw;
651
652 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700653 unsigned int flags = 0;
654
655 if (hibernation_mode == HIBERNATION_PLATFORM)
656 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200657 if (nocompress)
658 flags |= SF_NOCOMPRESS_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700660 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700661 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 if (!error)
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700663 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100664 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100665 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800666 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800668 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200669
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800670 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100671 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700672 Finish:
673 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700674 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700675 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700676 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100677 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700678 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700679 Unlock:
680 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 return error;
682}
683
684
685/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200686 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200688 * This routine is called as a late initcall, when all devices have been
689 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200691 * The image reading code is called to see if there is a hibernation image
692 * available for reading. If that is the case, devices are quiesced and the
693 * contents of memory is restored from the saved image.
694 *
695 * If this is successful, control reappears in the restored target kernel in
696 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
697 * attempts to recover gracefully and make the kernel return to the normal mode
698 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700static int software_resume(void)
701{
702 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700703 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Johannes Berg60a0d232007-11-14 17:00:16 -0800705 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100706 * If the user said "noresume".. bail out early.
707 */
708 if (noresume)
709 return 0;
710
711 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800712 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
713 * is configured into the kernel. Since the regular hibernate
714 * trigger path is via sysfs which takes a buffer mutex before
715 * calling hibernate functions (which take pm_mutex) this can
716 * cause lockdep to complain about a possible ABBA deadlock
717 * which cannot happen since we're in the boot code here and
718 * sysfs can't be invoked yet. Therefore, we use a subclass
719 * here to avoid lockdep complaining.
720 */
721 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200722
723 if (swsusp_resume_device)
724 goto Check_image;
725
726 if (!strlen(resume_file)) {
727 error = -ENOENT;
728 goto Unlock;
729 }
730
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200731 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200732
733 /* Check if the device is there */
734 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700735 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100736 /*
737 * Some device discovery might still be in progress; we need
738 * to wait for this to finish.
739 */
740 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200741
742 if (resume_wait) {
743 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
744 msleep(10);
745 async_synchronize_full();
746 }
747
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200748 /*
749 * We can't depend on SCSI devices being available after loading
750 * one of their modules until scsi_complete_async_scans() is
751 * called and the resume device usually is a SCSI one.
752 */
753 scsi_complete_async_scans();
754
Pavel Machek3efa1472005-07-07 17:56:43 -0700755 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200756 if (!swsusp_resume_device) {
757 error = -ENODEV;
758 goto Unlock;
759 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700760 }
761
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200762 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200763 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200764 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200766 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800767 error = swsusp_check();
768 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700769 goto Unlock;
770
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700771 /* The snapshot device should not be opened while we're running */
772 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
773 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200774 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700775 goto Unlock;
776 }
777
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100778 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100779 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
780 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200781 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100782
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700783 error = usermodehelper_disable();
784 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200785 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700786
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700787 error = create_basic_memory_bitmaps();
788 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200789 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
791 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800792 error = prepare_processes();
793 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400794 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700795 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 }
797
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200798 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700800 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200801 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800802 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700803 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200805 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700806 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100807 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700809 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700810 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700811 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100812 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100813 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700814 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700815 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700816 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800817 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200818 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700819 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200820close_finish:
821 swsusp_close(FMODE_READ);
822 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823}
824
825late_initcall(software_resume);
826
827
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700828static const char * const hibernation_modes[] = {
829 [HIBERNATION_PLATFORM] = "platform",
830 [HIBERNATION_SHUTDOWN] = "shutdown",
831 [HIBERNATION_REBOOT] = "reboot",
832 [HIBERNATION_TEST] = "test",
833 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834};
835
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200836/*
837 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200839 * Hibernation can be handled in several ways. There are a few different ways
840 * to put the system into the sleep state: using the platform driver (e.g. ACPI
841 * or other hibernation_ops), powering it off or rebooting it (for testing
842 * mostly), or using one of the two available test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200844 * The sysfs file /sys/power/disk provides an interface for selecting the
845 * hibernation mode to use. Reading from this file causes the available modes
846 * to be printed. There are 5 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 * 'platform'
849 * 'shutdown'
850 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700851 * 'test'
852 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200854 * If a platform hibernation driver is in use, 'platform' will be supported
855 * and will be used by default. Otherwise, 'shutdown' will be used by default.
856 * The selected option (i.e. the one corresponding to the current value of
857 * hibernation_mode) is enclosed by a square bracket.
858 *
859 * To select a given hibernation mode it is necessary to write the mode's
860 * string representation (as returned by reading from /sys/power/disk) back
861 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 */
863
Kay Sievers386f2752007-11-02 13:47:53 +0100864static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
865 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700867 int i;
868 char *start = buf;
869
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700870 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
871 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700872 continue;
873 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700874 case HIBERNATION_SHUTDOWN:
875 case HIBERNATION_REBOOT:
876 case HIBERNATION_TEST:
877 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700878 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700879 case HIBERNATION_PLATFORM:
880 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700881 break;
882 /* not a valid mode, continue with loop */
883 continue;
884 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700885 if (i == hibernation_mode)
886 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700887 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700888 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700889 }
890 buf += sprintf(buf, "\n");
891 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892}
893
Kay Sievers386f2752007-11-02 13:47:53 +0100894static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
895 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896{
897 int error = 0;
898 int i;
899 int len;
900 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700901 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
903 p = memchr(buf, '\n', n);
904 len = p ? p - buf : n;
905
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800906 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700907 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700908 if (len == strlen(hibernation_modes[i])
909 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 mode = i;
911 break;
912 }
913 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700914 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700915 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700916 case HIBERNATION_SHUTDOWN:
917 case HIBERNATION_REBOOT:
918 case HIBERNATION_TEST:
919 case HIBERNATION_TESTPROC:
920 hibernation_mode = mode;
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700921 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700922 case HIBERNATION_PLATFORM:
923 if (hibernation_ops)
924 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 else
926 error = -EINVAL;
927 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700928 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 error = -EINVAL;
930
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700931 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100932 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700933 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800934 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 return error ? error : n;
936}
937
938power_attr(disk);
939
Kay Sievers386f2752007-11-02 13:47:53 +0100940static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
941 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942{
943 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
944 MINOR(swsusp_resume_device));
945}
946
Kay Sievers386f2752007-11-02 13:47:53 +0100947static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
948 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800952 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
Andrew Mortona5762192006-01-06 00:09:50 -0800954 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
955 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
Andrew Mortona5762192006-01-06 00:09:50 -0800957 res = MKDEV(maj,min);
958 if (maj != MAJOR(res) || min != MINOR(res))
959 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800961 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800962 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800963 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100964 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800965 noresume = 0;
966 software_resume();
967 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800968 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800969 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970}
971
972power_attr(resume);
973
Kay Sievers386f2752007-11-02 13:47:53 +0100974static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
975 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800976{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800977 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800978}
979
Kay Sievers386f2752007-11-02 13:47:53 +0100980static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
981 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800982{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800983 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800984
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800985 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800986 image_size = size;
987 return n;
988 }
989
990 return -EINVAL;
991}
992
993power_attr(image_size);
994
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +0200995static ssize_t reserved_size_show(struct kobject *kobj,
996 struct kobj_attribute *attr, char *buf)
997{
998 return sprintf(buf, "%lu\n", reserved_size);
999}
1000
1001static ssize_t reserved_size_store(struct kobject *kobj,
1002 struct kobj_attribute *attr,
1003 const char *buf, size_t n)
1004{
1005 unsigned long size;
1006
1007 if (sscanf(buf, "%lu", &size) == 1) {
1008 reserved_size = size;
1009 return n;
1010 }
1011
1012 return -EINVAL;
1013}
1014
1015power_attr(reserved_size);
1016
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017static struct attribute * g[] = {
1018 &disk_attr.attr,
1019 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001020 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001021 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 NULL,
1023};
1024
1025
1026static struct attribute_group attr_group = {
1027 .attrs = g,
1028};
1029
1030
1031static int __init pm_disk_init(void)
1032{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001033 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034}
1035
1036core_initcall(pm_disk_init);
1037
1038
1039static int __init resume_setup(char *str)
1040{
1041 if (noresume)
1042 return 1;
1043
1044 strncpy( resume_file, str, 255 );
1045 return 1;
1046}
1047
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001048static int __init resume_offset_setup(char *str)
1049{
1050 unsigned long long offset;
1051
1052 if (noresume)
1053 return 1;
1054
1055 if (sscanf(str, "%llu", &offset) == 1)
1056 swsusp_resume_block = offset;
1057
1058 return 1;
1059}
1060
Bojan Smojverf996fc92010-09-09 23:06:23 +02001061static int __init hibernate_setup(char *str)
1062{
1063 if (!strncmp(str, "noresume", 8))
1064 noresume = 1;
1065 else if (!strncmp(str, "nocompress", 10))
1066 nocompress = 1;
1067 return 1;
1068}
1069
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070static int __init noresume_setup(char *str)
1071{
1072 noresume = 1;
1073 return 1;
1074}
1075
Barry Song6f8d7022011-10-06 20:34:46 +02001076static int __init resumewait_setup(char *str)
1077{
1078 resume_wait = 1;
1079 return 1;
1080}
1081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001083__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001085__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001086__setup("resumewait", resumewait_setup);