blob: 2d56f4113ae761a406fca80c8d39c892ae4b2416 [file] [log] [blame]
Rafael J. Wysockic125e962010-07-05 22:43:53 +02001/*
2 * drivers/base/power/wakeup.c - System wakeup events framework
3 *
4 * Copyright (c) 2010 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
5 *
6 * This file is released under the GPLv2.
7 */
8
9#include <linux/device.h>
10#include <linux/slab.h>
11#include <linux/sched.h>
12#include <linux/capability.h>
Paul Gortmaker1b6bc322011-05-27 07:12:15 -040013#include <linux/export.h>
Rafael J. Wysockic125e962010-07-05 22:43:53 +020014#include <linux/suspend.h>
Rafael J. Wysocki9c034392010-10-19 23:42:49 +020015#include <linux/seq_file.h>
16#include <linux/debugfs.h>
Arve Hjønnevåg6791e362012-04-29 22:53:02 +020017#include <trace/events/power.h>
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020018
19#include "power.h"
20
Rafael J. Wysockic125e962010-07-05 22:43:53 +020021/*
22 * If set, the suspend/hibernate code will abort transitions to a sleep state
23 * if wakeup events are registered during or immediately before the transition.
24 */
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +020025bool events_check_enabled __read_mostly;
Rafael J. Wysockic125e962010-07-05 22:43:53 +020026
Rafael J. Wysocki023d3772011-01-31 11:06:39 +010027/*
28 * Combined counters of registered wakeup events and wakeup events in progress.
29 * They need to be modified together atomically, so it's better to use one
30 * atomic variable to hold them both.
31 */
32static atomic_t combined_event_count = ATOMIC_INIT(0);
33
34#define IN_PROGRESS_BITS (sizeof(int) * 4)
35#define MAX_IN_PROGRESS ((1 << IN_PROGRESS_BITS) - 1)
36
37static void split_counters(unsigned int *cnt, unsigned int *inpr)
38{
39 unsigned int comb = atomic_read(&combined_event_count);
40
41 *cnt = (comb >> IN_PROGRESS_BITS);
42 *inpr = comb & MAX_IN_PROGRESS;
43}
44
45/* A preserved old value of the events counter. */
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020046static unsigned int saved_count;
Rafael J. Wysockic125e962010-07-05 22:43:53 +020047
48static DEFINE_SPINLOCK(events_lock);
49
Rafael J. Wysocki4eb241e2010-07-07 23:43:51 +020050static void pm_wakeup_timer_fn(unsigned long data);
51
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020052static LIST_HEAD(wakeup_sources);
53
Rafael J. Wysocki60af1062012-04-29 22:52:34 +020054static DECLARE_WAIT_QUEUE_HEAD(wakeup_count_wait_queue);
55
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020056/**
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +010057 * wakeup_source_prepare - Prepare a new wakeup source for initialization.
58 * @ws: Wakeup source to prepare.
59 * @name: Pointer to the name of the new wakeup source.
60 *
61 * Callers must ensure that the @name string won't be freed when @ws is still in
62 * use.
63 */
64void wakeup_source_prepare(struct wakeup_source *ws, const char *name)
65{
66 if (ws) {
67 memset(ws, 0, sizeof(*ws));
68 ws->name = name;
69 }
70}
71EXPORT_SYMBOL_GPL(wakeup_source_prepare);
72
73/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020074 * wakeup_source_create - Create a struct wakeup_source object.
75 * @name: Name of the new wakeup source.
76 */
77struct wakeup_source *wakeup_source_create(const char *name)
78{
79 struct wakeup_source *ws;
80
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +010081 ws = kmalloc(sizeof(*ws), GFP_KERNEL);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020082 if (!ws)
83 return NULL;
84
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +010085 wakeup_source_prepare(ws, name ? kstrdup(name, GFP_KERNEL) : NULL);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020086 return ws;
87}
88EXPORT_SYMBOL_GPL(wakeup_source_create);
89
90/**
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +010091 * wakeup_source_drop - Prepare a struct wakeup_source object for destruction.
92 * @ws: Wakeup source to prepare for destruction.
Rafael J. Wysockid94aff82012-02-17 23:39:20 +010093 *
94 * Callers must ensure that __pm_stay_awake() or __pm_wakeup_event() will never
95 * be run in parallel with this function for the same wakeup source object.
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020096 */
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +010097void wakeup_source_drop(struct wakeup_source *ws)
Rafael J. Wysocki074037e2010-09-22 22:09:10 +020098{
99 if (!ws)
100 return;
101
Rafael J. Wysockid94aff82012-02-17 23:39:20 +0100102 del_timer_sync(&ws->timer);
103 __pm_relax(ws);
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +0100104}
105EXPORT_SYMBOL_GPL(wakeup_source_drop);
106
107/**
108 * wakeup_source_destroy - Destroy a struct wakeup_source object.
109 * @ws: Wakeup source to destroy.
110 *
111 * Use only for wakeup source objects created with wakeup_source_create().
112 */
113void wakeup_source_destroy(struct wakeup_source *ws)
114{
115 if (!ws)
116 return;
117
118 wakeup_source_drop(ws);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200119 kfree(ws->name);
120 kfree(ws);
121}
122EXPORT_SYMBOL_GPL(wakeup_source_destroy);
123
124/**
125 * wakeup_source_add - Add given object to the list of wakeup sources.
126 * @ws: Wakeup source object to add to the list.
127 */
128void wakeup_source_add(struct wakeup_source *ws)
129{
John Stultz49550702012-09-06 23:19:06 +0200130 unsigned long flags;
131
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200132 if (WARN_ON(!ws))
133 return;
134
Rafael J. Wysocki7c951492012-02-11 00:00:11 +0100135 spin_lock_init(&ws->lock);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200136 setup_timer(&ws->timer, pm_wakeup_timer_fn, (unsigned long)ws);
137 ws->active = false;
Rafael J. Wysockib86ff9822012-04-29 22:53:42 +0200138 ws->last_time = ktime_get();
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200139
John Stultz49550702012-09-06 23:19:06 +0200140 spin_lock_irqsave(&events_lock, flags);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200141 list_add_rcu(&ws->entry, &wakeup_sources);
John Stultz49550702012-09-06 23:19:06 +0200142 spin_unlock_irqrestore(&events_lock, flags);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200143}
144EXPORT_SYMBOL_GPL(wakeup_source_add);
145
146/**
147 * wakeup_source_remove - Remove given object from the wakeup sources list.
148 * @ws: Wakeup source object to remove from the list.
149 */
150void wakeup_source_remove(struct wakeup_source *ws)
151{
John Stultz49550702012-09-06 23:19:06 +0200152 unsigned long flags;
153
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200154 if (WARN_ON(!ws))
155 return;
156
John Stultz49550702012-09-06 23:19:06 +0200157 spin_lock_irqsave(&events_lock, flags);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200158 list_del_rcu(&ws->entry);
John Stultz49550702012-09-06 23:19:06 +0200159 spin_unlock_irqrestore(&events_lock, flags);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200160 synchronize_rcu();
161}
162EXPORT_SYMBOL_GPL(wakeup_source_remove);
163
164/**
165 * wakeup_source_register - Create wakeup source and add it to the list.
166 * @name: Name of the wakeup source to register.
167 */
168struct wakeup_source *wakeup_source_register(const char *name)
169{
170 struct wakeup_source *ws;
171
172 ws = wakeup_source_create(name);
173 if (ws)
174 wakeup_source_add(ws);
175
176 return ws;
177}
178EXPORT_SYMBOL_GPL(wakeup_source_register);
179
180/**
181 * wakeup_source_unregister - Remove wakeup source from the list and remove it.
182 * @ws: Wakeup source object to unregister.
183 */
184void wakeup_source_unregister(struct wakeup_source *ws)
185{
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +0100186 if (ws) {
187 wakeup_source_remove(ws);
188 wakeup_source_destroy(ws);
189 }
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200190}
191EXPORT_SYMBOL_GPL(wakeup_source_unregister);
192
193/**
194 * device_wakeup_attach - Attach a wakeup source object to a device object.
195 * @dev: Device to handle.
196 * @ws: Wakeup source object to attach to @dev.
197 *
198 * This causes @dev to be treated as a wakeup device.
199 */
200static int device_wakeup_attach(struct device *dev, struct wakeup_source *ws)
201{
202 spin_lock_irq(&dev->power.lock);
203 if (dev->power.wakeup) {
204 spin_unlock_irq(&dev->power.lock);
205 return -EEXIST;
206 }
207 dev->power.wakeup = ws;
208 spin_unlock_irq(&dev->power.lock);
209 return 0;
210}
211
212/**
213 * device_wakeup_enable - Enable given device to be a wakeup source.
214 * @dev: Device to handle.
215 *
216 * Create a wakeup source object, register it and attach it to @dev.
217 */
218int device_wakeup_enable(struct device *dev)
219{
220 struct wakeup_source *ws;
221 int ret;
222
223 if (!dev || !dev->power.can_wakeup)
224 return -EINVAL;
225
226 ws = wakeup_source_register(dev_name(dev));
227 if (!ws)
228 return -ENOMEM;
229
230 ret = device_wakeup_attach(dev, ws);
231 if (ret)
232 wakeup_source_unregister(ws);
233
234 return ret;
235}
236EXPORT_SYMBOL_GPL(device_wakeup_enable);
237
238/**
239 * device_wakeup_detach - Detach a device's wakeup source object from it.
240 * @dev: Device to detach the wakeup source object from.
241 *
242 * After it returns, @dev will not be treated as a wakeup device any more.
243 */
244static struct wakeup_source *device_wakeup_detach(struct device *dev)
245{
246 struct wakeup_source *ws;
247
248 spin_lock_irq(&dev->power.lock);
249 ws = dev->power.wakeup;
250 dev->power.wakeup = NULL;
251 spin_unlock_irq(&dev->power.lock);
252 return ws;
253}
254
255/**
256 * device_wakeup_disable - Do not regard a device as a wakeup source any more.
257 * @dev: Device to handle.
258 *
259 * Detach the @dev's wakeup source object from it, unregister this wakeup source
260 * object and destroy it.
261 */
262int device_wakeup_disable(struct device *dev)
263{
264 struct wakeup_source *ws;
265
266 if (!dev || !dev->power.can_wakeup)
267 return -EINVAL;
268
269 ws = device_wakeup_detach(dev);
270 if (ws)
271 wakeup_source_unregister(ws);
272
273 return 0;
274}
275EXPORT_SYMBOL_GPL(device_wakeup_disable);
276
277/**
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100278 * device_set_wakeup_capable - Set/reset device wakeup capability flag.
279 * @dev: Device to handle.
280 * @capable: Whether or not @dev is capable of waking up the system from sleep.
281 *
282 * If @capable is set, set the @dev's power.can_wakeup flag and add its
283 * wakeup-related attributes to sysfs. Otherwise, unset the @dev's
284 * power.can_wakeup flag and remove its wakeup-related attributes from sysfs.
285 *
286 * This function may sleep and it can't be called from any context where
287 * sleeping is not allowed.
288 */
289void device_set_wakeup_capable(struct device *dev, bool capable)
290{
291 if (!!dev->power.can_wakeup == !!capable)
292 return;
293
Rafael J. Wysocki22110fa2011-04-26 11:33:09 +0200294 if (device_is_registered(dev) && !list_empty(&dev->power.entry)) {
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100295 if (capable) {
296 if (wakeup_sysfs_add(dev))
297 return;
298 } else {
299 wakeup_sysfs_remove(dev);
300 }
301 }
302 dev->power.can_wakeup = capable;
303}
304EXPORT_SYMBOL_GPL(device_set_wakeup_capable);
305
306/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200307 * device_init_wakeup - Device wakeup initialization.
308 * @dev: Device to handle.
309 * @enable: Whether or not to enable @dev as a wakeup device.
310 *
311 * By default, most devices should leave wakeup disabled. The exceptions are
312 * devices that everyone expects to be wakeup sources: keyboards, power buttons,
Alan Stern8f888932011-09-26 17:38:50 +0200313 * possibly network interfaces, etc. Also, devices that don't generate their
314 * own wakeup requests but merely forward requests from one bus to another
315 * (like PCI bridges) should have wakeup enabled by default.
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200316 */
317int device_init_wakeup(struct device *dev, bool enable)
318{
319 int ret = 0;
320
321 if (enable) {
322 device_set_wakeup_capable(dev, true);
323 ret = device_wakeup_enable(dev);
324 } else {
325 device_set_wakeup_capable(dev, false);
326 }
327
328 return ret;
329}
330EXPORT_SYMBOL_GPL(device_init_wakeup);
331
332/**
333 * device_set_wakeup_enable - Enable or disable a device to wake up the system.
334 * @dev: Device to handle.
335 */
336int device_set_wakeup_enable(struct device *dev, bool enable)
337{
338 if (!dev || !dev->power.can_wakeup)
339 return -EINVAL;
340
341 return enable ? device_wakeup_enable(dev) : device_wakeup_disable(dev);
342}
343EXPORT_SYMBOL_GPL(device_set_wakeup_enable);
Rafael J. Wysocki4eb241e2010-07-07 23:43:51 +0200344
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200345/*
346 * The functions below use the observation that each wakeup event starts a
347 * period in which the system should not be suspended. The moment this period
348 * will end depends on how the wakeup event is going to be processed after being
349 * detected and all of the possible cases can be divided into two distinct
350 * groups.
351 *
352 * First, a wakeup event may be detected by the same functional unit that will
353 * carry out the entire processing of it and possibly will pass it to user space
354 * for further processing. In that case the functional unit that has detected
355 * the event may later "close" the "no suspend" period associated with it
356 * directly as soon as it has been dealt with. The pair of pm_stay_awake() and
357 * pm_relax(), balanced with each other, is supposed to be used in such
358 * situations.
359 *
360 * Second, a wakeup event may be detected by one functional unit and processed
361 * by another one. In that case the unit that has detected it cannot really
362 * "close" the "no suspend" period associated with it, unless it knows in
363 * advance what's going to happen to the event during processing. This
364 * knowledge, however, may not be available to it, so it can simply specify time
365 * to wait before the system can be suspended and pass it as the second
366 * argument of pm_wakeup_event().
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200367 *
368 * It is valid to call pm_relax() after pm_wakeup_event(), in which case the
369 * "no suspend" period will be ended either by the pm_relax(), or by the timer
370 * function executed when the timer expires, whichever comes first.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200371 */
372
373/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200374 * wakup_source_activate - Mark given wakeup source as active.
375 * @ws: Wakeup source to handle.
376 *
377 * Update the @ws' statistics and, if @ws has just been activated, notify the PM
378 * core of the event by incrementing the counter of of wakeup events being
379 * processed.
380 */
381static void wakeup_source_activate(struct wakeup_source *ws)
382{
Arve Hjønnevåg6791e362012-04-29 22:53:02 +0200383 unsigned int cec;
384
Zhang Rui7e73c5a2013-02-06 13:00:36 +0100385 /*
386 * active wakeup source should bring the system
387 * out of PM_SUSPEND_FREEZE state
388 */
389 freeze_wake();
390
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200391 ws->active = true;
392 ws->active_count++;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200393 ws->last_time = ktime_get();
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200394 if (ws->autosleep_enabled)
395 ws->start_prevent_time = ws->last_time;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200396
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100397 /* Increment the counter of events in progress. */
Arve Hjønnevåg6791e362012-04-29 22:53:02 +0200398 cec = atomic_inc_return(&combined_event_count);
399
400 trace_wakeup_source_activate(ws->name, cec);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200401}
402
403/**
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200404 * wakeup_source_report_event - Report wakeup event using the given source.
405 * @ws: Wakeup source to report the event for.
406 */
407static void wakeup_source_report_event(struct wakeup_source *ws)
408{
409 ws->event_count++;
410 /* This is racy, but the counter is approximate anyway. */
411 if (events_check_enabled)
412 ws->wakeup_count++;
413
414 if (!ws->active)
415 wakeup_source_activate(ws);
416}
417
418/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200419 * __pm_stay_awake - Notify the PM core of a wakeup event.
420 * @ws: Wakeup source object associated with the source of the event.
421 *
422 * It is safe to call this function from interrupt context.
423 */
424void __pm_stay_awake(struct wakeup_source *ws)
425{
426 unsigned long flags;
427
428 if (!ws)
429 return;
430
431 spin_lock_irqsave(&ws->lock, flags);
Rafael J. Wysocki4782e162012-02-17 23:39:39 +0100432
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200433 wakeup_source_report_event(ws);
Rafael J. Wysocki4782e162012-02-17 23:39:39 +0100434 del_timer(&ws->timer);
435 ws->timer_expires = 0;
436
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200437 spin_unlock_irqrestore(&ws->lock, flags);
438}
439EXPORT_SYMBOL_GPL(__pm_stay_awake);
440
441/**
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200442 * pm_stay_awake - Notify the PM core that a wakeup event is being processed.
443 * @dev: Device the wakeup event is related to.
444 *
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200445 * Notify the PM core of a wakeup event (signaled by @dev) by calling
446 * __pm_stay_awake for the @dev's wakeup source object.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200447 *
448 * Call this function after detecting of a wakeup event if pm_relax() is going
449 * to be called directly after processing the event (and possibly passing it to
450 * user space for further processing).
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200451 */
452void pm_stay_awake(struct device *dev)
453{
454 unsigned long flags;
455
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200456 if (!dev)
457 return;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200458
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200459 spin_lock_irqsave(&dev->power.lock, flags);
460 __pm_stay_awake(dev->power.wakeup);
461 spin_unlock_irqrestore(&dev->power.lock, flags);
462}
463EXPORT_SYMBOL_GPL(pm_stay_awake);
464
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200465#ifdef CONFIG_PM_AUTOSLEEP
466static void update_prevent_sleep_time(struct wakeup_source *ws, ktime_t now)
467{
468 ktime_t delta = ktime_sub(now, ws->start_prevent_time);
469 ws->prevent_sleep_time = ktime_add(ws->prevent_sleep_time, delta);
470}
471#else
472static inline void update_prevent_sleep_time(struct wakeup_source *ws,
473 ktime_t now) {}
474#endif
475
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200476/**
477 * wakup_source_deactivate - Mark given wakeup source as inactive.
478 * @ws: Wakeup source to handle.
479 *
480 * Update the @ws' statistics and notify the PM core that the wakeup source has
481 * become inactive by decrementing the counter of wakeup events being processed
482 * and incrementing the counter of registered wakeup events.
483 */
484static void wakeup_source_deactivate(struct wakeup_source *ws)
485{
Arve Hjønnevåg6791e362012-04-29 22:53:02 +0200486 unsigned int cnt, inpr, cec;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200487 ktime_t duration;
488 ktime_t now;
489
490 ws->relax_count++;
491 /*
492 * __pm_relax() may be called directly or from a timer function.
493 * If it is called directly right after the timer function has been
494 * started, but before the timer function calls __pm_relax(), it is
495 * possible that __pm_stay_awake() will be called in the meantime and
496 * will set ws->active. Then, ws->active may be cleared immediately
497 * by the __pm_relax() called from the timer function, but in such a
498 * case ws->relax_count will be different from ws->active_count.
499 */
500 if (ws->relax_count != ws->active_count) {
501 ws->relax_count--;
502 return;
503 }
504
505 ws->active = false;
506
507 now = ktime_get();
508 duration = ktime_sub(now, ws->last_time);
509 ws->total_time = ktime_add(ws->total_time, duration);
510 if (ktime_to_ns(duration) > ktime_to_ns(ws->max_time))
511 ws->max_time = duration;
512
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200513 ws->last_time = now;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200514 del_timer(&ws->timer);
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100515 ws->timer_expires = 0;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200516
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200517 if (ws->autosleep_enabled)
518 update_prevent_sleep_time(ws, now);
519
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200520 /*
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100521 * Increment the counter of registered wakeup events and decrement the
522 * couter of wakeup events in progress simultaneously.
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200523 */
Arve Hjønnevåg6791e362012-04-29 22:53:02 +0200524 cec = atomic_add_return(MAX_IN_PROGRESS, &combined_event_count);
525 trace_wakeup_source_deactivate(ws->name, cec);
Rafael J. Wysocki60af1062012-04-29 22:52:34 +0200526
527 split_counters(&cnt, &inpr);
528 if (!inpr && waitqueue_active(&wakeup_count_wait_queue))
529 wake_up(&wakeup_count_wait_queue);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200530}
531
532/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200533 * __pm_relax - Notify the PM core that processing of a wakeup event has ended.
534 * @ws: Wakeup source object associated with the source of the event.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200535 *
536 * Call this function for wakeup events whose processing started with calling
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200537 * __pm_stay_awake().
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200538 *
539 * It is safe to call it from interrupt context.
540 */
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200541void __pm_relax(struct wakeup_source *ws)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200542{
543 unsigned long flags;
544
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200545 if (!ws)
546 return;
547
548 spin_lock_irqsave(&ws->lock, flags);
549 if (ws->active)
550 wakeup_source_deactivate(ws);
551 spin_unlock_irqrestore(&ws->lock, flags);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200552}
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200553EXPORT_SYMBOL_GPL(__pm_relax);
554
555/**
556 * pm_relax - Notify the PM core that processing of a wakeup event has ended.
557 * @dev: Device that signaled the event.
558 *
559 * Execute __pm_relax() for the @dev's wakeup source object.
560 */
561void pm_relax(struct device *dev)
562{
563 unsigned long flags;
564
565 if (!dev)
566 return;
567
568 spin_lock_irqsave(&dev->power.lock, flags);
569 __pm_relax(dev->power.wakeup);
570 spin_unlock_irqrestore(&dev->power.lock, flags);
571}
572EXPORT_SYMBOL_GPL(pm_relax);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200573
574/**
Rafael J. Wysocki4eb241e2010-07-07 23:43:51 +0200575 * pm_wakeup_timer_fn - Delayed finalization of a wakeup event.
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200576 * @data: Address of the wakeup source object associated with the event source.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200577 *
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100578 * Call wakeup_source_deactivate() for the wakeup source whose address is stored
579 * in @data if it is currently active and its timer has not been canceled and
580 * the expiration time of the timer is not in future.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200581 */
Rafael J. Wysocki4eb241e2010-07-07 23:43:51 +0200582static void pm_wakeup_timer_fn(unsigned long data)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200583{
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100584 struct wakeup_source *ws = (struct wakeup_source *)data;
585 unsigned long flags;
586
587 spin_lock_irqsave(&ws->lock, flags);
588
589 if (ws->active && ws->timer_expires
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200590 && time_after_eq(jiffies, ws->timer_expires)) {
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100591 wakeup_source_deactivate(ws);
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200592 ws->expire_count++;
593 }
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100594
595 spin_unlock_irqrestore(&ws->lock, flags);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200596}
597
598/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200599 * __pm_wakeup_event - Notify the PM core of a wakeup event.
600 * @ws: Wakeup source object associated with the event source.
601 * @msec: Anticipated event processing time (in milliseconds).
602 *
603 * Notify the PM core of a wakeup event whose source is @ws that will take
604 * approximately @msec milliseconds to be processed by the kernel. If @ws is
605 * not active, activate it. If @msec is nonzero, set up the @ws' timer to
606 * execute pm_wakeup_timer_fn() in future.
607 *
608 * It is safe to call this function from interrupt context.
609 */
610void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec)
611{
612 unsigned long flags;
613 unsigned long expires;
614
615 if (!ws)
616 return;
617
618 spin_lock_irqsave(&ws->lock, flags);
619
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200620 wakeup_source_report_event(ws);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200621
622 if (!msec) {
623 wakeup_source_deactivate(ws);
624 goto unlock;
625 }
626
627 expires = jiffies + msecs_to_jiffies(msec);
628 if (!expires)
629 expires = 1;
630
Rafael J. Wysocki4782e162012-02-17 23:39:39 +0100631 if (!ws->timer_expires || time_after(expires, ws->timer_expires)) {
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200632 mod_timer(&ws->timer, expires);
633 ws->timer_expires = expires;
634 }
635
636 unlock:
637 spin_unlock_irqrestore(&ws->lock, flags);
638}
639EXPORT_SYMBOL_GPL(__pm_wakeup_event);
640
641
642/**
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200643 * pm_wakeup_event - Notify the PM core of a wakeup event.
644 * @dev: Device the wakeup event is related to.
645 * @msec: Anticipated event processing time (in milliseconds).
646 *
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200647 * Call __pm_wakeup_event() for the @dev's wakeup source object.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200648 */
649void pm_wakeup_event(struct device *dev, unsigned int msec)
650{
651 unsigned long flags;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200652
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200653 if (!dev)
654 return;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200655
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200656 spin_lock_irqsave(&dev->power.lock, flags);
657 __pm_wakeup_event(dev->power.wakeup, msec);
658 spin_unlock_irqrestore(&dev->power.lock, flags);
659}
660EXPORT_SYMBOL_GPL(pm_wakeup_event);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200661
Julius Wernerbb177fe2013-06-12 12:55:22 -0700662void pm_print_active_wakeup_sources(void)
Todd Poynora938da02012-08-12 00:17:02 +0200663{
664 struct wakeup_source *ws;
665 int active = 0;
666 struct wakeup_source *last_activity_ws = NULL;
667
668 rcu_read_lock();
669 list_for_each_entry_rcu(ws, &wakeup_sources, entry) {
670 if (ws->active) {
671 pr_info("active wakeup source: %s\n", ws->name);
672 active = 1;
673 } else if (!active &&
674 (!last_activity_ws ||
675 ktime_to_ns(ws->last_time) >
676 ktime_to_ns(last_activity_ws->last_time))) {
677 last_activity_ws = ws;
678 }
679 }
680
681 if (!active && last_activity_ws)
682 pr_info("last active wakeup source: %s\n",
683 last_activity_ws->name);
684 rcu_read_unlock();
685}
Julius Wernerbb177fe2013-06-12 12:55:22 -0700686EXPORT_SYMBOL_GPL(pm_print_active_wakeup_sources);
Todd Poynora938da02012-08-12 00:17:02 +0200687
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200688/**
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100689 * pm_wakeup_pending - Check if power transition in progress should be aborted.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200690 *
691 * Compare the current number of registered wakeup events with its preserved
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100692 * value from the past and return true if new wakeup events have been registered
693 * since the old value was stored. Also return true if the current number of
694 * wakeup events being processed is different from zero.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200695 */
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100696bool pm_wakeup_pending(void)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200697{
698 unsigned long flags;
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100699 bool ret = false;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200700
701 spin_lock_irqsave(&events_lock, flags);
702 if (events_check_enabled) {
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100703 unsigned int cnt, inpr;
704
705 split_counters(&cnt, &inpr);
706 ret = (cnt != saved_count || inpr > 0);
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100707 events_check_enabled = !ret;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200708 }
709 spin_unlock_irqrestore(&events_lock, flags);
Todd Poynora938da02012-08-12 00:17:02 +0200710
Bernie Thompson9350de062013-06-01 00:47:43 +0000711 if (ret) {
712 pr_info("PM: Wakeup pending, aborting suspend\n");
Julius Wernerbb177fe2013-06-12 12:55:22 -0700713 pm_print_active_wakeup_sources();
Bernie Thompson9350de062013-06-01 00:47:43 +0000714 }
Todd Poynora938da02012-08-12 00:17:02 +0200715
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200716 return ret;
717}
718
719/**
720 * pm_get_wakeup_count - Read the number of registered wakeup events.
721 * @count: Address to store the value at.
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200722 * @block: Whether or not to block.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200723 *
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200724 * Store the number of registered wakeup events at the address in @count. If
725 * @block is set, block until the current number of wakeup events being
726 * processed is zero.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200727 *
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200728 * Return 'false' if the current number of wakeup events being processed is
729 * nonzero. Otherwise return 'true'.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200730 */
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200731bool pm_get_wakeup_count(unsigned int *count, bool block)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200732{
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100733 unsigned int cnt, inpr;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200734
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200735 if (block) {
736 DEFINE_WAIT(wait);
Rafael J. Wysocki60af1062012-04-29 22:52:34 +0200737
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200738 for (;;) {
739 prepare_to_wait(&wakeup_count_wait_queue, &wait,
740 TASK_INTERRUPTIBLE);
741 split_counters(&cnt, &inpr);
742 if (inpr == 0 || signal_pending(current))
743 break;
744
745 schedule();
746 }
747 finish_wait(&wakeup_count_wait_queue, &wait);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200748 }
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200749
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100750 split_counters(&cnt, &inpr);
751 *count = cnt;
752 return !inpr;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200753}
754
755/**
756 * pm_save_wakeup_count - Save the current number of registered wakeup events.
757 * @count: Value to compare with the current number of registered wakeup events.
758 *
759 * If @count is equal to the current number of registered wakeup events and the
760 * current number of wakeup events being processed is zero, store @count as the
Rafael J. Wysocki378eef92011-01-31 11:06:50 +0100761 * old number of registered wakeup events for pm_check_wakeup_events(), enable
762 * wakeup events detection and return 'true'. Otherwise disable wakeup events
763 * detection and return 'false'.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200764 */
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200765bool pm_save_wakeup_count(unsigned int count)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200766{
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100767 unsigned int cnt, inpr;
John Stultz49550702012-09-06 23:19:06 +0200768 unsigned long flags;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200769
Rafael J. Wysocki378eef92011-01-31 11:06:50 +0100770 events_check_enabled = false;
John Stultz49550702012-09-06 23:19:06 +0200771 spin_lock_irqsave(&events_lock, flags);
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100772 split_counters(&cnt, &inpr);
773 if (cnt == count && inpr == 0) {
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200774 saved_count = count;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200775 events_check_enabled = true;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200776 }
John Stultz49550702012-09-06 23:19:06 +0200777 spin_unlock_irqrestore(&events_lock, flags);
Rafael J. Wysocki378eef92011-01-31 11:06:50 +0100778 return events_check_enabled;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200779}
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200780
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200781#ifdef CONFIG_PM_AUTOSLEEP
782/**
783 * pm_wakep_autosleep_enabled - Modify autosleep_enabled for all wakeup sources.
784 * @enabled: Whether to set or to clear the autosleep_enabled flags.
785 */
786void pm_wakep_autosleep_enabled(bool set)
787{
788 struct wakeup_source *ws;
789 ktime_t now = ktime_get();
790
791 rcu_read_lock();
792 list_for_each_entry_rcu(ws, &wakeup_sources, entry) {
793 spin_lock_irq(&ws->lock);
794 if (ws->autosleep_enabled != set) {
795 ws->autosleep_enabled = set;
796 if (ws->active) {
797 if (set)
798 ws->start_prevent_time = now;
799 else
800 update_prevent_sleep_time(ws, now);
801 }
802 }
803 spin_unlock_irq(&ws->lock);
804 }
805 rcu_read_unlock();
806}
807#endif /* CONFIG_PM_AUTOSLEEP */
808
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200809static struct dentry *wakeup_sources_stats_dentry;
810
811/**
812 * print_wakeup_source_stats - Print wakeup source statistics information.
813 * @m: seq_file to print the statistics into.
814 * @ws: Wakeup source object to print the statistics for.
815 */
816static int print_wakeup_source_stats(struct seq_file *m,
817 struct wakeup_source *ws)
818{
819 unsigned long flags;
820 ktime_t total_time;
821 ktime_t max_time;
822 unsigned long active_count;
823 ktime_t active_time;
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200824 ktime_t prevent_sleep_time;
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200825 int ret;
826
827 spin_lock_irqsave(&ws->lock, flags);
828
829 total_time = ws->total_time;
830 max_time = ws->max_time;
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200831 prevent_sleep_time = ws->prevent_sleep_time;
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200832 active_count = ws->active_count;
833 if (ws->active) {
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200834 ktime_t now = ktime_get();
835
836 active_time = ktime_sub(now, ws->last_time);
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200837 total_time = ktime_add(total_time, active_time);
838 if (active_time.tv64 > max_time.tv64)
839 max_time = active_time;
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200840
841 if (ws->autosleep_enabled)
842 prevent_sleep_time = ktime_add(prevent_sleep_time,
843 ktime_sub(now, ws->start_prevent_time));
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200844 } else {
845 active_time = ktime_set(0, 0);
846 }
847
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200848 ret = seq_printf(m, "%-12s\t%lu\t\t%lu\t\t%lu\t\t%lu\t\t"
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200849 "%lld\t\t%lld\t\t%lld\t\t%lld\t\t%lld\n",
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200850 ws->name, active_count, ws->event_count,
851 ws->wakeup_count, ws->expire_count,
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200852 ktime_to_ms(active_time), ktime_to_ms(total_time),
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200853 ktime_to_ms(max_time), ktime_to_ms(ws->last_time),
854 ktime_to_ms(prevent_sleep_time));
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200855
856 spin_unlock_irqrestore(&ws->lock, flags);
857
858 return ret;
859}
860
861/**
862 * wakeup_sources_stats_show - Print wakeup sources statistics information.
863 * @m: seq_file to print the statistics into.
864 */
865static int wakeup_sources_stats_show(struct seq_file *m, void *unused)
866{
867 struct wakeup_source *ws;
868
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200869 seq_puts(m, "name\t\tactive_count\tevent_count\twakeup_count\t"
870 "expire_count\tactive_since\ttotal_time\tmax_time\t"
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200871 "last_change\tprevent_suspend_time\n");
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200872
873 rcu_read_lock();
874 list_for_each_entry_rcu(ws, &wakeup_sources, entry)
875 print_wakeup_source_stats(m, ws);
876 rcu_read_unlock();
877
878 return 0;
879}
880
881static int wakeup_sources_stats_open(struct inode *inode, struct file *file)
882{
883 return single_open(file, wakeup_sources_stats_show, NULL);
884}
885
886static const struct file_operations wakeup_sources_stats_fops = {
887 .owner = THIS_MODULE,
888 .open = wakeup_sources_stats_open,
889 .read = seq_read,
890 .llseek = seq_lseek,
891 .release = single_release,
892};
893
894static int __init wakeup_sources_debugfs_init(void)
895{
896 wakeup_sources_stats_dentry = debugfs_create_file("wakeup_sources",
897 S_IRUGO, NULL, NULL, &wakeup_sources_stats_fops);
898 return 0;
899}
900
901postcore_initcall(wakeup_sources_debugfs_init);