topology.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2018 Intel Corporation. All rights reserved.
 *
 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
 *         Keyon Jie <yang.jie@linux.intel.com>
 */

 
#ifndef __IPC_TOPOLOGY_H__
#define __IPC_TOPOLOGY_H__
 
#include <ipc/header.h>
#include <stdint.h>
 
/*
 * Component
 */
 
/* types of component */
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, /* Formerly SOF_COMP_SPLITTER */
    SOF_COMP_TONE,
    SOF_COMP_DEPRECATED1, /* Formerly SOF_COMP_SWITCH */
    SOF_COMP_BUFFER,
    SOF_COMP_EQ_IIR,
    SOF_COMP_EQ_FIR,
    SOF_COMP_KEYWORD_DETECT,
    SOF_COMP_KPB,           /* A key phrase buffer component */
    SOF_COMP_SELECTOR,      
    SOF_COMP_DEMUX,
    SOF_COMP_ASRC,      
    SOF_COMP_DCBLOCK,
    SOF_COMP_SMART_AMP,     
    SOF_COMP_MODULE_ADAPTER,        
    /* keep FILEREAD/FILEWRITE as the last ones */
    SOF_COMP_FILEREAD = 10000,  
    SOF_COMP_FILEWRITE = 10001, 
};
 
/* XRUN action for component */
#define SOF_XRUN_STOP       1   
#define SOF_XRUN_UNDER_ZERO 2   
#define SOF_XRUN_OVER_NULL  4   
 
/* create new generic component - SOF_IPC_TPLG_COMP_NEW */
struct sof_ipc_comp {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t id;
    /* holds an "enum sof_comp_type" value. Fixed-size because of #9378 */
    uint32_t type;
    uint32_t pipeline_id;
    uint32_t core;

    uint32_t ext_data_length;
} __attribute__((packed, aligned(4)));
 
/*
 * Component Buffers
 */
 
/*
 * SOF memory capabilities, add new ones at the end
 */
#define SOF_MEM_CAPS_RAM        BIT(0)
#define SOF_MEM_CAPS_ROM        BIT(1)
#define SOF_MEM_CAPS_EXT        BIT(2) 
#define SOF_MEM_CAPS_LP         BIT(3) 
#define SOF_MEM_CAPS_HP         BIT(4) 
#define SOF_MEM_CAPS_DMA        BIT(5) 
#define SOF_MEM_CAPS_CACHE      BIT(6) 
#define SOF_MEM_CAPS_EXEC       BIT(7) 
#define SOF_MEM_CAPS_L3         BIT(8) 
/* Don't forget to update when adding a new bit to the ABI. */
#define SOF_MEM_CAPS_LOWEST_INVALID BIT(9) 
 
/*
 * overrun will cause ring buffer overwrite, instead of XRUN.
 */
#define SOF_BUF_OVERRUN_PERMITTED   BIT(0)
 
/*
 * underrun will cause readback of 0s, instead of XRUN.
 */
#define SOF_BUF_UNDERRUN_PERMITTED  BIT(1)
 
/* the UUID size in bytes, shared between FW and host */
#define SOF_UUID_SIZE   16
 
/* create new component buffer - SOF_IPC_TPLG_BUFFER_NEW */
struct sof_ipc_buffer {
    struct sof_ipc_comp comp;
    uint32_t size;      
    uint32_t caps;      
    uint32_t flags;     
    uint32_t reserved;  
} __attribute__((packed, aligned(4)));
 
/* generic component config data - must always be after struct sof_ipc_comp */
struct sof_ipc_comp_config {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t periods_sink;  
    uint32_t periods_source;
    uint32_t reserved1; 
    uint32_t frame_fmt; 
    uint32_t xrun_action;
 
    /* reserved for future use */
    uint32_t reserved[2];
} __attribute__((packed, aligned(4)));
 
/* generic host component */
struct sof_ipc_comp_host {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
    uint32_t direction; 
    uint32_t no_irq;    
    uint32_t dmac_config; 
} __attribute__((packed, aligned(4)));
 
/* generic DAI component */
struct sof_ipc_comp_dai {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
    uint32_t direction; 
    uint32_t dai_index; 
    uint32_t type;      
    uint32_t reserved;  
} __attribute__((packed, aligned(4)));
 
/* generic mixer component */
struct sof_ipc_comp_mixer {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
} __attribute__((packed, aligned(4)));
 
