2 * pm_wakeup.h - Power management wakeup interface
4 * Copyright (C) 2008 Alan Stern
5 * Copyright (C) 2010 Rafael J. Wysocki, Novell Inc.
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.
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.
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
22 #ifndef _LINUX_PM_WAKEUP_H
23 #define _LINUX_PM_WAKEUP_H
26 # error "please don't include this file directly"
29 #include <linux/types.h>
32 * struct wakeup_source - Representation of wakeup sources
34 * @total_time: Total time this wakeup source has been active.
35 * @max_time: Maximum time this wakeup source has been continuously active.
36 * @last_time: Monotonic clock when the wakeup source's was touched last time.
37 * @prevent_sleep_time: Total time this source has been preventing autosleep.
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.
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.
43 * @active: Status of the wakeup source.
44 * @has_timeout: The wakeup source has been activated with a timeout.
46 struct wakeup_source {
48 struct list_head entry;
50 struct timer_list timer;
51 unsigned long timer_expires;
55 ktime_t start_prevent_time;
56 ktime_t prevent_sleep_time;
57 #ifdef CONFIG_PM_SLEEP_HISTORY
61 unsigned long event_count;
62 unsigned long active_count;
63 unsigned long relax_count;
64 unsigned long expire_count;
65 unsigned long wakeup_count;
67 bool autosleep_enabled:1;
70 #ifdef CONFIG_PM_SLEEP
73 * Changes to device_may_wakeup take effect on the next pm state change.
76 static inline bool device_can_wakeup(struct device *dev)
78 return dev->power.can_wakeup;
81 static inline bool device_may_wakeup(struct device *dev)
83 return dev->power.can_wakeup && !!dev->power.wakeup;
86 /* drivers/base/power/wakeup.c */
87 extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name);
88 extern struct wakeup_source *wakeup_source_create(const char *name);
89 extern void wakeup_source_drop(struct wakeup_source *ws);
90 extern void wakeup_source_destroy(struct wakeup_source *ws);
91 extern void wakeup_source_add(struct wakeup_source *ws);
92 extern void wakeup_source_remove(struct wakeup_source *ws);
93 extern struct wakeup_source *wakeup_source_register(const char *name);
94 extern void wakeup_source_unregister(struct wakeup_source *ws);
95 extern int device_wakeup_enable(struct device *dev);
96 extern int device_wakeup_disable(struct device *dev);
97 extern void device_set_wakeup_capable(struct device *dev, bool capable);
98 extern int device_init_wakeup(struct device *dev, bool val);
99 extern int device_set_wakeup_enable(struct device *dev, bool enable);
100 extern void __pm_stay_awake(struct wakeup_source *ws);
101 extern void pm_stay_awake(struct device *dev);
102 extern void __pm_relax(struct wakeup_source *ws);
103 extern void pm_relax(struct device *dev);
104 extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec);
105 extern void pm_wakeup_event(struct device *dev, unsigned int msec);
107 #else /* !CONFIG_PM_SLEEP */
109 static inline void device_set_wakeup_capable(struct device *dev, bool capable)
111 dev->power.can_wakeup = capable;
114 static inline bool device_can_wakeup(struct device *dev)
116 return dev->power.can_wakeup;
119 static inline void wakeup_source_prepare(struct wakeup_source *ws,
122 static inline struct wakeup_source *wakeup_source_create(const char *name)
127 static inline void wakeup_source_drop(struct wakeup_source *ws) {}
129 static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
131 static inline void wakeup_source_add(struct wakeup_source *ws) {}
133 static inline void wakeup_source_remove(struct wakeup_source *ws) {}
135 static inline struct wakeup_source *wakeup_source_register(const char *name)
140 static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
142 static inline int device_wakeup_enable(struct device *dev)
144 dev->power.should_wakeup = true;
148 static inline int device_wakeup_disable(struct device *dev)
150 dev->power.should_wakeup = false;
154 static inline int device_set_wakeup_enable(struct device *dev, bool enable)
156 dev->power.should_wakeup = enable;
160 static inline int device_init_wakeup(struct device *dev, bool val)
162 device_set_wakeup_capable(dev, val);
163 device_set_wakeup_enable(dev, val);
167 static inline bool device_may_wakeup(struct device *dev)
169 return dev->power.can_wakeup && dev->power.should_wakeup;
172 static inline void __pm_stay_awake(struct wakeup_source *ws) {}
174 static inline void pm_stay_awake(struct device *dev) {}
176 static inline void __pm_relax(struct wakeup_source *ws) {}
178 static inline void pm_relax(struct device *dev) {}
180 static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {}
182 static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {}
184 #endif /* !CONFIG_PM_SLEEP */
186 static inline void wakeup_source_init(struct wakeup_source *ws,
189 wakeup_source_prepare(ws, name);
190 wakeup_source_add(ws);
193 static inline void wakeup_source_trash(struct wakeup_source *ws)
195 wakeup_source_remove(ws);
196 wakeup_source_drop(ws);
199 #endif /* _LINUX_PM_WAKEUP_H */