header-intel-cavs.h File Reference

IPC command header for Intel cAVS platforms. More...

Include dependency graph for header-intel-cavs.h:

Go to the source code of this file.

Macros
#define	CAVS_IPC_RSVD_31   BIT(31)
#define	CAVS_IPC_MSG_TGT   BIT(30)
	Target, 0 - global message, 1 - message to a module.
#define	CAVS_IPC_RSP   BIT(29)
	Direction, 0 - request, 1 - response.
#define	CAVS_IPC_TYPE_SHIFT   24
#define	CAVS_IPC_TYPE_MASK   MASK(28, 24)
#define	CAVS_IPC_TYPE(x)
#define	CAVS_IPC_MOD_INSTANCE_ID_MASK   MASK(23, 16)
	ID of the target module instance.
#define	CAVS_IPC_MOD_ID_MASK   MASK(15, 0)
	ID of the target module.
#define	CAVS_IPC_MOD_INIT_INSTANCE   CAVS_IPC_TYPE(0x0U)
#define	CAVS_IPC_MOD_CFG_GET   CAVS_IPC_TYPE(0x1U)
#define	CAVS_IPC_MOD_CFG_SET   CAVS_IPC_TYPE(0x2U)
#define	CAVS_IPC_MOD_LARGE_CFG_GET   CAVS_IPC_TYPE(0x3U)
#define	CAVS_IPC_MOD_LARGE_CFG_SET   CAVS_IPC_TYPE(0x4U)
#define	CAVS_IPC_MOD_BIND   CAVS_IPC_TYPE(0x5U)
#define	CAVS_IPC_MOD_UNBIND   CAVS_IPC_TYPE(0x6U)
#define	CAVS_IPC_MOD_SET_DX   CAVS_IPC_TYPE(0x7U)
#define	CAVS_IPC_MOD_SET_D0IX   CAVS_IPC_TYPE(0x8U)
#define	CAVS_IPC_MOD_ENTER_RESTORE   CAVS_IPC_TYPE(0x9U)
#define	CAVS_IPC_MOD_EXIT_RESTORE   CAVS_IPC_TYPE(0xaU)
#define	CAVS_IPC_MOD_DELETE_INSTANCE   CAVS_IPC_TYPE(0xbU)
#define	CAVS_IPC_MOD_NOTIFICATION   CAVS_IPC_TYPE(0xcU)
#define	CAVS_IPC_MOD_SETD0IX_BIT_MASK   MASK(7, 0)
	Valid bits for SetD0ix.
#define	CAVS_IPC_MOD_SETD0IX_NO_TRACE   BIT(4)
	Disable DMA tracing (0 - keep tracing, 1 - to disable DMA trace).
#define	CAVS_IPC_MOD_SETD0IX_PCG   BIT(3)
	Prevent clock gating (0 - cg allowed, 1 - DSP clock always on).
#define	CAVS_IPC_MOD_SETD0IX_PPG   BIT(2)
	Prevent power gating (0 - D0ix transitions allowed).
#define	CAVS_IPC_MOD_SETD0IX_STREAMING   BIT(1)
	Streaming active.
#define	CAVS_IPC_MOD_SETD0IX_WAKE_TYPE   BIT(0)
	Legacy wake type, unused in cAVS 1.8+.

Detailed Description

IPC command header for Intel cAVS platforms.

Author

Marcin Maka marci.nosp@m.n.ma.nosp@m.ka@li.nosp@m.nux..nosp@m.intel.nosp@m..com

Macro Definition Documentation

CAVS_IPC_MOD_BIND

#define CAVS_IPC_MOD_BIND   CAVS_IPC_TYPE(0x5U)

CAVS_IPC_MOD_CFG_GET

#define CAVS_IPC_MOD_CFG_GET   CAVS_IPC_TYPE(0x1U)

CAVS_IPC_MOD_CFG_SET

#define CAVS_IPC_MOD_CFG_SET   CAVS_IPC_TYPE(0x2U)

CAVS_IPC_MOD_DELETE_INSTANCE

