Sound Open Firmware
Loading...
Searching...
No Matches
topology.h File Reference

IPC definitions. More...

Include dependency graph for topology.h:

Go to the source code of this file.

Data Structures

struct  sof_ipc_comp
struct  sof_ipc_buffer
struct  sof_ipc_comp_config
struct  sof_ipc_comp_host
struct  sof_ipc_comp_dai
struct  sof_ipc_comp_mixer
struct  sof_ipc_comp_volume
struct  sof_ipc_comp_src
struct  sof_ipc_comp_asrc
struct  sof_ipc_comp_mux
struct  sof_ipc_comp_tone
struct  sof_ipc_comp_process
struct  sof_ipc_comp_file
struct  sof_ipc_free
struct  sof_ipc_comp_reply
struct  sof_ipc_pipe_new
struct  sof_ipc_pipe_ready
struct  sof_ipc_pipe_free
struct  sof_ipc_pipe_comp_connect
struct  sof_ipc_comp_ext

Macros

#define SOF_XRUN_STOP   1
 stop stream
#define SOF_XRUN_UNDER_ZERO   2
 send 0s to sink
#define SOF_XRUN_OVER_NULL   4
 send data to NULL
#define SOF_MEM_CAPS_RAM   BIT(0)
#define SOF_MEM_CAPS_ROM   BIT(1)
#define SOF_MEM_CAPS_EXT   BIT(2)
 external
#define SOF_MEM_CAPS_LP   BIT(3)
 low power
#define SOF_MEM_CAPS_HP   BIT(4)
 high performance
#define SOF_MEM_CAPS_DMA   BIT(5)
 DMA'able.
#define SOF_MEM_CAPS_CACHE   BIT(6)
 cacheable
#define SOF_MEM_CAPS_EXEC   BIT(7)
 executable
#define SOF_MEM_CAPS_L3   BIT(8)
 L3 memory.
#define SOF_MEM_CAPS_LOWEST_INVALID   BIT(9)
 Used for input validation.
#define SOF_BUF_OVERRUN_PERMITTED   BIT(0)
#define SOF_BUF_UNDERRUN_PERMITTED   BIT(1)
#define SOF_UUID_SIZE   16

Enumerations

enum  sof_comp_type {
  SOF_COMP_NONE = 0 , SOF_COMP_HOST , SOF_COMP_DAI , SOF_COMP_SG_HOST ,
  SOF_COMP_SG_DAI , SOF_COMP_VOLUME , SOF_COMP_MIXER , SOF_COMP_MUX ,
  SOF_COMP_SRC , SOF_COMP_DEPRECATED0 , SOF_COMP_TONE , SOF_COMP_DEPRECATED1 ,
  SOF_COMP_BUFFER , SOF_COMP_EQ_IIR , SOF_COMP_EQ_FIR , SOF_COMP_KEYWORD_DETECT ,
  SOF_COMP_KPB , SOF_COMP_SELECTOR , SOF_COMP_DEMUX , SOF_COMP_ASRC ,
  SOF_COMP_DCBLOCK , SOF_COMP_SMART_AMP , SOF_COMP_MODULE_ADAPTER , SOF_COMP_FILEREAD = 10000 ,
  SOF_COMP_FILEWRITE = 10001
}
enum  sof_volume_ramp {
  SOF_VOLUME_LINEAR = 0 , SOF_VOLUME_LOG , SOF_VOLUME_LINEAR_ZC , SOF_VOLUME_LOG_ZC ,
  SOF_VOLUME_WINDOWS_FADE , SOF_VOLUME_WINDOWS_NO_FADE
}
enum  sof_ipc_pipe_sched_time_domain { SOF_TIME_DOMAIN_DMA = 0 , SOF_TIME_DOMAIN_TIMER }
 Types of pipeline scheduling time domains. More...

Detailed Description

Macro Definition Documentation

◆ SOF_BUF_OVERRUN_PERMITTED

#define SOF_BUF_OVERRUN_PERMITTED   BIT(0)

◆ SOF_BUF_UNDERRUN_PERMITTED

#define SOF_BUF_UNDERRUN_PERMITTED   BIT(1)

◆ SOF_MEM_CAPS_CACHE

#define SOF_MEM_CAPS_CACHE   BIT(6)

cacheable

◆ SOF_MEM_CAPS_DMA

#define SOF_MEM_CAPS_DMA   BIT(5)

DMA'able.

◆ SOF_MEM_CAPS_EXEC

#define SOF_MEM_CAPS_EXEC   BIT(7)

executable

◆ SOF_MEM_CAPS_EXT

#define SOF_MEM_CAPS_EXT   BIT(2)

external

◆ SOF_MEM_CAPS_HP

#define SOF_MEM_CAPS_HP   BIT(4)

high performance

◆ SOF_MEM_CAPS_L3

#define SOF_MEM_CAPS_L3   BIT(8)

L3 memory.

◆ SOF_MEM_CAPS_LOWEST_INVALID

#define SOF_MEM_CAPS_LOWEST_INVALID   BIT(9)

Used for input validation.

◆ SOF_MEM_CAPS_LP

#define SOF_MEM_CAPS_LP   BIT(3)

low power

◆ SOF_MEM_CAPS_RAM

#define SOF_MEM_CAPS_RAM   BIT(0)

◆ SOF_MEM_CAPS_ROM

#define SOF_MEM_CAPS_ROM   BIT(1)

◆ SOF_UUID_SIZE

#define SOF_UUID_SIZE   16

◆ SOF_XRUN_OVER_NULL

#define SOF_XRUN_OVER_NULL   4

send data to NULL

◆ SOF_XRUN_STOP

#define SOF_XRUN_STOP   1

stop stream

◆ SOF_XRUN_UNDER_ZERO

#define SOF_XRUN_UNDER_ZERO   2

send 0s to sink

Enumeration Type Documentation

◆ sof_comp_type

Enumerator
SOF_COMP_NONE 
SOF_COMP_HOST 
SOF_COMP_DAI 
SOF_COMP_SG_HOST 

scatter gather variant

SOF_COMP_SG_DAI 

scatter gather variant

SOF_COMP_VOLUME 
SOF_COMP_MIXER 
SOF_COMP_MUX 
SOF_COMP_SRC 
SOF_COMP_DEPRECATED0 
SOF_COMP_TONE 
SOF_COMP_DEPRECATED1 
SOF_COMP_BUFFER 
SOF_COMP_EQ_IIR 
SOF_COMP_EQ_FIR 
SOF_COMP_KEYWORD_DETECT 
SOF_COMP_KPB 
SOF_COMP_SELECTOR 

channel selector component

SOF_COMP_DEMUX 
SOF_COMP_ASRC 

Asynchronous sample rate converter.

SOF_COMP_DCBLOCK 
SOF_COMP_SMART_AMP 

smart amplifier component

SOF_COMP_MODULE_ADAPTER 

module adapter

SOF_COMP_FILEREAD 

host test based file IO

SOF_COMP_FILEWRITE 

host test based file IO

◆ sof_ipc_pipe_sched_time_domain

Types of pipeline scheduling time domains.

Enumerator
SOF_TIME_DOMAIN_DMA 

DMA interrupt.

SOF_TIME_DOMAIN_TIMER 

Timer interrupt.

◆ sof_volume_ramp

Enumerator
SOF_VOLUME_LINEAR 
SOF_VOLUME_LOG 
SOF_VOLUME_LINEAR_ZC 
SOF_VOLUME_LOG_ZC 
SOF_VOLUME_WINDOWS_FADE 
SOF_VOLUME_WINDOWS_NO_FADE