wwan/iosm/iosm_ipc_pm.h

1 /* SPDX-License-Identifier: GPL-2.0-only
3  * Copyright (C) 2020-21 Intel Corporation.
18  * union ipc_pm_cond - Conditions for D3 and the sleep message to CP.
21  * @hs:		Host Sleep
35  * enum ipc_mem_host_pm_state - Possible states of the HOST SLEEP finite state
37  * @IPC_MEM_HOST_PM_ACTIVE:		   Host is active
45  *					   accessible host is in suspend to RAM
59  * enum ipc_mem_dev_pm_state - Possible states of the DEVICE SLEEP finite state
65  *					and DOORBELL-IRQ-HPDA(data) values.
68  * @IPC_MEM_DEV_PM_WAKEUP:		DOORBELL-IRQ-DEVICE_WAKE(data).
69  * @IPC_MEM_DEV_PM_HOST_SLEEP:		DOORBELL-IRQ-HOST_SLEEP(data).
71  * @IPC_MEM_DEV_PM_FORCE_SLEEP:		DOORBELL-IRQ-FORCE_SLEEP.
72  * @IPC_MEM_DEV_PM_FORCE_ACTIVE:	DOORBELL-IRQ-FORCE_ACTIVE.
85  * struct iosm_pm - Power management instance
88  * @host_pm_state:		PM states for host
89  * @host_sleep_pend:		Variable to indicate Host Sleep Pending
90  * @host_sleep_complete:	Generic wait-for-completion used in
91  *				case of Host Sleep
113  * enum ipc_pm_unit - Power management units.
115  * @IPC_PM_UNIT_HS:	Host Sleep for converged protocol
125  * ipc_pm_init - Allocate power management component
131  * ipc_pm_deinit - Free power management component, invalidating its pointer.
137  * ipc_pm_dev_slp_notification - Handle a sleep notification message from the
139  *				 This function handles Host Sleep requests too
140  *				 if the Host Sleep protocol is register based.
150  * ipc_pm_set_s2idle_sleep - Set PM variables to sleep/active
157  * ipc_pm_prepare_host_sleep - Prepare the PM for sleep by entering
161  * Returns: true on success, false if the host was not active.
166  * ipc_pm_prepare_host_active - Prepare the PM for wakeup by entering
170  * Returns: true on success, false if the host was not sleeping.
175  * ipc_pm_wait_for_device_active - Wait up to IPC_PM_ACTIVE_TIMEOUT_MS ms
184  * ipc_pm_signal_hpda_doorbell - Wake up the device if it is in low power mode
188  * @host_slp_check:	if set to true then Host Sleep state machine check will
189  *			be performed. If Host Sleep state machine allows HP
191  *			flag will be set. If set to false then Host Sleep check
192  *			will not be performed. This is helpful for Host Sleep
198  * ipc_pm_trigger - Update power manager and wake up the link if needed