Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[cris-mirror.git] / drivers / base / power / wakeup.c
blobea01621ed769ab262b39d421d24f83a8433130ab
1 /*
2 * drivers/base/power/wakeup.c - System wakeup events framework
4 * Copyright (c) 2010 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
6 * This file is released under the GPLv2.
7 */
9 #include <linux/device.h>
10 #include <linux/slab.h>
11 #include <linux/sched/signal.h>
12 #include <linux/capability.h>
13 #include <linux/export.h>
14 #include <linux/suspend.h>
15 #include <linux/seq_file.h>
16 #include <linux/debugfs.h>
17 #include <linux/pm_wakeirq.h>
18 #include <trace/events/power.h>
20 #include "power.h"
22 #ifndef CONFIG_SUSPEND
23 suspend_state_t pm_suspend_target_state;
24 #define pm_suspend_target_state (PM_SUSPEND_ON)
25 #endif
28 * If set, the suspend/hibernate code will abort transitions to a sleep state
29 * if wakeup events are registered during or immediately before the transition.
31 bool events_check_enabled __read_mostly;
33 /* First wakeup IRQ seen by the kernel in the last cycle. */
34 unsigned int pm_wakeup_irq __read_mostly;
36 /* If greater than 0 and the system is suspending, terminate the suspend. */
37 static atomic_t pm_abort_suspend __read_mostly;
40 * Combined counters of registered wakeup events and wakeup events in progress.
41 * They need to be modified together atomically, so it's better to use one
42 * atomic variable to hold them both.
44 static atomic_t combined_event_count = ATOMIC_INIT(0);
46 #define IN_PROGRESS_BITS (sizeof(int) * 4)
47 #define MAX_IN_PROGRESS ((1 << IN_PROGRESS_BITS) - 1)
49 static void split_counters(unsigned int *cnt, unsigned int *inpr)
51 unsigned int comb = atomic_read(&combined_event_count);
53 *cnt = (comb >> IN_PROGRESS_BITS);
54 *inpr = comb & MAX_IN_PROGRESS;
57 /* A preserved old value of the events counter. */
58 static unsigned int saved_count;
60 static DEFINE_SPINLOCK(events_lock);
62 static void pm_wakeup_timer_fn(struct timer_list *t);
64 static LIST_HEAD(wakeup_sources);
66 static DECLARE_WAIT_QUEUE_HEAD(wakeup_count_wait_queue);
68 DEFINE_STATIC_SRCU(wakeup_srcu);
70 static struct wakeup_source deleted_ws = {
71 .name = "deleted",
72 .lock = __SPIN_LOCK_UNLOCKED(deleted_ws.lock),
75 /**
76 * wakeup_source_prepare - Prepare a new wakeup source for initialization.
77 * @ws: Wakeup source to prepare.
78 * @name: Pointer to the name of the new wakeup source.
80 * Callers must ensure that the @name string won't be freed when @ws is still in
81 * use.
83 void wakeup_source_prepare(struct wakeup_source *ws, const char *name)
85 if (ws) {
86 memset(ws, 0, sizeof(*ws));
87 ws->name = name;
90 EXPORT_SYMBOL_GPL(wakeup_source_prepare);
92 /**
93 * wakeup_source_create - Create a struct wakeup_source object.
94 * @name: Name of the new wakeup source.
96 struct wakeup_source *wakeup_source_create(const char *name)
98 struct wakeup_source *ws;
100 ws = kmalloc(sizeof(*ws), GFP_KERNEL);
101 if (!ws)
102 return NULL;
104 wakeup_source_prepare(ws, name ? kstrdup_const(name, GFP_KERNEL) : NULL);
105 return ws;
107 EXPORT_SYMBOL_GPL(wakeup_source_create);
110 * wakeup_source_drop - Prepare a struct wakeup_source object for destruction.
111 * @ws: Wakeup source to prepare for destruction.
113 * Callers must ensure that __pm_stay_awake() or __pm_wakeup_event() will never
114 * be run in parallel with this function for the same wakeup source object.
116 void wakeup_source_drop(struct wakeup_source *ws)
118 if (!ws)
119 return;
121 del_timer_sync(&ws->timer);
122 __pm_relax(ws);
124 EXPORT_SYMBOL_GPL(wakeup_source_drop);
127 * Record wakeup_source statistics being deleted into a dummy wakeup_source.
129 static void wakeup_source_record(struct wakeup_source *ws)
131 unsigned long flags;
133 spin_lock_irqsave(&deleted_ws.lock, flags);
135 if (ws->event_count) {
136 deleted_ws.total_time =
137 ktime_add(deleted_ws.total_time, ws->total_time);
138 deleted_ws.prevent_sleep_time =
139 ktime_add(deleted_ws.prevent_sleep_time,
140 ws->prevent_sleep_time);
141 deleted_ws.max_time =
142 ktime_compare(deleted_ws.max_time, ws->max_time) > 0 ?
143 deleted_ws.max_time : ws->max_time;
144 deleted_ws.event_count += ws->event_count;
145 deleted_ws.active_count += ws->active_count;
146 deleted_ws.relax_count += ws->relax_count;
147 deleted_ws.expire_count += ws->expire_count;
148 deleted_ws.wakeup_count += ws->wakeup_count;
151 spin_unlock_irqrestore(&deleted_ws.lock, flags);
155 * wakeup_source_destroy - Destroy a struct wakeup_source object.
156 * @ws: Wakeup source to destroy.
158 * Use only for wakeup source objects created with wakeup_source_create().
160 void wakeup_source_destroy(struct wakeup_source *ws)
162 if (!ws)
163 return;
165 wakeup_source_drop(ws);
166 wakeup_source_record(ws);
167 kfree_const(ws->name);
168 kfree(ws);
170 EXPORT_SYMBOL_GPL(wakeup_source_destroy);
173 * wakeup_source_add - Add given object to the list of wakeup sources.
174 * @ws: Wakeup source object to add to the list.
176 void wakeup_source_add(struct wakeup_source *ws)
178 unsigned long flags;
180 if (WARN_ON(!ws))
181 return;
183 spin_lock_init(&ws->lock);
184 timer_setup(&ws->timer, pm_wakeup_timer_fn, 0);
185 ws->active = false;
186 ws->last_time = ktime_get();
188 spin_lock_irqsave(&events_lock, flags);
189 list_add_rcu(&ws->entry, &wakeup_sources);
190 spin_unlock_irqrestore(&events_lock, flags);
192 EXPORT_SYMBOL_GPL(wakeup_source_add);
195 * wakeup_source_remove - Remove given object from the wakeup sources list.
196 * @ws: Wakeup source object to remove from the list.
198 void wakeup_source_remove(struct wakeup_source *ws)
200 unsigned long flags;
202 if (WARN_ON(!ws))
203 return;
205 spin_lock_irqsave(&events_lock, flags);
206 list_del_rcu(&ws->entry);
207 spin_unlock_irqrestore(&events_lock, flags);
208 synchronize_srcu(&wakeup_srcu);
210 EXPORT_SYMBOL_GPL(wakeup_source_remove);
213 * wakeup_source_register - Create wakeup source and add it to the list.
214 * @name: Name of the wakeup source to register.
216 struct wakeup_source *wakeup_source_register(const char *name)
218 struct wakeup_source *ws;
220 ws = wakeup_source_create(name);
221 if (ws)
222 wakeup_source_add(ws);
224 return ws;
226 EXPORT_SYMBOL_GPL(wakeup_source_register);
229 * wakeup_source_unregister - Remove wakeup source from the list and remove it.
230 * @ws: Wakeup source object to unregister.
232 void wakeup_source_unregister(struct wakeup_source *ws)
234 if (ws) {
235 wakeup_source_remove(ws);
236 wakeup_source_destroy(ws);
239 EXPORT_SYMBOL_GPL(wakeup_source_unregister);
242 * device_wakeup_attach - Attach a wakeup source object to a device object.
243 * @dev: Device to handle.
244 * @ws: Wakeup source object to attach to @dev.
246 * This causes @dev to be treated as a wakeup device.
248 static int device_wakeup_attach(struct device *dev, struct wakeup_source *ws)
250 spin_lock_irq(&dev->power.lock);
251 if (dev->power.wakeup) {
252 spin_unlock_irq(&dev->power.lock);
253 return -EEXIST;
255 dev->power.wakeup = ws;
256 if (dev->power.wakeirq)
257 device_wakeup_attach_irq(dev, dev->power.wakeirq);
258 spin_unlock_irq(&dev->power.lock);
259 return 0;
263 * device_wakeup_enable - Enable given device to be a wakeup source.
264 * @dev: Device to handle.
266 * Create a wakeup source object, register it and attach it to @dev.
268 int device_wakeup_enable(struct device *dev)
270 struct wakeup_source *ws;
271 int ret;
273 if (!dev || !dev->power.can_wakeup)
274 return -EINVAL;
276 if (pm_suspend_target_state != PM_SUSPEND_ON)
277 dev_dbg(dev, "Suspicious %s() during system transition!\n", __func__);
279 ws = wakeup_source_register(dev_name(dev));
280 if (!ws)
281 return -ENOMEM;
283 ret = device_wakeup_attach(dev, ws);
284 if (ret)
285 wakeup_source_unregister(ws);
287 return ret;
289 EXPORT_SYMBOL_GPL(device_wakeup_enable);
292 * device_wakeup_attach_irq - Attach a wakeirq to a wakeup source
293 * @dev: Device to handle
294 * @wakeirq: Device specific wakeirq entry
296 * Attach a device wakeirq to the wakeup source so the device
297 * wake IRQ can be configured automatically for suspend and
298 * resume.
300 * Call under the device's power.lock lock.
302 void device_wakeup_attach_irq(struct device *dev,
303 struct wake_irq *wakeirq)
305 struct wakeup_source *ws;
307 ws = dev->power.wakeup;
308 if (!ws)
309 return;
311 if (ws->wakeirq)
312 dev_err(dev, "Leftover wakeup IRQ found, overriding\n");
314 ws->wakeirq = wakeirq;
318 * device_wakeup_detach_irq - Detach a wakeirq from a wakeup source
319 * @dev: Device to handle
321 * Removes a device wakeirq from the wakeup source.
323 * Call under the device's power.lock lock.
325 void device_wakeup_detach_irq(struct device *dev)
327 struct wakeup_source *ws;
329 ws = dev->power.wakeup;
330 if (ws)
331 ws->wakeirq = NULL;
335 * device_wakeup_arm_wake_irqs(void)
337 * Itereates over the list of device wakeirqs to arm them.
339 void device_wakeup_arm_wake_irqs(void)
341 struct wakeup_source *ws;
342 int srcuidx;
344 srcuidx = srcu_read_lock(&wakeup_srcu);
345 list_for_each_entry_rcu(ws, &wakeup_sources, entry)
346 dev_pm_arm_wake_irq(ws->wakeirq);
347 srcu_read_unlock(&wakeup_srcu, srcuidx);
351 * device_wakeup_disarm_wake_irqs(void)
353 * Itereates over the list of device wakeirqs to disarm them.
355 void device_wakeup_disarm_wake_irqs(void)
357 struct wakeup_source *ws;
358 int srcuidx;
360 srcuidx = srcu_read_lock(&wakeup_srcu);
361 list_for_each_entry_rcu(ws, &wakeup_sources, entry)
362 dev_pm_disarm_wake_irq(ws->wakeirq);
363 srcu_read_unlock(&wakeup_srcu, srcuidx);
367 * device_wakeup_detach - Detach a device's wakeup source object from it.
368 * @dev: Device to detach the wakeup source object from.
370 * After it returns, @dev will not be treated as a wakeup device any more.
372 static struct wakeup_source *device_wakeup_detach(struct device *dev)
374 struct wakeup_source *ws;
376 spin_lock_irq(&dev->power.lock);
377 ws = dev->power.wakeup;
378 dev->power.wakeup = NULL;
379 spin_unlock_irq(&dev->power.lock);
380 return ws;
384 * device_wakeup_disable - Do not regard a device as a wakeup source any more.
385 * @dev: Device to handle.
387 * Detach the @dev's wakeup source object from it, unregister this wakeup source
388 * object and destroy it.
390 int device_wakeup_disable(struct device *dev)
392 struct wakeup_source *ws;
394 if (!dev || !dev->power.can_wakeup)
395 return -EINVAL;
397 ws = device_wakeup_detach(dev);
398 wakeup_source_unregister(ws);
399 return 0;
401 EXPORT_SYMBOL_GPL(device_wakeup_disable);
404 * device_set_wakeup_capable - Set/reset device wakeup capability flag.
405 * @dev: Device to handle.
406 * @capable: Whether or not @dev is capable of waking up the system from sleep.
408 * If @capable is set, set the @dev's power.can_wakeup flag and add its
409 * wakeup-related attributes to sysfs. Otherwise, unset the @dev's
410 * power.can_wakeup flag and remove its wakeup-related attributes from sysfs.
412 * This function may sleep and it can't be called from any context where
413 * sleeping is not allowed.
415 void device_set_wakeup_capable(struct device *dev, bool capable)
417 if (!!dev->power.can_wakeup == !!capable)
418 return;
420 dev->power.can_wakeup = capable;
421 if (device_is_registered(dev) && !list_empty(&dev->power.entry)) {
422 if (capable) {
423 int ret = wakeup_sysfs_add(dev);
425 if (ret)
426 dev_info(dev, "Wakeup sysfs attributes not added\n");
427 } else {
428 wakeup_sysfs_remove(dev);
432 EXPORT_SYMBOL_GPL(device_set_wakeup_capable);
435 * device_init_wakeup - Device wakeup initialization.
436 * @dev: Device to handle.
437 * @enable: Whether or not to enable @dev as a wakeup device.
439 * By default, most devices should leave wakeup disabled. The exceptions are
440 * devices that everyone expects to be wakeup sources: keyboards, power buttons,
441 * possibly network interfaces, etc. Also, devices that don't generate their
442 * own wakeup requests but merely forward requests from one bus to another
443 * (like PCI bridges) should have wakeup enabled by default.
445 int device_init_wakeup(struct device *dev, bool enable)
447 int ret = 0;
449 if (!dev)
450 return -EINVAL;
452 if (enable) {
453 device_set_wakeup_capable(dev, true);
454 ret = device_wakeup_enable(dev);
455 } else {
456 device_wakeup_disable(dev);
457 device_set_wakeup_capable(dev, false);
460 return ret;
462 EXPORT_SYMBOL_GPL(device_init_wakeup);
465 * device_set_wakeup_enable - Enable or disable a device to wake up the system.
466 * @dev: Device to handle.
468 int device_set_wakeup_enable(struct device *dev, bool enable)
470 return enable ? device_wakeup_enable(dev) : device_wakeup_disable(dev);
472 EXPORT_SYMBOL_GPL(device_set_wakeup_enable);
475 * wakeup_source_not_registered - validate the given wakeup source.
476 * @ws: Wakeup source to be validated.
478 static bool wakeup_source_not_registered(struct wakeup_source *ws)
481 * Use timer struct to check if the given source is initialized
482 * by wakeup_source_add.
484 return ws->timer.function != pm_wakeup_timer_fn;
488 * The functions below use the observation that each wakeup event starts a
489 * period in which the system should not be suspended. The moment this period
490 * will end depends on how the wakeup event is going to be processed after being
491 * detected and all of the possible cases can be divided into two distinct
492 * groups.
494 * First, a wakeup event may be detected by the same functional unit that will
495 * carry out the entire processing of it and possibly will pass it to user space
496 * for further processing. In that case the functional unit that has detected
497 * the event may later "close" the "no suspend" period associated with it
498 * directly as soon as it has been dealt with. The pair of pm_stay_awake() and
499 * pm_relax(), balanced with each other, is supposed to be used in such
500 * situations.
502 * Second, a wakeup event may be detected by one functional unit and processed
503 * by another one. In that case the unit that has detected it cannot really
504 * "close" the "no suspend" period associated with it, unless it knows in
505 * advance what's going to happen to the event during processing. This
506 * knowledge, however, may not be available to it, so it can simply specify time
507 * to wait before the system can be suspended and pass it as the second
508 * argument of pm_wakeup_event().
510 * It is valid to call pm_relax() after pm_wakeup_event(), in which case the
511 * "no suspend" period will be ended either by the pm_relax(), or by the timer
512 * function executed when the timer expires, whichever comes first.
516 * wakup_source_activate - Mark given wakeup source as active.
517 * @ws: Wakeup source to handle.
519 * Update the @ws' statistics and, if @ws has just been activated, notify the PM
520 * core of the event by incrementing the counter of of wakeup events being
521 * processed.
523 static void wakeup_source_activate(struct wakeup_source *ws)
525 unsigned int cec;
527 if (WARN_ONCE(wakeup_source_not_registered(ws),
528 "unregistered wakeup source\n"))
529 return;
531 ws->active = true;
532 ws->active_count++;
533 ws->last_time = ktime_get();
534 if (ws->autosleep_enabled)
535 ws->start_prevent_time = ws->last_time;
537 /* Increment the counter of events in progress. */
538 cec = atomic_inc_return(&combined_event_count);
540 trace_wakeup_source_activate(ws->name, cec);
544 * wakeup_source_report_event - Report wakeup event using the given source.
545 * @ws: Wakeup source to report the event for.
546 * @hard: If set, abort suspends in progress and wake up from suspend-to-idle.
548 static void wakeup_source_report_event(struct wakeup_source *ws, bool hard)
550 ws->event_count++;
551 /* This is racy, but the counter is approximate anyway. */
552 if (events_check_enabled)
553 ws->wakeup_count++;
555 if (!ws->active)
556 wakeup_source_activate(ws);
558 if (hard)
559 pm_system_wakeup();
563 * __pm_stay_awake - Notify the PM core of a wakeup event.
564 * @ws: Wakeup source object associated with the source of the event.
566 * It is safe to call this function from interrupt context.
568 void __pm_stay_awake(struct wakeup_source *ws)
570 unsigned long flags;
572 if (!ws)
573 return;
575 spin_lock_irqsave(&ws->lock, flags);
577 wakeup_source_report_event(ws, false);
578 del_timer(&ws->timer);
579 ws->timer_expires = 0;
581 spin_unlock_irqrestore(&ws->lock, flags);
583 EXPORT_SYMBOL_GPL(__pm_stay_awake);
586 * pm_stay_awake - Notify the PM core that a wakeup event is being processed.
587 * @dev: Device the wakeup event is related to.
589 * Notify the PM core of a wakeup event (signaled by @dev) by calling
590 * __pm_stay_awake for the @dev's wakeup source object.
592 * Call this function after detecting of a wakeup event if pm_relax() is going
593 * to be called directly after processing the event (and possibly passing it to
594 * user space for further processing).
596 void pm_stay_awake(struct device *dev)
598 unsigned long flags;
600 if (!dev)
601 return;
603 spin_lock_irqsave(&dev->power.lock, flags);
604 __pm_stay_awake(dev->power.wakeup);
605 spin_unlock_irqrestore(&dev->power.lock, flags);
607 EXPORT_SYMBOL_GPL(pm_stay_awake);
609 #ifdef CONFIG_PM_AUTOSLEEP
610 static void update_prevent_sleep_time(struct wakeup_source *ws, ktime_t now)
612 ktime_t delta = ktime_sub(now, ws->start_prevent_time);
613 ws->prevent_sleep_time = ktime_add(ws->prevent_sleep_time, delta);
615 #else
616 static inline void update_prevent_sleep_time(struct wakeup_source *ws,
617 ktime_t now) {}
618 #endif
621 * wakup_source_deactivate - Mark given wakeup source as inactive.
622 * @ws: Wakeup source to handle.
624 * Update the @ws' statistics and notify the PM core that the wakeup source has
625 * become inactive by decrementing the counter of wakeup events being processed
626 * and incrementing the counter of registered wakeup events.
628 static void wakeup_source_deactivate(struct wakeup_source *ws)
630 unsigned int cnt, inpr, cec;
631 ktime_t duration;
632 ktime_t now;
634 ws->relax_count++;
636 * __pm_relax() may be called directly or from a timer function.
637 * If it is called directly right after the timer function has been
638 * started, but before the timer function calls __pm_relax(), it is
639 * possible that __pm_stay_awake() will be called in the meantime and
640 * will set ws->active. Then, ws->active may be cleared immediately
641 * by the __pm_relax() called from the timer function, but in such a
642 * case ws->relax_count will be different from ws->active_count.
644 if (ws->relax_count != ws->active_count) {
645 ws->relax_count--;
646 return;
649 ws->active = false;
651 now = ktime_get();
652 duration = ktime_sub(now, ws->last_time);
653 ws->total_time = ktime_add(ws->total_time, duration);
654 if (ktime_to_ns(duration) > ktime_to_ns(ws->max_time))
655 ws->max_time = duration;
657 ws->last_time = now;
658 del_timer(&ws->timer);
659 ws->timer_expires = 0;
661 if (ws->autosleep_enabled)
662 update_prevent_sleep_time(ws, now);
665 * Increment the counter of registered wakeup events and decrement the
666 * couter of wakeup events in progress simultaneously.
668 cec = atomic_add_return(MAX_IN_PROGRESS, &combined_event_count);
669 trace_wakeup_source_deactivate(ws->name, cec);
671 split_counters(&cnt, &inpr);
672 if (!inpr && waitqueue_active(&wakeup_count_wait_queue))
673 wake_up(&wakeup_count_wait_queue);
677 * __pm_relax - Notify the PM core that processing of a wakeup event has ended.
678 * @ws: Wakeup source object associated with the source of the event.
680 * Call this function for wakeup events whose processing started with calling
681 * __pm_stay_awake().
683 * It is safe to call it from interrupt context.
685 void __pm_relax(struct wakeup_source *ws)
687 unsigned long flags;
689 if (!ws)
690 return;
692 spin_lock_irqsave(&ws->lock, flags);
693 if (ws->active)
694 wakeup_source_deactivate(ws);
695 spin_unlock_irqrestore(&ws->lock, flags);
697 EXPORT_SYMBOL_GPL(__pm_relax);
700 * pm_relax - Notify the PM core that processing of a wakeup event has ended.
701 * @dev: Device that signaled the event.
703 * Execute __pm_relax() for the @dev's wakeup source object.
705 void pm_relax(struct device *dev)
707 unsigned long flags;
709 if (!dev)
710 return;
712 spin_lock_irqsave(&dev->power.lock, flags);
713 __pm_relax(dev->power.wakeup);
714 spin_unlock_irqrestore(&dev->power.lock, flags);
716 EXPORT_SYMBOL_GPL(pm_relax);
719 * pm_wakeup_timer_fn - Delayed finalization of a wakeup event.
720 * @data: Address of the wakeup source object associated with the event source.
722 * Call wakeup_source_deactivate() for the wakeup source whose address is stored
723 * in @data if it is currently active and its timer has not been canceled and
724 * the expiration time of the timer is not in future.
726 static void pm_wakeup_timer_fn(struct timer_list *t)
728 struct wakeup_source *ws = from_timer(ws, t, timer);
729 unsigned long flags;
731 spin_lock_irqsave(&ws->lock, flags);
733 if (ws->active && ws->timer_expires
734 && time_after_eq(jiffies, ws->timer_expires)) {
735 wakeup_source_deactivate(ws);
736 ws->expire_count++;
739 spin_unlock_irqrestore(&ws->lock, flags);
743 * pm_wakeup_ws_event - Notify the PM core of a wakeup event.
744 * @ws: Wakeup source object associated with the event source.
745 * @msec: Anticipated event processing time (in milliseconds).
746 * @hard: If set, abort suspends in progress and wake up from suspend-to-idle.
748 * Notify the PM core of a wakeup event whose source is @ws that will take
749 * approximately @msec milliseconds to be processed by the kernel. If @ws is
750 * not active, activate it. If @msec is nonzero, set up the @ws' timer to
751 * execute pm_wakeup_timer_fn() in future.
753 * It is safe to call this function from interrupt context.
755 void pm_wakeup_ws_event(struct wakeup_source *ws, unsigned int msec, bool hard)
757 unsigned long flags;
758 unsigned long expires;
760 if (!ws)
761 return;
763 spin_lock_irqsave(&ws->lock, flags);
765 wakeup_source_report_event(ws, hard);
767 if (!msec) {
768 wakeup_source_deactivate(ws);
769 goto unlock;
772 expires = jiffies + msecs_to_jiffies(msec);
773 if (!expires)
774 expires = 1;
776 if (!ws->timer_expires || time_after(expires, ws->timer_expires)) {
777 mod_timer(&ws->timer, expires);
778 ws->timer_expires = expires;
781 unlock:
782 spin_unlock_irqrestore(&ws->lock, flags);
784 EXPORT_SYMBOL_GPL(pm_wakeup_ws_event);
787 * pm_wakeup_event - Notify the PM core of a wakeup event.
788 * @dev: Device the wakeup event is related to.
789 * @msec: Anticipated event processing time (in milliseconds).
790 * @hard: If set, abort suspends in progress and wake up from suspend-to-idle.
792 * Call pm_wakeup_ws_event() for the @dev's wakeup source object.
794 void pm_wakeup_dev_event(struct device *dev, unsigned int msec, bool hard)
796 unsigned long flags;
798 if (!dev)
799 return;
801 spin_lock_irqsave(&dev->power.lock, flags);
802 pm_wakeup_ws_event(dev->power.wakeup, msec, hard);
803 spin_unlock_irqrestore(&dev->power.lock, flags);
805 EXPORT_SYMBOL_GPL(pm_wakeup_dev_event);
807 void pm_print_active_wakeup_sources(void)
809 struct wakeup_source *ws;
810 int srcuidx, active = 0;
811 struct wakeup_source *last_activity_ws = NULL;
813 srcuidx = srcu_read_lock(&wakeup_srcu);
814 list_for_each_entry_rcu(ws, &wakeup_sources, entry) {
815 if (ws->active) {
816 pr_debug("active wakeup source: %s\n", ws->name);
817 active = 1;
818 } else if (!active &&
819 (!last_activity_ws ||
820 ktime_to_ns(ws->last_time) >
821 ktime_to_ns(last_activity_ws->last_time))) {
822 last_activity_ws = ws;
826 if (!active && last_activity_ws)
827 pr_debug("last active wakeup source: %s\n",
828 last_activity_ws->name);
829 srcu_read_unlock(&wakeup_srcu, srcuidx);
831 EXPORT_SYMBOL_GPL(pm_print_active_wakeup_sources);
834 * pm_wakeup_pending - Check if power transition in progress should be aborted.
836 * Compare the current number of registered wakeup events with its preserved
837 * value from the past and return true if new wakeup events have been registered
838 * since the old value was stored. Also return true if the current number of
839 * wakeup events being processed is different from zero.
841 bool pm_wakeup_pending(void)
843 unsigned long flags;
844 bool ret = false;
846 spin_lock_irqsave(&events_lock, flags);
847 if (events_check_enabled) {
848 unsigned int cnt, inpr;
850 split_counters(&cnt, &inpr);
851 ret = (cnt != saved_count || inpr > 0);
852 events_check_enabled = !ret;
854 spin_unlock_irqrestore(&events_lock, flags);
856 if (ret) {
857 pr_info("PM: Wakeup pending, aborting suspend\n");
858 pm_print_active_wakeup_sources();
861 return ret || atomic_read(&pm_abort_suspend) > 0;
864 void pm_system_wakeup(void)
866 atomic_inc(&pm_abort_suspend);
867 s2idle_wake();
869 EXPORT_SYMBOL_GPL(pm_system_wakeup);
871 void pm_system_cancel_wakeup(void)
873 atomic_dec(&pm_abort_suspend);
876 void pm_wakeup_clear(bool reset)
878 pm_wakeup_irq = 0;
879 if (reset)
880 atomic_set(&pm_abort_suspend, 0);
883 void pm_system_irq_wakeup(unsigned int irq_number)
885 if (pm_wakeup_irq == 0) {
886 pm_wakeup_irq = irq_number;
887 pm_system_wakeup();
892 * pm_get_wakeup_count - Read the number of registered wakeup events.
893 * @count: Address to store the value at.
894 * @block: Whether or not to block.
896 * Store the number of registered wakeup events at the address in @count. If
897 * @block is set, block until the current number of wakeup events being
898 * processed is zero.
900 * Return 'false' if the current number of wakeup events being processed is
901 * nonzero. Otherwise return 'true'.
903 bool pm_get_wakeup_count(unsigned int *count, bool block)
905 unsigned int cnt, inpr;
907 if (block) {
908 DEFINE_WAIT(wait);
910 for (;;) {
911 prepare_to_wait(&wakeup_count_wait_queue, &wait,
912 TASK_INTERRUPTIBLE);
913 split_counters(&cnt, &inpr);
914 if (inpr == 0 || signal_pending(current))
915 break;
916 pm_print_active_wakeup_sources();
917 schedule();
919 finish_wait(&wakeup_count_wait_queue, &wait);
922 split_counters(&cnt, &inpr);
923 *count = cnt;
924 return !inpr;
928 * pm_save_wakeup_count - Save the current number of registered wakeup events.
929 * @count: Value to compare with the current number of registered wakeup events.
931 * If @count is equal to the current number of registered wakeup events and the
932 * current number of wakeup events being processed is zero, store @count as the
933 * old number of registered wakeup events for pm_check_wakeup_events(), enable
934 * wakeup events detection and return 'true'. Otherwise disable wakeup events
935 * detection and return 'false'.
937 bool pm_save_wakeup_count(unsigned int count)
939 unsigned int cnt, inpr;
940 unsigned long flags;
942 events_check_enabled = false;
943 spin_lock_irqsave(&events_lock, flags);
944 split_counters(&cnt, &inpr);
945 if (cnt == count && inpr == 0) {
946 saved_count = count;
947 events_check_enabled = true;
949 spin_unlock_irqrestore(&events_lock, flags);
950 return events_check_enabled;
953 #ifdef CONFIG_PM_AUTOSLEEP
955 * pm_wakep_autosleep_enabled - Modify autosleep_enabled for all wakeup sources.
956 * @enabled: Whether to set or to clear the autosleep_enabled flags.
958 void pm_wakep_autosleep_enabled(bool set)
960 struct wakeup_source *ws;
961 ktime_t now = ktime_get();
962 int srcuidx;
964 srcuidx = srcu_read_lock(&wakeup_srcu);
965 list_for_each_entry_rcu(ws, &wakeup_sources, entry) {
966 spin_lock_irq(&ws->lock);
967 if (ws->autosleep_enabled != set) {
968 ws->autosleep_enabled = set;
969 if (ws->active) {
970 if (set)
971 ws->start_prevent_time = now;
972 else
973 update_prevent_sleep_time(ws, now);
976 spin_unlock_irq(&ws->lock);
978 srcu_read_unlock(&wakeup_srcu, srcuidx);
980 #endif /* CONFIG_PM_AUTOSLEEP */
982 static struct dentry *wakeup_sources_stats_dentry;
985 * print_wakeup_source_stats - Print wakeup source statistics information.
986 * @m: seq_file to print the statistics into.
987 * @ws: Wakeup source object to print the statistics for.
989 static int print_wakeup_source_stats(struct seq_file *m,
990 struct wakeup_source *ws)
992 unsigned long flags;
993 ktime_t total_time;
994 ktime_t max_time;
995 unsigned long active_count;
996 ktime_t active_time;
997 ktime_t prevent_sleep_time;
999 spin_lock_irqsave(&ws->lock, flags);
1001 total_time = ws->total_time;
1002 max_time = ws->max_time;
1003 prevent_sleep_time = ws->prevent_sleep_time;
1004 active_count = ws->active_count;
1005 if (ws->active) {
1006 ktime_t now = ktime_get();
1008 active_time = ktime_sub(now, ws->last_time);
1009 total_time = ktime_add(total_time, active_time);
1010 if (active_time > max_time)
1011 max_time = active_time;
1013 if (ws->autosleep_enabled)
1014 prevent_sleep_time = ktime_add(prevent_sleep_time,
1015 ktime_sub(now, ws->start_prevent_time));
1016 } else {
1017 active_time = 0;
1020 seq_printf(m, "%-12s\t%lu\t\t%lu\t\t%lu\t\t%lu\t\t%lld\t\t%lld\t\t%lld\t\t%lld\t\t%lld\n",
1021 ws->name, active_count, ws->event_count,
1022 ws->wakeup_count, ws->expire_count,
1023 ktime_to_ms(active_time), ktime_to_ms(total_time),
1024 ktime_to_ms(max_time), ktime_to_ms(ws->last_time),
1025 ktime_to_ms(prevent_sleep_time));
1027 spin_unlock_irqrestore(&ws->lock, flags);
1029 return 0;
1033 * wakeup_sources_stats_show - Print wakeup sources statistics information.
1034 * @m: seq_file to print the statistics into.
1036 static int wakeup_sources_stats_show(struct seq_file *m, void *unused)
1038 struct wakeup_source *ws;
1039 int srcuidx;
1041 seq_puts(m, "name\t\tactive_count\tevent_count\twakeup_count\t"
1042 "expire_count\tactive_since\ttotal_time\tmax_time\t"
1043 "last_change\tprevent_suspend_time\n");
1045 srcuidx = srcu_read_lock(&wakeup_srcu);
1046 list_for_each_entry_rcu(ws, &wakeup_sources, entry)
1047 print_wakeup_source_stats(m, ws);
1048 srcu_read_unlock(&wakeup_srcu, srcuidx);
1050 print_wakeup_source_stats(m, &deleted_ws);
1052 return 0;
1055 static int wakeup_sources_stats_open(struct inode *inode, struct file *file)
1057 return single_open(file, wakeup_sources_stats_show, NULL);
1060 static const struct file_operations wakeup_sources_stats_fops = {
1061 .owner = THIS_MODULE,
1062 .open = wakeup_sources_stats_open,
1063 .read = seq_read,
1064 .llseek = seq_lseek,
1065 .release = single_release,
1068 static int __init wakeup_sources_debugfs_init(void)
1070 wakeup_sources_stats_dentry = debugfs_create_file("wakeup_sources",
1071 S_IRUGO, NULL, NULL, &wakeup_sources_stats_fops);
1072 return 0;
1075 postcore_initcall(wakeup_sources_debugfs_init);