include/linux/suspend.h

1 /* SPDX-License-Identifier: GPL-2.0 */
100  * struct platform_suspend_ops - Callbacks for managing platform dependent
101  *	system sleep states.
103  * @valid: Callback to determine if given system sleep state is supported by
106  *	that it still may be impossible to enter given system sleep state if the
111  * @begin: Initialise a transition to given system sleep state.
119  * @prepare: Prepare the platform for entering the system sleep state indicated
125  *	system cannot enter the desired sleep state (@prepare_late(), @enter(),
128  * @prepare_late: Finish preparing the platform for entering the system sleep
133  *	system cannot enter the desired sleep state (@enter() will not be
136  * @enter: Enter the system sleep state indicated by @begin() or represented by
139  *	error code otherwise, in which case the system cannot enter the desired
142  * @wake: Called when the system has just left a sleep state, right after
149  * @finish: Finish wake-up of the platform.
157  * @suspend_again: Returns whether the system should suspend again (true) or
160  *	suspend_again callback is the place assuming that periodic-wakeup or
161  *	alarm-wakeup is already setup. This allows to execute some codes while
165  *	the platform that the system has returned to the working state or
205  * suspend_set_ops - set platform dependent suspend operations
238  * pm_suspend_via_firmware - Check if platform firmware will suspend the system.
240  * To be called during system-wide power management transitions to sleep states
241  * or during the subsequent system-wide transitions back to the working state.
244  * the system-wide power management transition (to a sleep state) in progress in
246  * to complete the last (or preceding) transition of the system to a sleep
254  * been carried out during the preceding transition of the system to a sleep
263  * pm_resume_via_firmware - Check if platform firmware has woken up the system.
265  * To be called during system-wide power management transitions from sleep
269  * the beginning of the system-wide power management transition in progress, so
270  * the event that woke up the system from sleep has been handled by the platform
279  * pm_suspend_no_platform - Check if platform may change device power states.
281  * To be called during system-wide power management transitions to sleep states
282  * or during the subsequent system-wide transitions back to the working state.
285  * kernel throughout the system-wide suspend and resume cycle in progress (that
294 /* Suspend-to-idle state machnine. */
297 	S2IDLE_STATE_ENTER,     /* Enter suspend-to-idle. */
298 	S2IDLE_STATE_WAKE,      /* Wake up from suspend-to-idle. */
314  * arch_suspend_disable_irqs - disable IRQs for suspend
323  * arch_suspend_enable_irqs - enable IRQs after suspend
345 static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }  in pm_suspend()
367  * struct platform_hibernation_ops - hibernation platform support
378  *	the platform that the system has returned to the working state.
394  * @enter: Put the system into the low power state after the hibernation image
399  * @leave: Perform the first stage of the cleanup after the system sleep state
405  * @pre_restore: Prepare system for the restoration from a hibernation image.
466 static inline int hibernate(void) { return -ENOSYS; }  in hibernate()
471 	return -ENOTSUPP;  in hibernate_quiet_exec()
484 #define PM_SUSPEND_PREPARE	0x0003 /* Going to suspend the system */