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 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. 42 */ 43 struct wakeup_source { 44 const char *name; 45 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 */ 64 65 static inline bool device_can_wakeup(struct device *dev) 66 { 67 return dev->power.can_wakeup; 68 } 69 70 static inline bool device_may_wakeup(struct device *dev) 71 { 72 return dev->power.can_wakeup && !!dev->power.wakeup; 73 } 74 75 /* drivers/base/power/wakeup.c */ 76 extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name); 77 extern struct wakeup_source *wakeup_source_create(const char *name); 78 extern void wakeup_source_drop(struct wakeup_source *ws); 79 extern void wakeup_source_destroy(struct wakeup_source *ws); 80 extern void wakeup_source_add(struct wakeup_source *ws); 81 extern void wakeup_source_remove(struct wakeup_source *ws); 82 extern struct wakeup_source *wakeup_source_register(const char *name); 83 extern void wakeup_source_unregister(struct wakeup_source *ws); 84 extern int device_wakeup_enable(struct device *dev); 85 extern int device_wakeup_disable(struct device *dev); 86 extern void device_set_wakeup_capable(struct device *dev, bool capable); 87 extern int device_init_wakeup(struct device *dev, bool val); 88 extern int device_set_wakeup_enable(struct device *dev, bool enable); 89 extern void __pm_stay_awake(struct wakeup_source *ws); 90 extern void pm_stay_awake(struct device *dev); 91 extern void __pm_relax(struct wakeup_source *ws); 92 extern void pm_relax(struct device *dev); 93 extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec); 94 extern void pm_wakeup_event(struct device *dev, unsigned int msec); 95 96 #else /* !CONFIG_PM_SLEEP */ 97 98 static inline void device_set_wakeup_capable(struct device *dev, bool capable) 99 { 100 dev->power.can_wakeup = capable; 101 } 102 103 static inline bool device_can_wakeup(struct device *dev) 104 { 105 return dev->power.can_wakeup; 106 } 107 108 static inline void wakeup_source_prepare(struct wakeup_source *ws, 109 const char *name) {} 110 111 static inline struct wakeup_source *wakeup_source_create(const char *name) 112 { 113 return NULL; 114 } 115 116 static inline void wakeup_source_drop(struct wakeup_source *ws) {} 117 118 static inline void wakeup_source_destroy(struct wakeup_source *ws) {} 119 120 static inline void wakeup_source_add(struct wakeup_source *ws) {} 121 122 static inline void wakeup_source_remove(struct wakeup_source *ws) {} 123 124 static inline struct wakeup_source *wakeup_source_register(const char *name) 125 { 126 return NULL; 127 } 128 129 static inline void wakeup_source_unregister(struct wakeup_source *ws) {} 130 131 static inline int device_wakeup_enable(struct device *dev) 132 { 133 dev->power.should_wakeup = true; 134 return 0; 135 } 136 137 static inline int device_wakeup_disable(struct device *dev) 138 { 139 dev->power.should_wakeup = false; 140 return 0; 141 } 142 143 static inline int device_set_wakeup_enable(struct device *dev, bool enable) 144 { 145 dev->power.should_wakeup = enable; 146 return 0; 147 } 148 149 static inline int device_init_wakeup(struct device *dev, bool val) 150 { 151 device_set_wakeup_capable(dev, val); 152 device_set_wakeup_enable(dev, val); 153 return 0; 154 } 155 156 static inline bool device_may_wakeup(struct device *dev) 157 { 158 return dev->power.can_wakeup && dev->power.should_wakeup; 159 } 160 161 static inline void __pm_stay_awake(struct wakeup_source *ws) {} 162 163 static inline void pm_stay_awake(struct device *dev) {} 164 165 static inline void __pm_relax(struct wakeup_source *ws) {} 166 167 static inline void pm_relax(struct device *dev) {} 168 169 static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {} 170 171 static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {} 172 173 #endif /* !CONFIG_PM_SLEEP */ 174 175 static 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 182 static inline void wakeup_source_trash(struct wakeup_source *ws) 183 { 184 wakeup_source_remove(ws); 185 wakeup_source_drop(ws); 186 } 187 188 #endif /* _LINUX_PM_WAKEUP_H */ 189