Skip to main content
Header: spf/api/vcpm/vcpm_api.h

Structures

vcpm_param_id_tty_mode_t

Payload for VCPM_PARAM_ID_TTY_MODE. Members
uint32_t
Voice System identifier for TTY mode.
uint32_t
TTY mode to be set.

vcpm_param_voice_config_payload_t

Payload for VCPM_PARAM_ID_VOICE_CONFIG. Members
uint32_t
Number of vcpm_cfg_subgraph_properties_t structures and payloads that immediately follow this structure.

vcpm_cfg_subgraph_properties_t

Payload for VCPM_PARAM_ID_VOICE_CONFIG. Members
uint32_t
Identifier for the subgraph for which the information is provided.
uint32_t
Number of vcpm_property_config_struct_t structures that follow this structure.

vcpm_property_config_struct_t

Payload for VCPM_PARAM_ID_VOICE_CONFIG. Members
uint32_t
Identifier for the VCPM property.
uint32_t
Size of the property payload that immediately follows this structure.

vcpm_property_id_tag_info_payload_t

Payload for VCPM_PROPERTY_ID_TAG_INFO. Members
uint32_t
Number of vcpm_tag_miid_info_t structures that immediately follow this structure.

vcpm_tag_miid_info_t

Payload for VCPM_PROPERTY_ID_TAG_INFO. Members
uint32_t
Identifier for the tag that the VCPM publishes.
uint32_t
Identifier for the module instance that corresponds to the tag ID.

vcpm_param_cal_table_payload_t

Payload for VCPM_PARAM_ID_CAL_TABLE. Members
uint32_t
Number of voice subgraphs for which calibration tables are provided.

vcpm_sgid_cal_table_t

Payload for VCPM_PARAM_ID_CAL_TABLE. Members
uint32_t
Subgraph identifier for the calibration table that follows this structure.
uint32_t
Size of the calibration table that follows this structure.

vcpm_param_cal_keys_payload_t

Payload for VCPM_PARAM_ID_CAL_KEYS. Members
uint32_t
Voice System identifier for the calibration key.
uint32_t
Number of vcpm_ckv_pair_t structures that immediately follow this structure.

vcpm_ckv_pair_t

Payload for VCPM_PARAM_ID_CAL_KEYS and VCPM_PARAM_ID_ACTIVE_CAL_KEYS. Members
uint32_t
Unique identifier for the calibration key.
uint32_t
Values of the following calibration keys from the modem processor.

vcpm_param_active_cal_keys_payload_t

Payload for VCPM_PARAM_ID_ACTIVE_CAL_KEYS. Members
uint32_t
Unique identifier for the subgraph for which the parameter payload is provided.
uint32_t
Maximum number of ckv_pairs of the given subgraph ID.
uint32_t
Number of vcpm_ckv_pair_t structures that immediately follow this structure.

vcpm_param_num_vol_steps_payload_t

Payload for VCPM_PARAM_ID_NUM_VOL_STEPS. Members
uint32_t
Voice System identifier for the volume step.
uint32_t
Total number of volume steps for the VSID session.

vcpm_param_clk_ctrl_payload_t

Payload for VCPM_PARAM_ID_CLK_CTRL. Members
uint32_t
Scale factor to apply to the aggregated kpps of the subgraph.
uint32_t
Scale factor to apply to the aggregated bus bandwidth of the subgraph.

vcpm_event_graph_open_payload_t

Payload for VCPM_EVENT_ID_GRAPH_OPEN. Members
uint32_t
Voice System identifier for the voice call graph.
uint32_t
Number of vcpm_vs_tag_miid_info_t structures that immediately follow this structure.

vcpm_vs_tag_miid_info_t

Payload for VCPM_EVENT_ID_GRAPH_OPEN. Members
uint32_t
ID for the sub-graph that corresponds to the module instance ID.
uint32_t
Tag IDs published by the VCPM.
uint32_t
ID for the module instance that corresponds to the tag ID.

