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 * @event_count: Number of signaled wakeup events.
38 * @active_count: Number of times the wakeup sorce was activated.
39 * @relax_count: Number of times the wakeup sorce was deactivated.
40 * @expire_count: Number of times the wakeup source's timeout has expired.
41 * @wakeup_count: Number of times the wakeup source might abort suspend.
42 * @active: Status of the wakeup source.
43 * @has_timeout: The wakeup source has been activated with a timeout.
45 struct wakeup_source {
47 struct list_head entry;
49 struct timer_list timer;
50 unsigned long timer_expires;
54 unsigned long event_count;
55 unsigned long active_count;
56 unsigned long relax_count;
57 unsigned long expire_count;
58 unsigned long wakeup_count;
62 #ifdef CONFIG_PM_SLEEP
65 * Changes to device_may_wakeup take effect on the next pm state change.
68 static inline bool device_can_wakeup(struct device *dev)
70 return dev->power.can_wakeup;
73 static inline bool device_may_wakeup(struct device *dev)
75 return dev->power.can_wakeup && !!dev->power.wakeup;
78 /* drivers/base/power/wakeup.c */
79 extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name);
80 extern struct wakeup_source *wakeup_source_create(const char *name);
81 extern void wakeup_source_drop(struct wakeup_source *ws);
82 extern void wakeup_source_destroy(struct wakeup_source *ws);
83 extern void wakeup_source_add(struct wakeup_source *ws);
84 extern void wakeup_source_remove(struct wakeup_source *ws);
85 extern struct wakeup_source *wakeup_source_register(const char *name);
86 extern void wakeup_source_unregister(struct wakeup_source *ws);
87 extern int device_wakeup_enable(struct device *dev);
88 extern int device_wakeup_disable(struct device *dev);
89 extern void device_set_wakeup_capable(struct device *dev, bool capable);
90 extern int device_init_wakeup(struct device *dev, bool val);
91 extern int device_set_wakeup_enable(struct device *dev, bool enable);
92 extern void __pm_stay_awake(struct wakeup_source *ws);
93 extern void pm_stay_awake(struct device *dev);
94 extern void __pm_relax(struct wakeup_source *ws);
95 extern void pm_relax(struct device *dev);
96 extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec);
97 extern void pm_wakeup_event(struct device *dev, unsigned int msec);
99 #else /* !CONFIG_PM_SLEEP */
101 static inline void device_set_wakeup_capable(struct device *dev, bool capable)
103 dev->power.can_wakeup = capable;
106 static inline bool device_can_wakeup(struct device *dev)
108 return dev->power.can_wakeup;
111 static inline void wakeup_source_prepare(struct wakeup_source *ws,
114 static inline struct wakeup_source *wakeup_source_create(const char *name)
119 static inline void wakeup_source_drop(struct wakeup_source *ws) {}
121 static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
123 static inline void wakeup_source_add(struct wakeup_source *ws) {}
125 static inline void wakeup_source_remove(struct wakeup_source *ws) {}
127 static inline struct wakeup_source *wakeup_source_register(const char *name)
132 static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
134 static inline int device_wakeup_enable(struct device *dev)
136 dev->power.should_wakeup = true;
140 static inline int device_wakeup_disable(struct device *dev)
142 dev->power.should_wakeup = false;
146 static inline int device_set_wakeup_enable(struct device *dev, bool enable)
148 dev->power.should_wakeup = enable;
152 static inline int device_init_wakeup(struct device *dev, bool val)
154 device_set_wakeup_capable(dev, val);
155 device_set_wakeup_enable(dev, val);
159 static inline bool device_may_wakeup(struct device *dev)
161 return dev->power.can_wakeup && dev->power.should_wakeup;
164 static inline void __pm_stay_awake(struct wakeup_source *ws) {}
166 static inline void pm_stay_awake(struct device *dev) {}
168 static inline void __pm_relax(struct wakeup_source *ws) {}
170 static inline void pm_relax(struct device *dev) {}
172 static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {}
174 static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {}
176 #endif /* !CONFIG_PM_SLEEP */
178 static inline void wakeup_source_init(struct wakeup_source *ws,
181 wakeup_source_prepare(ws, name);
182 wakeup_source_add(ws);
185 static inline void wakeup_source_trash(struct wakeup_source *ws)
187 wakeup_source_remove(ws);
188 wakeup_source_drop(ws);
191 #endif /* _LINUX_PM_WAKEUP_H */