3  * drivers/base/power/wakeup.c - System wakeup events framework
32  * if wakeup events are registered during or immediately before the transition.
36 /* First wakeup IRQ seen by the kernel in the last cycle. */
44  * Combined counters of registered wakeup events and wakeup events in progress.
83  * @name: Name of the new wakeup source.
153  * @ws: Wakeup source to destroy.
155  * Use only for wakeup source objects created with wakeup_source_create().
169  * wakeup_source_add - Add given object to the list of wakeup sources.
170  * @ws: Wakeup source object to add to the list.
190  * wakeup_source_remove - Remove given object from the wakeup sources list.
191  * @ws: Wakeup source object to remove from the list.
208 	 * this wakeup source as not registered.  in wakeup_source_remove()
215  * wakeup_source_register - Create wakeup source and add it to the list.
216  * @dev: Device this wakeup source is associated with (or NULL if virtual).
217  * @name: Name of the wakeup source to register.
241  * wakeup_source_unregister - Remove wakeup source from the list and remove it.
242  * @ws: Wakeup source object to unregister.
257  * wakeup_sources_read_lock - Lock wakeup source list for read.
269  * wakeup_sources_read_unlock - Unlock wakeup source list.
279  * wakeup_sources_walk_start - Begin a walk on wakeup source list
281  * Returns first object of the list of wakeup sources.
283  * Note that to be safe, wakeup sources list needs to be locked by calling
295  * wakeup_sources_walk_next - Get next wakeup source from the list
296  * @ws: Previous wakeup source object
298  * Note that to be safe, wakeup sources list needs to be locked by calling
311  * device_wakeup_attach - Attach a wakeup source object to a device object.
313  * @ws: Wakeup source object to attach to @dev.
315  * This causes @dev to be treated as a wakeup device.
320 	if (dev->power.wakeup) {  in device_wakeup_attach()
324 	dev->power.wakeup = ws;  in device_wakeup_attach()
332  * device_wakeup_enable - Enable given device to be a wakeup source.
335  * Create a wakeup source object, register it and attach it to @dev.
361  * device_wakeup_attach_irq - Attach a wakeirq to a wakeup source
365  * Attach a device wakeirq to the wakeup source so the device
376 	ws = dev->power.wakeup;  in device_wakeup_attach_irq()
381 		dev_err(dev, "Leftover wakeup IRQ found, overriding\n");  in device_wakeup_attach_irq()
387  * device_wakeup_detach_irq - Detach a wakeirq from a wakeup source
390  * Removes a device wakeirq from the wakeup source.
398 	ws = dev->power.wakeup;  in device_wakeup_detach_irq()
436  * device_wakeup_detach - Detach a device's wakeup source object from it.
437  * @dev: Device to detach the wakeup source object from.
439  * After it returns, @dev will not be treated as a wakeup device any more.
446 	ws = dev->power.wakeup;  in device_wakeup_detach()
447 	dev->power.wakeup = NULL;  in device_wakeup_detach()
453  * device_wakeup_disable - Do not regard a device as a wakeup source any more.
456  * Detach the @dev's wakeup source object from it, unregister this wakeup source
473  * device_set_wakeup_capable - Set/reset device wakeup capability flag.
478  * wakeup-related attributes to sysfs.  Otherwise, unset the @dev's
479  * power.can_wakeup flag and remove its wakeup-related attributes from sysfs.
495 				dev_info(dev, "Wakeup sysfs attributes not added\n");  in device_set_wakeup_capable()
504  * device_init_wakeup - Device wakeup initialization.
506  * @enable: Whether or not to enable @dev as a wakeup device.
508  * By default, most devices should leave wakeup disabled.  The exceptions are
509  * devices that everyone expects to be wakeup sources: keyboards, power buttons,
511  * own wakeup requests but merely forward requests from one bus to another
512  * (like PCI bridges) should have wakeup enabled by default.
544  * wakeup_source_not_registered - validate the given wakeup source.
545  * @ws: Wakeup source to be validated.
557  * The functions below use the observation that each wakeup event starts a
559  * will end depends on how the wakeup event is going to be processed after being
563  * First, a wakeup event may be detected by the same functional unit that will
571  * Second, a wakeup event may be detected by one functional unit and processed
585  * wakup_source_activate - Mark given wakeup source as active.
586  * @ws: Wakeup source to handle.
589  * core of the event by incrementing the counter of of wakeup events being
597 			"unregistered wakeup source\n"))  in wakeup_source_activate()
613  * wakeup_source_report_event - Report wakeup event using the given source.
614  * @ws: Wakeup source to report the event for.
632  * __pm_stay_awake - Notify the PM core of a wakeup event.
633  * @ws: Wakeup source object associated with the source of the event.
655  * pm_stay_awake - Notify the PM core that a wakeup event is being processed.
656  * @dev: Device the wakeup event is related to.
658  * Notify the PM core of a wakeup event (signaled by @dev) by calling
659  * __pm_stay_awake for the @dev's wakeup source object.
661  * Call this function after detecting of a wakeup event if pm_relax() is going
673 	__pm_stay_awake(dev->power.wakeup);  in pm_stay_awake()
690  * wakup_source_deactivate - Mark given wakeup source as inactive.
691  * @ws: Wakeup source to handle.
693  * Update the @ws' statistics and notify the PM core that the wakeup source has
694  * become inactive by decrementing the counter of wakeup events being processed
695  * and incrementing the counter of registered wakeup events.
734 	 * Increment the counter of registered wakeup events and decrement the  in wakeup_source_deactivate()
735 	 * couter of wakeup events in progress simultaneously.  in wakeup_source_deactivate()
746  * __pm_relax - Notify the PM core that processing of a wakeup event has ended.
747  * @ws: Wakeup source object associated with the source of the event.
749  * Call this function for wakeup events whose processing started with calling
769  * pm_relax - Notify the PM core that processing of a wakeup event has ended.
772  * Execute __pm_relax() for the @dev's wakeup source object.
782 	__pm_relax(dev->power.wakeup);  in pm_relax()
788  * pm_wakeup_timer_fn - Delayed finalization of a wakeup event.
789  * @data: Address of the wakeup source object associated with the event source.
791  * Call wakeup_source_deactivate() for the wakeup source whose address is stored
812  * pm_wakeup_ws_event - Notify the PM core of a wakeup event.
813  * @ws: Wakeup source object associated with the event source.
817  * Notify the PM core of a wakeup event whose source is @ws that will take
856  * pm_wakeup_dev_event - Notify the PM core of a wakeup event.
857  * @dev: Device the wakeup event is related to.
861  * Call pm_wakeup_ws_event() for the @dev's wakeup source object.
871 	pm_wakeup_ws_event(dev->power.wakeup, msec, hard);  in pm_wakeup_dev_event()
885 			pm_pr_dbg("active wakeup source: %s\n", ws->name);  in pm_print_active_wakeup_sources()
896 		pm_pr_dbg("last active wakeup source: %s\n",  in pm_print_active_wakeup_sources()
905  * Compare the current number of registered wakeup events with its preserved
906  * value from the past and return true if new wakeup events have been registered
908  * wakeup events being processed is different from zero.
926 		pm_pr_dbg("Wakeup pending, aborting suspend\n");  in pm_wakeup_pending()
987  * pm_get_wakeup_count - Read the number of registered wakeup events.
991  * Store the number of registered wakeup events at the address in @count.  If
992  * @block is set, block until the current number of wakeup events being
995  * Return 'false' if the current number of wakeup events being processed is
1023  * pm_save_wakeup_count - Save the current number of registered wakeup events.
1024  * @count: Value to compare with the current number of registered wakeup events.
1026  * If @count is equal to the current number of registered wakeup events and the
1027  * current number of wakeup events being processed is zero, store @count as the
1028  * old number of registered wakeup events for pm_check_wakeup_events(), enable
1029  * wakeup events detection and return 'true'.  Otherwise disable wakeup events
1050  * pm_wakep_autosleep_enabled - Modify autosleep_enabled for all wakeup sources.
1078  * print_wakeup_source_stats - Print wakeup source statistics information.
1080  * @ws: Wakeup source object to print the statistics for.
1174  * wakeup_sources_stats_seq_show - Print wakeup sources statistics information.