Host DMA trace logging control, audio probe injection and extraction data streams, and module-specific configuration payloads. More...

Collaboration diagram for IPC4 Telemetry, Logging & Audio Probes:

Files
file	aec.h
	Acoustic Echo Cancellation (AEC) module configuration and parameter definitions.

file	detect_test.h
	Keyword Detector (KD) test module configuration and parameter definitions.

file	kpb.h
	Key Phrase Buffer (KPB) audio pre-roll module configuration and parameters.

file	logging.h
	IPC4 host logging control and configuration interface.

file	probe.h
	IPC4 audio probe injection, extraction, and DMA definitions.

Data Structures
struct	sof_ipc4_aec_config
	AEC module configuration payload. More...

struct	ipc4_kpb_module_cfg
	KPB module instance base configuration structure. More...

struct	probe_dma
	Host DMA channel descriptor allocated for audio probes. More...

union	probe_point_id_t
	Packed identifier identifying target audio buffer for probe attachment. More...

struct	probe_point
	Probe tap point descriptor binding a pipeline buffer to a probe purpose. More...

struct	sof_ipc_probe_info_params
	Reply to INFO queries (SOF_IPC_PROBE_DMA_INFO, SOF_IPC_PROBE_POINT_INFO). More...

struct	ipc4_probe_module_cfg
	Probe module configuration structure. More...

Enumerations
enum	sof_ipc4_aec_config_params { IPC4_AEC_SET_EXT_FMT }
	Parameter IDs for AEC module LargeConfigSet/Get. More...

enum	ipc4_detect_test_module_config_params { IPC4_DETECT_TEST_SET_MODEL_BLOB = 1 , IPC4_DETECT_TEST_SET_CONFIG = 2 , IPC4_DETECT_TEST_GET_CONFIG = 3 }
	Parameter IDs for Keyword Detector test module LargeConfigSet/Get. More...

enum	ipc4_kpb_module_config_params { KP_BUF_CFG_FM_MODULE = 1 , KP_BUF_CLIENT_MIC_SELECT = 11 }
	Parameter IDs for KPB module LargeConfigSet/Get. More...

Functions
int	ipc4_logging_enable_logs (bool first_block, bool last_block, uint32_t data_offset_or_size, const char *data)
	Configure and enable firmware logging requested by the host via IPC4.

int	ipc4_logging_shutdown (void)
	Shutdown active IPC4 firmware logging and flush remaining trace buffers.

Detailed Description

Host DMA trace logging control, audio probe injection and extraction data streams, and module-specific configuration payloads.

Enumeration Type Documentation

Parameter IDs for Keyword Detector test module LargeConfigSet/Get.

Enumerator
IPC4_DETECT_TEST_SET_MODEL_BLOB	Send neural network keyword detection model binary blob via LargeConfigSet.
IPC4_DETECT_TEST_SET_CONFIG	Configure Keyword Detector operational thresholds and parameters via LargeConfigSet.
IPC4_DETECT_TEST_GET_CONFIG	Query current Keyword Detector operational configuration via LargeConfigGet.

Parameter IDs for KPB module LargeConfigSet/Get.

Enumerator
KP_BUF_CFG_FM_MODULE	Configure module IDs that execute within Fast Mode (FM) draining tasks.
KP_BUF_CLIENT_MIC_SELECT	Real-time sink microphone channel selector ID.

Parameter IDs for AEC module LargeConfigSet/Get.

Enumerator
IPC4_AEC_SET_EXT_FMT	Configure extended reference and output formats.

Configure and enable firmware logging requested by the host via IPC4.

Parameters

first_block	True if this buffer is the first chunk of logging configuration.
last_block	True if this buffer is the final chunk of logging configuration.
data_offset_or_size	Byte offset or payload size of the configuration block.
data	Pointer to configuration payload buffer.

int ipc4_logging_shutdown ( void )

Shutdown active IPC4 firmware logging and flush remaining trace buffers.