1/*
2 *  pm_wakeup.h - Power management wakeup interface
3 *
4 *  Copyright (C) 2008 Alan Stern
5 *  Copyright (C) 2010 Rafael J. Wysocki, Novell Inc.
6 *
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.
11 *
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.
16 *
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
20 */
21
22#ifndef _LINUX_PM_WAKEUP_H
23#define _LINUX_PM_WAKEUP_H
24
25#ifndef _DEVICE_H_
26# error "please don't include this file directly"
27#endif
28
29#include <linux/types.h>
30
31/**
32 * struct wakeup_source - Representation of wakeup sources
33 *
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 source was activated.
40 * @relax_count: Number of times the wakeup source 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.
45 */
46struct wakeup_source {
47	const char 		*name;
48	struct list_head	entry;
49	spinlock_t		lock;
50	struct timer_list	timer;
51	unsigned long		timer_expires;
52	ktime_t total_time;
53	ktime_t max_time;
54	ktime_t last_time;
55	ktime_t start_prevent_time;
56	ktime_t prevent_sleep_time;
57	unsigned long		event_count;
58	unsigned long		active_count;
59	unsigned long		relax_count;
60	unsigned long		expire_count;
61	unsigned long		wakeup_count;
62	bool			active:1;
63	bool			autosleep_enabled:1;
64};
65
66#ifdef CONFIG_PM_SLEEP
67
68/*
69 * Changes to device_may_wakeup take effect on the next pm state change.
70 */
71
72static inline bool device_can_wakeup(struct device *dev)
73{
74	return dev->power.can_wakeup;
75}
76
77static inline bool device_may_wakeup(struct device *dev)
78{
79	return dev->power.can_wakeup && !!dev->power.wakeup;
80}
81
82/* drivers/base/power/wakeup.c */
83extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name);
84extern struct wakeup_source *wakeup_source_create(const char *name);
85extern void wakeup_source_drop(struct wakeup_source *ws);
86extern void wakeup_source_destroy(struct wakeup_source *ws);
87extern void wakeup_source_add(struct wakeup_source *ws);
88extern void wakeup_source_remove(struct wakeup_source *ws);
89extern struct wakeup_source *wakeup_source_register(const char *name);
90extern void wakeup_source_unregister(struct wakeup_source *ws);
91extern int device_wakeup_enable(struct device *dev);
92extern int device_wakeup_disable(struct device *dev);
93extern void device_set_wakeup_capable(struct device *dev, bool capable);
94extern int device_init_wakeup(struct device *dev, bool val);
95extern int device_set_wakeup_enable(struct device *dev, bool enable);
96extern void __pm_stay_awake(struct wakeup_source *ws);
97extern void pm_stay_awake(struct device *dev);
98extern void __pm_relax(struct wakeup_source *ws);
99extern void pm_relax(struct device *dev);
100extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec);
101extern void pm_wakeup_event(struct device *dev, unsigned int msec);
102
103#else /* !CONFIG_PM_SLEEP */
104
105static inline void device_set_wakeup_capable(struct device *dev, bool capable)
106{
107	dev->power.can_wakeup = capable;
108}
109
110static inline bool device_can_wakeup(struct device *dev)
111{
112	return dev->power.can_wakeup;
113}
114
115static inline void wakeup_source_prepare(struct wakeup_source *ws,
116					 const char *name) {}
117
118static inline struct wakeup_source *wakeup_source_create(const char *name)
119{
120	return NULL;
121}
122
123static inline void wakeup_source_drop(struct wakeup_source *ws) {}
124
125static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
126
127static inline void wakeup_source_add(struct wakeup_source *ws) {}
128
129static inline void wakeup_source_remove(struct wakeup_source *ws) {}
130
131static inline struct wakeup_source *wakeup_source_register(const char *name)
132{
133	return NULL;
134}
135
136static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
137
138static inline int device_wakeup_enable(struct device *dev)
139{
140	dev->power.should_wakeup = true;
141	return 0;
142}
143
144static inline int device_wakeup_disable(struct device *dev)
145{
146	dev->power.should_wakeup = false;
147	return 0;
148}
149
150static inline int device_set_wakeup_enable(struct device *dev, bool enable)
151{
152	dev->power.should_wakeup = enable;
153	return 0;
154}
155
156static inline int device_init_wakeup(struct device *dev, bool val)
157{
158	device_set_wakeup_capable(dev, val);
159	device_set_wakeup_enable(dev, val);
160	return 0;
161}
162
163static inline bool device_may_wakeup(struct device *dev)
164{
165	return dev->power.can_wakeup && dev->power.should_wakeup;
166}
167
168static inline void __pm_stay_awake(struct wakeup_source *ws) {}
169
170static inline void pm_stay_awake(struct device *dev) {}
171
172static inline void __pm_relax(struct wakeup_source *ws) {}
173
174static inline void pm_relax(struct device *dev) {}
175
176static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {}
177
178static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {}
179
180#endif /* !CONFIG_PM_SLEEP */
181
182static inline void wakeup_source_init(struct wakeup_source *ws,
183				      const char *name)
184{
185	wakeup_source_prepare(ws, name);
186	wakeup_source_add(ws);
187}
188
189static inline void wakeup_source_trash(struct wakeup_source *ws)
190{
191	wakeup_source_remove(ws);
192	wakeup_source_drop(ws);
193}
194
195#endif /* _LINUX_PM_WAKEUP_H */
196