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

Structures

dls_param_id_config_buffer_t

Payload for #DLS_CMD_CONFIG_BUFFER. Members
uint32_t
Lower 32-bits of the 64-bit buffer starting address.
uint32_t
Upper 32-bits of the 64-bit buffer starting address.
uint32_t
Unique identifier for a shared memory address.
uint32_t
Total allocated buffer size for the data logging service.
uint32_t
Maximum one single log packet size.
uint32_t
This parameter is used to differentiate between the buffer configuration before starting the data logging and deconfiguration when the data logging is complete 1 - Configuration at the beginning to use the given memory space for the data logging.

dls_param_id_enable_disable_log_code_t

Payload for DLS_PARAM_ID_ENABLE_DISABLE_LOG_CODE. Members
uint32_t
Flag to indicate the log code is requested to be enabled or disabled.
uint32_t
Number of log codes to enable/disable.
uint32_t
This is a Flexible Array Member to list the log codes to be enabled/disabled.

dls_buf_start_addr_t

Members
uint32_t
This field contains the lower 32-bits of the 64-bit buffer starting address.
uint32_t
This field contains the upper 32-bits of the 64-bit buffer starting address.
uint32_t
Unique identifier for a shared memory address.

dls_data_event_id_commit_log_buffer_t

Payload for DLS_DATA_CMD_BUFFER_RETURN. Members
uint32_t
Total number of logged buffers that are committed.
dls_buf_start_addr_t
This is a flexible array member and it contains the following: lower 32-bits of the 64-bit buffer starting addresses upper 32-bits of the 64-bit buffer starting addresses.

dls_data_cmd_buffer_return_t

Payload for DLS_DATA_CMD_BUFFER_RETURN. Members
uint32_t
Total number of buffers that need to be returned.
dls_buf_start_addr_t
This field contains the 64-bit buffer starting addresses.

dls_buf_hdr_t

Members
uint32_t
It indicates the size of the data logged into the buffer.
dls_buf_state_t
It indicates the current state of a data logging buffer.
uint32_t
It indicates the available buffer space in percentage.

Type Definitions

dls_param_id_config_buffer_t

dls_param_id_enable_disable_log_code_t

dls_buf_start_addr_t

dls_data_event_id_commit_log_buffer_t

dls_data_cmd_buffer_return_t

dls_buf_hdr_t

Enumerations

dls_buf_state_t

Used to identify the state of the buffer.

Values

Macros

DLS_MODULE_INSTANCE_ID

Identifier for an instance of the Audio Logging Server module.

DLS_PARAM_ID_CONFIG_BUFFER

Used to configure the data logging service buffer information.

DLS_PARAM_ID_ENABLE_DISABLE_LOG_CODE

Used to configure the log code to start/stop the data logging.

DLS_DATA_EVENT_ID_COMMIT_LOG_BUFFER

Used to let the client know that a buffer of data is logged and is ready to be read at client side.

DLS_DATA_CMD_BUFFER_RETURN

Used to return the logged buffer.