vcpm_event_graph_close_payload_t

Payload for VCPM_EVENT_ID_GRAPH_CLOSE. Members
uint32_t
Voice System identifier for the voice call graph.

vcpm_param_timing_params_t

Payload for VCPM_PARAM_ID_TIMING_PARAMS. Members
uint32_t
Frame synchronization mode for the vocoder.
uint32_t
Voice System identifier for the vocoder.
uint32_t
Offset (in microseconds) from the VFR to deliver a Tx vocoder packet.
uint32_t
Offset (in microseconds) from the VFR to indicate the deadline to receive an Rx vocoder packet.
uint32_t
VFR cycle duration for the voice call.

vcpm_param_timing_references_t

Payload for VCPM_PARAM_ID_TIMING_REFERENCES. Members
uint32_t
Frame synchronization mode for the vocoder.
uint32_t
Voice System identifier for the encoder.
uint64_t
Time reference (in microseconds) used to align the encoder’s timeline to the client’s timeline at the beginning of the vocoder’s packet exchange operation.
uint64_t
Time reference(in microseconds) used to align the decoder’s timeline to the client’s timeline at the beginning of the vocoder’s packet exchange operation.
uint32_t
VFR cycle duration for the voice call.

vcpm_param_timing_references_v2_t

Payload for VCPM_PARAM_ID_TIMING_REFERENCES_V2. Members
uint32_t
Frame synchronization mode for the vocoder.
uint32_t
Voice System identifier 2 for the vocoder.
uint64_t
Time reference (in microseconds) used to align the encoder’s timeline to the client’s timeline at the beginning of the vocoder’s packet exchange operation.
uint64_t
Time reference(in microseconds) used to align the decoder’s timeline to the client’s timeline at the beginning of the vocoder’s packet exchange operation.
uint32_t
Enables the event-driven mailbox packet exchange mode in the Tx path for NO_DATA packets.
uint64_t
Client’s time reference for receiving the frame type of an uplink packet (absolute time in microseconds).
uint32_t
Minimum allowed delay margin between the timestamp of the encoder packet being ready and read_ref_timestamp_us.
uint32_t
Duration of the VFR cycle for the voice call.

vcpm_param_vsid_payload_t

Payload for VCPM_PARAM_ID_VSID. Members
uint32_t
Voice System identifier for the graph.

vcpm_param_id_mailbox_memory_config_t

Payload for VCPM_PARAM_ID_MAILBOX_MEMORY_CONFIG. Members
uint32_t
Lower 32 bits of the IO virtual address (understandable to the aDSP) of the mailbox memory.
uint32_t
Upper 32 bits of the IO virtual address (understandable to aDSP) of the mailbox memory.
uint32_t
Lower 32 bits of the IO virtual address (understandable to the PCIe) of the mailbox memory.
uint32_t
Upper 32 bits of the IO virtual address (understandable to the PCIe) of the mailbox memory.
uint32_t
Size (in bytes) of the mailbox memory carved out from the APQ DDR.

vcpm_param_id_tx_dev_pp_channel_info_t

Payload for VCPM_PARAM_ID_TX_DEV_PP_CHANNEL_INFO. Members
uint32_t
Voice System identifier for the channel.
uint32_t
Number of channels processed by the Tx voice processor sub-graph.

vcpm_param_id_voc_pkt_loopback_delay_t

Payload structure for the VCPM_PARAM_ID_VOC_PKT_LOOPBACK_DELAY. Members
uint32_t
Voice System identifier for the vocoder packet loopback.
uint32_t
Vocoder packet loopback delay in milliseconds.

Type Definitions

vcpm_param_id_tty_mode_t

vcpm_param_voice_config_payload_t

vcpm_cfg_subgraph_properties_t

vcpm_property_config_struct_t

vcpm_property_id_tag_info_payload_t

