linux/drivers/base/power/wakeup.c
<<
>>
Prefs
   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#ifndef CONFIG_SUSPEND
  23suspend_state_t pm_suspend_target_state;
  24#define pm_suspend_target_state (PM_SUSPEND_ON)
  25#endif
  26
  27/*
  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.
  30 */
  31bool events_check_enabled __read_mostly;
  32
  33/* First wakeup IRQ seen by the kernel in the last cycle. */
  34unsigned int pm_wakeup_irq __read_mostly;
  35
  36/* If greater than 0 and the system is suspending, terminate the suspend. */
  37static atomic_t pm_abort_suspend __read_mostly;
  38
  39/*
  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.
  43 */
  44static atomic_t combined_event_count = ATOMIC_INIT(0);
  45
  46#define IN_PROGRESS_BITS        (sizeof(int) * 4)
  47#define MAX_IN_PROGRESS         ((1 << IN_PROGRESS_BITS) - 1)
  48
  49static void split_counters(unsigned int *cnt, unsigned int *inpr)
  50{
  51        unsigned int comb = atomic_read(&combined_event_count);
  52
  53        *cnt = (comb >> IN_PROGRESS_BITS);
  54        *inpr = comb & MAX_IN_PROGRESS;
  55}
  56
  57/* A preserved old value of the events counter. */
  58static unsigned int saved_count;
  59
  60static DEFINE_SPINLOCK(events_lock);
  61
  62static void pm_wakeup_timer_fn(struct timer_list *t);
  63
  64static LIST_HEAD(wakeup_sources);
  65
  66static DECLARE_WAIT_QUEUE_HEAD(wakeup_count_wait_queue);
  67
  68DEFINE_STATIC_SRCU(wakeup_srcu);
  69
  70static struct wakeup_source deleted_ws = {
  71        .name = "deleted",
  72        .lock =  __SPIN_LOCK_UNLOCKED(deleted_ws.lock),
  73};
  74
  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.
  79 *
  80 * Callers must ensure that the @name string won't be freed when @ws is still in
  81 * use.
  82 */
  83void wakeup_source_prepare(struct wakeup_source *ws, const char *name)
  84{
  85        if (ws) {
  86                memset(ws, 0, sizeof(*ws));
  87                ws->name = name;
  88        }
  89}
  90EXPORT_SYMBOL_GPL(wakeup_source_prepare);
  91
  92/**
  93 * wakeup_source_create - Create a struct wakeup_source object.
  94 * @name: Name of the new wakeup source.
  95 */
  96struct wakeup_source *wakeup_source_create(const char *name)
  97{
  98        struct wakeup_source *ws;
  99
 100        ws = kmalloc(sizeof(*ws), GFP_KERNEL);
 101        if (!ws)
 102                return NULL;
 103
 104        wakeup_source_prepare(ws, name ? kstrdup_const(name, GFP_KERNEL) : NULL);
 105        return ws;
 106}
 107EXPORT_SYMBOL_GPL(wakeup_source_create);
 108
 109/**
 110 * wakeup_source_drop - Prepare a struct wakeup_source object for destruction.
 111 * @ws: Wakeup source to prepare for destruction.
 112 *
 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.
 115 */
 116void wakeup_source_drop(struct wakeup_source *ws)
 117{
 118        if (!ws)
 119                return;
 120
 121        del_timer_sync(&ws->timer);
 122        __pm_relax(ws);
 123}
 124EXPORT_SYMBOL_GPL(wakeup_source_drop);
 125
 126/*
 127 * Record wakeup_source statistics being deleted into a dummy wakeup_source.
 128 */
 129static void wakeup_source_record(struct wakeup_source *ws)
 130{
 131        unsigned long flags;
 132
 133        spin_lock_irqsave(&deleted_ws.lock, flags);
 134
 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;
 149        }
 150
 151        spin_unlock_irqrestore(&deleted_ws.lock, flags);
 152}
 153
 154/**
 155 * wakeup_source_destroy - Destroy a struct wakeup_source object.
 156 * @ws: Wakeup source to destroy.
 157 *
 158 * Use only for wakeup source objects created with wakeup_source_create().
 159 */
 160void wakeup_source_destroy(struct wakeup_source *ws)
 161{
 162        if (!ws)
 163                return;
 164
 165        wakeup_source_drop(ws);
 166        wakeup_source_record(ws);
 167        kfree_const(ws->name);
 168        kfree(ws);
 169}
 170EXPORT_SYMBOL_GPL(wakeup_source_destroy);
 171
 172/**
 173 * wakeup_source_add - Add given object to the list of wakeup sources.
 174 * @ws: Wakeup source object to add to the list.
 175 */
 176void wakeup_source_add(struct wakeup_source *ws)
 177{
 178        unsigned long flags;
 179
 180        if (WARN_ON(!ws))
 181                return;
 182
 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();
 187
 188        spin_lock_irqsave(&events_lock, flags);
 189        list_add_rcu(&ws->entry, &wakeup_sources);
 190        spin_unlock_irqrestore(&events_lock, flags);
 191}
 192EXPORT_SYMBOL_GPL(wakeup_source_add);
 193
 194/**
 195 * wakeup_source_remove - Remove given object from the wakeup sources list.
 196 * @ws: Wakeup source object to remove from the list.
 197 */
 198void wakeup_source_remove(struct wakeup_source *ws)
 199{
 200        unsigned long flags;
 201
 202        if (WARN_ON(!ws))
 203                return;
 204
 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);
 209}
 210EXPORT_SYMBOL_GPL(wakeup_source_remove);
 211
 212/**
 213 * wakeup_source_register - Create wakeup source and add it to the list.
 214 * @name: Name of the wakeup source to register.
 215 */
 216struct wakeup_source *wakeup_source_register(const char *name)
 217{
 218        struct wakeup_source *ws;
 219
 220        ws = wakeup_source_create(name);
 221        if (ws)
 222                wakeup_source_add(ws);
 223
 224        return ws;
 225}
 226EXPORT_SYMBOL_GPL(wakeup_source_register);
 227
 228/**
 229 * wakeup_source_unregister - Remove wakeup source from the list and remove it.
 230 * @ws: Wakeup source object to unregister.
 231 */
 232void wakeup_source_unregister(struct wakeup_source *ws)
 233{
 234        if (ws) {
 235                wakeup_source_remove(ws);
 236                wakeup_source_destroy(ws);
 237        }
 238}
 239EXPORT_SYMBOL_GPL(wakeup_source_unregister);
 240
 241/**
 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.
 245 *
 246 * This causes @dev to be treated as a wakeup device.
 247 */
 248static int device_wakeup_attach(struct device *dev, struct wakeup_source *ws)
 249{
 250        spin_lock_irq(&dev->power.lock);
 251        if (dev->power.wakeup) {
 252                spin_unlock_irq(&dev->power.lock);
 253                return -EEXIST;
 254        }
 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;
 260}
 261
 262/**
 263 * device_wakeup_enable - Enable given device to be a wakeup source.
 264 * @dev: Device to handle.
 265 *
 266 * Create a wakeup source object, register it and attach it to @dev.
 267 */
 268int device_wakeup_enable(struct device *dev)
 269{
 270        struct wakeup_source *ws;
 271        int ret;
 272
 273        if (!dev || !dev->power.can_wakeup)
 274                return -EINVAL;
 275
 276        if (pm_suspend_target_state != PM_SUSPEND_ON)
 277                dev_dbg(dev, "Suspicious %s() during system transition!\n", __func__);
 278
 279        ws = wakeup_source_register(dev_name(dev));
 280        if (!ws)
 281                return -ENOMEM;
 282
 283        ret = device_wakeup_attach(dev, ws);
 284        if (ret)
 285                wakeup_source_unregister(ws);
 286
 287        return ret;
 288}
 289EXPORT_SYMBOL_GPL(device_wakeup_enable);
 290
 291/**
 292 * device_wakeup_attach_irq - Attach a wakeirq to a wakeup source
 293 * @dev: Device to handle
 294 * @wakeirq: Device specific wakeirq entry
 295 *
 296 * Attach a device wakeirq to the wakeup source so the device
 297 * wake IRQ can be configured automatically for suspend and
 298 * resume.
 299 *
 300 * Call under the device's power.lock lock.
 301 */
 302void device_wakeup_attach_irq(struct device *dev,
 303                             struct wake_irq *wakeirq)
 304{
 305        struct wakeup_source *ws;
 306
 307        ws = dev->power.wakeup;
 308        if (!ws)
 309                return;
 310
 311        if (ws->wakeirq)
 312                dev_err(dev, "Leftover wakeup IRQ found, overriding\n");
 313
 314        ws->wakeirq = wakeirq;
 315}
 316
 317/**
 318 * device_wakeup_detach_irq - Detach a wakeirq from a wakeup source
 319 * @dev: Device to handle
 320 *
 321 * Removes a device wakeirq from the wakeup source.
 322 *
 323 * Call under the device's power.lock lock.
 324 */
 325void device_wakeup_detach_irq(struct device *dev)
 326{
 327        struct wakeup_source *ws;
 328
 329        ws = dev->power.wakeup;
 330        if (ws)
 331                ws->wakeirq = NULL;
 332}
 333
 334/**
 335 * device_wakeup_arm_wake_irqs(void)
 336 *
 337 * Itereates over the list of device wakeirqs to arm them.
 338 */
 339void device_wakeup_arm_wake_irqs(void)
 340{
 341        struct wakeup_source *ws;
 342        int srcuidx;
 343
 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);
 348}
 349
 350/**
 351 * device_wakeup_disarm_wake_irqs(void)
 352 *
 353 * Itereates over the list of device wakeirqs to disarm them.
 354 */
 355void device_wakeup_disarm_wake_irqs(void)
 356{
 357        struct wakeup_source *ws;
 358        int srcuidx;
 359
 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);
 364}
 365
 366/**
 367 * device_wakeup_detach - Detach a device's wakeup source object from it.
 368 * @dev: Device to detach the wakeup source object from.
 369 *
 370 * After it returns, @dev will not be treated as a wakeup device any more.
 371 */
 372static struct wakeup_source *device_wakeup_detach(struct device *dev)
 373{
 374        struct wakeup_source *ws;
 375
 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;
 381}
 382
 383/**
 384 * device_wakeup_disable - Do not regard a device as a wakeup source any more.
 385 * @dev: Device to handle.
 386 *
 387 * Detach the @dev's wakeup source object from it, unregister this wakeup source
 388 * object and destroy it.
 389 */
 390int device_wakeup_disable(struct device *dev)
 391{
 392        struct wakeup_source *ws;
 393
 394        if (!dev || !dev->power.can_wakeup)
 395                return -EINVAL;
 396
 397        ws = device_wakeup_detach(dev);
 398        wakeup_source_unregister(ws);
 399        return 0;
 400}
 401EXPORT_SYMBOL_GPL(device_wakeup_disable);
 402
 403/**
 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.
 407 *
 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.
 411 *
 412 * This function may sleep and it can't be called from any context where
 413 * sleeping is not allowed.
 414 */
 415void device_set_wakeup_capable(struct device *dev, bool capable)
 416{
 417        if (!!dev->power.can_wakeup == !!capable)
 418                return;
 419
 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);
 424
 425                        if (ret)
 426                                dev_info(dev, "Wakeup sysfs attributes not added\n");
 427                } else {
 428                        wakeup_sysfs_remove(dev);
 429                }
 430        }
 431}
 432EXPORT_SYMBOL_GPL(device_set_wakeup_capable);
 433
 434/**
 435 * device_init_wakeup - Device wakeup initialization.
 436 * @dev: Device to handle.
 437 * @enable: Whether or not to enable @dev as a wakeup device.
 438 *
 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.
 444 */
 445int device_init_wakeup(struct device *dev, bool enable)
 446{
 447        int ret = 0;
 448
 449        if (!dev)
 450                return -EINVAL;
 451
 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);
 458        }
 459
 460        return ret;
 461}
 462EXPORT_SYMBOL_GPL(device_init_wakeup);
 463
 464/**
 465 * device_set_wakeup_enable - Enable or disable a device to wake up the system.
 466 * @dev: Device to handle.
 467 */
 468int device_set_wakeup_enable(struct device *dev, bool enable)
 469{
 470        return enable ? device_wakeup_enable(dev) : device_wakeup_disable(dev);
 471}
 472EXPORT_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 */
 478static 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}
 486
 487/*
 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.
 493 *
 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.
 501 *
 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().
 509 *
 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.
 513 */
 514
 515/**
 516 * wakup_source_activate - Mark given wakeup source as active.
 517 * @ws: Wakeup source to handle.
 518 *
 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.
 522 */
 523static void wakeup_source_activate(struct wakeup_source *ws)
 524{
 525        unsigned int cec;
 526
 527        if (WARN_ONCE(wakeup_source_not_registered(ws),
 528                        "unregistered wakeup source\n"))
 529                return;
 530
 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;
 536
 537        /* Increment the counter of events in progress. */
 538        cec = atomic_inc_return(&combined_event_count);
 539
 540        trace_wakeup_source_activate(ws->name, cec);
 541}
 542
 543/**
 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.
 547 */
 548static void wakeup_source_report_event(struct wakeup_source *ws, bool hard)
 549{
 550        ws->event_count++;
 551        /* This is racy, but the counter is approximate anyway. */
 552        if (events_check_enabled)
 553                ws->wakeup_count++;
 554
 555        if (!ws->active)
 556                wakeup_source_activate(ws);
 557
 558        if (hard)
 559                pm_system_wakeup();
 560}
 561
 562/**
 563 * __pm_stay_awake - Notify the PM core of a wakeup event.
 564 * @ws: Wakeup source object associated with the source of the event.
 565 *
 566 * It is safe to call this function from interrupt context.
 567 */
 568void __pm_stay_awake(struct wakeup_source *ws)
 569{
 570        unsigned long flags;
 571
 572        if (!ws)
 573                return;
 574
 575        spin_lock_irqsave(&ws->lock, flags);
 576
 577        wakeup_source_report_event(ws, false);
 578        del_timer(&ws->timer);
 579        ws->timer_expires = 0;
 580
 581        spin_unlock_irqrestore(&ws->lock, flags);
 582}
 583EXPORT_SYMBOL_GPL(__pm_stay_awake);
 584
 585/**
 586 * pm_stay_awake - Notify the PM core that a wakeup event is being processed.
 587 * @dev: Device the wakeup event is related to.
 588 *
 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.
 591 *
 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).
 595 */
 596void pm_stay_awake(struct device *dev)
 597{
 598        unsigned long flags;
 599
 600        if (!dev)
 601                return;
 602
 603        spin_lock_irqsave(&dev->power.lock, flags);
 604        __pm_stay_awake(dev->power.wakeup);
 605        spin_unlock_irqrestore(&dev->power.lock, flags);
 606}
 607EXPORT_SYMBOL_GPL(pm_stay_awake);
 608
 609#ifdef CONFIG_PM_AUTOSLEEP
 610static void update_prevent_sleep_time(struct wakeup_source *ws, ktime_t now)
 611{
 612        ktime_t delta = ktime_sub(now, ws->start_prevent_time);
 613        ws->prevent_sleep_time = ktime_add(ws->prevent_sleep_time, delta);
 614}
 615#else
 616static inline void update_prevent_sleep_time(struct wakeup_source *ws,
 617                                             ktime_t now) {}
 618#endif
 619
 620/**
 621 * wakup_source_deactivate - Mark given wakeup source as inactive.
 622 * @ws: Wakeup source to handle.
 623 *
 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.
 627 */
 628static void wakeup_source_deactivate(struct wakeup_source *ws)
 629{
 630        unsigned int cnt, inpr, cec;
 631        ktime_t duration;
 632        ktime_t now;
 633
 634        ws->relax_count++;
 635        /*
 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.
 643         */
 644        if (ws->relax_count != ws->active_count) {
 645                ws->relax_count--;
 646                return;
 647        }
 648
 649        ws->active = false;
 650
 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;
 656
 657        ws->last_time = now;
 658        del_timer(&ws->timer);
 659        ws->timer_expires = 0;
 660
 661        if (ws->autosleep_enabled)
 662                update_prevent_sleep_time(ws, now);
 663
 664        /*
 665         * Increment the counter of registered wakeup events and decrement the
 666         * couter of wakeup events in progress simultaneously.
 667         */
 668        cec = atomic_add_return(MAX_IN_PROGRESS, &combined_event_count);
 669        trace_wakeup_source_deactivate(ws->name, cec);
 670
 671        split_counters(&cnt, &inpr);
 672        if (!inpr && waitqueue_active(&wakeup_count_wait_queue))
 673                wake_up(&wakeup_count_wait_queue);
 674}
 675
 676/**
 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.
 679 *
 680 * Call this function for wakeup events whose processing started with calling
 681 * __pm_stay_awake().
 682 *
 683 * It is safe to call it from interrupt context.
 684 */
 685void __pm_relax(struct wakeup_source *ws)
 686{
 687        unsigned long flags;
 688
 689        if (!ws)
 690                return;
 691
 692        spin_lock_irqsave(&ws->lock, flags);
 693        if (ws->active)
 694                wakeup_source_deactivate(ws);
 695        spin_unlock_irqrestore(&ws->lock, flags);
 696}
 697EXPORT_SYMBOL_GPL(__pm_relax);
 698
 699/**
 700 * pm_relax - Notify the PM core that processing of a wakeup event has ended.
 701 * @dev: Device that signaled the event.
 702 *
 703 * Execute __pm_relax() for the @dev's wakeup source object.
 704 */
 705void pm_relax(struct device *dev)
 706{
 707        unsigned long flags;
 708
 709        if (!dev)
 710                return;
 711
 712        spin_lock_irqsave(&dev->power.lock, flags);
 713        __pm_relax(dev->power.wakeup);
 714        spin_unlock_irqrestore(&dev->power.lock, flags);
 715}
 716EXPORT_SYMBOL_GPL(pm_relax);
 717
 718/**
 719 * pm_wakeup_timer_fn - Delayed finalization of a wakeup event.
 720 * @data: Address of the wakeup source object associated with the event source.
 721 *
 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.
 725 */
 726static void pm_wakeup_timer_fn(struct timer_list *t)
 727{
 728        struct wakeup_source *ws = from_timer(ws, t, timer);
 729        unsigned long flags;
 730
 731        spin_lock_irqsave(&ws->lock, flags);
 732
 733        if (ws->active && ws->timer_expires
 734            && time_after_eq(jiffies, ws->timer_expires)) {
 735                wakeup_source_deactivate(ws);
 736                ws->expire_count++;
 737        }
 738
 739        spin_unlock_irqrestore(&ws->lock, flags);
 740}
 741
 742/**
 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.
 747 *
 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.
 752 *
 753 * It is safe to call this function from interrupt context.
 754 */
 755void pm_wakeup_ws_event(struct wakeup_source *ws, unsigned int msec, bool hard)
 756{
 757        unsigned long flags;
 758        unsigned long expires;
 759
 760        if (!ws)
 761                return;
 762
 763        spin_lock_irqsave(&ws->lock, flags);
 764
 765        wakeup_source_report_event(ws, hard);
 766
 767        if (!msec) {
 768                wakeup_source_deactivate(ws);
 769                goto unlock;
 770        }
 771
 772        expires = jiffies + msecs_to_jiffies(msec);
 773        if (!expires)
 774                expires = 1;
 775
 776        if (!ws->timer_expires || time_after(expires, ws->timer_expires)) {
 777                mod_timer(&ws->timer, expires);
 778                ws->timer_expires = expires;
 779        }
 780
 781 unlock:
 782        spin_unlock_irqrestore(&ws->lock, flags);
 783}
 784EXPORT_SYMBOL_GPL(pm_wakeup_ws_event);
 785
 786/**
 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.
 791 *
 792 * Call pm_wakeup_ws_event() for the @dev's wakeup source object.
 793 */
 794void pm_wakeup_dev_event(struct device *dev, unsigned int msec, bool hard)
 795{
 796        unsigned long flags;
 797
 798        if (!dev)
 799                return;
 800
 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);
 804}
 805EXPORT_SYMBOL_GPL(pm_wakeup_dev_event);
 806
 807void pm_print_active_wakeup_sources(void)
 808{
 809        struct wakeup_source *ws;
 810        int srcuidx, active = 0;
 811        struct wakeup_source *last_activity_ws = NULL;
 812
 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;
 823                }
 824        }
 825
 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);
 830}
 831EXPORT_SYMBOL_GPL(pm_print_active_wakeup_sources);
 832
 833/**
 834 * pm_wakeup_pending - Check if power transition in progress should be aborted.
 835 *
 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.
 840 */
 841bool pm_wakeup_pending(void)
 842{
 843        unsigned long flags;
 844        bool ret = false;
 845
 846        spin_lock_irqsave(&events_lock, flags);
 847        if (events_check_enabled) {
 848                unsigned int cnt, inpr;
 849
 850                split_counters(&cnt, &inpr);
 851                ret = (cnt != saved_count || inpr > 0);
 852                events_check_enabled = !ret;
 853        }
 854        spin_unlock_irqrestore(&events_lock, flags);
 855
 856        if (ret) {
 857                pr_info("PM: Wakeup pending, aborting suspend\n");
 858                pm_print_active_wakeup_sources();
 859        }
 860
 861        return ret || atomic_read(&pm_abort_suspend) > 0;
 862}
 863
 864void pm_system_wakeup(void)
 865{
 866        atomic_inc(&pm_abort_suspend);
 867        s2idle_wake();
 868}
 869EXPORT_SYMBOL_GPL(pm_system_wakeup);
 870
 871void pm_system_cancel_wakeup(void)
 872{
 873        atomic_dec(&pm_abort_suspend);
 874}
 875
 876void pm_wakeup_clear(bool reset)
 877{
 878        pm_wakeup_irq = 0;
 879        if (reset)
 880                atomic_set(&pm_abort_suspend, 0);
 881}
 882
 883void pm_system_irq_wakeup(unsigned int irq_number)
 884{
 885        if (pm_wakeup_irq == 0) {
 886                pm_wakeup_irq = irq_number;
 887                pm_system_wakeup();
 888        }
 889}
 890
 891/**
 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.
 895 *
 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.
 899 *
 900 * Return 'false' if the current number of wakeup events being processed is
 901 * nonzero.  Otherwise return 'true'.
 902 */
 903bool pm_get_wakeup_count(unsigned int *count, bool block)
 904{
 905        unsigned int cnt, inpr;
 906
 907        if (block) {
 908                DEFINE_WAIT(wait);
 909
 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();
 918                }
 919                finish_wait(&wakeup_count_wait_queue, &wait);
 920        }
 921
 922        split_counters(&cnt, &inpr);
 923        *count = cnt;
 924        return !inpr;
 925}
 926
 927/**
 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.
 930 *
 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'.
 936 */
 937bool pm_save_wakeup_count(unsigned int count)
 938{
 939        unsigned int cnt, inpr;
 940        unsigned long flags;
 941
 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;
 948        }
 949        spin_unlock_irqrestore(&events_lock, flags);
 950        return events_check_enabled;
 951}
 952
 953#ifdef CONFIG_PM_AUTOSLEEP
 954/**
 955 * pm_wakep_autosleep_enabled - Modify autosleep_enabled for all wakeup sources.
 956 * @enabled: Whether to set or to clear the autosleep_enabled flags.
 957 */
 958void pm_wakep_autosleep_enabled(bool set)
 959{
 960        struct wakeup_source *ws;
 961        ktime_t now = ktime_get();
 962        int srcuidx;
 963
 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);
 974                        }
 975                }
 976                spin_unlock_irq(&ws->lock);
 977        }
 978        srcu_read_unlock(&wakeup_srcu, srcuidx);
 979}
 980#endif /* CONFIG_PM_AUTOSLEEP */
 981
 982static struct dentry *wakeup_sources_stats_dentry;
 983
 984/**
 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.
 988 */
 989static int print_wakeup_source_stats(struct seq_file *m,
 990                                     struct wakeup_source *ws)
 991{
 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;
 998
 999        spin_lock_irqsave(&ws->lock, flags);
1000
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();
1007
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;
1012
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;
1018        }
1019
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));
1026
1027        spin_unlock_irqrestore(&ws->lock, flags);
1028
1029        return 0;
1030}
1031
1032/**
1033 * wakeup_sources_stats_show - Print wakeup sources statistics information.
1034 * @m: seq_file to print the statistics into.
1035 */
1036static int wakeup_sources_stats_show(struct seq_file *m, void *unused)
1037{
1038        struct wakeup_source *ws;
1039        int srcuidx;
1040
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");
1044
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);
1049
1050        print_wakeup_source_stats(m, &deleted_ws);
1051
1052        return 0;
1053}
1054
1055static int wakeup_sources_stats_open(struct inode *inode, struct file *file)
1056{
1057        return single_open(file, wakeup_sources_stats_show, NULL);
1058}
1059
1060static 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,
1066};
1067
1068static int __init wakeup_sources_debugfs_init(void)
1069{
1070        wakeup_sources_stats_dentry = debugfs_create_file("wakeup_sources",
1071                        S_IRUGO, NULL, NULL, &wakeup_sources_stats_fops);
1072        return 0;
1073}
1074
1075postcore_initcall(wakeup_sources_debugfs_init);
1076