blob: 388cace9751f06b9ee9496e2824a79e4bb9d839f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_SWSUSP_H
2#define _LINUX_SWSUSP_H
3
Johannes Berg543b9fd2007-05-03 22:31:38 +10004#if defined(CONFIG_X86) || defined(CONFIG_FRV) || defined(CONFIG_PPC32) || defined(CONFIG_PPC64)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <asm/suspend.h>
6#endif
7#include <linux/swap.h>
8#include <linux/notifier.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/init.h>
10#include <linux/pm.h>
Rafael J. Wysocki7be98232007-05-06 14:50:42 -070011#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
Rafael J. Wysocki83573762006-12-06 20:34:18 -080013/* struct pbe is used for creating lists of pages that should be restored
14 * atomically during the resume from disk, because the page frames they have
15 * occupied before the suspend are in use.
16 */
Rafael J. Wysockidcbb5a52006-09-25 23:32:51 -070017struct pbe {
Rafael J. Wysocki83573762006-12-06 20:34:18 -080018 void *address; /* address of the copy */
19 void *orig_address; /* original address of a page */
Rafael J. Wysocki7088a5c2006-01-06 00:13:05 -080020 struct pbe *next;
Rafael J. Wysockidcbb5a52006-09-25 23:32:51 -070021};
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
Linus Torvalds1da177e2005-04-16 15:20:36 -070023/* mm/page_alloc.c */
24extern void drain_local_pages(void);
25extern void mark_free_pages(struct zone *zone);
26
Rafael J. Wysocki296699d2007-07-29 23:27:18 +020027#if defined(CONFIG_PM_SLEEP) && defined(CONFIG_VT) && defined(CONFIG_VT_CONSOLE)
Rafael J. Wysocki46cd2f32006-02-07 12:58:50 -080028extern int pm_prepare_console(void);
29extern void pm_restore_console(void);
30#else
31static inline int pm_prepare_console(void) { return 0; }
32static inline void pm_restore_console(void) {}
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -070033#endif
34
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070035/**
36 * struct hibernation_ops - hibernation platform support
37 *
38 * The methods in this structure allow a platform to override the default
39 * mechanism of shutting down the machine during a hibernation transition.
40 *
41 * All three methods must be assigned.
42 *
43 * @prepare: prepare system for hibernation
44 * @enter: shut down system after state has been saved to disk
45 * @finish: finish/clean up after state has been reloaded
Rafael J. Wysockia634cc12007-07-19 01:47:30 -070046 * @pre_restore: prepare system for the restoration from a hibernation image
47 * @restore_cleanup: clean up after a failing image restoration
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070048 */
49struct hibernation_ops {
50 int (*prepare)(void);
51 int (*enter)(void);
52 void (*finish)(void);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -070053 int (*pre_restore)(void);
54 void (*restore_cleanup)(void);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070055};
56
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +020057#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -070058/* kernel/power/snapshot.c */
Johannes Berg940d67f2007-05-08 19:23:49 +100059extern void __register_nosave_region(unsigned long b, unsigned long e, int km);
60static inline void register_nosave_region(unsigned long b, unsigned long e)
61{
62 __register_nosave_region(b, e, 0);
63}
64static inline void register_nosave_region_late(unsigned long b, unsigned long e)
65{
66 __register_nosave_region(b, e, 1);
67}
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -070068extern int swsusp_page_is_forbidden(struct page *);
69extern void swsusp_set_page_free(struct page *);
70extern void swsusp_unset_page_free(struct page *);
71extern unsigned long get_safe_page(gfp_t gfp_mask);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070072
73extern void hibernation_set_ops(struct hibernation_ops *ops);
74extern int hibernate(void);
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +020075#else /* CONFIG_HIBERNATION */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -070076static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
77static inline void swsusp_set_page_free(struct page *p) {}
78static inline void swsusp_unset_page_free(struct page *p) {}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -070079
80static inline void hibernation_set_ops(struct hibernation_ops *ops) {}
81static inline int hibernate(void) { return -ENOSYS; }
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +020082#endif /* CONFIG_HIBERNATION */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
Rafael J. Wysocki296699d2007-07-29 23:27:18 +020084#ifdef CONFIG_PM_SLEEP
Linus Torvalds1da177e2005-04-16 15:20:36 -070085void save_processor_state(void);
86void restore_processor_state(void);
87struct saved_context;
88void __save_processor_state(struct saved_context *ctxt);
89void __restore_processor_state(struct saved_context *ctxt);
Rafael J. Wysocki25761b62005-10-30 14:59:56 -080090
Rafael J. Wysockib10d9112007-07-19 01:47:36 -070091/* kernel/power/main.c */
92extern struct blocking_notifier_head pm_chain_head;
93
94static inline int register_pm_notifier(struct notifier_block *nb)
95{
96 return blocking_notifier_chain_register(&pm_chain_head, nb);
97}
98
99static inline int unregister_pm_notifier(struct notifier_block *nb)
100{
101 return blocking_notifier_chain_unregister(&pm_chain_head, nb);
102}
103
104#define pm_notifier(fn, pri) { \
105 static struct notifier_block fn##_nb = \
106 { .notifier_call = fn, .priority = pri }; \
107 register_pm_notifier(&fn##_nb); \
108}
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200109#else /* !CONFIG_PM_SLEEP */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700110
111static inline int register_pm_notifier(struct notifier_block *nb)
112{
113 return 0;
114}
115
116static inline int unregister_pm_notifier(struct notifier_block *nb)
117{
118 return 0;
119}
120
121#define pm_notifier(fn, pri) do { (void)(fn); } while (0)
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200122#endif /* !CONFIG_PM_SLEEP */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700123
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200124#ifndef CONFIG_HIBERNATION
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700125static inline void register_nosave_region(unsigned long b, unsigned long e)
126{
127}
Ryusuke Konishi70f38db2007-07-26 10:40:59 -0700128static inline void register_nosave_region_late(unsigned long b, unsigned long e)
129{
130}
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700131#endif
132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#endif /* _LINUX_SWSUSP_H */