vcpm_tag_miid_info_t

vcpm_param_cal_table_payload_t

vcpm_sgid_cal_table_t

vcpm_param_cal_keys_payload_t

vcpm_ckv_pair_t

vcpm_param_active_cal_keys_payload_t

vcpm_param_num_vol_steps_payload_t

vcpm_param_clk_ctrl_payload_t

vcpm_event_graph_open_payload_t

vcpm_vs_tag_miid_info_t

vcpm_event_graph_close_payload_t

vcpm_param_timing_params_t

vcpm_param_timing_references_t

vcpm_param_timing_references_v2_t

vcpm_param_vsid_payload_t

vcpm_param_id_mailbox_memory_config_t

vcpm_param_id_tx_dev_pp_channel_info_t

vcpm_param_id_voc_pkt_loopback_delay_t

Enumerations

platforms_spf

Values

vcpm_key_ids

Values

vcpm_key_vocoder_class

Values

vcpm_key_sample_rate

Values

vcpm_key_volume_level

Values

vcpm_key_bandwidth_extension

Values

vcpm_key_vocoder_network

Values

vcpm_key_vol_boost

Values

vcpm_cal_Keys

Values

vcpm_graph_tag_Keys

Values

Macros

VCPM_MODULE_INSTANCE_ID

Instance identifier for the VCPM static module.

VOICE_SERVICES_MODULE_INSTANCE_ID

VOICE_TTY_MODE_OFF

TTY is Off or disabled.

VOICE_TTY_MODE_HCO

Hearing Carry Over mode.

VOICE_TTY_MODE_VCO

Voice Carry Over mode.

VOICE_TTY_MODE_FULL

HCO mode plus VCO mode.

VCPM_PARAM_ID_TTY_MODE

Identifier for the parameter that sets the TTY mode of operation.

VCPM_PARAM_ID_VOICE_CONFIG

Identifier for the parameter that contains instance IDs of specific modules in a stream subgraph that is part of a voice call use case graph (applications processor).

VCPM_PROPERTY_ID_TAG_INFO

Identifier for the property that contains instance IDs of modules in different subgraphs that are part of a voice call use case graph (applications processor).

VOICE_MOD_TAG_ID_ENCODER

Tag ID for the voice encoder.

VOICE_MOD_TAG_ID_TX_MAILBOX

Tag ID for a mailbox in the Tx stream.

VOICE_MOD_TAG_ID_TX_STREAM_HPCM

Tag ID for Host PCM in the Tx stream.

VOICE_MOD_TAG_ID_DECODER

Tag ID for the voice decoder.

VOICE_MOD_TAG_ID_RX_MAILBOX

Tag ID for a mailbox in the Rx stream.

VOICE_MOD_TAG_ID_RX_STREAM_HPCM

Tag ID for HPCM in the Rx stream.

VOICE_MOD_TAG_ID_RX_TRM

Tag ID for the Timed Renderer module in the Rx stream.

VOICE_MOD_TAG_ID_TX_SMART_SYNC

Tag ID for smart synchronization in the Tx stream.

VOICE_MOD_TAG_ID_LTETTY_TX

Tag ID for LTE TTY in the Tx stream.

VOICE_MOD_TAG_ID_CTMTTY_TX

Tag ID for cellular text modem TTY in the Tx stream.

VOICE_MOD_TAG_ID_LTETTY_RX

Tag ID for LTE TTY in the Rx stream.

VOICE_MOD_TAG_ID_CTMTTY_RX

Tag ID for cellular text modem TTY in the Rx stream.

VOICE_MOD_TAG_ID_1XTTY_RX

Tag ID for 1x TTY in the Rx stream.

VCPM_PARAM_ID_CAL_TABLE

Identifier for the parameter that registers calibration tables per subgraph (from the applications processor).

VCPM_CAL_KEY_ID_VOCODER_CLASS

