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>
19 #include <linux/console.h>
20 #include <linux/cpu.h>
21 #include <linux/resume-trace.h>
22 #include <linux/freezer.h>
23 #include <linux/vmstat.h>
27 /*This is just an arbitrary number */
28 #define FREE_PAGE_NUMBER (100)
30 DEFINE_MUTEX(pm_mutex
);
32 struct pm_ops
*pm_ops
;
33 suspend_disk_method_t pm_disk_mode
= PM_DISK_PLATFORM
;
36 * pm_set_ops - Set the global power method table.
37 * @ops: Pointer to ops structure.
40 void pm_set_ops(struct pm_ops
* ops
)
42 mutex_lock(&pm_mutex
);
44 mutex_unlock(&pm_mutex
);
47 static inline void pm_finish(suspend_state_t state
)
50 pm_ops
->finish(state
);
54 * suspend_prepare - Do prep work before entering low-power state.
55 * @state: State we're entering.
57 * This is common code that is called for each state that we're
58 * entering. Allocate a console, stop all processes, then make sure
59 * the platform can enter the requested state.
62 static int suspend_prepare(suspend_state_t state
)
65 unsigned int free_pages
;
67 if (!pm_ops
|| !pm_ops
->enter
)
72 if (freeze_processes()) {
77 if ((free_pages
= global_page_state(NR_FREE_PAGES
))
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 error
= device_suspend(PMSG_SUSPEND
);
96 printk(KERN_ERR
"Some devices failed to suspend\n");
99 error
= disable_nonboot_cpus();
103 enable_nonboot_cpus();
110 pm_restore_console();
114 /* default implementation */
115 void __attribute__ ((weak
)) arch_suspend_disable_irqs(void)
120 /* default implementation */
121 void __attribute__ ((weak
)) arch_suspend_enable_irqs(void)
126 int suspend_enter(suspend_state_t state
)
130 arch_suspend_disable_irqs();
131 BUG_ON(!irqs_disabled());
133 if ((error
= device_power_down(PMSG_SUSPEND
))) {
134 printk(KERN_ERR
"Some devices failed to power down\n");
137 error
= pm_ops
->enter(state
);
140 arch_suspend_enable_irqs();
141 BUG_ON(irqs_disabled());
147 * suspend_finish - Do final work before exiting suspend sequence.
148 * @state: State we're coming out of.
150 * Call platform code to clean up, restart processes, and free the
151 * console that we've allocated. This is not called for suspend-to-disk.
154 static void suspend_finish(suspend_state_t state
)
156 enable_nonboot_cpus();
161 pm_restore_console();
167 static const char * const pm_states
[PM_SUSPEND_MAX
] = {
168 [PM_SUSPEND_STANDBY
] = "standby",
169 [PM_SUSPEND_MEM
] = "mem",
170 #ifdef CONFIG_SOFTWARE_SUSPEND
171 [PM_SUSPEND_DISK
] = "disk",
175 static inline int valid_state(suspend_state_t state
)
177 /* Suspend-to-disk does not really need low-level support.
178 * It can work with reboot if needed. */
179 if (state
== PM_SUSPEND_DISK
)
182 /* all other states need lowlevel support and need to be
183 * valid to the lowlevel implementation, no valid callback
184 * implies that all are valid. */
185 if (!pm_ops
|| (pm_ops
->valid
&& !pm_ops
->valid(state
)))
192 * enter_state - Do common work of entering low-power state.
193 * @state: pm_state structure for state we're entering.
195 * Make sure we're the only ones trying to enter a sleep state. Fail
196 * if someone has beat us to it, since we don't want anything weird to
197 * happen when we wake up.
198 * Then, do the setup for suspend, enter the state, and cleaup (after
202 static int enter_state(suspend_state_t state
)
206 if (!valid_state(state
))
208 if (!mutex_trylock(&pm_mutex
))
211 if (state
== PM_SUSPEND_DISK
) {
212 error
= pm_suspend_disk();
216 pr_debug("PM: Preparing system for %s sleep\n", pm_states
[state
]);
217 if ((error
= suspend_prepare(state
)))
220 pr_debug("PM: Entering %s sleep\n", pm_states
[state
]);
221 error
= suspend_enter(state
);
223 pr_debug("PM: Finishing wakeup.\n");
224 suspend_finish(state
);
226 mutex_unlock(&pm_mutex
);
231 * This is main interface to the outside world. It needs to be
232 * called from process context.
234 int software_suspend(void)
236 return enter_state(PM_SUSPEND_DISK
);
241 * pm_suspend - Externally visible function for suspending system.
242 * @state: Enumarted value of state to enter.
244 * Determine whether or not value is within range, get state
245 * structure, and enter (above).
248 int pm_suspend(suspend_state_t state
)
250 if (state
> PM_SUSPEND_ON
&& state
<= PM_SUSPEND_MAX
)
251 return enter_state(state
);
255 EXPORT_SYMBOL(pm_suspend
);
257 decl_subsys(power
,NULL
,NULL
);
261 * state - control system power state.
263 * show() returns what states are supported, which is hard-coded to
264 * 'standby' (Power-On Suspend), 'mem' (Suspend-to-RAM), and
265 * 'disk' (Suspend-to-Disk).
267 * store() accepts one of those strings, translates it into the
268 * proper enumerated value, and initiates a suspend transition.
271 static ssize_t
state_show(struct subsystem
* subsys
, char * buf
)
276 for (i
= 0; i
< PM_SUSPEND_MAX
; i
++) {
277 if (pm_states
[i
] && valid_state(i
))
278 s
+= sprintf(s
,"%s ", pm_states
[i
]);
280 s
+= sprintf(s
,"\n");
284 static ssize_t
state_store(struct subsystem
* subsys
, const char * buf
, size_t n
)
286 suspend_state_t state
= PM_SUSPEND_STANDBY
;
287 const char * const *s
;
292 p
= memchr(buf
, '\n', n
);
293 len
= p
? p
- buf
: n
;
295 for (s
= &pm_states
[state
]; state
< PM_SUSPEND_MAX
; s
++, state
++) {
296 if (*s
&& !strncmp(buf
, *s
, len
))
299 if (state
< PM_SUSPEND_MAX
&& *s
)
300 error
= enter_state(state
);
303 return error
? error
: n
;
308 #ifdef CONFIG_PM_TRACE
309 int pm_trace_enabled
;
311 static ssize_t
pm_trace_show(struct subsystem
* subsys
, char * buf
)
313 return sprintf(buf
, "%d\n", pm_trace_enabled
);
317 pm_trace_store(struct subsystem
* subsys
, const char * buf
, size_t n
)
321 if (sscanf(buf
, "%d", &val
) == 1) {
322 pm_trace_enabled
= !!val
;
328 power_attr(pm_trace
);
330 static struct attribute
* g
[] = {
336 static struct attribute
* g
[] = {
340 #endif /* CONFIG_PM_TRACE */
342 static struct attribute_group attr_group
= {
347 static int __init
pm_init(void)
349 int error
= subsystem_register(&power_subsys
);
351 error
= sysfs_create_group(&power_subsys
.kset
.kobj
,&attr_group
);
355 core_initcall(pm_init
);