2 * kernel/power/main.c - PM subsystem core functionality.
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
7 * This file is released under the GPLv2
11 #include <linux/module.h>
12 #include <linux/suspend.h>
13 #include <linux/kobject.h>
14 #include <linux/string.h>
15 #include <linux/delay.h>
16 #include <linux/errno.h>
17 #include <linux/init.h>
18 #include <linux/console.h>
19 #include <linux/cpu.h>
20 #include <linux/resume-trace.h>
21 #include <linux/freezer.h>
22 #include <linux/vmstat.h>
23 #include <linux/syscalls.h>
27 DEFINE_MUTEX(pm_mutex
);
29 unsigned int pm_flags
;
30 EXPORT_SYMBOL(pm_flags
);
32 #ifdef CONFIG_PM_SLEEP
34 /* Routines for PM-transition notifications */
36 static BLOCKING_NOTIFIER_HEAD(pm_chain_head
);
38 int register_pm_notifier(struct notifier_block
*nb
)
40 return blocking_notifier_chain_register(&pm_chain_head
, nb
);
42 EXPORT_SYMBOL_GPL(register_pm_notifier
);
44 int unregister_pm_notifier(struct notifier_block
*nb
)
46 return blocking_notifier_chain_unregister(&pm_chain_head
, nb
);
48 EXPORT_SYMBOL_GPL(unregister_pm_notifier
);
50 int pm_notifier_call_chain(unsigned long val
)
52 return (blocking_notifier_call_chain(&pm_chain_head
, val
, NULL
)
53 == NOTIFY_BAD
) ? -EINVAL
: 0;
56 #endif /* CONFIG_PM_SLEEP */
60 #ifdef CONFIG_PM_DEBUG
61 int pm_test_level
= TEST_NONE
;
63 static int suspend_test(int level
)
65 if (pm_test_level
== level
) {
66 printk(KERN_INFO
"suspend debug: Waiting for 5 seconds.\n");
73 static const char * const pm_tests
[__TEST_AFTER_LAST
] = {
76 [TEST_CPUS
] = "processors",
77 [TEST_PLATFORM
] = "platform",
78 [TEST_DEVICES
] = "devices",
79 [TEST_FREEZER
] = "freezer",
82 static ssize_t
pm_test_show(struct kobject
*kobj
, struct kobj_attribute
*attr
,
88 for (level
= TEST_FIRST
; level
<= TEST_MAX
; level
++)
89 if (pm_tests
[level
]) {
90 if (level
== pm_test_level
)
91 s
+= sprintf(s
, "[%s] ", pm_tests
[level
]);
93 s
+= sprintf(s
, "%s ", pm_tests
[level
]);
97 /* convert the last space to a newline */
103 static ssize_t
pm_test_store(struct kobject
*kobj
, struct kobj_attribute
*attr
,
104 const char *buf
, size_t n
)
106 const char * const *s
;
112 p
= memchr(buf
, '\n', n
);
113 len
= p
? p
- buf
: n
;
115 mutex_lock(&pm_mutex
);
118 for (s
= &pm_tests
[level
]; level
<= TEST_MAX
; s
++, level
++)
119 if (*s
&& len
== strlen(*s
) && !strncmp(buf
, *s
, len
)) {
120 pm_test_level
= level
;
125 mutex_unlock(&pm_mutex
);
127 return error
? error
: n
;
131 #else /* !CONFIG_PM_DEBUG */
132 static inline int suspend_test(int level
) { return 0; }
133 #endif /* !CONFIG_PM_DEBUG */
136 #ifdef CONFIG_SUSPEND
138 /* This is just an arbitrary number */
139 #define FREE_PAGE_NUMBER (100)
141 static struct platform_suspend_ops
*suspend_ops
;
144 * suspend_set_ops - Set the global suspend method table.
145 * @ops: Pointer to ops structure.
148 void suspend_set_ops(struct platform_suspend_ops
*ops
)
150 mutex_lock(&pm_mutex
);
152 mutex_unlock(&pm_mutex
);
156 * suspend_valid_only_mem - generic memory-only valid callback
158 * Platform drivers that implement mem suspend only and only need
159 * to check for that in their .valid callback can use this instead
160 * of rolling their own .valid callback.
162 int suspend_valid_only_mem(suspend_state_t state
)
164 return state
== PM_SUSPEND_MEM
;
168 * suspend_prepare - Do prep work before entering low-power state.
170 * This is common code that is called for each state that we're entering.
171 * Run suspend notifiers, allocate a console and stop all processes.
173 static int suspend_prepare(void)
176 unsigned int free_pages
;
178 if (!suspend_ops
|| !suspend_ops
->enter
)
181 error
= pm_notifier_call_chain(PM_SUSPEND_PREPARE
);
185 pm_prepare_console();
187 if (freeze_processes()) {
192 free_pages
= global_page_state(NR_FREE_PAGES
);
193 if (free_pages
< FREE_PAGE_NUMBER
) {
194 pr_debug("PM: free some memory\n");
195 shrink_all_memory(FREE_PAGE_NUMBER
- free_pages
);
196 if (nr_free_pages() < FREE_PAGE_NUMBER
) {
198 printk(KERN_ERR
"PM: No enough memory\n");
206 pm_restore_console();
208 pm_notifier_call_chain(PM_POST_SUSPEND
);
212 /* default implementation */
213 void __attribute__ ((weak
)) arch_suspend_disable_irqs(void)
218 /* default implementation */
219 void __attribute__ ((weak
)) arch_suspend_enable_irqs(void)
225 * suspend_enter - enter the desired system sleep state.
226 * @state: state to enter
228 * This function should be called after devices have been suspended.
230 static int suspend_enter(suspend_state_t state
)
234 arch_suspend_disable_irqs();
235 BUG_ON(!irqs_disabled());
237 if ((error
= device_power_down(PMSG_SUSPEND
))) {
238 printk(KERN_ERR
"Some devices failed to power down\n");
242 if (!suspend_test(TEST_CORE
))
243 error
= suspend_ops
->enter(state
);
247 arch_suspend_enable_irqs();
248 BUG_ON(irqs_disabled());
253 * suspend_devices_and_enter - suspend devices and enter the desired system
255 * @state: state to enter
257 int suspend_devices_and_enter(suspend_state_t state
)
264 if (suspend_ops
->set_target
) {
265 error
= suspend_ops
->set_target(state
);
270 error
= device_suspend(PMSG_SUSPEND
);
272 printk(KERN_ERR
"Some devices failed to suspend\n");
276 if (suspend_test(TEST_DEVICES
))
279 if (suspend_ops
->prepare
) {
280 error
= suspend_ops
->prepare();
285 if (suspend_test(TEST_PLATFORM
))
288 error
= disable_nonboot_cpus();
289 if (!error
&& !suspend_test(TEST_CPUS
))
290 suspend_enter(state
);
292 enable_nonboot_cpus();
294 if (suspend_ops
->finish
)
295 suspend_ops
->finish();
304 * suspend_finish - Do final work before exiting suspend sequence.
306 * Call platform code to clean up, restart processes, and free the
307 * console that we've allocated. This is not called for suspend-to-disk.
309 static void suspend_finish(void)
312 pm_restore_console();
313 pm_notifier_call_chain(PM_POST_SUSPEND
);
319 static const char * const pm_states
[PM_SUSPEND_MAX
] = {
320 [PM_SUSPEND_STANDBY
] = "standby",
321 [PM_SUSPEND_MEM
] = "mem",
324 static inline int valid_state(suspend_state_t state
)
326 /* All states need lowlevel support and need to be valid
327 * to the lowlevel implementation, no valid callback
328 * implies that none are valid. */
329 if (!suspend_ops
|| !suspend_ops
->valid
|| !suspend_ops
->valid(state
))
336 * enter_state - Do common work of entering low-power state.
337 * @state: pm_state structure for state we're entering.
339 * Make sure we're the only ones trying to enter a sleep state. Fail
340 * if someone has beat us to it, since we don't want anything weird to
341 * happen when we wake up.
342 * Then, do the setup for suspend, enter the state, and cleaup (after
345 static int enter_state(suspend_state_t state
)
349 if (!valid_state(state
))
352 if (!mutex_trylock(&pm_mutex
))
355 printk("Syncing filesystems ... ");
359 pr_debug("PM: Preparing system for %s sleep\n", pm_states
[state
]);
360 error
= suspend_prepare();
364 if (suspend_test(TEST_FREEZER
))
367 pr_debug("PM: Entering %s sleep\n", pm_states
[state
]);
368 error
= suspend_devices_and_enter(state
);
371 pr_debug("PM: Finishing wakeup.\n");
374 mutex_unlock(&pm_mutex
);
380 * pm_suspend - Externally visible function for suspending system.
381 * @state: Enumerated value of state to enter.
383 * Determine whether or not value is within range, get state
384 * structure, and enter (above).
387 int pm_suspend(suspend_state_t state
)
389 if (state
> PM_SUSPEND_ON
&& state
<= PM_SUSPEND_MAX
)
390 return enter_state(state
);
394 EXPORT_SYMBOL(pm_suspend
);
396 #endif /* CONFIG_SUSPEND */
398 struct kobject
*power_kobj
;
401 * state - control system power state.
403 * show() returns what states are supported, which is hard-coded to
404 * 'standby' (Power-On Suspend), 'mem' (Suspend-to-RAM), and
405 * 'disk' (Suspend-to-Disk).
407 * store() accepts one of those strings, translates it into the
408 * proper enumerated value, and initiates a suspend transition.
411 static ssize_t
state_show(struct kobject
*kobj
, struct kobj_attribute
*attr
,
415 #ifdef CONFIG_SUSPEND
418 for (i
= 0; i
< PM_SUSPEND_MAX
; i
++) {
419 if (pm_states
[i
] && valid_state(i
))
420 s
+= sprintf(s
,"%s ", pm_states
[i
]);
423 #ifdef CONFIG_HIBERNATION
424 s
+= sprintf(s
, "%s\n", "disk");
427 /* convert the last space to a newline */
433 static ssize_t
state_store(struct kobject
*kobj
, struct kobj_attribute
*attr
,
434 const char *buf
, size_t n
)
436 #ifdef CONFIG_SUSPEND
437 suspend_state_t state
= PM_SUSPEND_STANDBY
;
438 const char * const *s
;
444 p
= memchr(buf
, '\n', n
);
445 len
= p
? p
- buf
: n
;
447 /* First, check if we are requested to hibernate */
448 if (len
== 4 && !strncmp(buf
, "disk", len
)) {
453 #ifdef CONFIG_SUSPEND
454 for (s
= &pm_states
[state
]; state
< PM_SUSPEND_MAX
; s
++, state
++) {
455 if (*s
&& len
== strlen(*s
) && !strncmp(buf
, *s
, len
))
458 if (state
< PM_SUSPEND_MAX
&& *s
)
459 error
= enter_state(state
);
463 return error
? error
: n
;
468 #ifdef CONFIG_PM_TRACE
469 int pm_trace_enabled
;
471 static ssize_t
pm_trace_show(struct kobject
*kobj
, struct kobj_attribute
*attr
,
474 return sprintf(buf
, "%d\n", pm_trace_enabled
);
478 pm_trace_store(struct kobject
*kobj
, struct kobj_attribute
*attr
,
479 const char *buf
, size_t n
)
483 if (sscanf(buf
, "%d", &val
) == 1) {
484 pm_trace_enabled
= !!val
;
490 power_attr(pm_trace
);
491 #endif /* CONFIG_PM_TRACE */
493 static struct attribute
* g
[] = {
495 #ifdef CONFIG_PM_TRACE
498 #ifdef CONFIG_PM_DEBUG
504 static struct attribute_group attr_group
= {
509 static int __init
pm_init(void)
511 power_kobj
= kobject_create_and_add("power", NULL
);
514 return sysfs_create_group(power_kobj
, &attr_group
);
517 core_initcall(pm_init
);