1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * pm_wakeup.h - Power management wakeup interface
5 * Copyright (C) 2008 Alan Stern
6 * Copyright (C) 2010 Rafael J. Wysocki, Novell Inc.
9 #ifndef _LINUX_PM_WAKEUP_H
10 #define _LINUX_PM_WAKEUP_H
13 # error "please don't include this file directly"
16 #include <linux/types.h>
21 * struct wakeup_source - Representation of wakeup sources
23 * @name: Name of the wakeup source
24 * @id: Wakeup source id
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
30 * @total_time: Total time this wakeup source has been active.
31 * @max_time: Maximum time this wakeup source has been continuously active.
32 * @last_time: Monotonic clock when the wakeup source's was touched last time.
33 * @prevent_sleep_time: Total time this source has been preventing autosleep.
34 * @event_count: Number of signaled wakeup events.
35 * @active_count: Number of times the wakeup source was activated.
36 * @relax_count: Number of times the wakeup source was deactivated.
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.
39 * @dev: Struct device for sysfs statistics about the wakeup source.
40 * @active: Status of the wakeup source.
41 * @autosleep_enabled: Autosleep is active, so update @prevent_sleep_time.
43 struct wakeup_source {
46 struct list_head entry;
48 struct wake_irq *wakeirq;
49 struct timer_list timer;
50 unsigned long timer_expires;
54 ktime_t start_prevent_time;
55 ktime_t prevent_sleep_time;
56 unsigned long event_count;
57 unsigned long active_count;
58 unsigned long relax_count;
59 unsigned long expire_count;
60 unsigned long wakeup_count;
63 bool autosleep_enabled:1;
66 #define for_each_wakeup_source(ws) \
67 for ((ws) = wakeup_sources_walk_start(); \
69 (ws) = wakeup_sources_walk_next((ws)))
71 #ifdef CONFIG_PM_SLEEP
74 * Changes to device_may_wakeup take effect on the next pm state change.
77 static inline bool device_can_wakeup(struct device *dev)
79 return dev->power.can_wakeup;
82 static inline bool device_may_wakeup(struct device *dev)
84 return dev->power.can_wakeup && !!dev->power.wakeup;
87 static inline bool device_wakeup_path(struct device *dev)
89 return dev->power.wakeup_path;
92 static inline void device_set_wakeup_path(struct device *dev)
94 dev->power.wakeup_path = true;
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);
102 extern struct wakeup_source *wakeup_source_register(struct device *dev,
104 extern void wakeup_source_unregister(struct wakeup_source *ws);
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);
109 extern int device_wakeup_enable(struct device *dev);
110 extern int device_wakeup_disable(struct device *dev);
111 extern void device_set_wakeup_capable(struct device *dev, bool capable);
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);
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);
120 #else /* !CONFIG_PM_SLEEP */
122 static inline void device_set_wakeup_capable(struct device *dev, bool capable)
124 dev->power.can_wakeup = capable;
127 static inline bool device_can_wakeup(struct device *dev)
129 return dev->power.can_wakeup;
132 static inline struct wakeup_source *wakeup_source_create(const char *name)
137 static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
139 static inline void wakeup_source_add(struct wakeup_source *ws) {}
141 static inline void wakeup_source_remove(struct wakeup_source *ws) {}
143 static inline struct wakeup_source *wakeup_source_register(struct device *dev,
149 static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
151 static inline int device_wakeup_enable(struct device *dev)
153 dev->power.should_wakeup = true;
157 static inline int device_wakeup_disable(struct device *dev)
159 dev->power.should_wakeup = false;
163 static inline int device_set_wakeup_enable(struct device *dev, bool enable)
165 dev->power.should_wakeup = enable;
169 static inline bool device_may_wakeup(struct device *dev)
171 return dev->power.can_wakeup && dev->power.should_wakeup;
174 static inline bool device_wakeup_path(struct device *dev)
179 static inline void device_set_wakeup_path(struct device *dev) {}
181 static inline void __pm_stay_awake(struct wakeup_source *ws) {}
183 static inline void pm_stay_awake(struct device *dev) {}
185 static inline void __pm_relax(struct wakeup_source *ws) {}
187 static inline void pm_relax(struct device *dev) {}
189 static inline void pm_wakeup_ws_event(struct wakeup_source *ws,
190 unsigned int msec, bool hard) {}
192 static inline void pm_wakeup_dev_event(struct device *dev, unsigned int msec,
195 #endif /* !CONFIG_PM_SLEEP */
197 static inline bool device_awake_path(struct device *dev)
199 return device_wakeup_path(dev);
202 static inline void device_set_awake_path(struct device *dev)
204 device_set_wakeup_path(dev);
207 static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec)
209 return pm_wakeup_ws_event(ws, msec, false);
212 static inline void pm_wakeup_event(struct device *dev, unsigned int msec)
214 return pm_wakeup_dev_event(dev, msec, false);
217 static inline void pm_wakeup_hard_event(struct device *dev)
219 return pm_wakeup_dev_event(dev, 0, true);
223 * device_init_wakeup - Device wakeup initialization.
224 * @dev: Device to handle.
225 * @enable: Whether or not to enable @dev as a wakeup device.
227 * By default, most devices should leave wakeup disabled. The exceptions are
228 * devices that everyone expects to be wakeup sources: keyboards, power buttons,
229 * possibly network interfaces, etc. Also, devices that don't generate their
230 * own wakeup requests but merely forward requests from one bus to another
231 * (like PCI bridges) should have wakeup enabled by default.
233 static inline int device_init_wakeup(struct device *dev, bool enable)
236 device_set_wakeup_capable(dev, true);
237 return device_wakeup_enable(dev);
239 device_wakeup_disable(dev);
240 device_set_wakeup_capable(dev, false);
245 #endif /* _LINUX_PM_WAKEUP_H */