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_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
);
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
);
121 #else /* !CONFIG_PM_SLEEP */
123 static inline void device_set_wakeup_capable(struct device
*dev
, bool capable
)
125 dev
->power
.can_wakeup
= capable
;
128 static inline bool device_can_wakeup(struct device
*dev
)
130 return dev
->power
.can_wakeup
;
133 static inline struct wakeup_source
*wakeup_source_create(const char *name
)
138 static inline void wakeup_source_destroy(struct wakeup_source
*ws
) {}
140 static inline void wakeup_source_add(struct wakeup_source
*ws
) {}
142 static inline void wakeup_source_remove(struct wakeup_source
*ws
) {}
144 static inline struct wakeup_source
*wakeup_source_register(struct device
*dev
,
150 static inline void wakeup_source_unregister(struct wakeup_source
*ws
) {}
152 static inline int device_wakeup_enable(struct device
*dev
)
154 dev
->power
.should_wakeup
= true;
158 static inline int device_wakeup_disable(struct device
*dev
)
160 dev
->power
.should_wakeup
= false;
164 static inline int device_set_wakeup_enable(struct device
*dev
, bool enable
)
166 dev
->power
.should_wakeup
= enable
;
170 static inline int device_init_wakeup(struct device
*dev
, bool val
)
172 device_set_wakeup_capable(dev
, val
);
173 device_set_wakeup_enable(dev
, val
);
177 static inline bool device_may_wakeup(struct device
*dev
)
179 return dev
->power
.can_wakeup
&& dev
->power
.should_wakeup
;
182 static inline bool device_wakeup_path(struct device
*dev
)
187 static inline void device_set_wakeup_path(struct device
*dev
) {}
189 static inline void __pm_stay_awake(struct wakeup_source
*ws
) {}
191 static inline void pm_stay_awake(struct device
*dev
) {}
193 static inline void __pm_relax(struct wakeup_source
*ws
) {}
195 static inline void pm_relax(struct device
*dev
) {}
197 static inline void pm_wakeup_ws_event(struct wakeup_source
*ws
,
198 unsigned int msec
, bool hard
) {}
200 static inline void pm_wakeup_dev_event(struct device
*dev
, unsigned int msec
,
203 #endif /* !CONFIG_PM_SLEEP */
205 static inline void __pm_wakeup_event(struct wakeup_source
*ws
, unsigned int msec
)
207 return pm_wakeup_ws_event(ws
, msec
, false);
210 static inline void pm_wakeup_event(struct device
*dev
, unsigned int msec
)
212 return pm_wakeup_dev_event(dev
, msec
, false);
215 static inline void pm_wakeup_hard_event(struct device
*dev
)
217 return pm_wakeup_dev_event(dev
, 0, true);
220 #endif /* _LINUX_PM_WAKEUP_H */