blob: d26f04e927437a153b08182b6f01d2b2dfed1357 [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
6 * Copyright (c) 2004 Pavel Machek <pavel@suse.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();
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800341 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
Alan Sternd1616302009-05-24 22:05:42 +0200342 error = dpm_suspend_start(PMSG_FREEZE);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700343 if (error)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200344 goto Recover_platform;
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700345
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100346 if (hibernation_test(TEST_DEVICES))
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200347 goto Recover_platform;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700348
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100349 error = create_image(platform_mode);
350 /* Control returns here after successful restore */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100351
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100352 Resume_devices:
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200353 /* We may need to release the preallocated image pages here. */
354 if (error || !in_suspend)
355 swsusp_free();
356
Alan Sternd1616302009-05-24 22:05:42 +0200357 dpm_resume_end(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200358 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800359 set_gfp_allowed_mask(saved_mask);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700360 resume_console();
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100361 Close:
362 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700363 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200364
365 Recover_platform:
366 platform_recover(platform_mode);
367 goto Resume_devices;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700368}
369
370/**
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100371 * resume_target_kernel - prepare devices that need to be suspended with
372 * interrupts off, restore the contents of highmem that have not been
373 * restored yet from the image and run the low level code that will restore
374 * the remaining contents of memory and switch to the just restored target
375 * kernel.
376 */
377
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100378static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100379{
380 int error;
381
Alan Sternd1616302009-05-24 22:05:42 +0200382 error = dpm_suspend_noirq(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100383 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100384 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100385 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200386 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100387 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100388
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100389 error = platform_pre_restore(platform_mode);
390 if (error)
391 goto Cleanup;
392
393 error = disable_nonboot_cpus();
394 if (error)
395 goto Enable_cpus;
396
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100397 local_irq_disable();
398
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100399 error = sysdev_suspend(PMSG_QUIESCE);
400 if (error)
401 goto Enable_irqs;
402
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100403 /* We'll ignore saved state, but this gets preempt count (etc) right */
404 save_processor_state();
405 error = restore_highmem();
406 if (!error) {
407 error = swsusp_arch_resume();
408 /*
409 * The code below is only ever reached in case of a failure.
410 * Otherwise execution continues at place where
411 * swsusp_arch_suspend() was called
412 */
413 BUG_ON(!error);
414 /* This call to restore_highmem() undos the previous one */
415 restore_highmem();
416 }
417 /*
418 * The only reason why swsusp_arch_resume() can fail is memory being
419 * very tight, so we have to free it as soon as we can to avoid
420 * subsequent failures
421 */
422 swsusp_free();
423 restore_processor_state();
424 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100425
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100426 sysdev_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100427
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100428 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100429 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100430
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100431 Enable_cpus:
432 enable_nonboot_cpus();
433
434 Cleanup:
435 platform_restore_cleanup(platform_mode);
436
Alan Sternd1616302009-05-24 22:05:42 +0200437 dpm_resume_noirq(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100438
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100439 return error;
440}
441
442/**
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700443 * hibernation_restore - quiesce devices and restore the hibernation
444 * snapshot image. If successful, control returns in hibernation_snaphot()
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700445 * @platform_mode - if set, use the platform driver, if available, to
Nick Andrew877d0312009-01-26 11:06:57 +0100446 * prepare the platform firmware for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700447 *
448 * Must be called with pm_mutex held
449 */
450
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700451int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700452{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100453 int error;
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800454 gfp_t saved_mask;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700455
456 pm_prepare_console();
457 suspend_console();
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800458 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
Alan Sternd1616302009-05-24 22:05:42 +0200459 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700460 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100461 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200462 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700463 }
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800464 set_gfp_allowed_mask(saved_mask);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700465 resume_console();
466 pm_restore_console();
467 return error;
468}
469
470/**
471 * hibernation_platform_enter - enter the hibernation state using the
472 * platform driver (if available)
473 */
474
475int hibernation_platform_enter(void)
476{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100477 int error;
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800478 gfp_t saved_mask;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700479
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700480 if (!hibernation_ops)
481 return -ENOSYS;
482
483 /*
484 * We have cancelled the power transition by running
485 * hibernation_ops->finish() before saving the image, so we should let
486 * the firmware know that we're going to enter the sleep state after all
487 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100488 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700489 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100490 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700491
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100492 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700493 suspend_console();
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800494 saved_mask = clear_gfp_allowed_mask(GFP_IOFS);
Alan Sternd1616302009-05-24 22:05:42 +0200495 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200496 if (error) {
497 if (hibernation_ops->recover)
498 hibernation_ops->recover();
499 goto Resume_devices;
500 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700501
Alan Sternd1616302009-05-24 22:05:42 +0200502 error = dpm_suspend_noirq(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100503 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200504 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100505
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100506 error = hibernation_ops->prepare();
507 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200508 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100509
510 error = disable_nonboot_cpus();
511 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200512 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100513
514 local_irq_disable();
515 sysdev_suspend(PMSG_HIBERNATE);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200516 if (!pm_check_wakeup_events()) {
517 error = -EAGAIN;
518 goto Power_up;
519 }
520
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100521 hibernation_ops->enter();
522 /* We should never get here */
523 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700524
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200525 Power_up:
526 sysdev_resume();
527 local_irq_enable();
528 enable_nonboot_cpus();
529
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200530 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700531 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100532
Rafael J. Wysockif6f71f12010-07-07 23:43:18 +0200533 dpm_resume_noirq(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100534
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700535 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100536 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200537 dpm_resume_end(PMSG_RESTORE);
Rafael J. Wysocki452aa692010-03-05 13:42:13 -0800538 set_gfp_allowed_mask(saved_mask);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700539 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100540
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100541 Close:
542 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100543
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700544 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700545}
546
547/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700548 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 *
Johannes Bergfe0c9352007-04-30 15:09:51 -0700550 * Use the platform driver, if configured so; otherwise try
551 * to power off or reboot.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 */
553
Johannes Bergfe0c9352007-04-30 15:09:51 -0700554static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555{
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700556 switch (hibernation_mode) {
557 case HIBERNATION_TEST:
558 case HIBERNATION_TESTPROC:
Johannes Bergfe0c9352007-04-30 15:09:51 -0700559 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700560 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600561 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700563 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700564 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700565 case HIBERNATION_SHUTDOWN:
566 kernel_power_off();
567 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600569 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700570 /*
571 * Valid image is on the disk, if we continue we risk serious data
572 * corruption after resume.
573 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100574 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 while(1);
576}
577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578static int prepare_processes(void)
579{
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800580 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 if (freeze_processes()) {
583 error = -EBUSY;
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100584 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 }
Li Shaohua5a72e042005-06-25 14:55:06 -0700586 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700590 * hibernate - The granpappy of the built-in hibernation management
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 */
592
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700593int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
595 int error;
596
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700597 mutex_lock(&pm_mutex);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700598 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700599 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
600 error = -EBUSY;
601 goto Unlock;
602 }
603
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100604 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700605 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
606 if (error)
607 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700608
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700609 error = usermodehelper_disable();
610 if (error)
611 goto Exit;
612
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700613 /* Allocate memory management structures */
614 error = create_basic_memory_bitmaps();
615 if (error)
616 goto Exit;
617
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100618 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700619 sys_sync();
620 printk("done.\n");
621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 error = prepare_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700623 if (error)
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700624 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100626 if (hibernation_test(TEST_FREEZER))
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800627 goto Thaw;
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100628
629 if (hibernation_testmode(HIBERNATION_TESTPROC))
630 goto Thaw;
631
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700632 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200633 if (error)
634 goto Thaw;
635
636 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700637 unsigned int flags = 0;
638
639 if (hibernation_mode == HIBERNATION_PLATFORM)
640 flags |= SF_PLATFORM_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700642 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700643 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700645 power_down();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800646 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800648 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200649
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800650 Thaw:
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100651 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700652 Finish:
653 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700654 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700655 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700656 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100657 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700658 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700659 Unlock:
660 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 return error;
662}
663
664
665/**
666 * software_resume - Resume from a saved image.
667 *
668 * Called as a late_initcall (so all devices are discovered and
669 * initialized), we call swsusp to see if we have a saved image or not.
670 * If so, we quiesce devices, the restore the saved image. We will
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700671 * return above (in hibernate() ) if everything goes well.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 * Otherwise, we fail gracefully and return to the normally
673 * scheduled program.
674 *
675 */
676
677static int software_resume(void)
678{
679 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700680 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Johannes Berg60a0d232007-11-14 17:00:16 -0800682 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100683 * If the user said "noresume".. bail out early.
684 */
685 if (noresume)
686 return 0;
687
688 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800689 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
690 * is configured into the kernel. Since the regular hibernate
691 * trigger path is via sysfs which takes a buffer mutex before
692 * calling hibernate functions (which take pm_mutex) this can
693 * cause lockdep to complain about a possible ABBA deadlock
694 * which cannot happen since we're in the boot code here and
695 * sysfs can't be invoked yet. Therefore, we use a subclass
696 * here to avoid lockdep complaining.
697 */
698 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200699
700 if (swsusp_resume_device)
701 goto Check_image;
702
703 if (!strlen(resume_file)) {
704 error = -ENOENT;
705 goto Unlock;
706 }
707
708 pr_debug("PM: Checking image partition %s\n", resume_file);
709
710 /* Check if the device is there */
711 swsusp_resume_device = name_to_dev_t(resume_file);
Pavel Machek3efa1472005-07-07 17:56:43 -0700712 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100713 /*
714 * Some device discovery might still be in progress; we need
715 * to wait for this to finish.
716 */
717 wait_for_device_probe();
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200718 /*
719 * We can't depend on SCSI devices being available after loading
720 * one of their modules until scsi_complete_async_scans() is
721 * called and the resume device usually is a SCSI one.
722 */
723 scsi_complete_async_scans();
724
Pavel Machek3efa1472005-07-07 17:56:43 -0700725 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200726 if (!swsusp_resume_device) {
727 error = -ENODEV;
728 goto Unlock;
729 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700730 }
731
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200732 Check_image:
733 pr_debug("PM: Resume from partition %d:%d\n",
734 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100736 pr_debug("PM: Checking hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800737 error = swsusp_check();
738 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700739 goto Unlock;
740
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700741 /* The snapshot device should not be opened while we're running */
742 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
743 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200744 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700745 goto Unlock;
746 }
747
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100748 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100749 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
750 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200751 goto close_finish;
Alan Sternc3e94d82007-11-19 23:38:25 +0100752
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700753 error = usermodehelper_disable();
754 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200755 goto close_finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700756
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700757 error = create_basic_memory_bitmaps();
758 if (error)
Jiri Slaby76b57e62009-10-07 22:37:35 +0200759 goto close_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
761 pr_debug("PM: Preparing processes for restore.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800762 error = prepare_processes();
763 if (error) {
Al Viroc2dd0da2007-10-08 13:21:10 -0400764 swsusp_close(FMODE_READ);
Li Shaohua5a72e042005-06-25 14:55:06 -0700765 goto Done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 }
767
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100768 pr_debug("PM: Reading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700770 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200771 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800772 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700773 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800775 printk(KERN_ERR "PM: Restore failed, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700776 swsusp_free();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100777 thaw_processes();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 Done:
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700779 free_basic_memory_bitmaps();
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700780 usermodehelper_enable();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700781 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100782 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100783 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700784 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700785 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700786 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800787 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 pr_debug("PM: Resume from disk failed.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700789 return error;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200790close_finish:
791 swsusp_close(FMODE_READ);
792 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793}
794
795late_initcall(software_resume);
796
797
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700798static const char * const hibernation_modes[] = {
799 [HIBERNATION_PLATFORM] = "platform",
800 [HIBERNATION_SHUTDOWN] = "shutdown",
801 [HIBERNATION_REBOOT] = "reboot",
802 [HIBERNATION_TEST] = "test",
803 [HIBERNATION_TESTPROC] = "testproc",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804};
805
806/**
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700807 * disk - Control hibernation mode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700809 * Suspend-to-disk can be handled in several ways. We have a few options
810 * for putting the system to sleep - using the platform driver (e.g. ACPI
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700811 * or other hibernation_ops), powering off the system or rebooting the
812 * system (for testing) as well as the two test modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700814 * The system can support 'platform', and that is known a priori (and
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700815 * encoded by the presence of hibernation_ops). However, the user may
816 * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
817 * test modes, 'test' or 'testproc'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 *
819 * show() will display what the mode is currently set to.
820 * store() will accept one of
821 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 * 'platform'
823 * 'shutdown'
824 * 'reboot'
Johannes Berg11d77d02007-04-30 15:09:53 -0700825 * 'test'
826 * 'testproc'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 *
Johannes Berg11d77d02007-04-30 15:09:53 -0700828 * It will only change to 'platform' if the system
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700829 * supports it (as determined by having hibernation_ops).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 */
831
Kay Sievers386f2752007-11-02 13:47:53 +0100832static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
833 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700835 int i;
836 char *start = buf;
837
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700838 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
839 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700840 continue;
841 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700842 case HIBERNATION_SHUTDOWN:
843 case HIBERNATION_REBOOT:
844 case HIBERNATION_TEST:
845 case HIBERNATION_TESTPROC:
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700846 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700847 case HIBERNATION_PLATFORM:
848 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700849 break;
850 /* not a valid mode, continue with loop */
851 continue;
852 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700853 if (i == hibernation_mode)
854 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700855 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700856 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700857 }
858 buf += sprintf(buf, "\n");
859 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860}
861
862
Kay Sievers386f2752007-11-02 13:47:53 +0100863static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
864 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865{
866 int error = 0;
867 int i;
868 int len;
869 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700870 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
872 p = memchr(buf, '\n', n);
873 len = p ? p - buf : n;
874
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800875 mutex_lock(&pm_mutex);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700876 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700877 if (len == strlen(hibernation_modes[i])
878 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 mode = i;
880 break;
881 }
882 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700883 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700884 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700885 case HIBERNATION_SHUTDOWN:
886 case HIBERNATION_REBOOT:
887 case HIBERNATION_TEST:
888 case HIBERNATION_TESTPROC:
889 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700890 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700891 case HIBERNATION_PLATFORM:
892 if (hibernation_ops)
893 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 else
895 error = -EINVAL;
896 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700897 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 error = -EINVAL;
899
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700900 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100901 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700902 hibernation_modes[mode]);
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800903 mutex_unlock(&pm_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 return error ? error : n;
905}
906
907power_attr(disk);
908
Kay Sievers386f2752007-11-02 13:47:53 +0100909static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
910 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911{
912 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
913 MINOR(swsusp_resume_device));
914}
915
Kay Sievers386f2752007-11-02 13:47:53 +0100916static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
917 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 unsigned int maj, min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 dev_t res;
Andrew Mortona5762192006-01-06 00:09:50 -0800921 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Andrew Mortona5762192006-01-06 00:09:50 -0800923 if (sscanf(buf, "%u:%u", &maj, &min) != 2)
924 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Andrew Mortona5762192006-01-06 00:09:50 -0800926 res = MKDEV(maj,min);
927 if (maj != MAJOR(res) || min != MINOR(res))
928 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800930 mutex_lock(&pm_mutex);
Andrew Mortona5762192006-01-06 00:09:50 -0800931 swsusp_resume_device = res;
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800932 mutex_unlock(&pm_mutex);
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100933 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800934 noresume = 0;
935 software_resume();
936 ret = n;
Rafael J. Wysocki59a493352006-12-06 20:34:44 -0800937 out:
Andrew Mortona5762192006-01-06 00:09:50 -0800938 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939}
940
941power_attr(resume);
942
Kay Sievers386f2752007-11-02 13:47:53 +0100943static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
944 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800945{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800946 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800947}
948
Kay Sievers386f2752007-11-02 13:47:53 +0100949static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
950 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800951{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800952 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800953
Rafael J. Wysocki853609b2006-02-01 03:05:07 -0800954 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800955 image_size = size;
956 return n;
957 }
958
959 return -EINVAL;
960}
961
962power_attr(image_size);
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964static struct attribute * g[] = {
965 &disk_attr.attr,
966 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -0800967 &image_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 NULL,
969};
970
971
972static struct attribute_group attr_group = {
973 .attrs = g,
974};
975
976
977static int __init pm_disk_init(void)
978{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -0800979 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980}
981
982core_initcall(pm_disk_init);
983
984
985static int __init resume_setup(char *str)
986{
987 if (noresume)
988 return 1;
989
990 strncpy( resume_file, str, 255 );
991 return 1;
992}
993
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -0800994static int __init resume_offset_setup(char *str)
995{
996 unsigned long long offset;
997
998 if (noresume)
999 return 1;
1000
1001 if (sscanf(str, "%llu", &offset) == 1)
1002 swsusp_resume_block = offset;
1003
1004 return 1;
1005}
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007static int __init noresume_setup(char *str)
1008{
1009 noresume = 1;
1010 return 1;
1011}
1012
1013__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001014__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015__setup("resume=", resume_setup);