Commit | Line | Data |
---|---|---|
9a3df1f7 AS |
1 | /* |
2 | * pm_wakeup.h - Power management wakeup interface | |
3 | * | |
4 | * Copyright (C) 2008 Alan Stern | |
074037ec | 5 | * Copyright (C) 2010 Rafael J. Wysocki, Novell Inc. |
9a3df1f7 AS |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, write to the Free Software | |
19 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
20 | */ | |
21 | ||
22 | #ifndef _LINUX_PM_WAKEUP_H | |
23 | #define _LINUX_PM_WAKEUP_H | |
24 | ||
25 | #ifndef _DEVICE_H_ | |
26 | # error "please don't include this file directly" | |
27 | #endif | |
28 | ||
228c54ef DT |
29 | #include <linux/types.h> |
30 | ||
074037ec RW |
31 | /** |
32 | * struct wakeup_source - Representation of wakeup sources | |
2430d12c | 33 | * |
074037ec RW |
34 | * @total_time: Total time this wakeup source has been active. |
35 | * @max_time: Maximum time this wakeup source has been continuously active. | |
30e3ce6d | 36 | * @last_time: Monotonic clock when the wakeup source's was touched last time. |
55850945 | 37 | * @prevent_sleep_time: Total time this source has been preventing autosleep. |
074037ec RW |
38 | * @event_count: Number of signaled wakeup events. |
39 | * @active_count: Number of times the wakeup sorce was activated. | |
40 | * @relax_count: Number of times the wakeup sorce was deactivated. | |
30e3ce6d RW |
41 | * @expire_count: Number of times the wakeup source's timeout has expired. |
42 | * @wakeup_count: Number of times the wakeup source might abort suspend. | |
074037ec | 43 | * @active: Status of the wakeup source. |
30e3ce6d | 44 | * @has_timeout: The wakeup source has been activated with a timeout. |
9a3df1f7 | 45 | */ |
074037ec | 46 | struct wakeup_source { |
8671bbc1 | 47 | const char *name; |
074037ec RW |
48 | struct list_head entry; |
49 | spinlock_t lock; | |
50 | struct timer_list timer; | |
51 | unsigned long timer_expires; | |
52 | ktime_t total_time; | |
53 | ktime_t max_time; | |
54 | ktime_t last_time; | |
55850945 RW |
55 | ktime_t start_prevent_time; |
56 | ktime_t prevent_sleep_time; | |
074037ec RW |
57 | unsigned long event_count; |
58 | unsigned long active_count; | |
59 | unsigned long relax_count; | |
30e3ce6d RW |
60 | unsigned long expire_count; |
61 | unsigned long wakeup_count; | |
62 | bool active:1; | |
55850945 | 63 | bool autosleep_enabled:1; |
074037ec RW |
64 | }; |
65 | ||
66 | #ifdef CONFIG_PM_SLEEP | |
67 | ||
68 | /* | |
69 | * Changes to device_may_wakeup take effect on the next pm state change. | |
70 | */ | |
71 | ||
074037ec RW |
72 | static inline bool device_can_wakeup(struct device *dev) |
73 | { | |
74 | return dev->power.can_wakeup; | |
75 | } | |
76 | ||
074037ec | 77 | static inline bool device_may_wakeup(struct device *dev) |
9a3df1f7 | 78 | { |
074037ec | 79 | return dev->power.can_wakeup && !!dev->power.wakeup; |
9a3df1f7 AS |
80 | } |
81 | ||
074037ec | 82 | /* drivers/base/power/wakeup.c */ |
8671bbc1 | 83 | extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name); |
074037ec | 84 | extern struct wakeup_source *wakeup_source_create(const char *name); |
8671bbc1 | 85 | extern void wakeup_source_drop(struct wakeup_source *ws); |
074037ec RW |
86 | extern void wakeup_source_destroy(struct wakeup_source *ws); |
87 | extern void wakeup_source_add(struct wakeup_source *ws); | |
88 | extern void wakeup_source_remove(struct wakeup_source *ws); | |
89 | extern struct wakeup_source *wakeup_source_register(const char *name); | |
90 | extern void wakeup_source_unregister(struct wakeup_source *ws); | |
91 | extern int device_wakeup_enable(struct device *dev); | |
92 | extern int device_wakeup_disable(struct device *dev); | |
cb8f51bd | 93 | extern void device_set_wakeup_capable(struct device *dev, bool capable); |
074037ec RW |
94 | extern int device_init_wakeup(struct device *dev, bool val); |
95 | extern int device_set_wakeup_enable(struct device *dev, bool enable); | |
96 | extern void __pm_stay_awake(struct wakeup_source *ws); | |
97 | extern void pm_stay_awake(struct device *dev); | |
98 | extern void __pm_relax(struct wakeup_source *ws); | |
99 | extern void pm_relax(struct device *dev); | |
100 | extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec); | |
101 | extern void pm_wakeup_event(struct device *dev, unsigned int msec); | |
102 | ||
103 | #else /* !CONFIG_PM_SLEEP */ | |
104 | ||
228c54ef | 105 | static inline void device_set_wakeup_capable(struct device *dev, bool capable) |
eb9d0fe4 | 106 | { |
228c54ef | 107 | dev->power.can_wakeup = capable; |
eb9d0fe4 RW |
108 | } |
109 | ||
228c54ef | 110 | static inline bool device_can_wakeup(struct device *dev) |
9a3df1f7 AS |
111 | { |
112 | return dev->power.can_wakeup; | |
113 | } | |
114 | ||
8671bbc1 RW |
115 | static inline void wakeup_source_prepare(struct wakeup_source *ws, |
116 | const char *name) {} | |
117 | ||
074037ec | 118 | static inline struct wakeup_source *wakeup_source_create(const char *name) |
9a3df1f7 | 119 | { |
074037ec | 120 | return NULL; |
9a3df1f7 AS |
121 | } |
122 | ||
8671bbc1 RW |
123 | static inline void wakeup_source_drop(struct wakeup_source *ws) {} |
124 | ||
074037ec RW |
125 | static inline void wakeup_source_destroy(struct wakeup_source *ws) {} |
126 | ||
127 | static inline void wakeup_source_add(struct wakeup_source *ws) {} | |
9a3df1f7 | 128 | |
074037ec RW |
129 | static inline void wakeup_source_remove(struct wakeup_source *ws) {} |
130 | ||
131 | static inline struct wakeup_source *wakeup_source_register(const char *name) | |
9a3df1f7 | 132 | { |
074037ec | 133 | return NULL; |
9a3df1f7 AS |
134 | } |
135 | ||
074037ec RW |
136 | static inline void wakeup_source_unregister(struct wakeup_source *ws) {} |
137 | ||
138 | static inline int device_wakeup_enable(struct device *dev) | |
228c54ef | 139 | { |
805bdaec RW |
140 | dev->power.should_wakeup = true; |
141 | return 0; | |
228c54ef | 142 | } |
c300bd2f | 143 | |
074037ec | 144 | static inline int device_wakeup_disable(struct device *dev) |
9a3df1f7 | 145 | { |
805bdaec | 146 | dev->power.should_wakeup = false; |
074037ec | 147 | return 0; |
9a3df1f7 AS |
148 | } |
149 | ||
805bdaec | 150 | static inline int device_set_wakeup_enable(struct device *dev, bool enable) |
228c54ef | 151 | { |
805bdaec RW |
152 | dev->power.should_wakeup = enable; |
153 | return 0; | |
228c54ef DT |
154 | } |
155 | ||
805bdaec RW |
156 | static inline int device_init_wakeup(struct device *dev, bool val) |
157 | { | |
158 | device_set_wakeup_capable(dev, val); | |
159 | device_set_wakeup_enable(dev, val); | |
160 | return 0; | |
161 | } | |
074037ec | 162 | |
805bdaec | 163 | static inline bool device_may_wakeup(struct device *dev) |
228c54ef | 164 | { |
805bdaec | 165 | return dev->power.can_wakeup && dev->power.should_wakeup; |
228c54ef | 166 | } |
9a3df1f7 | 167 | |
074037ec RW |
168 | static inline void __pm_stay_awake(struct wakeup_source *ws) {} |
169 | ||
170 | static inline void pm_stay_awake(struct device *dev) {} | |
171 | ||
172 | static inline void __pm_relax(struct wakeup_source *ws) {} | |
173 | ||
174 | static inline void pm_relax(struct device *dev) {} | |
175 | ||
176 | static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {} | |
177 | ||
178 | static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {} | |
179 | ||
180 | #endif /* !CONFIG_PM_SLEEP */ | |
9a3df1f7 | 181 | |
8671bbc1 RW |
182 | static inline void wakeup_source_init(struct wakeup_source *ws, |
183 | const char *name) | |
184 | { | |
185 | wakeup_source_prepare(ws, name); | |
186 | wakeup_source_add(ws); | |
187 | } | |
188 | ||
189 | static inline void wakeup_source_trash(struct wakeup_source *ws) | |
190 | { | |
191 | wakeup_source_remove(ws); | |
192 | wakeup_source_drop(ws); | |
193 | } | |
194 | ||
9a3df1f7 | 195 | #endif /* _LINUX_PM_WAKEUP_H */ |