blob: 6418d8c8cdb23ab76e71b3ea7687dbb79b5b4bb6 [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 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700252 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100253 printk(KERN_ERR "PM: Some devices failed to power down, "
254 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200255 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700256 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100257
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100258 error = platform_pre_snapshot(platform_mode);
259 if (error || hibernation_test(TEST_PLATFORM))
260 goto Platform_finish;
261
262 error = disable_nonboot_cpus();
263 if (error || hibernation_test(TEST_CPUS)
264 || hibernation_testmode(HIBERNATION_TEST))
265 goto Enable_cpus;
266
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100267 local_irq_disable();
268
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200269 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100270 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200271 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100272 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100273 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100274 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700275
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100276 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100277 goto Power_up;
278
279 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700280 save_processor_state();
281 error = swsusp_arch_suspend();
282 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100283 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
284 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700285 /* Restore control flow magically appears here */
286 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200287 if (!in_suspend) {
288 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700289 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200290 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100291
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100292 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100293 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100294
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100295 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100296 local_irq_enable();
297
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100298 Enable_cpus:
299 enable_nonboot_cpus();
300
301 Platform_finish:
302 platform_finish(platform_mode);
303
Alan Sternd1616302009-05-24 22:05:42 +0200304 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200305 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100306
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700307 return error;
308}
309
310/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700311 * hibernation_snapshot - quiesce devices and create the hibernation
312 * snapshot image.
313 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100314 * prepare the platform firmware for the power transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700315 *
316 * Must be called with pm_mutex held
317 */
318
319int hibernation_snapshot(int platform_mode)
320{
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200321 pm_message_t msg = PMSG_RECOVER;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100322 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700323
Zhang Rui3fe03132008-10-26 20:50:26 +0100324 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700325 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200326 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700327
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200328 error = dpm_prepare(PMSG_FREEZE);
329 if (error)
330 goto Complete_devices;
331
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200332 /* Preallocate image memory before shutting down devices. */
333 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700334 if (error)
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200335 goto Complete_devices;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700336
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700337 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100338 pm_restrict_gfp_mask();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200339 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700340 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200341 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700342
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100343 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200344 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700345
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100346 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100347 /*
348 * Control returns here (1) after the image has been created or the
349 * image creation has failed and (2) after a successful restore.
350 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100351
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100352 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200353 /* We may need to release the preallocated image pages here. */
354 if (error || !in_suspend)
355 swsusp_free();
356
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200357 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
358 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100359
360 if (error || !in_suspend)
361 pm_restore_gfp_mask();
362
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700363 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200364
365 Complete_devices:
366 dpm_complete(msg);
367
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100368 Close:
369 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700370 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200371
372 Recover_platform:
373 platform_recover(platform_mode);
374 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700375}
376
377/**
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100378 * resume_target_kernel - prepare devices that need to be suspended with
379 * interrupts off, restore the contents of highmem that have not been
380 * restored yet from the image and run the low level code that will restore
381 * the remaining contents of memory and switch to the just restored target
382 * kernel.
383 */
384
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100385static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100386{
387 int error;
388
Alan Sternd1616302009-05-24 22:05:42 +0200389 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100390 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100391 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100392 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200393 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100394 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100395
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100396 error = platform_pre_restore(platform_mode);
397 if (error)
398 goto Cleanup;
399
400 error = disable_nonboot_cpus();
401 if (error)
402 goto Enable_cpus;
403
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100404 local_irq_disable();
405
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200406 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100407 if (error)
408 goto Enable_irqs;
409
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100410 save_processor_state();
411 error = restore_highmem();
412 if (!error) {
413 error = swsusp_arch_resume();
414 /*
415 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200416 * Otherwise, execution continues at the place where
417 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100418 */
419 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200420 /*
421 * This call to restore_highmem() reverts the changes made by
422 * the previous one.
423 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100424 restore_highmem();
425 }
426 /*
427 * The only reason why swsusp_arch_resume() can fail is memory being
428 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200429 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100430 */
431 swsusp_free();
432 restore_processor_state();
433 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100434
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100435 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100436
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100437 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100438 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100439
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100440 Enable_cpus:
441 enable_nonboot_cpus();
442
443 Cleanup:
444 platform_restore_cleanup(platform_mode);
445
Alan Sternd1616302009-05-24 22:05:42 +0200446 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100447
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100448 return error;
449}
450
451/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700452 * hibernation_restore - quiesce devices and restore the hibernation
453 * snapshot image. If successful, control returns in hibernation_snaphot()
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700454 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100455 * prepare the platform firmware for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700456 *
457 * Must be called with pm_mutex held
458 */
459
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700460int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700461{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100462 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700463
464 pm_prepare_console();
465 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100466 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200467 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700468 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100469 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200470 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700471 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100472 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700473 resume_console();
474 pm_restore_console();
475 return error;
476}
477
478/**
479 * hibernation_platform_enter - enter the hibernation state using the
480 * platform driver (if available)
481 */
482
483int hibernation_platform_enter(void)
484{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100485 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700486
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700487 if (!hibernation_ops)
488 return -ENOSYS;
489
490 /*
491 * We have cancelled the power transition by running
492 * hibernation_ops->finish() before saving the image, so we should let
493 * the firmware know that we're going to enter the sleep state after all
494 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100495 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700496 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100497 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700498
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100499 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700500 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200501 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200502 if (error) {
503 if (hibernation_ops->recover)
504 hibernation_ops->recover();
505 goto Resume_devices;
506 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700507
Alan Sternd1616302009-05-24 22:05:42 +0200508 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100509 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200510 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100511
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100512 error = hibernation_ops->prepare();
513 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200514 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100515
516 error = disable_nonboot_cpus();
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 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100521 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100522 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200523 error = -EAGAIN;
524 goto Power_up;
525 }
526
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100527 hibernation_ops->enter();
528 /* We should never get here */
529 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700530
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200531 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100532 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200533 local_irq_enable();
534 enable_nonboot_cpus();
535
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200536 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700537 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100538
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200539 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100540
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700541 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100542 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200543 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700544 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100545
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100546 Close:
547 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100548
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700549 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700550}
551
552/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700553 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 *
Johannes Bergfe0c9352007-04-30 15:09:51 -0700555 * Use the platform driver, if configured so; otherwise try
556 * to power off or reboot.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 */
558
Johannes Bergfe0c9352007-04-30 15:09:51 -0700559static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700561 switch (hibernation_mode) {
562 case HIBERNATION_TEST:
563 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700564 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700565 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600566 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700568 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700569 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700570 case HIBERNATION_SHUTDOWN:
571 kernel_power_off();
572 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600574 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700575 /*
576 * Valid image is on the disk, if we continue we risk serious data
577 * corruption after resume.
578 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100579 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 while(1);
581}
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583static int prepare_processes(void)
584{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800585 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 if (freeze_processes()) {
588 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100589 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700591 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592}
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700595 * hibernate - The granpappy of the built-in hibernation management
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 */
597
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700598int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599{
600 int error;
601
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700602 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700603 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700604 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
605 error = -EBUSY;
606 goto Unlock;
607 }
608
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100609 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700610 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
611 if (error)
612 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700613
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700614 error = usermodehelper_disable();
615 if (error)
616 goto Exit;
617
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700618 /* Allocate memory management structures */
619 error = create_basic_memory_bitmaps();
620 if (error)
621 goto Exit;
622
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100623 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700624 sys_sync();
625 printk("done.\n");
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700628 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700629 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100631 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800632 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100633
634 if (hibernation_testmode(HIBERNATION_TESTPROC))
635 goto Thaw;
636
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700637 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200638 if (error)
639 goto Thaw;
640
641 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700642 unsigned int flags = 0;
643
644 if (hibernation_mode == HIBERNATION_PLATFORM)
645 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200646 if (nocompress)
647 flags |= SF_NOCOMPRESS_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700649 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700650 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700652 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100653 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100654 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800655 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800657 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200658
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800659 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100660 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700661 Finish:
662 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700663 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700664 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700665 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100666 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700667 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700668 Unlock:
669 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 return error;
671}
672
673
674/**
675 * software_resume - Resume from a saved image.
676 *
677 * Called as a late_initcall (so all devices are discovered and
678 * initialized), we call swsusp to see if we have a saved image or not.
679 * If so, we quiesce devices, the restore the saved image. We will
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700680 * return above (in hibernate() ) if everything goes well.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 * Otherwise, we fail gracefully and return to the normally
682 * scheduled program.
683 *
684 */
685
686static int software_resume(void)
687{
688 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700689 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Johannes Berg60a0d232007-11-14 17:00:16 -0800691 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100692 * If the user said "noresume".. bail out early.
693 */
694 if (noresume)
695 return 0;
696
697 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800698 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
699 * is configured into the kernel. Since the regular hibernate
700 * trigger path is via sysfs which takes a buffer mutex before
701 * calling hibernate functions (which take pm_mutex) this can
702 * cause lockdep to complain about a possible ABBA deadlock
703 * which cannot happen since we're in the boot code here and
704 * sysfs can't be invoked yet. Therefore, we use a subclass
705 * here to avoid lockdep complaining.
706 */
707 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200708
709 if (swsusp_resume_device)
710 goto Check_image;
711
712 if (!strlen(resume_file)) {
713 error = -ENOENT;
714 goto Unlock;
715 }
716
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200717 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200718
719 /* Check if the device is there */
720 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700721 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100722 /*
723 * Some device discovery might still be in progress; we need
724 * to wait for this to finish.
725 */
726 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200727 /*
728 * We can't depend on SCSI devices being available after loading
729 * one of their modules until scsi_complete_async_scans() is
730 * called and the resume device usually is a SCSI one.
731 */
732 scsi_complete_async_scans();
733
Pavel Machek3efa1472005-07-07 17:56:43 -0700734 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200735 if (!swsusp_resume_device) {
736 error = -ENODEV;
737 goto Unlock;
738 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700739 }
740
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200741 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200742 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200743 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200745 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800746 error = swsusp_check();
747 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700748 goto Unlock;
749
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700750 /* The snapshot device should not be opened while we're running */
751 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
752 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200753 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700754 goto Unlock;
755 }
756
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100757 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100758 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
759 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200760 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100761
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700762 error = usermodehelper_disable();
763 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200764 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700765
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700766 error = create_basic_memory_bitmaps();
767 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200768 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
770 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800771 error = prepare_processes();
772 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400773 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700774 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 }
776
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200777 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700779 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200780 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800781 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700782 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200784 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700785 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100786 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700788 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700789 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700790 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100791 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100792 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700793 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700794 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700795 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800796 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200797 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700798 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200799close_finish:
800 swsusp_close(FMODE_READ);
801 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802}
803
804late_initcall(software_resume);
805
806
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700807static const char * const hibernation_modes[] = {
808 [HIBERNATION_PLATFORM] = "platform",
809 [HIBERNATION_SHUTDOWN] = "shutdown",
810 [HIBERNATION_REBOOT] = "reboot",
811 [HIBERNATION_TEST] = "test",
812 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813};
814
815/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700816 * disk - Control hibernation mode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700818 * Suspend-to-disk can be handled in several ways. We have a few options
819 * for putting the system to sleep - using the platform driver (e.g. ACPI
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700820 * or other hibernation_ops), powering off the system or rebooting the
821 * system (for testing) as well as the two test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700823 * The system can support 'platform', and that is known a priori (and
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700824 * encoded by the presence of hibernation_ops). However, the user may
825 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
826 * test modes, 'test' or 'testproc'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 *
828 * show() will display what the mode is currently set to.
829 * store() will accept one of
830 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 * 'platform'
832 * 'shutdown'
833 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700834 * 'test'
835 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700837 * It will only change to 'platform' if the system
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700838 * supports it (as determined by having hibernation_ops).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 */
840
Kay Sievers386f2752007-11-02 13:47:53 +0100841static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
842 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700844 int i;
845 char *start = buf;
846
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700847 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
848 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700849 continue;
850 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700851 case HIBERNATION_SHUTDOWN:
852 case HIBERNATION_REBOOT:
853 case HIBERNATION_TEST:
854 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700855 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700856 case HIBERNATION_PLATFORM:
857 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700858 break;
859 /* not a valid mode, continue with loop */
860 continue;
861 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700862 if (i == hibernation_mode)
863 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700864 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700865 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700866 }
867 buf += sprintf(buf, "\n");
868 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869}
870
871
Kay Sievers386f2752007-11-02 13:47:53 +0100872static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
873 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874{
875 int error = 0;
876 int i;
877 int len;
878 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700879 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
881 p = memchr(buf, '\n', n);
882 len = p ? p - buf : n;
883
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800884 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700885 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700886 if (len == strlen(hibernation_modes[i])
887 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 mode = i;
889 break;
890 }
891 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700892 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700893 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700894 case HIBERNATION_SHUTDOWN:
895 case HIBERNATION_REBOOT:
896 case HIBERNATION_TEST:
897 case HIBERNATION_TESTPROC:
898 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700899 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700900 case HIBERNATION_PLATFORM:
901 if (hibernation_ops)
902 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 else
904 error = -EINVAL;
905 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700906 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 error = -EINVAL;
908
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700909 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100910 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700911 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800912 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 return error ? error : n;
914}
915
916power_attr(disk);
917
Kay Sievers386f2752007-11-02 13:47:53 +0100918static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
919 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920{
921 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
922 MINOR(swsusp_resume_device));
923}
924
Kay Sievers386f2752007-11-02 13:47:53 +0100925static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
926 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800930 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
Andrew Mortona5762192006-01-06 00:09:50 -0800932 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
933 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Andrew Mortona5762192006-01-06 00:09:50 -0800935 res = MKDEV(maj,min);
936 if (maj != MAJOR(res) || min != MINOR(res))
937 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800939 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800940 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800941 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100942 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800943 noresume = 0;
944 software_resume();
945 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800946 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800947 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948}
949
950power_attr(resume);
951
Kay Sievers386f2752007-11-02 13:47:53 +0100952static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
953 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800954{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800955 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800956}
957
Kay Sievers386f2752007-11-02 13:47:53 +0100958static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
959 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800960{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800961 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800962
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800963 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800964 image_size = size;
965 return n;
966 }
967
968 return -EINVAL;
969}
970
971power_attr(image_size);
972
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +0200973static ssize_t reserved_size_show(struct kobject *kobj,
974 struct kobj_attribute *attr, char *buf)
975{
976 return sprintf(buf, "%lu\n", reserved_size);
977}
978
979static ssize_t reserved_size_store(struct kobject *kobj,
980 struct kobj_attribute *attr,
981 const char *buf, size_t n)
982{
983 unsigned long size;
984
985 if (sscanf(buf, "%lu", &size) == 1) {
986 reserved_size = size;
987 return n;
988 }
989
990 return -EINVAL;
991}
992
993power_attr(reserved_size);
994
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995static struct attribute * g[] = {
996 &disk_attr.attr,
997 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800998 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +0200999 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 NULL,
1001};
1002
1003
1004static struct attribute_group attr_group = {
1005 .attrs = g,
1006};
1007
1008
1009static int __init pm_disk_init(void)
1010{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001011 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012}
1013
1014core_initcall(pm_disk_init);
1015
1016
1017static int __init resume_setup(char *str)
1018{
1019 if (noresume)
1020 return 1;
1021
1022 strncpy( resume_file, str, 255 );
1023 return 1;
1024}
1025
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001026static int __init resume_offset_setup(char *str)
1027{
1028 unsigned long long offset;
1029
1030 if (noresume)
1031 return 1;
1032
1033 if (sscanf(str, "%llu", &offset) == 1)
1034 swsusp_resume_block = offset;
1035
1036 return 1;
1037}
1038
Bojan Smojverf996fc92010-09-09 23:06:23 +02001039static int __init hibernate_setup(char *str)
1040{
1041 if (!strncmp(str, "noresume", 8))
1042 noresume = 1;
1043 else if (!strncmp(str, "nocompress", 10))
1044 nocompress = 1;
1045 return 1;
1046}
1047
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048static int __init noresume_setup(char *str)
1049{
1050 noresume = 1;
1051 return 1;
1052}
1053
1054__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001055__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001057__setup("hibernate=", hibernate_setup);