include/sound/sof/topology.h

   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_TOPOLOGY_H__
  10 #define __INCLUDE_SOUND_SOF_TOPOLOGY_H__
  11
  12 #include <sound/sof/header.h>
  13
  14 /*
  15  * Component
  16  */
  17
  18 /* types of component */
  19 enum sof_comp_type {
  20         SOF_COMP_NONE = 0,
  21         SOF_COMP_HOST,
  22         SOF_COMP_DAI,
  23         SOF_COMP_SG_HOST,       /**< scatter gather variant */
  24         SOF_COMP_SG_DAI,        /**< scatter gather variant */
  25         SOF_COMP_VOLUME,
  26         SOF_COMP_MIXER,
  27         SOF_COMP_MUX,
  28         SOF_COMP_SRC,
  29         SOF_COMP_SPLITTER,
  30         SOF_COMP_TONE,
  31         SOF_COMP_SWITCH,
  32         SOF_COMP_BUFFER,
  33         SOF_COMP_EQ_IIR,
  34         SOF_COMP_EQ_FIR,
  35         SOF_COMP_KEYWORD_DETECT,
  36         SOF_COMP_KPB,                   /* A key phrase buffer component */
  37         SOF_COMP_SELECTOR,              /**< channel selector component */
  38         SOF_COMP_DEMUX,
  39         SOF_COMP_ASRC,          /**< Asynchronous sample rate converter */
  40         SOF_COMP_DCBLOCK,
  41         SOF_COMP_SMART_AMP,             /**< smart amplifier component */
  42         /* keep FILEREAD/FILEWRITE as the last ones */
  43         SOF_COMP_FILEREAD = 10000,      /**< host test based file IO */
  44         SOF_COMP_FILEWRITE = 10001,     /**< host test based file IO */
  45 };
  46
  47 /* XRUN action for component */
  48 #define SOF_XRUN_STOP           1       /**< stop stream */
  49 #define SOF_XRUN_UNDER_ZERO     2       /**< send 0s to sink */
  50 #define SOF_XRUN_OVER_NULL      4       /**< send data to NULL */
  51
  52 /* create new generic component - SOF_IPC_TPLG_COMP_NEW */
  53 struct sof_ipc_comp {
  54         struct sof_ipc_cmd_hdr hdr;
  55         uint32_t id;
  56         enum sof_comp_type type;
  57         uint32_t pipeline_id;
  58         uint32_t core;
  59
  60         /* extended data length, 0 if no extended data */
  61         uint32_t ext_data_length;
  62 } __packed;
  63
  64 /*
  65  * Component Buffers
  66  */
  67
  68 /*
  69  * SOF memory capabilities, add new ones at the end
  70  */
  71 #define SOF_MEM_CAPS_RAM                        (1 << 0)
  72 #define SOF_MEM_CAPS_ROM                        (1 << 1)
  73 #define SOF_MEM_CAPS_EXT                        (1 << 2) /**< external */
  74 #define SOF_MEM_CAPS_LP                 (1 << 3) /**< low power */
  75 #define SOF_MEM_CAPS_HP                 (1 << 4) /**< high performance */
  76 #define SOF_MEM_CAPS_DMA                        (1 << 5) /**< DMA'able */
  77 #define SOF_MEM_CAPS_CACHE                      (1 << 6) /**< cacheable */
  78 #define SOF_MEM_CAPS_EXEC                       (1 << 7) /**< executable */
  79
  80 /*
  81  * overrun will cause ring buffer overwrite, instead of XRUN.
  82  */
  83 #define SOF_BUF_OVERRUN_PERMITTED       BIT(0)
  84
  85 /*
  86  * underrun will cause readback of 0s, instead of XRUN.
  87  */
  88 #define SOF_BUF_UNDERRUN_PERMITTED      BIT(1)
  89
  90 /* the UUID size in bytes, shared between FW and host */
  91 #define SOF_UUID_SIZE   16
  92
  93 /* create new component buffer - SOF_IPC_TPLG_BUFFER_NEW */
  94 struct sof_ipc_buffer {
  95         struct sof_ipc_comp comp;
  96         uint32_t size;          /**< buffer size in bytes */
  97         uint32_t caps;          /**< SOF_MEM_CAPS_ */
  98         uint32_t flags;         /**< SOF_BUF_ flags defined above */
  99         uint32_t reserved;      /**< reserved for future use */
 100 } __packed;
 101
 102 /* generic component config data - must always be after struct sof_ipc_comp */
 103 struct sof_ipc_comp_config {
 104         struct sof_ipc_cmd_hdr hdr;
 105         uint32_t periods_sink;  /**< 0 means variable */
 106         uint32_t periods_source;/**< 0 means variable */
 107         uint32_t reserved1;     /**< reserved */
 108         uint32_t frame_fmt;     /**< SOF_IPC_FRAME_ */
 109         uint32_t xrun_action;
 110
 111         /* reserved for future use */
 112         uint32_t reserved[2];
 113 } __packed;
 114
 115 /* generic host component */
 116 struct sof_ipc_comp_host {
 117         struct sof_ipc_comp comp;
 118         struct sof_ipc_comp_config config;
 119         uint32_t direction;     /**< SOF_IPC_STREAM_ */
 120         uint32_t no_irq;        /**< don't send periodic IRQ to host/DSP */
 121         uint32_t dmac_config; /**< DMA engine specific */
 122 }  __packed;
 123
 124 /* generic DAI component */
 125 struct sof_ipc_comp_dai {
 126         struct sof_ipc_comp comp;
 127         struct sof_ipc_comp_config config;
 128         uint32_t direction;     /**< SOF_IPC_STREAM_ */
 129         uint32_t dai_index;     /**< index of this type dai */
 130         uint32_t type;          /**< DAI type - SOF_DAI_ */
 131         uint32_t reserved;      /**< reserved */
 132 }  __packed;
 133
 134 /* generic mixer component */
 135 struct sof_ipc_comp_mixer {
 136         struct sof_ipc_comp comp;
 137         struct sof_ipc_comp_config config;
 138 }  __packed;
 139
 140 /* volume ramping types */
 141 enum sof_volume_ramp {
 142         SOF_VOLUME_LINEAR       = 0,
 143         SOF_VOLUME_LOG,
 144         SOF_VOLUME_LINEAR_ZC,
 145         SOF_VOLUME_LOG_ZC,
 146 };
 147
 148 /* generic volume component */
 149 struct sof_ipc_comp_volume {
 150         struct sof_ipc_comp comp;
 151         struct sof_ipc_comp_config config;
 152         uint32_t channels;
 153         uint32_t min_value;
 154         uint32_t max_value;
 155         uint32_t ramp;          /**< SOF_VOLUME_ */
 156         uint32_t initial_ramp;  /**< ramp space in ms */
 157 }  __packed;
 158
 159 /* generic SRC component */
 160 struct sof_ipc_comp_src {
 161         struct sof_ipc_comp comp;
 162         struct sof_ipc_comp_config config;
 163         /* either source or sink rate must be non zero */
 164         uint32_t source_rate;   /**< source rate or 0 for variable */
 165         uint32_t sink_rate;     /**< sink rate or 0 for variable */
 166         uint32_t rate_mask;     /**< SOF_RATE_ supported rates */
 167 } __packed;
 168
 169 /* generic ASRC component */
 170 struct sof_ipc_comp_asrc {
 171         struct sof_ipc_comp comp;
 172         struct sof_ipc_comp_config config;
 173         /* either source or sink rate must be non zero */
 174         uint32_t source_rate;           /**< Define fixed source rate or */
 175                                         /**< use 0 to indicate need to get */
 176                                         /**< the rate from stream */
 177         uint32_t sink_rate;             /**< Define fixed sink rate or */
 178                                         /**< use 0 to indicate need to get */
 179                                         /**< the rate from stream */
 180         uint32_t asynchronous_mode;     /**< synchronous 0, asynchronous 1 */
 181                                         /**< When 1 the ASRC tracks and */
 182                                         /**< compensates for drift. */
 183         uint32_t operation_mode;        /**< push 0, pull 1, In push mode the */
 184                                         /**< ASRC consumes a defined number */
 185                                         /**< of frames at input, with varying */
 186                                         /**< number of frames at output. */
 187                                         /**< In pull mode the ASRC outputs */
 188                                         /**< a defined number of frames while */
 189                                         /**< number of input frames varies. */
 190
 191         /* reserved for future use */
 192         uint32_t reserved[4];
 193 } __attribute__((packed));
 194
 195 /* generic MUX component */
 196 struct sof_ipc_comp_mux {
 197         struct sof_ipc_comp comp;
 198         struct sof_ipc_comp_config config;
 199 } __packed;
 200
 201 /* generic tone generator component */
 202 struct sof_ipc_comp_tone {
 203         struct sof_ipc_comp comp;
 204         struct sof_ipc_comp_config config;
 205         int32_t sample_rate;
 206         int32_t frequency;
 207         int32_t amplitude;
 208         int32_t freq_mult;
 209         int32_t ampl_mult;
 210         int32_t length;
 211         int32_t period;
 212         int32_t repeats;
 213         int32_t ramp_step;
 214 } __packed;
 215
 216 /** \brief Types of processing components */
 217 enum sof_ipc_process_type {
 218         SOF_PROCESS_NONE = 0,           /**< None */
 219         SOF_PROCESS_EQFIR,              /**< Intel FIR */
 220         SOF_PROCESS_EQIIR,              /**< Intel IIR */
 221         SOF_PROCESS_KEYWORD_DETECT,     /**< Keyword Detection */
 222         SOF_PROCESS_KPB,                /**< KeyPhrase Buffer Manager */
 223         SOF_PROCESS_CHAN_SELECTOR,      /**< Channel Selector */
 224         SOF_PROCESS_MUX,
 225         SOF_PROCESS_DEMUX,
 226         SOF_PROCESS_DCBLOCK,
 227         SOF_PROCESS_SMART_AMP,  /**< Smart Amplifier */
 228 };
 229
 230 /* generic "effect", "codec" or proprietary processing component */
 231 struct sof_ipc_comp_process {
 232         struct sof_ipc_comp comp;
 233         struct sof_ipc_comp_config config;
 234         uint32_t size;  /**< size of bespoke data section in bytes */
 235         uint32_t type;  /**< sof_ipc_process_type */
 236
 237         /* reserved for future use */
 238         uint32_t reserved[7];
 239
 240         uint8_t data[0];
 241 } __packed;
 242
 243 /* frees components, buffers and pipelines
 244  * SOF_IPC_TPLG_COMP_FREE, SOF_IPC_TPLG_PIPE_FREE, SOF_IPC_TPLG_BUFFER_FREE
 245  */
 246 struct sof_ipc_free {
 247         struct sof_ipc_cmd_hdr hdr;
 248         uint32_t id;
 249 } __packed;
 250
 251 struct sof_ipc_comp_reply {
 252         struct sof_ipc_reply rhdr;
 253         uint32_t id;
 254         uint32_t offset;
 255 } __packed;
 256
 257 /*
 258  * Pipeline
 259  */
 260
 261 /** \brief Types of pipeline scheduling time domains */
 262 enum sof_ipc_pipe_sched_time_domain {
 263         SOF_TIME_DOMAIN_DMA = 0,        /**< DMA interrupt */
 264         SOF_TIME_DOMAIN_TIMER,          /**< Timer interrupt */
 265 };
 266
 267 /* new pipeline - SOF_IPC_TPLG_PIPE_NEW */
 268 struct sof_ipc_pipe_new {
 269         struct sof_ipc_cmd_hdr hdr;
 270         uint32_t comp_id;       /**< component id for pipeline */
 271         uint32_t pipeline_id;   /**< pipeline id */
 272         uint32_t sched_id;      /**< Scheduling component id */
 273         uint32_t core;          /**< core we run on */
 274         uint32_t period;        /**< execution period in us*/
 275         uint32_t priority;      /**< priority level 0 (low) to 10 (max) */
 276         uint32_t period_mips;   /**< worst case instruction count per period */
 277         uint32_t frames_per_sched;/**< output frames of pipeline, 0 is variable */
 278         uint32_t xrun_limit_usecs; /**< report xruns greater than limit */
 279         uint32_t time_domain;   /**< scheduling time domain */
 280 }  __packed;
 281
 282 /* pipeline construction complete - SOF_IPC_TPLG_PIPE_COMPLETE */
 283 struct sof_ipc_pipe_ready {
 284         struct sof_ipc_cmd_hdr hdr;
 285         uint32_t comp_id;
 286 }  __packed;
 287
 288 struct sof_ipc_pipe_free {
 289         struct sof_ipc_cmd_hdr hdr;
 290         uint32_t comp_id;
 291 }  __packed;
 292
 293 /* connect two components in pipeline - SOF_IPC_TPLG_COMP_CONNECT */
 294 struct sof_ipc_pipe_comp_connect {
 295         struct sof_ipc_cmd_hdr hdr;
 296         uint32_t source_id;
 297         uint32_t sink_id;
 298 }  __packed;
 299
 300 /* external events */
 301 enum sof_event_types {
 302         SOF_EVENT_NONE = 0,
 303         SOF_KEYWORD_DETECT_DAPM_EVENT,
 304 };
 305
 306 /* extended data struct for UUID components */
 307 struct sof_ipc_comp_ext {
 308         uint8_t uuid[SOF_UUID_SIZE];
 309 }  __packed;
 310
 311 #endif