module_endpoint_ops Struct Reference

Ops relevant only for the endpoint devices such as the host copier or DAI copier. More...

#include <module_interface.h>

Data Fields
uint64_t(*	get_total_data_processed )(struct comp_dev *dev, uint32_t stream_no, bool input)
	Returns total data processed in number bytes.
int(*	position )(struct comp_dev *dev, struct sof_ipc_stream_posn *posn)
	Retrieves component rendering position.
int(*	dai_ts_config )(struct comp_dev *dev)
	Configures timestamping in attached DAI.
int(*	dai_ts_start )(struct comp_dev *dev)
	Starts timestamping.
int(*	dai_ts_stop )(struct comp_dev *dev)
	Stops timestamping.
int(*	dai_ts_get )(struct comp_dev *dev, struct timestamp_data *tsd)
	Gets timestamp.
int(*	dai_get_hw_params )(struct comp_dev *dev, struct sof_ipc_stream_params *params, int dir)
	Fetches hardware stream parameters.
int(*	trigger )(struct comp_dev *dev, int cmd)
	Triggers device state.

Detailed Description

Ops relevant only for the endpoint devices such as the host copier or DAI copier.

Other modules should not implement these.

Field Documentation

dai_get_hw_params

int(* module_endpoint_ops::dai_get_hw_params) (struct comp_dev *dev, struct sof_ipc_stream_params *params, int dir)

Fetches hardware stream parameters.

Parameters

dev	Component device.
params	Receives copy of stream parameters retrieved from DAI hw settings.
dir	Stream direction (see enum sof_ipc_stream_direction).

Mandatory for components that allocate DAI.

dai_ts_config

int(* module_endpoint_ops::dai_ts_config) (struct comp_dev *dev)

Configures timestamping in attached DAI.

Parameters

dev	Component device.

Mandatory for components that allocate DAI.

dai_ts_get

int(* module_endpoint_ops::dai_ts_get) (struct comp_dev *dev, struct timestamp_data *tsd)

Gets timestamp.

Parameters

dev	Component device.
tsd	Receives timestamp data.

Mandatory for components that allocate DAI.

dai_ts_start

int(* module_endpoint_ops::dai_ts_start) (struct comp_dev *dev)

Starts timestamping.

Parameters

dev	Component device.

Mandatory for components that allocate DAI.

dai_ts_stop

int(* module_endpoint_ops::dai_ts_stop) (struct comp_dev *dev)

Stops timestamping.

Parameters

dev	Component device.

Mandatory for components that allocate DAI.

get_total_data_processed

uint64_t(* module_endpoint_ops::get_total_data_processed) (struct comp_dev *dev, uint32_t stream_no, bool input)

Returns total data processed in number bytes.

Parameters

dev	Component device
stream_no	Index of input/output stream
input	Selects between input (true) or output (false) stream direction

Returns

total data processed if succeeded, 0 otherwise.

position

int(* module_endpoint_ops::position) (struct comp_dev *dev, struct sof_ipc_stream_posn *posn)

Retrieves component rendering position.

Parameters

dev	Component device.
posn	Receives reported position.

trigger

int(* module_endpoint_ops::trigger) (struct comp_dev *dev, int cmd)

Triggers device state.

Parameters

dev	Component device.
cmd	Trigger command.

---

The documentation for this struct was generated from the following file:

• /home/lrg/work/sof-dox-work/src/include/sof/audio/module_adapter/module/module_interface.h