probe.h File Reference

IPC4 audio probe injection, extraction, and DMA definitions. More...

Include dependency graph for probe.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
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...

Macros
#define	PROBE_LOGGING_BUFFER_ID   0x01000000
	Buffer ID used in probe output stream headers for logging data packet.
#define	PROBE_PURPOSE_EXTRACTION   0
	Probe extraction mode: extract audio from pipeline to host.
#define	PROBE_PURPOSE_INJECTION   1
	Probe injection mode: inject host audio into pipeline.
#define	PROBE_TYPE_INPUT   0
	Probe point attached to module input pin.
#define	PROBE_TYPE_OUTPUT   1
	Probe point attached to module output pin.
#define	PROBE_TYPE_INTERNAL   2
	Probe point attached to internal module buffer.
#define	IPC4_PROBE_MODULE_INJECTION_DMA_ADD   1
	Probe module parameter: add injection DMA channel.
#define	IPC4_PROBE_MODULE_INJECTION_DMA_DETACH   2
	Probe module parameter: detach injection DMA channel.
#define	IPC4_PROBE_MODULE_PROBE_POINTS_ADD   3
	Probe module parameter: connect probe points.
#define	IPC4_PROBE_MODULE_DISCONNECT_PROBE_POINTS   4
	Probe module parameter: disconnect probe points.
#define	IPC4_PROBE_MODULE_AVAILABLE_PROBE_POINTS   5
	Probe module parameter: query active/available probe points.

Detailed Description

IPC4 audio probe injection, extraction, and DMA definitions.

NOTE: This ABI uses bit fields and is non portable.

Macro Definition Documentation

IPC4_PROBE_MODULE_AVAILABLE_PROBE_POINTS

#define IPC4_PROBE_MODULE_AVAILABLE_PROBE_POINTS   5

Probe module parameter: query active/available probe points.

IPC4_PROBE_MODULE_DISCONNECT_PROBE_POINTS

#define IPC4_PROBE_MODULE_DISCONNECT_PROBE_POINTS   4

Probe module parameter: disconnect probe points.

IPC4_PROBE_MODULE_INJECTION_DMA_ADD

#define IPC4_PROBE_MODULE_INJECTION_DMA_ADD   1

Probe module parameter: add injection DMA channel.

IPC4_PROBE_MODULE_INJECTION_DMA_DETACH

#define IPC4_PROBE_MODULE_INJECTION_DMA_DETACH   2

Probe module parameter: detach injection DMA channel.

IPC4_PROBE_MODULE_PROBE_POINTS_ADD

#define IPC4_PROBE_MODULE_PROBE_POINTS_ADD   3

Probe module parameter: connect probe points.

PROBE_LOGGING_BUFFER_ID

#define PROBE_LOGGING_BUFFER_ID   0x01000000

Buffer ID used in probe output stream headers for logging data packet.

PROBE_PURPOSE_EXTRACTION

#define PROBE_PURPOSE_EXTRACTION   0

Probe extraction mode: extract audio from pipeline to host.

PROBE_PURPOSE_INJECTION

#define PROBE_PURPOSE_INJECTION   1

Probe injection mode: inject host audio into pipeline.

PROBE_TYPE_INPUT

#define PROBE_TYPE_INPUT   0

Probe point attached to module input pin.

PROBE_TYPE_INTERNAL

#define PROBE_TYPE_INTERNAL   2

Probe point attached to internal module buffer.

PROBE_TYPE_OUTPUT

#define PROBE_TYPE_OUTPUT   1

Probe point attached to module output pin.