blob: 3085e62a80a5cea43a857cb7b28c50237f71fe39 [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.
Bojan Smojver62c552c2012-06-16 00:09:58 +02008 * Copyright (C) 2012 Bojan Smojver <bojan@rexursive.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
10 * This file is released under the GPLv2.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 */
12
Paul Gortmaker6e5fdee2011-05-26 16:00:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/suspend.h>
15#include <linux/syscalls.h>
16#include <linux/reboot.h>
17#include <linux/string.h>
18#include <linux/device.h>
Barry Song6f8d7022011-10-06 20:34:46 +020019#include <linux/async.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/delay.h>
21#include <linux/fs.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070022#include <linux/mount.h>
Eric W. Biederman88d10bb2005-09-22 21:43:46 -070023#include <linux/pm.h>
Rafael J. Wysocki97c78012006-10-11 01:20:45 -070024#include <linux/console.h>
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -070025#include <linux/cpu.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080026#include <linux/freezer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090027#include <linux/gfp.h>
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +010028#include <linux/syscore_ops.h>
Minho Ban2df83fa2012-05-14 21:45:31 +020029#include <linux/ctype.h>
30#include <linux/genhd.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;
Andi Kleend6efc2f2013-08-05 15:02:49 -070042__visible int 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,
Bojan Smojver62c552c2012-06-16 00:09:58 +020049#ifdef CONFIG_SUSPEND
50 HIBERNATION_SUSPEND,
51#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070052 /* keep last */
53 __HIBERNATION_AFTER_LAST
54};
55#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
56#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
57
58static int hibernation_mode = HIBERNATION_SHUTDOWN;
59
Srivatsa S. Bhat97819a22011-12-01 22:33:10 +010060bool freezer_test_done;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +010061
Lionel Debroux073ef1f2010-11-09 21:48:49 +010062static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070063
64/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020065 * hibernation_set_ops - Set the global hibernate operations.
66 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070067 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010068void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070069{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010070 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
71 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010072 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070073 WARN_ON(1);
74 return;
75 }
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +010076 lock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070077 hibernation_ops = ops;
78 if (ops)
79 hibernation_mode = HIBERNATION_PLATFORM;
80 else if (hibernation_mode == HIBERNATION_PLATFORM)
81 hibernation_mode = HIBERNATION_SHUTDOWN;
82
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +010083 unlock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070084}
85
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010086static bool entering_platform_hibernation;
87
88bool system_entering_hibernation(void)
89{
90 return entering_platform_hibernation;
91}
92EXPORT_SYMBOL(system_entering_hibernation);
93
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010094#ifdef CONFIG_PM_DEBUG
95static void hibernation_debug_sleep(void)
96{
97 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
98 mdelay(5000);
99}
100
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100101static int hibernation_test(int level)
102{
103 if (pm_test_level == level) {
104 hibernation_debug_sleep();
105 return 1;
106 }
107 return 0;
108}
109#else /* !CONFIG_PM_DEBUG */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100110static int hibernation_test(int level) { return 0; }
111#endif /* !CONFIG_PM_DEBUG */
112
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700113/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200114 * platform_begin - Call platform to start hibernation.
115 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700116 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100117static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700118{
119 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100120 hibernation_ops->begin() : 0;
121}
122
123/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200124 * platform_end - Call platform to finish transition to the working state.
125 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100126 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100127static void platform_end(int platform_mode)
128{
129 if (platform_mode && hibernation_ops)
130 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700131}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200134 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
135 * @platform_mode: Whether or not to use the platform driver.
136 *
137 * Use the platform driver to prepare the system for creating a hibernate image,
138 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800139 */
140
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700141static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800142{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700143 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700144 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800145}
146
147/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200148 * platform_leave - Call platform to prepare a transition to the working state.
149 * @platform_mode: Whether or not to use the platform driver.
150 *
151 * Use the platform driver prepare to prepare the machine for switching to the
152 * normal mode of operation.
153 *
154 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700155 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700156static void platform_leave(int platform_mode)
157{
158 if (platform_mode && hibernation_ops)
159 hibernation_ops->leave();
160}
161
162/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200163 * platform_finish - Call platform to switch the system to the working state.
164 * @platform_mode: Whether or not to use the platform driver.
165 *
166 * Use the platform driver to switch the machine to the normal mode of
167 * operation.
168 *
169 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700170 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700171static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700172{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700173 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700174 hibernation_ops->finish();
175}
176
177/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200178 * platform_pre_restore - Prepare for hibernate image restoration.
179 * @platform_mode: Whether or not to use the platform driver.
180 *
181 * Use the platform driver to prepare the system for resume from a hibernation
182 * image.
183 *
184 * If the restore fails after this function has been called,
185 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700186 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700187static int platform_pre_restore(int platform_mode)
188{
189 return (platform_mode && hibernation_ops) ?
190 hibernation_ops->pre_restore() : 0;
191}
192
193/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200194 * platform_restore_cleanup - Switch to the working state after failing restore.
195 * @platform_mode: Whether or not to use the platform driver.
196 *
197 * Use the platform driver to switch the system to the normal mode of operation
198 * after a failing restore.
199 *
200 * If platform_pre_restore() has been called before the failing restore, this
201 * function must be called too, regardless of the result of
202 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700203 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700204static void platform_restore_cleanup(int platform_mode)
205{
206 if (platform_mode && hibernation_ops)
207 hibernation_ops->restore_cleanup();
208}
209
210/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200211 * platform_recover - Recover from a failure to suspend devices.
212 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200213 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200214static void platform_recover(int platform_mode)
215{
216 if (platform_mode && hibernation_ops && hibernation_ops->recover)
217 hibernation_ops->recover();
218}
219
220/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200221 * swsusp_show_speed - Print time elapsed between two events during hibernation.
222 * @start: Starting event.
223 * @stop: Final event.
224 * @nr_pages: Number of memory pages processed between @start and @stop.
225 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100226 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100227void swsusp_show_speed(struct timeval *start, struct timeval *stop,
228 unsigned nr_pages, char *msg)
229{
230 s64 elapsed_centisecs64;
231 int centisecs;
232 int k;
233 int kps;
234
235 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
236 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
237 centisecs = elapsed_centisecs64;
238 if (centisecs == 0)
239 centisecs = 1; /* avoid div-by-zero */
240 k = nr_pages * (PAGE_SIZE / 1024);
241 kps = (k * 100) / centisecs;
242 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
243 msg, k,
244 centisecs / 100, centisecs % 100,
245 kps / 1000, (kps % 1000) / 10);
246}
247
248/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200249 * create_image - Create a hibernation image.
250 * @platform_mode: Whether or not to use the platform driver.
251 *
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100252 * Execute device drivers' "late" and "noirq" freeze callbacks, create a
253 * hibernation image and run the drivers' "noirq" and "early" thaw callbacks.
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200254 *
255 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700256 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800257static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700258{
259 int error;
260
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100261 error = dpm_suspend_end(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700262 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100263 printk(KERN_ERR "PM: Some devices failed to power down, "
264 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200265 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700266 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100267
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100268 error = platform_pre_snapshot(platform_mode);
269 if (error || hibernation_test(TEST_PLATFORM))
270 goto Platform_finish;
271
272 error = disable_nonboot_cpus();
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100273 if (error || hibernation_test(TEST_CPUS))
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100274 goto Enable_cpus;
275
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100276 local_irq_disable();
277
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200278 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100279 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200280 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100281 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100282 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100283 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700284
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100285 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100286 goto Power_up;
287
288 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700289 save_processor_state();
290 error = swsusp_arch_suspend();
291 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100292 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
293 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700294 /* Restore control flow magically appears here */
295 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200296 if (!in_suspend) {
297 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700298 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200299 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100300
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100301 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100302 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100303
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100304 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100305 local_irq_enable();
306
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100307 Enable_cpus:
308 enable_nonboot_cpus();
309
310 Platform_finish:
311 platform_finish(platform_mode);
312
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100313 dpm_resume_start(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200314 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100315
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700316 return error;
317}
318
319/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200320 * hibernation_snapshot - Quiesce devices and create a hibernation image.
321 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700322 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200323 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700324 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700325int hibernation_snapshot(int platform_mode)
326{
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100327 pm_message_t msg;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100328 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700329
Zhang Rui3fe03132008-10-26 20:50:26 +0100330 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700331 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200332 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700333
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200334 /* Preallocate image memory before shutting down devices. */
335 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700336 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200337 goto Close;
338
339 error = freeze_kernel_threads();
340 if (error)
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100341 goto Cleanup;
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200342
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100343 if (hibernation_test(TEST_FREEZER)) {
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100344
345 /*
346 * Indicate to the caller that we are returning due to a
347 * successful freezer test.
348 */
349 freezer_test_done = true;
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100350 goto Thaw;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100351 }
352
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200353 error = dpm_prepare(PMSG_FREEZE);
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100354 if (error) {
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100355 dpm_complete(PMSG_RECOVER);
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100356 goto Thaw;
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100357 }
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700358
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700359 suspend_console();
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200360 ftrace_stop();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100361 pm_restrict_gfp_mask();
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100362
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200363 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700364
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100365 if (error || hibernation_test(TEST_DEVICES))
366 platform_recover(platform_mode);
367 else
368 error = create_image(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700369
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100370 /*
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100371 * In the case that we call create_image() above, the control
372 * returns here (1) after the image has been created or the
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100373 * image creation has failed and (2) after a successful restore.
374 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100375
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200376 /* We may need to release the preallocated image pages here. */
377 if (error || !in_suspend)
378 swsusp_free();
379
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200380 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
381 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100382
383 if (error || !in_suspend)
384 pm_restore_gfp_mask();
385
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200386 ftrace_start();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700387 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200388 dpm_complete(msg);
389
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100390 Close:
391 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700392 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200393
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100394 Thaw:
395 thaw_kernel_threads();
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100396 Cleanup:
397 swsusp_free();
398 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700399}
400
401/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200402 * resume_target_kernel - Restore system state from a hibernation image.
403 * @platform_mode: Whether or not to use the platform driver.
404 *
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100405 * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
406 * contents of highmem that have not been restored yet from the image and run
407 * the low-level code that will restore the remaining contents of memory and
408 * switch to the just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100409 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100410static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100411{
412 int error;
413
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100414 error = dpm_suspend_end(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100415 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100416 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100417 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200418 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100419 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100420
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100421 error = platform_pre_restore(platform_mode);
422 if (error)
423 goto Cleanup;
424
425 error = disable_nonboot_cpus();
426 if (error)
427 goto Enable_cpus;
428
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100429 local_irq_disable();
430
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200431 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100432 if (error)
433 goto Enable_irqs;
434
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100435 save_processor_state();
436 error = restore_highmem();
437 if (!error) {
438 error = swsusp_arch_resume();
439 /*
440 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200441 * Otherwise, execution continues at the place where
442 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100443 */
444 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200445 /*
446 * This call to restore_highmem() reverts the changes made by
447 * the previous one.
448 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100449 restore_highmem();
450 }
451 /*
452 * The only reason why swsusp_arch_resume() can fail is memory being
453 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200454 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100455 */
456 swsusp_free();
457 restore_processor_state();
458 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100459
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100460 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100461
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100462 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100463 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100464
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100465 Enable_cpus:
466 enable_nonboot_cpus();
467
468 Cleanup:
469 platform_restore_cleanup(platform_mode);
470
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100471 dpm_resume_start(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100472
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100473 return error;
474}
475
476/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200477 * hibernation_restore - Quiesce devices and restore from a hibernation image.
478 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700479 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200480 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200481 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700482 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700483int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700484{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100485 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700486
487 pm_prepare_console();
488 suspend_console();
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200489 ftrace_stop();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100490 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200491 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700492 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100493 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200494 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700495 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100496 pm_restore_gfp_mask();
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200497 ftrace_start();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700498 resume_console();
499 pm_restore_console();
500 return error;
501}
502
503/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200504 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700505 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700506int hibernation_platform_enter(void)
507{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100508 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700509
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700510 if (!hibernation_ops)
511 return -ENOSYS;
512
513 /*
514 * We have cancelled the power transition by running
515 * hibernation_ops->finish() before saving the image, so we should let
516 * the firmware know that we're going to enter the sleep state after all
517 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100518 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700519 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100520 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700521
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100522 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700523 suspend_console();
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200524 ftrace_stop();
Alan Sternd1616302009-05-24 22:05:42 +0200525 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200526 if (error) {
527 if (hibernation_ops->recover)
528 hibernation_ops->recover();
529 goto Resume_devices;
530 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700531
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100532 error = dpm_suspend_end(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100533 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200534 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100535
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100536 error = hibernation_ops->prepare();
537 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200538 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100539
540 error = disable_nonboot_cpus();
541 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200542 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100543
544 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100545 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100546 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200547 error = -EAGAIN;
548 goto Power_up;
549 }
550
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100551 hibernation_ops->enter();
552 /* We should never get here */
553 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700554
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200555 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100556 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200557 local_irq_enable();
558 enable_nonboot_cpus();
559
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200560 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700561 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100562
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100563 dpm_resume_start(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100564
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700565 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100566 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200567 dpm_resume_end(PMSG_RESTORE);
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200568 ftrace_start();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700569 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100570
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100571 Close:
572 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100573
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700574 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700575}
576
577/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200578 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200580 * Use the platform driver, if configured, to put the system into the sleep
581 * state corresponding to hibernation, or try to power it off or reboot,
582 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 */
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700584static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585{
Bojan Smojver62c552c2012-06-16 00:09:58 +0200586#ifdef CONFIG_SUSPEND
587 int error;
588#endif
589
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700590 switch (hibernation_mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700591 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600592 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700594 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700595 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700596 case HIBERNATION_SHUTDOWN:
597 kernel_power_off();
598 break;
Bojan Smojver62c552c2012-06-16 00:09:58 +0200599#ifdef CONFIG_SUSPEND
600 case HIBERNATION_SUSPEND:
601 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
602 if (error) {
603 if (hibernation_ops)
604 hibernation_mode = HIBERNATION_PLATFORM;
605 else
606 hibernation_mode = HIBERNATION_SHUTDOWN;
607 power_down();
608 }
609 /*
610 * Restore swap signature.
611 */
612 error = swsusp_unmark();
613 if (error)
614 printk(KERN_ERR "PM: Swap will be unusable! "
615 "Try swapon -a.\n");
616 return;
617#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600619 kernel_halt();
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700620 /*
621 * Valid image is on the disk, if we continue we risk serious data
622 * corruption after resume.
623 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100624 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 while(1);
626}
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200629 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700631int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
633 int error;
634
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100635 lock_system_sleep();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700636 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700637 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
638 error = -EBUSY;
639 goto Unlock;
640 }
641
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100642 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700643 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
644 if (error)
645 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700646
647 /* Allocate memory management structures */
648 error = create_basic_memory_bitmaps();
649 if (error)
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200650 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700651
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100652 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700653 sys_sync();
654 printk("done.\n");
655
Tejun Heo03afed82011-11-21 12:32:24 -0800656 error = freeze_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700657 if (error)
Srivatsa S. Bhat05b48772012-02-17 23:39:51 +0100658 goto Free_bitmaps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700660 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Srivatsa S. Bhata556d5b52012-02-04 23:39:56 +0100661 if (error || freezer_test_done)
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200662 goto Thaw;
663
664 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700665 unsigned int flags = 0;
666
667 if (hibernation_mode == HIBERNATION_PLATFORM)
668 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200669 if (nocompress)
670 flags |= SF_NOCOMPRESS_MODE;
Bojan Smojver081a9d02011-10-13 23:58:07 +0200671 else
672 flags |= SF_CRC32_MODE;
673
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700675 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700676 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 if (!error)
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700678 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100679 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100680 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800681 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800683 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200684
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800685 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100686 thaw_processes();
Srivatsa S. Bhata556d5b52012-02-04 23:39:56 +0100687
688 /* Don't bother checking whether freezer_test_done is true */
689 freezer_test_done = false;
690
Srivatsa S. Bhat05b48772012-02-17 23:39:51 +0100691 Free_bitmaps:
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200692 free_basic_memory_bitmaps();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700693 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700694 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100695 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700696 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700697 Unlock:
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100698 unlock_system_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 return error;
700}
701
702
703/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200704 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200706 * This routine is called as a late initcall, when all devices have been
707 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200709 * The image reading code is called to see if there is a hibernation image
710 * available for reading. If that is the case, devices are quiesced and the
711 * contents of memory is restored from the saved image.
712 *
713 * If this is successful, control reappears in the restored target kernel in
714 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
715 * attempts to recover gracefully and make the kernel return to the normal mode
716 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718static int software_resume(void)
719{
720 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700721 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Johannes Berg60a0d232007-11-14 17:00:16 -0800723 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100724 * If the user said "noresume".. bail out early.
725 */
726 if (noresume)
727 return 0;
728
729 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800730 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
731 * is configured into the kernel. Since the regular hibernate
732 * trigger path is via sysfs which takes a buffer mutex before
733 * calling hibernate functions (which take pm_mutex) this can
734 * cause lockdep to complain about a possible ABBA deadlock
735 * which cannot happen since we're in the boot code here and
736 * sysfs can't be invoked yet. Therefore, we use a subclass
737 * here to avoid lockdep complaining.
738 */
739 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200740
741 if (swsusp_resume_device)
742 goto Check_image;
743
744 if (!strlen(resume_file)) {
745 error = -ENOENT;
746 goto Unlock;
747 }
748
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200749 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200750
Barry Songf126f732011-10-10 23:38:41 +0200751 if (resume_delay) {
752 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
753 resume_delay);
754 ssleep(resume_delay);
755 }
756
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200757 /* Check if the device is there */
758 swsusp_resume_device = name_to_dev_t(resume_file);
Minho Ban2df83fa2012-05-14 21:45:31 +0200759
760 /*
761 * name_to_dev_t is ineffective to verify parition if resume_file is in
762 * integer format. (e.g. major:minor)
763 */
764 if (isdigit(resume_file[0]) && resume_wait) {
765 int partno;
766 while (!get_gendisk(swsusp_resume_device, &partno))
767 msleep(10);
768 }
769
Pavel Machek3efa1472005-07-07 17:56:43 -0700770 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100771 /*
772 * Some device discovery might still be in progress; we need
773 * to wait for this to finish.
774 */
775 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200776
777 if (resume_wait) {
778 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
779 msleep(10);
780 async_synchronize_full();
781 }
782
Pavel Machek3efa1472005-07-07 17:56:43 -0700783 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200784 if (!swsusp_resume_device) {
785 error = -ENODEV;
786 goto Unlock;
787 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700788 }
789
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200790 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200791 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200792 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200794 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800795 error = swsusp_check();
796 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700797 goto Unlock;
798
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700799 /* The snapshot device should not be opened while we're running */
800 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
801 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200802 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700803 goto Unlock;
804 }
805
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100806 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100807 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
808 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200809 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100810
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200811 error = create_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700812 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200813 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700814
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 pr_debug("PM: Preparing processes for restore.\n");
Tejun Heo03afed82011-11-21 12:32:24 -0800816 error = freeze_processes();
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800817 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400818 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700819 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 }
821
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200822 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700824 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200825 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800826 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700827 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200829 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700830 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100831 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 Done:
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200833 free_basic_memory_bitmaps();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700834 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100835 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100836 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700837 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700838 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700839 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800840 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200841 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700842 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200843close_finish:
844 swsusp_close(FMODE_READ);
845 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846}
847
848late_initcall(software_resume);
849
850
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700851static const char * const hibernation_modes[] = {
852 [HIBERNATION_PLATFORM] = "platform",
853 [HIBERNATION_SHUTDOWN] = "shutdown",
854 [HIBERNATION_REBOOT] = "reboot",
Bojan Smojver62c552c2012-06-16 00:09:58 +0200855#ifdef CONFIG_SUSPEND
856 [HIBERNATION_SUSPEND] = "suspend",
857#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858};
859
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200860/*
861 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200863 * Hibernation can be handled in several ways. There are a few different ways
864 * to put the system into the sleep state: using the platform driver (e.g. ACPI
865 * or other hibernation_ops), powering it off or rebooting it (for testing
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100866 * mostly).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200868 * The sysfs file /sys/power/disk provides an interface for selecting the
869 * hibernation mode to use. Reading from this file causes the available modes
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100870 * to be printed. There are 3 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 * 'platform'
873 * 'shutdown'
874 * 'reboot'
875 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200876 * If a platform hibernation driver is in use, 'platform' will be supported
877 * and will be used by default. Otherwise, 'shutdown' will be used by default.
878 * The selected option (i.e. the one corresponding to the current value of
879 * hibernation_mode) is enclosed by a square bracket.
880 *
881 * To select a given hibernation mode it is necessary to write the mode's
882 * string representation (as returned by reading from /sys/power/disk) back
883 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 */
885
Kay Sievers386f2752007-11-02 13:47:53 +0100886static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
887 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700889 int i;
890 char *start = buf;
891
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700892 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
893 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700894 continue;
895 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700896 case HIBERNATION_SHUTDOWN:
897 case HIBERNATION_REBOOT:
Bojan Smojver62c552c2012-06-16 00:09:58 +0200898#ifdef CONFIG_SUSPEND
899 case HIBERNATION_SUSPEND:
900#endif
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700901 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700902 case HIBERNATION_PLATFORM:
903 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700904 break;
905 /* not a valid mode, continue with loop */
906 continue;
907 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700908 if (i == hibernation_mode)
909 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700910 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700911 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700912 }
913 buf += sprintf(buf, "\n");
914 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915}
916
Kay Sievers386f2752007-11-02 13:47:53 +0100917static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
918 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919{
920 int error = 0;
921 int i;
922 int len;
923 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700924 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
926 p = memchr(buf, '\n', n);
927 len = p ? p - buf : n;
928
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100929 lock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700930 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700931 if (len == strlen(hibernation_modes[i])
932 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 mode = i;
934 break;
935 }
936 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700937 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700938 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700939 case HIBERNATION_SHUTDOWN:
940 case HIBERNATION_REBOOT:
Bojan Smojver62c552c2012-06-16 00:09:58 +0200941#ifdef CONFIG_SUSPEND
942 case HIBERNATION_SUSPEND:
943#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700944 hibernation_mode = mode;
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700945 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700946 case HIBERNATION_PLATFORM:
947 if (hibernation_ops)
948 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 else
950 error = -EINVAL;
951 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700952 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 error = -EINVAL;
954
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700955 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100956 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700957 hibernation_modes[mode]);
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100958 unlock_system_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 return error ? error : n;
960}
961
962power_attr(disk);
963
Kay Sievers386f2752007-11-02 13:47:53 +0100964static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
965 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966{
967 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
968 MINOR(swsusp_resume_device));
969}
970
Kay Sievers386f2752007-11-02 13:47:53 +0100971static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
972 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800976 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
Andrew Mortona5762192006-01-06 00:09:50 -0800978 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
979 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
Andrew Mortona5762192006-01-06 00:09:50 -0800981 res = MKDEV(maj,min);
982 if (maj != MAJOR(res) || min != MINOR(res))
983 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100985 lock_system_sleep();
Andrew Mortona5762192006-01-06 00:09:50 -0800986 swsusp_resume_device = res;
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100987 unlock_system_sleep();
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100988 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800989 noresume = 0;
990 software_resume();
991 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800992 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800993 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994}
995
996power_attr(resume);
997
Kay Sievers386f2752007-11-02 13:47:53 +0100998static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
999 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001000{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001001 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001002}
1003
Kay Sievers386f2752007-11-02 13:47:53 +01001004static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1005 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001006{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001007 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001008
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001009 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001010 image_size = size;
1011 return n;
1012 }
1013
1014 return -EINVAL;
1015}
1016
1017power_attr(image_size);
1018
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001019static ssize_t reserved_size_show(struct kobject *kobj,
1020 struct kobj_attribute *attr, char *buf)
1021{
1022 return sprintf(buf, "%lu\n", reserved_size);
1023}
1024
1025static ssize_t reserved_size_store(struct kobject *kobj,
1026 struct kobj_attribute *attr,
1027 const char *buf, size_t n)
1028{
1029 unsigned long size;
1030
1031 if (sscanf(buf, "%lu", &size) == 1) {
1032 reserved_size = size;
1033 return n;
1034 }
1035
1036 return -EINVAL;
1037}
1038
1039power_attr(reserved_size);
1040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041static struct attribute * g[] = {
1042 &disk_attr.attr,
1043 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001044 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001045 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 NULL,
1047};
1048
1049
1050static struct attribute_group attr_group = {
1051 .attrs = g,
1052};
1053
1054
1055static int __init pm_disk_init(void)
1056{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001057 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058}
1059
1060core_initcall(pm_disk_init);
1061
1062
1063static int __init resume_setup(char *str)
1064{
1065 if (noresume)
1066 return 1;
1067
1068 strncpy( resume_file, str, 255 );
1069 return 1;
1070}
1071
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001072static int __init resume_offset_setup(char *str)
1073{
1074 unsigned long long offset;
1075
1076 if (noresume)
1077 return 1;
1078
1079 if (sscanf(str, "%llu", &offset) == 1)
1080 swsusp_resume_block = offset;
1081
1082 return 1;
1083}
1084
Bojan Smojverf996fc92010-09-09 23:06:23 +02001085static int __init hibernate_setup(char *str)
1086{
1087 if (!strncmp(str, "noresume", 8))
1088 noresume = 1;
1089 else if (!strncmp(str, "nocompress", 10))
1090 nocompress = 1;
1091 return 1;
1092}
1093
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094static int __init noresume_setup(char *str)
1095{
1096 noresume = 1;
1097 return 1;
1098}
1099
Barry Song6f8d7022011-10-06 20:34:46 +02001100static int __init resumewait_setup(char *str)
1101{
1102 resume_wait = 1;
1103 return 1;
1104}
1105
Barry Songf126f732011-10-10 23:38:41 +02001106static int __init resumedelay_setup(char *str)
1107{
1108 resume_delay = simple_strtoul(str, NULL, 0);
1109 return 1;
1110}
1111
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001113__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001115__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001116__setup("resumewait", resumewait_setup);
Barry Songf126f732011-10-10 23:38:41 +02001117__setup("resumedelay=", resumedelay_setup);