ASoC: SOF: IPC4: Introduce message handling functionality
Subsystems (3)
Peter Ujfalusi
maintainercover ASoC: SOF: IPC4: Introduce message handling functionality
Hi,
The series adds the basic IPC4 message handling code, implementing the ipc callbacks.
Due to the difference between IPC3 and IPC4 messaging we need to introduce new message container for IPC4, but the SOF internal callbacks and structures can be kept as they were and leaving it for the IPC specific code to handle the differences.
The series provides the foundation for both lowe level (sound/soc/sof/intel) and high level IPC4 implementation (topologies, firmware loading, control handling, etc).
Regards,
Peter
---
Peter Ujfalusi (3):
ASoC: SOF: Add rx_data pointer to snd_sof_ipc_msg struct
ASoC: SOF: Add initial header file for ipc4
ASoC: SOF: ipc4: Add support for mandatory message handling
functionality
include/sound/sof/ipc4/header.h | 460 ++++++++++++++++++++++++ sound/soc/sof/Makefile | 3 +- sound/soc/sof/ipc4.c | 604 ++++++++++++++++++++++++++++++++ sound/soc/sof/sof-priv.h | 4 + 4 files changed, 1070 insertions(+), 1 deletion(-) create mode 100644 include/sound/sof/ipc4/header.h create mode 100644 sound/soc/sof/ipc4.c
Signature · 1 line
2.36.0
Peter Ujfalusi
maintainerPATCH 1/3 ASoC: SOF: Add rx_data pointer to snd_sof_ipc_msg struct
The rx_data pointer can be used by IPC implementations to pass the received message (or part of the message, like the header) from platform code to generic, high level IPC code.
IPC4 is going to be the first user of this as its implementation on Intel platforms detaches the header and payload and the rx cannot be handled in a similar way as it is implemented for ipc3.
If the rx_data is dynamically allocated, it is up to the platform code to free it up.
After the message reception handling (rx_msg ops) returned, the pointer via the msg->rx_data should be considered as invalid.
--- sound/soc/sof/sof-priv.h | 3 +++ 1 file changed, 3 insertions(+)
sound/soc/sof/sof-priv.h +3 -0
@@ -350,6 +350,9 @@ struct snd_sof_ipc_msg {size_t reply_size;int reply_error; +/* notification, firmware initiated messages */ +void *rx_data; +wait_queue_head_t waitq;bool ipc_complete; };
Signature · 1 line
2.36.0
Peter Ujfalusi
maintainerPATCH 2/3 ASoC: SOF: Add initial header file for ipc4
In reply to Peter UjfalusiThe header file contains essential structure definitions, description of bit fields and bits in the ipc4 header and an internally used ipc4 message container definition.
--- include/sound/sof/ipc4/header.h | 460 ++++++++++++++++++++++++++++++++ 1 file changed, 460 insertions(+) create mode 100644 include/sound/sof/ipc4/header.h
include/sound/sof/ipc4/header.h new file +460 -0
@@ -0,0 +1,460 @@ +/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */ +/* +* This file is provided under a dual BSD/GPLv2 license. When using or +* redistributing this file, you may do so under either license. +* +* Copyright(c) 2022 Intel Corporation. All rights reserved. +*/ + +#ifndef __INCLUDE_SOUND_SOF_IPC4_HEADER_H__ +#define __INCLUDE_SOUND_SOF_IPC4_HEADER_H__ + +#include <linux/types.h> +#include <uapi/sound/sof/abi.h> + +/* maximum message size for mailbox Tx/Rx */ +#define SOF_IPC4_MSG_MAX_SIZE 4096 + +/** \addtogroup sof_uapi uAPI +* SOF uAPI specification. +* @{ +*/ + +/** +* struct sof_ipc4_msg - Placeholder of an IPC4 message +* @header_u64: IPC4 header as single u64 number +* @primary: Primary, mandatory part of the header +* @extension: Extended part of the header, if not used it should be +* set to 0 +* @data_size: Size of data in bytes pointed by @data_ptr +* @data_ptr: Pointer to the optional payload of a message +*/ +struct sof_ipc4_msg { +union { +u64 header_u64; +struct { +u32 primary; +u32 extension; + }; + }; + +size_t data_size; +void *data_ptr; +}; + +/** +* struct sof_ipc4_tuple - Generic type/ID and parameter tuple +* @type: type/ID +* @size: size of the @value array in bytes +* @value: value for the given type +*/ +struct sof_ipc4_tuple { +uint32_t type; +uint32_t size; +uint32_t value[]; +} __packed; + +/* +* IPC4 messages have two 32 bit identifier made up as follows :- +* +* header - msg type, msg id, msg direction ... +* extension - extra params such as msg data size in mailbox +* +* These are sent at the start of the IPC message in the mailbox. Messages +* should not be sent in the doorbell (special exceptions for firmware). +*/ + +/* +* IPC4 primary header bit allocation for messages +* bit 0-23: message type specific +* bit 24-28: type: enum sof_ipc4_global_msg if target is SOF_IPC4_FW_GEN_MSG +* enum sof_ipc4_module_type if target is SOF_IPC4_MODULE_MSG +* bit 29: response - sof_ipc4_msg_dir +* bit 30: target - enum sof_ipc4_msg_target +* bit 31: reserved, unused +*/ + +/* Value of target field - must fit into 1 bit */ +enum sof_ipc4_msg_target { +/* Global FW message */ +SOF_IPC4_FW_GEN_MSG , + +/* Module message */ +SOF_IPC4_MODULE_MSG +}; + +/* Value of type field - must fit into 5 bits */ +enum sof_ipc4_global_msg { +SOF_IPC4_GLB_BOOT_CONFIG , +SOF_IPC4_GLB_ROM_CONTROL , +SOF_IPC4_GLB_IPCGATEWAY_CMD , + +/* 3 .. 12: RESERVED - do not use */ + +SOF_IPC4_GLB_PERF_MEASUREMENTS_CMD =13 , +SOF_IPC4_GLB_CHAIN_DMA , + +SOF_IPC4_GLB_LOAD_MULTIPLE_MODULES , +SOF_IPC4_GLB_UNLOAD_MULTIPLE_MODULES , + +/* pipeline settings */ +SOF_IPC4_GLB_CREATE_PIPELINE , +SOF_IPC4_GLB_DELETE_PIPELINE , +SOF_IPC4_GLB_SET_PIPELINE_STATE , +SOF_IPC4_GLB_GET_PIPELINE_STATE , +SOF_IPC4_GLB_GET_PIPELINE_CONTEXT_SIZE , +SOF_IPC4_GLB_SAVE_PIPELINE , +SOF_IPC4_GLB_RESTORE_PIPELINE , + +/* Loads library (using Code Load or HD/A Host Output DMA) */ +SOF_IPC4_GLB_LOAD_LIBRARY , + +/* 25: RESERVED - do not use */ + +SOF_IPC4_GLB_INTERNAL_MESSAGE =26 , + +/* Notification (FW to SW driver) */ +SOF_IPC4_GLB_NOTIFICATION , + +/* 28 .. 31: RESERVED - do not use */ + +SOF_IPC4_GLB_TYPE_LAST , +}; + +/* Value of response field - must fit into 1 bit */ +enum sof_ipc4_msg_dir { +SOF_IPC4_MSG_REQUEST , +SOF_IPC4_MSG_REPLY , +}; + +enum sof_ipc4_pipeline_state { +SOF_IPC4_PIPE_INVALID_STATE , +SOF_IPC4_PIPE_UNINITIALIZED , +SOF_IPC4_PIPE_RESET , +SOF_IPC4_PIPE_PAUSED , +SOF_IPC4_PIPE_RUNNING , +SOF_IPC4_PIPE_EOS +}; + +/* Generic message fields (bit 24-30) */ + +/* encoded to header's msg_tgt field */ +#define SOF_IPC4_MSG_TARGET_SHIFT 30 +#define SOF_IPC4_MSG_TARGET_MASK BIT(30) +#define SOF_IPC4_MSG_TARGET (x) ((x) << SOF_IPC4_MSG_TARGET_SHIFT) +#define SOF_IPC4_MSG_IS_MODULE_MSG (x) ((x) & SOF_IPC4_MSG_TARGET_MASK ? 1 : 0) + +/* encoded to header's rsp field */ +#define SOF_IPC4_MSG_DIR_SHIFT 29 +#define SOF_IPC4_MSG_DIR_MASK BIT(29) +#define SOF_IPC4_MSG_DIR (x) ((x) << SOF_IPC4_MSG_DIR_SHIFT) + +/* encoded to header's type field */ +#define SOF_IPC4_MSG_TYPE_SHIFT 24 +#define SOF_IPC4_MSG_TYPE_MASK GENMASK(28, 24) +#define SOF_IPC4_MSG_TYPE_SET (x) (((x) << SOF_IPC4_MSG_TYPE_SHIFT) & \ + SOF_IPC4_MSG_TYPE_MASK) +#define SOF_IPC4_MSG_TYPE_GET (x) (((x) & SOF_IPC4_MSG_TYPE_MASK) >> \ + SOF_IPC4_MSG_TYPE_SHIFT) + +/* Global message type specific field definitions */ + +/* pipeline creation ipc msg */ +#define SOF_IPC4_GLB_PIPE_INSTANCE_SHIFT 16 +#define SOF_IPC4_GLB_PIPE_INSTANCE_MASK GENMASK(23, 16) +#define SOF_IPC4_GLB_PIPE_INSTANCE_ID (x) ((x) << SOF_IPC4_GLB_PIPE_INSTANCE_SHIFT) + +#define SOF_IPC4_GLB_PIPE_PRIORITY_SHIFT 11 +#define SOF_IPC4_GLB_PIPE_PRIORITY_MASK GENMASK(15, 11) +#define SOF_IPC4_GLB_PIPE_PRIORITY (x) ((x) << SOF_IPC4_GLB_PIPE_PRIORITY_SHIFT) + +#define SOF_IPC4_GLB_PIPE_MEM_SIZE_SHIFT 0 +#define SOF_IPC4_GLB_PIPE_MEM_SIZE_MASK GENMASK(10, 0) +#define SOF_IPC4_GLB_PIPE_MEM_SIZE (x) ((x) << SOF_IPC4_GLB_PIPE_MEM_SIZE_SHIFT) + +#define SOF_IPC4_GLB_PIPE_EXT_LP_SHIFT 0 +#define SOF_IPC4_GLB_PIPE_EXT_LP_MASK BIT(0) +#define SOF_IPC4_GLB_PIPE_EXT_LP (x) ((x) << SOF_IPC4_GLB_PIPE_EXT_LP_SHIFT) + +/* pipeline set state ipc msg */ +#define SOF_IPC4_GLB_PIPE_STATE_ID_SHIFT 16 +#define SOF_IPC4_GLB_PIPE_STATE_ID_MASK GENMASK(23, 16) +#define SOF_IPC4_GLB_PIPE_STATE_ID (x) ((x) << SOF_IPC4_GLB_PIPE_STATE_ID_SHIFT) + +#define SOF_IPC4_GLB_PIPE_STATE_SHIFT 0 +#define SOF_IPC4_GLB_PIPE_STATE_MASK GENMASK(15, 0) +#define SOF_IPC4_GLB_PIPE_STATE (x) ((x) << SOF_IPC4_GLB_PIPE_STATE_SHIFT) + +enum sof_ipc4_channel_config { +/* one channel only. */ +SOF_IPC4_CHANNEL_CONFIG_MONO , +/* L & R. */ +SOF_IPC4_CHANNEL_CONFIG_STEREO , +/* L, R & LFE; PCM only. */ +SOF_IPC4_CHANNEL_CONFIG_2_POINT_1 , +/* L, C & R; MP3 & AAC only. */ +SOF_IPC4_CHANNEL_CONFIG_3_POINT_0 , +/* L, C, R & LFE; PCM only. */ +SOF_IPC4_CHANNEL_CONFIG_3_POINT_1 , +/* L, R, Ls & Rs; PCM only. */ +SOF_IPC4_CHANNEL_CONFIG_QUATRO , +/* L, C, R & Cs; MP3 & AAC only. */ +SOF_IPC4_CHANNEL_CONFIG_4_POINT_0 , +/* L, C, R, Ls & Rs. */ +SOF_IPC4_CHANNEL_CONFIG_5_POINT_0 , +/* L, C, R, Ls, Rs & LFE. */ +SOF_IPC4_CHANNEL_CONFIG_5_POINT_1 , +/* one channel replicated in two. */ +SOF_IPC4_CHANNEL_CONFIG_DUAL_MONO , +/* Stereo (L,R) in 4 slots, 1st stream: [ L, R, -, - ] */ +SOF_IPC4_CHANNEL_CONFIG_I2S_DUAL_STEREO_0 , +/* Stereo (L,R) in 4 slots, 2nd stream: [ -, -, L, R ] */ +SOF_IPC4_CHANNEL_CONFIG_I2S_DUAL_STEREO_1 , +/* L, C, R, Ls, Rs & LFE., LS, RS */ +SOF_IPC4_CHANNEL_CONFIG_7_POINT_1 , +}; + +enum sof_ipc4_interleaved_style { +SOF_IPC4_CHANNELS_INTERLEAVED , +SOF_IPC4_CHANNELS_NONINTERLEAVED , +}; + +enum sof_ipc4_sample_type { +SOF_IPC4_MSB_INTEGER ,/* integer with Most Significant Byte first */ +SOF_IPC4_LSB_INTEGER ,/* integer with Least Significant Byte first */ +}; + +struct sof_ipc4_audio_format { +uint32_t sampling_frequency; +uint32_t bit_depth; +uint32_t ch_map; +uint32_t ch_cfg;/* sof_ipc4_channel_config */ +uint32_t interleaving_style; +uint32_t fmt_cfg;/* channels_count valid_bit_depth s_type */ +} __packed__aligned(4) ; + +#define SOF_IPC4_AUDIO_FORMAT_CFG_CHANNELS_COUNT_SHIFT 0 +#define SOF_IPC4_AUDIO_FORMAT_CFG_CHANNELS_COUNT_MASK GENMASK(7, 0) +#define SOF_IPC4_AUDIO_FORMAT_CFG_CHANNELS_COUNT (x) \ + ((x) & SOF_IPC4_AUDIO_FORMAT_CFG_CHANNELS_COUNT_MASK) +#define SOF_IPC4_AUDIO_FORMAT_CFG_V_BIT_DEPTH_SHIFT 8 +#define SOF_IPC4_AUDIO_FORMAT_CFG_V_BIT_DEPTH_MASK GENMASK(15, 8) +#define SOF_IPC4_AUDIO_FORMAT_CFG_V_BIT_DEPTH (x) \ + (((x) & SOF_IPC4_AUDIO_FORMAT_CFG_V_BIT_DEPTH_MASK) >> \ + SOF_IPC4_AUDIO_FORMAT_CFG_V_BIT_DEPTH_SHIFT) +#define SOF_IPC4_AUDIO_FORMAT_CFG_SAMPLE_TYPE_SHIFT 16 +#define SOF_IPC4_AUDIO_FORMAT_CFG_SAMPLE_TYPE_MASK GENMASK(23, 16) +#define SOF_IPC4_AUDIO_FORMAT_CFG_SAMPLE_TYPE (x) \ + (((x) & SOF_IPC4_AUDIO_FORMAT_CFG_SAMPLE_TYPE_MASK) >> \ + SOF_IPC4_AUDIO_FORMAT_CFG_SAMPLE_TYPE_SHIFT) + +/* Module message type specific field definitions */ + +enum sof_ipc4_module_type { +SOF_IPC4_MOD_INIT_INSTANCE , +SOF_IPC4_MOD_CONFIG_GET , +SOF_IPC4_MOD_CONFIG_SET , +SOF_IPC4_MOD_LARGE_CONFIG_GET , +SOF_IPC4_MOD_LARGE_CONFIG_SET , +SOF_IPC4_MOD_BIND , +SOF_IPC4_MOD_UNBIND , +SOF_IPC4_MOD_SET_DX , +SOF_IPC4_MOD_SET_D0IX , +SOF_IPC4_MOD_ENTER_MODULE_RESTORE , +SOF_IPC4_MOD_EXIT_MODULE_RESTORE , +SOF_IPC4_MOD_DELETE_INSTANCE , + +SOF_IPC4_MOD_TYPE_LAST , +}; + +struct sof_ipc4_base_module_cfg { +uint32_t cpc;/* the max count of Cycles Per Chunk processing */ +uint32_t ibs;/* input Buffer Size (in bytes) */ +uint32_t obs;/* output Buffer Size (in bytes) */ +uint32_t is_pages;/* number of physical pages used */ +struct sof_ipc4_audio_format audio_fmt; +} __packed__aligned(4) ; + +/* common module ipc msg */ +#define SOF_IPC4_MOD_INSTANCE_SHIFT 16 +#define SOF_IPC4_MOD_INSTANCE_MASK GENMASK(23, 16) +#define SOF_IPC4_MOD_INSTANCE (x) ((x) << SOF_IPC4_MOD_INSTANCE_SHIFT) + +#define SOF_IPC4_MOD_ID_SHIFT 0 +#define SOF_IPC4_MOD_ID_MASK GENMASK(15, 0) +#define SOF_IPC4_MOD_ID (x) ((x) << SOF_IPC4_MOD_ID_SHIFT) + +/* init module ipc msg */ +#define SOF_IPC4_MOD_EXT_PARAM_SIZE_SHIFT 0 +#define SOF_IPC4_MOD_EXT_PARAM_SIZE_MASK GENMASK(15, 0) +#define SOF_IPC4_MOD_EXT_PARAM_SIZE (x) ((x) << SOF_IPC4_MOD_EXT_PARAM_SIZE_SHIFT) + +#define SOF_IPC4_MOD_EXT_PPL_ID_SHIFT 16 +#define SOF_IPC4_MOD_EXT_PPL_ID_MASK GENMASK(23, 16) +#define SOF_IPC4_MOD_EXT_PPL_ID (x) ((x) << SOF_IPC4_MOD_EXT_PPL_ID_SHIFT) + +#define SOF_IPC4_MOD_EXT_CORE_ID_SHIFT 24 +#define SOF_IPC4_MOD_EXT_CORE_ID_MASK GENMASK(27, 24) +#define SOF_IPC4_MOD_EXT_CORE_ID (x) ((x) << SOF_IPC4_MOD_EXT_CORE_ID_SHIFT) + +#define SOF_IPC4_MOD_EXT_DOMAIN_SHIFT 28 +#define SOF_IPC4_MOD_EXT_DOMAIN_MASK BIT(28) +#define SOF_IPC4_MOD_EXT_DOMAIN (x) ((x) << SOF_IPC4_MOD_EXT_DOMAIN_SHIFT) + +/* bind/unbind module ipc msg */ +#define SOF_IPC4_MOD_EXT_DST_MOD_ID_SHIFT 0 +#define SOF_IPC4_MOD_EXT_DST_MOD_ID_MASK GENMASK(15, 0) +#define SOF_IPC4_MOD_EXT_DST_MOD_ID (x) ((x) << SOF_IPC4_MOD_EXT_DST_MOD_ID_SHIFT) + +#define SOF_IPC4_MOD_EXT_DST_MOD_INSTANCE_SHIFT 16 +#define SOF_IPC4_MOD_EXT_DST_MOD_INSTANCE_MASK GENMASK(23, 16) +#define SOF_IPC4_MOD_EXT_DST_MOD_INSTANCE (x) ((x) << SOF_IPC4_MOD_EXT_DST_MOD_INSTANCE_SHIFT) + +#define SOF_IPC4_MOD_EXT_DST_MOD_QUEUE_ID_SHIFT 24 +#define SOF_IPC4_MOD_EXT_DST_MOD_QUEUE_ID_MASK GENMASK(26, 24) +#define SOF_IPC4_MOD_EXT_DST_MOD_QUEUE_ID (x) ((x) << SOF_IPC4_MOD_EXT_DST_MOD_QUEUE_ID_SHIFT) + +#define SOF_IPC4_MOD_EXT_SRC_MOD_QUEUE_ID_SHIFT 27 +#define SOF_IPC4_MOD_EXT_SRC_MOD_QUEUE_ID_MASK GENMASK(29, 27) +#define SOF_IPC4_MOD_EXT_SRC_MOD_QUEUE_ID (x) ((x) << SOF_IPC4_MOD_EXT_SRC_MOD_QUEUE_ID_SHIFT) + +#define MOD_ENABLE_LOG 6 +#define MOD_SYSTEM_TIME 20 + +/* set module large config */ +#define SOF_IPC4_MOD_EXT_MSG_SIZE_SHIFT 0 +#define SOF_IPC4_MOD_EXT_MSG_SIZE_MASK GENMASK(19, 0) +#define SOF_IPC4_MOD_EXT_MSG_SIZE (x) ((x) << SOF_IPC4_MOD_EXT_MSG_SIZE_SHIFT) + +#define SOF_IPC4_MOD_EXT_MSG_PARAM_ID_SHIFT 20 +#define SOF_IPC4_MOD_EXT_MSG_PARAM_ID_MASK GENMASK(27, 20) +#define SOF_IPC4_MOD_EXT_MSG_PARAM_ID (x) ((x) << SOF_IPC4_MOD_EXT_MSG_PARAM_ID_SHIFT) + +#define SOF_IPC4_MOD_EXT_MSG_LAST_BLOCK_SHIFT 28 +#define SOF_IPC4_MOD_EXT_MSG_LAST_BLOCK_MASK BIT(28) +#define SOF_IPC4_MOD_EXT_MSG_LAST_BLOCK (x) ((x) << SOF_IPC4_MOD_EXT_MSG_LAST_BLOCK_SHIFT) + +#define SOF_IPC4_MOD_EXT_MSG_FIRST_BLOCK_SHIFT 29 +#define SOF_IPC4_MOD_EXT_MSG_FIRST_BLOCK_MASK BIT(29) +#define SOF_IPC4_MOD_EXT_MSG_FIRST_BLOCK (x) ((x) << SOF_IPC4_MOD_EXT_MSG_FIRST_BLOCK_SHIFT) + +/* Init instance messagees */ +#define SOF_IPC4_MOD_INIT_BASEFW_MOD_ID 0 +#define SOF_IPC4_MOD_INIT_BASEFW_INSTANCE_ID 0 + +enum sof_ipc4_base_fw_params { +SOF_IPC4_FW_PARAM_ENABLE_LOGS =6 , +SOF_IPC4_FW_PARAM_FW_CONFIG , +SOF_IPC4_FW_PARAM_HW_CONFIG_GET , +SOF_IPC4_FW_PARAM_MODULES_INFO_GET , +SOF_IPC4_FW_PARAM_LIBRARIES_INFO_GET =16 , +SOF_IPC4_FW_PARAM_SYSTEM_TIME =20 , +}; + +enum sof_ipc4_fw_config_params { +SOF_IPC4_FW_CFG_FW_VERSION , +SOF_IPC4_FW_CFG_MEMORY_RECLAIMED , +SOF_IPC4_FW_CFG_SLOW_CLOCK_FREQ_HZ , +SOF_IPC4_FW_CFG_FAST_CLOCK_FREQ_HZ , +SOF_IPC4_FW_CFG_DMA_BUFFER_CONFIG , +SOF_IPC4_FW_CFG_ALH_SUPPORT_LEVEL , +SOF_IPC4_FW_CFG_DL_MAILBOX_BYTES , +SOF_IPC4_FW_CFG_UL_MAILBOX_BYTES , +SOF_IPC4_FW_CFG_TRACE_LOG_BYTES , +SOF_IPC4_FW_CFG_MAX_PPL_COUNT , +SOF_IPC4_FW_CFG_MAX_ASTATE_COUNT , +SOF_IPC4_FW_CFG_MAX_MODULE_PIN_COUNT , +SOF_IPC4_FW_CFG_MODULES_COUNT , +SOF_IPC4_FW_CFG_MAX_MOD_INST_COUNT , +SOF_IPC4_FW_CFG_MAX_LL_TASKS_PER_PRI_COUNT , +SOF_IPC4_FW_CFG_LL_PRI_COUNT , +SOF_IPC4_FW_CFG_MAX_DP_TASKS_COUNT , +SOF_IPC4_FW_CFG_MAX_LIBS_COUNT , +SOF_IPC4_FW_CFG_SCHEDULER_CONFIG , +SOF_IPC4_FW_CFG_XTAL_FREQ_HZ , +SOF_IPC4_FW_CFG_CLOCKS_CONFIG , +SOF_IPC4_FW_CFG_RESERVED , +SOF_IPC4_FW_CFG_POWER_GATING_POLICY , +SOF_IPC4_FW_CFG_ASSERT_MODE , +}; + +struct sof_ipc4_fw_version { +uint16_t major; +uint16_t minor; +uint16_t hotfix; +uint16_t build; +} __packed; + +/* Reply messages */ + +/* +* IPC4 primary header bit allocation for replies +* bit 0-23: status +* bit 24-28: type: enum sof_ipc4_global_msg if target is SOF_IPC4_FW_GEN_MSG +* enum sof_ipc4_module_type if target is SOF_IPC4_MODULE_MSG +* bit 29: response - sof_ipc4_msg_dir +* bit 30: target - enum sof_ipc4_msg_target +* bit 31: reserved, unused +*/ + +#define SOF_IPC4_REPLY_STATUS GENMASK(23, 0) + +/* Notification messages */ + +/* +* IPC4 primary header bit allocation for notifications +* bit 0-15: notification type specific +* bit 16-23: enum sof_ipc4_notification_type +* bit 24-28: SOF_IPC4_GLB_NOTIFICATION +* bit 29: response - sof_ipc4_msg_dir +* bit 30: target - enum sof_ipc4_msg_target +* bit 31: reserved, unused +*/ + +#define SOF_IPC4_MSG_IS_NOTIFICATION (x) (SOF_IPC4_MSG_TYPE_GET(x) == \ + SOF_IPC4_GLB_NOTIFICATION) + +#define SOF_IPC4_NOTIFICATION_TYPE_SHIFT 16 +#define SOF_IPC4_NOTIFICATION_TYPE_MASK GENMASK(23, 16) +#define SOF_IPC4_NOTIFICATION_TYPE_GET (x) (((x) & SOF_IPC4_NOTIFICATION_TYPE_MASK) >> \ + SOF_IPC4_NOTIFICATION_TYPE_SHIFT) + +/* Value of notification type field - must fit into 8 bits */ +enum sof_ipc4_notification_type { +/* Phrase detected (notification from WoV module) */ +SOF_IPC4_NOTIFY_PHRASE_DETECTED =4 , +/* Event from a resource (pipeline or module instance) */ +SOF_IPC4_NOTIFY_RESOURCE_EVENT , +/* Debug log buffer status changed */ +SOF_IPC4_NOTIFY_LOG_BUFFER_STATUS , +/* Timestamp captured at the link */ +SOF_IPC4_NOTIFY_TIMESTAMP_CAPTURED , +/* FW complete initialization */ +SOF_IPC4_NOTIFY_FW_READY , +/* Audio classifier result (ACA) */ +SOF_IPC4_NOTIFY_FW_AUD_CLASS_RESULT , +/* Exception caught by DSP FW */ +SOF_IPC4_NOTIFY_EXCEPTION_CAUGHT , +/* 11 is skipped by the existing cavs firmware */ +/* Custom module notification */ +SOF_IPC4_NOTIFY_MODULE_NOTIFICATION =12 , +/* 13 is reserved - do not use */ +/* Probe notify data available */ +SOF_IPC4_NOTIFY_PROBE_DATA_AVAILABLE =14 , +/* AM module notifications */ +SOF_IPC4_NOTIFY_ASYNC_MSG_SRVC_MESSAGE , + +SOF_IPC4_NOTIFY_TYPE_LAST , +}; + +struct sof_ipc4_notify_resource_data { +uint32_t resource_type; +uint32_t resource_id; +uint32_t event_type; +uint32_t reserved; +uint32_t data[6 ]; +} __packed__aligned(4) ; + +/** @}*/ + +#endif
Signature · 1 line
2.36.0
Peter Ujfalusi
maintainerPATCH 3/3 ASoC: SOF: ipc4: Add support for mandatory message handling functionality
In reply to Peter UjfalusiIntroduce the initial and mandatory IPC ops support for IPC4 to enable IPC communication with this new IPC protocol.
This patch implements the following ops:tx_msg, rx_msg, set_get_data and get_reply.
--- sound/soc/sof/Makefile | 3 +- sound/soc/sof/ipc4.c | 604 +++++++++++++++++++++++++++++++++++++++ sound/soc/sof/sof-priv.h | 1 + 3 files changed, 607 insertions(+), 1 deletion(-) create mode 100644 sound/soc/sof/ipc4.c
sound/soc/sof/Makefile +2 -1
@@ -2,7 +2,8 @@ snd-sof-objs := core.o ops.o loader.o ipc.o pcm.o pm.o debug.o topology.o\ control.o trace.o iomem-utils.o sof-audio.o stream-ipc.o\ - ipc3-topology.o ipc3-control.o ipc3.o ipc3-pcm.o ipc3-loader.o + ipc3-topology.o ipc3-control.o ipc3.o ipc3-pcm.o ipc3-loader.o\ + ipc4.o ifneq ($(CONFIG_SND_SOC_SOF_CLIENT),) snd-sof-objs += sof-client.o endif
sound/soc/sof/ipc4.c new file +604 -0
604 lines not on this page · raw message
sound/soc/sof/sof-priv.h +1 -0
@@ -768,5 +768,6 @@ static inline int sof_resume_clients(struct snd_sof_dev *sdev)/* Main ops for IPC implementations */ extern const struct sof_ipc_ops ipc3_ops; +extern const struct sof_ipc_ops ipc4_ops;#endif
Signature · 1 line
2.36.0
Mark Brown
maintainerQuoted 8 lines · Peter Ujfalusi
The series adds the basic IPC4 message handling code, implementing the ipc callbacks.
Due to the difference between IPC3 and IPC4 messaging we need to introduce new message container for IPC4, but the SOF internal callbacks and structures can be kept as they were and leaving it for the IPC specific code to handle the differences.[...]
Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next
Thanks!
[1/3] ASoC: SOF: Add rx_data pointer to snd_sof_ipc_msg struct
commit: 84c2dca3c3d4b8e011a2536fc7aaf2a2bdc77972
[2/3] ASoC: SOF: Add initial header file for ipc4
commit: ed85a6e6fe7c01faff4504af9d5569e8ba417999
[3/3] ASoC: SOF: ipc4: Add support for mandatory message handling functionality
commit: ceb89acc4dc8f071f63f8d64442c7a5d768e4c9dAll being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying to this mail.
Thanks,
Mark