blob: 431721313b71fa44bbbbc7b6c291562076252c1e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02002 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
Pavel Macheka2531292010-07-18 14:27:13 +02006 * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02007 * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11
12#include <linux/suspend.h>
13#include <linux/syscalls.h>
14#include <linux/reboot.h>
15#include <linux/string.h>
16#include <linux/device.h>
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -070017#include <linux/kmod.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/delay.h>
19#include <linux/fs.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070020#include <linux/mount.h>
Eric W. Biederman88d10bb2005-09-22 21:43:46 -070021#include <linux/pm.h>
Rafael J. Wysocki97c78012006-10-11 01:20:45 -070022#include <linux/console.h>
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -070023#include <linux/cpu.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080024#include <linux/freezer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/gfp.h>
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +010026#include <linux/syscore_ops.h>
Rafael J. Wysockic7510852009-04-12 20:06:56 +020027#include <scsi/scsi_scan.h>
Magnus Damma8af7892009-03-31 15:23:37 -070028#include <asm/suspend.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include "power.h"
31
32
Bojan Smojverf996fc92010-09-09 23:06:23 +020033static int nocompress = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034static int noresume = 0;
Adrian Bunk47a460d2008-02-04 22:30:06 -080035static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080037sector_t swsusp_resume_block;
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +010038int in_suspend __nosavedata = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070040enum {
41 HIBERNATION_INVALID,
42 HIBERNATION_PLATFORM,
43 HIBERNATION_TEST,
44 HIBERNATION_TESTPROC,
45 HIBERNATION_SHUTDOWN,
46 HIBERNATION_REBOOT,
47 /* keep last */
48 __HIBERNATION_AFTER_LAST
49};
50#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
51#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
52
53static int hibernation_mode = HIBERNATION_SHUTDOWN;
54
Lionel Debroux073ef1f2010-11-09 21:48:49 +010055static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070056
57/**
58 * hibernation_set_ops - set the global hibernate operations
59 * @ops: the hibernation operations to use in subsequent hibernation transitions
60 */
61
Lionel Debroux073ef1f2010-11-09 21:48:49 +010062void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070063{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010064 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
65 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010066 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070067 WARN_ON(1);
68 return;
69 }
70 mutex_lock(&pm_mutex);
71 hibernation_ops = ops;
72 if (ops)
73 hibernation_mode = HIBERNATION_PLATFORM;
74 else if (hibernation_mode == HIBERNATION_PLATFORM)
75 hibernation_mode = HIBERNATION_SHUTDOWN;
76
77 mutex_unlock(&pm_mutex);
78}
79
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010080static bool entering_platform_hibernation;
81
82bool system_entering_hibernation(void)
83{
84 return entering_platform_hibernation;
85}
86EXPORT_SYMBOL(system_entering_hibernation);
87
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010088#ifdef CONFIG_PM_DEBUG
89static void hibernation_debug_sleep(void)
90{
91 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
92 mdelay(5000);
93}
94
95static int hibernation_testmode(int mode)
96{
97 if (hibernation_mode == mode) {
98 hibernation_debug_sleep();
99 return 1;
100 }
101 return 0;
102}
103
104static int hibernation_test(int level)
105{
106 if (pm_test_level == level) {
107 hibernation_debug_sleep();
108 return 1;
109 }
110 return 0;
111}
112#else /* !CONFIG_PM_DEBUG */
113static int hibernation_testmode(int mode) { return 0; }
114static int hibernation_test(int level) { return 0; }
115#endif /* !CONFIG_PM_DEBUG */
116
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700117/**
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100118 * platform_begin - tell the platform driver that we're starting
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700119 * hibernation
120 */
121
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100122static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700123{
124 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100125 hibernation_ops->begin() : 0;
126}
127
128/**
129 * platform_end - tell the platform driver that we've entered the
130 * working state
131 */
132
133static void platform_end(int platform_mode)
134{
135 if (platform_mode && hibernation_ops)
136 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700137}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139/**
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700140 * platform_pre_snapshot - prepare the machine for hibernation using the
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800141 * platform driver if so configured and return an error code if it fails
142 */
143
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700144static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800145{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700146 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700147 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800148}
149
150/**
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700151 * platform_leave - prepare the machine for switching to the normal mode
152 * of operation using the platform driver (called with interrupts disabled)
153 */
154
155static void platform_leave(int platform_mode)
156{
157 if (platform_mode && hibernation_ops)
158 hibernation_ops->leave();
159}
160
161/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700162 * platform_finish - switch the machine to the normal mode of operation
163 * using the platform driver (must be called after platform_prepare())
164 */
165
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700166static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700167{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700168 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700169 hibernation_ops->finish();
170}
171
172/**
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700173 * platform_pre_restore - prepare the platform for the restoration from a
174 * hibernation image. If the restore fails after this function has been
175 * called, platform_restore_cleanup() must be called.
176 */
177
178static int platform_pre_restore(int platform_mode)
179{
180 return (platform_mode && hibernation_ops) ?
181 hibernation_ops->pre_restore() : 0;
182}
183
184/**
185 * platform_restore_cleanup - switch the platform to the normal mode of
186 * operation after a failing restore. If platform_pre_restore() has been
187 * called before the failing restore, this function must be called too,
188 * regardless of the result of platform_pre_restore().
189 */
190
191static void platform_restore_cleanup(int platform_mode)
192{
193 if (platform_mode && hibernation_ops)
194 hibernation_ops->restore_cleanup();
195}
196
197/**
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200198 * platform_recover - recover the platform from a failure to suspend
199 * devices.
200 */
201
202static void platform_recover(int platform_mode)
203{
204 if (platform_mode && hibernation_ops && hibernation_ops->recover)
205 hibernation_ops->recover();
206}
207
208/**
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100209 * swsusp_show_speed - print the time elapsed between two events.
210 * @start: Starting event.
211 * @stop: Final event.
212 * @nr_pages - number of pages processed between @start and @stop
213 * @msg - introductory message to print
214 */
215
216void swsusp_show_speed(struct timeval *start, struct timeval *stop,
217 unsigned nr_pages, char *msg)
218{
219 s64 elapsed_centisecs64;
220 int centisecs;
221 int k;
222 int kps;
223
224 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
225 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
226 centisecs = elapsed_centisecs64;
227 if (centisecs == 0)
228 centisecs = 1; /* avoid div-by-zero */
229 k = nr_pages * (PAGE_SIZE / 1024);
230 kps = (k * 100) / centisecs;
231 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
232 msg, k,
233 centisecs / 100, centisecs % 100,
234 kps / 1000, (kps % 1000) / 10);
235}
236
237/**
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700238 * create_image - freeze devices that need to be frozen with interrupts
239 * off, create the hibernation image and thaw those devices. Control
240 * reappears in this routine after a restore.
241 */
242
Adrian Bunk47a460d2008-02-04 22:30:06 -0800243static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700244{
245 int error;
246
247 error = arch_prepare_suspend();
248 if (error)
249 return error;
250
Alan Sternd1616302009-05-24 22:05:42 +0200251 /* At this point, dpm_suspend_start() has been called, but *not*
252 * dpm_suspend_noirq(). We *must* call dpm_suspend_noirq() now.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700253 * Otherwise, drivers for some devices (e.g. interrupt controllers)
254 * become desynchronized with the actual state of the hardware
255 * at resume time, and evil weirdness ensues.
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();
269 if (error || hibernation_test(TEST_CPUS)
270 || hibernation_testmode(HIBERNATION_TEST))
271 goto Enable_cpus;
272
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100273 local_irq_disable();
274
Bjorn Helgaas44840792009-05-15 23:30:50 +0200275 error = sysdev_suspend(PMSG_FREEZE);
Rafael J. Wysocki2ca6f62f2011-04-18 23:58:59 +0200276 if (!error) {
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100277 error = syscore_suspend();
Rafael J. Wysocki2ca6f62f2011-04-18 23:58:59 +0200278 if (error)
279 sysdev_resume();
280 }
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100281 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200282 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100283 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100284 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100285 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700286
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100287 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100288 goto Power_up;
289
290 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700291 save_processor_state();
292 error = swsusp_arch_suspend();
293 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100294 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
295 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700296 /* Restore control flow magically appears here */
297 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200298 if (!in_suspend) {
299 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700300 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200301 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100302
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100303 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100304 syscore_resume();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100305 sysdev_resume();
Alan Sternd1616302009-05-24 22:05:42 +0200306 /* NOTE: dpm_resume_noirq() is just a resume() for devices
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700307 * that suspended with irqs off ... no overall powerup.
308 */
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100309
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100310 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100311 local_irq_enable();
312
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100313 Enable_cpus:
314 enable_nonboot_cpus();
315
316 Platform_finish:
317 platform_finish(platform_mode);
318
Alan Sternd1616302009-05-24 22:05:42 +0200319 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200320 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100321
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700322 return error;
323}
324
325/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700326 * hibernation_snapshot - quiesce devices and create the hibernation
327 * snapshot image.
328 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100329 * prepare the platform firmware for the power transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700330 *
331 * Must be called with pm_mutex held
332 */
333
334int hibernation_snapshot(int platform_mode)
335{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100336 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700337
Zhang Rui3fe03132008-10-26 20:50:26 +0100338 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700339 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200340 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700341
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200342 /* Preallocate image memory before shutting down devices. */
343 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700344 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100345 goto Close;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700346
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700347 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100348 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200349 error = dpm_suspend_start(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700350 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200351 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700352
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100353 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200354 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700355
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100356 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100357 /*
358 * Control returns here (1) after the image has been created or the
359 * image creation has failed and (2) after a successful restore.
360 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100361
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100362 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200363 /* We may need to release the preallocated image pages here. */
364 if (error || !in_suspend)
365 swsusp_free();
366
Alan Sternd1616302009-05-24 22:05:42 +0200367 dpm_resume_end(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200368 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100369
370 if (error || !in_suspend)
371 pm_restore_gfp_mask();
372
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700373 resume_console();
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100374 Close:
375 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700376 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200377
378 Recover_platform:
379 platform_recover(platform_mode);
380 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700381}
382
383/**
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100384 * resume_target_kernel - prepare devices that need to be suspended with
385 * interrupts off, restore the contents of highmem that have not been
386 * restored yet from the image and run the low level code that will restore
387 * the remaining contents of memory and switch to the just restored target
388 * kernel.
389 */
390
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100391static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100392{
393 int error;
394
Alan Sternd1616302009-05-24 22:05:42 +0200395 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100396 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100397 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100398 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200399 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100400 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100401
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100402 error = platform_pre_restore(platform_mode);
403 if (error)
404 goto Cleanup;
405
406 error = disable_nonboot_cpus();
407 if (error)
408 goto Enable_cpus;
409
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100410 local_irq_disable();
411
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100412 error = sysdev_suspend(PMSG_QUIESCE);
Rafael J. Wysocki2ca6f62f2011-04-18 23:58:59 +0200413 if (!error) {
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100414 error = syscore_suspend();
Rafael J. Wysocki2ca6f62f2011-04-18 23:58:59 +0200415 if (error)
416 sysdev_resume();
417 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100418 if (error)
419 goto Enable_irqs;
420
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100421 /* We'll ignore saved state, but this gets preempt count (etc) right */
422 save_processor_state();
423 error = restore_highmem();
424 if (!error) {
425 error = swsusp_arch_resume();
426 /*
427 * The code below is only ever reached in case of a failure.
428 * Otherwise execution continues at place where
429 * swsusp_arch_suspend() was called
430 */
431 BUG_ON(!error);
432 /* This call to restore_highmem() undos the previous one */
433 restore_highmem();
434 }
435 /*
436 * The only reason why swsusp_arch_resume() can fail is memory being
437 * very tight, so we have to free it as soon as we can to avoid
438 * subsequent failures
439 */
440 swsusp_free();
441 restore_processor_state();
442 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100443
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100444 syscore_resume();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100445 sysdev_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100446
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100447 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100448 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100449
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100450 Enable_cpus:
451 enable_nonboot_cpus();
452
453 Cleanup:
454 platform_restore_cleanup(platform_mode);
455
Alan Sternd1616302009-05-24 22:05:42 +0200456 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100457
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100458 return error;
459}
460
461/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700462 * hibernation_restore - quiesce devices and restore the hibernation
463 * snapshot image. If successful, control returns in hibernation_snaphot()
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700464 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100465 * prepare the platform firmware for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700466 *
467 * Must be called with pm_mutex held
468 */
469
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700470int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700471{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100472 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700473
474 pm_prepare_console();
475 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100476 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200477 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700478 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100479 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200480 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700481 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100482 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700483 resume_console();
484 pm_restore_console();
485 return error;
486}
487
488/**
489 * hibernation_platform_enter - enter the hibernation state using the
490 * platform driver (if available)
491 */
492
493int hibernation_platform_enter(void)
494{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100495 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700496
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700497 if (!hibernation_ops)
498 return -ENOSYS;
499
500 /*
501 * We have cancelled the power transition by running
502 * hibernation_ops->finish() before saving the image, so we should let
503 * the firmware know that we're going to enter the sleep state after all
504 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100505 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700506 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100507 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700508
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100509 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700510 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200511 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200512 if (error) {
513 if (hibernation_ops->recover)
514 hibernation_ops->recover();
515 goto Resume_devices;
516 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700517
Alan Sternd1616302009-05-24 22:05:42 +0200518 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100519 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200520 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100521
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100522 error = hibernation_ops->prepare();
523 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200524 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100525
526 error = disable_nonboot_cpus();
527 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200528 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100529
530 local_irq_disable();
531 sysdev_suspend(PMSG_HIBERNATE);
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100532 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100533 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200534 error = -EAGAIN;
535 goto Power_up;
536 }
537
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100538 hibernation_ops->enter();
539 /* We should never get here */
540 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700541
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200542 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100543 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200544 sysdev_resume();
545 local_irq_enable();
546 enable_nonboot_cpus();
547
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200548 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700549 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100550
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200551 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100552
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700553 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100554 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200555 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700556 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100557
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100558 Close:
559 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100560
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700561 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700562}
563
564/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700565 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 *
Johannes Bergfe0c9352007-04-30 15:09:51 -0700567 * Use the platform driver, if configured so; otherwise try
568 * to power off or reboot.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 */
570
Johannes Bergfe0c9352007-04-30 15:09:51 -0700571static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700573 switch (hibernation_mode) {
574 case HIBERNATION_TEST:
575 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700576 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700577 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600578 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700580 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700581 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700582 case HIBERNATION_SHUTDOWN:
583 kernel_power_off();
584 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600586 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700587 /*
588 * Valid image is on the disk, if we continue we risk serious data
589 * corruption after resume.
590 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100591 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 while(1);
593}
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595static int prepare_processes(void)
596{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800597 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 if (freeze_processes()) {
600 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100601 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700603 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604}
605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700607 * hibernate - The granpappy of the built-in hibernation management
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 */
609
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700610int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
612 int error;
613
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700614 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700615 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700616 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
617 error = -EBUSY;
618 goto Unlock;
619 }
620
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100621 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700622 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
623 if (error)
624 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700625
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700626 error = usermodehelper_disable();
627 if (error)
628 goto Exit;
629
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700630 /* Allocate memory management structures */
631 error = create_basic_memory_bitmaps();
632 if (error)
633 goto Exit;
634
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100635 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700636 sys_sync();
637 printk("done.\n");
638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700640 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700641 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100643 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800644 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100645
646 if (hibernation_testmode(HIBERNATION_TESTPROC))
647 goto Thaw;
648
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700649 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200650 if (error)
651 goto Thaw;
652
653 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700654 unsigned int flags = 0;
655
656 if (hibernation_mode == HIBERNATION_PLATFORM)
657 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200658 if (nocompress)
659 flags |= SF_NOCOMPRESS_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700661 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700662 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700664 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100665 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100666 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800667 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800669 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200670
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800671 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100672 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700673 Finish:
674 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700675 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700676 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700677 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100678 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700679 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700680 Unlock:
681 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 return error;
683}
684
685
686/**
687 * software_resume - Resume from a saved image.
688 *
689 * Called as a late_initcall (so all devices are discovered and
690 * initialized), we call swsusp to see if we have a saved image or not.
691 * If so, we quiesce devices, the restore the saved image. We will
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700692 * return above (in hibernate() ) if everything goes well.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 * Otherwise, we fail gracefully and return to the normally
694 * scheduled program.
695 *
696 */
697
698static int software_resume(void)
699{
700 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700701 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Johannes Berg60a0d232007-11-14 17:00:16 -0800703 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100704 * If the user said "noresume".. bail out early.
705 */
706 if (noresume)
707 return 0;
708
709 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800710 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
711 * is configured into the kernel. Since the regular hibernate
712 * trigger path is via sysfs which takes a buffer mutex before
713 * calling hibernate functions (which take pm_mutex) this can
714 * cause lockdep to complain about a possible ABBA deadlock
715 * which cannot happen since we're in the boot code here and
716 * sysfs can't be invoked yet. Therefore, we use a subclass
717 * here to avoid lockdep complaining.
718 */
719 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200720
721 if (swsusp_resume_device)
722 goto Check_image;
723
724 if (!strlen(resume_file)) {
725 error = -ENOENT;
726 goto Unlock;
727 }
728
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200729 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200730
731 /* Check if the device is there */
732 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700733 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100734 /*
735 * Some device discovery might still be in progress; we need
736 * to wait for this to finish.
737 */
738 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200739 /*
740 * We can't depend on SCSI devices being available after loading
741 * one of their modules until scsi_complete_async_scans() is
742 * called and the resume device usually is a SCSI one.
743 */
744 scsi_complete_async_scans();
745
Pavel Machek3efa1472005-07-07 17:56:43 -0700746 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200747 if (!swsusp_resume_device) {
748 error = -ENODEV;
749 goto Unlock;
750 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700751 }
752
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200753 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200754 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200755 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200757 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800758 error = swsusp_check();
759 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700760 goto Unlock;
761
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700762 /* The snapshot device should not be opened while we're running */
763 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
764 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200765 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700766 goto Unlock;
767 }
768
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100769 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100770 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
771 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200772 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100773
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700774 error = usermodehelper_disable();
775 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200776 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700777
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700778 error = create_basic_memory_bitmaps();
779 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200780 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
782 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800783 error = prepare_processes();
784 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400785 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700786 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 }
788
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200789 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700791 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200792 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800793 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700794 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200796 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700797 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100798 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700800 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700801 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700802 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100803 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100804 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700805 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700806 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700807 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800808 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200809 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700810 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200811close_finish:
812 swsusp_close(FMODE_READ);
813 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814}
815
816late_initcall(software_resume);
817
818
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700819static const char * const hibernation_modes[] = {
820 [HIBERNATION_PLATFORM] = "platform",
821 [HIBERNATION_SHUTDOWN] = "shutdown",
822 [HIBERNATION_REBOOT] = "reboot",
823 [HIBERNATION_TEST] = "test",
824 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825};
826
827/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700828 * disk - Control hibernation mode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700830 * Suspend-to-disk can be handled in several ways. We have a few options
831 * for putting the system to sleep - using the platform driver (e.g. ACPI
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700832 * or other hibernation_ops), powering off the system or rebooting the
833 * system (for testing) as well as the two test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700835 * The system can support 'platform', and that is known a priori (and
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700836 * encoded by the presence of hibernation_ops). However, the user may
837 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
838 * test modes, 'test' or 'testproc'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 *
840 * show() will display what the mode is currently set to.
841 * store() will accept one of
842 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 * 'platform'
844 * 'shutdown'
845 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700846 * 'test'
847 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700849 * It will only change to 'platform' if the system
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700850 * supports it (as determined by having hibernation_ops).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 */
852
Kay Sievers386f2752007-11-02 13:47:53 +0100853static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
854 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700856 int i;
857 char *start = buf;
858
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700859 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
860 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700861 continue;
862 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700863 case HIBERNATION_SHUTDOWN:
864 case HIBERNATION_REBOOT:
865 case HIBERNATION_TEST:
866 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700867 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700868 case HIBERNATION_PLATFORM:
869 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700870 break;
871 /* not a valid mode, continue with loop */
872 continue;
873 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700874 if (i == hibernation_mode)
875 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700876 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700877 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700878 }
879 buf += sprintf(buf, "\n");
880 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881}
882
883
Kay Sievers386f2752007-11-02 13:47:53 +0100884static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
885 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886{
887 int error = 0;
888 int i;
889 int len;
890 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700891 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
893 p = memchr(buf, '\n', n);
894 len = p ? p - buf : n;
895
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800896 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700897 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700898 if (len == strlen(hibernation_modes[i])
899 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 mode = i;
901 break;
902 }
903 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700904 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700905 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700906 case HIBERNATION_SHUTDOWN:
907 case HIBERNATION_REBOOT:
908 case HIBERNATION_TEST:
909 case HIBERNATION_TESTPROC:
910 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700911 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700912 case HIBERNATION_PLATFORM:
913 if (hibernation_ops)
914 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 else
916 error = -EINVAL;
917 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700918 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 error = -EINVAL;
920
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700921 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100922 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700923 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800924 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 return error ? error : n;
926}
927
928power_attr(disk);
929
Kay Sievers386f2752007-11-02 13:47:53 +0100930static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
931 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932{
933 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
934 MINOR(swsusp_resume_device));
935}
936
Kay Sievers386f2752007-11-02 13:47:53 +0100937static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
938 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800942 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
Andrew Mortona5762192006-01-06 00:09:50 -0800944 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
945 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
Andrew Mortona5762192006-01-06 00:09:50 -0800947 res = MKDEV(maj,min);
948 if (maj != MAJOR(res) || min != MINOR(res))
949 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800951 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800952 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800953 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100954 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800955 noresume = 0;
956 software_resume();
957 ret = n;
Rafael J. Wysocki59a49332006-12-06 20:34:44 -0800958 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800959 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960}
961
962power_attr(resume);
963
Kay Sievers386f2752007-11-02 13:47:53 +0100964static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
965 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800966{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800967 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800968}
969
Kay Sievers386f2752007-11-02 13:47:53 +0100970static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
971 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800972{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800973 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800974
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800975 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800976 image_size = size;
977 return n;
978 }
979
980 return -EINVAL;
981}
982
983power_attr(image_size);
984
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +0200985static ssize_t reserved_size_show(struct kobject *kobj,
986 struct kobj_attribute *attr, char *buf)
987{
988 return sprintf(buf, "%lu\n", reserved_size);
989}
990
991static ssize_t reserved_size_store(struct kobject *kobj,
992 struct kobj_attribute *attr,
993 const char *buf, size_t n)
994{
995 unsigned long size;
996
997 if (sscanf(buf, "%lu", &size) == 1) {
998 reserved_size = size;
999 return n;
1000 }
1001
1002 return -EINVAL;
1003}
1004
1005power_attr(reserved_size);
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007static struct attribute * g[] = {
1008 &disk_attr.attr,
1009 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001010 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001011 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 NULL,
1013};
1014
1015
1016static struct attribute_group attr_group = {
1017 .attrs = g,
1018};
1019
1020
1021static int __init pm_disk_init(void)
1022{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001023 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024}
1025
1026core_initcall(pm_disk_init);
1027
1028
1029static int __init resume_setup(char *str)
1030{
1031 if (noresume)
1032 return 1;
1033
1034 strncpy( resume_file, str, 255 );
1035 return 1;
1036}
1037
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001038static int __init resume_offset_setup(char *str)
1039{
1040 unsigned long long offset;
1041
1042 if (noresume)
1043 return 1;
1044
1045 if (sscanf(str, "%llu", &offset) == 1)
1046 swsusp_resume_block = offset;
1047
1048 return 1;
1049}
1050
Bojan Smojverf996fc92010-09-09 23:06:23 +02001051static int __init hibernate_setup(char *str)
1052{
1053 if (!strncmp(str, "noresume", 8))
1054 noresume = 1;
1055 else if (!strncmp(str, "nocompress", 10))
1056 nocompress = 1;
1057 return 1;
1058}
1059
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060static int __init noresume_setup(char *str)
1061{
1062 noresume = 1;
1063 return 1;
1064}
1065
1066__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001067__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001069__setup("hibernate=", hibernate_setup);