Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 1 | /* |
| 2 | * pm_wakeup.h - Power management wakeup interface |
| 3 | * |
| 4 | * Copyright (C) 2008 Alan Stern |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 5 | * Copyright (C) 2010 Rafael J. Wysocki, Novell Inc. |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 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 | |
Dmitry Torokhov | 228c54e | 2010-03-15 21:44:41 +0100 | [diff] [blame] | 29 | #include <linux/types.h> |
| 30 | |
Tony Lindgren | 4990d4f | 2015-05-18 15:40:29 -0700 | [diff] [blame] | 31 | struct wake_irq; |
| 32 | |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 33 | /** |
| 34 | * struct wakeup_source - Representation of wakeup sources |
Alan Stern | 2430d12 | 2010-06-13 00:36:52 +0200 | [diff] [blame] | 35 | * |
Tony Lindgren | 4990d4f | 2015-05-18 15:40:29 -0700 | [diff] [blame] | 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 |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 42 | * @total_time: Total time this wakeup source has been active. |
| 43 | * @max_time: Maximum time this wakeup source has been continuously active. |
Rafael J. Wysocki | 30e3ce6 | 2012-04-29 22:52:52 +0200 | [diff] [blame] | 44 | * @last_time: Monotonic clock when the wakeup source's was touched last time. |
Rafael J. Wysocki | 5585094 | 2012-04-29 22:53:32 +0200 | [diff] [blame] | 45 | * @prevent_sleep_time: Total time this source has been preventing autosleep. |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 46 | * @event_count: Number of signaled wakeup events. |
Chanwoo Choi | 1258ca8 | 2013-07-11 13:55:58 +0900 | [diff] [blame] | 47 | * @active_count: Number of times the wakeup source was activated. |
| 48 | * @relax_count: Number of times the wakeup source was deactivated. |
Rafael J. Wysocki | 30e3ce6 | 2012-04-29 22:52:52 +0200 | [diff] [blame] | 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. |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 51 | * @active: Status of the wakeup source. |
Rafael J. Wysocki | 30e3ce6 | 2012-04-29 22:52:52 +0200 | [diff] [blame] | 52 | * @has_timeout: The wakeup source has been activated with a timeout. |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 53 | */ |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 54 | struct wakeup_source { |
Rafael J. Wysocki | 8671bbc | 2012-02-21 23:47:56 +0100 | [diff] [blame] | 55 | const char *name; |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 56 | struct list_head entry; |
| 57 | spinlock_t lock; |
Tony Lindgren | 4990d4f | 2015-05-18 15:40:29 -0700 | [diff] [blame] | 58 | struct wake_irq *wakeirq; |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 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; |
Rafael J. Wysocki | 5585094 | 2012-04-29 22:53:32 +0200 | [diff] [blame] | 64 | ktime_t start_prevent_time; |
| 65 | ktime_t prevent_sleep_time; |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 66 | unsigned long event_count; |
| 67 | unsigned long active_count; |
| 68 | unsigned long relax_count; |
Rafael J. Wysocki | 30e3ce6 | 2012-04-29 22:52:52 +0200 | [diff] [blame] | 69 | unsigned long expire_count; |
| 70 | unsigned long wakeup_count; |
| 71 | bool active:1; |
Rafael J. Wysocki | 5585094 | 2012-04-29 22:53:32 +0200 | [diff] [blame] | 72 | bool autosleep_enabled:1; |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 73 | }; |
| 74 | |
| 75 | #ifdef CONFIG_PM_SLEEP |
| 76 | |
| 77 | /* |
| 78 | * Changes to device_may_wakeup take effect on the next pm state change. |
| 79 | */ |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 80 | |
Dmitry Torokhov | 228c54e | 2010-03-15 21:44:41 +0100 | [diff] [blame] | 81 | static inline bool device_can_wakeup(struct device *dev) |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 82 | { |
| 83 | return dev->power.can_wakeup; |
| 84 | } |
| 85 | |
Dmitry Torokhov | 228c54e | 2010-03-15 21:44:41 +0100 | [diff] [blame] | 86 | static inline bool device_may_wakeup(struct device *dev) |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 87 | { |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 88 | return dev->power.can_wakeup && !!dev->power.wakeup; |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 89 | } |
| 90 | |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 91 | /* drivers/base/power/wakeup.c */ |
Rafael J. Wysocki | 8671bbc | 2012-02-21 23:47:56 +0100 | [diff] [blame] | 92 | extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name); |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 93 | extern struct wakeup_source *wakeup_source_create(const char *name); |
Rafael J. Wysocki | 8671bbc | 2012-02-21 23:47:56 +0100 | [diff] [blame] | 94 | extern void wakeup_source_drop(struct wakeup_source *ws); |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 95 | extern void wakeup_source_destroy(struct wakeup_source *ws); |
| 96 | extern void wakeup_source_add(struct wakeup_source *ws); |
| 97 | extern void wakeup_source_remove(struct wakeup_source *ws); |
| 98 | extern struct wakeup_source *wakeup_source_register(const char *name); |
| 99 | extern void wakeup_source_unregister(struct wakeup_source *ws); |
| 100 | extern int device_wakeup_enable(struct device *dev); |
| 101 | extern int device_wakeup_disable(struct device *dev); |
Rafael J. Wysocki | cb8f51b | 2011-02-08 23:26:02 +0100 | [diff] [blame] | 102 | extern void device_set_wakeup_capable(struct device *dev, bool capable); |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 103 | extern int device_init_wakeup(struct device *dev, bool val); |
| 104 | extern int device_set_wakeup_enable(struct device *dev, bool enable); |
| 105 | extern void __pm_stay_awake(struct wakeup_source *ws); |
| 106 | extern void pm_stay_awake(struct device *dev); |
| 107 | extern void __pm_relax(struct wakeup_source *ws); |
| 108 | extern void pm_relax(struct device *dev); |
Rafael J. Wysocki | 8a537ec | 2017-04-26 23:22:09 +0200 | [diff] [blame^] | 109 | extern void pm_wakeup_ws_event(struct wakeup_source *ws, unsigned int msec, bool hard); |
| 110 | extern void pm_wakeup_dev_event(struct device *dev, unsigned int msec, bool hard); |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 111 | |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 112 | #else /* !CONFIG_PM_SLEEP */ |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 113 | |
Dmitry Torokhov | 228c54e | 2010-03-15 21:44:41 +0100 | [diff] [blame] | 114 | static inline void device_set_wakeup_capable(struct device *dev, bool capable) |
| 115 | { |
Alan Stern | 2430d12 | 2010-06-13 00:36:52 +0200 | [diff] [blame] | 116 | dev->power.can_wakeup = capable; |
Dmitry Torokhov | 228c54e | 2010-03-15 21:44:41 +0100 | [diff] [blame] | 117 | } |
Stephen Rothwell | c300bd2fb | 2008-07-10 02:16:44 +0200 | [diff] [blame] | 118 | |
Dmitry Torokhov | 228c54e | 2010-03-15 21:44:41 +0100 | [diff] [blame] | 119 | static inline bool device_can_wakeup(struct device *dev) |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 120 | { |
| 121 | return dev->power.can_wakeup; |
| 122 | } |
| 123 | |
Rafael J. Wysocki | 8671bbc | 2012-02-21 23:47:56 +0100 | [diff] [blame] | 124 | static inline void wakeup_source_prepare(struct wakeup_source *ws, |
| 125 | const char *name) {} |
| 126 | |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 127 | static inline struct wakeup_source *wakeup_source_create(const char *name) |
| 128 | { |
| 129 | return NULL; |
| 130 | } |
| 131 | |
Rafael J. Wysocki | 8671bbc | 2012-02-21 23:47:56 +0100 | [diff] [blame] | 132 | static inline void wakeup_source_drop(struct wakeup_source *ws) {} |
| 133 | |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 134 | static inline void wakeup_source_destroy(struct wakeup_source *ws) {} |
| 135 | |
| 136 | static inline void wakeup_source_add(struct wakeup_source *ws) {} |
| 137 | |
| 138 | static inline void wakeup_source_remove(struct wakeup_source *ws) {} |
| 139 | |
| 140 | static inline struct wakeup_source *wakeup_source_register(const char *name) |
| 141 | { |
| 142 | return NULL; |
| 143 | } |
| 144 | |
| 145 | static inline void wakeup_source_unregister(struct wakeup_source *ws) {} |
| 146 | |
| 147 | static inline int device_wakeup_enable(struct device *dev) |
| 148 | { |
Rafael J. Wysocki | 805bdae | 2011-02-24 11:10:01 +0100 | [diff] [blame] | 149 | dev->power.should_wakeup = true; |
| 150 | return 0; |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | static inline int device_wakeup_disable(struct device *dev) |
| 154 | { |
Rafael J. Wysocki | 805bdae | 2011-02-24 11:10:01 +0100 | [diff] [blame] | 155 | dev->power.should_wakeup = false; |
| 156 | return 0; |
| 157 | } |
| 158 | |
| 159 | static inline int device_set_wakeup_enable(struct device *dev, bool enable) |
| 160 | { |
| 161 | dev->power.should_wakeup = enable; |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 162 | return 0; |
| 163 | } |
| 164 | |
| 165 | static inline int device_init_wakeup(struct device *dev, bool val) |
| 166 | { |
Rafael J. Wysocki | 805bdae | 2011-02-24 11:10:01 +0100 | [diff] [blame] | 167 | device_set_wakeup_capable(dev, val); |
| 168 | device_set_wakeup_enable(dev, val); |
| 169 | return 0; |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 170 | } |
| 171 | |
Rafael J. Wysocki | 805bdae | 2011-02-24 11:10:01 +0100 | [diff] [blame] | 172 | static inline bool device_may_wakeup(struct device *dev) |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 173 | { |
Rafael J. Wysocki | 805bdae | 2011-02-24 11:10:01 +0100 | [diff] [blame] | 174 | return dev->power.can_wakeup && dev->power.should_wakeup; |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | static inline void __pm_stay_awake(struct wakeup_source *ws) {} |
| 178 | |
| 179 | static inline void pm_stay_awake(struct device *dev) {} |
| 180 | |
| 181 | static inline void __pm_relax(struct wakeup_source *ws) {} |
| 182 | |
| 183 | static inline void pm_relax(struct device *dev) {} |
| 184 | |
Rafael J. Wysocki | 8a537ec | 2017-04-26 23:22:09 +0200 | [diff] [blame^] | 185 | static inline void pm_wakeup_ws_event(struct wakeup_source *ws, |
| 186 | unsigned int msec, bool hard) {} |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 187 | |
Rafael J. Wysocki | 8a537ec | 2017-04-26 23:22:09 +0200 | [diff] [blame^] | 188 | static inline void pm_wakeup_dev_event(struct device *dev, unsigned int msec, |
| 189 | bool hard) {} |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 190 | |
| 191 | #endif /* !CONFIG_PM_SLEEP */ |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 192 | |
Rafael J. Wysocki | 8671bbc | 2012-02-21 23:47:56 +0100 | [diff] [blame] | 193 | static inline void wakeup_source_init(struct wakeup_source *ws, |
| 194 | const char *name) |
| 195 | { |
| 196 | wakeup_source_prepare(ws, name); |
| 197 | wakeup_source_add(ws); |
| 198 | } |
| 199 | |
| 200 | static inline void wakeup_source_trash(struct wakeup_source *ws) |
| 201 | { |
| 202 | wakeup_source_remove(ws); |
| 203 | wakeup_source_drop(ws); |
| 204 | } |
| 205 | |
Rafael J. Wysocki | 8a537ec | 2017-04-26 23:22:09 +0200 | [diff] [blame^] | 206 | static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) |
| 207 | { |
| 208 | return pm_wakeup_ws_event(ws, msec, false); |
| 209 | } |
| 210 | |
| 211 | static inline void pm_wakeup_event(struct device *dev, unsigned int msec) |
| 212 | { |
| 213 | return pm_wakeup_dev_event(dev, msec, false); |
| 214 | } |
| 215 | |
| 216 | static inline void pm_wakeup_hard_event(struct device *dev) |
| 217 | { |
| 218 | return pm_wakeup_dev_event(dev, 0, true); |
| 219 | } |
| 220 | |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 221 | #endif /* _LINUX_PM_WAKEUP_H */ |