]>
Commit | Line | Data |
---|---|---|
a9d70523 RW |
1 | /* |
2 | * kernel/power/suspend.c - Suspend to RAM and standby functionality. | |
3 | * | |
4 | * Copyright (c) 2003 Patrick Mochel | |
5 | * Copyright (c) 2003 Open Source Development Lab | |
6 | * Copyright (c) 2009 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc. | |
7 | * | |
8 | * This file is released under the GPLv2. | |
9 | */ | |
10 | ||
142bce74 RW |
11 | #define pr_fmt(fmt) "PM: " fmt |
12 | ||
a9d70523 RW |
13 | #include <linux/string.h> |
14 | #include <linux/delay.h> | |
15 | #include <linux/errno.h> | |
16 | #include <linux/init.h> | |
17 | #include <linux/console.h> | |
18 | #include <linux/cpu.h> | |
f3f12532 | 19 | #include <linux/cpuidle.h> |
a9d70523 | 20 | #include <linux/syscalls.h> |
5a0e3ad6 | 21 | #include <linux/gfp.h> |
dd4c4f17 MG |
22 | #include <linux/io.h> |
23 | #include <linux/kernel.h> | |
24 | #include <linux/list.h> | |
25 | #include <linux/mm.h> | |
26 | #include <linux/slab.h> | |
6e5fdeed | 27 | #include <linux/export.h> |
dd4c4f17 | 28 | #include <linux/suspend.h> |
40dc166c | 29 | #include <linux/syscore_ops.h> |
443772d4 | 30 | #include <linux/ftrace.h> |
938cfed1 | 31 | #include <trace/events/power.h> |
52f5684c | 32 | #include <linux/compiler.h> |
1d4a9c17 | 33 | #include <linux/moduleparam.h> |
a9d70523 RW |
34 | |
35 | #include "power.h" | |
36 | ||
406e7938 | 37 | const char * const pm_labels[] = { |
690cbb90 | 38 | [PM_SUSPEND_TO_IDLE] = "freeze", |
406e7938 RW |
39 | [PM_SUSPEND_STANDBY] = "standby", |
40 | [PM_SUSPEND_MEM] = "mem", | |
41 | }; | |
d431cbc5 | 42 | const char *pm_states[PM_SUSPEND_MAX]; |
406e7938 | 43 | static const char * const mem_sleep_labels[] = { |
690cbb90 | 44 | [PM_SUSPEND_TO_IDLE] = "s2idle", |
406e7938 RW |
45 | [PM_SUSPEND_STANDBY] = "shallow", |
46 | [PM_SUSPEND_MEM] = "deep", | |
47 | }; | |
48 | const char *mem_sleep_states[PM_SUSPEND_MAX]; | |
49 | ||
690cbb90 | 50 | suspend_state_t mem_sleep_current = PM_SUSPEND_TO_IDLE; |
e870c6c8 | 51 | suspend_state_t mem_sleep_default = PM_SUSPEND_MAX; |
bd8c9ba3 FF |
52 | suspend_state_t pm_suspend_target_state; |
53 | EXPORT_SYMBOL_GPL(pm_suspend_target_state); | |
a9d70523 | 54 | |
ef25ba04 RW |
55 | unsigned int pm_suspend_global_flags; |
56 | EXPORT_SYMBOL_GPL(pm_suspend_global_flags); | |
57 | ||
2f55ac07 | 58 | static const struct platform_suspend_ops *suspend_ops; |
23d5855f | 59 | static const struct platform_s2idle_ops *s2idle_ops; |
f02f4f9d | 60 | static DECLARE_WAIT_QUEUE_HEAD(s2idle_wait_head); |
38106313 | 61 | |
f02f4f9d RW |
62 | enum s2idle_states __read_mostly s2idle_state; |
63 | static DEFINE_SPINLOCK(s2idle_lock); | |
7e73c5ae | 64 | |
23d5855f | 65 | void s2idle_set_ops(const struct platform_s2idle_ops *ops) |
1f0b6386 RW |
66 | { |
67 | lock_system_sleep(); | |
23d5855f | 68 | s2idle_ops = ops; |
1f0b6386 RW |
69 | unlock_system_sleep(); |
70 | } | |
71 | ||
f02f4f9d | 72 | static void s2idle_begin(void) |
7e73c5ae | 73 | { |
f02f4f9d | 74 | s2idle_state = S2IDLE_STATE_NONE; |
7e73c5ae ZR |
75 | } |
76 | ||
f02f4f9d | 77 | static void s2idle_enter(void) |
7e73c5ae | 78 | { |
690cbb90 | 79 | trace_suspend_resume(TPS("machine_suspend"), PM_SUSPEND_TO_IDLE, true); |
33e4f80e | 80 | |
f02f4f9d | 81 | spin_lock_irq(&s2idle_lock); |
38106313 RW |
82 | if (pm_wakeup_pending()) |
83 | goto out; | |
84 | ||
f02f4f9d RW |
85 | s2idle_state = S2IDLE_STATE_ENTER; |
86 | spin_unlock_irq(&s2idle_lock); | |
38106313 RW |
87 | |
88 | get_online_cpus(); | |
f3f12532 | 89 | cpuidle_resume(); |
38106313 RW |
90 | |
91 | /* Push all the CPUs into the idle loop. */ | |
92 | wake_up_all_idle_cpus(); | |
38106313 | 93 | /* Make the current CPU wait so it can enter the idle loop too. */ |
f02f4f9d RW |
94 | wait_event(s2idle_wait_head, |
95 | s2idle_state == S2IDLE_STATE_WAKE); | |
38106313 | 96 | |
f3f12532 | 97 | cpuidle_pause(); |
38106313 RW |
98 | put_online_cpus(); |
99 | ||
f02f4f9d | 100 | spin_lock_irq(&s2idle_lock); |
38106313 RW |
101 | |
102 | out: | |
f02f4f9d RW |
103 | s2idle_state = S2IDLE_STATE_NONE; |
104 | spin_unlock_irq(&s2idle_lock); | |
33e4f80e | 105 | |
690cbb90 | 106 | trace_suspend_resume(TPS("machine_suspend"), PM_SUSPEND_TO_IDLE, false); |
33e4f80e RW |
107 | } |
108 | ||
109 | static void s2idle_loop(void) | |
110 | { | |
8d8b2441 | 111 | pm_pr_dbg("suspend-to-idle\n"); |
33e4f80e | 112 | |
9a3ebe35 RW |
113 | for (;;) { |
114 | int error; | |
115 | ||
116 | dpm_noirq_begin(); | |
117 | ||
8e6bcd9f RW |
118 | /* |
119 | * Suspend-to-idle equals | |
120 | * frozen processes + suspended devices + idle processors. | |
f02f4f9d | 121 | * Thus s2idle_enter() should be called right after |
8e6bcd9f | 122 | * all devices have been suspended. |
87cbde8d RW |
123 | * |
124 | * Wakeups during the noirq suspend of devices may be spurious, | |
125 | * so prevent them from terminating the loop right away. | |
8e6bcd9f | 126 | */ |
9a3ebe35 RW |
127 | error = dpm_noirq_suspend_devices(PMSG_SUSPEND); |
128 | if (!error) | |
f02f4f9d | 129 | s2idle_enter(); |
87cbde8d RW |
130 | else if (error == -EBUSY && pm_wakeup_pending()) |
131 | error = 0; | |
9a3ebe35 | 132 | |
87cbde8d | 133 | if (!error && s2idle_ops && s2idle_ops->wake) |
23d5855f | 134 | s2idle_ops->wake(); |
33e4f80e | 135 | |
87cbde8d RW |
136 | dpm_noirq_resume_devices(PMSG_RESUME); |
137 | ||
9a3ebe35 RW |
138 | dpm_noirq_end(); |
139 | ||
87cbde8d RW |
140 | if (error) |
141 | break; | |
142 | ||
23d5855f RW |
143 | if (s2idle_ops && s2idle_ops->sync) |
144 | s2idle_ops->sync(); | |
33e4f80e RW |
145 | |
146 | if (pm_wakeup_pending()) | |
147 | break; | |
148 | ||
149 | pm_wakeup_clear(false); | |
8e6bcd9f | 150 | } |
33e4f80e | 151 | |
8d8b2441 | 152 | pm_pr_dbg("resume from suspend-to-idle\n"); |
7e73c5ae ZR |
153 | } |
154 | ||
f02f4f9d | 155 | void s2idle_wake(void) |
7e73c5ae | 156 | { |
38106313 RW |
157 | unsigned long flags; |
158 | ||
f02f4f9d RW |
159 | spin_lock_irqsave(&s2idle_lock, flags); |
160 | if (s2idle_state > S2IDLE_STATE_NONE) { | |
161 | s2idle_state = S2IDLE_STATE_WAKE; | |
162 | wake_up(&s2idle_wait_head); | |
38106313 | 163 | } |
f02f4f9d | 164 | spin_unlock_irqrestore(&s2idle_lock, flags); |
7e73c5ae | 165 | } |
f02f4f9d | 166 | EXPORT_SYMBOL_GPL(s2idle_wake); |
7e73c5ae | 167 | |
43e8317b RW |
168 | static bool valid_state(suspend_state_t state) |
169 | { | |
170 | /* | |
171 | * PM_SUSPEND_STANDBY and PM_SUSPEND_MEM states need low level | |
172 | * support and need to be valid to the low level | |
173 | * implementation, no valid callback implies that none are valid. | |
174 | */ | |
175 | return suspend_ops && suspend_ops->valid && suspend_ops->valid(state); | |
176 | } | |
177 | ||
fa7fd6fa SH |
178 | void __init pm_states_init(void) |
179 | { | |
406e7938 RW |
180 | /* "mem" and "freeze" are always present in /sys/power/state. */ |
181 | pm_states[PM_SUSPEND_MEM] = pm_labels[PM_SUSPEND_MEM]; | |
690cbb90 | 182 | pm_states[PM_SUSPEND_TO_IDLE] = pm_labels[PM_SUSPEND_TO_IDLE]; |
fa7fd6fa | 183 | /* |
406e7938 RW |
184 | * Suspend-to-idle should be supported even without any suspend_ops, |
185 | * initialize mem_sleep_states[] accordingly here. | |
fa7fd6fa | 186 | */ |
690cbb90 | 187 | mem_sleep_states[PM_SUSPEND_TO_IDLE] = mem_sleep_labels[PM_SUSPEND_TO_IDLE]; |
fa7fd6fa SH |
188 | } |
189 | ||
406e7938 | 190 | static int __init mem_sleep_default_setup(char *str) |
0399d4db | 191 | { |
406e7938 RW |
192 | suspend_state_t state; |
193 | ||
690cbb90 | 194 | for (state = PM_SUSPEND_TO_IDLE; state <= PM_SUSPEND_MEM; state++) |
406e7938 RW |
195 | if (mem_sleep_labels[state] && |
196 | !strcmp(str, mem_sleep_labels[state])) { | |
197 | mem_sleep_default = state; | |
198 | break; | |
199 | } | |
200 | ||
0399d4db RW |
201 | return 1; |
202 | } | |
406e7938 | 203 | __setup("mem_sleep_default=", mem_sleep_default_setup); |
0399d4db | 204 | |
a9d70523 | 205 | /** |
55ae4519 RW |
206 | * suspend_set_ops - Set the global suspend method table. |
207 | * @ops: Suspend operations to use. | |
a9d70523 | 208 | */ |
2f55ac07 | 209 | void suspend_set_ops(const struct platform_suspend_ops *ops) |
a9d70523 | 210 | { |
bcda53fa | 211 | lock_system_sleep(); |
43e8317b | 212 | |
a9d70523 | 213 | suspend_ops = ops; |
0399d4db | 214 | |
406e7938 RW |
215 | if (valid_state(PM_SUSPEND_STANDBY)) { |
216 | mem_sleep_states[PM_SUSPEND_STANDBY] = mem_sleep_labels[PM_SUSPEND_STANDBY]; | |
217 | pm_states[PM_SUSPEND_STANDBY] = pm_labels[PM_SUSPEND_STANDBY]; | |
218 | if (mem_sleep_default == PM_SUSPEND_STANDBY) | |
219 | mem_sleep_current = PM_SUSPEND_STANDBY; | |
220 | } | |
221 | if (valid_state(PM_SUSPEND_MEM)) { | |
222 | mem_sleep_states[PM_SUSPEND_MEM] = mem_sleep_labels[PM_SUSPEND_MEM]; | |
e870c6c8 | 223 | if (mem_sleep_default >= PM_SUSPEND_MEM) |
406e7938 RW |
224 | mem_sleep_current = PM_SUSPEND_MEM; |
225 | } | |
43e8317b | 226 | |
bcda53fa | 227 | unlock_system_sleep(); |
a9d70523 | 228 | } |
a5e4fd87 | 229 | EXPORT_SYMBOL_GPL(suspend_set_ops); |
a9d70523 | 230 | |
a9d70523 | 231 | /** |
55ae4519 | 232 | * suspend_valid_only_mem - Generic memory-only valid callback. |
a9d70523 | 233 | * |
55ae4519 RW |
234 | * Platform drivers that implement mem suspend only and only need to check for |
235 | * that in their .valid() callback can use this instead of rolling their own | |
236 | * .valid() callback. | |
a9d70523 RW |
237 | */ |
238 | int suspend_valid_only_mem(suspend_state_t state) | |
239 | { | |
240 | return state == PM_SUSPEND_MEM; | |
241 | } | |
a5e4fd87 | 242 | EXPORT_SYMBOL_GPL(suspend_valid_only_mem); |
a9d70523 | 243 | |
8490fdf9 RW |
244 | static bool sleep_state_supported(suspend_state_t state) |
245 | { | |
690cbb90 | 246 | return state == PM_SUSPEND_TO_IDLE || (suspend_ops && suspend_ops->enter); |
8490fdf9 RW |
247 | } |
248 | ||
249 | static int platform_suspend_prepare(suspend_state_t state) | |
250 | { | |
690cbb90 | 251 | return state != PM_SUSPEND_TO_IDLE && suspend_ops->prepare ? |
8490fdf9 RW |
252 | suspend_ops->prepare() : 0; |
253 | } | |
254 | ||
a8d46b9e RW |
255 | static int platform_suspend_prepare_late(suspend_state_t state) |
256 | { | |
23d5855f RW |
257 | return state == PM_SUSPEND_TO_IDLE && s2idle_ops && s2idle_ops->prepare ? |
258 | s2idle_ops->prepare() : 0; | |
a8d46b9e RW |
259 | } |
260 | ||
ebc3e41e | 261 | static int platform_suspend_prepare_noirq(suspend_state_t state) |
8490fdf9 | 262 | { |
690cbb90 | 263 | return state != PM_SUSPEND_TO_IDLE && suspend_ops->prepare_late ? |
8490fdf9 RW |
264 | suspend_ops->prepare_late() : 0; |
265 | } | |
266 | ||
ebc3e41e | 267 | static void platform_resume_noirq(suspend_state_t state) |
8490fdf9 | 268 | { |
690cbb90 | 269 | if (state != PM_SUSPEND_TO_IDLE && suspend_ops->wake) |
8490fdf9 RW |
270 | suspend_ops->wake(); |
271 | } | |
272 | ||
a8d46b9e RW |
273 | static void platform_resume_early(suspend_state_t state) |
274 | { | |
23d5855f RW |
275 | if (state == PM_SUSPEND_TO_IDLE && s2idle_ops && s2idle_ops->restore) |
276 | s2idle_ops->restore(); | |
a8d46b9e RW |
277 | } |
278 | ||
ebc3e41e | 279 | static void platform_resume_finish(suspend_state_t state) |
8490fdf9 | 280 | { |
690cbb90 | 281 | if (state != PM_SUSPEND_TO_IDLE && suspend_ops->finish) |
8490fdf9 RW |
282 | suspend_ops->finish(); |
283 | } | |
284 | ||
285 | static int platform_suspend_begin(suspend_state_t state) | |
286 | { | |
23d5855f RW |
287 | if (state == PM_SUSPEND_TO_IDLE && s2idle_ops && s2idle_ops->begin) |
288 | return s2idle_ops->begin(); | |
fa7fd6fa | 289 | else if (suspend_ops && suspend_ops->begin) |
8490fdf9 RW |
290 | return suspend_ops->begin(state); |
291 | else | |
292 | return 0; | |
293 | } | |
294 | ||
ebc3e41e | 295 | static void platform_resume_end(suspend_state_t state) |
8490fdf9 | 296 | { |
23d5855f RW |
297 | if (state == PM_SUSPEND_TO_IDLE && s2idle_ops && s2idle_ops->end) |
298 | s2idle_ops->end(); | |
fa7fd6fa | 299 | else if (suspend_ops && suspend_ops->end) |
8490fdf9 RW |
300 | suspend_ops->end(); |
301 | } | |
302 | ||
ebc3e41e | 303 | static void platform_recover(suspend_state_t state) |
8490fdf9 | 304 | { |
690cbb90 | 305 | if (state != PM_SUSPEND_TO_IDLE && suspend_ops->recover) |
8490fdf9 RW |
306 | suspend_ops->recover(); |
307 | } | |
308 | ||
309 | static bool platform_suspend_again(suspend_state_t state) | |
310 | { | |
690cbb90 | 311 | return state != PM_SUSPEND_TO_IDLE && suspend_ops->suspend_again ? |
8490fdf9 RW |
312 | suspend_ops->suspend_again() : false; |
313 | } | |
314 | ||
1d4a9c17 BN |
315 | #ifdef CONFIG_PM_DEBUG |
316 | static unsigned int pm_test_delay = 5; | |
317 | module_param(pm_test_delay, uint, 0644); | |
318 | MODULE_PARM_DESC(pm_test_delay, | |
319 | "Number of seconds to wait before resuming from suspend test"); | |
320 | #endif | |
321 | ||
a9d70523 RW |
322 | static int suspend_test(int level) |
323 | { | |
324 | #ifdef CONFIG_PM_DEBUG | |
325 | if (pm_test_level == level) { | |
22e09b33 | 326 | pr_info("suspend debug: Waiting for %d second(s).\n", |
1d4a9c17 BN |
327 | pm_test_delay); |
328 | mdelay(pm_test_delay * 1000); | |
a9d70523 RW |
329 | return 1; |
330 | } | |
331 | #endif /* !CONFIG_PM_DEBUG */ | |
332 | return 0; | |
333 | } | |
334 | ||
335 | /** | |
55ae4519 | 336 | * suspend_prepare - Prepare for entering system sleep state. |
a9d70523 | 337 | * |
55ae4519 RW |
338 | * Common code run for every system sleep state that can be entered (except for |
339 | * hibernation). Run suspend notifiers, allocate the "suspend" console and | |
340 | * freeze processes. | |
a9d70523 | 341 | */ |
7e73c5ae | 342 | static int suspend_prepare(suspend_state_t state) |
a9d70523 | 343 | { |
ea00f4f4 | 344 | int error, nr_calls = 0; |
a9d70523 | 345 | |
8490fdf9 | 346 | if (!sleep_state_supported(state)) |
a9d70523 RW |
347 | return -EPERM; |
348 | ||
349 | pm_prepare_console(); | |
350 | ||
ea00f4f4 LW |
351 | error = __pm_notifier_call_chain(PM_SUSPEND_PREPARE, -1, &nr_calls); |
352 | if (error) { | |
353 | nr_calls--; | |
a9d70523 | 354 | goto Finish; |
ea00f4f4 | 355 | } |
a9d70523 | 356 | |
bb3632c6 | 357 | trace_suspend_resume(TPS("freeze_processes"), 0, true); |
a9d70523 | 358 | error = suspend_freeze_processes(); |
bb3632c6 | 359 | trace_suspend_resume(TPS("freeze_processes"), 0, false); |
03afed8b | 360 | if (!error) |
a9d70523 RW |
361 | return 0; |
362 | ||
03afed8b TH |
363 | suspend_stats.failed_freeze++; |
364 | dpm_save_failed_step(SUSPEND_FREEZE); | |
a9d70523 | 365 | Finish: |
ea00f4f4 | 366 | __pm_notifier_call_chain(PM_POST_SUSPEND, nr_calls, NULL); |
a9d70523 RW |
367 | pm_restore_console(); |
368 | return error; | |
369 | } | |
370 | ||
371 | /* default implementation */ | |
52f5684c | 372 | void __weak arch_suspend_disable_irqs(void) |
a9d70523 RW |
373 | { |
374 | local_irq_disable(); | |
375 | } | |
376 | ||
377 | /* default implementation */ | |
52f5684c | 378 | void __weak arch_suspend_enable_irqs(void) |
a9d70523 RW |
379 | { |
380 | local_irq_enable(); | |
381 | } | |
382 | ||
383 | /** | |
55ae4519 RW |
384 | * suspend_enter - Make the system enter the given sleep state. |
385 | * @state: System sleep state to enter. | |
386 | * @wakeup: Returns information that the sleep state should not be re-entered. | |
a9d70523 | 387 | * |
3b5fe852 | 388 | * This function should be called after devices have been suspended. |
a9d70523 | 389 | */ |
3b5fe852 | 390 | static int suspend_enter(suspend_state_t state, bool *wakeup) |
a9d70523 RW |
391 | { |
392 | int error; | |
393 | ||
8490fdf9 RW |
394 | error = platform_suspend_prepare(state); |
395 | if (error) | |
396 | goto Platform_finish; | |
a9d70523 | 397 | |
2a8a8ce6 | 398 | error = dpm_suspend_late(PMSG_SUSPEND); |
a9d70523 | 399 | if (error) { |
142bce74 | 400 | pr_err("late suspend of devices failed\n"); |
ce441011 | 401 | goto Platform_finish; |
a9d70523 | 402 | } |
a8d46b9e RW |
403 | error = platform_suspend_prepare_late(state); |
404 | if (error) | |
405 | goto Devices_early_resume; | |
406 | ||
690cbb90 | 407 | if (state == PM_SUSPEND_TO_IDLE && pm_test_level != TEST_PLATFORM) { |
8e6bcd9f RW |
408 | s2idle_loop(); |
409 | goto Platform_early_resume; | |
410 | } | |
411 | ||
2a8a8ce6 RW |
412 | error = dpm_suspend_noirq(PMSG_SUSPEND); |
413 | if (error) { | |
142bce74 | 414 | pr_err("noirq suspend of devices failed\n"); |
a8d46b9e | 415 | goto Platform_early_resume; |
2a8a8ce6 | 416 | } |
ebc3e41e | 417 | error = platform_suspend_prepare_noirq(state); |
8490fdf9 RW |
418 | if (error) |
419 | goto Platform_wake; | |
a9d70523 | 420 | |
08605acc ZR |
421 | if (suspend_test(TEST_PLATFORM)) |
422 | goto Platform_wake; | |
423 | ||
a9d70523 RW |
424 | error = disable_nonboot_cpus(); |
425 | if (error || suspend_test(TEST_CPUS)) | |
426 | goto Enable_cpus; | |
427 | ||
428 | arch_suspend_disable_irqs(); | |
429 | BUG_ON(!irqs_disabled()); | |
430 | ||
2e711c04 | 431 | error = syscore_suspend(); |
a9d70523 | 432 | if (!error) { |
3b5fe852 MH |
433 | *wakeup = pm_wakeup_pending(); |
434 | if (!(suspend_test(TEST_CORE) || *wakeup)) { | |
bb3632c6 TB |
435 | trace_suspend_resume(TPS("machine_suspend"), |
436 | state, true); | |
a9d70523 | 437 | error = suspend_ops->enter(state); |
bb3632c6 TB |
438 | trace_suspend_resume(TPS("machine_suspend"), |
439 | state, false); | |
c125e96f | 440 | events_check_enabled = false; |
67176736 RK |
441 | } else if (*wakeup) { |
442 | error = -EBUSY; | |
c125e96f | 443 | } |
40dc166c | 444 | syscore_resume(); |
a9d70523 RW |
445 | } |
446 | ||
447 | arch_suspend_enable_irqs(); | |
448 | BUG_ON(irqs_disabled()); | |
449 | ||
450 | Enable_cpus: | |
451 | enable_nonboot_cpus(); | |
452 | ||
453 | Platform_wake: | |
ebc3e41e | 454 | platform_resume_noirq(state); |
2a8a8ce6 RW |
455 | dpm_resume_noirq(PMSG_RESUME); |
456 | ||
a8d46b9e RW |
457 | Platform_early_resume: |
458 | platform_resume_early(state); | |
459 | ||
2a8a8ce6 RW |
460 | Devices_early_resume: |
461 | dpm_resume_early(PMSG_RESUME); | |
a9d70523 | 462 | |
ce441011 | 463 | Platform_finish: |
ebc3e41e | 464 | platform_resume_finish(state); |
a9d70523 RW |
465 | return error; |
466 | } | |
467 | ||
468 | /** | |
55ae4519 RW |
469 | * suspend_devices_and_enter - Suspend devices and enter system sleep state. |
470 | * @state: System sleep state to enter. | |
a9d70523 RW |
471 | */ |
472 | int suspend_devices_and_enter(suspend_state_t state) | |
473 | { | |
474 | int error; | |
3b5fe852 | 475 | bool wakeup = false; |
a9d70523 | 476 | |
8490fdf9 | 477 | if (!sleep_state_supported(state)) |
a9d70523 RW |
478 | return -ENOSYS; |
479 | ||
bd8c9ba3 FF |
480 | pm_suspend_target_state = state; |
481 | ||
8490fdf9 RW |
482 | error = platform_suspend_begin(state); |
483 | if (error) | |
484 | goto Close; | |
485 | ||
a9d70523 RW |
486 | suspend_console(); |
487 | suspend_test_start(); | |
488 | error = dpm_suspend_start(PMSG_SUSPEND); | |
489 | if (error) { | |
142bce74 | 490 | pr_err("Some devices failed to suspend, or early wake event detected\n"); |
a9d70523 RW |
491 | goto Recover_platform; |
492 | } | |
493 | suspend_test_finish("suspend devices"); | |
494 | if (suspend_test(TEST_DEVICES)) | |
495 | goto Recover_platform; | |
496 | ||
3b5fe852 MH |
497 | do { |
498 | error = suspend_enter(state, &wakeup); | |
8490fdf9 | 499 | } while (!error && !wakeup && platform_suspend_again(state)); |
a9d70523 RW |
500 | |
501 | Resume_devices: | |
502 | suspend_test_start(); | |
503 | dpm_resume_end(PMSG_RESUME); | |
504 | suspend_test_finish("resume devices"); | |
0cadc702 | 505 | trace_suspend_resume(TPS("resume_console"), state, true); |
a9d70523 | 506 | resume_console(); |
0cadc702 | 507 | trace_suspend_resume(TPS("resume_console"), state, false); |
1f0b6386 | 508 | |
8490fdf9 | 509 | Close: |
ebc3e41e | 510 | platform_resume_end(state); |
bd8c9ba3 | 511 | pm_suspend_target_state = PM_SUSPEND_ON; |
a9d70523 RW |
512 | return error; |
513 | ||
514 | Recover_platform: | |
ebc3e41e | 515 | platform_recover(state); |
a9d70523 RW |
516 | goto Resume_devices; |
517 | } | |
518 | ||
519 | /** | |
55ae4519 | 520 | * suspend_finish - Clean up before finishing the suspend sequence. |
a9d70523 | 521 | * |
55ae4519 RW |
522 | * Call platform code to clean up, restart processes, and free the console that |
523 | * we've allocated. This routine is not called for hibernation. | |
a9d70523 RW |
524 | */ |
525 | static void suspend_finish(void) | |
526 | { | |
527 | suspend_thaw_processes(); | |
a9d70523 RW |
528 | pm_notifier_call_chain(PM_POST_SUSPEND); |
529 | pm_restore_console(); | |
530 | } | |
531 | ||
532 | /** | |
55ae4519 RW |
533 | * enter_state - Do common work needed to enter system sleep state. |
534 | * @state: System sleep state to enter. | |
a9d70523 | 535 | * |
55ae4519 RW |
536 | * Make sure that no one else is trying to put the system into a sleep state. |
537 | * Fail if that's not the case. Otherwise, prepare for system suspend, make the | |
538 | * system enter the given sleep state and clean up after wakeup. | |
a9d70523 | 539 | */ |
93e1ee43 | 540 | static int enter_state(suspend_state_t state) |
a9d70523 RW |
541 | { |
542 | int error; | |
543 | ||
bb3632c6 | 544 | trace_suspend_resume(TPS("suspend_enter"), state, true); |
690cbb90 | 545 | if (state == PM_SUSPEND_TO_IDLE) { |
43e8317b RW |
546 | #ifdef CONFIG_PM_DEBUG |
547 | if (pm_test_level != TEST_NONE && pm_test_level <= TEST_CPUS) { | |
142bce74 | 548 | pr_warn("Unsupported test mode for suspend to idle, please choose none/freezer/devices/platform.\n"); |
43e8317b RW |
549 | return -EAGAIN; |
550 | } | |
551 | #endif | |
552 | } else if (!valid_state(state)) { | |
553 | return -EINVAL; | |
554 | } | |
a9d70523 RW |
555 | if (!mutex_trylock(&pm_mutex)) |
556 | return -EBUSY; | |
557 | ||
690cbb90 | 558 | if (state == PM_SUSPEND_TO_IDLE) |
f02f4f9d | 559 | s2idle_begin(); |
7e73c5ae | 560 | |
2fd77fff | 561 | #ifndef CONFIG_SUSPEND_SKIP_SYNC |
bb3632c6 | 562 | trace_suspend_resume(TPS("sync_filesystems"), 0, true); |
142bce74 | 563 | pr_info("Syncing filesystems ... "); |
a9d70523 | 564 | sys_sync(); |
1adb469b | 565 | pr_cont("done.\n"); |
bb3632c6 | 566 | trace_suspend_resume(TPS("sync_filesystems"), 0, false); |
2fd77fff | 567 | #endif |
a9d70523 | 568 | |
bebcdae3 | 569 | pm_pr_dbg("Preparing system for sleep (%s)\n", mem_sleep_labels[state]); |
ef25ba04 | 570 | pm_suspend_clear_flags(); |
7e73c5ae | 571 | error = suspend_prepare(state); |
a9d70523 RW |
572 | if (error) |
573 | goto Unlock; | |
574 | ||
575 | if (suspend_test(TEST_FREEZER)) | |
576 | goto Finish; | |
577 | ||
bb3632c6 | 578 | trace_suspend_resume(TPS("suspend_enter"), state, false); |
bebcdae3 | 579 | pm_pr_dbg("Suspending system (%s)\n", mem_sleep_labels[state]); |
87186475 | 580 | pm_restrict_gfp_mask(); |
a9d70523 | 581 | error = suspend_devices_and_enter(state); |
87186475 | 582 | pm_restore_gfp_mask(); |
a9d70523 RW |
583 | |
584 | Finish: | |
8d8b2441 | 585 | pm_pr_dbg("Finishing wakeup.\n"); |
a9d70523 RW |
586 | suspend_finish(); |
587 | Unlock: | |
588 | mutex_unlock(&pm_mutex); | |
589 | return error; | |
590 | } | |
591 | ||
592 | /** | |
55ae4519 RW |
593 | * pm_suspend - Externally visible function for suspending the system. |
594 | * @state: System sleep state to enter. | |
a9d70523 | 595 | * |
55ae4519 RW |
596 | * Check if the value of @state represents one of the supported states, |
597 | * execute enter_state() and update system suspend statistics. | |
a9d70523 RW |
598 | */ |
599 | int pm_suspend(suspend_state_t state) | |
600 | { | |
bc25cf50 RW |
601 | int error; |
602 | ||
603 | if (state <= PM_SUSPEND_ON || state >= PM_SUSPEND_MAX) | |
604 | return -EINVAL; | |
605 | ||
142bce74 | 606 | pr_info("suspend entry (%s)\n", mem_sleep_labels[state]); |
bc25cf50 RW |
607 | error = enter_state(state); |
608 | if (error) { | |
609 | suspend_stats.fail++; | |
610 | dpm_save_failed_errno(error); | |
611 | } else { | |
612 | suspend_stats.success++; | |
2a77c46d | 613 | } |
142bce74 | 614 | pr_info("suspend exit\n"); |
bc25cf50 | 615 | return error; |
a9d70523 RW |
616 | } |
617 | EXPORT_SYMBOL(pm_suspend); |