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 RW |
109 | extern int device_wakeup_enable(struct device *dev); |
110 | extern int 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_init_wakeup(struct device *dev, bool val); |
113 | extern int device_set_wakeup_enable(struct device *dev, bool enable); | |
114 | extern void __pm_stay_awake(struct wakeup_source *ws); | |
115 | extern void pm_stay_awake(struct device *dev); | |
116 | extern void __pm_relax(struct wakeup_source *ws); | |
117 | extern void pm_relax(struct device *dev); | |
8a537ece RW |
118 | extern void pm_wakeup_ws_event(struct wakeup_source *ws, unsigned int msec, bool hard); |
119 | extern void pm_wakeup_dev_event(struct device *dev, unsigned int msec, bool hard); | |
074037ec RW |
120 | |
121 | #else /* !CONFIG_PM_SLEEP */ | |
122 | ||
228c54ef | 123 | static inline void device_set_wakeup_capable(struct device *dev, bool capable) |
eb9d0fe4 | 124 | { |
228c54ef | 125 | dev->power.can_wakeup = capable; |
eb9d0fe4 RW |
126 | } |
127 | ||
228c54ef | 128 | static inline bool device_can_wakeup(struct device *dev) |
9a3df1f7 AS |
129 | { |
130 | return dev->power.can_wakeup; | |
131 | } | |
132 | ||
074037ec | 133 | static inline struct wakeup_source *wakeup_source_create(const char *name) |
9a3df1f7 | 134 | { |
074037ec | 135 | return NULL; |
9a3df1f7 AS |
136 | } |
137 | ||
074037ec RW |
138 | static inline void wakeup_source_destroy(struct wakeup_source *ws) {} |
139 | ||
140 | static inline void wakeup_source_add(struct wakeup_source *ws) {} | |
9a3df1f7 | 141 | |
074037ec RW |
142 | static inline void wakeup_source_remove(struct wakeup_source *ws) {} |
143 | ||
c8377adf TV |
144 | static inline struct wakeup_source *wakeup_source_register(struct device *dev, |
145 | const char *name) | |
9a3df1f7 | 146 | { |
074037ec | 147 | return NULL; |
9a3df1f7 AS |
148 | } |
149 | ||
074037ec RW |
150 | static inline void wakeup_source_unregister(struct wakeup_source *ws) {} |
151 | ||
152 | static inline int device_wakeup_enable(struct device *dev) | |
228c54ef | 153 | { |
805bdaec RW |
154 | dev->power.should_wakeup = true; |
155 | return 0; | |
228c54ef | 156 | } |
c300bd2f | 157 | |
074037ec | 158 | static inline int device_wakeup_disable(struct device *dev) |
9a3df1f7 | 159 | { |
805bdaec | 160 | dev->power.should_wakeup = false; |
074037ec | 161 | return 0; |
9a3df1f7 AS |
162 | } |
163 | ||
805bdaec | 164 | static inline int device_set_wakeup_enable(struct device *dev, bool enable) |
228c54ef | 165 | { |
805bdaec RW |
166 | dev->power.should_wakeup = enable; |
167 | return 0; | |
228c54ef DT |
168 | } |
169 | ||
805bdaec RW |
170 | static inline int device_init_wakeup(struct device *dev, bool val) |
171 | { | |
172 | device_set_wakeup_capable(dev, val); | |
173 | device_set_wakeup_enable(dev, val); | |
174 | return 0; | |
175 | } | |
074037ec | 176 | |
805bdaec | 177 | static inline bool device_may_wakeup(struct device *dev) |
228c54ef | 178 | { |
805bdaec | 179 | return dev->power.can_wakeup && dev->power.should_wakeup; |
228c54ef | 180 | } |
9a3df1f7 | 181 | |
4e1d9a73 PC |
182 | static inline bool device_wakeup_path(struct device *dev) |
183 | { | |
184 | return false; | |
185 | } | |
186 | ||
cf04ce78 UH |
187 | static inline void device_set_wakeup_path(struct device *dev) {} |
188 | ||
074037ec RW |
189 | static inline void __pm_stay_awake(struct wakeup_source *ws) {} |
190 | ||
191 | static inline void pm_stay_awake(struct device *dev) {} | |
192 | ||
193 | static inline void __pm_relax(struct wakeup_source *ws) {} | |
194 | ||
195 | static inline void pm_relax(struct device *dev) {} | |
196 | ||
8a537ece RW |
197 | static inline void pm_wakeup_ws_event(struct wakeup_source *ws, |
198 | unsigned int msec, bool hard) {} | |
074037ec | 199 | |
8a537ece RW |
200 | static inline void pm_wakeup_dev_event(struct device *dev, unsigned int msec, |
201 | bool hard) {} | |
074037ec RW |
202 | |
203 | #endif /* !CONFIG_PM_SLEEP */ | |
9a3df1f7 | 204 | |
8a537ece RW |
205 | static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) |
206 | { | |
207 | return pm_wakeup_ws_event(ws, msec, false); | |
208 | } | |
209 | ||
210 | static inline void pm_wakeup_event(struct device *dev, unsigned int msec) | |
211 | { | |
212 | return pm_wakeup_dev_event(dev, msec, false); | |
213 | } | |
214 | ||
215 | static inline void pm_wakeup_hard_event(struct device *dev) | |
216 | { | |
217 | return pm_wakeup_dev_event(dev, 0, true); | |
218 | } | |
219 | ||
9a3df1f7 | 220 | #endif /* _LINUX_PM_WAKEUP_H */ |