]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/base/power/wakeup.c
Merge branch 'for-4.15/asus' into for-linus
[mirror_ubuntu-bionic-kernel.git] / drivers / base / power / wakeup.c
1 /*
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/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>
19
20 #include "power.h"
21
22 /*
23 * If set, the suspend/hibernate code will abort transitions to a sleep state
24 * if wakeup events are registered during or immediately before the transition.
25 */
26 bool events_check_enabled __read_mostly;
27
28 /* First wakeup IRQ seen by the kernel in the last cycle. */
29 unsigned int pm_wakeup_irq __read_mostly;
30
31 /* If greater than 0 and the system is suspending, terminate the suspend. */
32 static atomic_t pm_abort_suspend __read_mostly;
33
34 /*
35 * Combined counters of registered wakeup events and wakeup events in progress.
36 * They need to be modified together atomically, so it's better to use one
37 * atomic variable to hold them both.
38 */
39 static atomic_t combined_event_count = ATOMIC_INIT(0);
40
41 #define IN_PROGRESS_BITS (sizeof(int) * 4)
42 #define MAX_IN_PROGRESS ((1 << IN_PROGRESS_BITS) - 1)
43
44 static void split_counters(unsigned int *cnt, unsigned int *inpr)
45 {
46 unsigned int comb = atomic_read(&combined_event_count);
47
48 *cnt = (comb >> IN_PROGRESS_BITS);
49 *inpr = comb & MAX_IN_PROGRESS;
50 }
51
52 /* A preserved old value of the events counter. */
53 static unsigned int saved_count;
54
55 static DEFINE_SPINLOCK(events_lock);
56
57 static void pm_wakeup_timer_fn(unsigned long data);
58
59 static LIST_HEAD(wakeup_sources);
60
61 static DECLARE_WAIT_QUEUE_HEAD(wakeup_count_wait_queue);
62
63 DEFINE_STATIC_SRCU(wakeup_srcu);
64
65 static struct wakeup_source deleted_ws = {
66 .name = "deleted",
67 .lock = __SPIN_LOCK_UNLOCKED(deleted_ws.lock),
68 };
69
70 /**
71 * wakeup_source_prepare - Prepare a new wakeup source for initialization.
72 * @ws: Wakeup source to prepare.
73 * @name: Pointer to the name of the new wakeup source.
74 *
75 * Callers must ensure that the @name string won't be freed when @ws is still in
76 * use.
77 */
78 void wakeup_source_prepare(struct wakeup_source *ws, const char *name)
79 {
80 if (ws) {
81 memset(ws, 0, sizeof(*ws));
82 ws->name = name;
83 }
84 }
85 EXPORT_SYMBOL_GPL(wakeup_source_prepare);
86
87 /**
88 * wakeup_source_create - Create a struct wakeup_source object.
89 * @name: Name of the new wakeup source.
90 */
91 struct wakeup_source *wakeup_source_create(const char *name)
92 {
93 struct wakeup_source *ws;
94
95 ws = kmalloc(sizeof(*ws), GFP_KERNEL);
96 if (!ws)
97 return NULL;
98
99 wakeup_source_prepare(ws, name ? kstrdup_const(name, GFP_KERNEL) : NULL);
100 return ws;
101 }
102 EXPORT_SYMBOL_GPL(wakeup_source_create);
103
104 /**
105 * wakeup_source_drop - Prepare a struct wakeup_source object for destruction.
106 * @ws: Wakeup source to prepare for destruction.
107 *
108 * Callers must ensure that __pm_stay_awake() or __pm_wakeup_event() will never
109 * be run in parallel with this function for the same wakeup source object.
110 */
111 void wakeup_source_drop(struct wakeup_source *ws)
112 {
113 if (!ws)
114 return;
115
116 del_timer_sync(&ws->timer);
117 __pm_relax(ws);
118 }
119 EXPORT_SYMBOL_GPL(wakeup_source_drop);
120
121 /*
122 * Record wakeup_source statistics being deleted into a dummy wakeup_source.
123 */
124 static void wakeup_source_record(struct wakeup_source *ws)
125 {
126 unsigned long flags;
127
128 spin_lock_irqsave(&deleted_ws.lock, flags);
129
130 if (ws->event_count) {
131 deleted_ws.total_time =
132 ktime_add(deleted_ws.total_time, ws->total_time);
133 deleted_ws.prevent_sleep_time =
134 ktime_add(deleted_ws.prevent_sleep_time,
135 ws->prevent_sleep_time);
136 deleted_ws.max_time =
137 ktime_compare(deleted_ws.max_time, ws->max_time) > 0 ?
138 deleted_ws.max_time : ws->max_time;
139 deleted_ws.event_count += ws->event_count;
140 deleted_ws.active_count += ws->active_count;
141 deleted_ws.relax_count += ws->relax_count;
142 deleted_ws.expire_count += ws->expire_count;
143 deleted_ws.wakeup_count += ws->wakeup_count;
144 }
145
146 spin_unlock_irqrestore(&deleted_ws.lock, flags);
147 }
148
149 /**
150 * wakeup_source_destroy - Destroy a struct wakeup_source object.
151 * @ws: Wakeup source to destroy.
152 *
153 * Use only for wakeup source objects created with wakeup_source_create().
154 */
155 void wakeup_source_destroy(struct wakeup_source *ws)
156 {
157 if (!ws)
158 return;
159
160 wakeup_source_drop(ws);
161 wakeup_source_record(ws);
162 kfree_const(ws->name);
163 kfree(ws);
164 }
165 EXPORT_SYMBOL_GPL(wakeup_source_destroy);
166
167 /**
168 * wakeup_source_add - Add given object to the list of wakeup sources.
169 * @ws: Wakeup source object to add to the list.
170 */
171 void wakeup_source_add(struct wakeup_source *ws)
172 {
173 unsigned long flags;
174
175 if (WARN_ON(!ws))
176 return;
177
178 spin_lock_init(&ws->lock);
179 setup_timer(&ws->timer, pm_wakeup_timer_fn, (unsigned long)ws);
180 ws->active = false;
181 ws->last_time = ktime_get();
182
183 spin_lock_irqsave(&events_lock, flags);
184 list_add_rcu(&ws->entry, &wakeup_sources);
185 spin_unlock_irqrestore(&events_lock, flags);
186 }
187 EXPORT_SYMBOL_GPL(wakeup_source_add);
188
189 /**
190 * wakeup_source_remove - Remove given object from the wakeup sources list.
191 * @ws: Wakeup source object to remove from the list.
192 */
193 void wakeup_source_remove(struct wakeup_source *ws)
194 {
195 unsigned long flags;
196
197 if (WARN_ON(!ws))
198 return;
199
200 spin_lock_irqsave(&events_lock, flags);
201 list_del_rcu(&ws->entry);
202 spin_unlock_irqrestore(&events_lock, flags);
203 synchronize_srcu(&wakeup_srcu);
204 }
205 EXPORT_SYMBOL_GPL(wakeup_source_remove);
206
207 /**
208 * wakeup_source_register - Create wakeup source and add it to the list.
209 * @name: Name of the wakeup source to register.
210 */
211 struct wakeup_source *wakeup_source_register(const char *name)
212 {
213 struct wakeup_source *ws;
214
215 ws = wakeup_source_create(name);
216 if (ws)
217 wakeup_source_add(ws);
218
219 return ws;
220 }
221 EXPORT_SYMBOL_GPL(wakeup_source_register);
222
223 /**
224 * wakeup_source_unregister - Remove wakeup source from the list and remove it.
225 * @ws: Wakeup source object to unregister.
226 */
227 void wakeup_source_unregister(struct wakeup_source *ws)
228 {
229 if (ws) {
230 wakeup_source_remove(ws);
231 wakeup_source_destroy(ws);
232 }
233 }
234 EXPORT_SYMBOL_GPL(wakeup_source_unregister);
235
236 /**
237 * device_wakeup_attach - Attach a wakeup source object to a device object.
238 * @dev: Device to handle.
239 * @ws: Wakeup source object to attach to @dev.
240 *
241 * This causes @dev to be treated as a wakeup device.
242 */
243 static int device_wakeup_attach(struct device *dev, struct wakeup_source *ws)
244 {
245 spin_lock_irq(&dev->power.lock);
246 if (dev->power.wakeup) {
247 spin_unlock_irq(&dev->power.lock);
248 return -EEXIST;
249 }
250 dev->power.wakeup = ws;
251 if (dev->power.wakeirq)
252 device_wakeup_attach_irq(dev, dev->power.wakeirq);
253 spin_unlock_irq(&dev->power.lock);
254 return 0;
255 }
256
257 /**
258 * device_wakeup_enable - Enable given device to be a wakeup source.
259 * @dev: Device to handle.
260 *
261 * Create a wakeup source object, register it and attach it to @dev.
262 */
263 int device_wakeup_enable(struct device *dev)
264 {
265 struct wakeup_source *ws;
266 int ret;
267
268 if (!dev || !dev->power.can_wakeup)
269 return -EINVAL;
270
271 ws = wakeup_source_register(dev_name(dev));
272 if (!ws)
273 return -ENOMEM;
274
275 ret = device_wakeup_attach(dev, ws);
276 if (ret)
277 wakeup_source_unregister(ws);
278
279 return ret;
280 }
281 EXPORT_SYMBOL_GPL(device_wakeup_enable);
282
283 /**
284 * device_wakeup_attach_irq - Attach a wakeirq to a wakeup source
285 * @dev: Device to handle
286 * @wakeirq: Device specific wakeirq entry
287 *
288 * Attach a device wakeirq to the wakeup source so the device
289 * wake IRQ can be configured automatically for suspend and
290 * resume.
291 *
292 * Call under the device's power.lock lock.
293 */
294 int device_wakeup_attach_irq(struct device *dev,
295 struct wake_irq *wakeirq)
296 {
297 struct wakeup_source *ws;
298
299 ws = dev->power.wakeup;
300 if (!ws) {
301 dev_err(dev, "forgot to call call device_init_wakeup?\n");
302 return -EINVAL;
303 }
304
305 if (ws->wakeirq)
306 return -EEXIST;
307
308 ws->wakeirq = wakeirq;
309 return 0;
310 }
311
312 /**
313 * device_wakeup_detach_irq - Detach a wakeirq from a wakeup source
314 * @dev: Device to handle
315 *
316 * Removes a device wakeirq from the wakeup source.
317 *
318 * Call under the device's power.lock lock.
319 */
320 void device_wakeup_detach_irq(struct device *dev)
321 {
322 struct wakeup_source *ws;
323
324 ws = dev->power.wakeup;
325 if (ws)
326 ws->wakeirq = NULL;
327 }
328
329 /**
330 * device_wakeup_arm_wake_irqs(void)
331 *
332 * Itereates over the list of device wakeirqs to arm them.
333 */
334 void device_wakeup_arm_wake_irqs(void)
335 {
336 struct wakeup_source *ws;
337 int srcuidx;
338
339 srcuidx = srcu_read_lock(&wakeup_srcu);
340 list_for_each_entry_rcu(ws, &wakeup_sources, entry)
341 dev_pm_arm_wake_irq(ws->wakeirq);
342 srcu_read_unlock(&wakeup_srcu, srcuidx);
343 }
344
345 /**
346 * device_wakeup_disarm_wake_irqs(void)
347 *
348 * Itereates over the list of device wakeirqs to disarm them.
349 */
350 void device_wakeup_disarm_wake_irqs(void)
351 {
352 struct wakeup_source *ws;
353 int srcuidx;
354
355 srcuidx = srcu_read_lock(&wakeup_srcu);
356 list_for_each_entry_rcu(ws, &wakeup_sources, entry)
357 dev_pm_disarm_wake_irq(ws->wakeirq);
358 srcu_read_unlock(&wakeup_srcu, srcuidx);
359 }
360
361 /**
362 * device_wakeup_detach - Detach a device's wakeup source object from it.
363 * @dev: Device to detach the wakeup source object from.
364 *
365 * After it returns, @dev will not be treated as a wakeup device any more.
366 */
367 static struct wakeup_source *device_wakeup_detach(struct device *dev)
368 {
369 struct wakeup_source *ws;
370
371 spin_lock_irq(&dev->power.lock);
372 ws = dev->power.wakeup;
373 dev->power.wakeup = NULL;
374 spin_unlock_irq(&dev->power.lock);
375 return ws;
376 }
377
378 /**
379 * device_wakeup_disable - Do not regard a device as a wakeup source any more.
380 * @dev: Device to handle.
381 *
382 * Detach the @dev's wakeup source object from it, unregister this wakeup source
383 * object and destroy it.
384 */
385 int device_wakeup_disable(struct device *dev)
386 {
387 struct wakeup_source *ws;
388
389 if (!dev || !dev->power.can_wakeup)
390 return -EINVAL;
391
392 ws = device_wakeup_detach(dev);
393 wakeup_source_unregister(ws);
394 return 0;
395 }
396 EXPORT_SYMBOL_GPL(device_wakeup_disable);
397
398 /**
399 * device_set_wakeup_capable - Set/reset device wakeup capability flag.
400 * @dev: Device to handle.
401 * @capable: Whether or not @dev is capable of waking up the system from sleep.
402 *
403 * If @capable is set, set the @dev's power.can_wakeup flag and add its
404 * wakeup-related attributes to sysfs. Otherwise, unset the @dev's
405 * power.can_wakeup flag and remove its wakeup-related attributes from sysfs.
406 *
407 * This function may sleep and it can't be called from any context where
408 * sleeping is not allowed.
409 */
410 void device_set_wakeup_capable(struct device *dev, bool capable)
411 {
412 if (!!dev->power.can_wakeup == !!capable)
413 return;
414
415 dev->power.can_wakeup = capable;
416 if (device_is_registered(dev) && !list_empty(&dev->power.entry)) {
417 if (capable) {
418 int ret = wakeup_sysfs_add(dev);
419
420 if (ret)
421 dev_info(dev, "Wakeup sysfs attributes not added\n");
422 } else {
423 wakeup_sysfs_remove(dev);
424 }
425 }
426 }
427 EXPORT_SYMBOL_GPL(device_set_wakeup_capable);
428
429 /**
430 * device_init_wakeup - Device wakeup initialization.
431 * @dev: Device to handle.
432 * @enable: Whether or not to enable @dev as a wakeup device.
433 *
434 * By default, most devices should leave wakeup disabled. The exceptions are
435 * devices that everyone expects to be wakeup sources: keyboards, power buttons,
436 * possibly network interfaces, etc. Also, devices that don't generate their
437 * own wakeup requests but merely forward requests from one bus to another
438 * (like PCI bridges) should have wakeup enabled by default.
439 */
440 int device_init_wakeup(struct device *dev, bool enable)
441 {
442 int ret = 0;
443
444 if (!dev)
445 return -EINVAL;
446
447 if (enable) {
448 device_set_wakeup_capable(dev, true);
449 ret = device_wakeup_enable(dev);
450 } else {
451 if (dev->power.can_wakeup)
452 device_wakeup_disable(dev);
453
454 device_set_wakeup_capable(dev, false);
455 }
456
457 return ret;
458 }
459 EXPORT_SYMBOL_GPL(device_init_wakeup);
460
461 /**
462 * device_set_wakeup_enable - Enable or disable a device to wake up the system.
463 * @dev: Device to handle.
464 */
465 int device_set_wakeup_enable(struct device *dev, bool enable)
466 {
467 if (!dev || !dev->power.can_wakeup)
468 return -EINVAL;
469
470 return enable ? device_wakeup_enable(dev) : device_wakeup_disable(dev);
471 }
472 EXPORT_SYMBOL_GPL(device_set_wakeup_enable);
473
474 /**
475 * wakeup_source_not_registered - validate the given wakeup source.
476 * @ws: Wakeup source to be validated.
477 */
478 static bool wakeup_source_not_registered(struct wakeup_source *ws)
479 {
480 /*
481 * Use timer struct to check if the given source is initialized
482 * by wakeup_source_add.
483 */
484 return ws->timer.function != pm_wakeup_timer_fn ||
485 ws->timer.data != (unsigned long)ws;
486 }
487
488 /*
489 * The functions below use the observation that each wakeup event starts a
490 * period in which the system should not be suspended. The moment this period
491 * will end depends on how the wakeup event is going to be processed after being
492 * detected and all of the possible cases can be divided into two distinct
493 * groups.
494 *
495 * First, a wakeup event may be detected by the same functional unit that will
496 * carry out the entire processing of it and possibly will pass it to user space
497 * for further processing. In that case the functional unit that has detected
498 * the event may later "close" the "no suspend" period associated with it
499 * directly as soon as it has been dealt with. The pair of pm_stay_awake() and
500 * pm_relax(), balanced with each other, is supposed to be used in such
501 * situations.
502 *
503 * Second, a wakeup event may be detected by one functional unit and processed
504 * by another one. In that case the unit that has detected it cannot really
505 * "close" the "no suspend" period associated with it, unless it knows in
506 * advance what's going to happen to the event during processing. This
507 * knowledge, however, may not be available to it, so it can simply specify time
508 * to wait before the system can be suspended and pass it as the second
509 * argument of pm_wakeup_event().
510 *
511 * It is valid to call pm_relax() after pm_wakeup_event(), in which case the
512 * "no suspend" period will be ended either by the pm_relax(), or by the timer
513 * function executed when the timer expires, whichever comes first.
514 */
515
516 /**
517 * wakup_source_activate - Mark given wakeup source as active.
518 * @ws: Wakeup source to handle.
519 *
520 * Update the @ws' statistics and, if @ws has just been activated, notify the PM
521 * core of the event by incrementing the counter of of wakeup events being
522 * processed.
523 */
524 static void wakeup_source_activate(struct wakeup_source *ws)
525 {
526 unsigned int cec;
527
528 if (WARN_ONCE(wakeup_source_not_registered(ws),
529 "unregistered wakeup source\n"))
530 return;
531
532 ws->active = true;
533 ws->active_count++;
534 ws->last_time = ktime_get();
535 if (ws->autosleep_enabled)
536 ws->start_prevent_time = ws->last_time;
537
538 /* Increment the counter of events in progress. */
539 cec = atomic_inc_return(&combined_event_count);
540
541 trace_wakeup_source_activate(ws->name, cec);
542 }
543
544 /**
545 * wakeup_source_report_event - Report wakeup event using the given source.
546 * @ws: Wakeup source to report the event for.
547 * @hard: If set, abort suspends in progress and wake up from suspend-to-idle.
548 */
549 static void wakeup_source_report_event(struct wakeup_source *ws, bool hard)
550 {
551 ws->event_count++;
552 /* This is racy, but the counter is approximate anyway. */
553 if (events_check_enabled)
554 ws->wakeup_count++;
555
556 if (!ws->active)
557 wakeup_source_activate(ws);
558
559 if (hard)
560 pm_system_wakeup();
561 }
562
563 /**
564 * __pm_stay_awake - Notify the PM core of a wakeup event.
565 * @ws: Wakeup source object associated with the source of the event.
566 *
567 * It is safe to call this function from interrupt context.
568 */
569 void __pm_stay_awake(struct wakeup_source *ws)
570 {
571 unsigned long flags;
572
573 if (!ws)
574 return;
575
576 spin_lock_irqsave(&ws->lock, flags);
577
578 wakeup_source_report_event(ws, false);
579 del_timer(&ws->timer);
580 ws->timer_expires = 0;
581
582 spin_unlock_irqrestore(&ws->lock, flags);
583 }
584 EXPORT_SYMBOL_GPL(__pm_stay_awake);
585
586 /**
587 * pm_stay_awake - Notify the PM core that a wakeup event is being processed.
588 * @dev: Device the wakeup event is related to.
589 *
590 * Notify the PM core of a wakeup event (signaled by @dev) by calling
591 * __pm_stay_awake for the @dev's wakeup source object.
592 *
593 * Call this function after detecting of a wakeup event if pm_relax() is going
594 * to be called directly after processing the event (and possibly passing it to
595 * user space for further processing).
596 */
597 void pm_stay_awake(struct device *dev)
598 {
599 unsigned long flags;
600
601 if (!dev)
602 return;
603
604 spin_lock_irqsave(&dev->power.lock, flags);
605 __pm_stay_awake(dev->power.wakeup);
606 spin_unlock_irqrestore(&dev->power.lock, flags);
607 }
608 EXPORT_SYMBOL_GPL(pm_stay_awake);
609
610 #ifdef CONFIG_PM_AUTOSLEEP
611 static void update_prevent_sleep_time(struct wakeup_source *ws, ktime_t now)
612 {
613 ktime_t delta = ktime_sub(now, ws->start_prevent_time);
614 ws->prevent_sleep_time = ktime_add(ws->prevent_sleep_time, delta);
615 }
616 #else
617 static inline void update_prevent_sleep_time(struct wakeup_source *ws,
618 ktime_t now) {}
619 #endif
620
621 /**
622 * wakup_source_deactivate - Mark given wakeup source as inactive.
623 * @ws: Wakeup source to handle.
624 *
625 * Update the @ws' statistics and notify the PM core that the wakeup source has
626 * become inactive by decrementing the counter of wakeup events being processed
627 * and incrementing the counter of registered wakeup events.
628 */
629 static void wakeup_source_deactivate(struct wakeup_source *ws)
630 {
631 unsigned int cnt, inpr, cec;
632 ktime_t duration;
633 ktime_t now;
634
635 ws->relax_count++;
636 /*
637 * __pm_relax() may be called directly or from a timer function.
638 * If it is called directly right after the timer function has been
639 * started, but before the timer function calls __pm_relax(), it is
640 * possible that __pm_stay_awake() will be called in the meantime and
641 * will set ws->active. Then, ws->active may be cleared immediately
642 * by the __pm_relax() called from the timer function, but in such a
643 * case ws->relax_count will be different from ws->active_count.
644 */
645 if (ws->relax_count != ws->active_count) {
646 ws->relax_count--;
647 return;
648 }
649
650 ws->active = false;
651
652 now = ktime_get();
653 duration = ktime_sub(now, ws->last_time);
654 ws->total_time = ktime_add(ws->total_time, duration);
655 if (ktime_to_ns(duration) > ktime_to_ns(ws->max_time))
656 ws->max_time = duration;
657
658 ws->last_time = now;
659 del_timer(&ws->timer);
660 ws->timer_expires = 0;
661
662 if (ws->autosleep_enabled)
663 update_prevent_sleep_time(ws, now);
664
665 /*
666 * Increment the counter of registered wakeup events and decrement the
667 * couter of wakeup events in progress simultaneously.
668 */
669 cec = atomic_add_return(MAX_IN_PROGRESS, &combined_event_count);
670 trace_wakeup_source_deactivate(ws->name, cec);
671
672 split_counters(&cnt, &inpr);
673 if (!inpr && waitqueue_active(&wakeup_count_wait_queue))
674 wake_up(&wakeup_count_wait_queue);
675 }
676
677 /**
678 * __pm_relax - Notify the PM core that processing of a wakeup event has ended.
679 * @ws: Wakeup source object associated with the source of the event.
680 *
681 * Call this function for wakeup events whose processing started with calling
682 * __pm_stay_awake().
683 *
684 * It is safe to call it from interrupt context.
685 */
686 void __pm_relax(struct wakeup_source *ws)
687 {
688 unsigned long flags;
689
690 if (!ws)
691 return;
692
693 spin_lock_irqsave(&ws->lock, flags);
694 if (ws->active)
695 wakeup_source_deactivate(ws);
696 spin_unlock_irqrestore(&ws->lock, flags);
697 }
698 EXPORT_SYMBOL_GPL(__pm_relax);
699
700 /**
701 * pm_relax - Notify the PM core that processing of a wakeup event has ended.
702 * @dev: Device that signaled the event.
703 *
704 * Execute __pm_relax() for the @dev's wakeup source object.
705 */
706 void pm_relax(struct device *dev)
707 {
708 unsigned long flags;
709
710 if (!dev)
711 return;
712
713 spin_lock_irqsave(&dev->power.lock, flags);
714 __pm_relax(dev->power.wakeup);
715 spin_unlock_irqrestore(&dev->power.lock, flags);
716 }
717 EXPORT_SYMBOL_GPL(pm_relax);
718
719 /**
720 * pm_wakeup_timer_fn - Delayed finalization of a wakeup event.
721 * @data: Address of the wakeup source object associated with the event source.
722 *
723 * Call wakeup_source_deactivate() for the wakeup source whose address is stored
724 * in @data if it is currently active and its timer has not been canceled and
725 * the expiration time of the timer is not in future.
726 */
727 static void pm_wakeup_timer_fn(unsigned long data)
728 {
729 struct wakeup_source *ws = (struct wakeup_source *)data;
730 unsigned long flags;
731
732 spin_lock_irqsave(&ws->lock, flags);
733
734 if (ws->active && ws->timer_expires
735 && time_after_eq(jiffies, ws->timer_expires)) {
736 wakeup_source_deactivate(ws);
737 ws->expire_count++;
738 }
739
740 spin_unlock_irqrestore(&ws->lock, flags);
741 }
742
743 /**
744 * pm_wakeup_ws_event - Notify the PM core of a wakeup event.
745 * @ws: Wakeup source object associated with the event source.
746 * @msec: Anticipated event processing time (in milliseconds).
747 * @hard: If set, abort suspends in progress and wake up from suspend-to-idle.
748 *
749 * Notify the PM core of a wakeup event whose source is @ws that will take
750 * approximately @msec milliseconds to be processed by the kernel. If @ws is
751 * not active, activate it. If @msec is nonzero, set up the @ws' timer to
752 * execute pm_wakeup_timer_fn() in future.
753 *
754 * It is safe to call this function from interrupt context.
755 */
756 void pm_wakeup_ws_event(struct wakeup_source *ws, unsigned int msec, bool hard)
757 {
758 unsigned long flags;
759 unsigned long expires;
760
761 if (!ws)
762 return;
763
764 spin_lock_irqsave(&ws->lock, flags);
765
766 wakeup_source_report_event(ws, hard);
767
768 if (!msec) {
769 wakeup_source_deactivate(ws);
770 goto unlock;
771 }
772
773 expires = jiffies + msecs_to_jiffies(msec);
774 if (!expires)
775 expires = 1;
776
777 if (!ws->timer_expires || time_after(expires, ws->timer_expires)) {
778 mod_timer(&ws->timer, expires);
779 ws->timer_expires = expires;
780 }
781
782 unlock:
783 spin_unlock_irqrestore(&ws->lock, flags);
784 }
785 EXPORT_SYMBOL_GPL(pm_wakeup_ws_event);
786
787 /**
788 * pm_wakeup_event - Notify the PM core of a wakeup event.
789 * @dev: Device the wakeup event is related to.
790 * @msec: Anticipated event processing time (in milliseconds).
791 * @hard: If set, abort suspends in progress and wake up from suspend-to-idle.
792 *
793 * Call pm_wakeup_ws_event() for the @dev's wakeup source object.
794 */
795 void pm_wakeup_dev_event(struct device *dev, unsigned int msec, bool hard)
796 {
797 unsigned long flags;
798
799 if (!dev)
800 return;
801
802 spin_lock_irqsave(&dev->power.lock, flags);
803 pm_wakeup_ws_event(dev->power.wakeup, msec, hard);
804 spin_unlock_irqrestore(&dev->power.lock, flags);
805 }
806 EXPORT_SYMBOL_GPL(pm_wakeup_dev_event);
807
808 void pm_print_active_wakeup_sources(void)
809 {
810 struct wakeup_source *ws;
811 int srcuidx, active = 0;
812 struct wakeup_source *last_activity_ws = NULL;
813
814 srcuidx = srcu_read_lock(&wakeup_srcu);
815 list_for_each_entry_rcu(ws, &wakeup_sources, entry) {
816 if (ws->active) {
817 pr_debug("active wakeup source: %s\n", ws->name);
818 active = 1;
819 } else if (!active &&
820 (!last_activity_ws ||
821 ktime_to_ns(ws->last_time) >
822 ktime_to_ns(last_activity_ws->last_time))) {
823 last_activity_ws = ws;
824 }
825 }
826
827 if (!active && last_activity_ws)
828 pr_debug("last active wakeup source: %s\n",
829 last_activity_ws->name);
830 srcu_read_unlock(&wakeup_srcu, srcuidx);
831 }
832 EXPORT_SYMBOL_GPL(pm_print_active_wakeup_sources);
833
834 /**
835 * pm_wakeup_pending - Check if power transition in progress should be aborted.
836 *
837 * Compare the current number of registered wakeup events with its preserved
838 * value from the past and return true if new wakeup events have been registered
839 * since the old value was stored. Also return true if the current number of
840 * wakeup events being processed is different from zero.
841 */
842 bool pm_wakeup_pending(void)
843 {
844 unsigned long flags;
845 bool ret = false;
846
847 spin_lock_irqsave(&events_lock, flags);
848 if (events_check_enabled) {
849 unsigned int cnt, inpr;
850
851 split_counters(&cnt, &inpr);
852 ret = (cnt != saved_count || inpr > 0);
853 events_check_enabled = !ret;
854 }
855 spin_unlock_irqrestore(&events_lock, flags);
856
857 if (ret) {
858 pr_info("PM: Wakeup pending, aborting suspend\n");
859 pm_print_active_wakeup_sources();
860 }
861
862 return ret || atomic_read(&pm_abort_suspend) > 0;
863 }
864
865 void pm_system_wakeup(void)
866 {
867 atomic_inc(&pm_abort_suspend);
868 s2idle_wake();
869 }
870 EXPORT_SYMBOL_GPL(pm_system_wakeup);
871
872 void pm_system_cancel_wakeup(void)
873 {
874 atomic_dec(&pm_abort_suspend);
875 }
876
877 void pm_wakeup_clear(bool reset)
878 {
879 pm_wakeup_irq = 0;
880 if (reset)
881 atomic_set(&pm_abort_suspend, 0);
882 }
883
884 void pm_system_irq_wakeup(unsigned int irq_number)
885 {
886 if (pm_wakeup_irq == 0) {
887 pm_wakeup_irq = irq_number;
888 pm_system_wakeup();
889 }
890 }
891
892 /**
893 * pm_get_wakeup_count - Read the number of registered wakeup events.
894 * @count: Address to store the value at.
895 * @block: Whether or not to block.
896 *
897 * Store the number of registered wakeup events at the address in @count. If
898 * @block is set, block until the current number of wakeup events being
899 * processed is zero.
900 *
901 * Return 'false' if the current number of wakeup events being processed is
902 * nonzero. Otherwise return 'true'.
903 */
904 bool pm_get_wakeup_count(unsigned int *count, bool block)
905 {
906 unsigned int cnt, inpr;
907
908 if (block) {
909 DEFINE_WAIT(wait);
910
911 for (;;) {
912 prepare_to_wait(&wakeup_count_wait_queue, &wait,
913 TASK_INTERRUPTIBLE);
914 split_counters(&cnt, &inpr);
915 if (inpr == 0 || signal_pending(current))
916 break;
917 pm_print_active_wakeup_sources();
918 schedule();
919 }
920 finish_wait(&wakeup_count_wait_queue, &wait);
921 }
922
923 split_counters(&cnt, &inpr);
924 *count = cnt;
925 return !inpr;
926 }
927
928 /**
929 * pm_save_wakeup_count - Save the current number of registered wakeup events.
930 * @count: Value to compare with the current number of registered wakeup events.
931 *
932 * If @count is equal to the current number of registered wakeup events and the
933 * current number of wakeup events being processed is zero, store @count as the
934 * old number of registered wakeup events for pm_check_wakeup_events(), enable
935 * wakeup events detection and return 'true'. Otherwise disable wakeup events
936 * detection and return 'false'.
937 */
938 bool pm_save_wakeup_count(unsigned int count)
939 {
940 unsigned int cnt, inpr;
941 unsigned long flags;
942
943 events_check_enabled = false;
944 spin_lock_irqsave(&events_lock, flags);
945 split_counters(&cnt, &inpr);
946 if (cnt == count && inpr == 0) {
947 saved_count = count;
948 events_check_enabled = true;
949 }
950 spin_unlock_irqrestore(&events_lock, flags);
951 return events_check_enabled;
952 }
953
954 #ifdef CONFIG_PM_AUTOSLEEP
955 /**
956 * pm_wakep_autosleep_enabled - Modify autosleep_enabled for all wakeup sources.
957 * @enabled: Whether to set or to clear the autosleep_enabled flags.
958 */
959 void pm_wakep_autosleep_enabled(bool set)
960 {
961 struct wakeup_source *ws;
962 ktime_t now = ktime_get();
963 int srcuidx;
964
965 srcuidx = srcu_read_lock(&wakeup_srcu);
966 list_for_each_entry_rcu(ws, &wakeup_sources, entry) {
967 spin_lock_irq(&ws->lock);
968 if (ws->autosleep_enabled != set) {
969 ws->autosleep_enabled = set;
970 if (ws->active) {
971 if (set)
972 ws->start_prevent_time = now;
973 else
974 update_prevent_sleep_time(ws, now);
975 }
976 }
977 spin_unlock_irq(&ws->lock);
978 }
979 srcu_read_unlock(&wakeup_srcu, srcuidx);
980 }
981 #endif /* CONFIG_PM_AUTOSLEEP */
982
983 static struct dentry *wakeup_sources_stats_dentry;
984
985 /**
986 * print_wakeup_source_stats - Print wakeup source statistics information.
987 * @m: seq_file to print the statistics into.
988 * @ws: Wakeup source object to print the statistics for.
989 */
990 static int print_wakeup_source_stats(struct seq_file *m,
991 struct wakeup_source *ws)
992 {
993 unsigned long flags;
994 ktime_t total_time;
995 ktime_t max_time;
996 unsigned long active_count;
997 ktime_t active_time;
998 ktime_t prevent_sleep_time;
999
1000 spin_lock_irqsave(&ws->lock, flags);
1001
1002 total_time = ws->total_time;
1003 max_time = ws->max_time;
1004 prevent_sleep_time = ws->prevent_sleep_time;
1005 active_count = ws->active_count;
1006 if (ws->active) {
1007 ktime_t now = ktime_get();
1008
1009 active_time = ktime_sub(now, ws->last_time);
1010 total_time = ktime_add(total_time, active_time);
1011 if (active_time > max_time)
1012 max_time = active_time;
1013
1014 if (ws->autosleep_enabled)
1015 prevent_sleep_time = ktime_add(prevent_sleep_time,
1016 ktime_sub(now, ws->start_prevent_time));
1017 } else {
1018 active_time = 0;
1019 }
1020
1021 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",
1022 ws->name, active_count, ws->event_count,
1023 ws->wakeup_count, ws->expire_count,
1024 ktime_to_ms(active_time), ktime_to_ms(total_time),
1025 ktime_to_ms(max_time), ktime_to_ms(ws->last_time),
1026 ktime_to_ms(prevent_sleep_time));
1027
1028 spin_unlock_irqrestore(&ws->lock, flags);
1029
1030 return 0;
1031 }
1032
1033 /**
1034 * wakeup_sources_stats_show - Print wakeup sources statistics information.
1035 * @m: seq_file to print the statistics into.
1036 */
1037 static int wakeup_sources_stats_show(struct seq_file *m, void *unused)
1038 {
1039 struct wakeup_source *ws;
1040 int srcuidx;
1041
1042 seq_puts(m, "name\t\tactive_count\tevent_count\twakeup_count\t"
1043 "expire_count\tactive_since\ttotal_time\tmax_time\t"
1044 "last_change\tprevent_suspend_time\n");
1045
1046 srcuidx = srcu_read_lock(&wakeup_srcu);
1047 list_for_each_entry_rcu(ws, &wakeup_sources, entry)
1048 print_wakeup_source_stats(m, ws);
1049 srcu_read_unlock(&wakeup_srcu, srcuidx);
1050
1051 print_wakeup_source_stats(m, &deleted_ws);
1052
1053 return 0;
1054 }
1055
1056 static int wakeup_sources_stats_open(struct inode *inode, struct file *file)
1057 {
1058 return single_open(file, wakeup_sources_stats_show, NULL);
1059 }
1060
1061 static const struct file_operations wakeup_sources_stats_fops = {
1062 .owner = THIS_MODULE,
1063 .open = wakeup_sources_stats_open,
1064 .read = seq_read,
1065 .llseek = seq_lseek,
1066 .release = single_release,
1067 };
1068
1069 static int __init wakeup_sources_debugfs_init(void)
1070 {
1071 wakeup_sources_stats_dentry = debugfs_create_file("wakeup_sources",
1072 S_IRUGO, NULL, NULL, &wakeup_sources_stats_fops);
1073 return 0;
1074 }
1075
1076 postcore_initcall(wakeup_sources_debugfs_init);