/* volume ramping types */
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,
};
 
/* generic volume component */
struct sof_ipc_comp_volume {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
    uint32_t channels;
    uint32_t min_value;
    uint32_t max_value;
    uint32_t ramp;      
    uint32_t initial_ramp;  
} __attribute__((packed, aligned(4)));
 
/* generic SRC component */
struct sof_ipc_comp_src {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
    /* either source or sink rate must be non zero */
    uint32_t source_rate;   
    uint32_t sink_rate; 
    uint32_t rate_mask; 
} __attribute__((packed, aligned(4)));
 
/* generic ASRC component */
struct sof_ipc_comp_asrc {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
    /* either source or sink rate must be non zero */
    uint32_t source_rate;           
    uint32_t sink_rate;             
    uint32_t asynchronous_mode;     
    uint32_t operation_mode;        
 
    /* reserved for future use */
    uint32_t reserved[4];
} __attribute__((packed, aligned(4)));
 
/* generic MUX component */
struct sof_ipc_comp_mux {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
} __attribute__((packed, aligned(4)));
 
/* generic tone generator component */
struct sof_ipc_comp_tone {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
    int32_t sample_rate;
    int32_t frequency;
    int32_t amplitude;
    int32_t freq_mult;
    int32_t ampl_mult;
    int32_t length;
    int32_t period;
    int32_t repeats;
    int32_t ramp_step;
} __attribute__((packed, aligned(4)));
 
/* generic "effect", "codec" or proprietary processing component */
struct sof_ipc_comp_process {
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
    uint32_t size;  
    uint32_t type;  
 
    /* reserved for future use */
    uint32_t reserved[7];
 
    unsigned char data[];
} __attribute__((packed, aligned(4)));
 
/* IPC file component used by testbench only */
struct sof_ipc_comp_file {
    /* These need to be the same as in above sof_ipc_comp_process */
    struct sof_ipc_comp comp;
    struct sof_ipc_comp_config config;
    uint32_t size;  
    uint32_t type;  
 
    /* reserved for future use */
    uint32_t reserved[7];
 
    /* These are additional parameters for file */
    uint32_t rate;
    uint32_t channels;
    char *fn;
    uint32_t mode;
    uint32_t frame_fmt;
    uint32_t direction; 
} __attribute__((packed, aligned(4)));
 
/* frees components, buffers and pipelines
 * SOF_IPC_TPLG_COMP_FREE, SOF_IPC_TPLG_PIPE_FREE, SOF_IPC_TPLG_BUFFER_FREE
 */
struct sof_ipc_free {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t id;
} __attribute__((packed, aligned(4)));
 
struct sof_ipc_comp_reply {
    struct sof_ipc_reply rhdr;
    uint32_t id;
    uint32_t offset;
} __attribute__((packed, aligned(4)));
 
/*
 * Pipeline
 */

enum sof_ipc_pipe_sched_time_domain {
    SOF_TIME_DOMAIN_DMA = 0,    
    SOF_TIME_DOMAIN_TIMER,      
};
 
/* new pipeline - SOF_IPC_TPLG_PIPE_NEW */
struct sof_ipc_pipe_new {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t comp_id;   
    uint32_t pipeline_id;   
    uint32_t sched_id;  
    uint32_t core;      
    uint32_t period;    
    uint32_t priority;  
    uint32_t period_mips;   
    uint32_t frames_per_sched;
    uint32_t xrun_limit_usecs; 
    uint32_t time_domain;   
} __attribute__((packed, aligned(4)));
 
/* pipeline construction complete - SOF_IPC_TPLG_PIPE_COMPLETE */
struct sof_ipc_pipe_ready {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t comp_id;
} __attribute__((packed, aligned(4)));
 
struct sof_ipc_pipe_free {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t comp_id;
} __attribute__((packed, aligned(4)));
 
/* connect two components in pipeline - SOF_IPC_TPLG_COMP_CONNECT */
struct sof_ipc_pipe_comp_connect {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t source_id;
    uint32_t sink_id;
} __attribute__((packed, aligned(4)));
 
/* extended data struct for UUID components */
struct sof_ipc_comp_ext {
    uint8_t uuid[SOF_UUID_SIZE];
} __attribute__((packed, aligned(4)));
 
#endif /* __IPC_TOPOLOGY_H__ */