Merge tag 'xfs-for-linus-4.7-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-block.git] / include / linux / pm_wakeup.h
CommitLineData
9a3df1f7
AS
1/*
2 * pm_wakeup.h - Power management wakeup interface
3 *
4 * Copyright (C) 2008 Alan Stern
074037ec 5 * Copyright (C) 2010 Rafael J. Wysocki, Novell Inc.
9a3df1f7
AS
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
228c54ef
DT
29#include <linux/types.h>
30
4990d4fe
TL
31struct wake_irq;
32
074037ec
RW
33/**
34 * struct wakeup_source - Representation of wakeup sources
2430d12c 35 *
4990d4fe
TL
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
074037ec
RW
42 * @total_time: Total time this wakeup source has been active.
43 * @max_time: Maximum time this wakeup source has been continuously active.
30e3ce6d 44 * @last_time: Monotonic clock when the wakeup source's was touched last time.
55850945 45 * @prevent_sleep_time: Total time this source has been preventing autosleep.
074037ec 46 * @event_count: Number of signaled wakeup events.
1258ca80
CC
47 * @active_count: Number of times the wakeup source was activated.
48 * @relax_count: Number of times the wakeup source was deactivated.
30e3ce6d
RW
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.
074037ec 51 * @active: Status of the wakeup source.
30e3ce6d 52 * @has_timeout: The wakeup source has been activated with a timeout.
9a3df1f7 53 */
074037ec 54struct wakeup_source {
8671bbc1 55 const char *name;
074037ec
RW
56 struct list_head entry;
57 spinlock_t lock;
4990d4fe 58 struct wake_irq *wakeirq;
074037ec
RW
59 struct timer_list timer;
60 unsigned long timer_expires;
61 ktime_t total_time;
62 ktime_t max_time;
63 ktime_t last_time;
55850945
RW
64 ktime_t start_prevent_time;
65 ktime_t prevent_sleep_time;
074037ec
RW
66 unsigned long event_count;
67 unsigned long active_count;
68 unsigned long relax_count;
30e3ce6d
RW
69 unsigned long expire_count;
70 unsigned long wakeup_count;
71 bool active:1;
55850945 72 bool autosleep_enabled:1;
074037ec
RW
73};
74
75#ifdef CONFIG_PM_SLEEP
76
77/*
78 * Changes to device_may_wakeup take effect on the next pm state change.
79 */
80
074037ec
RW
81static inline bool device_can_wakeup(struct device *dev)
82{
83 return dev->power.can_wakeup;
84}
85
074037ec 86static inline bool device_may_wakeup(struct device *dev)
9a3df1f7 87{
074037ec 88 return dev->power.can_wakeup && !!dev->power.wakeup;
9a3df1f7
AS
89}
90
074037ec 91/* drivers/base/power/wakeup.c */
8671bbc1 92extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name);
074037ec 93extern struct wakeup_source *wakeup_source_create(const char *name);
8671bbc1 94extern void wakeup_source_drop(struct wakeup_source *ws);
074037ec
RW
95extern void wakeup_source_destroy(struct wakeup_source *ws);
96extern void wakeup_source_add(struct wakeup_source *ws);
97extern void wakeup_source_remove(struct wakeup_source *ws);
98extern struct wakeup_source *wakeup_source_register(const char *name);
99extern void wakeup_source_unregister(struct wakeup_source *ws);
100extern int device_wakeup_enable(struct device *dev);
101extern int device_wakeup_disable(struct device *dev);
cb8f51bd 102extern void device_set_wakeup_capable(struct device *dev, bool capable);
074037ec
RW
103extern int device_init_wakeup(struct device *dev, bool val);
104extern int device_set_wakeup_enable(struct device *dev, bool enable);
105extern void __pm_stay_awake(struct wakeup_source *ws);
106extern void pm_stay_awake(struct device *dev);
107extern void __pm_relax(struct wakeup_source *ws);
108extern void pm_relax(struct device *dev);
109extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec);
110extern void pm_wakeup_event(struct device *dev, unsigned int msec);
111
112#else /* !CONFIG_PM_SLEEP */
113
228c54ef 114static inline void device_set_wakeup_capable(struct device *dev, bool capable)
eb9d0fe4 115{
228c54ef 116 dev->power.can_wakeup = capable;
eb9d0fe4
RW
117}
118
228c54ef 119static inline bool device_can_wakeup(struct device *dev)
9a3df1f7
AS
120{
121 return dev->power.can_wakeup;
122}
123
8671bbc1
RW
124static inline void wakeup_source_prepare(struct wakeup_source *ws,
125 const char *name) {}
126
074037ec 127static inline struct wakeup_source *wakeup_source_create(const char *name)
9a3df1f7 128{
074037ec 129 return NULL;
9a3df1f7
AS
130}
131
8671bbc1
RW
132static inline void wakeup_source_drop(struct wakeup_source *ws) {}
133
074037ec
RW
134static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
135
136static inline void wakeup_source_add(struct wakeup_source *ws) {}
9a3df1f7 137
074037ec
RW
138static inline void wakeup_source_remove(struct wakeup_source *ws) {}
139
140static inline struct wakeup_source *wakeup_source_register(const char *name)
9a3df1f7 141{
074037ec 142 return NULL;
9a3df1f7
AS
143}
144
074037ec
RW
145static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
146
147static inline int device_wakeup_enable(struct device *dev)
228c54ef 148{
805bdaec
RW
149 dev->power.should_wakeup = true;
150 return 0;
228c54ef 151}
c300bd2f 152
074037ec 153static inline int device_wakeup_disable(struct device *dev)
9a3df1f7 154{
805bdaec 155 dev->power.should_wakeup = false;
074037ec 156 return 0;
9a3df1f7
AS
157}
158
805bdaec 159static inline int device_set_wakeup_enable(struct device *dev, bool enable)
228c54ef 160{
805bdaec
RW
161 dev->power.should_wakeup = enable;
162 return 0;
228c54ef
DT
163}
164
805bdaec
RW
165static inline int device_init_wakeup(struct device *dev, bool val)
166{
167 device_set_wakeup_capable(dev, val);
168 device_set_wakeup_enable(dev, val);
169 return 0;
170}
074037ec 171
805bdaec 172static inline bool device_may_wakeup(struct device *dev)
228c54ef 173{
805bdaec 174 return dev->power.can_wakeup && dev->power.should_wakeup;
228c54ef 175}
9a3df1f7 176
074037ec
RW
177static inline void __pm_stay_awake(struct wakeup_source *ws) {}
178
179static inline void pm_stay_awake(struct device *dev) {}
180
181static inline void __pm_relax(struct wakeup_source *ws) {}
182
183static inline void pm_relax(struct device *dev) {}
184
185static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {}
186
187static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {}
188
189#endif /* !CONFIG_PM_SLEEP */
9a3df1f7 190
8671bbc1
RW
191static inline void wakeup_source_init(struct wakeup_source *ws,
192 const char *name)
193{
194 wakeup_source_prepare(ws, name);
195 wakeup_source_add(ws);
196}
197
198static inline void wakeup_source_trash(struct wakeup_source *ws)
199{
200 wakeup_source_remove(ws);
201 wakeup_source_drop(ws);
202}
203
9a3df1f7 204#endif /* _LINUX_PM_WAKEUP_H */