blob: 5314a94a92c1d07ac331b1868dcae9ce2368c458 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02002 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
Pavel Macheka2531292010-07-18 14:27:13 +02006 * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02007 * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11
Paul Gortmaker6e5fdee2011-05-26 16:00:52 -040012#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/suspend.h>
14#include <linux/syscalls.h>
15#include <linux/reboot.h>
16#include <linux/string.h>
17#include <linux/device.h>
Barry Song6f8d7022011-10-06 20:34:46 +020018#include <linux/async.h>
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -070019#include <linux/kmod.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/delay.h>
21#include <linux/fs.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070022#include <linux/mount.h>
Eric W. Biederman88d10bb2005-09-22 21:43:46 -070023#include <linux/pm.h>
Rafael J. Wysocki97c78012006-10-11 01:20:45 -070024#include <linux/console.h>
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -070025#include <linux/cpu.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080026#include <linux/freezer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090027#include <linux/gfp.h>
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +010028#include <linux/syscore_ops.h>
Rafael J. Wysockic7510852009-04-12 20:06:56 +020029#include <scsi/scsi_scan.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070030
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include "power.h"
32
33
Barry Songd231ff12011-10-11 23:29:18 -070034static int nocompress;
35static int noresume;
36static int resume_wait;
37static int resume_delay;
Adrian Bunk47a460d2008-02-04 22:30:06 -080038static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080040sector_t swsusp_resume_block;
Barry Songd231ff12011-10-11 23:29:18 -070041int in_suspend __nosavedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070043enum {
44 HIBERNATION_INVALID,
45 HIBERNATION_PLATFORM,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070046 HIBERNATION_SHUTDOWN,
47 HIBERNATION_REBOOT,
48 /* keep last */
49 __HIBERNATION_AFTER_LAST
50};
51#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
52#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
53
54static int hibernation_mode = HIBERNATION_SHUTDOWN;
55
Srivatsa S. Bhat97819a22011-12-01 22:33:10 +010056bool freezer_test_done;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +010057
Lionel Debroux073ef1f2010-11-09 21:48:49 +010058static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070059
60/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020061 * hibernation_set_ops - Set the global hibernate operations.
62 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070063 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010064void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070065{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010066 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
67 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010068 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070069 WARN_ON(1);
70 return;
71 }
72 mutex_lock(&pm_mutex);
73 hibernation_ops = ops;
74 if (ops)
75 hibernation_mode = HIBERNATION_PLATFORM;
76 else if (hibernation_mode == HIBERNATION_PLATFORM)
77 hibernation_mode = HIBERNATION_SHUTDOWN;
78
79 mutex_unlock(&pm_mutex);
80}
81
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010082static bool entering_platform_hibernation;
83
84bool system_entering_hibernation(void)
85{
86 return entering_platform_hibernation;
87}
88EXPORT_SYMBOL(system_entering_hibernation);
89
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010090#ifdef CONFIG_PM_DEBUG
91static void hibernation_debug_sleep(void)
92{
93 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
94 mdelay(5000);
95}
96
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010097static int hibernation_test(int level)
98{
99 if (pm_test_level == level) {
100 hibernation_debug_sleep();
101 return 1;
102 }
103 return 0;
104}
105#else /* !CONFIG_PM_DEBUG */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100106static int hibernation_test(int level) { return 0; }
107#endif /* !CONFIG_PM_DEBUG */
108
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700109/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200110 * platform_begin - Call platform to start hibernation.
111 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700112 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100113static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700114{
115 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100116 hibernation_ops->begin() : 0;
117}
118
119/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200120 * platform_end - Call platform to finish transition to the working state.
121 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100122 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100123static void platform_end(int platform_mode)
124{
125 if (platform_mode && hibernation_ops)
126 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700127}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200130 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
131 * @platform_mode: Whether or not to use the platform driver.
132 *
133 * Use the platform driver to prepare the system for creating a hibernate image,
134 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800135 */
136
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700137static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800138{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700139 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700140 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800141}
142
143/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200144 * platform_leave - Call platform to prepare a transition to the working state.
145 * @platform_mode: Whether or not to use the platform driver.
146 *
147 * Use the platform driver prepare to prepare the machine for switching to the
148 * normal mode of operation.
149 *
150 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700151 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700152static void platform_leave(int platform_mode)
153{
154 if (platform_mode && hibernation_ops)
155 hibernation_ops->leave();
156}
157
158/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200159 * platform_finish - Call platform to switch the system to the working state.
160 * @platform_mode: Whether or not to use the platform driver.
161 *
162 * Use the platform driver to switch the machine to the normal mode of
163 * operation.
164 *
165 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700166 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700167static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700168{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700169 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700170 hibernation_ops->finish();
171}
172
173/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200174 * platform_pre_restore - Prepare for hibernate image restoration.
175 * @platform_mode: Whether or not to use the platform driver.
176 *
177 * Use the platform driver to prepare the system for resume from a hibernation
178 * image.
179 *
180 * If the restore fails after this function has been called,
181 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700182 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700183static int platform_pre_restore(int platform_mode)
184{
185 return (platform_mode && hibernation_ops) ?
186 hibernation_ops->pre_restore() : 0;
187}
188
189/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200190 * platform_restore_cleanup - Switch to the working state after failing restore.
191 * @platform_mode: Whether or not to use the platform driver.
192 *
193 * Use the platform driver to switch the system to the normal mode of operation
194 * after a failing restore.
195 *
196 * If platform_pre_restore() has been called before the failing restore, this
197 * function must be called too, regardless of the result of
198 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700199 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700200static void platform_restore_cleanup(int platform_mode)
201{
202 if (platform_mode && hibernation_ops)
203 hibernation_ops->restore_cleanup();
204}
205
206/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200207 * platform_recover - Recover from a failure to suspend devices.
208 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200209 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200210static void platform_recover(int platform_mode)
211{
212 if (platform_mode && hibernation_ops && hibernation_ops->recover)
213 hibernation_ops->recover();
214}
215
216/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200217 * swsusp_show_speed - Print time elapsed between two events during hibernation.
218 * @start: Starting event.
219 * @stop: Final event.
220 * @nr_pages: Number of memory pages processed between @start and @stop.
221 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100222 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100223void swsusp_show_speed(struct timeval *start, struct timeval *stop,
224 unsigned nr_pages, char *msg)
225{
226 s64 elapsed_centisecs64;
227 int centisecs;
228 int k;
229 int kps;
230
231 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
232 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
233 centisecs = elapsed_centisecs64;
234 if (centisecs == 0)
235 centisecs = 1; /* avoid div-by-zero */
236 k = nr_pages * (PAGE_SIZE / 1024);
237 kps = (k * 100) / centisecs;
238 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
239 msg, k,
240 centisecs / 100, centisecs % 100,
241 kps / 1000, (kps % 1000) / 10);
242}
243
244/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200245 * create_image - Create a hibernation image.
246 * @platform_mode: Whether or not to use the platform driver.
247 *
248 * Execute device drivers' .freeze_noirq() callbacks, create a hibernation image
249 * and execute the drivers' .thaw_noirq() callbacks.
250 *
251 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700252 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800253static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700254{
255 int error;
256
Alan Sternd1616302009-05-24 22:05:42 +0200257 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700258 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100259 printk(KERN_ERR "PM: Some devices failed to power down, "
260 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200261 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700262 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100263
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100264 error = platform_pre_snapshot(platform_mode);
265 if (error || hibernation_test(TEST_PLATFORM))
266 goto Platform_finish;
267
268 error = disable_nonboot_cpus();
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100269 if (error || hibernation_test(TEST_CPUS))
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100270 goto Enable_cpus;
271
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100272 local_irq_disable();
273
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200274 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100275 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200276 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100277 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100278 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100279 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700280
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100281 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100282 goto Power_up;
283
284 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700285 save_processor_state();
286 error = swsusp_arch_suspend();
287 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100288 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
289 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700290 /* Restore control flow magically appears here */
291 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200292 if (!in_suspend) {
293 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700294 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200295 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100296
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100297 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100298 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100299
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100300 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100301 local_irq_enable();
302
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100303 Enable_cpus:
304 enable_nonboot_cpus();
305
306 Platform_finish:
307 platform_finish(platform_mode);
308
Alan Sternd1616302009-05-24 22:05:42 +0200309 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200310 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100311
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700312 return error;
313}
314
315/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200316 * hibernation_snapshot - Quiesce devices and create a hibernation image.
317 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700318 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200319 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700320 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700321int hibernation_snapshot(int platform_mode)
322{
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100323 pm_message_t msg;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100324 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700325
Zhang Rui3fe03132008-10-26 20:50:26 +0100326 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700327 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200328 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700329
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200330 /* Preallocate image memory before shutting down devices. */
331 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700332 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200333 goto Close;
334
335 error = freeze_kernel_threads();
336 if (error)
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100337 goto Cleanup;
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200338
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100339 if (hibernation_test(TEST_FREEZER)) {
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100340
341 /*
342 * Indicate to the caller that we are returning due to a
343 * successful freezer test.
344 */
345 freezer_test_done = true;
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100346 goto Cleanup;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100347 }
348
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200349 error = dpm_prepare(PMSG_FREEZE);
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100350 if (error) {
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100351 dpm_complete(PMSG_RECOVER);
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100352 goto Cleanup;
353 }
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700354
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700355 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100356 pm_restrict_gfp_mask();
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100357
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200358 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700359
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100360 if (error || hibernation_test(TEST_DEVICES))
361 platform_recover(platform_mode);
362 else
363 error = create_image(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700364
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100365 /*
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100366 * In the case that we call create_image() above, the control
367 * returns here (1) after the image has been created or the
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100368 * image creation has failed and (2) after a successful restore.
369 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100370
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200371 /* We may need to release the preallocated image pages here. */
372 if (error || !in_suspend)
373 swsusp_free();
374
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200375 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
376 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100377
378 if (error || !in_suspend)
379 pm_restore_gfp_mask();
380
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700381 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200382 dpm_complete(msg);
383
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100384 Close:
385 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700386 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200387
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100388 Cleanup:
389 swsusp_free();
390 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700391}
392
393/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200394 * resume_target_kernel - Restore system state from a hibernation image.
395 * @platform_mode: Whether or not to use the platform driver.
396 *
397 * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
398 * highmem that have not been restored yet from the image and run the low-level
399 * code that will restore the remaining contents of memory and switch to the
400 * just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100401 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100402static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100403{
404 int error;
405
Alan Sternd1616302009-05-24 22:05:42 +0200406 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100407 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100408 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100409 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200410 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100411 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100412
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100413 error = platform_pre_restore(platform_mode);
414 if (error)
415 goto Cleanup;
416
417 error = disable_nonboot_cpus();
418 if (error)
419 goto Enable_cpus;
420
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100421 local_irq_disable();
422
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200423 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100424 if (error)
425 goto Enable_irqs;
426
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100427 save_processor_state();
428 error = restore_highmem();
429 if (!error) {
430 error = swsusp_arch_resume();
431 /*
432 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200433 * Otherwise, execution continues at the place where
434 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100435 */
436 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200437 /*
438 * This call to restore_highmem() reverts the changes made by
439 * the previous one.
440 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100441 restore_highmem();
442 }
443 /*
444 * The only reason why swsusp_arch_resume() can fail is memory being
445 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200446 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100447 */
448 swsusp_free();
449 restore_processor_state();
450 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100451
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100452 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100453
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100454 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100455 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100456
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100457 Enable_cpus:
458 enable_nonboot_cpus();
459
460 Cleanup:
461 platform_restore_cleanup(platform_mode);
462
Alan Sternd1616302009-05-24 22:05:42 +0200463 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100464
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100465 return error;
466}
467
468/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200469 * hibernation_restore - Quiesce devices and restore from a hibernation image.
470 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700471 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200472 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200473 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700474 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700475int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700476{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100477 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700478
479 pm_prepare_console();
480 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100481 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200482 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700483 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100484 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200485 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700486 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100487 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700488 resume_console();
489 pm_restore_console();
490 return error;
491}
492
493/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200494 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700495 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700496int hibernation_platform_enter(void)
497{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100498 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700499
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700500 if (!hibernation_ops)
501 return -ENOSYS;
502
503 /*
504 * We have cancelled the power transition by running
505 * hibernation_ops->finish() before saving the image, so we should let
506 * the firmware know that we're going to enter the sleep state after all
507 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100508 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700509 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100510 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700511
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100512 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700513 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200514 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200515 if (error) {
516 if (hibernation_ops->recover)
517 hibernation_ops->recover();
518 goto Resume_devices;
519 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700520
Alan Sternd1616302009-05-24 22:05:42 +0200521 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100522 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200523 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100524
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100525 error = hibernation_ops->prepare();
526 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200527 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100528
529 error = disable_nonboot_cpus();
530 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200531 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100532
533 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100534 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100535 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200536 error = -EAGAIN;
537 goto Power_up;
538 }
539
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100540 hibernation_ops->enter();
541 /* We should never get here */
542 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700543
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200544 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100545 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200546 local_irq_enable();
547 enable_nonboot_cpus();
548
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200549 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700550 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100551
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200552 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100553
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700554 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100555 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200556 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700557 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100558
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100559 Close:
560 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100561
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700562 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700563}
564
565/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200566 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200568 * Use the platform driver, if configured, to put the system into the sleep
569 * state corresponding to hibernation, or try to power it off or reboot,
570 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 */
Johannes Bergfe0c9352007-04-30 15:09:51 -0700572static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700574 switch (hibernation_mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700575 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600576 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700578 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700579 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700580 case HIBERNATION_SHUTDOWN:
581 kernel_power_off();
582 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600584 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700585 /*
586 * Valid image is on the disk, if we continue we risk serious data
587 * corruption after resume.
588 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100589 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 while(1);
591}
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593static int prepare_processes(void)
594{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800595 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 if (freeze_processes()) {
598 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100599 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700601 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602}
603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200605 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700607int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608{
609 int error;
610
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700611 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700612 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700613 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
614 error = -EBUSY;
615 goto Unlock;
616 }
617
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100618 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700619 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
620 if (error)
621 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700622
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700623 error = usermodehelper_disable();
624 if (error)
625 goto Exit;
626
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700627 /* Allocate memory management structures */
628 error = create_basic_memory_bitmaps();
629 if (error)
630 goto Exit;
631
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100632 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700633 sys_sync();
634 printk("done.\n");
635
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700637 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700638 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700640 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200641 if (error)
642 goto Thaw;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100643 if (freezer_test_done) {
644 freezer_test_done = false;
645 goto Thaw;
646 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200647
648 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700649 unsigned int flags = 0;
650
651 if (hibernation_mode == HIBERNATION_PLATFORM)
652 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200653 if (nocompress)
654 flags |= SF_NOCOMPRESS_MODE;
Bojan Smojver081a9d02011-10-13 23:58:07 +0200655 else
656 flags |= SF_CRC32_MODE;
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700659 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700660 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700662 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100663 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100664 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800665 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800667 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200668
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800669 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100670 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700671 Finish:
672 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700673 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700674 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700675 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100676 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700677 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700678 Unlock:
679 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 return error;
681}
682
683
684/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200685 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200687 * This routine is called as a late initcall, when all devices have been
688 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200690 * The image reading code is called to see if there is a hibernation image
691 * available for reading. If that is the case, devices are quiesced and the
692 * contents of memory is restored from the saved image.
693 *
694 * If this is successful, control reappears in the restored target kernel in
695 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
696 * attempts to recover gracefully and make the kernel return to the normal mode
697 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699static int software_resume(void)
700{
701 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700702 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Johannes Berg60a0d232007-11-14 17:00:16 -0800704 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100705 * If the user said "noresume".. bail out early.
706 */
707 if (noresume)
708 return 0;
709
710 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800711 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
712 * is configured into the kernel. Since the regular hibernate
713 * trigger path is via sysfs which takes a buffer mutex before
714 * calling hibernate functions (which take pm_mutex) this can
715 * cause lockdep to complain about a possible ABBA deadlock
716 * which cannot happen since we're in the boot code here and
717 * sysfs can't be invoked yet. Therefore, we use a subclass
718 * here to avoid lockdep complaining.
719 */
720 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200721
722 if (swsusp_resume_device)
723 goto Check_image;
724
725 if (!strlen(resume_file)) {
726 error = -ENOENT;
727 goto Unlock;
728 }
729
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200730 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200731
Barry Songf126f732011-10-10 23:38:41 +0200732 if (resume_delay) {
733 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
734 resume_delay);
735 ssleep(resume_delay);
736 }
737
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200738 /* Check if the device is there */
739 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700740 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100741 /*
742 * Some device discovery might still be in progress; we need
743 * to wait for this to finish.
744 */
745 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200746
747 if (resume_wait) {
748 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
749 msleep(10);
750 async_synchronize_full();
751 }
752
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200753 /*
754 * We can't depend on SCSI devices being available after loading
755 * one of their modules until scsi_complete_async_scans() is
756 * called and the resume device usually is a SCSI one.
757 */
758 scsi_complete_async_scans();
759
Pavel Machek3efa1472005-07-07 17:56:43 -0700760 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200761 if (!swsusp_resume_device) {
762 error = -ENODEV;
763 goto Unlock;
764 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700765 }
766
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200767 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200768 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200769 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200771 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800772 error = swsusp_check();
773 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700774 goto Unlock;
775
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700776 /* The snapshot device should not be opened while we're running */
777 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
778 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200779 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700780 goto Unlock;
781 }
782
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100783 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100784 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
785 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200786 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100787
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700788 error = usermodehelper_disable();
789 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200790 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700791
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700792 error = create_basic_memory_bitmaps();
Srivatsa S. Bhat01185212011-12-01 22:32:43 +0100793 if (error) {
794 usermodehelper_enable();
Jiri Slaby76b57e62009-10-07 22:37:35 +0200795 goto close_finish;
Srivatsa S. Bhat01185212011-12-01 22:32:43 +0100796 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
798 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800799 error = prepare_processes();
800 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400801 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700802 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 }
804
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200805 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700807 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200808 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800809 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700810 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200812 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700813 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100814 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700816 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700817 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700818 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100819 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100820 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700821 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700822 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700823 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800824 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200825 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700826 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200827close_finish:
828 swsusp_close(FMODE_READ);
829 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830}
831
832late_initcall(software_resume);
833
834
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700835static const char * const hibernation_modes[] = {
836 [HIBERNATION_PLATFORM] = "platform",
837 [HIBERNATION_SHUTDOWN] = "shutdown",
838 [HIBERNATION_REBOOT] = "reboot",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839};
840
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200841/*
842 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200844 * Hibernation can be handled in several ways. There are a few different ways
845 * to put the system into the sleep state: using the platform driver (e.g. ACPI
846 * or other hibernation_ops), powering it off or rebooting it (for testing
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100847 * mostly).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200849 * The sysfs file /sys/power/disk provides an interface for selecting the
850 * hibernation mode to use. Reading from this file causes the available modes
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100851 * to be printed. There are 3 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 * 'platform'
854 * 'shutdown'
855 * 'reboot'
856 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200857 * If a platform hibernation driver is in use, 'platform' will be supported
858 * and will be used by default. Otherwise, 'shutdown' will be used by default.
859 * The selected option (i.e. the one corresponding to the current value of
860 * hibernation_mode) is enclosed by a square bracket.
861 *
862 * To select a given hibernation mode it is necessary to write the mode's
863 * string representation (as returned by reading from /sys/power/disk) back
864 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 */
866
Kay Sievers386f2752007-11-02 13:47:53 +0100867static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
868 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700870 int i;
871 char *start = buf;
872
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700873 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
874 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700875 continue;
876 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700877 case HIBERNATION_SHUTDOWN:
878 case HIBERNATION_REBOOT:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700879 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700880 case HIBERNATION_PLATFORM:
881 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700882 break;
883 /* not a valid mode, continue with loop */
884 continue;
885 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700886 if (i == hibernation_mode)
887 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700888 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700889 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700890 }
891 buf += sprintf(buf, "\n");
892 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893}
894
Kay Sievers386f2752007-11-02 13:47:53 +0100895static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
896 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897{
898 int error = 0;
899 int i;
900 int len;
901 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700902 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
904 p = memchr(buf, '\n', n);
905 len = p ? p - buf : n;
906
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800907 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700908 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700909 if (len == strlen(hibernation_modes[i])
910 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 mode = i;
912 break;
913 }
914 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700915 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700916 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700917 case HIBERNATION_SHUTDOWN:
918 case HIBERNATION_REBOOT:
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700919 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700920 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700921 case HIBERNATION_PLATFORM:
922 if (hibernation_ops)
923 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 else
925 error = -EINVAL;
926 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700927 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 error = -EINVAL;
929
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700930 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100931 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700932 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800933 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 return error ? error : n;
935}
936
937power_attr(disk);
938
Kay Sievers386f2752007-11-02 13:47:53 +0100939static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
940 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941{
942 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
943 MINOR(swsusp_resume_device));
944}
945
Kay Sievers386f2752007-11-02 13:47:53 +0100946static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
947 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800951 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Andrew Mortona5762192006-01-06 00:09:50 -0800953 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
954 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955
Andrew Mortona5762192006-01-06 00:09:50 -0800956 res = MKDEV(maj,min);
957 if (maj != MAJOR(res) || min != MINOR(res))
958 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800960 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800961 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800962 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100963 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800964 noresume = 0;
965 software_resume();
966 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800967 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800968 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969}
970
971power_attr(resume);
972
Kay Sievers386f2752007-11-02 13:47:53 +0100973static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
974 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800975{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800976 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800977}
978
Kay Sievers386f2752007-11-02 13:47:53 +0100979static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
980 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800981{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800982 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800983
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800984 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800985 image_size = size;
986 return n;
987 }
988
989 return -EINVAL;
990}
991
992power_attr(image_size);
993
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +0200994static ssize_t reserved_size_show(struct kobject *kobj,
995 struct kobj_attribute *attr, char *buf)
996{
997 return sprintf(buf, "%lu\n", reserved_size);
998}
999
1000static ssize_t reserved_size_store(struct kobject *kobj,
1001 struct kobj_attribute *attr,
1002 const char *buf, size_t n)
1003{
1004 unsigned long size;
1005
1006 if (sscanf(buf, "%lu", &size) == 1) {
1007 reserved_size = size;
1008 return n;
1009 }
1010
1011 return -EINVAL;
1012}
1013
1014power_attr(reserved_size);
1015
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016static struct attribute * g[] = {
1017 &disk_attr.attr,
1018 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001019 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001020 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 NULL,
1022};
1023
1024
1025static struct attribute_group attr_group = {
1026 .attrs = g,
1027};
1028
1029
1030static int __init pm_disk_init(void)
1031{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001032 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033}
1034
1035core_initcall(pm_disk_init);
1036
1037
1038static int __init resume_setup(char *str)
1039{
1040 if (noresume)
1041 return 1;
1042
1043 strncpy( resume_file, str, 255 );
1044 return 1;
1045}
1046
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001047static int __init resume_offset_setup(char *str)
1048{
1049 unsigned long long offset;
1050
1051 if (noresume)
1052 return 1;
1053
1054 if (sscanf(str, "%llu", &offset) == 1)
1055 swsusp_resume_block = offset;
1056
1057 return 1;
1058}
1059
Bojan Smojverf996fc92010-09-09 23:06:23 +02001060static int __init hibernate_setup(char *str)
1061{
1062 if (!strncmp(str, "noresume", 8))
1063 noresume = 1;
1064 else if (!strncmp(str, "nocompress", 10))
1065 nocompress = 1;
1066 return 1;
1067}
1068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069static int __init noresume_setup(char *str)
1070{
1071 noresume = 1;
1072 return 1;
1073}
1074
Barry Song6f8d7022011-10-06 20:34:46 +02001075static int __init resumewait_setup(char *str)
1076{
1077 resume_wait = 1;
1078 return 1;
1079}
1080
Barry Songf126f732011-10-10 23:38:41 +02001081static int __init resumedelay_setup(char *str)
1082{
1083 resume_delay = simple_strtoul(str, NULL, 0);
1084 return 1;
1085}
1086
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001088__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001090__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001091__setup("resumewait", resumewait_setup);
Barry Songf126f732011-10-10 23:38:41 +02001092__setup("resumedelay=", resumedelay_setup);