Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
9a3df1f7 AS |
2 | /* |
3 | * pm_wakeup.h - Power management wakeup interface | |
4 | * | |
5 | * Copyright (C) 2008 Alan Stern | |
074037ec | 6 | * Copyright (C) 2010 Rafael J. Wysocki, Novell Inc. |
9a3df1f7 AS |
7 | */ |
8 | ||
9 | #ifndef _LINUX_PM_WAKEUP_H | |
10 | #define _LINUX_PM_WAKEUP_H | |
11 | ||
12 | #ifndef _DEVICE_H_ | |
13 | # error "please don't include this file directly" | |
14 | #endif | |
15 | ||
228c54ef DT |
16 | #include <linux/types.h> |
17 | ||
4990d4fe TL |
18 | struct wake_irq; |
19 | ||
074037ec RW |
20 | /** |
21 | * struct wakeup_source - Representation of wakeup sources | |
2430d12c | 22 | * |
4990d4fe | 23 | * @name: Name of the wakeup source |
c8377adf | 24 | * @id: Wakeup source id |
4990d4fe TL |
25 | * @entry: Wakeup source list entry |
26 | * @lock: Wakeup source lock | |
27 | * @wakeirq: Optional device specific wakeirq | |
28 | * @timer: Wakeup timer list | |
29 | * @timer_expires: Wakeup timer expiration | |
074037ec RW |
30 | * @total_time: Total time this wakeup source has been active. |
31 | * @max_time: Maximum time this wakeup source has been continuously active. | |
30e3ce6d | 32 | * @last_time: Monotonic clock when the wakeup source's was touched last time. |
55850945 | 33 | * @prevent_sleep_time: Total time this source has been preventing autosleep. |
074037ec | 34 | * @event_count: Number of signaled wakeup events. |
1258ca80 CC |
35 | * @active_count: Number of times the wakeup source was activated. |
36 | * @relax_count: Number of times the wakeup source was deactivated. | |
30e3ce6d RW |
37 | * @expire_count: Number of times the wakeup source's timeout has expired. |
38 | * @wakeup_count: Number of times the wakeup source might abort suspend. | |
c8377adf | 39 | * @dev: Struct device for sysfs statistics about the wakeup source. |
074037ec | 40 | * @active: Status of the wakeup source. |
e9bea8f9 | 41 | * @autosleep_enabled: Autosleep is active, so update @prevent_sleep_time. |
9a3df1f7 | 42 | */ |
074037ec | 43 | struct wakeup_source { |
8671bbc1 | 44 | const char *name; |
c8377adf | 45 | int id; |
074037ec RW |
46 | struct list_head entry; |
47 | spinlock_t lock; | |
4990d4fe | 48 | struct wake_irq *wakeirq; |
074037ec RW |
49 | struct timer_list timer; |
50 | unsigned long timer_expires; | |
51 | ktime_t total_time; | |
52 | ktime_t max_time; | |
53 | ktime_t last_time; | |
55850945 RW |
54 | ktime_t start_prevent_time; |
55 | ktime_t prevent_sleep_time; | |
074037ec RW |
56 | unsigned long event_count; |
57 | unsigned long active_count; | |
58 | unsigned long relax_count; | |
30e3ce6d RW |
59 | unsigned long expire_count; |
60 | unsigned long wakeup_count; | |
c8377adf | 61 | struct device *dev; |
30e3ce6d | 62 | bool active:1; |
55850945 | 63 | bool autosleep_enabled:1; |
074037ec RW |
64 | }; |
65 | ||
b4941adb RW |
66 | #define for_each_wakeup_source(ws) \ |
67 | for ((ws) = wakeup_sources_walk_start(); \ | |
68 | (ws); \ | |
69 | (ws) = wakeup_sources_walk_next((ws))) | |
70 | ||
074037ec RW |
71 | #ifdef CONFIG_PM_SLEEP |
72 | ||
73 | /* | |
74 | * Changes to device_may_wakeup take effect on the next pm state change. | |
75 | */ | |
76 | ||
074037ec RW |
77 | static inline bool device_can_wakeup(struct device *dev) |
78 | { | |
79 | return dev->power.can_wakeup; | |
80 | } | |
81 | ||
074037ec | 82 | static inline bool device_may_wakeup(struct device *dev) |
9a3df1f7 | 83 | { |
074037ec | 84 | return dev->power.can_wakeup && !!dev->power.wakeup; |
9a3df1f7 AS |
85 | } |
86 | ||
4e1d9a73 PC |
87 | static inline bool device_wakeup_path(struct device *dev) |
88 | { | |
89 | return dev->power.wakeup_path; | |
90 | } | |
91 | ||
cf04ce78 UH |
92 | static inline void device_set_wakeup_path(struct device *dev) |
93 | { | |
94 | dev->power.wakeup_path = true; | |
95 | } | |
96 | ||
074037ec RW |
97 | /* drivers/base/power/wakeup.c */ |
98 | extern struct wakeup_source *wakeup_source_create(const char *name); | |
99 | extern void wakeup_source_destroy(struct wakeup_source *ws); | |
100 | extern void wakeup_source_add(struct wakeup_source *ws); | |
101 | extern void wakeup_source_remove(struct wakeup_source *ws); | |
c8377adf TV |
102 | extern struct wakeup_source *wakeup_source_register(struct device *dev, |
103 | const char *name); | |
074037ec | 104 | extern void wakeup_source_unregister(struct wakeup_source *ws); |
b4941adb RW |
105 | extern int wakeup_sources_read_lock(void); |
106 | extern void wakeup_sources_read_unlock(int idx); | |
107 | extern struct wakeup_source *wakeup_sources_walk_start(void); | |
108 | extern struct wakeup_source *wakeup_sources_walk_next(struct wakeup_source *ws); | |
074037ec | 109 | extern int device_wakeup_enable(struct device *dev); |
afde996a | 110 | extern void device_wakeup_disable(struct device *dev); |
cb8f51bd | 111 | extern void device_set_wakeup_capable(struct device *dev, bool capable); |
074037ec RW |
112 | extern int device_set_wakeup_enable(struct device *dev, bool enable); |
113 | extern void __pm_stay_awake(struct wakeup_source *ws); | |
114 | extern void pm_stay_awake(struct device *dev); | |
115 | extern void __pm_relax(struct wakeup_source *ws); | |
116 | extern void pm_relax(struct device *dev); | |
8a537ece RW |
117 | extern void pm_wakeup_ws_event(struct wakeup_source *ws, unsigned int msec, bool hard); |
118 | extern void pm_wakeup_dev_event(struct device *dev, unsigned int msec, bool hard); | |
074037ec RW |
119 | |
120 | #else /* !CONFIG_PM_SLEEP */ | |
121 | ||
228c54ef | 122 | static inline void device_set_wakeup_capable(struct device *dev, bool capable) |
eb9d0fe4 | 123 | { |
228c54ef | 124 | dev->power.can_wakeup = capable; |
eb9d0fe4 RW |
125 | } |
126 | ||
228c54ef | 127 | static inline bool device_can_wakeup(struct device *dev) |
9a3df1f7 AS |
128 | { |
129 | return dev->power.can_wakeup; | |
130 | } | |
131 | ||
074037ec | 132 | static inline struct wakeup_source *wakeup_source_create(const char *name) |
9a3df1f7 | 133 | { |
074037ec | 134 | return NULL; |
9a3df1f7 AS |
135 | } |
136 | ||
074037ec RW |
137 | static inline void wakeup_source_destroy(struct wakeup_source *ws) {} |
138 | ||
139 | static inline void wakeup_source_add(struct wakeup_source *ws) {} | |
9a3df1f7 | 140 | |
074037ec RW |
141 | static inline void wakeup_source_remove(struct wakeup_source *ws) {} |
142 | ||
c8377adf TV |
143 | static inline struct wakeup_source *wakeup_source_register(struct device *dev, |
144 | const char *name) | |
9a3df1f7 | 145 | { |
074037ec | 146 | return NULL; |
9a3df1f7 AS |
147 | } |
148 | ||
074037ec RW |
149 | static inline void wakeup_source_unregister(struct wakeup_source *ws) {} |
150 | ||
151 | static inline int device_wakeup_enable(struct device *dev) | |
228c54ef | 152 | { |
805bdaec RW |
153 | dev->power.should_wakeup = true; |
154 | return 0; | |
228c54ef | 155 | } |
c300bd2f | 156 | |
afde996a | 157 | static inline void device_wakeup_disable(struct device *dev) |
9a3df1f7 | 158 | { |
805bdaec | 159 | dev->power.should_wakeup = false; |
9a3df1f7 AS |
160 | } |
161 | ||
805bdaec | 162 | static inline int device_set_wakeup_enable(struct device *dev, bool enable) |
228c54ef | 163 | { |
805bdaec RW |
164 | dev->power.should_wakeup = enable; |
165 | return 0; | |
228c54ef DT |
166 | } |
167 | ||
805bdaec | 168 | static inline bool device_may_wakeup(struct device *dev) |
228c54ef | 169 | { |
805bdaec | 170 | return dev->power.can_wakeup && dev->power.should_wakeup; |
228c54ef | 171 | } |
9a3df1f7 | 172 | |
4e1d9a73 PC |
173 | static inline bool device_wakeup_path(struct device *dev) |
174 | { | |
175 | return false; | |
176 | } | |
177 | ||
cf04ce78 UH |
178 | static inline void device_set_wakeup_path(struct device *dev) {} |
179 | ||
074037ec RW |
180 | static inline void __pm_stay_awake(struct wakeup_source *ws) {} |
181 | ||
182 | static inline void pm_stay_awake(struct device *dev) {} | |
183 | ||
184 | static inline void __pm_relax(struct wakeup_source *ws) {} | |
185 | ||
186 | static inline void pm_relax(struct device *dev) {} | |
187 | ||
8a537ece RW |
188 | static inline void pm_wakeup_ws_event(struct wakeup_source *ws, |
189 | unsigned int msec, bool hard) {} | |
074037ec | 190 | |
8a537ece RW |
191 | static inline void pm_wakeup_dev_event(struct device *dev, unsigned int msec, |
192 | bool hard) {} | |
074037ec RW |
193 | |
194 | #endif /* !CONFIG_PM_SLEEP */ | |
9a3df1f7 | 195 | |
10bb4e4a UH |
196 | static inline bool device_awake_path(struct device *dev) |
197 | { | |
198 | return device_wakeup_path(dev); | |
199 | } | |
200 | ||
201 | static inline void device_set_awake_path(struct device *dev) | |
202 | { | |
203 | device_set_wakeup_path(dev); | |
204 | } | |
205 | ||
8a537ece RW |
206 | static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) |
207 | { | |
208 | return pm_wakeup_ws_event(ws, msec, false); | |
209 | } | |
210 | ||
211 | static inline void pm_wakeup_event(struct device *dev, unsigned int msec) | |
212 | { | |
213 | return pm_wakeup_dev_event(dev, msec, false); | |
214 | } | |
215 | ||
216 | static inline void pm_wakeup_hard_event(struct device *dev) | |
217 | { | |
218 | return pm_wakeup_dev_event(dev, 0, true); | |
219 | } | |
220 | ||
09d3154a BH |
221 | /** |
222 | * device_init_wakeup - Device wakeup initialization. | |
223 | * @dev: Device to handle. | |
224 | * @enable: Whether or not to enable @dev as a wakeup device. | |
225 | * | |
226 | * By default, most devices should leave wakeup disabled. The exceptions are | |
227 | * devices that everyone expects to be wakeup sources: keyboards, power buttons, | |
228 | * possibly network interfaces, etc. Also, devices that don't generate their | |
229 | * own wakeup requests but merely forward requests from one bus to another | |
230 | * (like PCI bridges) should have wakeup enabled by default. | |
231 | */ | |
232 | static inline int device_init_wakeup(struct device *dev, bool enable) | |
233 | { | |
234 | if (enable) { | |
235 | device_set_wakeup_capable(dev, true); | |
236 | return device_wakeup_enable(dev); | |
09d3154a | 237 | } |
3642c7ed DG |
238 | device_wakeup_disable(dev); |
239 | device_set_wakeup_capable(dev, false); | |
240 | return 0; | |
09d3154a BH |
241 | } |
242 | ||
9a3df1f7 | 243 | #endif /* _LINUX_PM_WAKEUP_H */ |