blob: 8b53db38a279e50a1fe3a8719752fe245201e7a0 [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>
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>
Minho Ban2df83fa2012-05-14 21:45:31 +020028#include <linux/ctype.h>
29#include <linux/genhd.h>
Rafael J. Wysockic7510852009-04-12 20:06:56 +020030#include <scsi/scsi_scan.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include "power.h"
33
34
Barry Songd231ff12011-10-11 23:29:18 -070035static int nocompress;
36static int noresume;
37static int resume_wait;
38static int resume_delay;
Adrian Bunk47a460d2008-02-04 22:30:06 -080039static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080041sector_t swsusp_resume_block;
Barry Songd231ff12011-10-11 23:29:18 -070042int in_suspend __nosavedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070044enum {
45 HIBERNATION_INVALID,
46 HIBERNATION_PLATFORM,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070047 HIBERNATION_SHUTDOWN,
48 HIBERNATION_REBOOT,
49 /* keep last */
50 __HIBERNATION_AFTER_LAST
51};
52#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
53#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
54
55static int hibernation_mode = HIBERNATION_SHUTDOWN;
56
Srivatsa S. Bhat97819a22011-12-01 22:33:10 +010057bool freezer_test_done;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +010058
Lionel Debroux073ef1f2010-11-09 21:48:49 +010059static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070060
61/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020062 * hibernation_set_ops - Set the global hibernate operations.
63 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070064 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010065void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070066{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010067 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
68 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010069 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070070 WARN_ON(1);
71 return;
72 }
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +010073 lock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070074 hibernation_ops = ops;
75 if (ops)
76 hibernation_mode = HIBERNATION_PLATFORM;
77 else if (hibernation_mode == HIBERNATION_PLATFORM)
78 hibernation_mode = HIBERNATION_SHUTDOWN;
79
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +010080 unlock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070081}
82
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010083static bool entering_platform_hibernation;
84
85bool system_entering_hibernation(void)
86{
87 return entering_platform_hibernation;
88}
89EXPORT_SYMBOL(system_entering_hibernation);
90
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010091#ifdef CONFIG_PM_DEBUG
92static void hibernation_debug_sleep(void)
93{
94 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
95 mdelay(5000);
96}
97
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010098static int hibernation_test(int level)
99{
100 if (pm_test_level == level) {
101 hibernation_debug_sleep();
102 return 1;
103 }
104 return 0;
105}
106#else /* !CONFIG_PM_DEBUG */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100107static int hibernation_test(int level) { return 0; }
108#endif /* !CONFIG_PM_DEBUG */
109
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700110/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200111 * platform_begin - Call platform to start hibernation.
112 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700113 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100114static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700115{
116 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100117 hibernation_ops->begin() : 0;
118}
119
120/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200121 * platform_end - Call platform to finish transition to the working state.
122 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100123 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100124static void platform_end(int platform_mode)
125{
126 if (platform_mode && hibernation_ops)
127 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700128}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200131 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
132 * @platform_mode: Whether or not to use the platform driver.
133 *
134 * Use the platform driver to prepare the system for creating a hibernate image,
135 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800136 */
137
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700138static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800139{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700140 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700141 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800142}
143
144/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200145 * platform_leave - Call platform to prepare a transition to the working state.
146 * @platform_mode: Whether or not to use the platform driver.
147 *
148 * Use the platform driver prepare to prepare the machine for switching to the
149 * normal mode of operation.
150 *
151 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700152 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700153static void platform_leave(int platform_mode)
154{
155 if (platform_mode && hibernation_ops)
156 hibernation_ops->leave();
157}
158
159/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200160 * platform_finish - Call platform to switch the system to the working state.
161 * @platform_mode: Whether or not to use the platform driver.
162 *
163 * Use the platform driver to switch the machine to the normal mode of
164 * operation.
165 *
166 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700167 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700168static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700169{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700170 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700171 hibernation_ops->finish();
172}
173
174/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200175 * platform_pre_restore - Prepare for hibernate image restoration.
176 * @platform_mode: Whether or not to use the platform driver.
177 *
178 * Use the platform driver to prepare the system for resume from a hibernation
179 * image.
180 *
181 * If the restore fails after this function has been called,
182 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700183 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700184static int platform_pre_restore(int platform_mode)
185{
186 return (platform_mode && hibernation_ops) ?
187 hibernation_ops->pre_restore() : 0;
188}
189
190/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200191 * platform_restore_cleanup - Switch to the working state after failing restore.
192 * @platform_mode: Whether or not to use the platform driver.
193 *
194 * Use the platform driver to switch the system to the normal mode of operation
195 * after a failing restore.
196 *
197 * If platform_pre_restore() has been called before the failing restore, this
198 * function must be called too, regardless of the result of
199 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700200 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700201static void platform_restore_cleanup(int platform_mode)
202{
203 if (platform_mode && hibernation_ops)
204 hibernation_ops->restore_cleanup();
205}
206
207/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200208 * platform_recover - Recover from a failure to suspend devices.
209 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200210 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200211static void platform_recover(int platform_mode)
212{
213 if (platform_mode && hibernation_ops && hibernation_ops->recover)
214 hibernation_ops->recover();
215}
216
217/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200218 * swsusp_show_speed - Print time elapsed between two events during hibernation.
219 * @start: Starting event.
220 * @stop: Final event.
221 * @nr_pages: Number of memory pages processed between @start and @stop.
222 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100223 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100224void swsusp_show_speed(struct timeval *start, struct timeval *stop,
225 unsigned nr_pages, char *msg)
226{
227 s64 elapsed_centisecs64;
228 int centisecs;
229 int k;
230 int kps;
231
232 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
233 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
234 centisecs = elapsed_centisecs64;
235 if (centisecs == 0)
236 centisecs = 1; /* avoid div-by-zero */
237 k = nr_pages * (PAGE_SIZE / 1024);
238 kps = (k * 100) / centisecs;
239 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
240 msg, k,
241 centisecs / 100, centisecs % 100,
242 kps / 1000, (kps % 1000) / 10);
243}
244
245/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200246 * create_image - Create a hibernation image.
247 * @platform_mode: Whether or not to use the platform driver.
248 *
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100249 * Execute device drivers' "late" and "noirq" freeze callbacks, create a
250 * hibernation image and run the drivers' "noirq" and "early" thaw callbacks.
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200251 *
252 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700253 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800254static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700255{
256 int error;
257
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100258 error = dpm_suspend_end(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700259 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100260 printk(KERN_ERR "PM: Some devices failed to power down, "
261 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200262 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700263 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100264
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100265 error = platform_pre_snapshot(platform_mode);
266 if (error || hibernation_test(TEST_PLATFORM))
267 goto Platform_finish;
268
269 error = disable_nonboot_cpus();
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100270 if (error || hibernation_test(TEST_CPUS))
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100271 goto Enable_cpus;
272
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100273 local_irq_disable();
274
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200275 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100276 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200277 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100278 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100279 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100280 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700281
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100282 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100283 goto Power_up;
284
285 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700286 save_processor_state();
287 error = swsusp_arch_suspend();
288 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100289 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
290 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700291 /* Restore control flow magically appears here */
292 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200293 if (!in_suspend) {
294 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700295 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200296 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100297
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100298 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100299 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100300
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100301 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100302 local_irq_enable();
303
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100304 Enable_cpus:
305 enable_nonboot_cpus();
306
307 Platform_finish:
308 platform_finish(platform_mode);
309
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100310 dpm_resume_start(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200311 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100312
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700313 return error;
314}
315
316/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200317 * hibernation_snapshot - Quiesce devices and create a hibernation image.
318 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700319 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200320 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700321 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700322int hibernation_snapshot(int platform_mode)
323{
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100324 pm_message_t msg;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100325 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700326
Zhang Rui3fe03132008-10-26 20:50:26 +0100327 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700328 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200329 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700330
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200331 /* Preallocate image memory before shutting down devices. */
332 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700333 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200334 goto Close;
335
336 error = freeze_kernel_threads();
337 if (error)
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100338 goto Cleanup;
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200339
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100340 if (hibernation_test(TEST_FREEZER)) {
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100341
342 /*
343 * Indicate to the caller that we are returning due to a
344 * successful freezer test.
345 */
346 freezer_test_done = true;
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100347 goto Thaw;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100348 }
349
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200350 error = dpm_prepare(PMSG_FREEZE);
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100351 if (error) {
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100352 dpm_complete(PMSG_RECOVER);
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100353 goto Thaw;
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100354 }
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700355
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700356 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100357 pm_restrict_gfp_mask();
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100358
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200359 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700360
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100361 if (error || hibernation_test(TEST_DEVICES))
362 platform_recover(platform_mode);
363 else
364 error = create_image(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700365
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100366 /*
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100367 * In the case that we call create_image() above, the control
368 * returns here (1) after the image has been created or the
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100369 * image creation has failed and (2) after a successful restore.
370 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100371
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200372 /* We may need to release the preallocated image pages here. */
373 if (error || !in_suspend)
374 swsusp_free();
375
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200376 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
377 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100378
379 if (error || !in_suspend)
380 pm_restore_gfp_mask();
381
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700382 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200383 dpm_complete(msg);
384
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100385 Close:
386 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700387 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200388
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100389 Thaw:
390 thaw_kernel_threads();
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100391 Cleanup:
392 swsusp_free();
393 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700394}
395
396/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200397 * resume_target_kernel - Restore system state from a hibernation image.
398 * @platform_mode: Whether or not to use the platform driver.
399 *
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100400 * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
401 * contents of highmem that have not been restored yet from the image and run
402 * the low-level code that will restore the remaining contents of memory and
403 * switch to the just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100404 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100405static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100406{
407 int error;
408
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100409 error = dpm_suspend_end(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100410 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100411 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100412 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200413 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100414 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100415
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100416 error = platform_pre_restore(platform_mode);
417 if (error)
418 goto Cleanup;
419
420 error = disable_nonboot_cpus();
421 if (error)
422 goto Enable_cpus;
423
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100424 local_irq_disable();
425
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200426 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100427 if (error)
428 goto Enable_irqs;
429
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100430 save_processor_state();
431 error = restore_highmem();
432 if (!error) {
433 error = swsusp_arch_resume();
434 /*
435 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200436 * Otherwise, execution continues at the place where
437 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100438 */
439 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200440 /*
441 * This call to restore_highmem() reverts the changes made by
442 * the previous one.
443 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100444 restore_highmem();
445 }
446 /*
447 * The only reason why swsusp_arch_resume() can fail is memory being
448 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200449 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100450 */
451 swsusp_free();
452 restore_processor_state();
453 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100454
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100455 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100456
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100457 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100458 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100459
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100460 Enable_cpus:
461 enable_nonboot_cpus();
462
463 Cleanup:
464 platform_restore_cleanup(platform_mode);
465
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100466 dpm_resume_start(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100467
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100468 return error;
469}
470
471/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200472 * hibernation_restore - Quiesce devices and restore from a hibernation image.
473 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700474 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200475 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200476 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700477 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700478int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700479{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100480 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700481
482 pm_prepare_console();
483 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100484 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200485 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700486 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100487 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200488 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700489 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100490 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700491 resume_console();
492 pm_restore_console();
493 return error;
494}
495
496/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200497 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700498 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700499int hibernation_platform_enter(void)
500{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100501 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700502
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700503 if (!hibernation_ops)
504 return -ENOSYS;
505
506 /*
507 * We have cancelled the power transition by running
508 * hibernation_ops->finish() before saving the image, so we should let
509 * the firmware know that we're going to enter the sleep state after all
510 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100511 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700512 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100513 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700514
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100515 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700516 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200517 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200518 if (error) {
519 if (hibernation_ops->recover)
520 hibernation_ops->recover();
521 goto Resume_devices;
522 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700523
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100524 error = dpm_suspend_end(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100525 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200526 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100527
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100528 error = hibernation_ops->prepare();
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 error = disable_nonboot_cpus();
533 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200534 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100535
536 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100537 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100538 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200539 error = -EAGAIN;
540 goto Power_up;
541 }
542
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100543 hibernation_ops->enter();
544 /* We should never get here */
545 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700546
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200547 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100548 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200549 local_irq_enable();
550 enable_nonboot_cpus();
551
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200552 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700553 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100554
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100555 dpm_resume_start(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100556
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700557 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100558 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200559 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700560 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100561
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100562 Close:
563 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100564
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700565 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700566}
567
568/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200569 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200571 * Use the platform driver, if configured, to put the system into the sleep
572 * state corresponding to hibernation, or try to power it off or reboot,
573 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 */
Johannes Bergfe0c9352007-04-30 15:09:51 -0700575static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700577 switch (hibernation_mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700578 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600579 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700581 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700582 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700583 case HIBERNATION_SHUTDOWN:
584 kernel_power_off();
585 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600587 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700588 /*
589 * Valid image is on the disk, if we continue we risk serious data
590 * corruption after resume.
591 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100592 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 while(1);
594}
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200597 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700599int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600{
601 int error;
602
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100603 lock_system_sleep();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700604 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700605 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
606 error = -EBUSY;
607 goto Unlock;
608 }
609
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100610 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700611 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
612 if (error)
613 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700614
615 /* Allocate memory management structures */
616 error = create_basic_memory_bitmaps();
617 if (error)
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200618 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700619
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100620 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700621 sys_sync();
622 printk("done.\n");
623
Tejun Heo03afed82011-11-21 12:32:24 -0800624 error = freeze_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700625 if (error)
Srivatsa S. Bhat05b48772012-02-17 23:39:51 +0100626 goto Free_bitmaps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700628 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Srivatsa S. Bhata556d5b52012-02-04 23:39:56 +0100629 if (error || freezer_test_done)
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200630 goto Thaw;
631
632 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700633 unsigned int flags = 0;
634
635 if (hibernation_mode == HIBERNATION_PLATFORM)
636 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200637 if (nocompress)
638 flags |= SF_NOCOMPRESS_MODE;
Bojan Smojver081a9d02011-10-13 23:58:07 +0200639 else
640 flags |= SF_CRC32_MODE;
641
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700643 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700644 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700646 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100647 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100648 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800649 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800651 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200652
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800653 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100654 thaw_processes();
Srivatsa S. Bhata556d5b52012-02-04 23:39:56 +0100655
656 /* Don't bother checking whether freezer_test_done is true */
657 freezer_test_done = false;
658
Srivatsa S. Bhat05b48772012-02-17 23:39:51 +0100659 Free_bitmaps:
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200660 free_basic_memory_bitmaps();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700661 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700662 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100663 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700664 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700665 Unlock:
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100666 unlock_system_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 return error;
668}
669
670
671/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200672 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200674 * This routine is called as a late initcall, when all devices have been
675 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200677 * The image reading code is called to see if there is a hibernation image
678 * available for reading. If that is the case, devices are quiesced and the
679 * contents of memory is restored from the saved image.
680 *
681 * If this is successful, control reappears in the restored target kernel in
682 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
683 * attempts to recover gracefully and make the kernel return to the normal mode
684 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686static int software_resume(void)
687{
688 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700689 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Johannes Berg60a0d232007-11-14 17:00:16 -0800691 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100692 * If the user said "noresume".. bail out early.
693 */
694 if (noresume)
695 return 0;
696
697 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800698 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
699 * is configured into the kernel. Since the regular hibernate
700 * trigger path is via sysfs which takes a buffer mutex before
701 * calling hibernate functions (which take pm_mutex) this can
702 * cause lockdep to complain about a possible ABBA deadlock
703 * which cannot happen since we're in the boot code here and
704 * sysfs can't be invoked yet. Therefore, we use a subclass
705 * here to avoid lockdep complaining.
706 */
707 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200708
709 if (swsusp_resume_device)
710 goto Check_image;
711
712 if (!strlen(resume_file)) {
713 error = -ENOENT;
714 goto Unlock;
715 }
716
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200717 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200718
Barry Songf126f732011-10-10 23:38:41 +0200719 if (resume_delay) {
720 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
721 resume_delay);
722 ssleep(resume_delay);
723 }
724
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200725 /* Check if the device is there */
726 swsusp_resume_device = name_to_dev_t(resume_file);
Minho Ban2df83fa2012-05-14 21:45:31 +0200727
728 /*
729 * name_to_dev_t is ineffective to verify parition if resume_file is in
730 * integer format. (e.g. major:minor)
731 */
732 if (isdigit(resume_file[0]) && resume_wait) {
733 int partno;
734 while (!get_gendisk(swsusp_resume_device, &partno))
735 msleep(10);
736 }
737
Pavel Machek3efa1472005-07-07 17:56:43 -0700738 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100739 /*
740 * Some device discovery might still be in progress; we need
741 * to wait for this to finish.
742 */
743 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200744
745 if (resume_wait) {
746 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
747 msleep(10);
748 async_synchronize_full();
749 }
750
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200751 /*
752 * We can't depend on SCSI devices being available after loading
753 * one of their modules until scsi_complete_async_scans() is
754 * called and the resume device usually is a SCSI one.
755 */
756 scsi_complete_async_scans();
757
Pavel Machek3efa1472005-07-07 17:56:43 -0700758 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200759 if (!swsusp_resume_device) {
760 error = -ENODEV;
761 goto Unlock;
762 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700763 }
764
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200765 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200766 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200767 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200769 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800770 error = swsusp_check();
771 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700772 goto Unlock;
773
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700774 /* The snapshot device should not be opened while we're running */
775 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
776 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200777 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700778 goto Unlock;
779 }
780
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100781 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100782 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
783 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200784 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100785
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200786 error = create_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700787 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200788 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 pr_debug("PM: Preparing processes for restore.\n");
Tejun Heo03afed82011-11-21 12:32:24 -0800791 error = freeze_processes();
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800792 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400793 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700794 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 }
796
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200797 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700799 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200800 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800801 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700802 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200804 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700805 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100806 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 Done:
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200808 free_basic_memory_bitmaps();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700809 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100810 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100811 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700812 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700813 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700814 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800815 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200816 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700817 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200818close_finish:
819 swsusp_close(FMODE_READ);
820 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821}
822
823late_initcall(software_resume);
824
825
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700826static const char * const hibernation_modes[] = {
827 [HIBERNATION_PLATFORM] = "platform",
828 [HIBERNATION_SHUTDOWN] = "shutdown",
829 [HIBERNATION_REBOOT] = "reboot",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830};
831
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200832/*
833 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200835 * Hibernation can be handled in several ways. There are a few different ways
836 * to put the system into the sleep state: using the platform driver (e.g. ACPI
837 * or other hibernation_ops), powering it off or rebooting it (for testing
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100838 * mostly).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200840 * The sysfs file /sys/power/disk provides an interface for selecting the
841 * hibernation mode to use. Reading from this file causes the available modes
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100842 * to be printed. There are 3 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 * 'platform'
845 * 'shutdown'
846 * 'reboot'
847 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200848 * If a platform hibernation driver is in use, 'platform' will be supported
849 * and will be used by default. Otherwise, 'shutdown' will be used by default.
850 * The selected option (i.e. the one corresponding to the current value of
851 * hibernation_mode) is enclosed by a square bracket.
852 *
853 * To select a given hibernation mode it is necessary to write the mode's
854 * string representation (as returned by reading from /sys/power/disk) back
855 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 */
857
Kay Sievers386f2752007-11-02 13:47:53 +0100858static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
859 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700861 int i;
862 char *start = buf;
863
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700864 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
865 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700866 continue;
867 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700868 case HIBERNATION_SHUTDOWN:
869 case HIBERNATION_REBOOT:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700870 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700871 case HIBERNATION_PLATFORM:
872 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700873 break;
874 /* not a valid mode, continue with loop */
875 continue;
876 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700877 if (i == hibernation_mode)
878 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700879 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700880 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700881 }
882 buf += sprintf(buf, "\n");
883 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884}
885
Kay Sievers386f2752007-11-02 13:47:53 +0100886static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
887 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
889 int error = 0;
890 int i;
891 int len;
892 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700893 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894
895 p = memchr(buf, '\n', n);
896 len = p ? p - buf : n;
897
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100898 lock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700899 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700900 if (len == strlen(hibernation_modes[i])
901 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 mode = i;
903 break;
904 }
905 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700906 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700907 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700908 case HIBERNATION_SHUTDOWN:
909 case HIBERNATION_REBOOT:
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700910 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700911 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700912 case HIBERNATION_PLATFORM:
913 if (hibernation_ops)
914 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 else
916 error = -EINVAL;
917 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700918 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 error = -EINVAL;
920
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700921 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100922 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700923 hibernation_modes[mode]);
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100924 unlock_system_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 return error ? error : n;
926}
927
928power_attr(disk);
929
Kay Sievers386f2752007-11-02 13:47:53 +0100930static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
931 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932{
933 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
934 MINOR(swsusp_resume_device));
935}
936
Kay Sievers386f2752007-11-02 13:47:53 +0100937static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
938 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800942 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
Andrew Mortona5762192006-01-06 00:09:50 -0800944 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
945 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
Andrew Mortona5762192006-01-06 00:09:50 -0800947 res = MKDEV(maj,min);
948 if (maj != MAJOR(res) || min != MINOR(res))
949 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100951 lock_system_sleep();
Andrew Mortona5762192006-01-06 00:09:50 -0800952 swsusp_resume_device = res;
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100953 unlock_system_sleep();
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100954 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800955 noresume = 0;
956 software_resume();
957 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800958 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800959 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960}
961
962power_attr(resume);
963
Kay Sievers386f2752007-11-02 13:47:53 +0100964static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
965 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800966{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800967 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800968}
969
Kay Sievers386f2752007-11-02 13:47:53 +0100970static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
971 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800972{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800973 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800974
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800975 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800976 image_size = size;
977 return n;
978 }
979
980 return -EINVAL;
981}
982
983power_attr(image_size);
984
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +0200985static ssize_t reserved_size_show(struct kobject *kobj,
986 struct kobj_attribute *attr, char *buf)
987{
988 return sprintf(buf, "%lu\n", reserved_size);
989}
990
991static ssize_t reserved_size_store(struct kobject *kobj,
992 struct kobj_attribute *attr,
993 const char *buf, size_t n)
994{
995 unsigned long size;
996
997 if (sscanf(buf, "%lu", &size) == 1) {
998 reserved_size = size;
999 return n;
1000 }
1001
1002 return -EINVAL;
1003}
1004
1005power_attr(reserved_size);
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007static struct attribute * g[] = {
1008 &disk_attr.attr,
1009 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001010 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001011 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 NULL,
1013};
1014
1015
1016static struct attribute_group attr_group = {
1017 .attrs = g,
1018};
1019
1020
1021static int __init pm_disk_init(void)
1022{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001023 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024}
1025
1026core_initcall(pm_disk_init);
1027
1028
1029static int __init resume_setup(char *str)
1030{
1031 if (noresume)
1032 return 1;
1033
1034 strncpy( resume_file, str, 255 );
1035 return 1;
1036}
1037
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001038static int __init resume_offset_setup(char *str)
1039{
1040 unsigned long long offset;
1041
1042 if (noresume)
1043 return 1;
1044
1045 if (sscanf(str, "%llu", &offset) == 1)
1046 swsusp_resume_block = offset;
1047
1048 return 1;
1049}
1050
Bojan Smojverf996fc92010-09-09 23:06:23 +02001051static int __init hibernate_setup(char *str)
1052{
1053 if (!strncmp(str, "noresume", 8))
1054 noresume = 1;
1055 else if (!strncmp(str, "nocompress", 10))
1056 nocompress = 1;
1057 return 1;
1058}
1059
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060static int __init noresume_setup(char *str)
1061{
1062 noresume = 1;
1063 return 1;
1064}
1065
Barry Song6f8d7022011-10-06 20:34:46 +02001066static int __init resumewait_setup(char *str)
1067{
1068 resume_wait = 1;
1069 return 1;
1070}
1071
Barry Songf126f732011-10-10 23:38:41 +02001072static int __init resumedelay_setup(char *str)
1073{
1074 resume_delay = simple_strtoul(str, NULL, 0);
1075 return 1;
1076}
1077
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001079__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001081__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001082__setup("resumewait", resumewait_setup);
Barry Songf126f732011-10-10 23:38:41 +02001083__setup("resumedelay=", resumedelay_setup);