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 struct wake_irq; 32 33 /** 34 * struct wakeup_source - Representation of wakeup sources 35 * 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 42 * @total_time: Total time this wakeup source has been active. 43 * @max_time: Maximum time this wakeup source has been continuously active. 44 * @last_time: Monotonic clock when the wakeup source's was touched last time. 45 * @prevent_sleep_time: Total time this source has been preventing autosleep. 46 * @event_count: Number of signaled wakeup events. 47 * @active_count: Number of times the wakeup source was activated. 48 * @relax_count: Number of times the wakeup source was deactivated. 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. 51 * @active: Status of the wakeup source. 52 * @has_timeout: The wakeup source has been activated with a timeout. 53 */ 54 struct wakeup_source { 55 const char *name; 56 struct list_head entry; 57 spinlock_t lock; 58 struct wake_irq *wakeirq; 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; 64 ktime_t start_prevent_time; 65 ktime_t prevent_sleep_time; 66 unsigned long event_count; 67 unsigned long active_count; 68 unsigned long relax_count; 69 unsigned long expire_count; 70 unsigned long wakeup_count; 71 bool active:1; 72 bool autosleep_enabled:1; 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 81 static inline bool device_can_wakeup(struct device *dev) 82 { 83 return dev->power.can_wakeup; 84 } 85 86 static inline bool device_may_wakeup(struct device *dev) 87 { 88 return dev->power.can_wakeup && !!dev->power.wakeup; 89 } 90 91 static inline void device_set_wakeup_path(struct device *dev) 92 { 93 dev->power.wakeup_path = true; 94 } 95 96 /* drivers/base/power/wakeup.c */ 97 extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name); 98 extern struct wakeup_source *wakeup_source_create(const char *name); 99 extern void wakeup_source_destroy(struct wakeup_source *ws); 100 extern void wakeup_source_add(struct wakeup_source *ws); 101 extern void wakeup_source_remove(struct wakeup_source *ws); 102 extern struct wakeup_source *wakeup_source_register(const char *name); 103 extern void wakeup_source_unregister(struct wakeup_source *ws); 104 extern int device_wakeup_enable(struct device *dev); 105 extern int device_wakeup_disable(struct device *dev); 106 extern void device_set_wakeup_capable(struct device *dev, bool capable); 107 extern int device_init_wakeup(struct device *dev, bool val); 108 extern int device_set_wakeup_enable(struct device *dev, bool enable); 109 extern void __pm_stay_awake(struct wakeup_source *ws); 110 extern void pm_stay_awake(struct device *dev); 111 extern void __pm_relax(struct wakeup_source *ws); 112 extern void pm_relax(struct device *dev); 113 extern void pm_wakeup_ws_event(struct wakeup_source *ws, unsigned int msec, bool hard); 114 extern void pm_wakeup_dev_event(struct device *dev, unsigned int msec, bool hard); 115 116 #else /* !CONFIG_PM_SLEEP */ 117 118 static inline void device_set_wakeup_capable(struct device *dev, bool capable) 119 { 120 dev->power.can_wakeup = capable; 121 } 122 123 static inline bool device_can_wakeup(struct device *dev) 124 { 125 return dev->power.can_wakeup; 126 } 127 128 static inline void wakeup_source_prepare(struct wakeup_source *ws, 129 const char *name) {} 130 131 static inline struct wakeup_source *wakeup_source_create(const char *name) 132 { 133 return NULL; 134 } 135 136 static inline void wakeup_source_destroy(struct wakeup_source *ws) {} 137 138 static inline void wakeup_source_add(struct wakeup_source *ws) {} 139 140 static inline void wakeup_source_remove(struct wakeup_source *ws) {} 141 142 static inline struct wakeup_source *wakeup_source_register(const char *name) 143 { 144 return NULL; 145 } 146 147 static inline void wakeup_source_unregister(struct wakeup_source *ws) {} 148 149 static inline int device_wakeup_enable(struct device *dev) 150 { 151 dev->power.should_wakeup = true; 152 return 0; 153 } 154 155 static inline int device_wakeup_disable(struct device *dev) 156 { 157 dev->power.should_wakeup = false; 158 return 0; 159 } 160 161 static inline int device_set_wakeup_enable(struct device *dev, bool enable) 162 { 163 dev->power.should_wakeup = enable; 164 return 0; 165 } 166 167 static inline int device_init_wakeup(struct device *dev, bool val) 168 { 169 device_set_wakeup_capable(dev, val); 170 device_set_wakeup_enable(dev, val); 171 return 0; 172 } 173 174 static inline bool device_may_wakeup(struct device *dev) 175 { 176 return dev->power.can_wakeup && dev->power.should_wakeup; 177 } 178 179 static inline void device_set_wakeup_path(struct device *dev) {} 180 181 static inline void __pm_stay_awake(struct wakeup_source *ws) {} 182 183 static inline void pm_stay_awake(struct device *dev) {} 184 185 static inline void __pm_relax(struct wakeup_source *ws) {} 186 187 static inline void pm_relax(struct device *dev) {} 188 189 static inline void pm_wakeup_ws_event(struct wakeup_source *ws, 190 unsigned int msec, bool hard) {} 191 192 static inline void pm_wakeup_dev_event(struct device *dev, unsigned int msec, 193 bool hard) {} 194 195 #endif /* !CONFIG_PM_SLEEP */ 196 197 static inline void wakeup_source_init(struct wakeup_source *ws, 198 const char *name) 199 { 200 wakeup_source_prepare(ws, name); 201 wakeup_source_add(ws); 202 } 203 204 static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) 205 { 206 return pm_wakeup_ws_event(ws, msec, false); 207 } 208 209 static inline void pm_wakeup_event(struct device *dev, unsigned int msec) 210 { 211 return pm_wakeup_dev_event(dev, msec, false); 212 } 213 214 static inline void pm_wakeup_hard_event(struct device *dev) 215 { 216 return pm_wakeup_dev_event(dev, 0, true); 217 } 218 219 #endif /* _LINUX_PM_WAKEUP_H */ 220