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/suspend.h>
12 #include <linux/kobject.h>
13 #include <linux/string.h>
14 #include <linux/delay.h>
15 #include <linux/errno.h>
16 #include <linux/init.h>
18 #include <linux/console.h>
22 /*This is just an arbitrary number */
23 #define FREE_PAGE_NUMBER (100)
25 DECLARE_MUTEX(pm_sem);
27 struct pm_ops *pm_ops;
28 suspend_disk_method_t pm_disk_mode = PM_DISK_SHUTDOWN;
31 * pm_set_ops - Set the global power method table.
32 * @ops: Pointer to ops structure.
35 void pm_set_ops(struct pm_ops * ops)
44 * suspend_prepare - Do prep work before entering low-power state.
45 * @state: State we're entering.
47 * This is common code that is called for each state that we're
48 * entering. Allocate a console, stop all processes, then make sure
49 * the platform can enter the requested state.
52 static int suspend_prepare(suspend_state_t state)
55 unsigned int free_pages;
57 if (!pm_ops || !pm_ops->enter)
60 error = device_prepare_suspend(PMSG_SUSPEND);
66 disable_nonboot_cpus();
68 if (num_online_cpus() != 1) {
73 if (freeze_processes()) {
78 if ((free_pages = nr_free_pages()) < FREE_PAGE_NUMBER) {
79 pr_debug("PM: free some memory\n");
80 shrink_all_memory(FREE_PAGE_NUMBER - free_pages);
81 if (nr_free_pages() < FREE_PAGE_NUMBER) {
83 printk(KERN_ERR "PM: No enough memory\n");
88 if (pm_ops->prepare) {
89 if ((error = pm_ops->prepare(state)))
94 if ((error = device_suspend(PMSG_SUSPEND))) {
95 printk(KERN_ERR "Some devices failed to suspend\n");
101 pm_ops->finish(state);
105 enable_nonboot_cpus();
106 pm_restore_console();
111 int suspend_enter(suspend_state_t state)
116 local_irq_save(flags);
118 if ((error = device_power_down(PMSG_SUSPEND))) {
119 printk(KERN_ERR "Some devices failed to power down\n");
122 error = pm_ops->enter(state);
125 local_irq_restore(flags);
131 * suspend_finish - Do final work before exiting suspend sequence.
132 * @state: State we're coming out of.
134 * Call platform code to clean up, restart processes, and free the
135 * console that we've allocated. This is not called for suspend-to-disk.
138 static void suspend_finish(suspend_state_t state)
143 enable_nonboot_cpus();
144 if (pm_ops && pm_ops->finish)
145 pm_ops->finish(state);
146 pm_restore_console();
152 static const char * const pm_states[PM_SUSPEND_MAX] = {
153 [PM_SUSPEND_STANDBY] = "standby",
154 [PM_SUSPEND_MEM] = "mem",
155 #ifdef CONFIG_SOFTWARE_SUSPEND
156 [PM_SUSPEND_DISK] = "disk",
160 static inline int valid_state(suspend_state_t state)
162 /* Suspend-to-disk does not really need low-level support.
163 * It can work with reboot if needed. */
164 if (state == PM_SUSPEND_DISK)
167 if (pm_ops && pm_ops->valid && !pm_ops->valid(state))
174 * enter_state - Do common work of entering low-power state.
175 * @state: pm_state structure for state we're entering.
177 * Make sure we're the only ones trying to enter a sleep state. Fail
178 * if someone has beat us to it, since we don't want anything weird to
179 * happen when we wake up.
180 * Then, do the setup for suspend, enter the state, and cleaup (after
184 static int enter_state(suspend_state_t state)
188 if (!valid_state(state))
190 if (down_trylock(&pm_sem))
193 if (state == PM_SUSPEND_DISK) {
194 error = pm_suspend_disk();
198 pr_debug("PM: Preparing system for %s sleep\n", pm_states[state]);
199 if ((error = suspend_prepare(state)))
202 pr_debug("PM: Entering %s sleep\n", pm_states[state]);
203 error = suspend_enter(state);
205 pr_debug("PM: Finishing wakeup.\n");
206 suspend_finish(state);
213 * This is main interface to the outside world. It needs to be
214 * called from process context.
216 int software_suspend(void)
218 return enter_state(PM_SUSPEND_DISK);
223 * pm_suspend - Externally visible function for suspending system.
224 * @state: Enumarted value of state to enter.
226 * Determine whether or not value is within range, get state
227 * structure, and enter (above).
230 int pm_suspend(suspend_state_t state)
232 if (state > PM_SUSPEND_ON && state <= PM_SUSPEND_MAX)
233 return enter_state(state);
239 decl_subsys(power,NULL,NULL);
243 * state - control system power state.
245 * show() returns what states are supported, which is hard-coded to
246 * 'standby' (Power-On Suspend), 'mem' (Suspend-to-RAM), and
247 * 'disk' (Suspend-to-Disk).
249 * store() accepts one of those strings, translates it into the
250 * proper enumerated value, and initiates a suspend transition.
253 static ssize_t state_show(struct subsystem * subsys, char * buf)
258 for (i = 0; i < PM_SUSPEND_MAX; i++) {
259 if (pm_states[i] && valid_state(i))
260 s += sprintf(s,"%s ", pm_states[i]);
262 s += sprintf(s,"\n");
266 static ssize_t state_store(struct subsystem * subsys, const char * buf, size_t n)
268 suspend_state_t state = PM_SUSPEND_STANDBY;
269 const char * const *s;
274 p = memchr(buf, '\n', n);
275 len = p ? p - buf : n;
277 for (s = &pm_states[state]; state < PM_SUSPEND_MAX; s++, state++) {
278 if (*s && !strncmp(buf, *s, len))
281 if (state < PM_SUSPEND_MAX && *s)
282 error = enter_state(state);
285 return error ? error : n;
290 static struct attribute * g[] = {
295 static struct attribute_group attr_group = {
300 static int __init pm_init(void)
302 int error = subsystem_register(&power_subsys);
304 error = sysfs_create_group(&power_subsys.kset.kobj,&attr_group);
308 core_initcall(pm_init);