include/linux/suspend.h

1 /* SPDX-License-Identifier: GPL-2.0 */
44  * struct platform_suspend_ops - Callbacks for managing platform dependent
45  *	system sleep states.
47  * @valid: Callback to determine if given system sleep state is supported by
50  *	that it still may be impossible to enter given system sleep state if the
55  * @begin: Initialise a transition to given system sleep state.
63  * @prepare: Prepare the platform for entering the system sleep state indicated
69  *	system cannot enter the desired sleep state (@prepare_late(), @enter(),
72  * @prepare_late: Finish preparing the platform for entering the system sleep
77  *	system cannot enter the desired sleep state (@enter() will not be
80  * @enter: Enter the system sleep state indicated by @begin() or represented by
83  *	error code otherwise, in which case the system cannot enter the desired
86  * @wake: Called when the system has just left a sleep state, right after
93  * @finish: Finish wake-up of the platform.
101  * @suspend_again: Returns whether the system should suspend again (true) or
104  *	suspend_again callback is the place assuming that periodic-wakeup or
105  *	alarm-wakeup is already setup. This allows to execute some codes while
109  *	the platform that the system has returned to the working state or
151  * suspend_set_ops - set platform dependent suspend operations
184  * pm_suspend_via_firmware - Check if platform firmware will suspend the system.
186  * To be called during system-wide power management transitions to sleep states
187  * or during the subsequent system-wide transitions back to the working state.
190  * the system-wide power management transition (to a sleep state) in progress in
192  * to complete the last (or preceding) transition of the system to a sleep
200  * been carried out during the preceding transition of the system to a sleep
209  * pm_resume_via_firmware - Check if platform firmware has woken up the system.
211  * To be called during system-wide power management transitions from sleep
215  * the beginning of the system-wide power management transition in progress, so
216  * the event that woke up the system from sleep has been handled by the platform
225  * pm_suspend_no_platform - Check if platform may change device power states.
227  * To be called during system-wide power management transitions to sleep states
228  * or during the subsequent system-wide transitions back to the working state.
231  * kernel throughout the system-wide suspend and resume cycle in progress (that
240 /* Suspend-to-idle state machnine. */
243 	S2IDLE_STATE_ENTER,     /* Enter suspend-to-idle. */
244 	S2IDLE_STATE_WAKE,      /* Wake up from suspend-to-idle. */
260  * arch_suspend_disable_irqs - disable IRQs for suspend
269  * arch_suspend_enable_irqs - enable IRQs after suspend
293 static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }  in pm_suspend()
312  * struct platform_hibernation_ops - hibernation platform support
323  *	the platform that the system has returned to the working state.
339  * @enter: Put the system into the low power state after the hibernation image
344  * @leave: Perform the first stage of the cleanup after the system sleep state
350  * @pre_restore: Prepare system for the restoration from a hibernation image.
407 static inline int hibernate(void) { return -ENOSYS; }  in hibernate()
412 	return -ENOTSUPP;  in hibernate_quiet_exec()
427 #define PM_SUSPEND_PREPARE	0x0003 /* Going to suspend the system */
543  * pm_pr_dbg - print pm sleep debug messages
545  * If pm_debug_messages_on is enabled and the system is entering/leaving