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