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>
34 * struct wakeup_source - Representation of wakeup sources
36 * @name: Name of the wakeup source
37 * @entry: Wakeup source list entry
38 * @lock: Wakeup source lock
39 * @wakeirq: Optional device specific wakeirq
40 * @timer: Wakeup timer list
41 * @timer_expires: Wakeup timer expiration
42 * @total_time: Total time this wakeup source has been active.
43 * @max_time: Maximum time this wakeup source has been continuously active.
44 * @last_time: Monotonic clock when the wakeup source's was touched last time.
45 * @prevent_sleep_time: Total time this source has been preventing autosleep.
46 * @event_count: Number of signaled wakeup events.
47 * @active_count: Number of times the wakeup source was activated.
48 * @relax_count: Number of times the wakeup source was deactivated.
49 * @expire_count: Number of times the wakeup source's timeout has expired.
50 * @wakeup_count: Number of times the wakeup source might abort suspend.
51 * @active: Status of the wakeup source.
52 * @has_timeout: The wakeup source has been activated with a timeout.
54 struct wakeup_source {
56 struct list_head entry;
58 struct wake_irq *wakeirq;
59 struct timer_list timer;
60 unsigned long timer_expires;
64 ktime_t start_prevent_time;
65 ktime_t prevent_sleep_time;
66 unsigned long event_count;
67 unsigned long active_count;
68 unsigned long relax_count;
69 unsigned long expire_count;
70 unsigned long wakeup_count;
72 bool autosleep_enabled:1;
75 #ifdef CONFIG_PM_SLEEP
78 * Changes to device_may_wakeup take effect on the next pm state change.
81 static inline bool device_can_wakeup(struct device *dev)
83 return dev->power.can_wakeup;
86 static inline bool device_may_wakeup(struct device *dev)
88 return dev->power.can_wakeup && !!dev->power.wakeup;
91 static inline void device_set_wakeup_path(struct device *dev)
93 dev->power.wakeup_path = true;
96 /* drivers/base/power/wakeup.c */
97 extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name);
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(const char *name);
103 extern void wakeup_source_unregister(struct wakeup_source *ws);
104 extern int device_wakeup_enable(struct device *dev);
105 extern int device_wakeup_disable(struct device *dev);
106 extern void device_set_wakeup_capable(struct device *dev, bool capable);
107 extern int device_init_wakeup(struct device *dev, bool val);
108 extern int device_set_wakeup_enable(struct device *dev, bool enable);
109 extern void __pm_stay_awake(struct wakeup_source *ws);
110 extern void pm_stay_awake(struct device *dev);
111 extern void __pm_relax(struct wakeup_source *ws);
112 extern void pm_relax(struct device *dev);
113 extern void pm_wakeup_ws_event(struct wakeup_source *ws, unsigned int msec, bool hard);
114 extern void pm_wakeup_dev_event(struct device *dev, unsigned int msec, bool hard);
116 #else /* !CONFIG_PM_SLEEP */
118 static inline void device_set_wakeup_capable(struct device *dev, bool capable)
120 dev->power.can_wakeup = capable;
123 static inline bool device_can_wakeup(struct device *dev)
125 return dev->power.can_wakeup;
128 static inline void wakeup_source_prepare(struct wakeup_source *ws,
131 static inline struct wakeup_source *wakeup_source_create(const char *name)
136 static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
138 static inline void wakeup_source_add(struct wakeup_source *ws) {}
140 static inline void wakeup_source_remove(struct wakeup_source *ws) {}
142 static inline struct wakeup_source *wakeup_source_register(const char *name)
147 static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
149 static inline int device_wakeup_enable(struct device *dev)
151 dev->power.should_wakeup = true;
155 static inline int device_wakeup_disable(struct device *dev)
157 dev->power.should_wakeup = false;
161 static inline int device_set_wakeup_enable(struct device *dev, bool enable)
163 dev->power.should_wakeup = enable;
167 static inline int device_init_wakeup(struct device *dev, bool val)
169 device_set_wakeup_capable(dev, val);
170 device_set_wakeup_enable(dev, val);
174 static inline bool device_may_wakeup(struct device *dev)
176 return dev->power.can_wakeup && dev->power.should_wakeup;
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 void wakeup_source_init(struct wakeup_source *ws,
200 wakeup_source_prepare(ws, name);
201 wakeup_source_add(ws);
204 static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec)
206 return pm_wakeup_ws_event(ws, msec, false);
209 static inline void pm_wakeup_event(struct device *dev, unsigned int msec)
211 return pm_wakeup_dev_event(dev, msec, false);
214 static inline void pm_wakeup_hard_event(struct device *dev)
216 return pm_wakeup_dev_event(dev, 0, true);
219 #endif /* _LINUX_PM_WAKEUP_H */