blob: 21ad3fe3164f0e74f28e3a2075fb0145ae8e6561 [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>
Rafael J. Wysockic7510852009-04-12 20:06:56 +020031#include <scsi/scsi_scan.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070032
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include "power.h"
34
35
Barry Songd231ff12011-10-11 23:29:18 -070036static int nocompress;
37static int noresume;
38static int resume_wait;
39static int resume_delay;
Adrian Bunk47a460d2008-02-04 22:30:06 -080040static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080042sector_t swsusp_resume_block;
Barry Songd231ff12011-10-11 23:29:18 -070043int in_suspend __nosavedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070045enum {
46 HIBERNATION_INVALID,
47 HIBERNATION_PLATFORM,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070048 HIBERNATION_SHUTDOWN,
49 HIBERNATION_REBOOT,
Bojan Smojver62c552c2012-06-16 00:09:58 +020050#ifdef CONFIG_SUSPEND
51 HIBERNATION_SUSPEND,
52#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070053 /* keep last */
54 __HIBERNATION_AFTER_LAST
55};
56#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
57#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
58
59static int hibernation_mode = HIBERNATION_SHUTDOWN;
60
Srivatsa S. Bhat97819a22011-12-01 22:33:10 +010061bool freezer_test_done;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +010062
Lionel Debroux073ef1f2010-11-09 21:48:49 +010063static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070064
65/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020066 * hibernation_set_ops - Set the global hibernate operations.
67 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070068 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010069void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070070{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010071 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
72 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010073 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070074 WARN_ON(1);
75 return;
76 }
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +010077 lock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070078 hibernation_ops = ops;
79 if (ops)
80 hibernation_mode = HIBERNATION_PLATFORM;
81 else if (hibernation_mode == HIBERNATION_PLATFORM)
82 hibernation_mode = HIBERNATION_SHUTDOWN;
83
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +010084 unlock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070085}
86
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010087static bool entering_platform_hibernation;
88
89bool system_entering_hibernation(void)
90{
91 return entering_platform_hibernation;
92}
93EXPORT_SYMBOL(system_entering_hibernation);
94
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010095#ifdef CONFIG_PM_DEBUG
96static void hibernation_debug_sleep(void)
97{
98 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
99 mdelay(5000);
100}
101
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100102static int hibernation_test(int level)
103{
104 if (pm_test_level == level) {
105 hibernation_debug_sleep();
106 return 1;
107 }
108 return 0;
109}
110#else /* !CONFIG_PM_DEBUG */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100111static int hibernation_test(int level) { return 0; }
112#endif /* !CONFIG_PM_DEBUG */
113
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700114/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200115 * platform_begin - Call platform to start hibernation.
116 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700117 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100118static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700119{
120 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100121 hibernation_ops->begin() : 0;
122}
123
124/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200125 * platform_end - Call platform to finish transition to the working state.
126 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100127 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100128static void platform_end(int platform_mode)
129{
130 if (platform_mode && hibernation_ops)
131 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700132}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200135 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
136 * @platform_mode: Whether or not to use the platform driver.
137 *
138 * Use the platform driver to prepare the system for creating a hibernate image,
139 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800140 */
141
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700142static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800143{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700144 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700145 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800146}
147
148/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200149 * platform_leave - Call platform to prepare a transition to the working state.
150 * @platform_mode: Whether or not to use the platform driver.
151 *
152 * Use the platform driver prepare to prepare the machine for switching to the
153 * normal mode of operation.
154 *
155 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700156 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700157static void platform_leave(int platform_mode)
158{
159 if (platform_mode && hibernation_ops)
160 hibernation_ops->leave();
161}
162
163/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200164 * platform_finish - Call platform to switch the system to the working state.
165 * @platform_mode: Whether or not to use the platform driver.
166 *
167 * Use the platform driver to switch the machine to the normal mode of
168 * operation.
169 *
170 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700171 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700172static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700173{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700174 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700175 hibernation_ops->finish();
176}
177
178/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200179 * platform_pre_restore - Prepare for hibernate image restoration.
180 * @platform_mode: Whether or not to use the platform driver.
181 *
182 * Use the platform driver to prepare the system for resume from a hibernation
183 * image.
184 *
185 * If the restore fails after this function has been called,
186 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700187 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700188static int platform_pre_restore(int platform_mode)
189{
190 return (platform_mode && hibernation_ops) ?
191 hibernation_ops->pre_restore() : 0;
192}
193
194/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200195 * platform_restore_cleanup - Switch to the working state after failing restore.
196 * @platform_mode: Whether or not to use the platform driver.
197 *
198 * Use the platform driver to switch the system to the normal mode of operation
199 * after a failing restore.
200 *
201 * If platform_pre_restore() has been called before the failing restore, this
202 * function must be called too, regardless of the result of
203 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700204 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700205static void platform_restore_cleanup(int platform_mode)
206{
207 if (platform_mode && hibernation_ops)
208 hibernation_ops->restore_cleanup();
209}
210
211/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200212 * platform_recover - Recover from a failure to suspend devices.
213 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200214 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200215static void platform_recover(int platform_mode)
216{
217 if (platform_mode && hibernation_ops && hibernation_ops->recover)
218 hibernation_ops->recover();
219}
220
221/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200222 * swsusp_show_speed - Print time elapsed between two events during hibernation.
223 * @start: Starting event.
224 * @stop: Final event.
225 * @nr_pages: Number of memory pages processed between @start and @stop.
226 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100227 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100228void swsusp_show_speed(struct timeval *start, struct timeval *stop,
229 unsigned nr_pages, char *msg)
230{
231 s64 elapsed_centisecs64;
232 int centisecs;
233 int k;
234 int kps;
235
236 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
237 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
238 centisecs = elapsed_centisecs64;
239 if (centisecs == 0)
240 centisecs = 1; /* avoid div-by-zero */
241 k = nr_pages * (PAGE_SIZE / 1024);
242 kps = (k * 100) / centisecs;
243 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
244 msg, k,
245 centisecs / 100, centisecs % 100,
246 kps / 1000, (kps % 1000) / 10);
247}
248
249/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200250 * create_image - Create a hibernation image.
251 * @platform_mode: Whether or not to use the platform driver.
252 *
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100253 * Execute device drivers' "late" and "noirq" freeze callbacks, create a
254 * hibernation image and run the drivers' "noirq" and "early" thaw callbacks.
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200255 *
256 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700257 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800258static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700259{
260 int error;
261
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100262 error = dpm_suspend_end(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700263 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100264 printk(KERN_ERR "PM: Some devices failed to power down, "
265 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200266 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700267 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100268
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100269 error = platform_pre_snapshot(platform_mode);
270 if (error || hibernation_test(TEST_PLATFORM))
271 goto Platform_finish;
272
273 error = disable_nonboot_cpus();
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100274 if (error || hibernation_test(TEST_CPUS))
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100275 goto Enable_cpus;
276
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100277 local_irq_disable();
278
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200279 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100280 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200281 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100282 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100283 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100284 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700285
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100286 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100287 goto Power_up;
288
289 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700290 save_processor_state();
291 error = swsusp_arch_suspend();
292 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100293 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
294 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700295 /* Restore control flow magically appears here */
296 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200297 if (!in_suspend) {
298 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700299 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200300 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100301
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100302 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100303 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100304
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100305 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100306 local_irq_enable();
307
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100308 Enable_cpus:
309 enable_nonboot_cpus();
310
311 Platform_finish:
312 platform_finish(platform_mode);
313
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100314 dpm_resume_start(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200315 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100316
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700317 return error;
318}
319
320/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200321 * hibernation_snapshot - Quiesce devices and create a hibernation image.
322 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700323 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200324 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700325 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700326int hibernation_snapshot(int platform_mode)
327{
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100328 pm_message_t msg;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100329 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700330
Zhang Rui3fe03132008-10-26 20:50:26 +0100331 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700332 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200333 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700334
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200335 /* Preallocate image memory before shutting down devices. */
336 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700337 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200338 goto Close;
339
340 error = freeze_kernel_threads();
341 if (error)
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100342 goto Cleanup;
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200343
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100344 if (hibernation_test(TEST_FREEZER)) {
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100345
346 /*
347 * Indicate to the caller that we are returning due to a
348 * successful freezer test.
349 */
350 freezer_test_done = true;
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100351 goto Thaw;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100352 }
353
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200354 error = dpm_prepare(PMSG_FREEZE);
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100355 if (error) {
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100356 dpm_complete(PMSG_RECOVER);
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100357 goto Thaw;
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100358 }
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700359
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700360 suspend_console();
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
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700386 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200387 dpm_complete(msg);
388
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100389 Close:
390 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700391 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200392
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100393 Thaw:
394 thaw_kernel_threads();
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100395 Cleanup:
396 swsusp_free();
397 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700398}
399
400/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200401 * resume_target_kernel - Restore system state from a hibernation image.
402 * @platform_mode: Whether or not to use the platform driver.
403 *
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100404 * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
405 * contents of highmem that have not been restored yet from the image and run
406 * the low-level code that will restore the remaining contents of memory and
407 * switch to the just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100408 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100409static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100410{
411 int error;
412
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100413 error = dpm_suspend_end(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100414 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100415 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100416 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200417 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100418 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100419
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100420 error = platform_pre_restore(platform_mode);
421 if (error)
422 goto Cleanup;
423
424 error = disable_nonboot_cpus();
425 if (error)
426 goto Enable_cpus;
427
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100428 local_irq_disable();
429
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200430 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100431 if (error)
432 goto Enable_irqs;
433
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100434 save_processor_state();
435 error = restore_highmem();
436 if (!error) {
437 error = swsusp_arch_resume();
438 /*
439 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200440 * Otherwise, execution continues at the place where
441 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100442 */
443 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200444 /*
445 * This call to restore_highmem() reverts the changes made by
446 * the previous one.
447 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100448 restore_highmem();
449 }
450 /*
451 * The only reason why swsusp_arch_resume() can fail is memory being
452 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200453 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100454 */
455 swsusp_free();
456 restore_processor_state();
457 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100458
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100459 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100460
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100461 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100462 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100463
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100464 Enable_cpus:
465 enable_nonboot_cpus();
466
467 Cleanup:
468 platform_restore_cleanup(platform_mode);
469
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100470 dpm_resume_start(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100471
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100472 return error;
473}
474
475/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200476 * hibernation_restore - Quiesce devices and restore from a hibernation image.
477 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700478 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200479 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200480 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700481 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700482int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700483{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100484 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700485
486 pm_prepare_console();
487 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100488 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200489 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700490 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100491 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200492 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700493 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100494 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700495 resume_console();
496 pm_restore_console();
497 return error;
498}
499
500/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200501 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700502 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700503int hibernation_platform_enter(void)
504{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100505 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700506
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700507 if (!hibernation_ops)
508 return -ENOSYS;
509
510 /*
511 * We have cancelled the power transition by running
512 * hibernation_ops->finish() before saving the image, so we should let
513 * the firmware know that we're going to enter the sleep state after all
514 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100515 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700516 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100517 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700518
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100519 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700520 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200521 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200522 if (error) {
523 if (hibernation_ops->recover)
524 hibernation_ops->recover();
525 goto Resume_devices;
526 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700527
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100528 error = dpm_suspend_end(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100529 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200530 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100531
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100532 error = hibernation_ops->prepare();
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 error = disable_nonboot_cpus();
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 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100541 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100542 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200543 error = -EAGAIN;
544 goto Power_up;
545 }
546
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100547 hibernation_ops->enter();
548 /* We should never get here */
549 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700550
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200551 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100552 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200553 local_irq_enable();
554 enable_nonboot_cpus();
555
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200556 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700557 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100558
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100559 dpm_resume_start(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100560
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700561 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100562 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200563 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700564 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100565
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100566 Close:
567 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100568
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700569 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700570}
571
572/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200573 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200575 * Use the platform driver, if configured, to put the system into the sleep
576 * state corresponding to hibernation, or try to power it off or reboot,
577 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 */
Johannes Bergfe0c9352007-04-30 15:09:51 -0700579static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Bojan Smojver62c552c2012-06-16 00:09:58 +0200581#ifdef CONFIG_SUSPEND
582 int error;
583#endif
584
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700585 switch (hibernation_mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700586 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600587 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700589 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700590 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700591 case HIBERNATION_SHUTDOWN:
592 kernel_power_off();
593 break;
Bojan Smojver62c552c2012-06-16 00:09:58 +0200594#ifdef CONFIG_SUSPEND
595 case HIBERNATION_SUSPEND:
596 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
597 if (error) {
598 if (hibernation_ops)
599 hibernation_mode = HIBERNATION_PLATFORM;
600 else
601 hibernation_mode = HIBERNATION_SHUTDOWN;
602 power_down();
603 }
604 /*
605 * Restore swap signature.
606 */
607 error = swsusp_unmark();
608 if (error)
609 printk(KERN_ERR "PM: Swap will be unusable! "
610 "Try swapon -a.\n");
611 return;
612#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600614 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700615 /*
616 * Valid image is on the disk, if we continue we risk serious data
617 * corruption after resume.
618 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100619 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 while(1);
621}
622
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200624 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700626int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627{
628 int error;
629
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100630 lock_system_sleep();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700631 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700632 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
633 error = -EBUSY;
634 goto Unlock;
635 }
636
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100637 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700638 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
639 if (error)
640 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700641
642 /* Allocate memory management structures */
643 error = create_basic_memory_bitmaps();
644 if (error)
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200645 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700646
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100647 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700648 sys_sync();
649 printk("done.\n");
650
Tejun Heo03afed82011-11-21 12:32:24 -0800651 error = freeze_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700652 if (error)
Srivatsa S. Bhat05b48772012-02-17 23:39:51 +0100653 goto Free_bitmaps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700655 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Srivatsa S. Bhata556d5b52012-02-04 23:39:56 +0100656 if (error || freezer_test_done)
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200657 goto Thaw;
658
659 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700660 unsigned int flags = 0;
661
662 if (hibernation_mode == HIBERNATION_PLATFORM)
663 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200664 if (nocompress)
665 flags |= SF_NOCOMPRESS_MODE;
Bojan Smojver081a9d02011-10-13 23:58:07 +0200666 else
667 flags |= SF_CRC32_MODE;
668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700670 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700671 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700673 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100674 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100675 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800676 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800678 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200679
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800680 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100681 thaw_processes();
Srivatsa S. Bhata556d5b52012-02-04 23:39:56 +0100682
683 /* Don't bother checking whether freezer_test_done is true */
684 freezer_test_done = false;
685
Srivatsa S. Bhat05b48772012-02-17 23:39:51 +0100686 Free_bitmaps:
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200687 free_basic_memory_bitmaps();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700688 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700689 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100690 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700691 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700692 Unlock:
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100693 unlock_system_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 return error;
695}
696
697
698/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200699 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200701 * This routine is called as a late initcall, when all devices have been
702 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200704 * The image reading code is called to see if there is a hibernation image
705 * available for reading. If that is the case, devices are quiesced and the
706 * contents of memory is restored from the saved image.
707 *
708 * If this is successful, control reappears in the restored target kernel in
709 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
710 * attempts to recover gracefully and make the kernel return to the normal mode
711 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713static int software_resume(void)
714{
715 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700716 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
Johannes Berg60a0d232007-11-14 17:00:16 -0800718 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100719 * If the user said "noresume".. bail out early.
720 */
721 if (noresume)
722 return 0;
723
724 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800725 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
726 * is configured into the kernel. Since the regular hibernate
727 * trigger path is via sysfs which takes a buffer mutex before
728 * calling hibernate functions (which take pm_mutex) this can
729 * cause lockdep to complain about a possible ABBA deadlock
730 * which cannot happen since we're in the boot code here and
731 * sysfs can't be invoked yet. Therefore, we use a subclass
732 * here to avoid lockdep complaining.
733 */
734 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200735
736 if (swsusp_resume_device)
737 goto Check_image;
738
739 if (!strlen(resume_file)) {
740 error = -ENOENT;
741 goto Unlock;
742 }
743
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200744 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200745
Barry Songf126f732011-10-10 23:38:41 +0200746 if (resume_delay) {
747 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
748 resume_delay);
749 ssleep(resume_delay);
750 }
751
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200752 /* Check if the device is there */
753 swsusp_resume_device = name_to_dev_t(resume_file);
Minho Ban2df83fa2012-05-14 21:45:31 +0200754
755 /*
756 * name_to_dev_t is ineffective to verify parition if resume_file is in
757 * integer format. (e.g. major:minor)
758 */
759 if (isdigit(resume_file[0]) && resume_wait) {
760 int partno;
761 while (!get_gendisk(swsusp_resume_device, &partno))
762 msleep(10);
763 }
764
Pavel Machek3efa1472005-07-07 17:56:43 -0700765 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100766 /*
767 * Some device discovery might still be in progress; we need
768 * to wait for this to finish.
769 */
770 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200771
772 if (resume_wait) {
773 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
774 msleep(10);
775 async_synchronize_full();
776 }
777
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200778 /*
779 * We can't depend on SCSI devices being available after loading
780 * one of their modules until scsi_complete_async_scans() is
781 * called and the resume device usually is a SCSI one.
782 */
783 scsi_complete_async_scans();
784
Pavel Machek3efa1472005-07-07 17:56:43 -0700785 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200786 if (!swsusp_resume_device) {
787 error = -ENODEV;
788 goto Unlock;
789 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700790 }
791
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200792 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200793 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200794 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200796 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800797 error = swsusp_check();
798 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700799 goto Unlock;
800
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700801 /* The snapshot device should not be opened while we're running */
802 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
803 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200804 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700805 goto Unlock;
806 }
807
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100808 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100809 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
810 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200811 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100812
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200813 error = create_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700814 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200815 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 pr_debug("PM: Preparing processes for restore.\n");
Tejun Heo03afed82011-11-21 12:32:24 -0800818 error = freeze_processes();
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800819 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400820 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700821 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
823
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200824 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700826 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200827 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800828 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700829 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200831 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700832 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100833 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 Done:
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200835 free_basic_memory_bitmaps();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700836 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100837 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100838 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700839 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700840 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700841 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800842 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200843 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700844 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200845close_finish:
846 swsusp_close(FMODE_READ);
847 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848}
849
850late_initcall(software_resume);
851
852
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700853static const char * const hibernation_modes[] = {
854 [HIBERNATION_PLATFORM] = "platform",
855 [HIBERNATION_SHUTDOWN] = "shutdown",
856 [HIBERNATION_REBOOT] = "reboot",
Bojan Smojver62c552c2012-06-16 00:09:58 +0200857#ifdef CONFIG_SUSPEND
858 [HIBERNATION_SUSPEND] = "suspend",
859#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860};
861
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200862/*
863 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200865 * Hibernation can be handled in several ways. There are a few different ways
866 * to put the system into the sleep state: using the platform driver (e.g. ACPI
867 * or other hibernation_ops), powering it off or rebooting it (for testing
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100868 * mostly).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200870 * The sysfs file /sys/power/disk provides an interface for selecting the
871 * hibernation mode to use. Reading from this file causes the available modes
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100872 * to be printed. There are 3 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 * 'platform'
875 * 'shutdown'
876 * 'reboot'
877 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200878 * If a platform hibernation driver is in use, 'platform' will be supported
879 * and will be used by default. Otherwise, 'shutdown' will be used by default.
880 * The selected option (i.e. the one corresponding to the current value of
881 * hibernation_mode) is enclosed by a square bracket.
882 *
883 * To select a given hibernation mode it is necessary to write the mode's
884 * string representation (as returned by reading from /sys/power/disk) back
885 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 */
887
Kay Sievers386f2752007-11-02 13:47:53 +0100888static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
889 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700891 int i;
892 char *start = buf;
893
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700894 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
895 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700896 continue;
897 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700898 case HIBERNATION_SHUTDOWN:
899 case HIBERNATION_REBOOT:
Bojan Smojver62c552c2012-06-16 00:09:58 +0200900#ifdef CONFIG_SUSPEND
901 case HIBERNATION_SUSPEND:
902#endif
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700903 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700904 case HIBERNATION_PLATFORM:
905 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700906 break;
907 /* not a valid mode, continue with loop */
908 continue;
909 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700910 if (i == hibernation_mode)
911 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700912 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700913 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700914 }
915 buf += sprintf(buf, "\n");
916 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917}
918
Kay Sievers386f2752007-11-02 13:47:53 +0100919static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
920 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921{
922 int error = 0;
923 int i;
924 int len;
925 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700926 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
928 p = memchr(buf, '\n', n);
929 len = p ? p - buf : n;
930
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100931 lock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700932 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700933 if (len == strlen(hibernation_modes[i])
934 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 mode = i;
936 break;
937 }
938 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700939 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700940 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700941 case HIBERNATION_SHUTDOWN:
942 case HIBERNATION_REBOOT:
Bojan Smojver62c552c2012-06-16 00:09:58 +0200943#ifdef CONFIG_SUSPEND
944 case HIBERNATION_SUSPEND:
945#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700946 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700947 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700948 case HIBERNATION_PLATFORM:
949 if (hibernation_ops)
950 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 else
952 error = -EINVAL;
953 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700954 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 error = -EINVAL;
956
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700957 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100958 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700959 hibernation_modes[mode]);
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100960 unlock_system_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 return error ? error : n;
962}
963
964power_attr(disk);
965
Kay Sievers386f2752007-11-02 13:47:53 +0100966static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
967 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968{
969 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
970 MINOR(swsusp_resume_device));
971}
972
Kay Sievers386f2752007-11-02 13:47:53 +0100973static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
974 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800978 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
Andrew Mortona5762192006-01-06 00:09:50 -0800980 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
981 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
Andrew Mortona5762192006-01-06 00:09:50 -0800983 res = MKDEV(maj,min);
984 if (maj != MAJOR(res) || min != MINOR(res))
985 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100987 lock_system_sleep();
Andrew Mortona5762192006-01-06 00:09:50 -0800988 swsusp_resume_device = res;
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100989 unlock_system_sleep();
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100990 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800991 noresume = 0;
992 software_resume();
993 ret = n;
Rafael J. Wysocki59a49332006-12-06 20:34:44 -0800994 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800995 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996}
997
998power_attr(resume);
999
Kay Sievers386f2752007-11-02 13:47:53 +01001000static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
1001 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001002{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001003 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001004}
1005
Kay Sievers386f2752007-11-02 13:47:53 +01001006static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1007 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001008{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001009 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001010
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001011 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001012 image_size = size;
1013 return n;
1014 }
1015
1016 return -EINVAL;
1017}
1018
1019power_attr(image_size);
1020
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001021static ssize_t reserved_size_show(struct kobject *kobj,
1022 struct kobj_attribute *attr, char *buf)
1023{
1024 return sprintf(buf, "%lu\n", reserved_size);
1025}
1026
1027static ssize_t reserved_size_store(struct kobject *kobj,
1028 struct kobj_attribute *attr,
1029 const char *buf, size_t n)
1030{
1031 unsigned long size;
1032
1033 if (sscanf(buf, "%lu", &size) == 1) {
1034 reserved_size = size;
1035 return n;
1036 }
1037
1038 return -EINVAL;
1039}
1040
1041power_attr(reserved_size);
1042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043static struct attribute * g[] = {
1044 &disk_attr.attr,
1045 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001046 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001047 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 NULL,
1049};
1050
1051
1052static struct attribute_group attr_group = {
1053 .attrs = g,
1054};
1055
1056
1057static int __init pm_disk_init(void)
1058{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001059 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060}
1061
1062core_initcall(pm_disk_init);
1063
1064
1065static int __init resume_setup(char *str)
1066{
1067 if (noresume)
1068 return 1;
1069
1070 strncpy( resume_file, str, 255 );
1071 return 1;
1072}
1073
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001074static int __init resume_offset_setup(char *str)
1075{
1076 unsigned long long offset;
1077
1078 if (noresume)
1079 return 1;
1080
1081 if (sscanf(str, "%llu", &offset) == 1)
1082 swsusp_resume_block = offset;
1083
1084 return 1;
1085}
1086
Bojan Smojverf996fc92010-09-09 23:06:23 +02001087static int __init hibernate_setup(char *str)
1088{
1089 if (!strncmp(str, "noresume", 8))
1090 noresume = 1;
1091 else if (!strncmp(str, "nocompress", 10))
1092 nocompress = 1;
1093 return 1;
1094}
1095
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096static int __init noresume_setup(char *str)
1097{
1098 noresume = 1;
1099 return 1;
1100}
1101
Barry Song6f8d7022011-10-06 20:34:46 +02001102static int __init resumewait_setup(char *str)
1103{
1104 resume_wait = 1;
1105 return 1;
1106}
1107
Barry Songf126f732011-10-10 23:38:41 +02001108static int __init resumedelay_setup(char *str)
1109{
1110 resume_delay = simple_strtoul(str, NULL, 0);
1111 return 1;
1112}
1113
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001115__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001117__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001118__setup("resumewait", resumewait_setup);
Barry Songf126f732011-10-10 23:38:41 +02001119__setup("resumedelay=", resumedelay_setup);