blob: 2595b8d8fe1f92a99637d5d2a6fea2a016f7a0b6 [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{
130 if (WARN_ON(!ws))
131 return;
132
Rafael J. Wysocki7c951492012-02-11 00:00:11 +0100133 spin_lock_init(&ws->lock);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200134 setup_timer(&ws->timer, pm_wakeup_timer_fn, (unsigned long)ws);
135 ws->active = false;
136
137 spin_lock_irq(&events_lock);
138 list_add_rcu(&ws->entry, &wakeup_sources);
139 spin_unlock_irq(&events_lock);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200140}
141EXPORT_SYMBOL_GPL(wakeup_source_add);
142
143/**
144 * wakeup_source_remove - Remove given object from the wakeup sources list.
145 * @ws: Wakeup source object to remove from the list.
146 */
147void wakeup_source_remove(struct wakeup_source *ws)
148{
149 if (WARN_ON(!ws))
150 return;
151
152 spin_lock_irq(&events_lock);
153 list_del_rcu(&ws->entry);
154 spin_unlock_irq(&events_lock);
155 synchronize_rcu();
156}
157EXPORT_SYMBOL_GPL(wakeup_source_remove);
158
159/**
160 * wakeup_source_register - Create wakeup source and add it to the list.
161 * @name: Name of the wakeup source to register.
162 */
163struct wakeup_source *wakeup_source_register(const char *name)
164{
165 struct wakeup_source *ws;
166
167 ws = wakeup_source_create(name);
168 if (ws)
169 wakeup_source_add(ws);
170
171 return ws;
172}
173EXPORT_SYMBOL_GPL(wakeup_source_register);
174
175/**
176 * wakeup_source_unregister - Remove wakeup source from the list and remove it.
177 * @ws: Wakeup source object to unregister.
178 */
179void wakeup_source_unregister(struct wakeup_source *ws)
180{
Rafael J. Wysocki8671bbc2012-02-21 23:47:56 +0100181 if (ws) {
182 wakeup_source_remove(ws);
183 wakeup_source_destroy(ws);
184 }
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200185}
186EXPORT_SYMBOL_GPL(wakeup_source_unregister);
187
188/**
189 * device_wakeup_attach - Attach a wakeup source object to a device object.
190 * @dev: Device to handle.
191 * @ws: Wakeup source object to attach to @dev.
192 *
193 * This causes @dev to be treated as a wakeup device.
194 */
195static int device_wakeup_attach(struct device *dev, struct wakeup_source *ws)
196{
197 spin_lock_irq(&dev->power.lock);
198 if (dev->power.wakeup) {
199 spin_unlock_irq(&dev->power.lock);
200 return -EEXIST;
201 }
202 dev->power.wakeup = ws;
203 spin_unlock_irq(&dev->power.lock);
204 return 0;
205}
206
207/**
208 * device_wakeup_enable - Enable given device to be a wakeup source.
209 * @dev: Device to handle.
210 *
211 * Create a wakeup source object, register it and attach it to @dev.
212 */
213int device_wakeup_enable(struct device *dev)
214{
215 struct wakeup_source *ws;
216 int ret;
217
218 if (!dev || !dev->power.can_wakeup)
219 return -EINVAL;
220
221 ws = wakeup_source_register(dev_name(dev));
222 if (!ws)
223 return -ENOMEM;
224
225 ret = device_wakeup_attach(dev, ws);
226 if (ret)
227 wakeup_source_unregister(ws);
228
229 return ret;
230}
231EXPORT_SYMBOL_GPL(device_wakeup_enable);
232
233/**
234 * device_wakeup_detach - Detach a device's wakeup source object from it.
235 * @dev: Device to detach the wakeup source object from.
236 *
237 * After it returns, @dev will not be treated as a wakeup device any more.
238 */
239static struct wakeup_source *device_wakeup_detach(struct device *dev)
240{
241 struct wakeup_source *ws;
242
243 spin_lock_irq(&dev->power.lock);
244 ws = dev->power.wakeup;
245 dev->power.wakeup = NULL;
246 spin_unlock_irq(&dev->power.lock);
247 return ws;
248}
249
250/**
251 * device_wakeup_disable - Do not regard a device as a wakeup source any more.
252 * @dev: Device to handle.
253 *
254 * Detach the @dev's wakeup source object from it, unregister this wakeup source
255 * object and destroy it.
256 */
257int device_wakeup_disable(struct device *dev)
258{
259 struct wakeup_source *ws;
260
261 if (!dev || !dev->power.can_wakeup)
262 return -EINVAL;
263
264 ws = device_wakeup_detach(dev);
265 if (ws)
266 wakeup_source_unregister(ws);
267
268 return 0;
269}
270EXPORT_SYMBOL_GPL(device_wakeup_disable);
271
272/**
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100273 * device_set_wakeup_capable - Set/reset device wakeup capability flag.
274 * @dev: Device to handle.
275 * @capable: Whether or not @dev is capable of waking up the system from sleep.
276 *
277 * If @capable is set, set the @dev's power.can_wakeup flag and add its
278 * wakeup-related attributes to sysfs. Otherwise, unset the @dev's
279 * power.can_wakeup flag and remove its wakeup-related attributes from sysfs.
280 *
281 * This function may sleep and it can't be called from any context where
282 * sleeping is not allowed.
283 */
284void device_set_wakeup_capable(struct device *dev, bool capable)
285{
286 if (!!dev->power.can_wakeup == !!capable)
287 return;
288
Rafael J. Wysocki22110fa2011-04-26 11:33:09 +0200289 if (device_is_registered(dev) && !list_empty(&dev->power.entry)) {
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100290 if (capable) {
291 if (wakeup_sysfs_add(dev))
292 return;
293 } else {
294 wakeup_sysfs_remove(dev);
295 }
296 }
297 dev->power.can_wakeup = capable;
298}
299EXPORT_SYMBOL_GPL(device_set_wakeup_capable);
300
301/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200302 * device_init_wakeup - Device wakeup initialization.
303 * @dev: Device to handle.
304 * @enable: Whether or not to enable @dev as a wakeup device.
305 *
306 * By default, most devices should leave wakeup disabled. The exceptions are
307 * devices that everyone expects to be wakeup sources: keyboards, power buttons,
Alan Stern8f888932011-09-26 17:38:50 +0200308 * possibly network interfaces, etc. Also, devices that don't generate their
309 * own wakeup requests but merely forward requests from one bus to another
310 * (like PCI bridges) should have wakeup enabled by default.
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200311 */
312int device_init_wakeup(struct device *dev, bool enable)
313{
314 int ret = 0;
315
316 if (enable) {
317 device_set_wakeup_capable(dev, true);
318 ret = device_wakeup_enable(dev);
319 } else {
320 device_set_wakeup_capable(dev, false);
321 }
322
323 return ret;
324}
325EXPORT_SYMBOL_GPL(device_init_wakeup);
326
327/**
328 * device_set_wakeup_enable - Enable or disable a device to wake up the system.
329 * @dev: Device to handle.
330 */
331int device_set_wakeup_enable(struct device *dev, bool enable)
332{
333 if (!dev || !dev->power.can_wakeup)
334 return -EINVAL;
335
336 return enable ? device_wakeup_enable(dev) : device_wakeup_disable(dev);
337}
338EXPORT_SYMBOL_GPL(device_set_wakeup_enable);
Rafael J. Wysocki4eb241e2010-07-07 23:43:51 +0200339
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200340/*
341 * The functions below use the observation that each wakeup event starts a
342 * period in which the system should not be suspended. The moment this period
343 * will end depends on how the wakeup event is going to be processed after being
344 * detected and all of the possible cases can be divided into two distinct
345 * groups.
346 *
347 * First, a wakeup event may be detected by the same functional unit that will
348 * carry out the entire processing of it and possibly will pass it to user space
349 * for further processing. In that case the functional unit that has detected
350 * the event may later "close" the "no suspend" period associated with it
351 * directly as soon as it has been dealt with. The pair of pm_stay_awake() and
352 * pm_relax(), balanced with each other, is supposed to be used in such
353 * situations.
354 *
355 * Second, a wakeup event may be detected by one functional unit and processed
356 * by another one. In that case the unit that has detected it cannot really
357 * "close" the "no suspend" period associated with it, unless it knows in
358 * advance what's going to happen to the event during processing. This
359 * knowledge, however, may not be available to it, so it can simply specify time
360 * to wait before the system can be suspended and pass it as the second
361 * argument of pm_wakeup_event().
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200362 *
363 * It is valid to call pm_relax() after pm_wakeup_event(), in which case the
364 * "no suspend" period will be ended either by the pm_relax(), or by the timer
365 * function executed when the timer expires, whichever comes first.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200366 */
367
368/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200369 * wakup_source_activate - Mark given wakeup source as active.
370 * @ws: Wakeup source to handle.
371 *
372 * Update the @ws' statistics and, if @ws has just been activated, notify the PM
373 * core of the event by incrementing the counter of of wakeup events being
374 * processed.
375 */
376static void wakeup_source_activate(struct wakeup_source *ws)
377{
Arve Hjønnevåg6791e362012-04-29 22:53:02 +0200378 unsigned int cec;
379
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200380 ws->active = true;
381 ws->active_count++;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200382 ws->last_time = ktime_get();
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200383 if (ws->autosleep_enabled)
384 ws->start_prevent_time = ws->last_time;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200385
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100386 /* Increment the counter of events in progress. */
Arve Hjønnevåg6791e362012-04-29 22:53:02 +0200387 cec = atomic_inc_return(&combined_event_count);
388
389 trace_wakeup_source_activate(ws->name, cec);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200390}
391
392/**
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200393 * wakeup_source_report_event - Report wakeup event using the given source.
394 * @ws: Wakeup source to report the event for.
395 */
396static void wakeup_source_report_event(struct wakeup_source *ws)
397{
398 ws->event_count++;
399 /* This is racy, but the counter is approximate anyway. */
400 if (events_check_enabled)
401 ws->wakeup_count++;
402
403 if (!ws->active)
404 wakeup_source_activate(ws);
405}
406
407/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200408 * __pm_stay_awake - Notify the PM core of a wakeup event.
409 * @ws: Wakeup source object associated with the source of the event.
410 *
411 * It is safe to call this function from interrupt context.
412 */
413void __pm_stay_awake(struct wakeup_source *ws)
414{
415 unsigned long flags;
416
417 if (!ws)
418 return;
419
420 spin_lock_irqsave(&ws->lock, flags);
Rafael J. Wysocki4782e162012-02-17 23:39:39 +0100421
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200422 wakeup_source_report_event(ws);
Rafael J. Wysocki4782e162012-02-17 23:39:39 +0100423 del_timer(&ws->timer);
424 ws->timer_expires = 0;
425
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200426 spin_unlock_irqrestore(&ws->lock, flags);
427}
428EXPORT_SYMBOL_GPL(__pm_stay_awake);
429
430/**
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200431 * pm_stay_awake - Notify the PM core that a wakeup event is being processed.
432 * @dev: Device the wakeup event is related to.
433 *
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200434 * Notify the PM core of a wakeup event (signaled by @dev) by calling
435 * __pm_stay_awake for the @dev's wakeup source object.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200436 *
437 * Call this function after detecting of a wakeup event if pm_relax() is going
438 * to be called directly after processing the event (and possibly passing it to
439 * user space for further processing).
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200440 */
441void pm_stay_awake(struct device *dev)
442{
443 unsigned long flags;
444
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200445 if (!dev)
446 return;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200447
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200448 spin_lock_irqsave(&dev->power.lock, flags);
449 __pm_stay_awake(dev->power.wakeup);
450 spin_unlock_irqrestore(&dev->power.lock, flags);
451}
452EXPORT_SYMBOL_GPL(pm_stay_awake);
453
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200454#ifdef CONFIG_PM_AUTOSLEEP
455static void update_prevent_sleep_time(struct wakeup_source *ws, ktime_t now)
456{
457 ktime_t delta = ktime_sub(now, ws->start_prevent_time);
458 ws->prevent_sleep_time = ktime_add(ws->prevent_sleep_time, delta);
459}
460#else
461static inline void update_prevent_sleep_time(struct wakeup_source *ws,
462 ktime_t now) {}
463#endif
464
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200465/**
466 * wakup_source_deactivate - Mark given wakeup source as inactive.
467 * @ws: Wakeup source to handle.
468 *
469 * Update the @ws' statistics and notify the PM core that the wakeup source has
470 * become inactive by decrementing the counter of wakeup events being processed
471 * and incrementing the counter of registered wakeup events.
472 */
473static void wakeup_source_deactivate(struct wakeup_source *ws)
474{
Arve Hjønnevåg6791e362012-04-29 22:53:02 +0200475 unsigned int cnt, inpr, cec;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200476 ktime_t duration;
477 ktime_t now;
478
479 ws->relax_count++;
480 /*
481 * __pm_relax() may be called directly or from a timer function.
482 * If it is called directly right after the timer function has been
483 * started, but before the timer function calls __pm_relax(), it is
484 * possible that __pm_stay_awake() will be called in the meantime and
485 * will set ws->active. Then, ws->active may be cleared immediately
486 * by the __pm_relax() called from the timer function, but in such a
487 * case ws->relax_count will be different from ws->active_count.
488 */
489 if (ws->relax_count != ws->active_count) {
490 ws->relax_count--;
491 return;
492 }
493
494 ws->active = false;
495
496 now = ktime_get();
497 duration = ktime_sub(now, ws->last_time);
498 ws->total_time = ktime_add(ws->total_time, duration);
499 if (ktime_to_ns(duration) > ktime_to_ns(ws->max_time))
500 ws->max_time = duration;
501
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200502 ws->last_time = now;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200503 del_timer(&ws->timer);
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100504 ws->timer_expires = 0;
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200505
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200506 if (ws->autosleep_enabled)
507 update_prevent_sleep_time(ws, now);
508
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200509 /*
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100510 * Increment the counter of registered wakeup events and decrement the
511 * couter of wakeup events in progress simultaneously.
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200512 */
Arve Hjønnevåg6791e362012-04-29 22:53:02 +0200513 cec = atomic_add_return(MAX_IN_PROGRESS, &combined_event_count);
514 trace_wakeup_source_deactivate(ws->name, cec);
Rafael J. Wysocki60af1062012-04-29 22:52:34 +0200515
516 split_counters(&cnt, &inpr);
517 if (!inpr && waitqueue_active(&wakeup_count_wait_queue))
518 wake_up(&wakeup_count_wait_queue);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200519}
520
521/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200522 * __pm_relax - Notify the PM core that processing of a wakeup event has ended.
523 * @ws: Wakeup source object associated with the source of the event.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200524 *
525 * Call this function for wakeup events whose processing started with calling
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200526 * __pm_stay_awake().
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200527 *
528 * It is safe to call it from interrupt context.
529 */
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200530void __pm_relax(struct wakeup_source *ws)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200531{
532 unsigned long flags;
533
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200534 if (!ws)
535 return;
536
537 spin_lock_irqsave(&ws->lock, flags);
538 if (ws->active)
539 wakeup_source_deactivate(ws);
540 spin_unlock_irqrestore(&ws->lock, flags);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200541}
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200542EXPORT_SYMBOL_GPL(__pm_relax);
543
544/**
545 * pm_relax - Notify the PM core that processing of a wakeup event has ended.
546 * @dev: Device that signaled the event.
547 *
548 * Execute __pm_relax() for the @dev's wakeup source object.
549 */
550void pm_relax(struct device *dev)
551{
552 unsigned long flags;
553
554 if (!dev)
555 return;
556
557 spin_lock_irqsave(&dev->power.lock, flags);
558 __pm_relax(dev->power.wakeup);
559 spin_unlock_irqrestore(&dev->power.lock, flags);
560}
561EXPORT_SYMBOL_GPL(pm_relax);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200562
563/**
Rafael J. Wysocki4eb241e2010-07-07 23:43:51 +0200564 * pm_wakeup_timer_fn - Delayed finalization of a wakeup event.
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200565 * @data: Address of the wakeup source object associated with the event source.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200566 *
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100567 * Call wakeup_source_deactivate() for the wakeup source whose address is stored
568 * in @data if it is currently active and its timer has not been canceled and
569 * the expiration time of the timer is not in future.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200570 */
Rafael J. Wysocki4eb241e2010-07-07 23:43:51 +0200571static void pm_wakeup_timer_fn(unsigned long data)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200572{
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100573 struct wakeup_source *ws = (struct wakeup_source *)data;
574 unsigned long flags;
575
576 spin_lock_irqsave(&ws->lock, flags);
577
578 if (ws->active && ws->timer_expires
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200579 && time_after_eq(jiffies, ws->timer_expires)) {
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100580 wakeup_source_deactivate(ws);
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200581 ws->expire_count++;
582 }
Rafael J. Wysockida863cd2012-02-17 23:39:33 +0100583
584 spin_unlock_irqrestore(&ws->lock, flags);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200585}
586
587/**
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200588 * __pm_wakeup_event - Notify the PM core of a wakeup event.
589 * @ws: Wakeup source object associated with the event source.
590 * @msec: Anticipated event processing time (in milliseconds).
591 *
592 * Notify the PM core of a wakeup event whose source is @ws that will take
593 * approximately @msec milliseconds to be processed by the kernel. If @ws is
594 * not active, activate it. If @msec is nonzero, set up the @ws' timer to
595 * execute pm_wakeup_timer_fn() in future.
596 *
597 * It is safe to call this function from interrupt context.
598 */
599void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec)
600{
601 unsigned long flags;
602 unsigned long expires;
603
604 if (!ws)
605 return;
606
607 spin_lock_irqsave(&ws->lock, flags);
608
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200609 wakeup_source_report_event(ws);
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200610
611 if (!msec) {
612 wakeup_source_deactivate(ws);
613 goto unlock;
614 }
615
616 expires = jiffies + msecs_to_jiffies(msec);
617 if (!expires)
618 expires = 1;
619
Rafael J. Wysocki4782e162012-02-17 23:39:39 +0100620 if (!ws->timer_expires || time_after(expires, ws->timer_expires)) {
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200621 mod_timer(&ws->timer, expires);
622 ws->timer_expires = expires;
623 }
624
625 unlock:
626 spin_unlock_irqrestore(&ws->lock, flags);
627}
628EXPORT_SYMBOL_GPL(__pm_wakeup_event);
629
630
631/**
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200632 * pm_wakeup_event - Notify the PM core of a wakeup event.
633 * @dev: Device the wakeup event is related to.
634 * @msec: Anticipated event processing time (in milliseconds).
635 *
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200636 * Call __pm_wakeup_event() for the @dev's wakeup source object.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200637 */
638void pm_wakeup_event(struct device *dev, unsigned int msec)
639{
640 unsigned long flags;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200641
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200642 if (!dev)
643 return;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200644
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200645 spin_lock_irqsave(&dev->power.lock, flags);
646 __pm_wakeup_event(dev->power.wakeup, msec);
647 spin_unlock_irqrestore(&dev->power.lock, flags);
648}
649EXPORT_SYMBOL_GPL(pm_wakeup_event);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200650
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200651/**
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100652 * pm_wakeup_pending - Check if power transition in progress should be aborted.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200653 *
654 * Compare the current number of registered wakeup events with its preserved
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100655 * value from the past and return true if new wakeup events have been registered
656 * since the old value was stored. Also return true if the current number of
657 * wakeup events being processed is different from zero.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200658 */
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100659bool pm_wakeup_pending(void)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200660{
661 unsigned long flags;
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100662 bool ret = false;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200663
664 spin_lock_irqsave(&events_lock, flags);
665 if (events_check_enabled) {
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100666 unsigned int cnt, inpr;
667
668 split_counters(&cnt, &inpr);
669 ret = (cnt != saved_count || inpr > 0);
Rafael J. Wysockia2867e02010-12-03 22:58:31 +0100670 events_check_enabled = !ret;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200671 }
672 spin_unlock_irqrestore(&events_lock, flags);
673 return ret;
674}
675
676/**
677 * pm_get_wakeup_count - Read the number of registered wakeup events.
678 * @count: Address to store the value at.
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200679 * @block: Whether or not to block.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200680 *
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200681 * Store the number of registered wakeup events at the address in @count. If
682 * @block is set, block until the current number of wakeup events being
683 * processed is zero.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200684 *
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200685 * Return 'false' if the current number of wakeup events being processed is
686 * nonzero. Otherwise return 'true'.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200687 */
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200688bool pm_get_wakeup_count(unsigned int *count, bool block)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200689{
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100690 unsigned int cnt, inpr;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200691
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200692 if (block) {
693 DEFINE_WAIT(wait);
Rafael J. Wysocki60af1062012-04-29 22:52:34 +0200694
Rafael J. Wysocki7483b4a2012-04-29 22:53:22 +0200695 for (;;) {
696 prepare_to_wait(&wakeup_count_wait_queue, &wait,
697 TASK_INTERRUPTIBLE);
698 split_counters(&cnt, &inpr);
699 if (inpr == 0 || signal_pending(current))
700 break;
701
702 schedule();
703 }
704 finish_wait(&wakeup_count_wait_queue, &wait);
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200705 }
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200706
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100707 split_counters(&cnt, &inpr);
708 *count = cnt;
709 return !inpr;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200710}
711
712/**
713 * pm_save_wakeup_count - Save the current number of registered wakeup events.
714 * @count: Value to compare with the current number of registered wakeup events.
715 *
716 * If @count is equal to the current number of registered wakeup events and the
717 * current number of wakeup events being processed is zero, store @count as the
Rafael J. Wysocki378eef92011-01-31 11:06:50 +0100718 * old number of registered wakeup events for pm_check_wakeup_events(), enable
719 * wakeup events detection and return 'true'. Otherwise disable wakeup events
720 * detection and return 'false'.
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200721 */
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200722bool pm_save_wakeup_count(unsigned int count)
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200723{
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100724 unsigned int cnt, inpr;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200725
Rafael J. Wysocki378eef92011-01-31 11:06:50 +0100726 events_check_enabled = false;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200727 spin_lock_irq(&events_lock);
Rafael J. Wysocki023d3772011-01-31 11:06:39 +0100728 split_counters(&cnt, &inpr);
729 if (cnt == count && inpr == 0) {
Rafael J. Wysocki074037e2010-09-22 22:09:10 +0200730 saved_count = count;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200731 events_check_enabled = true;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200732 }
733 spin_unlock_irq(&events_lock);
Rafael J. Wysocki378eef92011-01-31 11:06:50 +0100734 return events_check_enabled;
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200735}
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200736
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200737#ifdef CONFIG_PM_AUTOSLEEP
738/**
739 * pm_wakep_autosleep_enabled - Modify autosleep_enabled for all wakeup sources.
740 * @enabled: Whether to set or to clear the autosleep_enabled flags.
741 */
742void pm_wakep_autosleep_enabled(bool set)
743{
744 struct wakeup_source *ws;
745 ktime_t now = ktime_get();
746
747 rcu_read_lock();
748 list_for_each_entry_rcu(ws, &wakeup_sources, entry) {
749 spin_lock_irq(&ws->lock);
750 if (ws->autosleep_enabled != set) {
751 ws->autosleep_enabled = set;
752 if (ws->active) {
753 if (set)
754 ws->start_prevent_time = now;
755 else
756 update_prevent_sleep_time(ws, now);
757 }
758 }
759 spin_unlock_irq(&ws->lock);
760 }
761 rcu_read_unlock();
762}
763#endif /* CONFIG_PM_AUTOSLEEP */
764
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200765static struct dentry *wakeup_sources_stats_dentry;
766
767/**
768 * print_wakeup_source_stats - Print wakeup source statistics information.
769 * @m: seq_file to print the statistics into.
770 * @ws: Wakeup source object to print the statistics for.
771 */
772static int print_wakeup_source_stats(struct seq_file *m,
773 struct wakeup_source *ws)
774{
775 unsigned long flags;
776 ktime_t total_time;
777 ktime_t max_time;
778 unsigned long active_count;
779 ktime_t active_time;
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200780 ktime_t prevent_sleep_time;
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200781 int ret;
782
783 spin_lock_irqsave(&ws->lock, flags);
784
785 total_time = ws->total_time;
786 max_time = ws->max_time;
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200787 prevent_sleep_time = ws->prevent_sleep_time;
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200788 active_count = ws->active_count;
789 if (ws->active) {
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200790 ktime_t now = ktime_get();
791
792 active_time = ktime_sub(now, ws->last_time);
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200793 total_time = ktime_add(total_time, active_time);
794 if (active_time.tv64 > max_time.tv64)
795 max_time = active_time;
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200796
797 if (ws->autosleep_enabled)
798 prevent_sleep_time = ktime_add(prevent_sleep_time,
799 ktime_sub(now, ws->start_prevent_time));
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200800 } else {
801 active_time = ktime_set(0, 0);
802 }
803
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200804 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 +0200805 "%lld\t\t%lld\t\t%lld\t\t%lld\t\t%lld\n",
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200806 ws->name, active_count, ws->event_count,
807 ws->wakeup_count, ws->expire_count,
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200808 ktime_to_ms(active_time), ktime_to_ms(total_time),
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200809 ktime_to_ms(max_time), ktime_to_ms(ws->last_time),
810 ktime_to_ms(prevent_sleep_time));
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200811
812 spin_unlock_irqrestore(&ws->lock, flags);
813
814 return ret;
815}
816
817/**
818 * wakeup_sources_stats_show - Print wakeup sources statistics information.
819 * @m: seq_file to print the statistics into.
820 */
821static int wakeup_sources_stats_show(struct seq_file *m, void *unused)
822{
823 struct wakeup_source *ws;
824
Rafael J. Wysocki30e3ce62012-04-29 22:52:52 +0200825 seq_puts(m, "name\t\tactive_count\tevent_count\twakeup_count\t"
826 "expire_count\tactive_since\ttotal_time\tmax_time\t"
Rafael J. Wysocki55850942012-04-29 22:53:32 +0200827 "last_change\tprevent_suspend_time\n");
Rafael J. Wysocki9c034392010-10-19 23:42:49 +0200828
829 rcu_read_lock();
830 list_for_each_entry_rcu(ws, &wakeup_sources, entry)
831 print_wakeup_source_stats(m, ws);
832 rcu_read_unlock();
833
834 return 0;
835}
836
837static int wakeup_sources_stats_open(struct inode *inode, struct file *file)
838{
839 return single_open(file, wakeup_sources_stats_show, NULL);
840}
841
842static const struct file_operations wakeup_sources_stats_fops = {
843 .owner = THIS_MODULE,
844 .open = wakeup_sources_stats_open,
845 .read = seq_read,
846 .llseek = seq_lseek,
847 .release = single_release,
848};
849
850static int __init wakeup_sources_debugfs_init(void)
851{
852 wakeup_sources_stats_dentry = debugfs_create_file("wakeup_sources",
853 S_IRUGO, NULL, NULL, &wakeup_sources_stats_fops);
854 return 0;
855}
856
857postcore_initcall(wakeup_sources_debugfs_init);