#define CAVS_IPC_MOD_DELETE_INSTANCE   CAVS_IPC_TYPE(0xbU)

CAVS_IPC_MOD_ENTER_RESTORE

#define CAVS_IPC_MOD_ENTER_RESTORE   CAVS_IPC_TYPE(0x9U)

CAVS_IPC_MOD_EXIT_RESTORE

#define CAVS_IPC_MOD_EXIT_RESTORE   CAVS_IPC_TYPE(0xaU)

CAVS_IPC_MOD_ID_MASK

#define CAVS_IPC_MOD_ID_MASK   MASK(15, 0)

ID of the target module.

CAVS_IPC_MOD_INIT_INSTANCE

#define CAVS_IPC_MOD_INIT_INSTANCE   CAVS_IPC_TYPE(0x0U)

CAVS_IPC_MOD_INSTANCE_ID_MASK

#define CAVS_IPC_MOD_INSTANCE_ID_MASK   MASK(23, 16)

ID of the target module instance.

CAVS_IPC_MOD_LARGE_CFG_GET

#define CAVS_IPC_MOD_LARGE_CFG_GET   CAVS_IPC_TYPE(0x3U)

CAVS_IPC_MOD_LARGE_CFG_SET

#define CAVS_IPC_MOD_LARGE_CFG_SET   CAVS_IPC_TYPE(0x4U)

CAVS_IPC_MOD_NOTIFICATION

#define CAVS_IPC_MOD_NOTIFICATION   CAVS_IPC_TYPE(0xcU)

CAVS_IPC_MOD_SET_D0IX

#define CAVS_IPC_MOD_SET_D0IX   CAVS_IPC_TYPE(0x8U)

CAVS_IPC_MOD_SET_DX

#define CAVS_IPC_MOD_SET_DX   CAVS_IPC_TYPE(0x7U)

CAVS_IPC_MOD_SETD0IX_BIT_MASK

#define CAVS_IPC_MOD_SETD0IX_BIT_MASK   MASK(7, 0)

Valid bits for SetD0ix.

CAVS_IPC_MOD_SETD0IX_NO_TRACE

#define CAVS_IPC_MOD_SETD0IX_NO_TRACE   BIT(4)

Disable DMA tracing (0 - keep tracing, 1 - to disable DMA trace).

CAVS_IPC_MOD_SETD0IX_PCG

#define CAVS_IPC_MOD_SETD0IX_PCG   BIT(3)

Prevent clock gating (0 - cg allowed, 1 - DSP clock always on).

CAVS_IPC_MOD_SETD0IX_PPG

#define CAVS_IPC_MOD_SETD0IX_PPG   BIT(2)

Prevent power gating (0 - D0ix transitions allowed).

CAVS_IPC_MOD_SETD0IX_STREAMING

#define CAVS_IPC_MOD_SETD0IX_STREAMING   BIT(1)

Streaming active.

CAVS_IPC_MOD_SETD0IX_WAKE_TYPE

#define CAVS_IPC_MOD_SETD0IX_WAKE_TYPE   BIT(0)

Legacy wake type, unused in cAVS 1.8+.

CAVS_IPC_MOD_UNBIND

#define CAVS_IPC_MOD_UNBIND   CAVS_IPC_TYPE(0x6U)

CAVS_IPC_MSG_TGT

#define CAVS_IPC_MSG_TGT   BIT(30)

Target, 0 - global message, 1 - message to a module.

CAVS_IPC_RSP

#define CAVS_IPC_RSP   BIT(29)

Direction, 0 - request, 1 - response.

CAVS_IPC_RSVD_31

#define CAVS_IPC_RSVD_31   BIT(31)

CAVS_IPC_TYPE

#define CAVS_IPC_TYPE

(

x

)

Value:

((x) << CAVS_IPC_TYPE_SHIFT)

CAVS_IPC_TYPE_MASK

#define CAVS_IPC_TYPE_MASK   MASK(28, 24)

CAVS_IPC_TYPE_SHIFT

#define CAVS_IPC_TYPE_SHIFT   24