sof/ipc4/header.h

1 /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
24  * struct sof_ipc4_msg - Placeholder of an IPC4 message
46  * struct sof_ipc4_tuple - Generic type/ID and parameter tuple
58  * IPC4 messages have two 32 bit identifier made up as follows :-
60  * header - msg type, msg id, msg direction ...
61  * extension - extra params such as msg data size in mailbox
68  * IPC4 primary header bit allocation for messages
69  * bit 0-23:	message type specific
70  * bit 24-28:	type:	enum sof_ipc4_global_msg if target is SOF_IPC4_FW_GEN_MSG
72  * bit 29:	response - sof_ipc4_msg_dir
73  * bit 30:	target - enum sof_ipc4_msg_target
74  * bit 31:	reserved, unused
77 /* Value of target field - must fit into 1 bit */
86 /* Value of type field - must fit into 5 bits */
92 	/* 3 .. 12: RESERVED - do not use */
126 	/* 28 .. 31: RESERVED - do not use */
131 /* Value of response field - must fit into 1 bit */
146 /* Generic message fields (bit 24-30) */
150 #define SOF_IPC4_MSG_TARGET_MASK		BIT(30)
155 #define SOF_IPC4_MSG_DIR_SHIFT			29
156 #define SOF_IPC4_MSG_DIR_MASK			BIT(29)
183 #define SOF_IPC4_GLB_PIPE_EXT_LP_MASK		BIT(0)
200 #define SOF_IPC4_GLB_PIPE_STATE_EXT_MULTI	BIT(0)
218 #define SOF_IPC4_GLB_CHAIN_DMA_ALLOCATE_MASK	BIT(16)
222 #define SOF_IPC4_GLB_CHAIN_DMA_ENABLE_MASK	BIT(17)
226 #define SOF_IPC4_GLB_CHAIN_DMA_SCS_MASK		BIT(18)
256 	/* Stereo (L,R) in 4 slots, 1st stream: [ L, R, -, - ] */
258 	/* Stereo (L,R) in 4 slots, 2nd stream: [ -, -, L, R ] */
348 #define SOF_IPC4_MOD_EXT_DOMAIN_MASK		BIT(28)
365 #define SOF_IPC4_MOD_EXT_SRC_MOD_QUEUE_ID_MASK	GENMASK(29, 27)
381 #define SOF_IPC4_MOD_EXT_MSG_LAST_BLOCK_MASK	BIT(28)
384 #define SOF_IPC4_MOD_EXT_MSG_FIRST_BLOCK_SHIFT	29
385 #define SOF_IPC4_MOD_EXT_MSG_FIRST_BLOCK_MASK	BIT(29)
452  * IPC4 primary header bit allocation for replies
453  * bit 0-23:	status
454  * bit 24-28:	type:	enum sof_ipc4_global_msg if target is SOF_IPC4_FW_GEN_MSG
456  * bit 29:	response - sof_ipc4_msg_dir
457  * bit 30:	target - enum sof_ipc4_msg_target
458  * bit 31:	reserved, unused
466  * IPC4 primary header bit allocation for notifications
467  * bit 0-15:	notification type specific
468  * bit 16-23:	enum sof_ipc4_notification_type
469  * bit 24-28:	SOF_IPC4_GLB_NOTIFICATION
470  * bit 29:	response - sof_ipc4_msg_dir
471  * bit 30:	target - enum sof_ipc4_msg_target
472  * bit 31:	reserved, unused
488 /* Value of notification type field - must fit into 8 bits */
507 	/* 13 is reserved - do not use */
542  * struct sof_ipc4_notify_module_data - payload for module notification