include/linux/pm.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3  *  pm.h - Power management interface
59 	int event;  member
63  * struct dev_pm_ops - device PM callbacks.
70  *	registration of a child already in progress), it may return -EAGAIN, so
80  *	runtime-suspended and it may be left in that state during the entire
85  *	The PM core executes subsystem-level @prepare() for all devices before
103  *	The PM core executes subsystem-level @complete() after it has executed
116  *	contents of main memory are preserved.  The exact action to perform
118  *	type), but generally the device must be quiescent after subsystem-level
120  *	Subsystem-level @suspend() is executed for all devices after invoking
121  *	subsystem-level @prepare() for all of them.
128  *	contents of main memory were preserved.  The exact action to perform
131  *	requests (the device itself may be left in a low-power state, waiting
136  *	Subsystem-level @resume() is executed for all devices after invoking
137  *	subsystem-level @resume_noirq() for all of them.
143  * @freeze: Hibernation-specific, executed before creating a hibernation image.
145  *	wakeup events or change its power state.  The majority of subsystems
146  *	(with the notable exception of the PCI bus type) expect the driver-level
149  *	Subsystem-level @freeze() is executed for all devices after invoking
150  *	subsystem-level @prepare() for all of them.
153  *	@suspend_late(), but it should not enable the device to signal wakeup
156  * @thaw: Hibernation-specific, executed after creating a hibernation image OR
161  *	Subsystem-level @thaw() is executed for all devices after invoking
162  *	subsystem-level @thaw_noirq() for all of them.  It also may be executed
168  * @poweroff: Hibernation-specific, executed after saving a hibernation image.
171  *	Subsystem-level @poweroff() is executed for all devices after invoking
172  *	subsystem-level @prepare() for all of them.
177  * @restore: Hibernation-specific, executed after restoring the contents of main
186  *	It generally is expected that the device will be in a low-power state
187  *	(appropriate for the target system sleep state) after subsystem-level
189  *	system wakeup signals and is enabled to wake up the system, it should be
192  *	put the device into the low-power state and configure it to generate
193  *	wakeup signals, in which case it generally is not necessary to define
207  *	signal system wakeup by any of these callbacks.
224  *	This need not mean that the device should be put into a low-power state.
227  *	power and is capable of generating runtime wakeup events, remote wakeup
232  *	wakeup event generated by hardware or at the request of software.  If
233  *	necessary, put the device into the full-power state and restore its
237  *	low-power state if all of the necessary conditions are satisfied.
244  * internal transitions to various low-power modes which are transparent
251  * domains, device types, classes and bus types.  They are the subsystem-level
254  * have to collaborate with the subsystem-level callbacks to achieve the goals
277  * (PM domains, device types, classes and bus types) and the subsystem-level
488  * FREEZE	System is going to hibernate, call ->prepare() and ->freeze()
491  * SUSPEND	System is going to suspend, call ->prepare() and ->suspend()
494  * HIBERNATE	Hibernation image has been saved, call ->prepare() and
495  *		->poweroff() for all devices.
498  *		hibernation image, call ->prepare() and ->freeze() for all
501  * RESUME	System is resuming, call ->resume() and ->complete() for all
504  * THAW		Hibernation image has been created, call ->thaw() and
505  *		->complete() for all devices.
508  *		image, call ->restore() and ->complete() for all devices.
512  *		->thaw() and ->complete() for all devices.
521  * REMOTE_WAKEUP	Remote-wakeup request was received from the device.
530 #define PM_EVENT_INVALID	(-1)
551 #define PMSG_INVALID	((struct pm_message){ .event = PM_EVENT_INVALID, })
552 #define PMSG_ON		((struct pm_message){ .event = PM_EVENT_ON, })
553 #define PMSG_FREEZE	((struct pm_message){ .event = PM_EVENT_FREEZE, })
554 #define PMSG_QUIESCE	((struct pm_message){ .event = PM_EVENT_QUIESCE, })
555 #define PMSG_SUSPEND	((struct pm_message){ .event = PM_EVENT_SUSPEND, })
556 #define PMSG_HIBERNATE	((struct pm_message){ .event = PM_EVENT_HIBERNATE, })
557 #define PMSG_RESUME	((struct pm_message){ .event = PM_EVENT_RESUME, })
558 #define PMSG_THAW	((struct pm_message){ .event = PM_EVENT_THAW, })
559 #define PMSG_RESTORE	((struct pm_message){ .event = PM_EVENT_RESTORE, })
560 #define PMSG_RECOVER	((struct pm_message){ .event = PM_EVENT_RECOVER, })
562 					{ .event = PM_EVENT_USER_SUSPEND, })
564 					{ .event = PM_EVENT_USER_RESUME, })
566 					{ .event = PM_EVENT_REMOTE_RESUME, })
568 					{ .event = PM_EVENT_AUTO_SUSPEND, })
570 					{ .event = PM_EVENT_AUTO_RESUME, })
572 #define PMSG_IS_AUTO(msg)	(((msg).event & PM_EVENT_AUTO) != 0)
575  * Device run-time power management status.
583  *			bus type's ->runtime_resume() callback has completed
586  * RPM_SUSPENDED	Device bus type's ->runtime_suspend() callback has
590  * RPM_RESUMING		Device bus type's ->runtime_resume() callback is being
593  * RPM_SUSPENDING	Device bus type's ->runtime_suspend() callback is being
598 	RPM_INVALID = -1,
606  * Device run-time power management request types.
610  * RPM_REQ_IDLE		Run the device bus type's ->runtime_idle() callback
612  * RPM_REQ_SUSPEND	Run the device bus type's ->runtime_suspend() callback
617  * RPM_REQ_RESUME	Run the device bus type's ->runtime_resume() callback
651  * NO_DIRECT_COMPLETE: Do not apply direct-complete optimization to the device.
652  * SMART_PREPARE: Take the driver ->prepare callback return value into account.
656  * See Documentation/driver-api/pm/devices.rst for details.
680 	struct wakeup_source	*wakeup;  member
730  * struct dev_pm_domain - power management domain representation.
742  * subsystem-level and driver-level callbacks.
756  * suspend framework, based on the ->suspend() and ->resume() callbacks common
769  *		a power-off reset, or it may have maintained state from the
783  *		wakeup events as appropriate.
786  *		state (eg. ACPI S4) and enable wakeup events as appropriate.
790  *		NOT emit system wakeup events.
798  * A minimally power-aware driver treats all messages as SUSPEND, fully
799  * reinitializes its device during resume() -- whether or not it was reset
800  * during the suspend/resume cycle -- and can't issue wakeup events.
802  * More power-aware drivers may also use low power states at runtime as
804  * be able to use wakeup events to exit from runtime low-power states,
805  * or from system low-power states such as standby or suspend-to-RAM.