mirror of https://github.com/Qortal/Brooklyn
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
525 lines
14 KiB
525 lines
14 KiB
/* SPDX-License-Identifier: GPL-2.0-only */ |
|
#ifndef __SST_MFLD_DSP_H__ |
|
#define __SST_MFLD_DSP_H__ |
|
/* |
|
* sst_mfld_dsp.h - Intel SST Driver for audio engine |
|
* |
|
* Copyright (C) 2008-14 Intel Corporation |
|
* Authors: Vinod Koul <[email protected]> |
|
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
* |
|
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
*/ |
|
|
|
#define SST_MAX_BIN_BYTES 1024 |
|
|
|
#define MAX_DBG_RW_BYTES 80 |
|
#define MAX_NUM_SCATTER_BUFFERS 8 |
|
#define MAX_LOOP_BACK_DWORDS 8 |
|
/* IPC base address and mailbox, timestamp offsets */ |
|
#define SST_MAILBOX_SIZE 0x0400 |
|
#define SST_MAILBOX_SEND 0x0000 |
|
#define SST_TIME_STAMP 0x1800 |
|
#define SST_TIME_STAMP_MRFLD 0x800 |
|
#define SST_RESERVED_OFFSET 0x1A00 |
|
#define SST_SCU_LPE_MAILBOX 0x1000 |
|
#define SST_LPE_SCU_MAILBOX 0x1400 |
|
#define SST_SCU_LPE_LOG_BUF (SST_SCU_LPE_MAILBOX+16) |
|
#define PROCESS_MSG 0x80 |
|
|
|
/* Message ID's for IPC messages */ |
|
/* Bits B7: SST or IA/SC ; B6-B4: Msg Category; B3-B0: Msg Type */ |
|
|
|
/* I2L Firmware/Codec Download msgs */ |
|
#define IPC_IA_PREP_LIB_DNLD 0x01 |
|
#define IPC_IA_LIB_DNLD_CMPLT 0x02 |
|
#define IPC_IA_GET_FW_VERSION 0x04 |
|
#define IPC_IA_GET_FW_BUILD_INF 0x05 |
|
#define IPC_IA_GET_FW_INFO 0x06 |
|
#define IPC_IA_GET_FW_CTXT 0x07 |
|
#define IPC_IA_SET_FW_CTXT 0x08 |
|
#define IPC_IA_PREPARE_SHUTDOWN 0x31 |
|
/* I2L Codec Config/control msgs */ |
|
#define IPC_PREP_D3 0x10 |
|
#define IPC_IA_SET_CODEC_PARAMS 0x10 |
|
#define IPC_IA_GET_CODEC_PARAMS 0x11 |
|
#define IPC_IA_SET_PPP_PARAMS 0x12 |
|
#define IPC_IA_GET_PPP_PARAMS 0x13 |
|
#define IPC_SST_PERIOD_ELAPSED_MRFLD 0xA |
|
#define IPC_IA_ALG_PARAMS 0x1A |
|
#define IPC_IA_TUNING_PARAMS 0x1B |
|
#define IPC_IA_SET_RUNTIME_PARAMS 0x1C |
|
#define IPC_IA_SET_PARAMS 0x1 |
|
#define IPC_IA_GET_PARAMS 0x2 |
|
|
|
#define IPC_EFFECTS_CREATE 0xE |
|
#define IPC_EFFECTS_DESTROY 0xF |
|
|
|
/* I2L Stream config/control msgs */ |
|
#define IPC_IA_ALLOC_STREAM_MRFLD 0x2 |
|
#define IPC_IA_ALLOC_STREAM 0x20 /* Allocate a stream ID */ |
|
#define IPC_IA_FREE_STREAM_MRFLD 0x03 |
|
#define IPC_IA_FREE_STREAM 0x21 /* Free the stream ID */ |
|
#define IPC_IA_SET_STREAM_PARAMS 0x22 |
|
#define IPC_IA_SET_STREAM_PARAMS_MRFLD 0x12 |
|
#define IPC_IA_GET_STREAM_PARAMS 0x23 |
|
#define IPC_IA_PAUSE_STREAM 0x24 |
|
#define IPC_IA_PAUSE_STREAM_MRFLD 0x4 |
|
#define IPC_IA_RESUME_STREAM 0x25 |
|
#define IPC_IA_RESUME_STREAM_MRFLD 0x5 |
|
#define IPC_IA_DROP_STREAM 0x26 |
|
#define IPC_IA_DROP_STREAM_MRFLD 0x07 |
|
#define IPC_IA_DRAIN_STREAM 0x27 /* Short msg with str_id */ |
|
#define IPC_IA_DRAIN_STREAM_MRFLD 0x8 |
|
#define IPC_IA_CONTROL_ROUTING 0x29 |
|
#define IPC_IA_VTSV_UPDATE_MODULES 0x20 |
|
#define IPC_IA_VTSV_DETECTED 0x21 |
|
|
|
#define IPC_IA_START_STREAM_MRFLD 0X06 |
|
#define IPC_IA_START_STREAM 0x30 /* Short msg with str_id */ |
|
|
|
#define IPC_IA_SET_GAIN_MRFLD 0x21 |
|
/* Debug msgs */ |
|
#define IPC_IA_DBG_MEM_READ 0x40 |
|
#define IPC_IA_DBG_MEM_WRITE 0x41 |
|
#define IPC_IA_DBG_LOOP_BACK 0x42 |
|
#define IPC_IA_DBG_LOG_ENABLE 0x45 |
|
#define IPC_IA_DBG_SET_PROBE_PARAMS 0x47 |
|
|
|
/* L2I Firmware/Codec Download msgs */ |
|
#define IPC_IA_FW_INIT_CMPLT 0x81 |
|
#define IPC_IA_FW_INIT_CMPLT_MRFLD 0x01 |
|
#define IPC_IA_FW_ASYNC_ERR_MRFLD 0x11 |
|
|
|
/* L2I Codec Config/control msgs */ |
|
#define IPC_SST_FRAGMENT_ELPASED 0x90 /* Request IA more data */ |
|
|
|
#define IPC_SST_BUF_UNDER_RUN 0x92 /* PB Under run and stopped */ |
|
#define IPC_SST_BUF_OVER_RUN 0x93 /* CAP Under run and stopped */ |
|
#define IPC_SST_DRAIN_END 0x94 /* PB Drain complete and stopped */ |
|
#define IPC_SST_CHNGE_SSP_PARAMS 0x95 /* PB SSP parameters changed */ |
|
#define IPC_SST_STREAM_PROCESS_FATAL_ERR 0x96/* error in processing a stream */ |
|
#define IPC_SST_PERIOD_ELAPSED 0x97 /* period elapsed */ |
|
|
|
#define IPC_SST_ERROR_EVENT 0x99 /* Buffer over run occurred */ |
|
/* L2S messages */ |
|
#define IPC_SC_DDR_LINK_UP 0xC0 |
|
#define IPC_SC_DDR_LINK_DOWN 0xC1 |
|
#define IPC_SC_SET_LPECLK_REQ 0xC2 |
|
#define IPC_SC_SSP_BIT_BANG 0xC3 |
|
|
|
/* L2I Error reporting msgs */ |
|
#define IPC_IA_MEM_ALLOC_FAIL 0xE0 |
|
#define IPC_IA_PROC_ERR 0xE1 /* error in processing a |
|
stream can be used by playback and |
|
capture modules */ |
|
|
|
/* L2I Debug msgs */ |
|
#define IPC_IA_PRINT_STRING 0xF0 |
|
|
|
/* Buffer under-run */ |
|
#define IPC_IA_BUF_UNDER_RUN_MRFLD 0x0B |
|
|
|
/* Mrfld specific defines: |
|
* For asynchronous messages(INIT_CMPLT, PERIOD_ELAPSED, ASYNC_ERROR) |
|
* received from FW, the format is: |
|
* - IPC High: pvt_id is set to zero. Always short message. |
|
* - msg_id is in lower 16-bits of IPC low payload. |
|
* - pipe_id is in higher 16-bits of IPC low payload for period_elapsed. |
|
* - error id is in higher 16-bits of IPC low payload for async errors. |
|
*/ |
|
#define SST_ASYNC_DRV_ID 0 |
|
|
|
/* Command Response or Acknowledge message to any IPC message will have |
|
* same message ID and stream ID information which is sent. |
|
* There is no specific Ack message ID. The data field is used as response |
|
* meaning. |
|
*/ |
|
enum ackData { |
|
IPC_ACK_SUCCESS = 0, |
|
IPC_ACK_FAILURE, |
|
}; |
|
|
|
enum ipc_ia_msg_id { |
|
IPC_CMD = 1, /*!< Task Control message ID */ |
|
IPC_SET_PARAMS = 2,/*!< Task Set param message ID */ |
|
IPC_GET_PARAMS = 3, /*!< Task Get param message ID */ |
|
IPC_INVALID = 0xFF, /*!<Task Get param message ID */ |
|
}; |
|
|
|
enum sst_codec_types { |
|
/* AUDIO/MUSIC CODEC Type Definitions */ |
|
SST_CODEC_TYPE_UNKNOWN = 0, |
|
SST_CODEC_TYPE_PCM, /* Pass through Audio codec */ |
|
SST_CODEC_TYPE_MP3, |
|
SST_CODEC_TYPE_MP24, |
|
SST_CODEC_TYPE_AAC, |
|
SST_CODEC_TYPE_AACP, |
|
SST_CODEC_TYPE_eAACP, |
|
}; |
|
|
|
enum stream_type { |
|
SST_STREAM_TYPE_NONE = 0, |
|
SST_STREAM_TYPE_MUSIC = 1, |
|
}; |
|
|
|
enum sst_error_codes { |
|
/* Error code,response to msgId: Description */ |
|
/* Common error codes */ |
|
SST_SUCCESS = 0, /* Success */ |
|
SST_ERR_INVALID_STREAM_ID = 1, |
|
SST_ERR_INVALID_MSG_ID = 2, |
|
SST_ERR_INVALID_STREAM_OP = 3, |
|
SST_ERR_INVALID_PARAMS = 4, |
|
SST_ERR_INVALID_CODEC = 5, |
|
SST_ERR_INVALID_MEDIA_TYPE = 6, |
|
SST_ERR_STREAM_ERR = 7, |
|
|
|
SST_ERR_STREAM_IN_USE = 15, |
|
}; |
|
|
|
struct ipc_dsp_hdr { |
|
u16 mod_index_id:8; /*!< DSP Command ID specific to tasks */ |
|
u16 pipe_id:8; /*!< instance of the module in the pipeline */ |
|
u16 mod_id; /*!< Pipe_id */ |
|
u16 cmd_id; /*!< Module ID = lpe_algo_types_t */ |
|
u16 length; /*!< Length of the payload only */ |
|
} __packed; |
|
|
|
union ipc_header_high { |
|
struct { |
|
u32 msg_id:8; /* Message ID - Max 256 Message Types */ |
|
u32 task_id:4; /* Task ID associated with this comand */ |
|
u32 drv_id:4; /* Identifier for the driver to track*/ |
|
u32 rsvd1:8; /* Reserved */ |
|
u32 result:4; /* Reserved */ |
|
u32 res_rqd:1; /* Response rqd */ |
|
u32 large:1; /* Large Message if large = 1 */ |
|
u32 done:1; /* bit 30 - Done bit */ |
|
u32 busy:1; /* bit 31 - busy bit*/ |
|
} part; |
|
u32 full; |
|
} __packed; |
|
/* IPC header */ |
|
union ipc_header_mrfld { |
|
struct { |
|
u32 header_low_payload; |
|
union ipc_header_high header_high; |
|
} p; |
|
u64 full; |
|
} __packed; |
|
/* CAUTION NOTE: All IPC message body must be multiple of 32 bits.*/ |
|
|
|
/* IPC Header */ |
|
union ipc_header { |
|
struct { |
|
u32 msg_id:8; /* Message ID - Max 256 Message Types */ |
|
u32 str_id:5; |
|
u32 large:1; /* Large Message if large = 1 */ |
|
u32 reserved:2; /* Reserved for future use */ |
|
u32 data:14; /* Ack/Info for msg, size of msg in Mailbox */ |
|
u32 done:1; /* bit 30 */ |
|
u32 busy:1; /* bit 31 */ |
|
} part; |
|
u32 full; |
|
} __packed; |
|
|
|
/* Firmware build info */ |
|
struct sst_fw_build_info { |
|
unsigned char date[16]; /* Firmware build date */ |
|
unsigned char time[16]; /* Firmware build time */ |
|
} __packed; |
|
|
|
/* Firmware Version info */ |
|
struct snd_sst_fw_version { |
|
u8 build; /* build number*/ |
|
u8 minor; /* minor number*/ |
|
u8 major; /* major number*/ |
|
u8 type; /* build type */ |
|
}; |
|
|
|
struct ipc_header_fw_init { |
|
struct snd_sst_fw_version fw_version;/* Firmware version details */ |
|
struct sst_fw_build_info build_info; |
|
u16 result; /* Fw init result */ |
|
u8 module_id; /* Module ID in case of error */ |
|
u8 debug_info; /* Debug info from Module ID in case of fail */ |
|
} __packed; |
|
|
|
struct snd_sst_tstamp { |
|
u64 ring_buffer_counter; /* PB/CP: Bytes copied from/to DDR. */ |
|
u64 hardware_counter; /* PB/CP: Bytes DMAed to/from SSP. */ |
|
u64 frames_decoded; |
|
u64 bytes_decoded; |
|
u64 bytes_copied; |
|
u32 sampling_frequency; |
|
u32 channel_peak[8]; |
|
} __packed; |
|
|
|
/* Stream type params struture for Alloc stream */ |
|
struct snd_sst_str_type { |
|
u8 codec_type; /* Codec type */ |
|
u8 str_type; /* 1 = voice 2 = music */ |
|
u8 operation; /* Playback or Capture */ |
|
u8 protected_str; /* 0=Non DRM, 1=DRM */ |
|
u8 time_slots; |
|
u8 reserved; /* Reserved */ |
|
u16 result; /* Result used for acknowledgment */ |
|
} __packed; |
|
|
|
/* Library info structure */ |
|
struct module_info { |
|
u32 lib_version; |
|
u32 lib_type;/*TBD- KLOCKWORK u8 lib_type;*/ |
|
u32 media_type; |
|
u8 lib_name[12]; |
|
u32 lib_caps; |
|
unsigned char b_date[16]; /* Lib build date */ |
|
unsigned char b_time[16]; /* Lib build time */ |
|
} __packed; |
|
|
|
/* Library slot info */ |
|
struct lib_slot_info { |
|
u8 slot_num; /* 1 or 2 */ |
|
u8 reserved1; |
|
u16 reserved2; |
|
u32 iram_size; /* slot size in IRAM */ |
|
u32 dram_size; /* slot size in DRAM */ |
|
u32 iram_offset; /* starting offset of slot in IRAM */ |
|
u32 dram_offset; /* starting offset of slot in DRAM */ |
|
} __packed; |
|
|
|
struct snd_ppp_mixer_params { |
|
__u32 type; /*Type of the parameter */ |
|
__u32 size; |
|
__u32 input_stream_bitmap; /*Input stream Bit Map*/ |
|
} __packed; |
|
|
|
struct snd_sst_lib_download { |
|
struct module_info lib_info; /* library info type, capabilities etc */ |
|
struct lib_slot_info slot_info; /* slot info to be downloaded */ |
|
u32 mod_entry_pt; |
|
}; |
|
|
|
struct snd_sst_lib_download_info { |
|
struct snd_sst_lib_download dload_lib; |
|
u16 result; /* Result used for acknowledgment */ |
|
u8 pvt_id; /* Private ID */ |
|
u8 reserved; /* for alignment */ |
|
}; |
|
struct snd_pcm_params { |
|
u8 num_chan; /* 1=Mono, 2=Stereo */ |
|
u8 pcm_wd_sz; /* 16/24 - bit*/ |
|
u8 use_offload_path; /* 0-PCM using period elpased & ALSA interfaces |
|
1-PCM stream via compressed interface */ |
|
u8 reserved2; |
|
u32 sfreq; /* Sampling rate in Hz */ |
|
u8 channel_map[8]; |
|
} __packed; |
|
|
|
/* MP3 Music Parameters Message */ |
|
struct snd_mp3_params { |
|
u8 num_chan; /* 1=Mono, 2=Stereo */ |
|
u8 pcm_wd_sz; /* 16/24 - bit*/ |
|
u8 crc_check; /* crc_check - disable (0) or enable (1) */ |
|
u8 reserved1; /* unused*/ |
|
u16 reserved2; /* Unused */ |
|
} __packed; |
|
|
|
#define AAC_BIT_STREAM_ADTS 0 |
|
#define AAC_BIT_STREAM_ADIF 1 |
|
#define AAC_BIT_STREAM_RAW 2 |
|
|
|
/* AAC Music Parameters Message */ |
|
struct snd_aac_params { |
|
u8 num_chan; /* 1=Mono, 2=Stereo*/ |
|
u8 pcm_wd_sz; /* 16/24 - bit*/ |
|
u8 bdownsample; /*SBR downsampling 0 - disable 1 -enabled AAC+ only */ |
|
u8 bs_format; /* input bit stream format adts=0, adif=1, raw=2 */ |
|
u16 reser2; |
|
u32 externalsr; /*sampling rate of basic AAC raw bit stream*/ |
|
u8 sbr_signalling;/*disable/enable/set automode the SBR tool.AAC+*/ |
|
u8 reser1; |
|
u16 reser3; |
|
} __packed; |
|
|
|
/* WMA Music Parameters Message */ |
|
struct snd_wma_params { |
|
u8 num_chan; /* 1=Mono, 2=Stereo */ |
|
u8 pcm_wd_sz; /* 16/24 - bit*/ |
|
u16 reserved1; |
|
u32 brate; /* Use the hard coded value. */ |
|
u32 sfreq; /* Sampling freq eg. 8000, 441000, 48000 */ |
|
u32 channel_mask; /* Channel Mask */ |
|
u16 format_tag; /* Format Tag */ |
|
u16 block_align; /* packet size */ |
|
u16 wma_encode_opt;/* Encoder option */ |
|
u8 op_align; /* op align 0- 16 bit, 1- MSB, 2 LSB */ |
|
u8 reserved; /* reserved */ |
|
} __packed; |
|
|
|
/* Codec params struture */ |
|
union snd_sst_codec_params { |
|
struct snd_pcm_params pcm_params; |
|
struct snd_mp3_params mp3_params; |
|
struct snd_aac_params aac_params; |
|
struct snd_wma_params wma_params; |
|
} __packed; |
|
|
|
/* Address and size info of a frame buffer */ |
|
struct sst_address_info { |
|
u32 addr; /* Address at IA */ |
|
u32 size; /* Size of the buffer */ |
|
}; |
|
|
|
struct snd_sst_alloc_params_ext { |
|
__u16 sg_count; |
|
__u16 reserved; |
|
__u32 frag_size; /*Number of samples after which period elapsed |
|
message is sent valid only if path = 0*/ |
|
struct sst_address_info ring_buf_info[8]; |
|
}; |
|
|
|
struct snd_sst_stream_params { |
|
union snd_sst_codec_params uc; |
|
} __packed; |
|
|
|
struct snd_sst_params { |
|
u32 result; |
|
u32 stream_id; |
|
u8 codec; |
|
u8 ops; |
|
u8 stream_type; |
|
u8 device_type; |
|
u8 task; |
|
struct snd_sst_stream_params sparams; |
|
struct snd_sst_alloc_params_ext aparams; |
|
}; |
|
|
|
struct snd_sst_alloc_mrfld { |
|
u16 codec_type; |
|
u8 operation; |
|
u8 sg_count; |
|
struct sst_address_info ring_buf_info[8]; |
|
u32 frag_size; |
|
u32 ts; |
|
struct snd_sst_stream_params codec_params; |
|
} __packed; |
|
|
|
/* Alloc stream params structure */ |
|
struct snd_sst_alloc_params { |
|
struct snd_sst_str_type str_type; |
|
struct snd_sst_stream_params stream_params; |
|
struct snd_sst_alloc_params_ext alloc_params; |
|
} __packed; |
|
|
|
/* Alloc stream response message */ |
|
struct snd_sst_alloc_response { |
|
struct snd_sst_str_type str_type; /* Stream type for allocation */ |
|
struct snd_sst_lib_download lib_dnld; /* Valid only for codec dnld */ |
|
}; |
|
|
|
/* Drop response */ |
|
struct snd_sst_drop_response { |
|
u32 result; |
|
u32 bytes; |
|
}; |
|
|
|
struct snd_sst_async_msg { |
|
u32 msg_id; /* Async msg id */ |
|
u32 payload[0]; |
|
}; |
|
|
|
struct snd_sst_async_err_msg { |
|
u32 fw_resp; /* Firmware Result */ |
|
u32 lib_resp; /*Library result */ |
|
} __packed; |
|
|
|
struct snd_sst_vol { |
|
u32 stream_id; |
|
s32 volume; |
|
u32 ramp_duration; |
|
u32 ramp_type; /* Ramp type, default=0 */ |
|
}; |
|
|
|
/* Gain library parameters for mrfld |
|
* based on DSP command spec v0.82 |
|
*/ |
|
struct snd_sst_gain_v2 { |
|
u16 gain_cell_num; /* num of gain cells to modify*/ |
|
u8 cell_nbr_idx; /* instance index*/ |
|
u8 cell_path_idx; /* pipe-id */ |
|
u16 module_id; /*module id */ |
|
u16 left_cell_gain; /* left gain value in dB*/ |
|
u16 right_cell_gain; /* right gain value in dB*/ |
|
u16 gain_time_const; /* gain time constant*/ |
|
} __packed; |
|
|
|
struct snd_sst_mute { |
|
u32 stream_id; |
|
u32 mute; |
|
}; |
|
|
|
struct snd_sst_runtime_params { |
|
u8 type; |
|
u8 str_id; |
|
u8 size; |
|
u8 rsvd; |
|
void *addr; |
|
} __packed; |
|
|
|
enum stream_param_type { |
|
SST_SET_TIME_SLOT = 0, |
|
SST_SET_CHANNEL_INFO = 1, |
|
OTHERS = 2, /*reserved for future params*/ |
|
}; |
|
|
|
/* CSV Voice call routing structure */ |
|
struct snd_sst_control_routing { |
|
u8 control; /* 0=start, 1=Stop */ |
|
u8 reserved[3]; /* Reserved- for 32 bit alignment */ |
|
}; |
|
|
|
struct ipc_post { |
|
struct list_head node; |
|
union ipc_header header; /* driver specific */ |
|
bool is_large; |
|
bool is_process_reply; |
|
union ipc_header_mrfld mrfld_header; |
|
char *mailbox_data; |
|
}; |
|
|
|
struct snd_sst_ctxt_params { |
|
u32 address; /* Physical Address in DDR where the context is stored */ |
|
u32 size; /* size of the context */ |
|
}; |
|
|
|
struct snd_sst_lpe_log_params { |
|
u8 dbg_type; |
|
u8 module_id; |
|
u8 log_level; |
|
u8 reserved; |
|
} __packed; |
|
|
|
enum snd_sst_bytes_type { |
|
SND_SST_BYTES_SET = 0x1, |
|
SND_SST_BYTES_GET = 0x2, |
|
}; |
|
|
|
struct snd_sst_bytes_v2 { |
|
u8 type; |
|
u8 ipc_msg; |
|
u8 block; |
|
u8 task_id; |
|
u8 pipe_id; |
|
u8 rsvd; |
|
u16 len; |
|
char bytes[0]; |
|
}; |
|
|
|
#define MAX_VTSV_FILES 2 |
|
struct snd_sst_vtsv_info { |
|
struct sst_address_info vfiles[MAX_VTSV_FILES]; |
|
} __packed; |
|
|
|
#endif /* __SST_MFLD_DSP_H__ */
|
|
|