blob: 554d3b049f3539da6fc56eea9052e727a00ca6cf [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
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200275 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100276 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200277 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100278 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100279 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100280 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700281
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100282 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100283 goto Power_up;
284
285 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700286 save_processor_state();
287 error = swsusp_arch_suspend();
288 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100289 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
290 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700291 /* Restore control flow magically appears here */
292 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200293 if (!in_suspend) {
294 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700295 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200296 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100297
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100298 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100299 syscore_resume();
Alan Sternd1616302009-05-24 22:05:42 +0200300 /* NOTE: dpm_resume_noirq() is just a resume() for devices
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700301 * that suspended with irqs off ... no overall powerup.
302 */
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100303
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100304 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100305 local_irq_enable();
306
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100307 Enable_cpus:
308 enable_nonboot_cpus();
309
310 Platform_finish:
311 platform_finish(platform_mode);
312
Alan Sternd1616302009-05-24 22:05:42 +0200313 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200314 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100315
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700316 return error;
317}
318
319/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700320 * hibernation_snapshot - quiesce devices and create the hibernation
321 * snapshot image.
322 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100323 * prepare the platform firmware for the power transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700324 *
325 * Must be called with pm_mutex held
326 */
327
328int hibernation_snapshot(int platform_mode)
329{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100330 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700331
Zhang Rui3fe03132008-10-26 20:50:26 +0100332 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700333 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200334 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700335
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200336 /* Preallocate image memory before shutting down devices. */
337 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700338 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100339 goto Close;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700340
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700341 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100342 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200343 error = dpm_suspend_start(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700344 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200345 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700346
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100347 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200348 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700349
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100350 error = create_image(platform_mode);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100351 /*
352 * Control returns here (1) after the image has been created or the
353 * image creation has failed and (2) after a successful restore.
354 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100355
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100356 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200357 /* We may need to release the preallocated image pages here. */
358 if (error || !in_suspend)
359 swsusp_free();
360
Alan Sternd1616302009-05-24 22:05:42 +0200361 dpm_resume_end(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200362 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100363
364 if (error || !in_suspend)
365 pm_restore_gfp_mask();
366
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700367 resume_console();
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 /* We'll ignore saved state, but this gets preempt count (etc) right */
411 save_processor_state();
412 error = restore_highmem();
413 if (!error) {
414 error = swsusp_arch_resume();
415 /*
416 * The code below is only ever reached in case of a failure.
417 * Otherwise execution continues at place where
418 * swsusp_arch_suspend() was called
419 */
420 BUG_ON(!error);
421 /* This call to restore_highmem() undos the previous one */
422 restore_highmem();
423 }
424 /*
425 * The only reason why swsusp_arch_resume() can fail is memory being
426 * very tight, so we have to free it as soon as we can to avoid
427 * subsequent failures
428 */
429 swsusp_free();
430 restore_processor_state();
431 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100432
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100433 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100434
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100435 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100436 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100437
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100438 Enable_cpus:
439 enable_nonboot_cpus();
440
441 Cleanup:
442 platform_restore_cleanup(platform_mode);
443
Alan Sternd1616302009-05-24 22:05:42 +0200444 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100445
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100446 return error;
447}
448
449/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700450 * hibernation_restore - quiesce devices and restore the hibernation
451 * snapshot image. If successful, control returns in hibernation_snaphot()
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700452 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100453 * prepare the platform firmware for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700454 *
455 * Must be called with pm_mutex held
456 */
457
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700458int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700459{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100460 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700461
462 pm_prepare_console();
463 suspend_console();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100464 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200465 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700466 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100467 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200468 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700469 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100470 pm_restore_gfp_mask();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700471 resume_console();
472 pm_restore_console();
473 return error;
474}
475
476/**
477 * hibernation_platform_enter - enter the hibernation state using the
478 * platform driver (if available)
479 */
480
481int hibernation_platform_enter(void)
482{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100483 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700484
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700485 if (!hibernation_ops)
486 return -ENOSYS;
487
488 /*
489 * We have cancelled the power transition by running
490 * hibernation_ops->finish() before saving the image, so we should let
491 * the firmware know that we're going to enter the sleep state after all
492 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100493 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700494 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100495 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700496
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100497 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700498 suspend_console();
Alan Sternd1616302009-05-24 22:05:42 +0200499 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200500 if (error) {
501 if (hibernation_ops->recover)
502 hibernation_ops->recover();
503 goto Resume_devices;
504 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700505
Alan Sternd1616302009-05-24 22:05:42 +0200506 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100507 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200508 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100509
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100510 error = hibernation_ops->prepare();
511 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200512 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100513
514 error = disable_nonboot_cpus();
515 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200516 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100517
518 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100519 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100520 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200521 error = -EAGAIN;
522 goto Power_up;
523 }
524
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100525 hibernation_ops->enter();
526 /* We should never get here */
527 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700528
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200529 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100530 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200531 local_irq_enable();
532 enable_nonboot_cpus();
533
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200534 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700535 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100536
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200537 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100538
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700539 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100540 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200541 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700542 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100543
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100544 Close:
545 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100546
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700547 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700548}
549
550/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700551 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 *
Johannes Bergfe0c9352007-04-30 15:09:51 -0700553 * Use the platform driver, if configured so; otherwise try
554 * to power off or reboot.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 */
556
Johannes Bergfe0c9352007-04-30 15:09:51 -0700557static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700559 switch (hibernation_mode) {
560 case HIBERNATION_TEST:
561 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700562 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700563 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600564 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700566 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700567 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700568 case HIBERNATION_SHUTDOWN:
569 kernel_power_off();
570 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600572 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700573 /*
574 * Valid image is on the disk, if we continue we risk serious data
575 * corruption after resume.
576 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100577 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 while(1);
579}
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581static int prepare_processes(void)
582{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800583 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 if (freeze_processes()) {
586 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100587 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700589 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700593 * hibernate - The granpappy of the built-in hibernation management
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 */
595
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700596int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597{
598 int error;
599
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700600 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700601 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700602 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
603 error = -EBUSY;
604 goto Unlock;
605 }
606
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100607 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700608 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
609 if (error)
610 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700611
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700612 error = usermodehelper_disable();
613 if (error)
614 goto Exit;
615
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700616 /* Allocate memory management structures */
617 error = create_basic_memory_bitmaps();
618 if (error)
619 goto Exit;
620
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100621 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700622 sys_sync();
623 printk("done.\n");
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700626 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700627 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100629 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800630 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100631
632 if (hibernation_testmode(HIBERNATION_TESTPROC))
633 goto Thaw;
634
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700635 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200636 if (error)
637 goto Thaw;
638
639 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700640 unsigned int flags = 0;
641
642 if (hibernation_mode == HIBERNATION_PLATFORM)
643 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200644 if (nocompress)
645 flags |= SF_NOCOMPRESS_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700647 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700648 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700650 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100651 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100652 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800653 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800655 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200656
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800657 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100658 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700659 Finish:
660 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700661 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700662 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700663 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100664 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700665 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700666 Unlock:
667 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 return error;
669}
670
671
672/**
673 * software_resume - Resume from a saved image.
674 *
675 * Called as a late_initcall (so all devices are discovered and
676 * initialized), we call swsusp to see if we have a saved image or not.
677 * If so, we quiesce devices, the restore the saved image. We will
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700678 * return above (in hibernate() ) if everything goes well.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 * Otherwise, we fail gracefully and return to the normally
680 * scheduled program.
681 *
682 */
683
684static int software_resume(void)
685{
686 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700687 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Johannes Berg60a0d232007-11-14 17:00:16 -0800689 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100690 * If the user said "noresume".. bail out early.
691 */
692 if (noresume)
693 return 0;
694
695 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800696 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
697 * is configured into the kernel. Since the regular hibernate
698 * trigger path is via sysfs which takes a buffer mutex before
699 * calling hibernate functions (which take pm_mutex) this can
700 * cause lockdep to complain about a possible ABBA deadlock
701 * which cannot happen since we're in the boot code here and
702 * sysfs can't be invoked yet. Therefore, we use a subclass
703 * here to avoid lockdep complaining.
704 */
705 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200706
707 if (swsusp_resume_device)
708 goto Check_image;
709
710 if (!strlen(resume_file)) {
711 error = -ENOENT;
712 goto Unlock;
713 }
714
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200715 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200716
717 /* Check if the device is there */
718 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700719 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100720 /*
721 * Some device discovery might still be in progress; we need
722 * to wait for this to finish.
723 */
724 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200725 /*
726 * We can't depend on SCSI devices being available after loading
727 * one of their modules until scsi_complete_async_scans() is
728 * called and the resume device usually is a SCSI one.
729 */
730 scsi_complete_async_scans();
731
Pavel Machek3efa1472005-07-07 17:56:43 -0700732 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200733 if (!swsusp_resume_device) {
734 error = -ENODEV;
735 goto Unlock;
736 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700737 }
738
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200739 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200740 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200741 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200743 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800744 error = swsusp_check();
745 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700746 goto Unlock;
747
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700748 /* The snapshot device should not be opened while we're running */
749 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
750 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200751 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700752 goto Unlock;
753 }
754
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100755 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100756 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
757 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200758 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100759
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700760 error = usermodehelper_disable();
761 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200762 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700763
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700764 error = create_basic_memory_bitmaps();
765 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200766 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
768 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800769 error = prepare_processes();
770 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400771 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700772 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 }
774
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200775 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700777 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200778 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800779 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700780 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200782 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700783 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100784 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700786 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700787 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700788 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100789 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100790 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700791 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700792 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700793 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800794 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200795 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700796 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200797close_finish:
798 swsusp_close(FMODE_READ);
799 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
802late_initcall(software_resume);
803
804
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700805static const char * const hibernation_modes[] = {
806 [HIBERNATION_PLATFORM] = "platform",
807 [HIBERNATION_SHUTDOWN] = "shutdown",
808 [HIBERNATION_REBOOT] = "reboot",
809 [HIBERNATION_TEST] = "test",
810 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811};
812
813/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700814 * disk - Control hibernation mode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700816 * Suspend-to-disk can be handled in several ways. We have a few options
817 * for putting the system to sleep - using the platform driver (e.g. ACPI
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700818 * or other hibernation_ops), powering off the system or rebooting the
819 * system (for testing) as well as the two test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700821 * The system can support 'platform', and that is known a priori (and
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700822 * encoded by the presence of hibernation_ops). However, the user may
823 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
824 * test modes, 'test' or 'testproc'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 *
826 * show() will display what the mode is currently set to.
827 * store() will accept one of
828 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 * 'platform'
830 * 'shutdown'
831 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700832 * 'test'
833 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700835 * It will only change to 'platform' if the system
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700836 * supports it (as determined by having hibernation_ops).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 */
838
Kay Sievers386f2752007-11-02 13:47:53 +0100839static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
840 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700842 int i;
843 char *start = buf;
844
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700845 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
846 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700847 continue;
848 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700849 case HIBERNATION_SHUTDOWN:
850 case HIBERNATION_REBOOT:
851 case HIBERNATION_TEST:
852 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700853 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700854 case HIBERNATION_PLATFORM:
855 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700856 break;
857 /* not a valid mode, continue with loop */
858 continue;
859 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700860 if (i == hibernation_mode)
861 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700862 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700863 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700864 }
865 buf += sprintf(buf, "\n");
866 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867}
868
869
Kay Sievers386f2752007-11-02 13:47:53 +0100870static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
871 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872{
873 int error = 0;
874 int i;
875 int len;
876 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700877 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
879 p = memchr(buf, '\n', n);
880 len = p ? p - buf : n;
881
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800882 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700883 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700884 if (len == strlen(hibernation_modes[i])
885 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 mode = i;
887 break;
888 }
889 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700890 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700891 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700892 case HIBERNATION_SHUTDOWN:
893 case HIBERNATION_REBOOT:
894 case HIBERNATION_TEST:
895 case HIBERNATION_TESTPROC:
896 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700897 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700898 case HIBERNATION_PLATFORM:
899 if (hibernation_ops)
900 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 else
902 error = -EINVAL;
903 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700904 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 error = -EINVAL;
906
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700907 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100908 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700909 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800910 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 return error ? error : n;
912}
913
914power_attr(disk);
915
Kay Sievers386f2752007-11-02 13:47:53 +0100916static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
917 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918{
919 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
920 MINOR(swsusp_resume_device));
921}
922
Kay Sievers386f2752007-11-02 13:47:53 +0100923static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
924 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800928 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
Andrew Mortona5762192006-01-06 00:09:50 -0800930 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
931 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Andrew Mortona5762192006-01-06 00:09:50 -0800933 res = MKDEV(maj,min);
934 if (maj != MAJOR(res) || min != MINOR(res))
935 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800937 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800938 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800939 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100940 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800941 noresume = 0;
942 software_resume();
943 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800944 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800945 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946}
947
948power_attr(resume);
949
Kay Sievers386f2752007-11-02 13:47:53 +0100950static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
951 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800952{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800953 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800954}
955
Kay Sievers386f2752007-11-02 13:47:53 +0100956static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
957 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800958{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800959 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800960
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800961 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800962 image_size = size;
963 return n;
964 }
965
966 return -EINVAL;
967}
968
969power_attr(image_size);
970
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971static struct attribute * g[] = {
972 &disk_attr.attr,
973 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800974 &image_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 NULL,
976};
977
978
979static struct attribute_group attr_group = {
980 .attrs = g,
981};
982
983
984static int __init pm_disk_init(void)
985{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800986 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987}
988
989core_initcall(pm_disk_init);
990
991
992static int __init resume_setup(char *str)
993{
994 if (noresume)
995 return 1;
996
997 strncpy( resume_file, str, 255 );
998 return 1;
999}
1000
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001001static int __init resume_offset_setup(char *str)
1002{
1003 unsigned long long offset;
1004
1005 if (noresume)
1006 return 1;
1007
1008 if (sscanf(str, "%llu", &offset) == 1)
1009 swsusp_resume_block = offset;
1010
1011 return 1;
1012}
1013
Bojan Smojverf996fc92010-09-09 23:06:23 +02001014static int __init hibernate_setup(char *str)
1015{
1016 if (!strncmp(str, "noresume", 8))
1017 noresume = 1;
1018 else if (!strncmp(str, "nocompress", 10))
1019 nocompress = 1;
1020 return 1;
1021}
1022
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023static int __init noresume_setup(char *str)
1024{
1025 noresume = 1;
1026 return 1;
1027}
1028
1029__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001030__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001032__setup("hibernate=", hibernate_setup);