Skip to main content
Header: spf/api/modules/audio_if_api.h

Structures

param_id_audio_if_intf_cfg_t

Payload for #PARAM_ID_AUDIO_IF_CFG. Members
uint16_t
QAIF types.
uint16_t
Index types for the audio_if interface.
uint16_t
Audio interface mode.
uint16_t
Specifies whether the PCM block shares the data-out signal to the driver with other masters.
uint32_t
Specifies the position of the active slot.
uint16_t
Number of slots per frame.
uint16_t
Width of the slot in a audio_if frame.
uint32_t
Position of the active audio_if lanes: 1 to ((2^N)-1), where N is the number of physical lanes supported by the hardware interface.
uint32_t
Defines the sampling rate of frame sync of the interface.
uint16_t
Specifies the Slave or Master mode of operation.
uint16_t
Indicates the audio_if Synchronization mode.
uint16_t
Specifies whether to invert synchronization.
uint16_t
Indicates the number of bit-clock cycles when delaying data for synchronization.
uint16_t
Indicates the bit clock type.
uint8_t
Specifies whether to invert the clock supplied to the blocks inside QAIF.
uint8_t
Specifies whether to invert the clock supplied to the blocks outside of QAIF.

param_id_audio_if_full_cycle_cfg_t

Payload for PARAM_ID_AUDIO_IF_FULL_CYCLE_CFG. Members
uint16_t
Full Cycle configuration enable.
uint8_t
Specifies whether to invert the launch clock.
uint8_t
Specifies whether to invert the capture clock.

Type Definitions

audio_if_idx_t

Valid indices of Audio Interface.

audio_if_intf_mode_t

Valid modes of Audio Interface.

audio_if_frame_sync_mode_t

Valid frame sync modes.

audio_if_frame_sync_data_delay_t

Valid frame sync data delay.

audio_if_frame_sync_src_t

Valid frame sync source.

audio_if_slots_per_frame_t

Valid slots per frame.

audio_if_slot_width_t

Valid slot width.

audio_if_bit_clk_type_t

Valid bit clock types.

param_id_audio_if_intf_cfg_t

audio_if_full_cycle_en_t

param_id_audio_if_full_cycle_cfg_t

Enumerations

audio_if_idx_t

Valid indices of Audio Interface.

Values

audio_if_intf_mode_t

Valid modes of Audio Interface.

Values

audio_if_frame_sync_mode_t

Valid frame sync modes.

Values

audio_if_frame_sync_data_delay_t

Valid frame sync data delay.

Values

audio_if_frame_sync_src_t

Valid frame sync source.

Values

audio_if_slots_per_frame_t

Valid slots per frame.

Values

audio_if_slot_width_t

Valid slot width.

Values

audio_if_bit_clk_type_t

Valid bit clock types.

Values

audio_if_full_cycle_en_t

Values

Macros

PORT_ID_AUDIO_IF_INPUT

Input port ID of audio_if module.

PORT_ID_AUDIO_IF_OUTPUT

Output port ID of audio_if module.

AUDIO_IF_STACK_SIZE

AUDIO_IF_CTRL_DATA_OE_DISABLE

Enumeration for disabling the audio_if configuration ctrl_data_out_enable parameter.

AUDIO_IF_CTRL_DATA_OE_ENABLE

Enumeration for enabling the audio_if configuration ctrl_data_out_enable parameter.

AUDIO_IF_FRAME_SYNC_NORMAL

Enumeration for the Normal synchronization.

AUDIO_IF_FRAME_SYNC_INVERT

Enumeration for inverting the synchronization.

AUDIO_IF_INT_CLK_NORMAL

Enumeration for the bit clock supply without inversion to the blocks inside QAIF.

AUDIO_IF_INT_CLK_INVERT

Enumeration for inverting the bit clock supply to the blocks inside QAIF.

AUDIO_IF_EXT_CLK_NORMAL

Enumeration for the bit clock supply without inversion to the blocks outside QAIF.

AUDIO_IF_EXT_CLK_INVERT

Enumeration for the bit clock supply with inversion to the blocks outside QAIF.

AUDIO_IF_CAPTURE_CLK_NORMAL

Enumeration for normal capture clock.

AUDIO_IF_CAPTURE_CLK_INVERT

Enumeration for inverting the capture clock.

AUDIO_IF_LAUNCH_CLK_NORMAL

Enumeration for the Normal launch clock.

AUDIO_IF_LAUNCH_CLK_INVERT

Enumeration for inverting the launch clock.

AUDIO_IF_MAX_CHANNEL_CNT

Maximum number of channels for the audio_if interface.

PARAM_ID_AUDIO_IF_INTF_CFG

Identifier for the parameter that configure the audio_if interface.

PARAM_ID_AUDIO_IF_FULL_CYCLE_CFG

Identifier for the parameter that configure the full cycle setting of audio_if interface.

MODULE_ID_AUDIO_IF_SINK

Identifier for the hardware audio_if Sink module.

MODULE_ID_AUDIO_IF_SOURCE

Identifier for the audio_if Source module.