Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * kernel/power/disk.c - Suspend-to-disk support. | |
3 | * | |
4 | * Copyright (c) 2003 Patrick Mochel | |
5 | * Copyright (c) 2003 Open Source Development Lab | |
6 | * Copyright (c) 2004 Pavel Machek <pavel@suse.cz> | |
7 | * | |
8 | * This file is released under the GPLv2. | |
9 | * | |
10 | */ | |
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> | |
1bfcf130 | 17 | #include <linux/kmod.h> |
1da177e4 LT |
18 | #include <linux/delay.h> |
19 | #include <linux/fs.h> | |
d53d9f16 | 20 | #include <linux/mount.h> |
88d10bba | 21 | #include <linux/pm.h> |
97c7801c | 22 | #include <linux/console.h> |
e3920fb4 | 23 | #include <linux/cpu.h> |
7dfb7103 | 24 | #include <linux/freezer.h> |
d53d9f16 | 25 | |
1da177e4 LT |
26 | #include "power.h" |
27 | ||
28 | ||
1da177e4 | 29 | static int noresume = 0; |
47a460d5 | 30 | static char resume_file[256] = CONFIG_PM_STD_PARTITION; |
1da177e4 | 31 | dev_t swsusp_resume_device; |
9a154d9d | 32 | sector_t swsusp_resume_block; |
1da177e4 | 33 | |
a3d25c27 RW |
34 | enum { |
35 | HIBERNATION_INVALID, | |
36 | HIBERNATION_PLATFORM, | |
37 | HIBERNATION_TEST, | |
38 | HIBERNATION_TESTPROC, | |
39 | HIBERNATION_SHUTDOWN, | |
40 | HIBERNATION_REBOOT, | |
41 | /* keep last */ | |
42 | __HIBERNATION_AFTER_LAST | |
43 | }; | |
44 | #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1) | |
45 | #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1) | |
46 | ||
47 | static int hibernation_mode = HIBERNATION_SHUTDOWN; | |
48 | ||
b3dac3b3 | 49 | static struct platform_hibernation_ops *hibernation_ops; |
a3d25c27 RW |
50 | |
51 | /** | |
52 | * hibernation_set_ops - set the global hibernate operations | |
53 | * @ops: the hibernation operations to use in subsequent hibernation transitions | |
54 | */ | |
55 | ||
b3dac3b3 | 56 | void hibernation_set_ops(struct platform_hibernation_ops *ops) |
a3d25c27 | 57 | { |
caea99ef RW |
58 | if (ops && !(ops->begin && ops->end && ops->pre_snapshot |
59 | && ops->prepare && ops->finish && ops->enter && ops->pre_restore | |
74f270af | 60 | && ops->restore_cleanup)) { |
a3d25c27 RW |
61 | WARN_ON(1); |
62 | return; | |
63 | } | |
64 | mutex_lock(&pm_mutex); | |
65 | hibernation_ops = ops; | |
66 | if (ops) | |
67 | hibernation_mode = HIBERNATION_PLATFORM; | |
68 | else if (hibernation_mode == HIBERNATION_PLATFORM) | |
69 | hibernation_mode = HIBERNATION_SHUTDOWN; | |
70 | ||
71 | mutex_unlock(&pm_mutex); | |
72 | } | |
73 | ||
4cc79776 RW |
74 | #ifdef CONFIG_PM_DEBUG |
75 | static void hibernation_debug_sleep(void) | |
76 | { | |
77 | printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n"); | |
78 | mdelay(5000); | |
79 | } | |
80 | ||
81 | static int hibernation_testmode(int mode) | |
82 | { | |
83 | if (hibernation_mode == mode) { | |
84 | hibernation_debug_sleep(); | |
85 | return 1; | |
86 | } | |
87 | return 0; | |
88 | } | |
89 | ||
90 | static int hibernation_test(int level) | |
91 | { | |
92 | if (pm_test_level == level) { | |
93 | hibernation_debug_sleep(); | |
94 | return 1; | |
95 | } | |
96 | return 0; | |
97 | } | |
98 | #else /* !CONFIG_PM_DEBUG */ | |
99 | static int hibernation_testmode(int mode) { return 0; } | |
100 | static int hibernation_test(int level) { return 0; } | |
101 | #endif /* !CONFIG_PM_DEBUG */ | |
102 | ||
74f270af | 103 | /** |
caea99ef | 104 | * platform_begin - tell the platform driver that we're starting |
74f270af RW |
105 | * hibernation |
106 | */ | |
107 | ||
caea99ef | 108 | static int platform_begin(int platform_mode) |
74f270af RW |
109 | { |
110 | return (platform_mode && hibernation_ops) ? | |
caea99ef RW |
111 | hibernation_ops->begin() : 0; |
112 | } | |
113 | ||
114 | /** | |
115 | * platform_end - tell the platform driver that we've entered the | |
116 | * working state | |
117 | */ | |
118 | ||
119 | static void platform_end(int platform_mode) | |
120 | { | |
121 | if (platform_mode && hibernation_ops) | |
122 | hibernation_ops->end(); | |
74f270af | 123 | } |
a3d25c27 | 124 | |
8a05aac2 | 125 | /** |
74f270af | 126 | * platform_pre_snapshot - prepare the machine for hibernation using the |
8a05aac2 SS |
127 | * platform driver if so configured and return an error code if it fails |
128 | */ | |
129 | ||
74f270af | 130 | static int platform_pre_snapshot(int platform_mode) |
8a05aac2 | 131 | { |
7777fab9 | 132 | return (platform_mode && hibernation_ops) ? |
74f270af | 133 | hibernation_ops->pre_snapshot() : 0; |
a3d25c27 | 134 | } |
8a05aac2 | 135 | |
c7e0831d RW |
136 | /** |
137 | * platform_leave - prepare the machine for switching to the normal mode | |
138 | * of operation using the platform driver (called with interrupts disabled) | |
139 | */ | |
140 | ||
141 | static void platform_leave(int platform_mode) | |
142 | { | |
143 | if (platform_mode && hibernation_ops) | |
144 | hibernation_ops->leave(); | |
145 | } | |
146 | ||
a3d25c27 RW |
147 | /** |
148 | * platform_finish - switch the machine to the normal mode of operation | |
149 | * using the platform driver (must be called after platform_prepare()) | |
150 | */ | |
151 | ||
7777fab9 | 152 | static void platform_finish(int platform_mode) |
a3d25c27 | 153 | { |
7777fab9 | 154 | if (platform_mode && hibernation_ops) |
a3d25c27 | 155 | hibernation_ops->finish(); |
8a05aac2 SS |
156 | } |
157 | ||
a634cc10 RW |
158 | /** |
159 | * platform_pre_restore - prepare the platform for the restoration from a | |
160 | * hibernation image. If the restore fails after this function has been | |
161 | * called, platform_restore_cleanup() must be called. | |
162 | */ | |
163 | ||
164 | static int platform_pre_restore(int platform_mode) | |
165 | { | |
166 | return (platform_mode && hibernation_ops) ? | |
167 | hibernation_ops->pre_restore() : 0; | |
168 | } | |
169 | ||
170 | /** | |
171 | * platform_restore_cleanup - switch the platform to the normal mode of | |
172 | * operation after a failing restore. If platform_pre_restore() has been | |
173 | * called before the failing restore, this function must be called too, | |
174 | * regardless of the result of platform_pre_restore(). | |
175 | */ | |
176 | ||
177 | static void platform_restore_cleanup(int platform_mode) | |
178 | { | |
179 | if (platform_mode && hibernation_ops) | |
180 | hibernation_ops->restore_cleanup(); | |
181 | } | |
182 | ||
d8f3de0d RW |
183 | /** |
184 | * platform_recover - recover the platform from a failure to suspend | |
185 | * devices. | |
186 | */ | |
187 | ||
188 | static void platform_recover(int platform_mode) | |
189 | { | |
190 | if (platform_mode && hibernation_ops && hibernation_ops->recover) | |
191 | hibernation_ops->recover(); | |
192 | } | |
193 | ||
c7e0831d RW |
194 | /** |
195 | * create_image - freeze devices that need to be frozen with interrupts | |
196 | * off, create the hibernation image and thaw those devices. Control | |
197 | * reappears in this routine after a restore. | |
198 | */ | |
199 | ||
47a460d5 | 200 | static int create_image(int platform_mode) |
c7e0831d RW |
201 | { |
202 | int error; | |
203 | ||
204 | error = arch_prepare_suspend(); | |
205 | if (error) | |
206 | return error; | |
207 | ||
1eede070 | 208 | device_pm_lock(); |
c7e0831d RW |
209 | local_irq_disable(); |
210 | /* At this point, device_suspend() has been called, but *not* | |
211 | * device_power_down(). We *must* call device_power_down() now. | |
212 | * Otherwise, drivers for some devices (e.g. interrupt controllers) | |
213 | * become desynchronized with the actual state of the hardware | |
214 | * at resume time, and evil weirdness ensues. | |
215 | */ | |
216 | error = device_power_down(PMSG_FREEZE); | |
217 | if (error) { | |
23976728 RW |
218 | printk(KERN_ERR "PM: Some devices failed to power down, " |
219 | "aborting hibernation\n"); | |
c7e0831d RW |
220 | goto Enable_irqs; |
221 | } | |
222 | ||
4cc79776 RW |
223 | if (hibernation_test(TEST_CORE)) |
224 | goto Power_up; | |
225 | ||
226 | in_suspend = 1; | |
c7e0831d RW |
227 | save_processor_state(); |
228 | error = swsusp_arch_suspend(); | |
229 | if (error) | |
23976728 RW |
230 | printk(KERN_ERR "PM: Error %d creating hibernation image\n", |
231 | error); | |
c7e0831d RW |
232 | /* Restore control flow magically appears here */ |
233 | restore_processor_state(); | |
234 | if (!in_suspend) | |
235 | platform_leave(platform_mode); | |
4cc79776 | 236 | Power_up: |
c7e0831d RW |
237 | /* NOTE: device_power_up() is just a resume() for devices |
238 | * that suspended with irqs off ... no overall powerup. | |
239 | */ | |
1eede070 RW |
240 | device_power_up(in_suspend ? |
241 | (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE); | |
c7e0831d RW |
242 | Enable_irqs: |
243 | local_irq_enable(); | |
1eede070 | 244 | device_pm_unlock(); |
c7e0831d RW |
245 | return error; |
246 | } | |
247 | ||
7777fab9 RW |
248 | /** |
249 | * hibernation_snapshot - quiesce devices and create the hibernation | |
250 | * snapshot image. | |
251 | * @platform_mode - if set, use the platform driver, if available, to | |
252 | * prepare the platform frimware for the power transition. | |
253 | * | |
254 | * Must be called with pm_mutex held | |
255 | */ | |
256 | ||
257 | int hibernation_snapshot(int platform_mode) | |
258 | { | |
cbe2f5a6 | 259 | int error; |
7777fab9 RW |
260 | |
261 | /* Free memory before shutting down devices. */ | |
262 | error = swsusp_shrink_memory(); | |
263 | if (error) | |
10a1803d | 264 | return error; |
7777fab9 | 265 | |
caea99ef | 266 | error = platform_begin(platform_mode); |
74f270af | 267 | if (error) |
caea99ef | 268 | goto Close; |
74f270af | 269 | |
7777fab9 RW |
270 | suspend_console(); |
271 | error = device_suspend(PMSG_FREEZE); | |
10a1803d | 272 | if (error) |
d8f3de0d | 273 | goto Recover_platform; |
10a1803d | 274 | |
4cc79776 | 275 | if (hibernation_test(TEST_DEVICES)) |
d8f3de0d | 276 | goto Recover_platform; |
7777fab9 | 277 | |
4cc79776 RW |
278 | error = platform_pre_snapshot(platform_mode); |
279 | if (error || hibernation_test(TEST_PLATFORM)) | |
280 | goto Finish; | |
281 | ||
7777fab9 RW |
282 | error = disable_nonboot_cpus(); |
283 | if (!error) { | |
4cc79776 RW |
284 | if (hibernation_test(TEST_CPUS)) |
285 | goto Enable_cpus; | |
286 | ||
287 | if (hibernation_testmode(HIBERNATION_TEST)) | |
288 | goto Enable_cpus; | |
289 | ||
290 | error = create_image(platform_mode); | |
291 | /* Control returns here after successful restore */ | |
7777fab9 | 292 | } |
4cc79776 | 293 | Enable_cpus: |
7777fab9 | 294 | enable_nonboot_cpus(); |
4cc79776 | 295 | Finish: |
7777fab9 | 296 | platform_finish(platform_mode); |
4cc79776 | 297 | Resume_devices: |
1eede070 RW |
298 | device_resume(in_suspend ? |
299 | (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE); | |
7777fab9 | 300 | resume_console(); |
caea99ef RW |
301 | Close: |
302 | platform_end(platform_mode); | |
7777fab9 | 303 | return error; |
d8f3de0d RW |
304 | |
305 | Recover_platform: | |
306 | platform_recover(platform_mode); | |
307 | goto Resume_devices; | |
7777fab9 RW |
308 | } |
309 | ||
72df68ca RW |
310 | /** |
311 | * resume_target_kernel - prepare devices that need to be suspended with | |
312 | * interrupts off, restore the contents of highmem that have not been | |
313 | * restored yet from the image and run the low level code that will restore | |
314 | * the remaining contents of memory and switch to the just restored target | |
315 | * kernel. | |
316 | */ | |
317 | ||
318 | static int resume_target_kernel(void) | |
319 | { | |
320 | int error; | |
321 | ||
1eede070 | 322 | device_pm_lock(); |
72df68ca | 323 | local_irq_disable(); |
1eede070 | 324 | error = device_power_down(PMSG_QUIESCE); |
72df68ca | 325 | if (error) { |
23976728 | 326 | printk(KERN_ERR "PM: Some devices failed to power down, " |
72df68ca RW |
327 | "aborting resume\n"); |
328 | goto Enable_irqs; | |
329 | } | |
330 | /* We'll ignore saved state, but this gets preempt count (etc) right */ | |
331 | save_processor_state(); | |
332 | error = restore_highmem(); | |
333 | if (!error) { | |
334 | error = swsusp_arch_resume(); | |
335 | /* | |
336 | * The code below is only ever reached in case of a failure. | |
337 | * Otherwise execution continues at place where | |
338 | * swsusp_arch_suspend() was called | |
339 | */ | |
340 | BUG_ON(!error); | |
341 | /* This call to restore_highmem() undos the previous one */ | |
342 | restore_highmem(); | |
343 | } | |
344 | /* | |
345 | * The only reason why swsusp_arch_resume() can fail is memory being | |
346 | * very tight, so we have to free it as soon as we can to avoid | |
347 | * subsequent failures | |
348 | */ | |
349 | swsusp_free(); | |
350 | restore_processor_state(); | |
351 | touch_softlockup_watchdog(); | |
1eede070 | 352 | device_power_up(PMSG_RECOVER); |
72df68ca RW |
353 | Enable_irqs: |
354 | local_irq_enable(); | |
1eede070 | 355 | device_pm_unlock(); |
72df68ca RW |
356 | return error; |
357 | } | |
358 | ||
7777fab9 RW |
359 | /** |
360 | * hibernation_restore - quiesce devices and restore the hibernation | |
361 | * snapshot image. If successful, control returns in hibernation_snaphot() | |
a634cc10 RW |
362 | * @platform_mode - if set, use the platform driver, if available, to |
363 | * prepare the platform frimware for the transition. | |
7777fab9 RW |
364 | * |
365 | * Must be called with pm_mutex held | |
366 | */ | |
367 | ||
a634cc10 | 368 | int hibernation_restore(int platform_mode) |
7777fab9 | 369 | { |
cbe2f5a6 | 370 | int error; |
7777fab9 RW |
371 | |
372 | pm_prepare_console(); | |
373 | suspend_console(); | |
1eede070 | 374 | error = device_suspend(PMSG_QUIESCE); |
7777fab9 RW |
375 | if (error) |
376 | goto Finish; | |
377 | ||
a634cc10 RW |
378 | error = platform_pre_restore(platform_mode); |
379 | if (!error) { | |
380 | error = disable_nonboot_cpus(); | |
381 | if (!error) | |
72df68ca | 382 | error = resume_target_kernel(); |
a634cc10 RW |
383 | enable_nonboot_cpus(); |
384 | } | |
385 | platform_restore_cleanup(platform_mode); | |
1eede070 | 386 | device_resume(PMSG_RECOVER); |
10a1803d | 387 | Finish: |
7777fab9 RW |
388 | resume_console(); |
389 | pm_restore_console(); | |
390 | return error; | |
391 | } | |
392 | ||
393 | /** | |
394 | * hibernation_platform_enter - enter the hibernation state using the | |
395 | * platform driver (if available) | |
396 | */ | |
397 | ||
398 | int hibernation_platform_enter(void) | |
399 | { | |
cbe2f5a6 | 400 | int error; |
b1457bcc | 401 | |
9cd9a005 RW |
402 | if (!hibernation_ops) |
403 | return -ENOSYS; | |
404 | ||
405 | /* | |
406 | * We have cancelled the power transition by running | |
407 | * hibernation_ops->finish() before saving the image, so we should let | |
408 | * the firmware know that we're going to enter the sleep state after all | |
409 | */ | |
caea99ef | 410 | error = hibernation_ops->begin(); |
9cd9a005 | 411 | if (error) |
caea99ef | 412 | goto Close; |
9cd9a005 RW |
413 | |
414 | suspend_console(); | |
3a2d5b70 | 415 | error = device_suspend(PMSG_HIBERNATE); |
d8f3de0d RW |
416 | if (error) { |
417 | if (hibernation_ops->recover) | |
418 | hibernation_ops->recover(); | |
419 | goto Resume_devices; | |
420 | } | |
9cd9a005 RW |
421 | |
422 | error = hibernation_ops->prepare(); | |
423 | if (error) | |
424 | goto Resume_devices; | |
425 | ||
426 | error = disable_nonboot_cpus(); | |
427 | if (error) | |
428 | goto Finish; | |
429 | ||
1eede070 | 430 | device_pm_lock(); |
9cd9a005 | 431 | local_irq_disable(); |
3a2d5b70 | 432 | error = device_power_down(PMSG_HIBERNATE); |
9cd9a005 RW |
433 | if (!error) { |
434 | hibernation_ops->enter(); | |
435 | /* We should never get here */ | |
436 | while (1); | |
7777fab9 | 437 | } |
9cd9a005 | 438 | local_irq_enable(); |
1eede070 | 439 | device_pm_unlock(); |
9cd9a005 RW |
440 | |
441 | /* | |
442 | * We don't need to reenable the nonboot CPUs or resume consoles, since | |
443 | * the system is going to be halted anyway. | |
444 | */ | |
445 | Finish: | |
446 | hibernation_ops->finish(); | |
447 | Resume_devices: | |
1eede070 | 448 | device_resume(PMSG_RESTORE); |
9cd9a005 | 449 | resume_console(); |
caea99ef RW |
450 | Close: |
451 | hibernation_ops->end(); | |
b1457bcc | 452 | return error; |
7777fab9 RW |
453 | } |
454 | ||
1da177e4 | 455 | /** |
a3d25c27 | 456 | * power_down - Shut the machine down for hibernation. |
1da177e4 | 457 | * |
fe0c935a JB |
458 | * Use the platform driver, if configured so; otherwise try |
459 | * to power off or reboot. | |
1da177e4 LT |
460 | */ |
461 | ||
fe0c935a | 462 | static void power_down(void) |
1da177e4 | 463 | { |
a3d25c27 RW |
464 | switch (hibernation_mode) { |
465 | case HIBERNATION_TEST: | |
466 | case HIBERNATION_TESTPROC: | |
fe0c935a | 467 | break; |
a3d25c27 | 468 | case HIBERNATION_REBOOT: |
fdde86ac | 469 | kernel_restart(NULL); |
1da177e4 | 470 | break; |
a3d25c27 | 471 | case HIBERNATION_PLATFORM: |
7777fab9 | 472 | hibernation_platform_enter(); |
9cd9a005 RW |
473 | case HIBERNATION_SHUTDOWN: |
474 | kernel_power_off(); | |
475 | break; | |
1da177e4 | 476 | } |
fdde86ac | 477 | kernel_halt(); |
fe0c935a JB |
478 | /* |
479 | * Valid image is on the disk, if we continue we risk serious data | |
480 | * corruption after resume. | |
481 | */ | |
23976728 | 482 | printk(KERN_CRIT "PM: Please power down manually\n"); |
1da177e4 LT |
483 | while(1); |
484 | } | |
485 | ||
1da177e4 LT |
486 | static int prepare_processes(void) |
487 | { | |
b918f6e6 | 488 | int error = 0; |
1da177e4 | 489 | |
1da177e4 LT |
490 | if (freeze_processes()) { |
491 | error = -EBUSY; | |
5a0a2f30 | 492 | thaw_processes(); |
1da177e4 | 493 | } |
5a72e04d | 494 | return error; |
1da177e4 LT |
495 | } |
496 | ||
1da177e4 | 497 | /** |
a3d25c27 | 498 | * hibernate - The granpappy of the built-in hibernation management |
1da177e4 LT |
499 | */ |
500 | ||
a3d25c27 | 501 | int hibernate(void) |
1da177e4 LT |
502 | { |
503 | int error; | |
504 | ||
b10d9117 | 505 | mutex_lock(&pm_mutex); |
0709db60 | 506 | /* The snapshot device should not be opened while we're running */ |
b10d9117 RW |
507 | if (!atomic_add_unless(&snapshot_device_available, -1, 0)) { |
508 | error = -EBUSY; | |
509 | goto Unlock; | |
510 | } | |
511 | ||
5a0a2f30 | 512 | pm_prepare_console(); |
b10d9117 RW |
513 | error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE); |
514 | if (error) | |
515 | goto Exit; | |
0709db60 | 516 | |
1bfcf130 RW |
517 | error = usermodehelper_disable(); |
518 | if (error) | |
519 | goto Exit; | |
520 | ||
0709db60 RW |
521 | /* Allocate memory management structures */ |
522 | error = create_basic_memory_bitmaps(); | |
523 | if (error) | |
524 | goto Exit; | |
525 | ||
23976728 | 526 | printk(KERN_INFO "PM: Syncing filesystems ... "); |
232b1432 RW |
527 | sys_sync(); |
528 | printk("done.\n"); | |
529 | ||
1da177e4 | 530 | error = prepare_processes(); |
5a72e04d | 531 | if (error) |
0709db60 | 532 | goto Finish; |
1da177e4 | 533 | |
4cc79776 | 534 | if (hibernation_test(TEST_FREEZER)) |
ed746e3b | 535 | goto Thaw; |
4cc79776 RW |
536 | |
537 | if (hibernation_testmode(HIBERNATION_TESTPROC)) | |
538 | goto Thaw; | |
539 | ||
7777fab9 RW |
540 | error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM); |
541 | if (in_suspend && !error) { | |
a634cc10 RW |
542 | unsigned int flags = 0; |
543 | ||
544 | if (hibernation_mode == HIBERNATION_PLATFORM) | |
545 | flags |= SF_PLATFORM_MODE; | |
1da177e4 | 546 | pr_debug("PM: writing image.\n"); |
a634cc10 | 547 | error = swsusp_write(flags); |
7777fab9 | 548 | swsusp_free(); |
1da177e4 | 549 | if (!error) |
fe0c935a | 550 | power_down(); |
b918f6e6 | 551 | } else { |
1da177e4 | 552 | pr_debug("PM: Image restored successfully.\n"); |
7777fab9 | 553 | swsusp_free(); |
b918f6e6 | 554 | } |
b918f6e6 | 555 | Thaw: |
5a0a2f30 | 556 | thaw_processes(); |
0709db60 RW |
557 | Finish: |
558 | free_basic_memory_bitmaps(); | |
1bfcf130 | 559 | usermodehelper_enable(); |
0709db60 | 560 | Exit: |
b10d9117 | 561 | pm_notifier_call_chain(PM_POST_HIBERNATION); |
5a0a2f30 | 562 | pm_restore_console(); |
0709db60 | 563 | atomic_inc(&snapshot_device_available); |
b10d9117 RW |
564 | Unlock: |
565 | mutex_unlock(&pm_mutex); | |
1da177e4 LT |
566 | return error; |
567 | } | |
568 | ||
569 | ||
570 | /** | |
571 | * software_resume - Resume from a saved image. | |
572 | * | |
573 | * Called as a late_initcall (so all devices are discovered and | |
574 | * initialized), we call swsusp to see if we have a saved image or not. | |
575 | * If so, we quiesce devices, the restore the saved image. We will | |
a3d25c27 | 576 | * return above (in hibernate() ) if everything goes well. |
1da177e4 LT |
577 | * Otherwise, we fail gracefully and return to the normally |
578 | * scheduled program. | |
579 | * | |
580 | */ | |
581 | ||
582 | static int software_resume(void) | |
583 | { | |
584 | int error; | |
a634cc10 | 585 | unsigned int flags; |
1da177e4 | 586 | |
60a0d233 JB |
587 | /* |
588 | * name_to_dev_t() below takes a sysfs buffer mutex when sysfs | |
589 | * is configured into the kernel. Since the regular hibernate | |
590 | * trigger path is via sysfs which takes a buffer mutex before | |
591 | * calling hibernate functions (which take pm_mutex) this can | |
592 | * cause lockdep to complain about a possible ABBA deadlock | |
593 | * which cannot happen since we're in the boot code here and | |
594 | * sysfs can't be invoked yet. Therefore, we use a subclass | |
595 | * here to avoid lockdep complaining. | |
596 | */ | |
597 | mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING); | |
3efa147a | 598 | if (!swsusp_resume_device) { |
dd5d666b | 599 | if (!strlen(resume_file)) { |
a6d70980 | 600 | mutex_unlock(&pm_mutex); |
3efa147a | 601 | return -ENOENT; |
dd5d666b | 602 | } |
3efa147a | 603 | swsusp_resume_device = name_to_dev_t(resume_file); |
23976728 | 604 | pr_debug("PM: Resume from partition %s\n", resume_file); |
3efa147a | 605 | } else { |
23976728 RW |
606 | pr_debug("PM: Resume from partition %d:%d\n", |
607 | MAJOR(swsusp_resume_device), | |
608 | MINOR(swsusp_resume_device)); | |
3efa147a PM |
609 | } |
610 | ||
1da177e4 LT |
611 | if (noresume) { |
612 | /** | |
9575809c RW |
613 | * FIXME: If noresume is specified, we need to find the |
614 | * partition and reset it back to normal swap space. | |
1da177e4 | 615 | */ |
a6d70980 | 616 | mutex_unlock(&pm_mutex); |
1da177e4 LT |
617 | return 0; |
618 | } | |
619 | ||
23976728 | 620 | pr_debug("PM: Checking hibernation image.\n"); |
ed746e3b RW |
621 | error = swsusp_check(); |
622 | if (error) | |
74dfd666 | 623 | goto Unlock; |
1da177e4 | 624 | |
0709db60 RW |
625 | /* The snapshot device should not be opened while we're running */ |
626 | if (!atomic_add_unless(&snapshot_device_available, -1, 0)) { | |
627 | error = -EBUSY; | |
628 | goto Unlock; | |
629 | } | |
630 | ||
5a0a2f30 | 631 | pm_prepare_console(); |
c3e94d89 AS |
632 | error = pm_notifier_call_chain(PM_RESTORE_PREPARE); |
633 | if (error) | |
634 | goto Finish; | |
635 | ||
1bfcf130 RW |
636 | error = usermodehelper_disable(); |
637 | if (error) | |
638 | goto Finish; | |
639 | ||
74dfd666 RW |
640 | error = create_basic_memory_bitmaps(); |
641 | if (error) | |
0709db60 | 642 | goto Finish; |
1da177e4 | 643 | |
74dfd666 | 644 | pr_debug("PM: Preparing processes for restore.\n"); |
ed746e3b RW |
645 | error = prepare_processes(); |
646 | if (error) { | |
c2dd0dae | 647 | swsusp_close(FMODE_READ); |
5a72e04d | 648 | goto Done; |
1da177e4 LT |
649 | } |
650 | ||
23976728 | 651 | pr_debug("PM: Reading hibernation image.\n"); |
1da177e4 | 652 | |
a634cc10 | 653 | error = swsusp_read(&flags); |
ed746e3b | 654 | if (!error) |
a634cc10 | 655 | hibernation_restore(flags & SF_PLATFORM_MODE); |
1da177e4 | 656 | |
ed746e3b | 657 | printk(KERN_ERR "PM: Restore failed, recovering.\n"); |
7777fab9 | 658 | swsusp_free(); |
5a0a2f30 | 659 | thaw_processes(); |
1da177e4 | 660 | Done: |
74dfd666 | 661 | free_basic_memory_bitmaps(); |
1bfcf130 | 662 | usermodehelper_enable(); |
0709db60 | 663 | Finish: |
c3e94d89 | 664 | pm_notifier_call_chain(PM_POST_RESTORE); |
5a0a2f30 | 665 | pm_restore_console(); |
0709db60 | 666 | atomic_inc(&snapshot_device_available); |
dd5d666b | 667 | /* For success case, the suspend path will release the lock */ |
74dfd666 | 668 | Unlock: |
a6d70980 | 669 | mutex_unlock(&pm_mutex); |
1da177e4 | 670 | pr_debug("PM: Resume from disk failed.\n"); |
7777fab9 | 671 | return error; |
1da177e4 LT |
672 | } |
673 | ||
674 | late_initcall(software_resume); | |
675 | ||
676 | ||
a3d25c27 RW |
677 | static const char * const hibernation_modes[] = { |
678 | [HIBERNATION_PLATFORM] = "platform", | |
679 | [HIBERNATION_SHUTDOWN] = "shutdown", | |
680 | [HIBERNATION_REBOOT] = "reboot", | |
681 | [HIBERNATION_TEST] = "test", | |
682 | [HIBERNATION_TESTPROC] = "testproc", | |
1da177e4 LT |
683 | }; |
684 | ||
685 | /** | |
a3d25c27 | 686 | * disk - Control hibernation mode |
1da177e4 | 687 | * |
11d77d0c JB |
688 | * Suspend-to-disk can be handled in several ways. We have a few options |
689 | * for putting the system to sleep - using the platform driver (e.g. ACPI | |
a3d25c27 RW |
690 | * or other hibernation_ops), powering off the system or rebooting the |
691 | * system (for testing) as well as the two test modes. | |
1da177e4 | 692 | * |
11d77d0c | 693 | * The system can support 'platform', and that is known a priori (and |
a3d25c27 RW |
694 | * encoded by the presence of hibernation_ops). However, the user may |
695 | * choose 'shutdown' or 'reboot' as alternatives, as well as one fo the | |
696 | * test modes, 'test' or 'testproc'. | |
1da177e4 LT |
697 | * |
698 | * show() will display what the mode is currently set to. | |
699 | * store() will accept one of | |
700 | * | |
1da177e4 LT |
701 | * 'platform' |
702 | * 'shutdown' | |
703 | * 'reboot' | |
11d77d0c JB |
704 | * 'test' |
705 | * 'testproc' | |
1da177e4 | 706 | * |
11d77d0c | 707 | * It will only change to 'platform' if the system |
a3d25c27 | 708 | * supports it (as determined by having hibernation_ops). |
1da177e4 LT |
709 | */ |
710 | ||
386f275f KS |
711 | static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr, |
712 | char *buf) | |
1da177e4 | 713 | { |
f0ced9b2 JB |
714 | int i; |
715 | char *start = buf; | |
716 | ||
a3d25c27 RW |
717 | for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) { |
718 | if (!hibernation_modes[i]) | |
f0ced9b2 JB |
719 | continue; |
720 | switch (i) { | |
a3d25c27 RW |
721 | case HIBERNATION_SHUTDOWN: |
722 | case HIBERNATION_REBOOT: | |
723 | case HIBERNATION_TEST: | |
724 | case HIBERNATION_TESTPROC: | |
f0ced9b2 | 725 | break; |
a3d25c27 RW |
726 | case HIBERNATION_PLATFORM: |
727 | if (hibernation_ops) | |
f0ced9b2 JB |
728 | break; |
729 | /* not a valid mode, continue with loop */ | |
730 | continue; | |
731 | } | |
a3d25c27 RW |
732 | if (i == hibernation_mode) |
733 | buf += sprintf(buf, "[%s] ", hibernation_modes[i]); | |
f0ced9b2 | 734 | else |
a3d25c27 | 735 | buf += sprintf(buf, "%s ", hibernation_modes[i]); |
f0ced9b2 JB |
736 | } |
737 | buf += sprintf(buf, "\n"); | |
738 | return buf-start; | |
1da177e4 LT |
739 | } |
740 | ||
741 | ||
386f275f KS |
742 | static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr, |
743 | const char *buf, size_t n) | |
1da177e4 LT |
744 | { |
745 | int error = 0; | |
746 | int i; | |
747 | int len; | |
748 | char *p; | |
a3d25c27 | 749 | int mode = HIBERNATION_INVALID; |
1da177e4 LT |
750 | |
751 | p = memchr(buf, '\n', n); | |
752 | len = p ? p - buf : n; | |
753 | ||
a6d70980 | 754 | mutex_lock(&pm_mutex); |
a3d25c27 | 755 | for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) { |
8d98a690 RW |
756 | if (len == strlen(hibernation_modes[i]) |
757 | && !strncmp(buf, hibernation_modes[i], len)) { | |
1da177e4 LT |
758 | mode = i; |
759 | break; | |
760 | } | |
761 | } | |
a3d25c27 | 762 | if (mode != HIBERNATION_INVALID) { |
fe0c935a | 763 | switch (mode) { |
a3d25c27 RW |
764 | case HIBERNATION_SHUTDOWN: |
765 | case HIBERNATION_REBOOT: | |
766 | case HIBERNATION_TEST: | |
767 | case HIBERNATION_TESTPROC: | |
768 | hibernation_mode = mode; | |
fe0c935a | 769 | break; |
a3d25c27 RW |
770 | case HIBERNATION_PLATFORM: |
771 | if (hibernation_ops) | |
772 | hibernation_mode = mode; | |
1da177e4 LT |
773 | else |
774 | error = -EINVAL; | |
775 | } | |
a3d25c27 | 776 | } else |
1da177e4 LT |
777 | error = -EINVAL; |
778 | ||
a3d25c27 | 779 | if (!error) |
23976728 | 780 | pr_debug("PM: Hibernation mode set to '%s'\n", |
a3d25c27 | 781 | hibernation_modes[mode]); |
a6d70980 | 782 | mutex_unlock(&pm_mutex); |
1da177e4 LT |
783 | return error ? error : n; |
784 | } | |
785 | ||
786 | power_attr(disk); | |
787 | ||
386f275f KS |
788 | static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr, |
789 | char *buf) | |
1da177e4 LT |
790 | { |
791 | return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device), | |
792 | MINOR(swsusp_resume_device)); | |
793 | } | |
794 | ||
386f275f KS |
795 | static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr, |
796 | const char *buf, size_t n) | |
1da177e4 | 797 | { |
1da177e4 | 798 | unsigned int maj, min; |
1da177e4 | 799 | dev_t res; |
a576219a | 800 | int ret = -EINVAL; |
1da177e4 | 801 | |
a576219a AM |
802 | if (sscanf(buf, "%u:%u", &maj, &min) != 2) |
803 | goto out; | |
1da177e4 | 804 | |
a576219a AM |
805 | res = MKDEV(maj,min); |
806 | if (maj != MAJOR(res) || min != MINOR(res)) | |
807 | goto out; | |
1da177e4 | 808 | |
a6d70980 | 809 | mutex_lock(&pm_mutex); |
a576219a | 810 | swsusp_resume_device = res; |
a6d70980 | 811 | mutex_unlock(&pm_mutex); |
23976728 | 812 | printk(KERN_INFO "PM: Starting manual resume from disk\n"); |
a576219a AM |
813 | noresume = 0; |
814 | software_resume(); | |
815 | ret = n; | |
59a49335 | 816 | out: |
a576219a | 817 | return ret; |
1da177e4 LT |
818 | } |
819 | ||
820 | power_attr(resume); | |
821 | ||
386f275f KS |
822 | static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr, |
823 | char *buf) | |
ca0aec0f | 824 | { |
853609b6 | 825 | return sprintf(buf, "%lu\n", image_size); |
ca0aec0f RW |
826 | } |
827 | ||
386f275f KS |
828 | static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr, |
829 | const char *buf, size_t n) | |
ca0aec0f | 830 | { |
853609b6 | 831 | unsigned long size; |
ca0aec0f | 832 | |
853609b6 | 833 | if (sscanf(buf, "%lu", &size) == 1) { |
ca0aec0f RW |
834 | image_size = size; |
835 | return n; | |
836 | } | |
837 | ||
838 | return -EINVAL; | |
839 | } | |
840 | ||
841 | power_attr(image_size); | |
842 | ||
1da177e4 LT |
843 | static struct attribute * g[] = { |
844 | &disk_attr.attr, | |
845 | &resume_attr.attr, | |
ca0aec0f | 846 | &image_size_attr.attr, |
1da177e4 LT |
847 | NULL, |
848 | }; | |
849 | ||
850 | ||
851 | static struct attribute_group attr_group = { | |
852 | .attrs = g, | |
853 | }; | |
854 | ||
855 | ||
856 | static int __init pm_disk_init(void) | |
857 | { | |
d76e15fb | 858 | return sysfs_create_group(power_kobj, &attr_group); |
1da177e4 LT |
859 | } |
860 | ||
861 | core_initcall(pm_disk_init); | |
862 | ||
863 | ||
864 | static int __init resume_setup(char *str) | |
865 | { | |
866 | if (noresume) | |
867 | return 1; | |
868 | ||
869 | strncpy( resume_file, str, 255 ); | |
870 | return 1; | |
871 | } | |
872 | ||
9a154d9d RW |
873 | static int __init resume_offset_setup(char *str) |
874 | { | |
875 | unsigned long long offset; | |
876 | ||
877 | if (noresume) | |
878 | return 1; | |
879 | ||
880 | if (sscanf(str, "%llu", &offset) == 1) | |
881 | swsusp_resume_block = offset; | |
882 | ||
883 | return 1; | |
884 | } | |
885 | ||
1da177e4 LT |
886 | static int __init noresume_setup(char *str) |
887 | { | |
888 | noresume = 1; | |
889 | return 1; | |
890 | } | |
891 | ||
892 | __setup("noresume", noresume_setup); | |
9a154d9d | 893 | __setup("resume_offset=", resume_offset_setup); |
1da177e4 | 894 | __setup("resume=", resume_setup); |