blob: d9f05113e5fb85204df5f45ee28d17e4596f31ee [file] [log] [blame]
Alan Stern9a3df1f2008-03-19 22:39:13 +01001/*
2 * pm_wakeup.h - Power management wakeup interface
3 *
4 * Copyright (C) 2008 Alan Stern
Rafael J. Wysocki074037e2010-09-22 22:09:10 +02005 * Copyright (C) 2010 Rafael J. Wysocki, Novell Inc.
Alan Stern9a3df1f2008-03-19 22:39:13 +01006 *
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
Dmitry Torokhov228c54e2010-03-15 21:44:41 +010029#include <linux/types.h>
30
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020031/**
32 * struct wakeup_source - Representation of wakeup sources
Alan Stern2430d122010-06-13 00:36:52 +020033 *
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020034 * @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 activated 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 * @hit_count: Number of times the wakeup sorce might abort system suspend.
41 * @active: Status of the wakeup source.
Alan Stern9a3df1f2008-03-19 22:39:13 +010042 */
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020043struct wakeup_source {
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +010044 const char *name;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020045 struct list_head entry;
46 spinlock_t lock;
47 struct timer_list timer;
48 unsigned long timer_expires;
49 ktime_t total_time;
50 ktime_t max_time;
51 ktime_t last_time;
52 unsigned long event_count;
53 unsigned long active_count;
54 unsigned long relax_count;
55 unsigned long hit_count;
56 unsigned int active:1;
57};
58
59#ifdef CONFIG_PM_SLEEP
60
61/*
62 * Changes to device_may_wakeup take effect on the next pm state change.
63 */
Alan Stern9a3df1f2008-03-19 22:39:13 +010064
Dmitry Torokhov228c54e2010-03-15 21:44:41 +010065static inline bool device_can_wakeup(struct device *dev)
Alan Stern9a3df1f2008-03-19 22:39:13 +010066{
67 return dev->power.can_wakeup;
68}
69
Dmitry Torokhov228c54e2010-03-15 21:44:41 +010070static inline bool device_may_wakeup(struct device *dev)
Alan Stern9a3df1f2008-03-19 22:39:13 +010071{
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020072 return dev->power.can_wakeup && !!dev->power.wakeup;
Alan Stern9a3df1f2008-03-19 22:39:13 +010073}
74
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020075/* drivers/base/power/wakeup.c */
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +010076extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020077extern struct wakeup_source *wakeup_source_create(const char *name);
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +010078extern void wakeup_source_drop(struct wakeup_source *ws);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020079extern void wakeup_source_destroy(struct wakeup_source *ws);
80extern void wakeup_source_add(struct wakeup_source *ws);
81extern void wakeup_source_remove(struct wakeup_source *ws);
82extern struct wakeup_source *wakeup_source_register(const char *name);
83extern void wakeup_source_unregister(struct wakeup_source *ws);
84extern int device_wakeup_enable(struct device *dev);
85extern int device_wakeup_disable(struct device *dev);
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +010086extern void device_set_wakeup_capable(struct device *dev, bool capable);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020087extern int device_init_wakeup(struct device *dev, bool val);
88extern int device_set_wakeup_enable(struct device *dev, bool enable);
89extern void __pm_stay_awake(struct wakeup_source *ws);
90extern void pm_stay_awake(struct device *dev);
91extern void __pm_relax(struct wakeup_source *ws);
92extern void pm_relax(struct device *dev);
93extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec);
94extern void pm_wakeup_event(struct device *dev, unsigned int msec);
Alan Stern9a3df1f2008-03-19 22:39:13 +010095
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020096#else /* !CONFIG_PM_SLEEP */
Alan Stern9a3df1f2008-03-19 22:39:13 +010097
Dmitry Torokhov228c54e2010-03-15 21:44:41 +010098static inline void device_set_wakeup_capable(struct device *dev, bool capable)
99{
Alan Stern2430d122010-06-13 00:36:52 +0200100 dev->power.can_wakeup = capable;
Dmitry Torokhov228c54e2010-03-15 21:44:41 +0100101}
Stephen Rothwellc300bd2fb2008-07-10 02:16:44 +0200102
Dmitry Torokhov228c54e2010-03-15 21:44:41 +0100103static inline bool device_can_wakeup(struct device *dev)
Alan Stern9a3df1f2008-03-19 22:39:13 +0100104{
105 return dev->power.can_wakeup;
106}
107
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +0100108static inline void wakeup_source_prepare(struct wakeup_source *ws,
109 const char *name) {}
110
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200111static inline struct wakeup_source *wakeup_source_create(const char *name)
112{
113 return NULL;
114}
115
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +0100116static inline void wakeup_source_drop(struct wakeup_source *ws) {}
117
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200118static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
119
120static inline void wakeup_source_add(struct wakeup_source *ws) {}
121
122static inline void wakeup_source_remove(struct wakeup_source *ws) {}
123
124static inline struct wakeup_source *wakeup_source_register(const char *name)
125{
126 return NULL;
127}
128
129static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
130
131static inline int device_wakeup_enable(struct device *dev)
132{
Rafael J. Wysocki805bdae2011-02-24 11:10:01 +0100133 dev->power.should_wakeup = true;
134 return 0;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200135}
136
137static inline int device_wakeup_disable(struct device *dev)
138{
Rafael J. Wysocki805bdae2011-02-24 11:10:01 +0100139 dev->power.should_wakeup = false;
140 return 0;
141}
142
143static inline int device_set_wakeup_enable(struct device *dev, bool enable)
144{
145 dev->power.should_wakeup = enable;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200146 return 0;
147}
148
149static inline int device_init_wakeup(struct device *dev, bool val)
150{
Rafael J. Wysocki805bdae2011-02-24 11:10:01 +0100151 device_set_wakeup_capable(dev, val);
152 device_set_wakeup_enable(dev, val);
153 return 0;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200154}
155
Rafael J. Wysocki805bdae2011-02-24 11:10:01 +0100156static inline bool device_may_wakeup(struct device *dev)
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200157{
Rafael J. Wysocki805bdae2011-02-24 11:10:01 +0100158 return dev->power.can_wakeup && dev->power.should_wakeup;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200159}
160
161static inline void __pm_stay_awake(struct wakeup_source *ws) {}
162
163static inline void pm_stay_awake(struct device *dev) {}
164
165static inline void __pm_relax(struct wakeup_source *ws) {}
166
167static inline void pm_relax(struct device *dev) {}
168
169static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {}
170
171static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {}
172
173#endif /* !CONFIG_PM_SLEEP */
Alan Stern9a3df1f2008-03-19 22:39:13 +0100174
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +0100175static inline void wakeup_source_init(struct wakeup_source *ws,
176 const char *name)
177{
178 wakeup_source_prepare(ws, name);
179 wakeup_source_add(ws);
180}
181
182static inline void wakeup_source_trash(struct wakeup_source *ws)
183{
184 wakeup_source_remove(ws);
185 wakeup_source_drop(ws);
186}
187
Alan Stern9a3df1f2008-03-19 22:39:13 +0100188#endif /* _LINUX_PM_WAKEUP_H */