ipc-config.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2021 Intel Corporation. All rights reserved.
 */
 
#ifndef __SOF_AUDIO_IPC_CONFIG_H__
#define __SOF_AUDIO_IPC_CONFIG_H__
 
#include <stdint.h>
#include <stdbool.h>
 
/* ACE 2.0 and newer */
#define GTW_DMA_CONFIG_ID       0x1000
#define GTW_DMA_INVALID_CHANNEL_ID  0xffffffff
/* Maximum number of devices */
#define GTW_DMA_DEVICE_MAX_COUNT 16
 
struct dma_device_stream_channel_map {
    uint32_t device_address;
    uint32_t channel_map;
};
 
struct dma_stream_channel_map {
    uint32_t device_count;
    struct dma_device_stream_channel_map map[GTW_DMA_DEVICE_MAX_COUNT];
};
 
struct ipc_dma_config {
    uint8_t dma_method;     
    uint8_t pre_allocated_by_host;  
    uint16_t rsvd;
    uint32_t dma_channel_id;    
    uint32_t stream_id;
    /* DmaStreamChannelMap */
    struct dma_stream_channel_map channel_map;
    uint32_t dma_priv_config_size;
    uint8_t  dma_priv_config[0];
} __attribute__((packed, aligned(4)));
 
#define GET_IPC_DMA_CONFIG(buffer, size) \
    ((struct ipc_dma_config *)((uint8_t *)(buffer) + (size) - sizeof(struct ipc_dma_config)))
#define GET_IPC_DMA_CONFIG_ID(buffer, size) ((uint32_t *)GET_IPC_DMA_CONFIG(buffer, size) - 2)
 
/*
 * Generic IPC information for base components. Fields can be added here with NO impact on
 * IPC ABI version.
 */
 
/* generic host component */
struct ipc_config_host {
    uint32_t direction;     
    uint32_t no_irq;        
    uint32_t dmac_config;       
    uint32_t dma_buffer_size;   
    uint32_t feature_mask;      
};
 
/* generic DAI component */
struct ipc_config_dai {
    uint32_t direction;     
    uint32_t dai_index;     
    uint32_t type;          
    uint32_t dma_buffer_size;   
    /* physical protocol and clocking */
    uint32_t sampling_frequency;    
    uint16_t format;        
    uint16_t group_id;      
    bool is_config_blob;        
    uint32_t feature_mask;      
    struct ipc_dma_config *host_dma_config[GTW_DMA_DEVICE_MAX_COUNT];
    const struct ipc4_audio_format *gtw_fmt;
    /* Gain feature flag */
    bool apply_gain;
};
 
/* generic volume component */
struct ipc_config_volume {
    uint32_t channels;
    uint32_t min_value;
    uint32_t max_value;
    uint32_t ramp;      
    uint32_t initial_ramp;  
};
 
/* generic SRC component */
struct ipc_config_src {
    /* either source or sink rate must be non zero */
    uint32_t source_rate;   
    uint32_t sink_rate; 
    uint32_t rate_mask; 
};
 
/* generic ASRC component */
struct ipc_config_asrc {
    /* 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;        
};
 
/* generic tone generator component */
struct ipc_config_tone {
    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;
};
 
/* generic "effect", "codec" or proprietary processing component */
struct ipc_config_process {
    uint32_t size;  
    uint32_t type;  
 
    const unsigned char *data;
};
 
/* file IO ipc comp */
struct ipc_comp_file {
    struct ipc_config_process module_header; /* Needed for module_adapter_init_data() */
    uint32_t rate;
    uint32_t channels;
    char *fn;
    uint32_t mode;
    uint32_t frame_fmt;
    uint32_t direction; 
} __attribute__((packed, aligned(4)));
 
#endif