blob: 657272e91d0a0af648a892fd64ca2111a100dfb4 [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. Wysockic7510852009-04-12 20:06:56 +020026#include <scsi/scsi_scan.h>
Magnus Damma8af7892009-03-31 15:23:37 -070027#include <asm/suspend.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070028
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include "power.h"
30
31
Bojan Smojverf996fc92010-09-09 23:06:23 +020032static int nocompress = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033static int noresume = 0;
Adrian Bunk47a460d2008-02-04 22:30:06 -080034static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080036sector_t swsusp_resume_block;
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +010037int in_suspend __nosavedata = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070039enum {
40 HIBERNATION_INVALID,
41 HIBERNATION_PLATFORM,
42 HIBERNATION_TEST,
43 HIBERNATION_TESTPROC,
44 HIBERNATION_SHUTDOWN,
45 HIBERNATION_REBOOT,
46 /* keep last */
47 __HIBERNATION_AFTER_LAST
48};
49#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
50#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
51
52static int hibernation_mode = HIBERNATION_SHUTDOWN;
53
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -070054static struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070055
56/**
57 * hibernation_set_ops - set the global hibernate operations
58 * @ops: the hibernation operations to use in subsequent hibernation transitions
59 */
60
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -070061void hibernation_set_ops(struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070062{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010063 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
64 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -070065 && ops->restore_cleanup)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070066 WARN_ON(1);
67 return;
68 }
69 mutex_lock(&pm_mutex);
70 hibernation_ops = ops;
71 if (ops)
72 hibernation_mode = HIBERNATION_PLATFORM;
73 else if (hibernation_mode == HIBERNATION_PLATFORM)
74 hibernation_mode = HIBERNATION_SHUTDOWN;
75
76 mutex_unlock(&pm_mutex);
77}
78
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010079static bool entering_platform_hibernation;
80
81bool system_entering_hibernation(void)
82{
83 return entering_platform_hibernation;
84}
85EXPORT_SYMBOL(system_entering_hibernation);
86
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010087#ifdef CONFIG_PM_DEBUG
88static void hibernation_debug_sleep(void)
89{
90 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
91 mdelay(5000);
92}
93
94static int hibernation_testmode(int mode)
95{
96 if (hibernation_mode == mode) {
97 hibernation_debug_sleep();
98 return 1;
99 }
100 return 0;
101}
102
103static int hibernation_test(int level)
104{
105 if (pm_test_level == level) {
106 hibernation_debug_sleep();
107 return 1;
108 }
109 return 0;
110}
111#else /* !CONFIG_PM_DEBUG */
112static int hibernation_testmode(int mode) { return 0; }
113static int hibernation_test(int level) { return 0; }
114#endif /* !CONFIG_PM_DEBUG */
115
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700116/**
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100117 * platform_begin - tell the platform driver that we're starting
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700118 * hibernation
119 */
120
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100121static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700122{
123 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100124 hibernation_ops->begin() : 0;
125}
126
127/**
128 * platform_end - tell the platform driver that we've entered the
129 * working state
130 */
131
132static void platform_end(int platform_mode)
133{
134 if (platform_mode && hibernation_ops)
135 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700136}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138/**
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700139 * platform_pre_snapshot - prepare the machine for hibernation using the
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800140 * platform driver if so configured and return an error code if it fails
141 */
142
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700143static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800144{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700145 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700146 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800147}
148
149/**
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700150 * platform_leave - prepare the machine for switching to the normal mode
151 * of operation using the platform driver (called with interrupts disabled)
152 */
153
154static void platform_leave(int platform_mode)
155{
156 if (platform_mode && hibernation_ops)
157 hibernation_ops->leave();
158}
159
160/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700161 * platform_finish - switch the machine to the normal mode of operation
162 * using the platform driver (must be called after platform_prepare())
163 */
164
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700165static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700166{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700167 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700168 hibernation_ops->finish();
169}
170
171/**
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700172 * platform_pre_restore - prepare the platform for the restoration from a
173 * hibernation image. If the restore fails after this function has been
174 * called, platform_restore_cleanup() must be called.
175 */
176
177static int platform_pre_restore(int platform_mode)
178{
179 return (platform_mode && hibernation_ops) ?
180 hibernation_ops->pre_restore() : 0;
181}
182
183/**
184 * platform_restore_cleanup - switch the platform to the normal mode of
185 * operation after a failing restore. If platform_pre_restore() has been
186 * called before the failing restore, this function must be called too,
187 * regardless of the result of platform_pre_restore().
188 */
189
190static void platform_restore_cleanup(int platform_mode)
191{
192 if (platform_mode && hibernation_ops)
193 hibernation_ops->restore_cleanup();
194}
195
196/**
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200197 * platform_recover - recover the platform from a failure to suspend
198 * devices.
199 */
200
201static void platform_recover(int platform_mode)
202{
203 if (platform_mode && hibernation_ops && hibernation_ops->recover)
204 hibernation_ops->recover();
205}
206
207/**
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100208 * swsusp_show_speed - print the time elapsed between two events.
209 * @start: Starting event.
210 * @stop: Final event.
211 * @nr_pages - number of pages processed between @start and @stop
212 * @msg - introductory message to print
213 */
214
215void swsusp_show_speed(struct timeval *start, struct timeval *stop,
216 unsigned nr_pages, char *msg)
217{
218 s64 elapsed_centisecs64;
219 int centisecs;
220 int k;
221 int kps;
222
223 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
224 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
225 centisecs = elapsed_centisecs64;
226 if (centisecs == 0)
227 centisecs = 1; /* avoid div-by-zero */
228 k = nr_pages * (PAGE_SIZE / 1024);
229 kps = (k * 100) / centisecs;
230 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
231 msg, k,
232 centisecs / 100, centisecs % 100,
233 kps / 1000, (kps % 1000) / 10);
234}
235
236/**
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700237 * create_image - freeze devices that need to be frozen with interrupts
238 * off, create the hibernation image and thaw those devices. Control
239 * reappears in this routine after a restore.
240 */
241
Adrian Bunk47a460d2008-02-04 22:30:06 -0800242static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700243{
244 int error;
245
246 error = arch_prepare_suspend();
247 if (error)
248 return error;
249
Alan Sternd1616302009-05-24 22:05:42 +0200250 /* At this point, dpm_suspend_start() has been called, but *not*
251 * dpm_suspend_noirq(). We *must* call dpm_suspend_noirq() now.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700252 * Otherwise, drivers for some devices (e.g. interrupt controllers)
253 * become desynchronized with the actual state of the hardware
254 * at resume time, and evil weirdness ensues.
255 */
Alan Sternd1616302009-05-24 22:05:42 +0200256 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700257 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100258 printk(KERN_ERR "PM: Some devices failed to power down, "
259 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200260 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700261 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100262
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100263 error = platform_pre_snapshot(platform_mode);
264 if (error || hibernation_test(TEST_PLATFORM))
265 goto Platform_finish;
266
267 error = disable_nonboot_cpus();
268 if (error || hibernation_test(TEST_CPUS)
269 || hibernation_testmode(HIBERNATION_TEST))
270 goto Enable_cpus;
271
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100272 local_irq_disable();
273
Bjorn Helgaas44840792009-05-15 23:30:50 +0200274 error = sysdev_suspend(PMSG_FREEZE);
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100275 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200276 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100277 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100278 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100279 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700280
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200281 if (hibernation_test(TEST_CORE) || !pm_check_wakeup_events())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100282 goto Power_up;
283
284 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700285 save_processor_state();
286 error = swsusp_arch_suspend();
287 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100288 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
289 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700290 /* Restore control flow magically appears here */
291 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200292 if (!in_suspend) {
293 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700294 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200295 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100296
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100297 Power_up:
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100298 sysdev_resume();
Alan Sternd1616302009-05-24 22:05:42 +0200299 /* NOTE: dpm_resume_noirq() is just a resume() for devices
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700300 * that suspended with irqs off ... no overall powerup.
301 */
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100302
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100303 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100304 local_irq_enable();
305
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100306 Enable_cpus:
307 enable_nonboot_cpus();
308
309 Platform_finish:
310 platform_finish(platform_mode);
311
Alan Sternd1616302009-05-24 22:05:42 +0200312 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200313 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100314
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700315 return error;
316}
317
318/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700319 * hibernation_snapshot - quiesce devices and create the hibernation
320 * snapshot image.
321 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100322 * prepare the platform firmware for the power transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700323 *
324 * Must be called with pm_mutex held
325 */
326
327int hibernation_snapshot(int platform_mode)
328{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100329 int error;
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800330 gfp_t saved_mask;
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. Wysocki452aa692010-03-05 13:42:13 -0800342 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
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);
351 /* Control returns here after successful restore */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100352
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100353 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200354 /* We may need to release the preallocated image pages here. */
355 if (error || !in_suspend)
356 swsusp_free();
357
Alan Sternd1616302009-05-24 22:05:42 +0200358 dpm_resume_end(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200359 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800360 set_gfp_allowed_mask(saved_mask);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700361 resume_console();
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100362 Close:
363 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700364 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200365
366 Recover_platform:
367 platform_recover(platform_mode);
368 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700369}
370
371/**
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100372 * resume_target_kernel - prepare devices that need to be suspended with
373 * interrupts off, restore the contents of highmem that have not been
374 * restored yet from the image and run the low level code that will restore
375 * the remaining contents of memory and switch to the just restored target
376 * kernel.
377 */
378
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100379static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100380{
381 int error;
382
Alan Sternd1616302009-05-24 22:05:42 +0200383 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100384 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100385 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100386 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200387 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100388 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100389
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100390 error = platform_pre_restore(platform_mode);
391 if (error)
392 goto Cleanup;
393
394 error = disable_nonboot_cpus();
395 if (error)
396 goto Enable_cpus;
397
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100398 local_irq_disable();
399
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100400 error = sysdev_suspend(PMSG_QUIESCE);
401 if (error)
402 goto Enable_irqs;
403
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100404 /* We'll ignore saved state, but this gets preempt count (etc) right */
405 save_processor_state();
406 error = restore_highmem();
407 if (!error) {
408 error = swsusp_arch_resume();
409 /*
410 * The code below is only ever reached in case of a failure.
411 * Otherwise execution continues at place where
412 * swsusp_arch_suspend() was called
413 */
414 BUG_ON(!error);
415 /* This call to restore_highmem() undos the previous one */
416 restore_highmem();
417 }
418 /*
419 * The only reason why swsusp_arch_resume() can fail is memory being
420 * very tight, so we have to free it as soon as we can to avoid
421 * subsequent failures
422 */
423 swsusp_free();
424 restore_processor_state();
425 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100426
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100427 sysdev_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100428
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100429 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100430 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100431
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100432 Enable_cpus:
433 enable_nonboot_cpus();
434
435 Cleanup:
436 platform_restore_cleanup(platform_mode);
437
Alan Sternd1616302009-05-24 22:05:42 +0200438 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100439
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100440 return error;
441}
442
443/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700444 * hibernation_restore - quiesce devices and restore the hibernation
445 * snapshot image. If successful, control returns in hibernation_snaphot()
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700446 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100447 * prepare the platform firmware for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700448 *
449 * Must be called with pm_mutex held
450 */
451
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700452int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700453{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100454 int error;
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800455 gfp_t saved_mask;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700456
457 pm_prepare_console();
458 suspend_console();
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800459 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
Alan Sternd1616302009-05-24 22:05:42 +0200460 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700461 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100462 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200463 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700464 }
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800465 set_gfp_allowed_mask(saved_mask);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700466 resume_console();
467 pm_restore_console();
468 return error;
469}
470
471/**
472 * hibernation_platform_enter - enter the hibernation state using the
473 * platform driver (if available)
474 */
475
476int hibernation_platform_enter(void)
477{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100478 int error;
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800479 gfp_t saved_mask;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700480
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700481 if (!hibernation_ops)
482 return -ENOSYS;
483
484 /*
485 * We have cancelled the power transition by running
486 * hibernation_ops->finish() before saving the image, so we should let
487 * the firmware know that we're going to enter the sleep state after all
488 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100489 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700490 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100491 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700492
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100493 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700494 suspend_console();
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800495 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
Alan Sternd1616302009-05-24 22:05:42 +0200496 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200497 if (error) {
498 if (hibernation_ops->recover)
499 hibernation_ops->recover();
500 goto Resume_devices;
501 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700502
Alan Sternd1616302009-05-24 22:05:42 +0200503 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100504 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200505 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100506
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100507 error = hibernation_ops->prepare();
508 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200509 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100510
511 error = disable_nonboot_cpus();
512 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200513 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100514
515 local_irq_disable();
516 sysdev_suspend(PMSG_HIBERNATE);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200517 if (!pm_check_wakeup_events()) {
518 error = -EAGAIN;
519 goto Power_up;
520 }
521
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100522 hibernation_ops->enter();
523 /* We should never get here */
524 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700525
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200526 Power_up:
527 sysdev_resume();
528 local_irq_enable();
529 enable_nonboot_cpus();
530
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200531 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700532 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100533
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200534 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100535
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700536 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100537 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200538 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800539 set_gfp_allowed_mask(saved_mask);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700540 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100541
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100542 Close:
543 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100544
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700545 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700546}
547
548/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700549 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 *
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700551 * Use the platform driver, if configured so; otherwise try
552 * to power off or reboot.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
554
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700555static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700557 switch (hibernation_mode) {
558 case HIBERNATION_TEST:
559 case HIBERNATION_TESTPROC:
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700560 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700561 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600562 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700564 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700565 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700566 case HIBERNATION_SHUTDOWN:
567 kernel_power_off();
568 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600570 kernel_halt();
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700571 /*
572 * Valid image is on the disk, if we continue we risk serious data
573 * corruption after resume.
574 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100575 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 while(1);
577}
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579static int prepare_processes(void)
580{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800581 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 if (freeze_processes()) {
584 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100585 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700587 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588}
589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700591 * hibernate - The granpappy of the built-in hibernation management
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 */
593
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700594int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595{
596 int error;
597
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700598 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700599 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700600 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
601 error = -EBUSY;
602 goto Unlock;
603 }
604
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100605 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700606 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
607 if (error)
608 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700609
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700610 error = usermodehelper_disable();
611 if (error)
612 goto Exit;
613
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700614 /* Allocate memory management structures */
615 error = create_basic_memory_bitmaps();
616 if (error)
617 goto Exit;
618
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100619 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700620 sys_sync();
621 printk("done.\n");
622
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700624 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700625 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100627 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800628 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100629
630 if (hibernation_testmode(HIBERNATION_TESTPROC))
631 goto Thaw;
632
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700633 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200634 if (error)
635 goto Thaw;
636
637 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700638 unsigned int flags = 0;
639
640 if (hibernation_mode == HIBERNATION_PLATFORM)
641 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200642 if (nocompress)
643 flags |= SF_NOCOMPRESS_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700645 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700646 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 if (!error)
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700648 power_down();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800649 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800651 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200652
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800653 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100654 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700655 Finish:
656 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700657 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700658 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700659 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100660 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700661 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700662 Unlock:
663 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 return error;
665}
666
667
668/**
669 * software_resume - Resume from a saved image.
670 *
671 * Called as a late_initcall (so all devices are discovered and
672 * initialized), we call swsusp to see if we have a saved image or not.
673 * If so, we quiesce devices, the restore the saved image. We will
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700674 * return above (in hibernate() ) if everything goes well.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 * Otherwise, we fail gracefully and return to the normally
676 * scheduled program.
677 *
678 */
679
680static int software_resume(void)
681{
682 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700683 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
Johannes Berg60a0d232007-11-14 17:00:16 -0800685 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100686 * If the user said "noresume".. bail out early.
687 */
688 if (noresume)
689 return 0;
690
691 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800692 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
693 * is configured into the kernel. Since the regular hibernate
694 * trigger path is via sysfs which takes a buffer mutex before
695 * calling hibernate functions (which take pm_mutex) this can
696 * cause lockdep to complain about a possible ABBA deadlock
697 * which cannot happen since we're in the boot code here and
698 * sysfs can't be invoked yet. Therefore, we use a subclass
699 * here to avoid lockdep complaining.
700 */
701 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200702
703 if (swsusp_resume_device)
704 goto Check_image;
705
706 if (!strlen(resume_file)) {
707 error = -ENOENT;
708 goto Unlock;
709 }
710
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200711 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200712
713 /* Check if the device is there */
714 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700715 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100716 /*
717 * Some device discovery might still be in progress; we need
718 * to wait for this to finish.
719 */
720 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200721 /*
722 * We can't depend on SCSI devices being available after loading
723 * one of their modules until scsi_complete_async_scans() is
724 * called and the resume device usually is a SCSI one.
725 */
726 scsi_complete_async_scans();
727
Pavel Machek3efa1472005-07-07 17:56:43 -0700728 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200729 if (!swsusp_resume_device) {
730 error = -ENODEV;
731 goto Unlock;
732 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700733 }
734
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200735 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200736 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200737 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200739 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800740 error = swsusp_check();
741 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700742 goto Unlock;
743
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700744 /* The snapshot device should not be opened while we're running */
745 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
746 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200747 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700748 goto Unlock;
749 }
750
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100751 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100752 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
753 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200754 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100755
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700756 error = usermodehelper_disable();
757 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200758 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700759
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700760 error = create_basic_memory_bitmaps();
761 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200762 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
764 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800765 error = prepare_processes();
766 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400767 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700768 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 }
770
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200771 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700773 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200774 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800775 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700776 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200778 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700779 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100780 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700782 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700783 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700784 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100785 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100786 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700787 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700788 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700789 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800790 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200791 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700792 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200793close_finish:
794 swsusp_close(FMODE_READ);
795 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796}
797
798late_initcall(software_resume);
799
800
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700801static const char * const hibernation_modes[] = {
802 [HIBERNATION_PLATFORM] = "platform",
803 [HIBERNATION_SHUTDOWN] = "shutdown",
804 [HIBERNATION_REBOOT] = "reboot",
805 [HIBERNATION_TEST] = "test",
806 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807};
808
809/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700810 * disk - Control hibernation mode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700812 * Suspend-to-disk can be handled in several ways. We have a few options
813 * for putting the system to sleep - using the platform driver (e.g. ACPI
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700814 * or other hibernation_ops), powering off the system or rebooting the
815 * system (for testing) as well as the two test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700817 * The system can support 'platform', and that is known a priori (and
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700818 * encoded by the presence of hibernation_ops). However, the user may
819 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
820 * test modes, 'test' or 'testproc'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 *
822 * show() will display what the mode is currently set to.
823 * store() will accept one of
824 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 * 'platform'
826 * 'shutdown'
827 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700828 * 'test'
829 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700831 * It will only change to 'platform' if the system
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700832 * supports it (as determined by having hibernation_ops).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 */
834
Kay Sievers386f2752007-11-02 13:47:53 +0100835static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
836 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700838 int i;
839 char *start = buf;
840
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700841 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
842 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700843 continue;
844 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700845 case HIBERNATION_SHUTDOWN:
846 case HIBERNATION_REBOOT:
847 case HIBERNATION_TEST:
848 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700849 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700850 case HIBERNATION_PLATFORM:
851 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700852 break;
853 /* not a valid mode, continue with loop */
854 continue;
855 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700856 if (i == hibernation_mode)
857 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700858 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700859 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700860 }
861 buf += sprintf(buf, "\n");
862 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
864
865
Kay Sievers386f2752007-11-02 13:47:53 +0100866static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
867 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868{
869 int error = 0;
870 int i;
871 int len;
872 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700873 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875 p = memchr(buf, '\n', n);
876 len = p ? p - buf : n;
877
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800878 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700879 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700880 if (len == strlen(hibernation_modes[i])
881 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 mode = i;
883 break;
884 }
885 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700886 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700887 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700888 case HIBERNATION_SHUTDOWN:
889 case HIBERNATION_REBOOT:
890 case HIBERNATION_TEST:
891 case HIBERNATION_TESTPROC:
892 hibernation_mode = mode;
Johannes Bergfe0c935a2007-04-30 15:09:51 -0700893 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700894 case HIBERNATION_PLATFORM:
895 if (hibernation_ops)
896 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 else
898 error = -EINVAL;
899 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700900 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 error = -EINVAL;
902
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700903 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100904 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700905 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800906 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 return error ? error : n;
908}
909
910power_attr(disk);
911
Kay Sievers386f2752007-11-02 13:47:53 +0100912static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
913 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914{
915 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
916 MINOR(swsusp_resume_device));
917}
918
Kay Sievers386f2752007-11-02 13:47:53 +0100919static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
920 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800924 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Andrew Mortona5762192006-01-06 00:09:50 -0800926 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
927 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928
Andrew Mortona5762192006-01-06 00:09:50 -0800929 res = MKDEV(maj,min);
930 if (maj != MAJOR(res) || min != MINOR(res))
931 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800933 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800934 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800935 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100936 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800937 noresume = 0;
938 software_resume();
939 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800940 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800941 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942}
943
944power_attr(resume);
945
Kay Sievers386f2752007-11-02 13:47:53 +0100946static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
947 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800948{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800949 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800950}
951
Kay Sievers386f2752007-11-02 13:47:53 +0100952static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
953 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800954{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800955 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800956
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800957 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800958 image_size = size;
959 return n;
960 }
961
962 return -EINVAL;
963}
964
965power_attr(image_size);
966
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967static struct attribute * g[] = {
968 &disk_attr.attr,
969 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800970 &image_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 NULL,
972};
973
974
975static struct attribute_group attr_group = {
976 .attrs = g,
977};
978
979
980static int __init pm_disk_init(void)
981{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800982 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983}
984
985core_initcall(pm_disk_init);
986
987
988static int __init resume_setup(char *str)
989{
990 if (noresume)
991 return 1;
992
993 strncpy( resume_file, str, 255 );
994 return 1;
995}
996
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -0800997static int __init resume_offset_setup(char *str)
998{
999 unsigned long long offset;
1000
1001 if (noresume)
1002 return 1;
1003
1004 if (sscanf(str, "%llu", &offset) == 1)
1005 swsusp_resume_block = offset;
1006
1007 return 1;
1008}
1009
Bojan Smojverf996fc92010-09-09 23:06:23 +02001010static int __init hibernate_setup(char *str)
1011{
1012 if (!strncmp(str, "noresume", 8))
1013 noresume = 1;
1014 else if (!strncmp(str, "nocompress", 10))
1015 nocompress = 1;
1016 return 1;
1017}
1018
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019static int __init noresume_setup(char *str)
1020{
1021 noresume = 1;
1022 return 1;
1023}
1024
1025__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001026__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001028__setup("hibernate=", hibernate_setup);