defconfig: exynos9610: Re-add dropped Wi-Fi AP options lost
[GitHub/LineageOS/android_kernel_motorola_exynos9610.git] / kernel / power / hibernate.c
CommitLineData
1da177e4 1/*
8b759b84 2 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
1da177e4
LT
3 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
a2531293 6 * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
8b759b84 7 * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
62c552cc 8 * Copyright (C) 2012 Bojan Smojver <bojan@rexursive.com>
1da177e4
LT
9 *
10 * This file is released under the GPLv2.
1da177e4
LT
11 */
12
2872de13
RW
13#define pr_fmt(fmt) "PM: " fmt
14
6e5fdeed 15#include <linux/export.h>
1da177e4
LT
16#include <linux/suspend.h>
17#include <linux/syscalls.h>
18#include <linux/reboot.h>
19#include <linux/string.h>
20#include <linux/device.h>
6f8d7022 21#include <linux/async.h>
1da177e4
LT
22#include <linux/delay.h>
23#include <linux/fs.h>
d53d9f16 24#include <linux/mount.h>
88d10bba 25#include <linux/pm.h>
38b8d208 26#include <linux/nmi.h>
97c7801c 27#include <linux/console.h>
e3920fb4 28#include <linux/cpu.h>
7dfb7103 29#include <linux/freezer.h>
5a0e3ad6 30#include <linux/gfp.h>
40dc166c 31#include <linux/syscore_ops.h>
2df83fa4
MB
32#include <linux/ctype.h>
33#include <linux/genhd.h>
db597605 34#include <linux/ktime.h>
bb3632c6 35#include <trace/events/power.h>
d53d9f16 36
1da177e4
LT
37#include "power.h"
38
39
d231ff1a
BS
40static int nocompress;
41static int noresume;
a6e15a39 42static int nohibernate;
d231ff1a 43static int resume_wait;
f6514be5 44static unsigned int resume_delay;
47a460d5 45static char resume_file[256] = CONFIG_PM_STD_PARTITION;
1da177e4 46dev_t swsusp_resume_device;
9a154d9d 47sector_t swsusp_resume_block;
d6efc2f7 48__visible int in_suspend __nosavedata;
1da177e4 49
a3d25c27
RW
50enum {
51 HIBERNATION_INVALID,
52 HIBERNATION_PLATFORM,
a3d25c27
RW
53 HIBERNATION_SHUTDOWN,
54 HIBERNATION_REBOOT,
62c552cc
BS
55#ifdef CONFIG_SUSPEND
56 HIBERNATION_SUSPEND,
57#endif
fe12c00d 58 HIBERNATION_TEST_RESUME,
a3d25c27
RW
59 /* keep last */
60 __HIBERNATION_AFTER_LAST
61};
62#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
63#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
64
65static int hibernation_mode = HIBERNATION_SHUTDOWN;
66
97819a26 67bool freezer_test_done;
aa9a7b11 68
073ef1f6 69static const struct platform_hibernation_ops *hibernation_ops;
a3d25c27 70
a6e15a39
KC
71bool hibernation_available(void)
72{
73 return (nohibernate == 0);
74}
75
a3d25c27 76/**
f42a9813
RW
77 * hibernation_set_ops - Set the global hibernate operations.
78 * @ops: Hibernation operations to use in subsequent hibernation transitions.
a3d25c27 79 */
073ef1f6 80void hibernation_set_ops(const struct platform_hibernation_ops *ops)
a3d25c27 81{
caea99ef
RW
82 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
83 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
5729c63a 84 && ops->restore_cleanup && ops->leave)) {
a3d25c27
RW
85 WARN_ON(1);
86 return;
87 }
bcda53fa 88 lock_system_sleep();
a3d25c27
RW
89 hibernation_ops = ops;
90 if (ops)
91 hibernation_mode = HIBERNATION_PLATFORM;
92 else if (hibernation_mode == HIBERNATION_PLATFORM)
93 hibernation_mode = HIBERNATION_SHUTDOWN;
94
bcda53fa 95 unlock_system_sleep();
a3d25c27 96}
e0c7855e 97EXPORT_SYMBOL_GPL(hibernation_set_ops);
a3d25c27 98
abfe2d7b
RW
99static bool entering_platform_hibernation;
100
101bool system_entering_hibernation(void)
102{
103 return entering_platform_hibernation;
104}
105EXPORT_SYMBOL(system_entering_hibernation);
106
4cc79776
RW
107#ifdef CONFIG_PM_DEBUG
108static void hibernation_debug_sleep(void)
109{
2872de13 110 pr_info("hibernation debug: Waiting for 5 seconds.\n");
4cc79776
RW
111 mdelay(5000);
112}
113
4cc79776
RW
114static int hibernation_test(int level)
115{
116 if (pm_test_level == level) {
117 hibernation_debug_sleep();
118 return 1;
119 }
120 return 0;
121}
122#else /* !CONFIG_PM_DEBUG */
4cc79776
RW
123static int hibernation_test(int level) { return 0; }
124#endif /* !CONFIG_PM_DEBUG */
125
74f270af 126/**
f42a9813
RW
127 * platform_begin - Call platform to start hibernation.
128 * @platform_mode: Whether or not to use the platform driver.
74f270af 129 */
caea99ef 130static int platform_begin(int platform_mode)
74f270af
RW
131{
132 return (platform_mode && hibernation_ops) ?
caea99ef
RW
133 hibernation_ops->begin() : 0;
134}
135
136/**
f42a9813
RW
137 * platform_end - Call platform to finish transition to the working state.
138 * @platform_mode: Whether or not to use the platform driver.
caea99ef 139 */
caea99ef
RW
140static void platform_end(int platform_mode)
141{
142 if (platform_mode && hibernation_ops)
143 hibernation_ops->end();
74f270af 144}
a3d25c27 145
8a05aac2 146/**
f42a9813
RW
147 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
148 * @platform_mode: Whether or not to use the platform driver.
149 *
150 * Use the platform driver to prepare the system for creating a hibernate image,
151 * if so configured, and return an error code if that fails.
8a05aac2
SS
152 */
153
74f270af 154static int platform_pre_snapshot(int platform_mode)
8a05aac2 155{
7777fab9 156 return (platform_mode && hibernation_ops) ?
74f270af 157 hibernation_ops->pre_snapshot() : 0;
a3d25c27 158}
8a05aac2 159
c7e0831d 160/**
f42a9813
RW
161 * platform_leave - Call platform to prepare a transition to the working state.
162 * @platform_mode: Whether or not to use the platform driver.
163 *
164 * Use the platform driver prepare to prepare the machine for switching to the
165 * normal mode of operation.
166 *
167 * This routine is called on one CPU with interrupts disabled.
c7e0831d 168 */
c7e0831d
RW
169static void platform_leave(int platform_mode)
170{
171 if (platform_mode && hibernation_ops)
172 hibernation_ops->leave();
173}
174
a3d25c27 175/**
f42a9813
RW
176 * platform_finish - Call platform to switch the system to the working state.
177 * @platform_mode: Whether or not to use the platform driver.
178 *
179 * Use the platform driver to switch the machine to the normal mode of
180 * operation.
181 *
182 * This routine must be called after platform_prepare().
a3d25c27 183 */
7777fab9 184static void platform_finish(int platform_mode)
a3d25c27 185{
7777fab9 186 if (platform_mode && hibernation_ops)
a3d25c27 187 hibernation_ops->finish();
8a05aac2
SS
188}
189
a634cc10 190/**
f42a9813
RW
191 * platform_pre_restore - Prepare for hibernate image restoration.
192 * @platform_mode: Whether or not to use the platform driver.
193 *
194 * Use the platform driver to prepare the system for resume from a hibernation
195 * image.
196 *
197 * If the restore fails after this function has been called,
198 * platform_restore_cleanup() must be called.
a634cc10 199 */
a634cc10
RW
200static int platform_pre_restore(int platform_mode)
201{
202 return (platform_mode && hibernation_ops) ?
203 hibernation_ops->pre_restore() : 0;
204}
205
206/**
f42a9813
RW
207 * platform_restore_cleanup - Switch to the working state after failing restore.
208 * @platform_mode: Whether or not to use the platform driver.
209 *
210 * Use the platform driver to switch the system to the normal mode of operation
211 * after a failing restore.
212 *
213 * If platform_pre_restore() has been called before the failing restore, this
214 * function must be called too, regardless of the result of
215 * platform_pre_restore().
a634cc10 216 */
a634cc10
RW
217static void platform_restore_cleanup(int platform_mode)
218{
219 if (platform_mode && hibernation_ops)
220 hibernation_ops->restore_cleanup();
221}
222
d8f3de0d 223/**
f42a9813
RW
224 * platform_recover - Recover from a failure to suspend devices.
225 * @platform_mode: Whether or not to use the platform driver.
d8f3de0d 226 */
d8f3de0d
RW
227static void platform_recover(int platform_mode)
228{
229 if (platform_mode && hibernation_ops && hibernation_ops->recover)
230 hibernation_ops->recover();
231}
232
8e60c6a1 233/**
f42a9813
RW
234 * swsusp_show_speed - Print time elapsed between two events during hibernation.
235 * @start: Starting event.
236 * @stop: Final event.
237 * @nr_pages: Number of memory pages processed between @start and @stop.
238 * @msg: Additional diagnostic message to print.
8e60c6a1 239 */
db597605
TR
240void swsusp_show_speed(ktime_t start, ktime_t stop,
241 unsigned nr_pages, char *msg)
8e60c6a1 242{
db597605 243 ktime_t diff;
4881f603
CG
244 u64 elapsed_centisecs64;
245 unsigned int centisecs;
246 unsigned int k;
247 unsigned int kps;
8e60c6a1 248
db597605
TR
249 diff = ktime_sub(stop, start);
250 elapsed_centisecs64 = ktime_divns(diff, 10*NSEC_PER_MSEC);
8e60c6a1
NC
251 centisecs = elapsed_centisecs64;
252 if (centisecs == 0)
253 centisecs = 1; /* avoid div-by-zero */
254 k = nr_pages * (PAGE_SIZE / 1024);
255 kps = (k * 100) / centisecs;
2872de13
RW
256 pr_info("%s %u kbytes in %u.%02u seconds (%u.%02u MB/s)\n",
257 msg, k, centisecs / 100, centisecs % 100, kps / 1000,
258 (kps % 1000) / 10);
8e60c6a1
NC
259}
260
c7e0831d 261/**
f42a9813
RW
262 * create_image - Create a hibernation image.
263 * @platform_mode: Whether or not to use the platform driver.
264 *
cf579dfb
RW
265 * Execute device drivers' "late" and "noirq" freeze callbacks, create a
266 * hibernation image and run the drivers' "noirq" and "early" thaw callbacks.
f42a9813
RW
267 *
268 * Control reappears in this routine after the subsequent restore.
c7e0831d 269 */
47a460d5 270static int create_image(int platform_mode)
c7e0831d
RW
271{
272 int error;
273
cf579dfb 274 error = dpm_suspend_end(PMSG_FREEZE);
c7e0831d 275 if (error) {
2872de13 276 pr_err("Some devices failed to power down, aborting hibernation\n");
32bdfac5 277 return error;
c7e0831d 278 }
2ed8d2b3 279
4aecd671
RW
280 error = platform_pre_snapshot(platform_mode);
281 if (error || hibernation_test(TEST_PLATFORM))
282 goto Platform_finish;
283
284 error = disable_nonboot_cpus();
48580ab8 285 if (error || hibernation_test(TEST_CPUS))
4aecd671
RW
286 goto Enable_cpus;
287
2ed8d2b3
RW
288 local_irq_disable();
289
2e711c04 290 error = syscore_suspend();
770824bd 291 if (error) {
2872de13 292 pr_err("Some system devices failed to power down, aborting hibernation\n");
4aecd671 293 goto Enable_irqs;
770824bd 294 }
c7e0831d 295
a2867e08 296 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
4cc79776
RW
297 goto Power_up;
298
299 in_suspend = 1;
c7e0831d 300 save_processor_state();
bb3632c6 301 trace_suspend_resume(TPS("machine_suspend"), PM_EVENT_HIBERNATE, true);
05db6ce8
HK
302 dbg_snapshot_suspend("machine_suspend", swsusp_arch_suspend,
303 NULL, PM_EVENT_HIBERNATE, DSS_FLAG_IN);
c7e0831d 304 error = swsusp_arch_suspend();
62822e2e
TG
305 /* Restore control flow magically appears here */
306 restore_processor_state();
05db6ce8
HK
307 dbg_snapshot_suspend("machine_suspend", swsusp_arch_suspend,
308 NULL, PM_EVENT_HIBERNATE, DSS_FLAG_OUT);
bb3632c6 309 trace_suspend_resume(TPS("machine_suspend"), PM_EVENT_HIBERNATE, false);
c7e0831d 310 if (error)
2872de13
RW
311 pr_err("Error %d creating hibernation image\n", error);
312
1ad1410f 313 if (!in_suspend) {
c125e96f 314 events_check_enabled = false;
1ad1410f
AA
315 clear_free_pages();
316 }
362e77d1
BM
317
318 platform_leave(platform_mode);
4aecd671 319
4cc79776 320 Power_up:
40dc166c 321 syscore_resume();
2ed8d2b3 322
4aecd671 323 Enable_irqs:
2ed8d2b3
RW
324 local_irq_enable();
325
4aecd671
RW
326 Enable_cpus:
327 enable_nonboot_cpus();
328
329 Platform_finish:
330 platform_finish(platform_mode);
331
cf579dfb 332 dpm_resume_start(in_suspend ?
1eede070 333 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
2ed8d2b3 334
c7e0831d
RW
335 return error;
336}
337
7777fab9 338/**
f42a9813
RW
339 * hibernation_snapshot - Quiesce devices and create a hibernation image.
340 * @platform_mode: If set, use platform driver to prepare for the transition.
7777fab9 341 *
f42a9813 342 * This routine must be called with pm_mutex held.
7777fab9 343 */
7777fab9
RW
344int hibernation_snapshot(int platform_mode)
345{
953a2063 346 pm_message_t msg;
cbe2f5a6 347 int error;
7777fab9 348
27614273 349 pm_suspend_clear_flags();
3fe0313e 350 error = platform_begin(platform_mode);
7777fab9 351 if (error)
d074ee02 352 goto Close;
7777fab9 353
64a473cb
RW
354 /* Preallocate image memory before shutting down devices. */
355 error = hibernate_preallocate_memory();
2aede851
RW
356 if (error)
357 goto Close;
358
359 error = freeze_kernel_threads();
360 if (error)
bb58dd5d 361 goto Cleanup;
2aede851 362
48580ab8 363 if (hibernation_test(TEST_FREEZER)) {
aa9a7b11
SB
364
365 /*
366 * Indicate to the caller that we are returning due to a
367 * successful freezer test.
368 */
369 freezer_test_done = true;
51d6ff7a 370 goto Thaw;
aa9a7b11
SB
371 }
372
2aede851 373 error = dpm_prepare(PMSG_FREEZE);
bb58dd5d 374 if (error) {
953a2063 375 dpm_complete(PMSG_RECOVER);
51d6ff7a 376 goto Thaw;
bb58dd5d 377 }
74f270af 378
7777fab9 379 suspend_console();
c9e664f1 380 pm_restrict_gfp_mask();
953a2063 381
91e7c75b 382 error = dpm_suspend(PMSG_FREEZE);
10a1803d 383
953a2063
SB
384 if (error || hibernation_test(TEST_DEVICES))
385 platform_recover(platform_mode);
386 else
387 error = create_image(platform_mode);
7777fab9 388
c9e664f1 389 /*
953a2063
SB
390 * In the case that we call create_image() above, the control
391 * returns here (1) after the image has been created or the
c9e664f1
RW
392 * image creation has failed and (2) after a successful restore.
393 */
4cc79776 394
64a473cb
RW
395 /* We may need to release the preallocated image pages here. */
396 if (error || !in_suspend)
397 swsusp_free();
398
91e7c75b
RW
399 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
400 dpm_resume(msg);
c9e664f1
RW
401
402 if (error || !in_suspend)
403 pm_restore_gfp_mask();
404
7777fab9 405 resume_console();
91e7c75b
RW
406 dpm_complete(msg);
407
caea99ef
RW
408 Close:
409 platform_end(platform_mode);
7777fab9 410 return error;
d8f3de0d 411
51d6ff7a
SB
412 Thaw:
413 thaw_kernel_threads();
bb58dd5d
RW
414 Cleanup:
415 swsusp_free();
416 goto Close;
7777fab9
RW
417}
418
406f992e
RW
419int __weak hibernate_resume_nonboot_cpu_disable(void)
420{
421 return disable_nonboot_cpus();
422}
423
72df68ca 424/**
f42a9813
RW
425 * resume_target_kernel - Restore system state from a hibernation image.
426 * @platform_mode: Whether or not to use the platform driver.
427 *
cf579dfb
RW
428 * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
429 * contents of highmem that have not been restored yet from the image and run
430 * the low-level code that will restore the remaining contents of memory and
431 * switch to the just restored target kernel.
72df68ca 432 */
4aecd671 433static int resume_target_kernel(bool platform_mode)
72df68ca
RW
434{
435 int error;
436
cf579dfb 437 error = dpm_suspend_end(PMSG_QUIESCE);
72df68ca 438 if (error) {
2872de13 439 pr_err("Some devices failed to power down, aborting resume\n");
32bdfac5 440 return error;
72df68ca 441 }
2ed8d2b3 442
4aecd671
RW
443 error = platform_pre_restore(platform_mode);
444 if (error)
445 goto Cleanup;
446
406f992e 447 error = hibernate_resume_nonboot_cpu_disable();
4aecd671
RW
448 if (error)
449 goto Enable_cpus;
450
2ed8d2b3
RW
451 local_irq_disable();
452
2e711c04 453 error = syscore_suspend();
4aecd671
RW
454 if (error)
455 goto Enable_irqs;
456
72df68ca
RW
457 save_processor_state();
458 error = restore_highmem();
459 if (!error) {
460 error = swsusp_arch_resume();
461 /*
462 * The code below is only ever reached in case of a failure.
4e2d9491
RW
463 * Otherwise, execution continues at the place where
464 * swsusp_arch_suspend() was called.
72df68ca
RW
465 */
466 BUG_ON(!error);
4e2d9491
RW
467 /*
468 * This call to restore_highmem() reverts the changes made by
469 * the previous one.
470 */
72df68ca
RW
471 restore_highmem();
472 }
473 /*
474 * The only reason why swsusp_arch_resume() can fail is memory being
475 * very tight, so we have to free it as soon as we can to avoid
4e2d9491 476 * subsequent failures.
72df68ca
RW
477 */
478 swsusp_free();
479 restore_processor_state();
480 touch_softlockup_watchdog();
2ed8d2b3 481
40dc166c 482 syscore_resume();
2ed8d2b3 483
4aecd671 484 Enable_irqs:
72df68ca 485 local_irq_enable();
2ed8d2b3 486
4aecd671
RW
487 Enable_cpus:
488 enable_nonboot_cpus();
489
490 Cleanup:
491 platform_restore_cleanup(platform_mode);
492
cf579dfb 493 dpm_resume_start(PMSG_RECOVER);
2ed8d2b3 494
72df68ca
RW
495 return error;
496}
497
7777fab9 498/**
f42a9813
RW
499 * hibernation_restore - Quiesce devices and restore from a hibernation image.
500 * @platform_mode: If set, use platform driver to prepare for the transition.
7777fab9 501 *
f42a9813 502 * This routine must be called with pm_mutex held. If it is successful, control
21e82808 503 * reappears in the restored target kernel in hibernation_snapshot().
7777fab9 504 */
a634cc10 505int hibernation_restore(int platform_mode)
7777fab9 506{
cbe2f5a6 507 int error;
7777fab9
RW
508
509 pm_prepare_console();
510 suspend_console();
c9e664f1 511 pm_restrict_gfp_mask();
d1616302 512 error = dpm_suspend_start(PMSG_QUIESCE);
a634cc10 513 if (!error) {
4aecd671 514 error = resume_target_kernel(platform_mode);
94fb823f
ID
515 /*
516 * The above should either succeed and jump to the new kernel,
517 * or return with an error. Otherwise things are just
518 * undefined, so let's be paranoid.
519 */
520 BUG_ON(!error);
a634cc10 521 }
94fb823f 522 dpm_resume_end(PMSG_RECOVER);
c9e664f1 523 pm_restore_gfp_mask();
7777fab9
RW
524 resume_console();
525 pm_restore_console();
526 return error;
527}
528
529/**
f42a9813 530 * hibernation_platform_enter - Power off the system using the platform driver.
7777fab9 531 */
7777fab9
RW
532int hibernation_platform_enter(void)
533{
cbe2f5a6 534 int error;
b1457bcc 535
9cd9a005
RW
536 if (!hibernation_ops)
537 return -ENOSYS;
538
539 /*
540 * We have cancelled the power transition by running
541 * hibernation_ops->finish() before saving the image, so we should let
542 * the firmware know that we're going to enter the sleep state after all
543 */
caea99ef 544 error = hibernation_ops->begin();
9cd9a005 545 if (error)
caea99ef 546 goto Close;
9cd9a005 547
abfe2d7b 548 entering_platform_hibernation = true;
9cd9a005 549 suspend_console();
d1616302 550 error = dpm_suspend_start(PMSG_HIBERNATE);
d8f3de0d
RW
551 if (error) {
552 if (hibernation_ops->recover)
553 hibernation_ops->recover();
554 goto Resume_devices;
555 }
9cd9a005 556
cf579dfb 557 error = dpm_suspend_end(PMSG_HIBERNATE);
4aecd671 558 if (error)
32bdfac5 559 goto Resume_devices;
4aecd671 560
9cd9a005
RW
561 error = hibernation_ops->prepare();
562 if (error)
e681c9dd 563 goto Platform_finish;
9cd9a005
RW
564
565 error = disable_nonboot_cpus();
566 if (error)
8c506608 567 goto Enable_cpus;
2ed8d2b3 568
4aecd671 569 local_irq_disable();
40dc166c 570 syscore_suspend();
a2867e08 571 if (pm_wakeup_pending()) {
c125e96f
RW
572 error = -EAGAIN;
573 goto Power_up;
574 }
575
4aecd671
RW
576 hibernation_ops->enter();
577 /* We should never get here */
578 while (1);
9cd9a005 579
c125e96f 580 Power_up:
40dc166c 581 syscore_resume();
c125e96f 582 local_irq_enable();
8c506608
VK
583
584 Enable_cpus:
c125e96f
RW
585 enable_nonboot_cpus();
586
e681c9dd 587 Platform_finish:
9cd9a005 588 hibernation_ops->finish();
2ed8d2b3 589
cf579dfb 590 dpm_resume_start(PMSG_RESTORE);
4aecd671 591
9cd9a005 592 Resume_devices:
abfe2d7b 593 entering_platform_hibernation = false;
d1616302 594 dpm_resume_end(PMSG_RESTORE);
9cd9a005 595 resume_console();
2ed8d2b3 596
caea99ef
RW
597 Close:
598 hibernation_ops->end();
2ed8d2b3 599
b1457bcc 600 return error;
7777fab9
RW
601}
602
1da177e4 603/**
f42a9813 604 * power_down - Shut the machine down for hibernation.
1da177e4 605 *
f42a9813
RW
606 * Use the platform driver, if configured, to put the system into the sleep
607 * state corresponding to hibernation, or try to power it off or reboot,
608 * depending on the value of hibernation_mode.
1da177e4 609 */
fe0c935a 610static void power_down(void)
1da177e4 611{
62c552cc
BS
612#ifdef CONFIG_SUSPEND
613 int error;
81d45bdf
RW
614
615 if (hibernation_mode == HIBERNATION_SUSPEND) {
616 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
617 if (error) {
618 hibernation_mode = hibernation_ops ?
619 HIBERNATION_PLATFORM :
620 HIBERNATION_SHUTDOWN;
621 } else {
622 /* Restore swap signature. */
623 error = swsusp_unmark();
624 if (error)
2872de13 625 pr_err("Swap will be unusable! Try swapon -a.\n");
81d45bdf
RW
626
627 return;
628 }
629 }
62c552cc
BS
630#endif
631
a3d25c27 632 switch (hibernation_mode) {
a3d25c27 633 case HIBERNATION_REBOOT:
fdde86ac 634 kernel_restart(NULL);
1da177e4 635 break;
a3d25c27 636 case HIBERNATION_PLATFORM:
7777fab9 637 hibernation_platform_enter();
9cd9a005 638 case HIBERNATION_SHUTDOWN:
2c730785
SC
639 if (pm_power_off)
640 kernel_power_off();
9cd9a005 641 break;
1da177e4 642 }
fdde86ac 643 kernel_halt();
fe0c935a
JB
644 /*
645 * Valid image is on the disk, if we continue we risk serious data
646 * corruption after resume.
647 */
2872de13 648 pr_crit("Power down manually\n");
2c730785
SC
649 while (1)
650 cpu_relax();
1da177e4
LT
651}
652
fe12c00d
CY
653static int load_image_and_restore(void)
654{
655 int error;
656 unsigned int flags;
657
8d8b2441 658 pm_pr_dbg("Loading hibernation image.\n");
fe12c00d
CY
659
660 lock_device_hotplug();
661 error = create_basic_memory_bitmaps();
662 if (error)
663 goto Unlock;
664
665 error = swsusp_read(&flags);
666 swsusp_close(FMODE_READ);
667 if (!error)
668 hibernation_restore(flags & SF_PLATFORM_MODE);
669
2872de13 670 pr_err("Failed to load hibernation image, recovering.\n");
fe12c00d
CY
671 swsusp_free();
672 free_basic_memory_bitmaps();
673 Unlock:
674 unlock_device_hotplug();
675
676 return error;
677}
678
1da177e4 679/**
f42a9813 680 * hibernate - Carry out system hibernation, including saving the image.
1da177e4 681 */
a3d25c27 682int hibernate(void)
1da177e4 683{
ea00f4f4 684 int error, nr_calls = 0;
fe12c00d 685 bool snapshot_test = false;
1da177e4 686
a6e15a39 687 if (!hibernation_available()) {
8d8b2441 688 pm_pr_dbg("Hibernation not available.\n");
a6e15a39
KC
689 return -EPERM;
690 }
691
bcda53fa 692 lock_system_sleep();
0709db60 693 /* The snapshot device should not be opened while we're running */
b10d9117
RW
694 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
695 error = -EBUSY;
696 goto Unlock;
697 }
698
8915aa20 699 pr_info("hibernation entry\n");
5a0a2f30 700 pm_prepare_console();
ea00f4f4
LW
701 error = __pm_notifier_call_chain(PM_HIBERNATION_PREPARE, -1, &nr_calls);
702 if (error) {
703 nr_calls--;
b10d9117 704 goto Exit;
ea00f4f4 705 }
0709db60 706
2872de13 707 pr_info("Syncing filesystems ... \n");
232b1432 708 sys_sync();
2872de13 709 pr_info("done.\n");
232b1432 710
03afed8b 711 error = freeze_processes();
5a72e04d 712 if (error)
8fd37a4c
RW
713 goto Exit;
714
942f4015 715 lock_device_hotplug();
8fd37a4c
RW
716 /* Allocate memory management structures */
717 error = create_basic_memory_bitmaps();
718 if (error)
719 goto Thaw;
1da177e4 720
7777fab9 721 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
a556d5b5 722 if (error || freezer_test_done)
8fd37a4c 723 goto Free_bitmaps;
64a473cb
RW
724
725 if (in_suspend) {
a634cc10
RW
726 unsigned int flags = 0;
727
728 if (hibernation_mode == HIBERNATION_PLATFORM)
729 flags |= SF_PLATFORM_MODE;
f996fc96
BS
730 if (nocompress)
731 flags |= SF_NOCOMPRESS_MODE;
081a9d04
BS
732 else
733 flags |= SF_CRC32_MODE;
734
8d8b2441 735 pm_pr_dbg("Writing image.\n");
a634cc10 736 error = swsusp_write(flags);
7777fab9 737 swsusp_free();
fe12c00d
CY
738 if (!error) {
739 if (hibernation_mode == HIBERNATION_TEST_RESUME)
740 snapshot_test = true;
741 else
742 power_down();
743 }
5262a475 744 in_suspend = 0;
c9e664f1 745 pm_restore_gfp_mask();
b918f6e6 746 } else {
8d8b2441 747 pm_pr_dbg("Image restored successfully.\n");
b918f6e6 748 }
64a473cb 749
8fd37a4c
RW
750 Free_bitmaps:
751 free_basic_memory_bitmaps();
b918f6e6 752 Thaw:
942f4015 753 unlock_device_hotplug();
fe12c00d 754 if (snapshot_test) {
8d8b2441 755 pm_pr_dbg("Checking hibernation image\n");
fe12c00d
CY
756 error = swsusp_check();
757 if (!error)
758 error = load_image_and_restore();
759 }
5a0a2f30 760 thaw_processes();
a556d5b5
SB
761
762 /* Don't bother checking whether freezer_test_done is true */
763 freezer_test_done = false;
0709db60 764 Exit:
ea00f4f4 765 __pm_notifier_call_chain(PM_POST_HIBERNATION, nr_calls, NULL);
5a0a2f30 766 pm_restore_console();
0709db60 767 atomic_inc(&snapshot_device_available);
b10d9117 768 Unlock:
bcda53fa 769 unlock_system_sleep();
8915aa20
RW
770 pr_info("hibernation exit\n");
771
1da177e4
LT
772 return error;
773}
774
775
776/**
f42a9813
RW
777 * software_resume - Resume from a saved hibernation image.
778 *
779 * This routine is called as a late initcall, when all devices have been
780 * discovered and initialized already.
1da177e4 781 *
f42a9813
RW
782 * The image reading code is called to see if there is a hibernation image
783 * available for reading. If that is the case, devices are quiesced and the
784 * contents of memory is restored from the saved image.
1da177e4 785 *
f42a9813 786 * If this is successful, control reappears in the restored target kernel in
d439e64f 787 * hibernation_snapshot() which returns to hibernate(). Otherwise, the routine
f42a9813
RW
788 * attempts to recover gracefully and make the kernel return to the normal mode
789 * of operation.
1da177e4 790 */
1da177e4
LT
791static int software_resume(void)
792{
ea00f4f4 793 int error, nr_calls = 0;
1da177e4 794
eed3ee08
AV
795 /*
796 * If the user said "noresume".. bail out early.
797 */
a6e15a39 798 if (noresume || !hibernation_available())
eed3ee08
AV
799 return 0;
800
60a0d233
JB
801 /*
802 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
803 * is configured into the kernel. Since the regular hibernate
804 * trigger path is via sysfs which takes a buffer mutex before
805 * calling hibernate functions (which take pm_mutex) this can
806 * cause lockdep to complain about a possible ABBA deadlock
807 * which cannot happen since we're in the boot code here and
808 * sysfs can't be invoked yet. Therefore, we use a subclass
809 * here to avoid lockdep complaining.
810 */
811 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
0c8454f5
RW
812
813 if (swsusp_resume_device)
814 goto Check_image;
815
816 if (!strlen(resume_file)) {
817 error = -ENOENT;
818 goto Unlock;
819 }
820
8d8b2441 821 pm_pr_dbg("Checking hibernation image partition %s\n", resume_file);
0c8454f5 822
f126f733 823 if (resume_delay) {
2872de13 824 pr_info("Waiting %dsec before reading resume device ...\n",
f126f733
BS
825 resume_delay);
826 ssleep(resume_delay);
827 }
828
0c8454f5
RW
829 /* Check if the device is there */
830 swsusp_resume_device = name_to_dev_t(resume_file);
2df83fa4
MB
831
832 /*
833 * name_to_dev_t is ineffective to verify parition if resume_file is in
834 * integer format. (e.g. major:minor)
835 */
836 if (isdigit(resume_file[0]) && resume_wait) {
837 int partno;
838 while (!get_gendisk(swsusp_resume_device, &partno))
839 msleep(10);
840 }
841
3efa147a 842 if (!swsusp_resume_device) {
eed3ee08
AV
843 /*
844 * Some device discovery might still be in progress; we need
845 * to wait for this to finish.
846 */
847 wait_for_device_probe();
6f8d7022
BS
848
849 if (resume_wait) {
850 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
851 msleep(10);
852 async_synchronize_full();
853 }
854
3efa147a 855 swsusp_resume_device = name_to_dev_t(resume_file);
0c8454f5
RW
856 if (!swsusp_resume_device) {
857 error = -ENODEV;
858 goto Unlock;
859 }
3efa147a
PM
860 }
861
0c8454f5 862 Check_image:
8d8b2441 863 pm_pr_dbg("Hibernation image partition %d:%d present\n",
0c8454f5 864 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
1da177e4 865
8d8b2441 866 pm_pr_dbg("Looking for hibernation image.\n");
ed746e3b
RW
867 error = swsusp_check();
868 if (error)
74dfd666 869 goto Unlock;
1da177e4 870
0709db60
RW
871 /* The snapshot device should not be opened while we're running */
872 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
873 error = -EBUSY;
76b57e61 874 swsusp_close(FMODE_READ);
0709db60
RW
875 goto Unlock;
876 }
877
8915aa20 878 pr_info("resume from hibernation\n");
5a0a2f30 879 pm_prepare_console();
ea00f4f4
LW
880 error = __pm_notifier_call_chain(PM_RESTORE_PREPARE, -1, &nr_calls);
881 if (error) {
882 nr_calls--;
8fd37a4c 883 goto Close_Finish;
ea00f4f4 884 }
1bfcf130 885
8d8b2441 886 pm_pr_dbg("Preparing processes for restore.\n");
03afed8b 887 error = freeze_processes();
8fd37a4c
RW
888 if (error)
889 goto Close_Finish;
fe12c00d 890 error = load_image_and_restore();
8fd37a4c 891 thaw_processes();
0709db60 892 Finish:
ea00f4f4 893 __pm_notifier_call_chain(PM_POST_RESTORE, nr_calls, NULL);
5a0a2f30 894 pm_restore_console();
8915aa20 895 pr_info("resume from hibernation failed (%d)\n", error);
0709db60 896 atomic_inc(&snapshot_device_available);
dd5d666b 897 /* For success case, the suspend path will release the lock */
74dfd666 898 Unlock:
a6d70980 899 mutex_unlock(&pm_mutex);
8d8b2441 900 pm_pr_dbg("Hibernation image not present or could not be loaded.\n");
7777fab9 901 return error;
8fd37a4c 902 Close_Finish:
76b57e61
JS
903 swsusp_close(FMODE_READ);
904 goto Finish;
1da177e4
LT
905}
906
d3c345db 907late_initcall_sync(software_resume);
1da177e4
LT
908
909
a3d25c27
RW
910static const char * const hibernation_modes[] = {
911 [HIBERNATION_PLATFORM] = "platform",
912 [HIBERNATION_SHUTDOWN] = "shutdown",
913 [HIBERNATION_REBOOT] = "reboot",
62c552cc
BS
914#ifdef CONFIG_SUSPEND
915 [HIBERNATION_SUSPEND] = "suspend",
916#endif
fe12c00d 917 [HIBERNATION_TEST_RESUME] = "test_resume",
1da177e4
LT
918};
919
f42a9813
RW
920/*
921 * /sys/power/disk - Control hibernation mode.
1da177e4 922 *
f42a9813
RW
923 * Hibernation can be handled in several ways. There are a few different ways
924 * to put the system into the sleep state: using the platform driver (e.g. ACPI
925 * or other hibernation_ops), powering it off or rebooting it (for testing
48580ab8 926 * mostly).
1da177e4 927 *
f42a9813
RW
928 * The sysfs file /sys/power/disk provides an interface for selecting the
929 * hibernation mode to use. Reading from this file causes the available modes
48580ab8 930 * to be printed. There are 3 modes that can be supported:
1da177e4 931 *
1da177e4
LT
932 * 'platform'
933 * 'shutdown'
934 * 'reboot'
935 *
f42a9813
RW
936 * If a platform hibernation driver is in use, 'platform' will be supported
937 * and will be used by default. Otherwise, 'shutdown' will be used by default.
938 * The selected option (i.e. the one corresponding to the current value of
939 * hibernation_mode) is enclosed by a square bracket.
940 *
941 * To select a given hibernation mode it is necessary to write the mode's
942 * string representation (as returned by reading from /sys/power/disk) back
943 * into /sys/power/disk.
1da177e4
LT
944 */
945
386f275f
KS
946static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
947 char *buf)
1da177e4 948{
f0ced9b2
JB
949 int i;
950 char *start = buf;
951
a6e15a39
KC
952 if (!hibernation_available())
953 return sprintf(buf, "[disabled]\n");
954
a3d25c27
RW
955 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
956 if (!hibernation_modes[i])
f0ced9b2
JB
957 continue;
958 switch (i) {
a3d25c27
RW
959 case HIBERNATION_SHUTDOWN:
960 case HIBERNATION_REBOOT:
62c552cc
BS
961#ifdef CONFIG_SUSPEND
962 case HIBERNATION_SUSPEND:
963#endif
fe12c00d 964 case HIBERNATION_TEST_RESUME:
f0ced9b2 965 break;
a3d25c27
RW
966 case HIBERNATION_PLATFORM:
967 if (hibernation_ops)
f0ced9b2
JB
968 break;
969 /* not a valid mode, continue with loop */
970 continue;
971 }
a3d25c27
RW
972 if (i == hibernation_mode)
973 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
f0ced9b2 974 else
a3d25c27 975 buf += sprintf(buf, "%s ", hibernation_modes[i]);
f0ced9b2
JB
976 }
977 buf += sprintf(buf, "\n");
978 return buf-start;
1da177e4
LT
979}
980
386f275f
KS
981static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
982 const char *buf, size_t n)
1da177e4
LT
983{
984 int error = 0;
985 int i;
986 int len;
987 char *p;
a3d25c27 988 int mode = HIBERNATION_INVALID;
1da177e4 989
a6e15a39
KC
990 if (!hibernation_available())
991 return -EPERM;
992
1da177e4
LT
993 p = memchr(buf, '\n', n);
994 len = p ? p - buf : n;
995
bcda53fa 996 lock_system_sleep();
a3d25c27 997 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
8d98a690
RW
998 if (len == strlen(hibernation_modes[i])
999 && !strncmp(buf, hibernation_modes[i], len)) {
1da177e4
LT
1000 mode = i;
1001 break;
1002 }
1003 }
a3d25c27 1004 if (mode != HIBERNATION_INVALID) {
fe0c935a 1005 switch (mode) {
a3d25c27
RW
1006 case HIBERNATION_SHUTDOWN:
1007 case HIBERNATION_REBOOT:
62c552cc
BS
1008#ifdef CONFIG_SUSPEND
1009 case HIBERNATION_SUSPEND:
1010#endif
fe12c00d 1011 case HIBERNATION_TEST_RESUME:
a3d25c27 1012 hibernation_mode = mode;
fe0c935a 1013 break;
a3d25c27
RW
1014 case HIBERNATION_PLATFORM:
1015 if (hibernation_ops)
1016 hibernation_mode = mode;
1da177e4
LT
1017 else
1018 error = -EINVAL;
1019 }
a3d25c27 1020 } else
1da177e4
LT
1021 error = -EINVAL;
1022
a3d25c27 1023 if (!error)
8d8b2441
RW
1024 pm_pr_dbg("Hibernation mode set to '%s'\n",
1025 hibernation_modes[mode]);
bcda53fa 1026 unlock_system_sleep();
1da177e4
LT
1027 return error ? error : n;
1028}
1029
1030power_attr(disk);
1031
386f275f
KS
1032static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
1033 char *buf)
1da177e4
LT
1034{
1035 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
1036 MINOR(swsusp_resume_device));
1037}
1038
386f275f
KS
1039static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
1040 const char *buf, size_t n)
1da177e4 1041{
1da177e4 1042 dev_t res;
421a5fa1
SC
1043 int len = n;
1044 char *name;
1da177e4 1045
421a5fa1
SC
1046 if (len && buf[len-1] == '\n')
1047 len--;
1048 name = kstrndup(buf, len, GFP_KERNEL);
1049 if (!name)
1050 return -ENOMEM;
1da177e4 1051
421a5fa1
SC
1052 res = name_to_dev_t(name);
1053 kfree(name);
1054 if (!res)
1055 return -EINVAL;
1da177e4 1056
bcda53fa 1057 lock_system_sleep();
a576219a 1058 swsusp_resume_device = res;
bcda53fa 1059 unlock_system_sleep();
2872de13 1060 pr_info("Starting manual resume from disk\n");
a576219a
AM
1061 noresume = 0;
1062 software_resume();
421a5fa1 1063 return n;
1da177e4
LT
1064}
1065
1066power_attr(resume);
1067
386f275f
KS
1068static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
1069 char *buf)
ca0aec0f 1070{
853609b6 1071 return sprintf(buf, "%lu\n", image_size);
ca0aec0f
RW
1072}
1073
386f275f
KS
1074static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1075 const char *buf, size_t n)
ca0aec0f 1076{
853609b6 1077 unsigned long size;
ca0aec0f 1078
853609b6 1079 if (sscanf(buf, "%lu", &size) == 1) {
ca0aec0f
RW
1080 image_size = size;
1081 return n;
1082 }
1083
1084 return -EINVAL;
1085}
1086
1087power_attr(image_size);
1088
ddeb6487
RW
1089static ssize_t reserved_size_show(struct kobject *kobj,
1090 struct kobj_attribute *attr, char *buf)
1091{
1092 return sprintf(buf, "%lu\n", reserved_size);
1093}
1094
1095static ssize_t reserved_size_store(struct kobject *kobj,
1096 struct kobj_attribute *attr,
1097 const char *buf, size_t n)
1098{
1099 unsigned long size;
1100
1101 if (sscanf(buf, "%lu", &size) == 1) {
1102 reserved_size = size;
1103 return n;
1104 }
1105
1106 return -EINVAL;
1107}
1108
1109power_attr(reserved_size);
1110
1da177e4
LT
1111static struct attribute * g[] = {
1112 &disk_attr.attr,
1113 &resume_attr.attr,
ca0aec0f 1114 &image_size_attr.attr,
ddeb6487 1115 &reserved_size_attr.attr,
1da177e4
LT
1116 NULL,
1117};
1118
1119
59494fe2 1120static const struct attribute_group attr_group = {
1da177e4
LT
1121 .attrs = g,
1122};
1123
1124
1125static int __init pm_disk_init(void)
1126{
d76e15fb 1127 return sysfs_create_group(power_kobj, &attr_group);
1da177e4
LT
1128}
1129
1130core_initcall(pm_disk_init);
1131
1132
1133static int __init resume_setup(char *str)
1134{
1135 if (noresume)
1136 return 1;
1137
1138 strncpy( resume_file, str, 255 );
1139 return 1;
1140}
1141
9a154d9d
RW
1142static int __init resume_offset_setup(char *str)
1143{
1144 unsigned long long offset;
1145
1146 if (noresume)
1147 return 1;
1148
1149 if (sscanf(str, "%llu", &offset) == 1)
1150 swsusp_resume_block = offset;
1151
1152 return 1;
1153}
1154
f996fc96
BS
1155static int __init hibernate_setup(char *str)
1156{
2f88e41a 1157 if (!strncmp(str, "noresume", 8)) {
f996fc96 1158 noresume = 1;
2f88e41a 1159 } else if (!strncmp(str, "nocompress", 10)) {
f996fc96 1160 nocompress = 1;
2f88e41a 1161 } else if (!strncmp(str, "no", 2)) {
a6e15a39
KC
1162 noresume = 1;
1163 nohibernate = 1;
0f5bf6d0 1164 } else if (IS_ENABLED(CONFIG_STRICT_KERNEL_RWX)
4c0b6c10
RW
1165 && !strncmp(str, "protect_image", 13)) {
1166 enable_restore_image_protection();
a6e15a39 1167 }
f996fc96
BS
1168 return 1;
1169}
1170
1da177e4
LT
1171static int __init noresume_setup(char *str)
1172{
1173 noresume = 1;
1174 return 1;
1175}
1176
6f8d7022
BS
1177static int __init resumewait_setup(char *str)
1178{
1179 resume_wait = 1;
1180 return 1;
1181}
1182
f126f733
BS
1183static int __init resumedelay_setup(char *str)
1184{
f6514be5 1185 int rc = kstrtouint(str, 0, &resume_delay);
317cf7e5
FF
1186
1187 if (rc)
1188 return rc;
f126f733
BS
1189 return 1;
1190}
1191
a6e15a39
KC
1192static int __init nohibernate_setup(char *str)
1193{
1194 noresume = 1;
1195 nohibernate = 1;
1196 return 1;
1197}
1198
1da177e4 1199__setup("noresume", noresume_setup);
9a154d9d 1200__setup("resume_offset=", resume_offset_setup);
1da177e4 1201__setup("resume=", resume_setup);
f996fc96 1202__setup("hibernate=", hibernate_setup);
6f8d7022 1203__setup("resumewait", resumewait_setup);
f126f733 1204__setup("resumedelay=", resumedelay_setup);
a6e15a39 1205__setup("nohibernate", nohibernate_setup);