Identifier for the calibration key that identifes the vocoder class (from the applications processor and modem).

VCPM_CAL_KEY_ID_SAMPLING_RATE

Calibration key that identifies the sampling rate.

VCPM_CAL_KEY_ID_VOLUME_LEVEL

Calibration key that identifies the volume level.

VCPM_CAL_KEY_ID_BWE

Calibration key that identifies the bandwidth extension mode.

VCPM_CAL_KEY_ID_NETWORK

Identifier for the calibration key that identifes the network.

VCPM_CAL_KEY_ID_VOL_BOOST

Calibration key that identifies the Volume boost mode.

VCPM_CAL_KEY_VOCODER_CLASS_AMR

Calibration key that represents all the vocoders covered in the AMR class for VCPM_CAL_KEY_ID_VOCODER_CLASS.

VCPM_CAL_KEY_VOCODER_CLASS_EVRC

Calibration key that represents all the vocoders covered in the EVRC class for VCPM_CAL_KEY_ID_VOCODER_CLASS.

VCPM_CAL_KEY_VOCODER_CLASS_EVS

Calibration key that represents all the vocoders covered in the EVS class VCPM_CAL_KEY_ID_VOCODER_CLASS.

VCPM_CAL_KEY_NETWORK_CDMA

Calibration key that represents the CDMA network for VCPM_CAL_KEY_ID_NETWORK.

VCPM_CAL_KEY_NETWORK_GSM

Calibration key that represents the GSM network for VCPM_CAL_KEY_ID_NETWORK.

VCPM_CAL_KEY_NETWORK_WCDMA

Calibration key that represents the WCDMA network for VCPM_CAL_KEY_ID_NETWORK.

VCPM_CAL_KEY_NETWORK_LTE

Calibration key that represents the LTE network for VCPM_CAL_KEY_ID_NETWORK.

VCPM_CAL_KEY_NETWORK_TDSCDMA

Calibration key that represents the TD-SCDMA network for VCPM_CAL_KEY_ID_NETWORK.

VCPM_PARAM_ID_CAL_KEYS

Identifier for the parameter that sets calibration keys from both the applications processor and modem to the VCPM.

VCPM_PARAM_ID_ACTIVE_CAL_KEYS

Identifier for the parameter the applications processor uses to query active calibration keys for each voice call subgraph.

VCPM_PARAM_ID_NUM_VOL_STEPS

Identifier for the parameter that sets the number of volume steps from the applications processor to the VCPM.

VCPM_PARAM_ID_CLK_CTRL

Identifier for the parameter that sets the clock control parameters.

VCPM_EVENT_ID_GRAPH_OPEN

ID for the event that indicates a voice call graph is opened.

VCPM_EVENT_ID_GRAPH_CLOSE

Identifier for the event that indicates a voice call graph is closed.

VCPM_PARAM_ID_TIMING_PARAMS

Identifier for the parameter that sets timing parameters from the modem to the VCPM.

VCPM_PARAM_ID_TIMING_REFERENCES

Identifier for the parameter that sets timing references from the modem to the VCPM.

VCPM_PARAM_ID_TIMING_REFERENCES_V2

Identifier for the parameter that sets version 2 of the timing references from the modem to the VCPM.

VCPM_PARAM_ID_VSID

Identifier for the parameter that sets the Voice System ID from the applications processor to the VCPM.

VCPM_PARAM_ID_MAILBOX_MEMORY_CONFIG

Parameter identifier for configuring memory on the modem that is shared with mailbox Tx and Rx modules present on the aDSP for vocoder packet exchange.

VCPM_PARAM_ID_TX_DEV_PP_CHANNEL_INFO

Parameter ID the VCPM exposes to the HLOS to set the Tx channel information processed by the Tx sub-graph.

VCPM_PARAM_ID_VOC_PKT_LOOPBACK_DELAY

Identifier for the parameter that sets up the vocoder packet loopback delay.