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