blob: c77963938bca440a90423952d6d85cf4d66abd83 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070032static int noresume = 0;
Adrian Bunk47a460d2008-02-04 22:30:06 -080033static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080035sector_t swsusp_resume_block;
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +010036int in_suspend __nosavedata = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070038enum {
39 HIBERNATION_INVALID,
40 HIBERNATION_PLATFORM,
41 HIBERNATION_TEST,
42 HIBERNATION_TESTPROC,
43 HIBERNATION_SHUTDOWN,
44 HIBERNATION_REBOOT,
45 /* keep last */
46 __HIBERNATION_AFTER_LAST
47};
48#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
49#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
50
51static int hibernation_mode = HIBERNATION_SHUTDOWN;
52
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -070053static struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070054
55/**
56 * hibernation_set_ops - set the global hibernate operations
57 * @ops: the hibernation operations to use in subsequent hibernation transitions
58 */
59
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -070060void hibernation_set_ops(struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070061{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010062 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
63 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -070064 && ops->restore_cleanup)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070065 WARN_ON(1);
66 return;
67 }
68 mutex_lock(&pm_mutex);
69 hibernation_ops = ops;
70 if (ops)
71 hibernation_mode = HIBERNATION_PLATFORM;
72 else if (hibernation_mode == HIBERNATION_PLATFORM)
73 hibernation_mode = HIBERNATION_SHUTDOWN;
74
75 mutex_unlock(&pm_mutex);
76}
77
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010078static bool entering_platform_hibernation;
79
80bool system_entering_hibernation(void)
81{
82 return entering_platform_hibernation;
83}
84EXPORT_SYMBOL(system_entering_hibernation);
85
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010086#ifdef CONFIG_PM_DEBUG
87static void hibernation_debug_sleep(void)
88{
89 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
90 mdelay(5000);
91}
92
93static int hibernation_testmode(int mode)
94{
95 if (hibernation_mode == mode) {
96 hibernation_debug_sleep();
97 return 1;
98 }
99 return 0;
100}
101
102static int hibernation_test(int level)
103{
104 if (pm_test_level == level) {
105 hibernation_debug_sleep();
106 return 1;
107 }
108 return 0;
109}
110#else /* !CONFIG_PM_DEBUG */
111static int hibernation_testmode(int mode) { return 0; }
112static int hibernation_test(int level) { return 0; }
113#endif /* !CONFIG_PM_DEBUG */
114
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700115/**
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100116 * platform_begin - tell the platform driver that we're starting
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700117 * hibernation
118 */
119
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100120static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700121{
122 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100123 hibernation_ops->begin() : 0;
124}
125
126/**
127 * platform_end - tell the platform driver that we've entered the
128 * working state
129 */
130
131static void platform_end(int platform_mode)
132{
133 if (platform_mode && hibernation_ops)
134 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700135}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137/**
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700138 * platform_pre_snapshot - prepare the machine for hibernation using the
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800139 * platform driver if so configured and return an error code if it fails
140 */
141
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700142static int platform_pre_snapshot(int platform_mode)
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800143{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700144 return (platform_mode && hibernation_ops) ?
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700145 hibernation_ops->pre_snapshot() : 0;
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800146}
147
148/**
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700149 * platform_leave - prepare the machine for switching to the normal mode
150 * of operation using the platform driver (called with interrupts disabled)
151 */
152
153static void platform_leave(int platform_mode)
154{
155 if (platform_mode && hibernation_ops)
156 hibernation_ops->leave();
157}
158
159/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700160 * platform_finish - switch the machine to the normal mode of operation
161 * using the platform driver (must be called after platform_prepare())
162 */
163
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700164static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700165{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700166 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700167 hibernation_ops->finish();
168}
169
170/**
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700171 * platform_pre_restore - prepare the platform for the restoration from a
172 * hibernation image. If the restore fails after this function has been
173 * called, platform_restore_cleanup() must be called.
174 */
175
176static int platform_pre_restore(int platform_mode)
177{
178 return (platform_mode && hibernation_ops) ?
179 hibernation_ops->pre_restore() : 0;
180}
181
182/**
183 * platform_restore_cleanup - switch the platform to the normal mode of
184 * operation after a failing restore. If platform_pre_restore() has been
185 * called before the failing restore, this function must be called too,
186 * regardless of the result of platform_pre_restore().
187 */
188
189static void platform_restore_cleanup(int platform_mode)
190{
191 if (platform_mode && hibernation_ops)
192 hibernation_ops->restore_cleanup();
193}
194
195/**
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200196 * platform_recover - recover the platform from a failure to suspend
197 * devices.
198 */
199
200static void platform_recover(int platform_mode)
201{
202 if (platform_mode && hibernation_ops && hibernation_ops->recover)
203 hibernation_ops->recover();
204}
205
206/**
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100207 * swsusp_show_speed - print the time elapsed between two events.
208 * @start: Starting event.
209 * @stop: Final event.
210 * @nr_pages - number of pages processed between @start and @stop
211 * @msg - introductory message to print
212 */
213
214void swsusp_show_speed(struct timeval *start, struct timeval *stop,
215 unsigned nr_pages, char *msg)
216{
217 s64 elapsed_centisecs64;
218 int centisecs;
219 int k;
220 int kps;
221
222 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
223 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
224 centisecs = elapsed_centisecs64;
225 if (centisecs == 0)
226 centisecs = 1; /* avoid div-by-zero */
227 k = nr_pages * (PAGE_SIZE / 1024);
228 kps = (k * 100) / centisecs;
229 printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
230 msg, k,
231 centisecs / 100, centisecs % 100,
232 kps / 1000, (kps % 1000) / 10);
233}
234
235/**
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700236 * create_image - freeze devices that need to be frozen with interrupts
237 * off, create the hibernation image and thaw those devices. Control
238 * reappears in this routine after a restore.
239 */
240
Adrian Bunk47a460d2008-02-04 22:30:06 -0800241static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700242{
243 int error;
244
245 error = arch_prepare_suspend();
246 if (error)
247 return error;
248
Alan Sternd1616302009-05-24 22:05:42 +0200249 /* At this point, dpm_suspend_start() has been called, but *not*
250 * dpm_suspend_noirq(). We *must* call dpm_suspend_noirq() now.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700251 * Otherwise, drivers for some devices (e.g. interrupt controllers)
252 * become desynchronized with the actual state of the hardware
253 * at resume time, and evil weirdness ensues.
254 */
Alan Sternd1616302009-05-24 22:05:42 +0200255 error = dpm_suspend_noirq(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700256 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100257 printk(KERN_ERR "PM: Some devices failed to power down, "
258 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200259 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700260 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100261
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100262 error = platform_pre_snapshot(platform_mode);
263 if (error || hibernation_test(TEST_PLATFORM))
264 goto Platform_finish;
265
266 error = disable_nonboot_cpus();
267 if (error || hibernation_test(TEST_CPUS)
268 || hibernation_testmode(HIBERNATION_TEST))
269 goto Enable_cpus;
270
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100271 local_irq_disable();
272
Bjorn Helgaas44840792009-05-15 23:30:50 +0200273 error = sysdev_suspend(PMSG_FREEZE);
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100274 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200275 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100276 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100277 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100278 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700279
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200280 if (hibernation_test(TEST_CORE) || !pm_check_wakeup_events())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100281 goto Power_up;
282
283 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700284 save_processor_state();
285 error = swsusp_arch_suspend();
286 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100287 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
288 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700289 /* Restore control flow magically appears here */
290 restore_processor_state();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200291 if (!in_suspend) {
292 events_check_enabled = false;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700293 platform_leave(platform_mode);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200294 }
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100295
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100296 Power_up:
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100297 sysdev_resume();
Alan Sternd1616302009-05-24 22:05:42 +0200298 /* NOTE: dpm_resume_noirq() is just a resume() for devices
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700299 * that suspended with irqs off ... no overall powerup.
300 */
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100301
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100302 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100303 local_irq_enable();
304
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100305 Enable_cpus:
306 enable_nonboot_cpus();
307
308 Platform_finish:
309 platform_finish(platform_mode);
310
Alan Sternd1616302009-05-24 22:05:42 +0200311 dpm_resume_noirq(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200312 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100313
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700314 return error;
315}
316
317/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700318 * hibernation_snapshot - quiesce devices and create the hibernation
319 * snapshot image.
320 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100321 * prepare the platform firmware for the power transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700322 *
323 * Must be called with pm_mutex held
324 */
325
326int hibernation_snapshot(int platform_mode)
327{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100328 int error;
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800329 gfp_t saved_mask;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700330
Zhang Rui3fe03132008-10-26 20:50:26 +0100331 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700332 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200333 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700334
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200335 /* Preallocate image memory before shutting down devices. */
336 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700337 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100338 goto Close;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700339
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700340 suspend_console();
KAMEZAWA Hiroyukid2997b12010-08-09 17:20:11 -0700341 hibernation_freeze_swap();
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 Bergfe0c9352007-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 Bergfe0c9352007-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 Bergfe0c9352007-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 Bergfe0c9352007-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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700643 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700644 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700646 power_down();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800647 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800649 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200650
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800651 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100652 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700653 Finish:
654 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700655 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700656 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700657 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100658 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700659 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700660 Unlock:
661 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 return error;
663}
664
665
666/**
667 * software_resume - Resume from a saved image.
668 *
669 * Called as a late_initcall (so all devices are discovered and
670 * initialized), we call swsusp to see if we have a saved image or not.
671 * If so, we quiesce devices, the restore the saved image. We will
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700672 * return above (in hibernate() ) if everything goes well.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 * Otherwise, we fail gracefully and return to the normally
674 * scheduled program.
675 *
676 */
677
678static int software_resume(void)
679{
680 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700681 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Johannes Berg60a0d232007-11-14 17:00:16 -0800683 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100684 * If the user said "noresume".. bail out early.
685 */
686 if (noresume)
687 return 0;
688
689 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800690 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
691 * is configured into the kernel. Since the regular hibernate
692 * trigger path is via sysfs which takes a buffer mutex before
693 * calling hibernate functions (which take pm_mutex) this can
694 * cause lockdep to complain about a possible ABBA deadlock
695 * which cannot happen since we're in the boot code here and
696 * sysfs can't be invoked yet. Therefore, we use a subclass
697 * here to avoid lockdep complaining.
698 */
699 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200700
701 if (swsusp_resume_device)
702 goto Check_image;
703
704 if (!strlen(resume_file)) {
705 error = -ENOENT;
706 goto Unlock;
707 }
708
709 pr_debug("PM: Checking image partition %s\n", resume_file);
710
711 /* Check if the device is there */
712 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700713 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100714 /*
715 * Some device discovery might still be in progress; we need
716 * to wait for this to finish.
717 */
718 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200719 /*
720 * We can't depend on SCSI devices being available after loading
721 * one of their modules until scsi_complete_async_scans() is
722 * called and the resume device usually is a SCSI one.
723 */
724 scsi_complete_async_scans();
725
Pavel Machek3efa1472005-07-07 17:56:43 -0700726 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200727 if (!swsusp_resume_device) {
728 error = -ENODEV;
729 goto Unlock;
730 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700731 }
732
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200733 Check_image:
734 pr_debug("PM: Resume from partition %d:%d\n",
735 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100737 pr_debug("PM: Checking hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800738 error = swsusp_check();
739 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700740 goto Unlock;
741
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700742 /* The snapshot device should not be opened while we're running */
743 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
744 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200745 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700746 goto Unlock;
747 }
748
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100749 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100750 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
751 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200752 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100753
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700754 error = usermodehelper_disable();
755 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200756 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700757
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700758 error = create_basic_memory_bitmaps();
759 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200760 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
762 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800763 error = prepare_processes();
764 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400765 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700766 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 }
768
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100769 pr_debug("PM: Reading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700771 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200772 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800773 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700774 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800776 printk(KERN_ERR "PM: Restore failed, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700777 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100778 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700780 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700781 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700782 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100783 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100784 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700785 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700786 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700787 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800788 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 pr_debug("PM: Resume from disk failed.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700790 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200791close_finish:
792 swsusp_close(FMODE_READ);
793 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794}
795
796late_initcall(software_resume);
797
798
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700799static const char * const hibernation_modes[] = {
800 [HIBERNATION_PLATFORM] = "platform",
801 [HIBERNATION_SHUTDOWN] = "shutdown",
802 [HIBERNATION_REBOOT] = "reboot",
803 [HIBERNATION_TEST] = "test",
804 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805};
806
807/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700808 * disk - Control hibernation mode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700810 * Suspend-to-disk can be handled in several ways. We have a few options
811 * for putting the system to sleep - using the platform driver (e.g. ACPI
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700812 * or other hibernation_ops), powering off the system or rebooting the
813 * system (for testing) as well as the two test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700815 * The system can support 'platform', and that is known a priori (and
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700816 * encoded by the presence of hibernation_ops). However, the user may
817 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
818 * test modes, 'test' or 'testproc'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 *
820 * show() will display what the mode is currently set to.
821 * store() will accept one of
822 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 * 'platform'
824 * 'shutdown'
825 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700826 * 'test'
827 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700829 * It will only change to 'platform' if the system
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700830 * supports it (as determined by having hibernation_ops).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 */
832
Kay Sievers386f2752007-11-02 13:47:53 +0100833static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
834 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700836 int i;
837 char *start = buf;
838
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700839 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
840 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700841 continue;
842 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700843 case HIBERNATION_SHUTDOWN:
844 case HIBERNATION_REBOOT:
845 case HIBERNATION_TEST:
846 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700847 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700848 case HIBERNATION_PLATFORM:
849 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700850 break;
851 /* not a valid mode, continue with loop */
852 continue;
853 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700854 if (i == hibernation_mode)
855 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700856 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700857 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700858 }
859 buf += sprintf(buf, "\n");
860 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861}
862
863
Kay Sievers386f2752007-11-02 13:47:53 +0100864static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
865 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
867 int error = 0;
868 int i;
869 int len;
870 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700871 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
873 p = memchr(buf, '\n', n);
874 len = p ? p - buf : n;
875
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800876 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700877 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700878 if (len == strlen(hibernation_modes[i])
879 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 mode = i;
881 break;
882 }
883 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700884 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700885 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700886 case HIBERNATION_SHUTDOWN:
887 case HIBERNATION_REBOOT:
888 case HIBERNATION_TEST:
889 case HIBERNATION_TESTPROC:
890 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700891 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700892 case HIBERNATION_PLATFORM:
893 if (hibernation_ops)
894 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 else
896 error = -EINVAL;
897 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700898 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 error = -EINVAL;
900
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700901 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100902 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700903 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800904 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 return error ? error : n;
906}
907
908power_attr(disk);
909
Kay Sievers386f2752007-11-02 13:47:53 +0100910static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
911 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
913 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
914 MINOR(swsusp_resume_device));
915}
916
Kay Sievers386f2752007-11-02 13:47:53 +0100917static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
918 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800922 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
Andrew Mortona5762192006-01-06 00:09:50 -0800924 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
925 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Andrew Mortona5762192006-01-06 00:09:50 -0800927 res = MKDEV(maj,min);
928 if (maj != MAJOR(res) || min != MINOR(res))
929 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800931 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800932 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800933 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100934 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800935 noresume = 0;
936 software_resume();
937 ret = n;
Rafael J. Wysocki59a49332006-12-06 20:34:44 -0800938 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800939 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940}
941
942power_attr(resume);
943
Kay Sievers386f2752007-11-02 13:47:53 +0100944static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
945 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800946{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800947 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800948}
949
Kay Sievers386f2752007-11-02 13:47:53 +0100950static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
951 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800952{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800953 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800954
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800955 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800956 image_size = size;
957 return n;
958 }
959
960 return -EINVAL;
961}
962
963power_attr(image_size);
964
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965static struct attribute * g[] = {
966 &disk_attr.attr,
967 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800968 &image_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 NULL,
970};
971
972
973static struct attribute_group attr_group = {
974 .attrs = g,
975};
976
977
978static int __init pm_disk_init(void)
979{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800980 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981}
982
983core_initcall(pm_disk_init);
984
985
986static int __init resume_setup(char *str)
987{
988 if (noresume)
989 return 1;
990
991 strncpy( resume_file, str, 255 );
992 return 1;
993}
994
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -0800995static int __init resume_offset_setup(char *str)
996{
997 unsigned long long offset;
998
999 if (noresume)
1000 return 1;
1001
1002 if (sscanf(str, "%llu", &offset) == 1)
1003 swsusp_resume_block = offset;
1004
1005 return 1;
1006}
1007
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008static int __init noresume_setup(char *str)
1009{
1010 noresume = 1;
1011 return 1;
1012}
1013
1014__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001015__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016__setup("resume=", resume_setup);