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>
26 /*This is just an arbitrary number */
27 #define FREE_PAGE_NUMBER (100)
29 DEFINE_MUTEX(pm_mutex
);
31 struct pm_ops
*pm_ops
;
34 * pm_set_ops - Set the global power method table.
35 * @ops: Pointer to ops structure.
38 void pm_set_ops(struct pm_ops
* ops
)
40 mutex_lock(&pm_mutex
);
42 mutex_unlock(&pm_mutex
);
46 * pm_valid_only_mem - generic memory-only valid callback
48 * pm_ops drivers that implement mem suspend only and only need
49 * to check for that in their .valid callback can use this instead
50 * of rolling their own .valid callback.
52 int pm_valid_only_mem(suspend_state_t state
)
54 return state
== PM_SUSPEND_MEM
;
58 static inline void pm_finish(suspend_state_t state
)
61 pm_ops
->finish(state
);
65 * suspend_prepare - Do prep work before entering low-power state.
66 * @state: State we're entering.
68 * This is common code that is called for each state that we're
69 * entering. Allocate a console, stop all processes, then make sure
70 * the platform can enter the requested state.
73 static int suspend_prepare(suspend_state_t state
)
76 unsigned int free_pages
;
78 if (!pm_ops
|| !pm_ops
->enter
)
83 if (freeze_processes()) {
88 if ((free_pages
= global_page_state(NR_FREE_PAGES
))
90 pr_debug("PM: free some memory\n");
91 shrink_all_memory(FREE_PAGE_NUMBER
- free_pages
);
92 if (nr_free_pages() < FREE_PAGE_NUMBER
) {
94 printk(KERN_ERR
"PM: No enough memory\n");
99 if (pm_ops
->set_target
) {
100 error
= pm_ops
->set_target(state
);
105 error
= device_suspend(PMSG_SUSPEND
);
107 printk(KERN_ERR
"Some devices failed to suspend\n");
110 if (pm_ops
->prepare
) {
111 if ((error
= pm_ops
->prepare(state
)))
115 error
= disable_nonboot_cpus();
119 enable_nonboot_cpus();
127 pm_restore_console();
131 /* default implementation */
132 void __attribute__ ((weak
)) arch_suspend_disable_irqs(void)
137 /* default implementation */
138 void __attribute__ ((weak
)) arch_suspend_enable_irqs(void)
143 int suspend_enter(suspend_state_t state
)
147 arch_suspend_disable_irqs();
148 BUG_ON(!irqs_disabled());
150 if ((error
= device_power_down(PMSG_SUSPEND
))) {
151 printk(KERN_ERR
"Some devices failed to power down\n");
154 error
= pm_ops
->enter(state
);
157 arch_suspend_enable_irqs();
158 BUG_ON(irqs_disabled());
164 * suspend_finish - Do final work before exiting suspend sequence.
165 * @state: State we're coming out of.
167 * Call platform code to clean up, restart processes, and free the
168 * console that we've allocated. This is not called for suspend-to-disk.
171 static void suspend_finish(suspend_state_t state
)
173 enable_nonboot_cpus();
178 pm_restore_console();
184 static const char * const pm_states
[PM_SUSPEND_MAX
] = {
185 [PM_SUSPEND_STANDBY
] = "standby",
186 [PM_SUSPEND_MEM
] = "mem",
189 static inline int valid_state(suspend_state_t state
)
191 /* All states need lowlevel support and need to be valid
192 * to the lowlevel implementation, no valid callback
193 * implies that none are valid. */
194 if (!pm_ops
|| !pm_ops
->valid
|| !pm_ops
->valid(state
))
201 * enter_state - Do common work of entering low-power state.
202 * @state: pm_state structure for state we're entering.
204 * Make sure we're the only ones trying to enter a sleep state. Fail
205 * if someone has beat us to it, since we don't want anything weird to
206 * happen when we wake up.
207 * Then, do the setup for suspend, enter the state, and cleaup (after
211 static int enter_state(suspend_state_t state
)
215 if (!valid_state(state
))
217 if (!mutex_trylock(&pm_mutex
))
220 pr_debug("PM: Preparing system for %s sleep\n", pm_states
[state
]);
221 if ((error
= suspend_prepare(state
)))
224 pr_debug("PM: Entering %s sleep\n", pm_states
[state
]);
225 error
= suspend_enter(state
);
227 pr_debug("PM: Finishing wakeup.\n");
228 suspend_finish(state
);
230 mutex_unlock(&pm_mutex
);
236 * pm_suspend - Externally visible function for suspending system.
237 * @state: Enumerated value of state to enter.
239 * Determine whether or not value is within range, get state
240 * structure, and enter (above).
243 int pm_suspend(suspend_state_t state
)
245 if (state
> PM_SUSPEND_ON
&& state
<= PM_SUSPEND_MAX
)
246 return enter_state(state
);
250 EXPORT_SYMBOL(pm_suspend
);
252 decl_subsys(power
,NULL
,NULL
);
256 * state - control system power state.
258 * show() returns what states are supported, which is hard-coded to
259 * 'standby' (Power-On Suspend), 'mem' (Suspend-to-RAM), and
260 * 'disk' (Suspend-to-Disk).
262 * store() accepts one of those strings, translates it into the
263 * proper enumerated value, and initiates a suspend transition.
266 static ssize_t
state_show(struct kset
*kset
, char *buf
)
271 for (i
= 0; i
< PM_SUSPEND_MAX
; i
++) {
272 if (pm_states
[i
] && valid_state(i
))
273 s
+= sprintf(s
,"%s ", pm_states
[i
]);
275 #ifdef CONFIG_SOFTWARE_SUSPEND
276 s
+= sprintf(s
, "%s\n", "disk");
279 /* convert the last space to a newline */
285 static ssize_t
state_store(struct kset
*kset
, const char *buf
, size_t n
)
287 suspend_state_t state
= PM_SUSPEND_STANDBY
;
288 const char * const *s
;
293 p
= memchr(buf
, '\n', n
);
294 len
= p
? p
- buf
: n
;
296 /* First, check if we are requested to hibernate */
297 if (len
== 4 && !strncmp(buf
, "disk", len
)) {
299 return error
? error
: n
;
302 for (s
= &pm_states
[state
]; state
< PM_SUSPEND_MAX
; s
++, state
++) {
303 if (*s
&& len
== strlen(*s
) && !strncmp(buf
, *s
, len
))
306 if (state
< PM_SUSPEND_MAX
&& *s
)
307 error
= enter_state(state
);
310 return error
? error
: n
;
315 #ifdef CONFIG_PM_TRACE
316 int pm_trace_enabled
;
318 static ssize_t
pm_trace_show(struct kset
*kset
, char *buf
)
320 return sprintf(buf
, "%d\n", pm_trace_enabled
);
324 pm_trace_store(struct kset
*kset
, const char *buf
, size_t n
)
328 if (sscanf(buf
, "%d", &val
) == 1) {
329 pm_trace_enabled
= !!val
;
335 power_attr(pm_trace
);
337 static struct attribute
* g
[] = {
343 static struct attribute
* g
[] = {
347 #endif /* CONFIG_PM_TRACE */
349 static struct attribute_group attr_group
= {
354 static int __init
pm_init(void)
356 int error
= subsystem_register(&power_subsys
);
358 error
= sysfs_create_group(&power_subsys
.kobj
,&attr_group
);
362 core_initcall(pm_init
);