1e149ca29SPierre-Louis Bossart /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */ 253e0c72dSLiam Girdwood /* 353e0c72dSLiam Girdwood * This file is provided under a dual BSD/GPLv2 license. When using or 453e0c72dSLiam Girdwood * redistributing this file, you may do so under either license. 553e0c72dSLiam Girdwood * 653e0c72dSLiam Girdwood * Copyright(c) 2018 Intel Corporation. All rights reserved. 753e0c72dSLiam Girdwood */ 853e0c72dSLiam Girdwood 953e0c72dSLiam Girdwood #ifndef __INCLUDE_SOUND_SOF_HEADER_H__ 1053e0c72dSLiam Girdwood #define __INCLUDE_SOUND_SOF_HEADER_H__ 1153e0c72dSLiam Girdwood 1203048217SKuninori Morimoto #include <linux/types.h> 1353e0c72dSLiam Girdwood #include <uapi/sound/sof/abi.h> 1453e0c72dSLiam Girdwood 1553e0c72dSLiam Girdwood /** \addtogroup sof_uapi uAPI 1653e0c72dSLiam Girdwood * SOF uAPI specification. 1753e0c72dSLiam Girdwood * @{ 1853e0c72dSLiam Girdwood */ 1953e0c72dSLiam Girdwood 2053e0c72dSLiam Girdwood /* 2153e0c72dSLiam Girdwood * IPC messages have a prefixed 32 bit identifier made up as follows :- 2253e0c72dSLiam Girdwood * 2353e0c72dSLiam Girdwood * 0xGCCCNNNN where 2453e0c72dSLiam Girdwood * G is global cmd type (4 bits) 2553e0c72dSLiam Girdwood * C is command type (12 bits) 2653e0c72dSLiam Girdwood * I is the ID number (16 bits) - monotonic and overflows 2753e0c72dSLiam Girdwood * 2853e0c72dSLiam Girdwood * This is sent at the start of the IPM message in the mailbox. Messages should 2953e0c72dSLiam Girdwood * not be sent in the doorbell (special exceptions for firmware . 3053e0c72dSLiam Girdwood */ 3153e0c72dSLiam Girdwood 3253e0c72dSLiam Girdwood /* Global Message - Generic */ 3353e0c72dSLiam Girdwood #define SOF_GLB_TYPE_SHIFT 28 34*4aaa06b2SCurtis Malainey #define SOF_GLB_TYPE_MASK (0xfUL << SOF_GLB_TYPE_SHIFT) 3553e0c72dSLiam Girdwood #define SOF_GLB_TYPE(x) ((x) << SOF_GLB_TYPE_SHIFT) 3653e0c72dSLiam Girdwood 3753e0c72dSLiam Girdwood /* Command Message - Generic */ 3853e0c72dSLiam Girdwood #define SOF_CMD_TYPE_SHIFT 16 397c1d0e55SCurtis Malainey #define SOF_CMD_TYPE_MASK (0xfffL << SOF_CMD_TYPE_SHIFT) 4053e0c72dSLiam Girdwood #define SOF_CMD_TYPE(x) ((x) << SOF_CMD_TYPE_SHIFT) 4153e0c72dSLiam Girdwood 4253e0c72dSLiam Girdwood /* Global Message Types */ 4353e0c72dSLiam Girdwood #define SOF_IPC_GLB_REPLY SOF_GLB_TYPE(0x1U) 4453e0c72dSLiam Girdwood #define SOF_IPC_GLB_COMPOUND SOF_GLB_TYPE(0x2U) 4553e0c72dSLiam Girdwood #define SOF_IPC_GLB_TPLG_MSG SOF_GLB_TYPE(0x3U) 4653e0c72dSLiam Girdwood #define SOF_IPC_GLB_PM_MSG SOF_GLB_TYPE(0x4U) 4753e0c72dSLiam Girdwood #define SOF_IPC_GLB_COMP_MSG SOF_GLB_TYPE(0x5U) 4853e0c72dSLiam Girdwood #define SOF_IPC_GLB_STREAM_MSG SOF_GLB_TYPE(0x6U) 4953e0c72dSLiam Girdwood #define SOF_IPC_FW_READY SOF_GLB_TYPE(0x7U) 5053e0c72dSLiam Girdwood #define SOF_IPC_GLB_DAI_MSG SOF_GLB_TYPE(0x8U) 5153e0c72dSLiam Girdwood #define SOF_IPC_GLB_TRACE_MSG SOF_GLB_TYPE(0x9U) 5259be1973SPierre-Louis Bossart #define SOF_IPC_GLB_GDB_DEBUG SOF_GLB_TYPE(0xAU) 5353b22d25SRanjani Sridharan #define SOF_IPC_GLB_TEST_MSG SOF_GLB_TYPE(0xBU) 54f3b433e4SCezary Rojewski #define SOF_IPC_GLB_PROBE SOF_GLB_TYPE(0xCU) 555b10b629SKarol Trzcinski #define SOF_IPC_GLB_DEBUG SOF_GLB_TYPE(0xDU) 5653e0c72dSLiam Girdwood 5753e0c72dSLiam Girdwood /* 5853e0c72dSLiam Girdwood * DSP Command Message Types 5953e0c72dSLiam Girdwood */ 6053e0c72dSLiam Girdwood 6153e0c72dSLiam Girdwood /* topology */ 6253e0c72dSLiam Girdwood #define SOF_IPC_TPLG_COMP_NEW SOF_CMD_TYPE(0x001) 6353e0c72dSLiam Girdwood #define SOF_IPC_TPLG_COMP_FREE SOF_CMD_TYPE(0x002) 6453e0c72dSLiam Girdwood #define SOF_IPC_TPLG_COMP_CONNECT SOF_CMD_TYPE(0x003) 6553e0c72dSLiam Girdwood #define SOF_IPC_TPLG_PIPE_NEW SOF_CMD_TYPE(0x010) 6653e0c72dSLiam Girdwood #define SOF_IPC_TPLG_PIPE_FREE SOF_CMD_TYPE(0x011) 6753e0c72dSLiam Girdwood #define SOF_IPC_TPLG_PIPE_CONNECT SOF_CMD_TYPE(0x012) 6853e0c72dSLiam Girdwood #define SOF_IPC_TPLG_PIPE_COMPLETE SOF_CMD_TYPE(0x013) 6953e0c72dSLiam Girdwood #define SOF_IPC_TPLG_BUFFER_NEW SOF_CMD_TYPE(0x020) 7053e0c72dSLiam Girdwood #define SOF_IPC_TPLG_BUFFER_FREE SOF_CMD_TYPE(0x021) 7153e0c72dSLiam Girdwood 7253e0c72dSLiam Girdwood /* PM */ 7353e0c72dSLiam Girdwood #define SOF_IPC_PM_CTX_SAVE SOF_CMD_TYPE(0x001) 7453e0c72dSLiam Girdwood #define SOF_IPC_PM_CTX_RESTORE SOF_CMD_TYPE(0x002) 7553e0c72dSLiam Girdwood #define SOF_IPC_PM_CTX_SIZE SOF_CMD_TYPE(0x003) 7653e0c72dSLiam Girdwood #define SOF_IPC_PM_CLK_SET SOF_CMD_TYPE(0x004) 7753e0c72dSLiam Girdwood #define SOF_IPC_PM_CLK_GET SOF_CMD_TYPE(0x005) 7853e0c72dSLiam Girdwood #define SOF_IPC_PM_CLK_REQ SOF_CMD_TYPE(0x006) 7953e0c72dSLiam Girdwood #define SOF_IPC_PM_CORE_ENABLE SOF_CMD_TYPE(0x007) 8010992004SKeyon Jie #define SOF_IPC_PM_GATE SOF_CMD_TYPE(0x008) 8153e0c72dSLiam Girdwood 8253e0c72dSLiam Girdwood /* component runtime config - multiple different types */ 8353e0c72dSLiam Girdwood #define SOF_IPC_COMP_SET_VALUE SOF_CMD_TYPE(0x001) 8453e0c72dSLiam Girdwood #define SOF_IPC_COMP_GET_VALUE SOF_CMD_TYPE(0x002) 8553e0c72dSLiam Girdwood #define SOF_IPC_COMP_SET_DATA SOF_CMD_TYPE(0x003) 8653e0c72dSLiam Girdwood #define SOF_IPC_COMP_GET_DATA SOF_CMD_TYPE(0x004) 8759be1973SPierre-Louis Bossart #define SOF_IPC_COMP_NOTIFICATION SOF_CMD_TYPE(0x005) 8853e0c72dSLiam Girdwood 8953e0c72dSLiam Girdwood /* DAI messages */ 9053e0c72dSLiam Girdwood #define SOF_IPC_DAI_CONFIG SOF_CMD_TYPE(0x001) 9153e0c72dSLiam Girdwood #define SOF_IPC_DAI_LOOPBACK SOF_CMD_TYPE(0x002) 9253e0c72dSLiam Girdwood 9353e0c72dSLiam Girdwood /* stream */ 9453e0c72dSLiam Girdwood #define SOF_IPC_STREAM_PCM_PARAMS SOF_CMD_TYPE(0x001) 9553e0c72dSLiam Girdwood #define SOF_IPC_STREAM_PCM_PARAMS_REPLY SOF_CMD_TYPE(0x002) 9653e0c72dSLiam Girdwood #define SOF_IPC_STREAM_PCM_FREE SOF_CMD_TYPE(0x003) 9753e0c72dSLiam Girdwood #define SOF_IPC_STREAM_TRIG_START SOF_CMD_TYPE(0x004) 9853e0c72dSLiam Girdwood #define SOF_IPC_STREAM_TRIG_STOP SOF_CMD_TYPE(0x005) 9953e0c72dSLiam Girdwood #define SOF_IPC_STREAM_TRIG_PAUSE SOF_CMD_TYPE(0x006) 10053e0c72dSLiam Girdwood #define SOF_IPC_STREAM_TRIG_RELEASE SOF_CMD_TYPE(0x007) 10153e0c72dSLiam Girdwood #define SOF_IPC_STREAM_TRIG_DRAIN SOF_CMD_TYPE(0x008) 10253e0c72dSLiam Girdwood #define SOF_IPC_STREAM_TRIG_XRUN SOF_CMD_TYPE(0x009) 10353e0c72dSLiam Girdwood #define SOF_IPC_STREAM_POSITION SOF_CMD_TYPE(0x00a) 10453e0c72dSLiam Girdwood #define SOF_IPC_STREAM_VORBIS_PARAMS SOF_CMD_TYPE(0x010) 10553e0c72dSLiam Girdwood #define SOF_IPC_STREAM_VORBIS_FREE SOF_CMD_TYPE(0x011) 10653e0c72dSLiam Girdwood 107f3b433e4SCezary Rojewski /* probe */ 108f3b433e4SCezary Rojewski #define SOF_IPC_PROBE_INIT SOF_CMD_TYPE(0x001) 109f3b433e4SCezary Rojewski #define SOF_IPC_PROBE_DEINIT SOF_CMD_TYPE(0x002) 110f3b433e4SCezary Rojewski #define SOF_IPC_PROBE_DMA_ADD SOF_CMD_TYPE(0x003) 111f3b433e4SCezary Rojewski #define SOF_IPC_PROBE_DMA_INFO SOF_CMD_TYPE(0x004) 112f3b433e4SCezary Rojewski #define SOF_IPC_PROBE_DMA_REMOVE SOF_CMD_TYPE(0x005) 113f3b433e4SCezary Rojewski #define SOF_IPC_PROBE_POINT_ADD SOF_CMD_TYPE(0x006) 114f3b433e4SCezary Rojewski #define SOF_IPC_PROBE_POINT_INFO SOF_CMD_TYPE(0x007) 115f3b433e4SCezary Rojewski #define SOF_IPC_PROBE_POINT_REMOVE SOF_CMD_TYPE(0x008) 116f3b433e4SCezary Rojewski 11753b22d25SRanjani Sridharan /* trace */ 11853e0c72dSLiam Girdwood #define SOF_IPC_TRACE_DMA_PARAMS SOF_CMD_TYPE(0x001) 11953e0c72dSLiam Girdwood #define SOF_IPC_TRACE_DMA_POSITION SOF_CMD_TYPE(0x002) 120e3adc949SBard liao #define SOF_IPC_TRACE_DMA_PARAMS_EXT SOF_CMD_TYPE(0x003) 1218f6cfbb6SKarol Trzcinski #define SOF_IPC_TRACE_FILTER_UPDATE SOF_CMD_TYPE(0x004) /**< ABI3.17 */ 122168eed44SRanjani Sridharan #define SOF_IPC_TRACE_DMA_FREE SOF_CMD_TYPE(0x005) /**< ABI3.20 */ 12353e0c72dSLiam Girdwood 1245b10b629SKarol Trzcinski /* debug */ 1255b10b629SKarol Trzcinski #define SOF_IPC_DEBUG_MEM_USAGE SOF_CMD_TYPE(0x001) 1265b10b629SKarol Trzcinski 1276dd95895SKarol Trzcinski /* test */ 12853b22d25SRanjani Sridharan #define SOF_IPC_TEST_IPC_FLOOD SOF_CMD_TYPE(0x001) 12953b22d25SRanjani Sridharan 13053e0c72dSLiam Girdwood /* Get message component id */ 13153e0c72dSLiam Girdwood #define SOF_IPC_MESSAGE_ID(x) ((x) & 0xffff) 13253e0c72dSLiam Girdwood 13353e0c72dSLiam Girdwood /* maximum message size for mailbox Tx/Rx */ 13453e0c72dSLiam Girdwood #define SOF_IPC_MSG_MAX_SIZE 384 13553e0c72dSLiam Girdwood 13653e0c72dSLiam Girdwood /* 13753e0c72dSLiam Girdwood * Structure Header - Header for all IPC structures except command structs. 13853e0c72dSLiam Girdwood * The size can be greater than the structure size and that means there is 13953e0c72dSLiam Girdwood * extended bespoke data beyond the end of the structure including variable 14053e0c72dSLiam Girdwood * arrays. 14153e0c72dSLiam Girdwood */ 14253e0c72dSLiam Girdwood 14353e0c72dSLiam Girdwood struct sof_ipc_hdr { 14453e0c72dSLiam Girdwood uint32_t size; /**< size of structure */ 14553e0c72dSLiam Girdwood } __packed; 14653e0c72dSLiam Girdwood 14753e0c72dSLiam Girdwood /* 14853e0c72dSLiam Girdwood * Command Header - Header for all IPC commands. Identifies IPC message. 14953e0c72dSLiam Girdwood * The size can be greater than the structure size and that means there is 15053e0c72dSLiam Girdwood * extended bespoke data beyond the end of the structure including variable 15153e0c72dSLiam Girdwood * arrays. 15253e0c72dSLiam Girdwood */ 15353e0c72dSLiam Girdwood 15453e0c72dSLiam Girdwood struct sof_ipc_cmd_hdr { 15553e0c72dSLiam Girdwood uint32_t size; /**< size of structure */ 15653e0c72dSLiam Girdwood uint32_t cmd; /**< SOF_IPC_GLB_ + cmd */ 15753e0c72dSLiam Girdwood } __packed; 15853e0c72dSLiam Girdwood 15953e0c72dSLiam Girdwood /* 16053e0c72dSLiam Girdwood * Generic reply message. Some commands override this with their own reply 16153e0c72dSLiam Girdwood * types that must include this at start. 16253e0c72dSLiam Girdwood */ 16353e0c72dSLiam Girdwood struct sof_ipc_reply { 16453e0c72dSLiam Girdwood struct sof_ipc_cmd_hdr hdr; 16553e0c72dSLiam Girdwood int32_t error; /**< negative error numbers */ 16653e0c72dSLiam Girdwood } __packed; 16753e0c72dSLiam Girdwood 16853e0c72dSLiam Girdwood /* 16953e0c72dSLiam Girdwood * Compound commands - SOF_IPC_GLB_COMPOUND. 17053e0c72dSLiam Girdwood * 17153e0c72dSLiam Girdwood * Compound commands are sent to the DSP as a single IPC operation. The 17253e0c72dSLiam Girdwood * commands are split into blocks and each block has a header. This header 17353e0c72dSLiam Girdwood * identifies the command type and the number of commands before the next 17453e0c72dSLiam Girdwood * header. 17553e0c72dSLiam Girdwood */ 17653e0c72dSLiam Girdwood 17753e0c72dSLiam Girdwood struct sof_ipc_compound_hdr { 17853e0c72dSLiam Girdwood struct sof_ipc_cmd_hdr hdr; 17953e0c72dSLiam Girdwood uint32_t count; /**< count of 0 means end of compound sequence */ 18053e0c72dSLiam Girdwood } __packed; 18153e0c72dSLiam Girdwood 18214104eb6SKai Vehmanen /** 18314104eb6SKai Vehmanen * OOPS header architecture specific data. 18414104eb6SKai Vehmanen */ 18514104eb6SKai Vehmanen struct sof_ipc_dsp_oops_arch_hdr { 18614104eb6SKai Vehmanen uint32_t arch; /* Identifier of architecture */ 18714104eb6SKai Vehmanen uint32_t totalsize; /* Total size of oops message */ 18814104eb6SKai Vehmanen } __packed; 18914104eb6SKai Vehmanen 19014104eb6SKai Vehmanen /** 19114104eb6SKai Vehmanen * OOPS header platform specific data. 19214104eb6SKai Vehmanen */ 19314104eb6SKai Vehmanen struct sof_ipc_dsp_oops_plat_hdr { 19414104eb6SKai Vehmanen uint32_t configidhi; /* ConfigID hi 32bits */ 19514104eb6SKai Vehmanen uint32_t configidlo; /* ConfigID lo 32bits */ 19614104eb6SKai Vehmanen uint32_t numaregs; /* Special regs num */ 19714104eb6SKai Vehmanen uint32_t stackoffset; /* Offset to stack pointer from beginning of 19814104eb6SKai Vehmanen * oops message 19914104eb6SKai Vehmanen */ 20014104eb6SKai Vehmanen uint32_t stackptr; /* Stack ptr */ 20114104eb6SKai Vehmanen } __packed; 20214104eb6SKai Vehmanen 20353e0c72dSLiam Girdwood /** @}*/ 20453e0c72dSLiam Girdwood 20553e0c72dSLiam Girdwood #endif 206