blob: de4b989cc8fde6e05dadf766932719ef7113f07f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02002 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
Pavel Macheka2531292010-07-18 14:27:13 +02006 * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
Rafael J. Wysocki8b759b82009-06-10 01:27:49 +02007 * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
Bojan Smojver62c552c2012-06-16 00:09:58 +02008 * Copyright (C) 2012 Bojan Smojver <bojan@rexursive.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
10 * This file is released under the GPLv2.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 */
12
Paul Gortmaker6e5fdee2011-05-26 16:00:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/suspend.h>
15#include <linux/syscalls.h>
16#include <linux/reboot.h>
17#include <linux/string.h>
18#include <linux/device.h>
Barry Song6f8d7022011-10-06 20:34:46 +020019#include <linux/async.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/delay.h>
21#include <linux/fs.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070022#include <linux/mount.h>
Eric W. Biederman88d10bb2005-09-22 21:43:46 -070023#include <linux/pm.h>
Rafael J. Wysocki97c78012006-10-11 01:20:45 -070024#include <linux/console.h>
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -070025#include <linux/cpu.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080026#include <linux/freezer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090027#include <linux/gfp.h>
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +010028#include <linux/syscore_ops.h>
Minho Ban2df83fa2012-05-14 21:45:31 +020029#include <linux/ctype.h>
30#include <linux/genhd.h>
Andrew Mortond53d9f12005-07-12 13:58:07 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include "power.h"
33
34
Barry Songd231ff12011-10-11 23:29:18 -070035static int nocompress;
36static int noresume;
37static int resume_wait;
38static int resume_delay;
Adrian Bunk47a460d2008-02-04 22:30:06 -080039static char resume_file[256] = CONFIG_PM_STD_PARTITION;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040dev_t swsusp_resume_device;
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -080041sector_t swsusp_resume_block;
Andi Kleend6efc2f2013-08-05 15:02:49 -070042__visible int in_suspend __nosavedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070044enum {
45 HIBERNATION_INVALID,
46 HIBERNATION_PLATFORM,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070047 HIBERNATION_SHUTDOWN,
48 HIBERNATION_REBOOT,
Bojan Smojver62c552c2012-06-16 00:09:58 +020049#ifdef CONFIG_SUSPEND
50 HIBERNATION_SUSPEND,
51#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070052 /* keep last */
53 __HIBERNATION_AFTER_LAST
54};
55#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
56#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
57
58static int hibernation_mode = HIBERNATION_SHUTDOWN;
59
Srivatsa S. Bhat97819a22011-12-01 22:33:10 +010060bool freezer_test_done;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +010061
Lionel Debroux073ef1f2010-11-09 21:48:49 +010062static const struct platform_hibernation_ops *hibernation_ops;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070063
64/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +020065 * hibernation_set_ops - Set the global hibernate operations.
66 * @ops: Hibernation operations to use in subsequent hibernation transitions.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070067 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +010068void hibernation_set_ops(const struct platform_hibernation_ops *ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070069{
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +010070 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
71 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
MyungJoo Ham5729c632010-11-26 23:07:48 +010072 && ops->restore_cleanup && ops->leave)) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070073 WARN_ON(1);
74 return;
75 }
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +010076 lock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070077 hibernation_ops = ops;
78 if (ops)
79 hibernation_mode = HIBERNATION_PLATFORM;
80 else if (hibernation_mode == HIBERNATION_PLATFORM)
81 hibernation_mode = HIBERNATION_SHUTDOWN;
82
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +010083 unlock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070084}
Leonardo Potenzae0c78552013-11-19 12:27:41 +000085EXPORT_SYMBOL_GPL(hibernation_set_ops);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070086
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +010087static bool entering_platform_hibernation;
88
89bool system_entering_hibernation(void)
90{
91 return entering_platform_hibernation;
92}
93EXPORT_SYMBOL(system_entering_hibernation);
94
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +010095#ifdef CONFIG_PM_DEBUG
96static void hibernation_debug_sleep(void)
97{
98 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
99 mdelay(5000);
100}
101
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100102static 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 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100111static int hibernation_test(int level) { return 0; }
112#endif /* !CONFIG_PM_DEBUG */
113
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700114/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200115 * platform_begin - Call platform to start hibernation.
116 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700117 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100118static int platform_begin(int platform_mode)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700119{
120 return (platform_mode && hibernation_ops) ?
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100121 hibernation_ops->begin() : 0;
122}
123
124/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200125 * platform_end - Call platform to finish transition to the working state.
126 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100127 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100128static void platform_end(int platform_mode)
129{
130 if (platform_mode && hibernation_ops)
131 hibernation_ops->end();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700132}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200135 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
136 * @platform_mode: Whether or not to use the platform driver.
137 *
138 * Use the platform driver to prepare the system for creating a hibernate image,
139 * if so configured, and return an error code if that fails.
Stefan Seyfried8a05aac2006-12-06 20:34:21 -0800140 */
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. Wysockif42a9812011-05-24 23:36:06 +0200149 * platform_leave - Call platform to prepare a transition to the working state.
150 * @platform_mode: Whether or not to use the platform driver.
151 *
152 * Use the platform driver prepare to prepare the machine for switching to the
153 * normal mode of operation.
154 *
155 * This routine is called on one CPU with interrupts disabled.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700156 */
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700157static void platform_leave(int platform_mode)
158{
159 if (platform_mode && hibernation_ops)
160 hibernation_ops->leave();
161}
162
163/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200164 * platform_finish - Call platform to switch the system to the working state.
165 * @platform_mode: Whether or not to use the platform driver.
166 *
167 * Use the platform driver to switch the machine to the normal mode of
168 * operation.
169 *
170 * This routine must be called after platform_prepare().
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700171 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700172static void platform_finish(int platform_mode)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700173{
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700174 if (platform_mode && hibernation_ops)
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700175 hibernation_ops->finish();
176}
177
178/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200179 * platform_pre_restore - Prepare for hibernate image restoration.
180 * @platform_mode: Whether or not to use the platform driver.
181 *
182 * Use the platform driver to prepare the system for resume from a hibernation
183 * image.
184 *
185 * If the restore fails after this function has been called,
186 * platform_restore_cleanup() must be called.
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700187 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700188static int platform_pre_restore(int platform_mode)
189{
190 return (platform_mode && hibernation_ops) ?
191 hibernation_ops->pre_restore() : 0;
192}
193
194/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200195 * platform_restore_cleanup - Switch to the working state after failing restore.
196 * @platform_mode: Whether or not to use the platform driver.
197 *
198 * Use the platform driver to switch the system to the normal mode of operation
199 * after a failing restore.
200 *
201 * If platform_pre_restore() has been called before the failing restore, this
202 * function must be called too, regardless of the result of
203 * platform_pre_restore().
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700204 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700205static void platform_restore_cleanup(int platform_mode)
206{
207 if (platform_mode && hibernation_ops)
208 hibernation_ops->restore_cleanup();
209}
210
211/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200212 * platform_recover - Recover from a failure to suspend devices.
213 * @platform_mode: Whether or not to use the platform driver.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200214 */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200215static void platform_recover(int platform_mode)
216{
217 if (platform_mode && hibernation_ops && hibernation_ops->recover)
218 hibernation_ops->recover();
219}
220
221/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200222 * swsusp_show_speed - Print time elapsed between two events during hibernation.
223 * @start: Starting event.
224 * @stop: Final event.
225 * @nr_pages: Number of memory pages processed between @start and @stop.
226 * @msg: Additional diagnostic message to print.
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100227 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100228void swsusp_show_speed(struct timeval *start, struct timeval *stop,
229 unsigned nr_pages, char *msg)
230{
Chen Gang4881f602014-04-25 08:44:59 +0800231 u64 elapsed_centisecs64;
232 unsigned int centisecs;
233 unsigned int k;
234 unsigned int kps;
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100235
236 elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
Chen Gang4881f602014-04-25 08:44:59 +0800237 /*
238 * If "(s64)elapsed_centisecs64 < 0", it will print long elapsed time,
239 * it is obvious enough for what went wrong.
240 */
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100241 do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
242 centisecs = elapsed_centisecs64;
243 if (centisecs == 0)
244 centisecs = 1; /* avoid div-by-zero */
245 k = nr_pages * (PAGE_SIZE / 1024);
246 kps = (k * 100) / centisecs;
Chen Gang4881f602014-04-25 08:44:59 +0800247 printk(KERN_INFO "PM: %s %u kbytes in %u.%02u seconds (%u.%02u MB/s)\n",
Nigel Cunningham8e60c6a2009-12-06 16:16:07 +0100248 msg, k,
249 centisecs / 100, centisecs % 100,
250 kps / 1000, (kps % 1000) / 10);
251}
252
253/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200254 * create_image - Create a hibernation image.
255 * @platform_mode: Whether or not to use the platform driver.
256 *
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100257 * Execute device drivers' "late" and "noirq" freeze callbacks, create a
258 * hibernation image and run the drivers' "noirq" and "early" thaw callbacks.
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200259 *
260 * Control reappears in this routine after the subsequent restore.
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700261 */
Adrian Bunk47a460d2008-02-04 22:30:06 -0800262static int create_image(int platform_mode)
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700263{
264 int error;
265
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100266 error = dpm_suspend_end(PMSG_FREEZE);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700267 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100268 printk(KERN_ERR "PM: Some devices failed to power down, "
269 "aborting hibernation\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200270 return error;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700271 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100272
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100273 error = platform_pre_snapshot(platform_mode);
274 if (error || hibernation_test(TEST_PLATFORM))
275 goto Platform_finish;
276
277 error = disable_nonboot_cpus();
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100278 if (error || hibernation_test(TEST_CPUS))
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100279 goto Enable_cpus;
280
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100281 local_irq_disable();
282
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200283 error = syscore_suspend();
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100284 if (error) {
Bjorn Helgaas44840792009-05-15 23:30:50 +0200285 printk(KERN_ERR "PM: Some system devices failed to power down, "
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100286 "aborting hibernation\n");
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100287 goto Enable_irqs;
Rafael J. Wysocki770824b2009-02-22 18:38:50 +0100288 }
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700289
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100290 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100291 goto Power_up;
292
293 in_suspend = 1;
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700294 save_processor_state();
295 error = swsusp_arch_suspend();
296 if (error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100297 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
298 error);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700299 /* Restore control flow magically appears here */
300 restore_processor_state();
Bjørn Mork362e77d2013-12-04 16:06:58 +0100301 if (!in_suspend)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200302 events_check_enabled = false;
Bjørn Mork362e77d2013-12-04 16:06:58 +0100303
304 platform_leave(platform_mode);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100305
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100306 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100307 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100308
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100309 Enable_irqs:
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100310 local_irq_enable();
311
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100312 Enable_cpus:
313 enable_nonboot_cpus();
314
315 Platform_finish:
316 platform_finish(platform_mode);
317
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100318 dpm_resume_start(in_suspend ?
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200319 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100320
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700321 return error;
322}
323
324/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200325 * hibernation_snapshot - Quiesce devices and create a hibernation image.
326 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700327 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200328 * This routine must be called with pm_mutex held.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700329 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700330int hibernation_snapshot(int platform_mode)
331{
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100332 pm_message_t msg;
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100333 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700334
Zhang Rui3fe03132008-10-26 20:50:26 +0100335 error = platform_begin(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700336 if (error)
Rafael J. Wysockid074ee02010-07-07 23:43:35 +0200337 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700338
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200339 /* Preallocate image memory before shutting down devices. */
340 error = hibernate_preallocate_memory();
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700341 if (error)
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200342 goto Close;
343
344 error = freeze_kernel_threads();
345 if (error)
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100346 goto Cleanup;
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200347
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100348 if (hibernation_test(TEST_FREEZER)) {
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100349
350 /*
351 * Indicate to the caller that we are returning due to a
352 * successful freezer test.
353 */
354 freezer_test_done = true;
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100355 goto Thaw;
Srivatsa S. Bhataa9a7b12011-11-18 23:02:42 +0100356 }
357
Rafael J. Wysocki2aede852011-09-26 20:32:27 +0200358 error = dpm_prepare(PMSG_FREEZE);
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100359 if (error) {
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100360 dpm_complete(PMSG_RECOVER);
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100361 goto Thaw;
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100362 }
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700363
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700364 suspend_console();
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200365 ftrace_stop();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100366 pm_restrict_gfp_mask();
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100367
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200368 error = dpm_suspend(PMSG_FREEZE);
Rafael J. Wysocki10a18032007-07-19 01:47:31 -0700369
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100370 if (error || hibernation_test(TEST_DEVICES))
371 platform_recover(platform_mode);
372 else
373 error = create_image(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700374
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100375 /*
Srivatsa S. Bhat953a2062011-11-22 23:20:31 +0100376 * In the case that we call create_image() above, the control
377 * returns here (1) after the image has been created or the
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100378 * image creation has failed and (2) after a successful restore.
379 */
Rafael J. Wysocki4cc79772007-11-19 23:42:31 +0100380
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200381 /* We may need to release the preallocated image pages here. */
382 if (error || !in_suspend)
383 swsusp_free();
384
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200385 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
386 dpm_resume(msg);
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100387
388 if (error || !in_suspend)
389 pm_restore_gfp_mask();
390
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200391 ftrace_start();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700392 resume_console();
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200393 dpm_complete(msg);
394
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100395 Close:
396 platform_end(platform_mode);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700397 return error;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200398
Srivatsa S. Bhat51d6ff72012-02-04 22:26:38 +0100399 Thaw:
400 thaw_kernel_threads();
Rafael J. Wysockibb58dd52011-11-22 23:08:10 +0100401 Cleanup:
402 swsusp_free();
403 goto Close;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700404}
405
406/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200407 * resume_target_kernel - Restore system state from a hibernation image.
408 * @platform_mode: Whether or not to use the platform driver.
409 *
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100410 * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
411 * contents of highmem that have not been restored yet from the image and run
412 * the low-level code that will restore the remaining contents of memory and
413 * switch to the just restored target kernel.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100414 */
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100415static int resume_target_kernel(bool platform_mode)
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100416{
417 int error;
418
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100419 error = dpm_suspend_end(PMSG_QUIESCE);
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100420 if (error) {
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100421 printk(KERN_ERR "PM: Some devices failed to power down, "
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100422 "aborting resume\n");
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200423 return error;
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100424 }
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100425
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100426 error = platform_pre_restore(platform_mode);
427 if (error)
428 goto Cleanup;
429
430 error = disable_nonboot_cpus();
431 if (error)
432 goto Enable_cpus;
433
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100434 local_irq_disable();
435
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200436 error = syscore_suspend();
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100437 if (error)
438 goto Enable_irqs;
439
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100440 save_processor_state();
441 error = restore_highmem();
442 if (!error) {
443 error = swsusp_arch_resume();
444 /*
445 * The code below is only ever reached in case of a failure.
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200446 * Otherwise, execution continues at the place where
447 * swsusp_arch_suspend() was called.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100448 */
449 BUG_ON(!error);
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200450 /*
451 * This call to restore_highmem() reverts the changes made by
452 * the previous one.
453 */
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100454 restore_highmem();
455 }
456 /*
457 * The only reason why swsusp_arch_resume() can fail is memory being
458 * very tight, so we have to free it as soon as we can to avoid
Rafael J. Wysocki4e2d9492011-05-24 00:21:26 +0200459 * subsequent failures.
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100460 */
461 swsusp_free();
462 restore_processor_state();
463 touch_softlockup_watchdog();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100464
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100465 syscore_resume();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100466
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100467 Enable_irqs:
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100468 local_irq_enable();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100469
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100470 Enable_cpus:
471 enable_nonboot_cpus();
472
473 Cleanup:
474 platform_restore_cleanup(platform_mode);
475
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100476 dpm_resume_start(PMSG_RECOVER);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100477
Rafael J. Wysocki72df68c2007-12-08 02:04:21 +0100478 return error;
479}
480
481/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200482 * hibernation_restore - Quiesce devices and restore from a hibernation image.
483 * @platform_mode: If set, use platform driver to prepare for the transition.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700484 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200485 * This routine must be called with pm_mutex held. If it is successful, control
Barry Song21e82802011-09-27 22:05:44 +0200486 * reappears in the restored target kernel in hibernation_snapshot().
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700487 */
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700488int hibernation_restore(int platform_mode)
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700489{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100490 int error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700491
492 pm_prepare_console();
493 suspend_console();
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200494 ftrace_stop();
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100495 pm_restrict_gfp_mask();
Alan Sternd1616302009-05-24 22:05:42 +0200496 error = dpm_suspend_start(PMSG_QUIESCE);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700497 if (!error) {
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100498 error = resume_target_kernel(platform_mode);
Alan Sternd1616302009-05-24 22:05:42 +0200499 dpm_resume_end(PMSG_RECOVER);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700500 }
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100501 pm_restore_gfp_mask();
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200502 ftrace_start();
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700503 resume_console();
504 pm_restore_console();
505 return error;
506}
507
508/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200509 * hibernation_platform_enter - Power off the system using the platform driver.
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700510 */
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700511int hibernation_platform_enter(void)
512{
Ingo Molnarcbe2f5a2008-11-23 10:37:12 +0100513 int error;
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700514
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700515 if (!hibernation_ops)
516 return -ENOSYS;
517
518 /*
519 * We have cancelled the power transition by running
520 * hibernation_ops->finish() before saving the image, so we should let
521 * the firmware know that we're going to enter the sleep state after all
522 */
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100523 error = hibernation_ops->begin();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700524 if (error)
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100525 goto Close;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700526
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100527 entering_platform_hibernation = true;
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700528 suspend_console();
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200529 ftrace_stop();
Alan Sternd1616302009-05-24 22:05:42 +0200530 error = dpm_suspend_start(PMSG_HIBERNATE);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200531 if (error) {
532 if (hibernation_ops->recover)
533 hibernation_ops->recover();
534 goto Resume_devices;
535 }
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700536
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100537 error = dpm_suspend_end(PMSG_HIBERNATE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100538 if (error)
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200539 goto Resume_devices;
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100540
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100541 error = hibernation_ops->prepare();
542 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200543 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100544
545 error = disable_nonboot_cpus();
546 if (error)
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200547 goto Platform_finish;
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100548
549 local_irq_disable();
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100550 syscore_suspend();
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100551 if (pm_wakeup_pending()) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200552 error = -EAGAIN;
553 goto Power_up;
554 }
555
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100556 hibernation_ops->enter();
557 /* We should never get here */
558 while (1);
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700559
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200560 Power_up:
Rafael J. Wysocki40dc1662011-03-15 00:43:46 +0100561 syscore_resume();
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200562 local_irq_enable();
563 enable_nonboot_cpus();
564
Thadeu Lima de Souza Cascardoe681c9d2009-07-08 13:23:32 +0200565 Platform_finish:
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700566 hibernation_ops->finish();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100567
Rafael J. Wysockicf579df2012-01-29 20:38:29 +0100568 dpm_resume_start(PMSG_RESTORE);
Rafael J. Wysocki4aecd672009-03-16 22:34:26 +0100569
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700570 Resume_devices:
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100571 entering_platform_hibernation = false;
Alan Sternd1616302009-05-24 22:05:42 +0200572 dpm_resume_end(PMSG_RESTORE);
Srivatsa S. Bhat443772d42012-06-16 15:30:45 +0200573 ftrace_start();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700574 resume_console();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100575
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100576 Close:
577 hibernation_ops->end();
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100578
Rafael J. Wysockib1457bc2007-07-19 01:47:31 -0700579 return error;
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700580}
581
582/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200583 * power_down - Shut the machine down for hibernation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200585 * Use the platform driver, if configured, to put the system into the sleep
586 * state corresponding to hibernation, or try to power it off or reboot,
587 * depending on the value of hibernation_mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 */
Johannes Bergfe0c9352007-04-30 15:09:51 -0700589static void power_down(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
Bojan Smojver62c552c2012-06-16 00:09:58 +0200591#ifdef CONFIG_SUSPEND
592 int error;
593#endif
594
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700595 switch (hibernation_mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700596 case HIBERNATION_REBOOT:
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600597 kernel_restart(NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700599 case HIBERNATION_PLATFORM:
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700600 hibernation_platform_enter();
Rafael J. Wysocki9cd9a002007-10-18 03:04:56 -0700601 case HIBERNATION_SHUTDOWN:
602 kernel_power_off();
603 break;
Bojan Smojver62c552c2012-06-16 00:09:58 +0200604#ifdef CONFIG_SUSPEND
605 case HIBERNATION_SUSPEND:
606 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
607 if (error) {
608 if (hibernation_ops)
609 hibernation_mode = HIBERNATION_PLATFORM;
610 else
611 hibernation_mode = HIBERNATION_SHUTDOWN;
612 power_down();
613 }
614 /*
615 * Restore swap signature.
616 */
617 error = swsusp_unmark();
618 if (error)
619 printk(KERN_ERR "PM: Swap will be unusable! "
620 "Try swapon -a.\n");
621 return;
622#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 }
Eric W. Biedermanfdde86a2005-07-26 12:01:17 -0600624 kernel_halt();
Johannes Bergfe0c9352007-04-30 15:09:51 -0700625 /*
626 * Valid image is on the disk, if we continue we risk serious data
627 * corruption after resume.
628 */
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100629 printk(KERN_CRIT "PM: Please power down manually\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 while(1);
631}
632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200634 * hibernate - Carry out system hibernation, including saving the image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700636int hibernate(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
638 int error;
639
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100640 lock_system_sleep();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700641 /* The snapshot device should not be opened while we're running */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700642 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
643 error = -EBUSY;
644 goto Unlock;
645 }
646
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100647 pm_prepare_console();
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700648 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
649 if (error)
650 goto Exit;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700651
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100652 printk(KERN_INFO "PM: Syncing filesystems ... ");
Rafael J. Wysocki232b1432007-10-18 03:04:44 -0700653 sys_sync();
654 printk("done.\n");
655
Tejun Heo03afed82011-11-21 12:32:24 -0800656 error = freeze_processes();
Li Shaohua5a72e042005-06-25 14:55:06 -0700657 if (error)
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200658 goto Exit;
659
Rafael J. Wysocki942f4012013-08-30 14:19:46 +0200660 lock_device_hotplug();
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200661 /* Allocate memory management structures */
662 error = create_basic_memory_bitmaps();
663 if (error)
664 goto Thaw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700666 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
Srivatsa S. Bhata556d5b52012-02-04 23:39:56 +0100667 if (error || freezer_test_done)
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200668 goto Free_bitmaps;
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200669
670 if (in_suspend) {
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700671 unsigned int flags = 0;
672
673 if (hibernation_mode == HIBERNATION_PLATFORM)
674 flags |= SF_PLATFORM_MODE;
Bojan Smojverf996fc92010-09-09 23:06:23 +0200675 if (nocompress)
676 flags |= SF_NOCOMPRESS_MODE;
Bojan Smojver081a9d02011-10-13 23:58:07 +0200677 else
678 flags |= SF_CRC32_MODE;
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 pr_debug("PM: writing image.\n");
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700681 error = swsusp_write(flags);
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700682 swsusp_free();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 if (!error)
Johannes Bergfe0c9352007-04-30 15:09:51 -0700684 power_down();
MyungJoo Ham5262a472010-11-26 23:07:56 +0100685 in_suspend = 0;
Rafael J. Wysockic9e664f2010-12-03 22:57:45 +0100686 pm_restore_gfp_mask();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800687 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 pr_debug("PM: Image restored successfully.\n");
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800689 }
Rafael J. Wysocki64a473c2009-07-08 13:24:05 +0200690
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200691 Free_bitmaps:
692 free_basic_memory_bitmaps();
Rafael J. Wysockib918f6e2006-11-02 22:07:19 -0800693 Thaw:
Rafael J. Wysocki942f4012013-08-30 14:19:46 +0200694 unlock_device_hotplug();
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100695 thaw_processes();
Srivatsa S. Bhata556d5b52012-02-04 23:39:56 +0100696
697 /* Don't bother checking whether freezer_test_done is true */
698 freezer_test_done = false;
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700699 Exit:
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700700 pm_notifier_call_chain(PM_POST_HIBERNATION);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100701 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700702 atomic_inc(&snapshot_device_available);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700703 Unlock:
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100704 unlock_system_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 return error;
706}
707
708
709/**
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200710 * software_resume - Resume from a saved hibernation image.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200712 * This routine is called as a late initcall, when all devices have been
713 * discovered and initialized already.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200715 * The image reading code is called to see if there is a hibernation image
716 * available for reading. If that is the case, devices are quiesced and the
717 * contents of memory is restored from the saved image.
718 *
719 * If this is successful, control reappears in the restored target kernel in
720 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
721 * attempts to recover gracefully and make the kernel return to the normal mode
722 * of operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724static int software_resume(void)
725{
726 int error;
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700727 unsigned int flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
Johannes Berg60a0d232007-11-14 17:00:16 -0800729 /*
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100730 * If the user said "noresume".. bail out early.
731 */
732 if (noresume)
733 return 0;
734
735 /*
Johannes Berg60a0d232007-11-14 17:00:16 -0800736 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
737 * is configured into the kernel. Since the regular hibernate
738 * trigger path is via sysfs which takes a buffer mutex before
739 * calling hibernate functions (which take pm_mutex) this can
740 * cause lockdep to complain about a possible ABBA deadlock
741 * which cannot happen since we're in the boot code here and
742 * sysfs can't be invoked yet. Therefore, we use a subclass
743 * here to avoid lockdep complaining.
744 */
745 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200746
747 if (swsusp_resume_device)
748 goto Check_image;
749
750 if (!strlen(resume_file)) {
751 error = -ENOENT;
752 goto Unlock;
753 }
754
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200755 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200756
Barry Songf126f732011-10-10 23:38:41 +0200757 if (resume_delay) {
758 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
759 resume_delay);
760 ssleep(resume_delay);
761 }
762
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200763 /* Check if the device is there */
764 swsusp_resume_device = name_to_dev_t(resume_file);
Minho Ban2df83fa2012-05-14 21:45:31 +0200765
766 /*
767 * name_to_dev_t is ineffective to verify parition if resume_file is in
768 * integer format. (e.g. major:minor)
769 */
770 if (isdigit(resume_file[0]) && resume_wait) {
771 int partno;
772 while (!get_gendisk(swsusp_resume_device, &partno))
773 msleep(10);
774 }
775
Pavel Machek3efa1472005-07-07 17:56:43 -0700776 if (!swsusp_resume_device) {
Arjan van de Veneed3ee02009-02-14 02:00:19 +0100777 /*
778 * Some device discovery might still be in progress; we need
779 * to wait for this to finish.
780 */
781 wait_for_device_probe();
Barry Song6f8d7022011-10-06 20:34:46 +0200782
783 if (resume_wait) {
784 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
785 msleep(10);
786 async_synchronize_full();
787 }
788
Pavel Machek3efa1472005-07-07 17:56:43 -0700789 swsusp_resume_device = name_to_dev_t(resume_file);
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200790 if (!swsusp_resume_device) {
791 error = -ENODEV;
792 goto Unlock;
793 }
Pavel Machek3efa1472005-07-07 17:56:43 -0700794 }
795
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200796 Check_image:
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200797 pr_debug("PM: Hibernation image partition %d:%d present\n",
Rafael J. Wysocki0c8454f2009-04-25 00:16:06 +0200798 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200800 pr_debug("PM: Looking for hibernation image.\n");
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800801 error = swsusp_check();
802 if (error)
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700803 goto Unlock;
804
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700805 /* The snapshot device should not be opened while we're running */
806 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
807 error = -EBUSY;
Jiri Slaby76b57e62009-10-07 22:37:35 +0200808 swsusp_close(FMODE_READ);
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700809 goto Unlock;
810 }
811
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100812 pm_prepare_console();
Alan Sternc3e94d82007-11-19 23:38:25 +0100813 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
814 if (error)
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200815 goto Close_Finish;
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 pr_debug("PM: Preparing processes for restore.\n");
Tejun Heo03afed82011-11-21 12:32:24 -0800818 error = freeze_processes();
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200819 if (error)
820 goto Close_Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200822 pr_debug("PM: Loading hibernation image.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Rafael J. Wysocki942f4012013-08-30 14:19:46 +0200824 lock_device_hotplug();
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200825 error = create_basic_memory_bitmaps();
826 if (error)
827 goto Thaw;
828
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700829 error = swsusp_read(&flags);
Jiri Slaby76b57e62009-10-07 22:37:35 +0200830 swsusp_close(FMODE_READ);
Rafael J. Wysockied746e32007-02-10 01:43:32 -0800831 if (!error)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700832 hibernation_restore(flags & SF_PLATFORM_MODE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200834 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700835 swsusp_free();
Rafael J. Wysocki7b5179a2012-03-28 23:30:14 +0200836 free_basic_memory_bitmaps();
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200837 Thaw:
Rafael J. Wysocki942f4012013-08-30 14:19:46 +0200838 unlock_device_hotplug();
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200839 thaw_processes();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700840 Finish:
Alan Sternc3e94d82007-11-19 23:38:25 +0100841 pm_notifier_call_chain(PM_POST_RESTORE);
Rafael J. Wysocki5a0a2f32008-01-11 01:25:21 +0100842 pm_restore_console();
Rafael J. Wysocki0709db62007-05-06 14:50:45 -0700843 atomic_inc(&snapshot_device_available);
Shaohua Lidd5d6662005-09-03 15:57:04 -0700844 /* For success case, the suspend path will release the lock */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700845 Unlock:
Stephen Hemmingera6d70982006-12-06 20:34:35 -0800846 mutex_unlock(&pm_mutex);
Rafael J. Wysockid0941ea2010-09-28 23:31:22 +0200847 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
Rafael J. Wysocki7777fab2007-07-19 01:47:29 -0700848 return error;
Rafael J. Wysocki8fd37a42013-08-30 14:19:38 +0200849 Close_Finish:
Jiri Slaby76b57e62009-10-07 22:37:35 +0200850 swsusp_close(FMODE_READ);
851 goto Finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}
853
Russ Dilld3c345d2013-10-24 14:25:26 +0100854late_initcall_sync(software_resume);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
856
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700857static const char * const hibernation_modes[] = {
858 [HIBERNATION_PLATFORM] = "platform",
859 [HIBERNATION_SHUTDOWN] = "shutdown",
860 [HIBERNATION_REBOOT] = "reboot",
Bojan Smojver62c552c2012-06-16 00:09:58 +0200861#ifdef CONFIG_SUSPEND
862 [HIBERNATION_SUSPEND] = "suspend",
863#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864};
865
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200866/*
867 * /sys/power/disk - Control hibernation mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200869 * Hibernation can be handled in several ways. There are a few different ways
870 * to put the system into the sleep state: using the platform driver (e.g. ACPI
871 * or other hibernation_ops), powering it off or rebooting it (for testing
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100872 * mostly).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200874 * The sysfs file /sys/power/disk provides an interface for selecting the
875 * hibernation mode to use. Reading from this file causes the available modes
Srivatsa S. Bhat48580ab2011-12-01 22:33:20 +0100876 * to be printed. There are 3 modes that can be supported:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 * 'platform'
879 * 'shutdown'
880 * 'reboot'
881 *
Rafael J. Wysockif42a9812011-05-24 23:36:06 +0200882 * If a platform hibernation driver is in use, 'platform' will be supported
883 * and will be used by default. Otherwise, 'shutdown' will be used by default.
884 * The selected option (i.e. the one corresponding to the current value of
885 * hibernation_mode) is enclosed by a square bracket.
886 *
887 * To select a given hibernation mode it is necessary to write the mode's
888 * string representation (as returned by reading from /sys/power/disk) back
889 * into /sys/power/disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 */
891
Kay Sievers386f2752007-11-02 13:47:53 +0100892static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
893 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894{
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700895 int i;
896 char *start = buf;
897
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700898 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
899 if (!hibernation_modes[i])
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700900 continue;
901 switch (i) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700902 case HIBERNATION_SHUTDOWN:
903 case HIBERNATION_REBOOT:
Bojan Smojver62c552c2012-06-16 00:09:58 +0200904#ifdef CONFIG_SUSPEND
905 case HIBERNATION_SUSPEND:
906#endif
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700907 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700908 case HIBERNATION_PLATFORM:
909 if (hibernation_ops)
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700910 break;
911 /* not a valid mode, continue with loop */
912 continue;
913 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700914 if (i == hibernation_mode)
915 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700916 else
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700917 buf += sprintf(buf, "%s ", hibernation_modes[i]);
Johannes Bergf0ced9b2007-05-06 14:50:50 -0700918 }
919 buf += sprintf(buf, "\n");
920 return buf-start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921}
922
Kay Sievers386f2752007-11-02 13:47:53 +0100923static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
924 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925{
926 int error = 0;
927 int i;
928 int len;
929 char *p;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700930 int mode = HIBERNATION_INVALID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
932 p = memchr(buf, '\n', n);
933 len = p ? p - buf : n;
934
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100935 lock_system_sleep();
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700936 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
Rafael J. Wysocki8d98a692007-05-16 22:11:19 -0700937 if (len == strlen(hibernation_modes[i])
938 && !strncmp(buf, hibernation_modes[i], len)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 mode = i;
940 break;
941 }
942 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700943 if (mode != HIBERNATION_INVALID) {
Johannes Bergfe0c9352007-04-30 15:09:51 -0700944 switch (mode) {
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700945 case HIBERNATION_SHUTDOWN:
946 case HIBERNATION_REBOOT:
Bojan Smojver62c552c2012-06-16 00:09:58 +0200947#ifdef CONFIG_SUSPEND
948 case HIBERNATION_SUSPEND:
949#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700950 hibernation_mode = mode;
Johannes Bergfe0c9352007-04-30 15:09:51 -0700951 break;
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700952 case HIBERNATION_PLATFORM:
953 if (hibernation_ops)
954 hibernation_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 else
956 error = -EINVAL;
957 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700958 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 error = -EINVAL;
960
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700961 if (!error)
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100962 pr_debug("PM: Hibernation mode set to '%s'\n",
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700963 hibernation_modes[mode]);
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100964 unlock_system_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 return error ? error : n;
966}
967
968power_attr(disk);
969
Kay Sievers386f2752007-11-02 13:47:53 +0100970static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
971 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972{
973 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
974 MINOR(swsusp_resume_device));
975}
976
Kay Sievers386f2752007-11-02 13:47:53 +0100977static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
978 const char *buf, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 dev_t res;
Sebastian Capella421a5fa2014-02-14 14:52:56 -0800981 int len = n;
982 char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Sebastian Capella421a5fa2014-02-14 14:52:56 -0800984 if (len && buf[len-1] == '\n')
985 len--;
986 name = kstrndup(buf, len, GFP_KERNEL);
987 if (!name)
988 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
Sebastian Capella421a5fa2014-02-14 14:52:56 -0800990 res = name_to_dev_t(name);
991 kfree(name);
992 if (!res)
993 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100995 lock_system_sleep();
Andrew Mortona5762192006-01-06 00:09:50 -0800996 swsusp_resume_device = res;
Srivatsa S. Bhatbcda53f2011-12-07 22:29:54 +0100997 unlock_system_sleep();
Rafael J. Wysocki23976722007-12-08 02:09:43 +0100998 printk(KERN_INFO "PM: Starting manual resume from disk\n");
Andrew Mortona5762192006-01-06 00:09:50 -0800999 noresume = 0;
1000 software_resume();
Sebastian Capella421a5fa2014-02-14 14:52:56 -08001001 return n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002}
1003
1004power_attr(resume);
1005
Kay Sievers386f2752007-11-02 13:47:53 +01001006static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
1007 char *buf)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001008{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001009 return sprintf(buf, "%lu\n", image_size);
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001010}
1011
Kay Sievers386f2752007-11-02 13:47:53 +01001012static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1013 const char *buf, size_t n)
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001014{
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001015 unsigned long size;
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001016
Rafael J. Wysocki853609b2006-02-01 03:05:07 -08001017 if (sscanf(buf, "%lu", &size) == 1) {
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001018 image_size = size;
1019 return n;
1020 }
1021
1022 return -EINVAL;
1023}
1024
1025power_attr(image_size);
1026
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001027static ssize_t reserved_size_show(struct kobject *kobj,
1028 struct kobj_attribute *attr, char *buf)
1029{
1030 return sprintf(buf, "%lu\n", reserved_size);
1031}
1032
1033static ssize_t reserved_size_store(struct kobject *kobj,
1034 struct kobj_attribute *attr,
1035 const char *buf, size_t n)
1036{
1037 unsigned long size;
1038
1039 if (sscanf(buf, "%lu", &size) == 1) {
1040 reserved_size = size;
1041 return n;
1042 }
1043
1044 return -EINVAL;
1045}
1046
1047power_attr(reserved_size);
1048
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049static struct attribute * g[] = {
1050 &disk_attr.attr,
1051 &resume_attr.attr,
Rafael J. Wysockica0aec02006-01-06 00:15:56 -08001052 &image_size_attr.attr,
Rafael J. Wysockiddeb6482011-05-15 11:38:48 +02001053 &reserved_size_attr.attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 NULL,
1055};
1056
1057
1058static struct attribute_group attr_group = {
1059 .attrs = g,
1060};
1061
1062
1063static int __init pm_disk_init(void)
1064{
Greg Kroah-Hartmand76e15f2007-11-27 11:28:26 -08001065 return sysfs_create_group(power_kobj, &attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066}
1067
1068core_initcall(pm_disk_init);
1069
1070
1071static int __init resume_setup(char *str)
1072{
1073 if (noresume)
1074 return 1;
1075
1076 strncpy( resume_file, str, 255 );
1077 return 1;
1078}
1079
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001080static int __init resume_offset_setup(char *str)
1081{
1082 unsigned long long offset;
1083
1084 if (noresume)
1085 return 1;
1086
1087 if (sscanf(str, "%llu", &offset) == 1)
1088 swsusp_resume_block = offset;
1089
1090 return 1;
1091}
1092
Bojan Smojverf996fc92010-09-09 23:06:23 +02001093static int __init hibernate_setup(char *str)
1094{
1095 if (!strncmp(str, "noresume", 8))
1096 noresume = 1;
1097 else if (!strncmp(str, "nocompress", 10))
1098 nocompress = 1;
1099 return 1;
1100}
1101
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102static int __init noresume_setup(char *str)
1103{
1104 noresume = 1;
1105 return 1;
1106}
1107
Barry Song6f8d7022011-10-06 20:34:46 +02001108static int __init resumewait_setup(char *str)
1109{
1110 resume_wait = 1;
1111 return 1;
1112}
1113
Barry Songf126f732011-10-10 23:38:41 +02001114static int __init resumedelay_setup(char *str)
1115{
1116 resume_delay = simple_strtoul(str, NULL, 0);
1117 return 1;
1118}
1119
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120__setup("noresume", noresume_setup);
Rafael J. Wysocki9a154d92006-12-06 20:34:12 -08001121__setup("resume_offset=", resume_offset_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122__setup("resume=", resume_setup);
Bojan Smojverf996fc92010-09-09 23:06:23 +02001123__setup("hibernate=", hibernate_setup);
Barry Song6f8d7022011-10-06 20:34:46 +02001124__setup("resumewait", resumewait_setup);
Barry Songf126f732011-10-10 23:38:41 +02001125__setup("resumedelay=", resumedelay_setup);