1/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */ 2/* 3 * This file is provided under a dual BSD/GPLv2 license. When using or 4 * redistributing this file, you may do so under either license. 5 * 6 * Copyright(c) 2018 Intel Corporation. All rights reserved. 7 */ 8 9#ifndef __INCLUDE_SOUND_SOF_HEADER_H__ 10#define __INCLUDE_SOUND_SOF_HEADER_H__ 11 12#include <linux/types.h> 13#include <uapi/sound/sof/abi.h> 14 15/** \addtogroup sof_uapi uAPI 16 * SOF uAPI specification. 17 * @{ 18 */ 19 20/* 21 * IPC messages have a prefixed 32 bit identifier made up as follows :- 22 * 23 * 0xGCCCNNNN where 24 * G is global cmd type (4 bits) 25 * C is command type (12 bits) 26 * I is the ID number (16 bits) - monotonic and overflows 27 * 28 * This is sent at the start of the IPM message in the mailbox. Messages should 29 * not be sent in the doorbell (special exceptions for firmware . 30 */ 31 32/* Global Message - Generic */ 33#define SOF_GLB_TYPE_SHIFT 28 34#define SOF_GLB_TYPE_MASK (0xfL << SOF_GLB_TYPE_SHIFT) 35#define SOF_GLB_TYPE(x) ((x) << SOF_GLB_TYPE_SHIFT) 36 37/* Command Message - Generic */ 38#define SOF_CMD_TYPE_SHIFT 16 39#define SOF_CMD_TYPE_MASK (0xfffL << SOF_CMD_TYPE_SHIFT) 40#define SOF_CMD_TYPE(x) ((x) << SOF_CMD_TYPE_SHIFT) 41 42/* Global Message Types */ 43#define SOF_IPC_GLB_REPLY SOF_GLB_TYPE(0x1U) 44#define SOF_IPC_GLB_COMPOUND SOF_GLB_TYPE(0x2U) 45#define SOF_IPC_GLB_TPLG_MSG SOF_GLB_TYPE(0x3U) 46#define SOF_IPC_GLB_PM_MSG SOF_GLB_TYPE(0x4U) 47#define SOF_IPC_GLB_COMP_MSG SOF_GLB_TYPE(0x5U) 48#define SOF_IPC_GLB_STREAM_MSG SOF_GLB_TYPE(0x6U) 49#define SOF_IPC_FW_READY SOF_GLB_TYPE(0x7U) 50#define SOF_IPC_GLB_DAI_MSG SOF_GLB_TYPE(0x8U) 51#define SOF_IPC_GLB_TRACE_MSG SOF_GLB_TYPE(0x9U) 52#define SOF_IPC_GLB_GDB_DEBUG SOF_GLB_TYPE(0xAU) 53#define SOF_IPC_GLB_TEST_MSG SOF_GLB_TYPE(0xBU) 54#define SOF_IPC_GLB_PROBE SOF_GLB_TYPE(0xCU) 55#define SOF_IPC_GLB_DEBUG SOF_GLB_TYPE(0xDU) 56 57/* 58 * DSP Command Message Types 59 */ 60 61/* topology */ 62#define SOF_IPC_TPLG_COMP_NEW SOF_CMD_TYPE(0x001) 63#define SOF_IPC_TPLG_COMP_FREE SOF_CMD_TYPE(0x002) 64#define SOF_IPC_TPLG_COMP_CONNECT SOF_CMD_TYPE(0x003) 65#define SOF_IPC_TPLG_PIPE_NEW SOF_CMD_TYPE(0x010) 66#define SOF_IPC_TPLG_PIPE_FREE SOF_CMD_TYPE(0x011) 67#define SOF_IPC_TPLG_PIPE_CONNECT SOF_CMD_TYPE(0x012) 68#define SOF_IPC_TPLG_PIPE_COMPLETE SOF_CMD_TYPE(0x013) 69#define SOF_IPC_TPLG_BUFFER_NEW SOF_CMD_TYPE(0x020) 70#define SOF_IPC_TPLG_BUFFER_FREE SOF_CMD_TYPE(0x021) 71 72/* PM */ 73#define SOF_IPC_PM_CTX_SAVE SOF_CMD_TYPE(0x001) 74#define SOF_IPC_PM_CTX_RESTORE SOF_CMD_TYPE(0x002) 75#define SOF_IPC_PM_CTX_SIZE SOF_CMD_TYPE(0x003) 76#define SOF_IPC_PM_CLK_SET SOF_CMD_TYPE(0x004) 77#define SOF_IPC_PM_CLK_GET SOF_CMD_TYPE(0x005) 78#define SOF_IPC_PM_CLK_REQ SOF_CMD_TYPE(0x006) 79#define SOF_IPC_PM_CORE_ENABLE SOF_CMD_TYPE(0x007) 80#define SOF_IPC_PM_GATE SOF_CMD_TYPE(0x008) 81 82/* component runtime config - multiple different types */ 83#define SOF_IPC_COMP_SET_VALUE SOF_CMD_TYPE(0x001) 84#define SOF_IPC_COMP_GET_VALUE SOF_CMD_TYPE(0x002) 85#define SOF_IPC_COMP_SET_DATA SOF_CMD_TYPE(0x003) 86#define SOF_IPC_COMP_GET_DATA SOF_CMD_TYPE(0x004) 87#define SOF_IPC_COMP_NOTIFICATION SOF_CMD_TYPE(0x005) 88 89/* DAI messages */ 90#define SOF_IPC_DAI_CONFIG SOF_CMD_TYPE(0x001) 91#define SOF_IPC_DAI_LOOPBACK SOF_CMD_TYPE(0x002) 92 93/* stream */ 94#define SOF_IPC_STREAM_PCM_PARAMS SOF_CMD_TYPE(0x001) 95#define SOF_IPC_STREAM_PCM_PARAMS_REPLY SOF_CMD_TYPE(0x002) 96#define SOF_IPC_STREAM_PCM_FREE SOF_CMD_TYPE(0x003) 97#define SOF_IPC_STREAM_TRIG_START SOF_CMD_TYPE(0x004) 98#define SOF_IPC_STREAM_TRIG_STOP SOF_CMD_TYPE(0x005) 99#define SOF_IPC_STREAM_TRIG_PAUSE SOF_CMD_TYPE(0x006) 100#define SOF_IPC_STREAM_TRIG_RELEASE SOF_CMD_TYPE(0x007) 101#define SOF_IPC_STREAM_TRIG_DRAIN SOF_CMD_TYPE(0x008) 102#define SOF_IPC_STREAM_TRIG_XRUN SOF_CMD_TYPE(0x009) 103#define SOF_IPC_STREAM_POSITION SOF_CMD_TYPE(0x00a) 104#define SOF_IPC_STREAM_VORBIS_PARAMS SOF_CMD_TYPE(0x010) 105#define SOF_IPC_STREAM_VORBIS_FREE SOF_CMD_TYPE(0x011) 106 107/* probe */ 108#define SOF_IPC_PROBE_INIT SOF_CMD_TYPE(0x001) 109#define SOF_IPC_PROBE_DEINIT SOF_CMD_TYPE(0x002) 110#define SOF_IPC_PROBE_DMA_ADD SOF_CMD_TYPE(0x003) 111#define SOF_IPC_PROBE_DMA_INFO SOF_CMD_TYPE(0x004) 112#define SOF_IPC_PROBE_DMA_REMOVE SOF_CMD_TYPE(0x005) 113#define SOF_IPC_PROBE_POINT_ADD SOF_CMD_TYPE(0x006) 114#define SOF_IPC_PROBE_POINT_INFO SOF_CMD_TYPE(0x007) 115#define SOF_IPC_PROBE_POINT_REMOVE SOF_CMD_TYPE(0x008) 116 117/* trace */ 118#define SOF_IPC_TRACE_DMA_PARAMS SOF_CMD_TYPE(0x001) 119#define SOF_IPC_TRACE_DMA_POSITION SOF_CMD_TYPE(0x002) 120#define SOF_IPC_TRACE_DMA_PARAMS_EXT SOF_CMD_TYPE(0x003) 121#define SOF_IPC_TRACE_FILTER_UPDATE SOF_CMD_TYPE(0x004) /**< ABI3.17 */ 122 123/* debug */ 124#define SOF_IPC_DEBUG_MEM_USAGE SOF_CMD_TYPE(0x001) 125 126/* test */ 127#define SOF_IPC_TEST_IPC_FLOOD SOF_CMD_TYPE(0x001) 128 129/* Get message component id */ 130#define SOF_IPC_MESSAGE_ID(x) ((x) & 0xffff) 131 132/* maximum message size for mailbox Tx/Rx */ 133#define SOF_IPC_MSG_MAX_SIZE 384 134 135/* 136 * Structure Header - Header for all IPC structures except command structs. 137 * The size can be greater than the structure size and that means there is 138 * extended bespoke data beyond the end of the structure including variable 139 * arrays. 140 */ 141 142struct sof_ipc_hdr { 143 uint32_t size; /**< size of structure */ 144} __packed; 145 146/* 147 * Command Header - Header for all IPC commands. Identifies IPC message. 148 * The size can be greater than the structure size and that means there is 149 * extended bespoke data beyond the end of the structure including variable 150 * arrays. 151 */ 152 153struct sof_ipc_cmd_hdr { 154 uint32_t size; /**< size of structure */ 155 uint32_t cmd; /**< SOF_IPC_GLB_ + cmd */ 156} __packed; 157 158/* 159 * Generic reply message. Some commands override this with their own reply 160 * types that must include this at start. 161 */ 162struct sof_ipc_reply { 163 struct sof_ipc_cmd_hdr hdr; 164 int32_t error; /**< negative error numbers */ 165} __packed; 166 167/* 168 * Compound commands - SOF_IPC_GLB_COMPOUND. 169 * 170 * Compound commands are sent to the DSP as a single IPC operation. The 171 * commands are split into blocks and each block has a header. This header 172 * identifies the command type and the number of commands before the next 173 * header. 174 */ 175 176struct sof_ipc_compound_hdr { 177 struct sof_ipc_cmd_hdr hdr; 178 uint32_t count; /**< count of 0 means end of compound sequence */ 179} __packed; 180 181/** 182 * OOPS header architecture specific data. 183 */ 184struct sof_ipc_dsp_oops_arch_hdr { 185 uint32_t arch; /* Identifier of architecture */ 186 uint32_t totalsize; /* Total size of oops message */ 187} __packed; 188 189/** 190 * OOPS header platform specific data. 191 */ 192struct sof_ipc_dsp_oops_plat_hdr { 193 uint32_t configidhi; /* ConfigID hi 32bits */ 194 uint32_t configidlo; /* ConfigID lo 32bits */ 195 uint32_t numaregs; /* Special regs num */ 196 uint32_t stackoffset; /* Offset to stack pointer from beginning of 197 * oops message 198 */ 199 uint32_t stackptr; /* Stack ptr */ 200} __packed; 201 202/** @}*/ 203 204#endif 205