wwan/iosm/iosm_ipc_pm.h

1 /* SPDX-License-Identifier: GPL-2.0-only
3  * Copyright (C) 2020-21 Intel Corporation.
9 /* Trigger the doorbell interrupt on cp to change the PM sleep/active status */
10 #define ipc_cp_irq_sleep_control(ipc_pcie, data)                               \  argument
11 	ipc_doorbell_fire(ipc_pcie, IPC_DOORBELL_IRQ_SLEEP, data)
14 #define ipc_cp_irq_hpda_update(ipc_pcie, data)                                 \  argument
15 	ipc_doorbell_fire(ipc_pcie, IPC_DOORBELL_IRQ_HPDA, 0xFF & (data))
18  * union ipc_pm_cond - Conditions for D3 and the sleep message to CP.
35  * enum ipc_mem_host_pm_state - Possible states of the HOST SLEEP finite state
37  * @IPC_MEM_HOST_PM_ACTIVE:		   Host is active
39  *					   active
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
90  * @host_sleep_complete:	Generic wait-for-completion used in
113  * enum ipc_pm_unit - Power management units.
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
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
175  * ipc_pm_wait_for_device_active - Wait up to IPC_PM_ACTIVE_TIMEOUT_MS ms
176  *				   for the device to reach active state
179  * Returns: true if device is active, false on timeout
184  * ipc_pm_signal_hpda_doorbell - Wake up the device if it is in low power mode
198  * ipc_pm_trigger - Update power manager and wake up the link if needed
201  * @active:	Device link state
203  * Returns: true if link is unchanged or active, false otherwise
205 bool ipc_pm_trigger(struct iosm_pm *ipc_pm, enum ipc_pm_unit unit, bool active);