include/linux/pm.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3  *  pm.h - Power management interface
52 	int event;  member
56  * struct dev_pm_ops - device PM callbacks.
63  *	registration of a child already in progress), it may return -EAGAIN, so
73  *	runtime-suspended and it may be left in that state during the entire
78  *	The PM core executes subsystem-level @prepare() for all devices before
96  *	The PM core executes subsystem-level @complete() after it has executed
109  *	contents of main memory are preserved.  The exact action to perform
111  *	type), but generally the device must be quiescent after subsystem-level
113  *	Subsystem-level @suspend() is executed for all devices after invoking
114  *	subsystem-level @prepare() for all of them.
121  *	contents of main memory were preserved.  The exact action to perform
124  *	requests (the device itself may be left in a low-power state, waiting
129  *	Subsystem-level @resume() is executed for all devices after invoking
130  *	subsystem-level @resume_noirq() for all of them.
136  * @freeze: Hibernation-specific, executed before creating a hibernation image.
138  *	wakeup events or change its power state.  The majority of subsystems
139  *	(with the notable exception of the PCI bus type) expect the driver-level
142  *	Subsystem-level @freeze() is executed for all devices after invoking
143  *	subsystem-level @prepare() for all of them.
146  *	@suspend_late(), but it should not enable the device to signal wakeup
149  * @thaw: Hibernation-specific, executed after creating a hibernation image OR
154  *	Subsystem-level @thaw() is executed for all devices after invoking
155  *	subsystem-level @thaw_noirq() for all of them.  It also may be executed
161  * @poweroff: Hibernation-specific, executed after saving a hibernation image.
164  *	Subsystem-level @poweroff() is executed for all devices after invoking
165  *	subsystem-level @prepare() for all of them.
170  * @restore: Hibernation-specific, executed after restoring the contents of main
179  *	It generally is expected that the device will be in a low-power state
180  *	(appropriate for the target system sleep state) after subsystem-level
182  *	system wakeup signals and is enabled to wake up the system, it should be
185  *	put the device into the low-power state and configure it to generate
186  *	wakeup signals, in which case it generally is not necessary to define
200  *	signal system wakeup by any of these callbacks.
217  *	This need not mean that the device should be put into a low-power state.
220  *	power and is capable of generating runtime wakeup events, remote wakeup
225  *	wakeup event generated by hardware or at the request of software.  If
226  *	necessary, put the device into the full-power state and restore its
230  *	low-power state if all of the necessary conditions are satisfied.
237  * internal transitions to various low-power modes which are transparent
244  * domains, device types, classes and bus types.  They are the subsystem-level
247  * have to collaborate with the subsystem-level callbacks to achieve the goals
270  * (PM domains, device types, classes and bus types) and the subsystem-level
396  * FREEZE	System is going to hibernate, call ->prepare() and ->freeze()
399  * SUSPEND	System is going to suspend, call ->prepare() and ->suspend()
402  * HIBERNATE	Hibernation image has been saved, call ->prepare() and
403  *		->poweroff() for all devices.
406  *		hibernation image, call ->prepare() and ->freeze() for all
409  * RESUME	System is resuming, call ->resume() and ->complete() for all
412  * THAW		Hibernation image has been created, call ->thaw() and
413  *		->complete() for all devices.
416  *		image, call ->restore() and ->complete() for all devices.
420  *		->thaw() and ->complete() for all devices.
429  * REMOTE_WAKEUP	Remote-wakeup request was received from the device.
438 #define PM_EVENT_INVALID	(-1)
459 #define PMSG_INVALID	((struct pm_message){ .event = PM_EVENT_INVALID, })
460 #define PMSG_ON		((struct pm_message){ .event = PM_EVENT_ON, })
461 #define PMSG_FREEZE	((struct pm_message){ .event = PM_EVENT_FREEZE, })
462 #define PMSG_QUIESCE	((struct pm_message){ .event = PM_EVENT_QUIESCE, })
463 #define PMSG_SUSPEND	((struct pm_message){ .event = PM_EVENT_SUSPEND, })
464 #define PMSG_HIBERNATE	((struct pm_message){ .event = PM_EVENT_HIBERNATE, })
465 #define PMSG_RESUME	((struct pm_message){ .event = PM_EVENT_RESUME, })
466 #define PMSG_THAW	((struct pm_message){ .event = PM_EVENT_THAW, })
467 #define PMSG_RESTORE	((struct pm_message){ .event = PM_EVENT_RESTORE, })
468 #define PMSG_RECOVER	((struct pm_message){ .event = PM_EVENT_RECOVER, })
470 					{ .event = PM_EVENT_USER_SUSPEND, })
472 					{ .event = PM_EVENT_USER_RESUME, })
474 					{ .event = PM_EVENT_REMOTE_RESUME, })
476 					{ .event = PM_EVENT_AUTO_SUSPEND, })
478 					{ .event = PM_EVENT_AUTO_RESUME, })
480 #define PMSG_IS_AUTO(msg)	(((msg).event & PM_EVENT_AUTO) != 0)
483  * Device run-time power management status.
491  *			bus type's ->runtime_resume() callback has completed
494  * RPM_SUSPENDED	Device bus type's ->runtime_suspend() callback has
498  * RPM_RESUMING		Device bus type's ->runtime_resume() callback is being
501  * RPM_SUSPENDING	Device bus type's ->runtime_suspend() callback is being
513  * Device run-time power management request types.
517  * RPM_REQ_IDLE		Run the device bus type's ->runtime_idle() callback
519  * RPM_REQ_SUSPEND	Run the device bus type's ->runtime_suspend() callback
524  * RPM_REQ_RESUME	Run the device bus type's ->runtime_resume() callback
556  * NO_DIRECT_COMPLETE: Do not apply direct-complete optimization to the device.
557  * SMART_PREPARE: Take the driver ->prepare callback return value into account.
561  * See Documentation/driver-api/pm/devices.rst for details.
585 	struct wakeup_source	*wakeup;  member
636  * struct dev_pm_domain - power management domain representation.
647  * subsystem-level and driver-level callbacks.
662  * suspend framework, based on the ->suspend() and ->resume() callbacks common
675  *		a power-off reset, or it may have maintained state from the
689  *		wakeup events as appropriate.
692  *		state (eg. ACPI S4) and enable wakeup events as appropriate.
696  *		NOT emit system wakeup events.
704  * A minimally power-aware driver treats all messages as SUSPEND, fully
705  * reinitializes its device during resume() -- whether or not it was reset
706  * during the suspend/resume cycle -- and can't issue wakeup events.
708  * More power-aware drivers may also use low power states at runtime as
710  * be able to use wakeup events to exit from runtime low-power states,
711  * or from system low-power states such as standby or suspend-to-RAM.