> ## Documentation Index > Fetch the complete documentation index at: https://dragonwingdocs-staging.qualcomm.com/llms.txt > Use this file to discover all available pages before exploring further. # Sp VI **Header:** `spf/api/modules/sp_vi.h` ## Structures ### `param_id_sp_vi_op_mode_cfg_t` **Members** } } ### `vi_r0t0_cfg_t` **Members** This field is valid only in Normal mode (operation\_mode = 0).} This field is valid in both Normal mode and Calibration mode.} ### `param_id_sp_th_vi_r0t0_cfg_t` **Members** ### `param_id_sp_vi_static_cfg_t` **Members** } } Pilot tone frequency values MUST be the same for the RX/TH/EX modules} } } } Method2 also requires setting of spk\_delta\_t\_delta\_r\_ratio\_u16q9 param.} It's only for laser display. should be disabled at normal mode on devices.} HAL will set a periodic query on the DC presense flag. If DC is present, HAL will shut down WSA to protect spkrs.} ### `sp_vi_th_spkr_param_t` **Members** } } If (Rvc > factor\*(AC impedance)), the speaker is considered open.} } } } } Below this value, the resistance update is unreliable.} ### `sp_vi_r0t0_cali_param_t` **Members** } } } } After this threshold, calibrated resistance is considered as failed.} } ### `param_id_sp_th_vi_dynamic_cfg_t` **Members** ### `param_id_sp_th_vi_calib_res_cfg_t` **Members** The state of each speaker is tied together.} ### `vi_th_ftm_cfg_t` **Members** ### `param_id_sp_th_vi_ftm_cfg_t` **Members** ### `vi_th_ftm_params_t` **Members** ### `param_id_sp_th_vi_ftm_params_t` **Members** } } ### `vi_th_v_vali_cfg_t` **Members** ### `param_id_sp_th_vi_v_vali_cfg_t` **Members** ### `vi_th_v_vali_params_t` **Members** } ### `param_id_sp_th_vi_v_vali_params_t` **Members** } } ### `fbsp_tdf_2_cfg_t` **Members** } } } } ### `sp_vi_ex_spkr_param_t` **Members** ### `param_id_sp_ex_vi_dynamic_cfg_t` **Members** ### `param_id_sp_ex_vi_stats_t` **Members** } This field is reset to zero after crossing the maximum limit for uint32 variables.} } } ### `param_id_sp_ex_vi_mode_cfg_t` **Members** When enabled, the estimated spkr parameters are averaged and pushed out to HAL for parameter display and saving into audio.cal} ### `vi_ex_ftm_cfg_t` **Members** ### `param_id_sp_ex_vi_ftm_cfg_t` **Members** ### `vi_ex_ftm_params_t` **Members** ### `param_id_sp_ex_vi_ftm_params_t` **Members** ### `param_id_sp_vi_channel_map_cfg_t` **Members** } SP\_VI\_VSENS\_CHAN1(1) SP\_VI\_ISENS\_CHAN1(2) SP\_VI\_VSENS\_CHAN2(3) SP\_VI\_ISENS\_CHAN2(4) SP\_VI\_VSENS\_CHAN3(5) SP\_VI\_ISENS\_CHAN3(6) SP\_VI\_VSENS\_CHAN4(7) SP\_VI\_ISENS\_CHAN4(8) Some possible configurations are (1,2,3,4,5,6,7,8), (2,1,4,3,6,5,8,7), (1,2,0,0),(4,3,0,0), and (2,1,0,0). All channels must be unique. The order does not matter as long as the channels are valid. If only two channels are sent (V and I), they must be first two channels: Eg: (4,3), (1,2), etc.} ### `param_id_sp_ex_vi_CFSmoothing_param_t` **Members** } ### `param_id_vi_output_bps_split_enable_t` **Members** If the input has bits per sample as 32 and this is enabled, it splits the output into two channels with bits per sample as 16 for each corresponding input channel.} ### `param_id_sp_vi_spkr_diag_getpkt_param_t` **Members** ### `sp_vi_cali_param_t` **Members** ### `param_id_sp_th_vi_calib_res_per_spkr_cfg_param_t` **Members** ### `param_id_max_rated_temp_param_t` **Members** ## Type Definitions ### `param_id_sp_vi_op_mode_cfg_t` ```cpp theme={null} typedef struct param_id_sp_vi_op_mode_cfg_t param_id_sp_vi_op_mode_cfg_t ``` ### `vi_r0t0_cfg_t` ```cpp theme={null} typedef struct vi_r0t0_cfg_t vi_r0t0_cfg_t ``` ### `param_id_sp_th_vi_r0t0_cfg_t` ```cpp theme={null} typedef struct param_id_sp_th_vi_r0t0_cfg_t param_id_sp_th_vi_r0t0_cfg_t ``` ### `param_id_sp_vi_static_cfg_t` ```cpp theme={null} typedef struct param_id_sp_vi_static_cfg_t param_id_sp_vi_static_cfg_t ``` ### `sp_vi_th_spkr_param_t` ```cpp theme={null} typedef struct sp_vi_th_spkr_param_t sp_vi_th_spkr_param_t ``` ### `sp_vi_r0t0_cali_param_t` ```cpp theme={null} typedef struct sp_vi_r0t0_cali_param_t sp_vi_r0t0_cali_param_t ``` ### `param_id_sp_th_vi_dynamic_cfg_t` ```cpp theme={null} typedef struct param_id_sp_th_vi_dynamic_cfg_t param_id_sp_th_vi_dynamic_cfg_t ``` ### `param_id_sp_th_vi_calib_res_cfg_t` ```cpp theme={null} typedef struct param_id_sp_th_vi_calib_res_cfg_t param_id_sp_th_vi_calib_res_cfg_t ``` ### `vi_th_ftm_cfg_t` ```cpp theme={null} typedef struct vi_th_ftm_cfg_t vi_th_ftm_cfg_t ``` ### `param_id_sp_th_vi_ftm_cfg_t` ```cpp theme={null} typedef struct param_id_sp_th_vi_ftm_cfg_t param_id_sp_th_vi_ftm_cfg_t ``` ### `vi_th_ftm_params_t` ```cpp theme={null} typedef struct vi_th_ftm_params_t vi_th_ftm_params_t ``` ### `param_id_sp_th_vi_ftm_params_t` ```cpp theme={null} typedef struct param_id_sp_th_vi_ftm_params_t param_id_sp_th_vi_ftm_params_t ``` ### `vi_th_v_vali_cfg_t` ```cpp theme={null} typedef struct vi_th_v_vali_cfg_t vi_th_v_vali_cfg_t ``` ### `param_id_sp_th_vi_v_vali_cfg_t` ```cpp theme={null} typedef struct param_id_sp_th_vi_v_vali_cfg_t param_id_sp_th_vi_v_vali_cfg_t ``` ### `vi_th_v_vali_params_t` ```cpp theme={null} typedef struct vi_th_v_vali_params_t vi_th_v_vali_params_t ``` ### `param_id_sp_th_vi_v_vali_params_t` ```cpp theme={null} typedef struct param_id_sp_th_vi_v_vali_params_t param_id_sp_th_vi_v_vali_params_t ``` ### `fbsp_tdf_2_cfg_t` ```cpp theme={null} typedef struct fbsp_tdf_2_cfg_t fbsp_tdf_2_cfg_t ``` ### `sp_vi_ex_spkr_param_t` ```cpp theme={null} typedef struct sp_vi_ex_spkr_param_t sp_vi_ex_spkr_param_t ``` ### `param_id_sp_ex_vi_dynamic_cfg_t` ```cpp theme={null} typedef struct param_id_sp_ex_vi_dynamic_cfg_t param_id_sp_ex_vi_dynamic_cfg_t ``` ### `param_id_sp_ex_vi_stats_t` ```cpp theme={null} typedef struct param_id_sp_ex_vi_stats_t param_id_sp_ex_vi_stats_t ``` ### `param_id_sp_ex_vi_mode_cfg_t` ```cpp theme={null} typedef struct param_id_sp_ex_vi_mode_cfg_t param_id_sp_ex_vi_mode_cfg_t ``` ### `vi_ex_ftm_cfg_t` ```cpp theme={null} typedef struct vi_ex_ftm_cfg_t vi_ex_ftm_cfg_t ``` ### `param_id_sp_ex_vi_ftm_cfg_t` ```cpp theme={null} typedef struct param_id_sp_ex_vi_ftm_cfg_t param_id_sp_ex_vi_ftm_cfg_t ``` ### `vi_ex_ftm_params_t` ```cpp theme={null} typedef struct vi_ex_ftm_params_t vi_ex_ftm_params_t ``` ### `param_id_sp_ex_vi_ftm_params_t` ```cpp theme={null} typedef struct param_id_sp_ex_vi_ftm_params_t param_id_sp_ex_vi_ftm_params_t ``` ### `param_id_sp_vi_channel_map_cfg_t` ```cpp theme={null} typedef struct param_id_sp_vi_channel_map_cfg_t param_id_sp_vi_channel_map_cfg_t ``` ### `param_id_sp_ex_vi_CFSmoothing_param_t` ```cpp theme={null} typedef struct param_id_sp_ex_vi_CFSmoothing_param_t param_id_sp_ex_vi_CFSmoothing_param_t ``` ### `param_id_vi_output_bps_split_enable_t` ```cpp theme={null} typedef struct param_id_vi_output_bps_split_enable_t param_id_vi_output_bps_split_enable_t ``` ### `param_id_sp_vi_spkr_diag_getpkt_param_t` ```cpp theme={null} typedef struct param_id_sp_vi_spkr_diag_getpkt_param_t param_id_sp_vi_spkr_diag_getpkt_param_t ``` ### `sp_vi_cali_param_t` ```cpp theme={null} typedef struct sp_vi_cali_param_t sp_vi_cali_param_t ``` ### `param_id_sp_th_vi_calib_res_per_spkr_cfg_param_t` ```cpp theme={null} typedef struct param_id_sp_th_vi_calib_res_per_spkr_cfg_param_t param_id_sp_th_vi_calib_res_per_spkr_cfg_param_t ``` ### `param_id_max_rated_temp_param_t` ```cpp theme={null} typedef struct param_id_max_rated_temp_param_t param_id_max_rated_temp_param_t ``` ## Macros ### `SP_VI_VSENS_CHAN1` ```c theme={null} #define SP_VI_VSENS_CHAN1 1 ``` ### `SP_VI_ISENS_CHAN1` ```c theme={null} #define SP_VI_ISENS_CHAN1 2 ``` ### `SP_VI_VSENS_CHAN2` ```c theme={null} #define SP_VI_VSENS_CHAN2 3 ``` ### `SP_VI_ISENS_CHAN2` ```c theme={null} #define SP_VI_ISENS_CHAN2 4 ``` ### `SP_VI_VSENS_CHAN3` ```c theme={null} #define SP_VI_VSENS_CHAN3 5 ``` ### `SP_VI_ISENS_CHAN3` ```c theme={null} #define SP_VI_ISENS_CHAN3 6 ``` ### `SP_VI_VSENS_CHAN4` ```c theme={null} #define SP_VI_VSENS_CHAN4 7 ``` ### `SP_VI_ISENS_CHAN4` ```c theme={null} #define SP_VI_ISENS_CHAN4 8 ``` ### `PARAM_ID_SP_VI_OP_MODE_CFG` ```c theme={null} #define PARAM_ID_SP_VI_OP_MODE_CFG 0x080011F4 ``` ### `PARAM_ID_SP_TH_VI_R0T0_CFG` ```c theme={null} #define PARAM_ID_SP_TH_VI_R0T0_CFG 0x080011F5 ``` ### `PARAM_ID_SP_VI_STATIC_CFG` ```c theme={null} #define PARAM_ID_SP_VI_STATIC_CFG 0x080011F6 ``` ### `PARAM_ID_SPv5_TH_VI_DYNAMIC_CFG` ```c theme={null} #define PARAM_ID_SPv5_TH_VI_DYNAMIC_CFG 0x08001B5C ``` ### `PARAM_ID_SP_TH_VI_CALIB_RES_CFG` ```c theme={null} #define PARAM_ID_SP_TH_VI_CALIB_RES_CFG 0x080011F8 ``` ### `PARAM_ID_SP_TH_VI_FTM_CFG` ```c theme={null} #define PARAM_ID_SP_TH_VI_FTM_CFG 0x080011F9 ``` ### `PARAM_ID_SP_TH_VI_FTM_PARAMS` ```c theme={null} #define PARAM_ID_SP_TH_VI_FTM_PARAMS 0x080011FA ``` ### `PARAM_ID_SP_TH_VI_V_VALI_CFG` ```c theme={null} #define PARAM_ID_SP_TH_VI_V_VALI_CFG 0x080011FB ``` ### `PARAM_ID_SP_TH_VI_V_VALI_PARAMS` ```c theme={null} #define PARAM_ID_SP_TH_VI_V_VALI_PARAMS 0x080011FC ``` ### `PARAM_ID_SPv5_EX_VI_DYNAMIC_CFG` ```c theme={null} #define PARAM_ID_SPv5_EX_VI_DYNAMIC_CFG 0x08001B5D ``` ### `PARAM_ID_SP_EX_VI_STATS` ```c theme={null} #define PARAM_ID_SP_EX_VI_STATS 0x080011FE ``` ### `PARAM_ID_SP_EX_VI_MODE_CFG` ```c theme={null} #define PARAM_ID_SP_EX_VI_MODE_CFG 0x080011FF ``` ### `PARAM_ID_SP_EX_VI_FTM_CFG` ```c theme={null} #define PARAM_ID_SP_EX_VI_FTM_CFG 0x08001200 ``` ### `PARAM_ID_SP_EX_VI_FTM_PARAMS` ```c theme={null} #define PARAM_ID_SP_EX_VI_FTM_PARAMS 0x08001201 ``` ### `PARAM_ID_SP_VI_CHANNEL_MAP_CFG` ```c theme={null} #define PARAM_ID_SP_VI_CHANNEL_MAP_CFG 0x08001203 ``` ### `PARAM_ID_SP_VI_CFSMOOTHING_CFG_PARAM` ```c theme={null} #define PARAM_ID_SP_VI_CFSMOOTHING_CFG_PARAM 0x08001364 ``` ### `PARAM_ID_VI_OUTPUT_SPLIT_ENABLE` ```c theme={null} #define PARAM_ID_VI_OUTPUT_SPLIT_ENABLE 0x080011C2 ``` ### `PARAM_ID_SPv5_VI_SPKR_DIAG_GETPKT_PARAM` ```c theme={null} #define PARAM_ID_SPv5_VI_SPKR_DIAG_GETPKT_PARAM 0x08001B5E ``` ### `PARAM_ID_SP_TH_VI_CALIB_RES_PER_SPKR_CFG` ```c theme={null} #define PARAM_ID_SP_TH_VI_CALIB_RES_PER_SPKR_CFG 0x0800150F ``` ### `PARAM_ID_MAX_RATED_TEMP` ```c theme={null} #define PARAM_ID_MAX_RATED_TEMP 0x08001510 ``` ### `EVENT_ID_SPv5_SPEAKER_DIAGNOSTICS` ```c theme={null} #define EVENT_ID_SPv5_SPEAKER_DIAGNOSTICS 0x08001538 ``` ### `EVENT_ID_VI_CALIBRATION` ```c theme={null} #define EVENT_ID_VI_CALIBRATION 0x0800119F ``` ### `EVENT_ID_TH_VI_V_VALI_PARAMS` ```c theme={null} #define EVENT_ID_TH_VI_V_VALI_PARAMS 0x08001129 ``` ### `EVENT_ID_VI_PER_SPKR_CALIBRATION` ```c theme={null} #define EVENT_ID_VI_PER_SPKR_CALIBRATION 0x08001511 ``` ### `VI_MAX_INPUT_PORTS` ```c theme={null} #define VI_MAX_INPUT_PORTS 1 ``` ### `VI_MAX_OUTPUT_PORTS` ```c theme={null} #define VI_MAX_OUTPUT_PORTS 1 ``` ### `VI_STACK_SIZE` ```c theme={null} #define VI_STACK_SIZE 4096 ``` ### `SP_IIR_TDF2_STAGES_MAX` ```c theme={null} #define SP_IIR_TDF2_STAGES_MAX 5 ``` ### `MAX_SAMPLES_IN_PACKET_48k` ```c theme={null} #define MAX_SAMPLES_IN_PACKET_48k 480 ``` ### `MAX_SAMPLES_IN_PACKET` ```c theme={null} #define MAX_SAMPLES_IN_PACKET 480 ``` ### `MAX_SAMPLES_IN_PACKET_8k` ```c theme={null} #define MAX_SAMPLES_IN_PACKET_8k 80 ``` ### `SP_IIR_TDF2_NUM_NUM_PER_STAGE` ```c theme={null} #define SP_IIR_TDF2_NUM_NUM_PER_STAGE 3 ``` ### `SP_IIR_TDF2_NUM_DEN_PER_STAGE` ```c theme={null} #define SP_IIR_TDF2_NUM_DEN_PER_STAGE 2 ``` ### `MODULE_ID_SPEAKER_PROTECTION_V7_VI` ```c theme={null} #define MODULE_ID_SPEAKER_PROTECTION_V7_VI 0x0702C003 ```