blob: aeabd26e3342788e4330cfb4e8e2a5ba40b348d0 [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. Wysocki40dc1662011-03-15 00:43:46 +0100276 if (!error)
277 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100278 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200279 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100280 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100281 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100282 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700283
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100284 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100285 goto Power_up;
286
287 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700288 save_processor_state();
289 error = swsusp_arch_suspend();
290 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100291 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
292 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700293 /* Restore control flow magically appears here */
294 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200295 if (!in_suspend) {
296 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700297 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200298 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100299
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100300 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100301 syscore_resume();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100302 sysdev_resume();
Alan Sternd1616302009-05-24 22:05:42 +0200303 /* NOTE: dpm_resume_noirq() is just a resume() for devices
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700304 * that suspended with irqs off ... no overall powerup.
305 */
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100306
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100307 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100308 local_irq_enable();
309
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100310 Enable_cpus:
311 enable_nonboot_cpus();
312
313 Platform_finish:
314 platform_finish(platform_mode);
315
Alan Sternd1616302009-05-24 22:05:42 +0200316 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200317 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100318
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700319 return error;
320}
321
322/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700323 * hibernation_snapshot - quiesce devices and create the hibernation
324 * snapshot image.
325 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100326 * prepare the platform firmware for the power transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700327 *
328 * Must be called with pm_mutex held
329 */
330
331int hibernation_snapshot(int platform_mode)
332{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100333 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700334
Zhang Rui3fe03132008-10-26 20:50:26 +0100335 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700336 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200337 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700338
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200339 /* Preallocate image memory before shutting down devices. */
340 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700341 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100342 goto Close;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700343
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700344 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100345 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200346 error = dpm_suspend_start(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700347 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200348 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700349
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100350 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200351 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700352
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100353 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100354 /*
355 * Control returns here (1) after the image has been created or the
356 * image creation has failed and (2) after a successful restore.
357 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100358
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100359 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200360 /* We may need to release the preallocated image pages here. */
361 if (error || !in_suspend)
362 swsusp_free();
363
Alan Sternd1616302009-05-24 22:05:42 +0200364 dpm_resume_end(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200365 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100366
367 if (error || !in_suspend)
368 pm_restore_gfp_mask();
369
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700370 resume_console();
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100371 Close:
372 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700373 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200374
375 Recover_platform:
376 platform_recover(platform_mode);
377 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700378}
379
380/**
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100381 * resume_target_kernel - prepare devices that need to be suspended with
382 * interrupts off, restore the contents of highmem that have not been
383 * restored yet from the image and run the low level code that will restore
384 * the remaining contents of memory and switch to the just restored target
385 * kernel.
386 */
387
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100388static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100389{
390 int error;
391
Alan Sternd1616302009-05-24 22:05:42 +0200392 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100393 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100394 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100395 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200396 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100397 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100398
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100399 error = platform_pre_restore(platform_mode);
400 if (error)
401 goto Cleanup;
402
403 error = disable_nonboot_cpus();
404 if (error)
405 goto Enable_cpus;
406
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100407 local_irq_disable();
408
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100409 error = sysdev_suspend(PMSG_QUIESCE);
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100410 if (!error)
411 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100412 if (error)
413 goto Enable_irqs;
414
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100415 /* We'll ignore saved state, but this gets preempt count (etc) right */
416 save_processor_state();
417 error = restore_highmem();
418 if (!error) {
419 error = swsusp_arch_resume();
420 /*
421 * The code below is only ever reached in case of a failure.
422 * Otherwise execution continues at place where
423 * swsusp_arch_suspend() was called
424 */
425 BUG_ON(!error);
426 /* This call to restore_highmem() undos the previous one */
427 restore_highmem();
428 }
429 /*
430 * The only reason why swsusp_arch_resume() can fail is memory being
431 * very tight, so we have to free it as soon as we can to avoid
432 * subsequent failures
433 */
434 swsusp_free();
435 restore_processor_state();
436 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100437
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100438 syscore_resume();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100439 sysdev_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100440
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100441 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100442 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100443
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100444 Enable_cpus:
445 enable_nonboot_cpus();
446
447 Cleanup:
448 platform_restore_cleanup(platform_mode);
449
Alan Sternd1616302009-05-24 22:05:42 +0200450 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100451
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100452 return error;
453}
454
455/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700456 * hibernation_restore - quiesce devices and restore the hibernation
457 * snapshot image. If successful, control returns in hibernation_snaphot()
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700458 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100459 * prepare the platform firmware for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700460 *
461 * Must be called with pm_mutex held
462 */
463
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700464int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700465{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100466 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700467
468 pm_prepare_console();
469 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100470 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200471 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700472 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100473 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200474 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700475 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100476 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700477 resume_console();
478 pm_restore_console();
479 return error;
480}
481
482/**
483 * hibernation_platform_enter - enter the hibernation state using the
484 * platform driver (if available)
485 */
486
487int hibernation_platform_enter(void)
488{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100489 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700490
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700491 if (!hibernation_ops)
492 return -ENOSYS;
493
494 /*
495 * We have cancelled the power transition by running
496 * hibernation_ops->finish() before saving the image, so we should let
497 * the firmware know that we're going to enter the sleep state after all
498 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100499 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700500 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100501 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700502
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100503 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700504 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200505 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200506 if (error) {
507 if (hibernation_ops->recover)
508 hibernation_ops->recover();
509 goto Resume_devices;
510 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700511
Alan Sternd1616302009-05-24 22:05:42 +0200512 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100513 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200514 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100515
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100516 error = hibernation_ops->prepare();
517 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200518 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100519
520 error = disable_nonboot_cpus();
521 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200522 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100523
524 local_irq_disable();
525 sysdev_suspend(PMSG_HIBERNATE);
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100526 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100527 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200528 error = -EAGAIN;
529 goto Power_up;
530 }
531
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100532 hibernation_ops->enter();
533 /* We should never get here */
534 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700535
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200536 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100537 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200538 sysdev_resume();
539 local_irq_enable();
540 enable_nonboot_cpus();
541
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200542 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700543 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100544
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200545 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100546
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700547 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100548 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200549 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700550 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100551
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100552 Close:
553 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100554
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700555 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700556}
557
558/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700559 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 *
Johannes Bergfe0c9352007-04-30 15:09:51 -0700561 * Use the platform driver, if configured so; otherwise try
562 * to power off or reboot.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 */
564
Johannes Bergfe0c9352007-04-30 15:09:51 -0700565static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700567 switch (hibernation_mode) {
568 case HIBERNATION_TEST:
569 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700570 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700571 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600572 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700574 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700575 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700576 case HIBERNATION_SHUTDOWN:
577 kernel_power_off();
578 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600580 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700581 /*
582 * Valid image is on the disk, if we continue we risk serious data
583 * corruption after resume.
584 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100585 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 while(1);
587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589static int prepare_processes(void)
590{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800591 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 if (freeze_processes()) {
594 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100595 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700597 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598}
599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700601 * hibernate - The granpappy of the built-in hibernation management
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 */
603
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700604int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
606 int error;
607
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700608 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700609 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700610 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
611 error = -EBUSY;
612 goto Unlock;
613 }
614
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100615 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700616 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
617 if (error)
618 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700619
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700620 error = usermodehelper_disable();
621 if (error)
622 goto Exit;
623
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700624 /* Allocate memory management structures */
625 error = create_basic_memory_bitmaps();
626 if (error)
627 goto Exit;
628
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100629 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700630 sys_sync();
631 printk("done.\n");
632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700634 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700635 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100637 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800638 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100639
640 if (hibernation_testmode(HIBERNATION_TESTPROC))
641 goto Thaw;
642
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700643 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200644 if (error)
645 goto Thaw;
646
647 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700648 unsigned int flags = 0;
649
650 if (hibernation_mode == HIBERNATION_PLATFORM)
651 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200652 if (nocompress)
653 flags |= SF_NOCOMPRESS_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700655 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700656 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700658 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100659 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100660 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800661 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800663 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200664
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800665 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100666 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700667 Finish:
668 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700669 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700670 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700671 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100672 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700673 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700674 Unlock:
675 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 return error;
677}
678
679
680/**
681 * software_resume - Resume from a saved image.
682 *
683 * Called as a late_initcall (so all devices are discovered and
684 * initialized), we call swsusp to see if we have a saved image or not.
685 * If so, we quiesce devices, the restore the saved image. We will
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700686 * return above (in hibernate() ) if everything goes well.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 * Otherwise, we fail gracefully and return to the normally
688 * scheduled program.
689 *
690 */
691
692static int software_resume(void)
693{
694 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700695 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Johannes Berg60a0d232007-11-14 17:00:16 -0800697 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100698 * If the user said "noresume".. bail out early.
699 */
700 if (noresume)
701 return 0;
702
703 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800704 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
705 * is configured into the kernel. Since the regular hibernate
706 * trigger path is via sysfs which takes a buffer mutex before
707 * calling hibernate functions (which take pm_mutex) this can
708 * cause lockdep to complain about a possible ABBA deadlock
709 * which cannot happen since we're in the boot code here and
710 * sysfs can't be invoked yet. Therefore, we use a subclass
711 * here to avoid lockdep complaining.
712 */
713 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200714
715 if (swsusp_resume_device)
716 goto Check_image;
717
718 if (!strlen(resume_file)) {
719 error = -ENOENT;
720 goto Unlock;
721 }
722
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200723 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200724
725 /* Check if the device is there */
726 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700727 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100728 /*
729 * Some device discovery might still be in progress; we need
730 * to wait for this to finish.
731 */
732 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200733 /*
734 * We can't depend on SCSI devices being available after loading
735 * one of their modules until scsi_complete_async_scans() is
736 * called and the resume device usually is a SCSI one.
737 */
738 scsi_complete_async_scans();
739
Pavel Machek3efa1472005-07-07 17:56:43 -0700740 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200741 if (!swsusp_resume_device) {
742 error = -ENODEV;
743 goto Unlock;
744 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700745 }
746
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200747 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200748 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200749 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200751 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800752 error = swsusp_check();
753 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700754 goto Unlock;
755
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700756 /* The snapshot device should not be opened while we're running */
757 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
758 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200759 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700760 goto Unlock;
761 }
762
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100763 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100764 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
765 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200766 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100767
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700768 error = usermodehelper_disable();
769 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200770 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700771
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700772 error = create_basic_memory_bitmaps();
773 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200774 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
776 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800777 error = prepare_processes();
778 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400779 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700780 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 }
782
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200783 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700785 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200786 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800787 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700788 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200790 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700791 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100792 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700794 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700795 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700796 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100797 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100798 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700799 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700800 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700801 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800802 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200803 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700804 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200805close_finish:
806 swsusp_close(FMODE_READ);
807 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
809
810late_initcall(software_resume);
811
812
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700813static const char * const hibernation_modes[] = {
814 [HIBERNATION_PLATFORM] = "platform",
815 [HIBERNATION_SHUTDOWN] = "shutdown",
816 [HIBERNATION_REBOOT] = "reboot",
817 [HIBERNATION_TEST] = "test",
818 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819};
820
821/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700822 * disk - Control hibernation mode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700824 * Suspend-to-disk can be handled in several ways. We have a few options
825 * for putting the system to sleep - using the platform driver (e.g. ACPI
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700826 * or other hibernation_ops), powering off the system or rebooting the
827 * system (for testing) as well as the two test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700829 * The system can support 'platform', and that is known a priori (and
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700830 * encoded by the presence of hibernation_ops). However, the user may
831 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
832 * test modes, 'test' or 'testproc'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 *
834 * show() will display what the mode is currently set to.
835 * store() will accept one of
836 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 * 'platform'
838 * 'shutdown'
839 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700840 * 'test'
841 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700843 * It will only change to 'platform' if the system
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700844 * supports it (as determined by having hibernation_ops).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 */
846
Kay Sievers386f2752007-11-02 13:47:53 +0100847static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
848 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700850 int i;
851 char *start = buf;
852
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700853 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
854 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700855 continue;
856 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700857 case HIBERNATION_SHUTDOWN:
858 case HIBERNATION_REBOOT:
859 case HIBERNATION_TEST:
860 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700861 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700862 case HIBERNATION_PLATFORM:
863 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700864 break;
865 /* not a valid mode, continue with loop */
866 continue;
867 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700868 if (i == hibernation_mode)
869 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700870 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700871 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700872 }
873 buf += sprintf(buf, "\n");
874 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875}
876
877
Kay Sievers386f2752007-11-02 13:47:53 +0100878static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
879 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
881 int error = 0;
882 int i;
883 int len;
884 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700885 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
887 p = memchr(buf, '\n', n);
888 len = p ? p - buf : n;
889
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800890 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700891 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700892 if (len == strlen(hibernation_modes[i])
893 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 mode = i;
895 break;
896 }
897 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700898 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700899 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700900 case HIBERNATION_SHUTDOWN:
901 case HIBERNATION_REBOOT:
902 case HIBERNATION_TEST:
903 case HIBERNATION_TESTPROC:
904 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700905 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700906 case HIBERNATION_PLATFORM:
907 if (hibernation_ops)
908 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 else
910 error = -EINVAL;
911 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700912 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 error = -EINVAL;
914
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700915 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100916 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700917 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800918 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 return error ? error : n;
920}
921
922power_attr(disk);
923
Kay Sievers386f2752007-11-02 13:47:53 +0100924static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
925 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926{
927 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
928 MINOR(swsusp_resume_device));
929}
930
Kay Sievers386f2752007-11-02 13:47:53 +0100931static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
932 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800936 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
Andrew Mortona5762192006-01-06 00:09:50 -0800938 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
939 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Andrew Mortona5762192006-01-06 00:09:50 -0800941 res = MKDEV(maj,min);
942 if (maj != MAJOR(res) || min != MINOR(res))
943 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800945 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800946 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800947 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100948 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800949 noresume = 0;
950 software_resume();
951 ret = n;
Rafael J. Wysocki59a49332006-12-06 20:34:44 -0800952 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800953 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954}
955
956power_attr(resume);
957
Kay Sievers386f2752007-11-02 13:47:53 +0100958static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
959 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800960{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800961 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800962}
963
Kay Sievers386f2752007-11-02 13:47:53 +0100964static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
965 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800966{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800967 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800968
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800969 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800970 image_size = size;
971 return n;
972 }
973
974 return -EINVAL;
975}
976
977power_attr(image_size);
978
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979static struct attribute * g[] = {
980 &disk_attr.attr,
981 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800982 &image_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 NULL,
984};
985
986
987static struct attribute_group attr_group = {
988 .attrs = g,
989};
990
991
992static int __init pm_disk_init(void)
993{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800994 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995}
996
997core_initcall(pm_disk_init);
998
999
1000static int __init resume_setup(char *str)
1001{
1002 if (noresume)
1003 return 1;
1004
1005 strncpy( resume_file, str, 255 );
1006 return 1;
1007}
1008
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001009static int __init resume_offset_setup(char *str)
1010{
1011 unsigned long long offset;
1012
1013 if (noresume)
1014 return 1;
1015
1016 if (sscanf(str, "%llu", &offset) == 1)
1017 swsusp_resume_block = offset;
1018
1019 return 1;
1020}
1021
Bojan Smojverf996fc92010-09-09 23:06:23 +02001022static int __init hibernate_setup(char *str)
1023{
1024 if (!strncmp(str, "noresume", 8))
1025 noresume = 1;
1026 else if (!strncmp(str, "nocompress", 10))
1027 nocompress = 1;
1028 return 1;
1029}
1030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031static int __init noresume_setup(char *str)
1032{
1033 noresume = 1;
1034 return 1;
1035}
1036
1037__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001038__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001040__setup("hibernate=", hibernate_setup);