include/linux/suspend.h

1 /* SPDX-License-Identifier: GPL-2.0 */
44  * struct platform_suspend_ops - Callbacks for managing platform dependent
93  * @finish: Finish wake-up of the platform.
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
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
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
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
315  * operations required by it during a hibernation transition.
319  * @begin: Tell the platform driver that we're starting hibernation.
325  * @pre_snapshot: Prepare the platform for creating the hibernation image.
329  * @finish: Restore the previous state of the platform after the hibernation
331  *	mode after the hibernation (the same method is executed in both cases).
336  *	Called right after the hibernation image has been saved and before
339  * @enter: Put the system into the low power state after the hibernation image
350  * @pre_restore: Prepare system for the restoration from a hibernation image.
359  *	Called by the PM core if the suspending of devices during hibernation
407 static inline int hibernate(void) { return -ENOSYS; }  in hibernate()
412 	return -ENOTSUPP;  in hibernate_quiet_exec()
424 /* Hibernation and suspend events */
426 #define PM_POST_HIBERNATION	0x0002 /* Hibernation finished */
543  * pm_pr_dbg - print pm sleep debug messages