Trace Internal Event Buffer APIs

Functions
traceResult	xTraceInternalEventBufferPush (void *pvData, uint32_t uiSize, int32_t *piBytesWritten)
	Pushes data to the internal trace event buffer. More...
traceResult	xTraceInternalEventBufferTransfer (int32_t *piBytesWritten)
	Transfers all internal trace event buffer data using the function xTraceStreamPortWriteData(...) as defined in trcStreamPort.h. More...
traceResult	xTraceInternalEventBufferClear (void)
	Clears all trace events in the internal trace event buffer. More...

Detailed Description

Function Documentation

xTraceInternalEventBufferClear()

traceResult xTraceInternalEventBufferClear

(

void

)

Clears all trace events in the internal trace event buffer.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceInternalEventBufferPush()

traceResult xTraceInternalEventBufferPush	(	void *	pvData,
		uint32_t	uiSize,
		int32_t *	piBytesWritten
	)

Pushes data to the internal trace event buffer.

Parameters

[in]	pvData	Pointer to data
[in]	uiSize	Size of data
[out]	piBytesWritten	Bytes written.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceInternalEventBufferTransfer()

traceResult xTraceInternalEventBufferTransfer

(

int32_t *

piBytesWritten

)

Transfers all internal trace event buffer data using the function xTraceStreamPortWriteData(...) as defined in trcStreamPort.h.

This function is intended to be called by the periodic TzCtrl task with a suitable delay (e.g. 10-100 ms).

In case of errors from the streaming interface, it registers a warning (TRC_WARNING_STREAM_PORT_WRITE) provided by xTraceErrorGetLast().

Parameters

[out]

piBytesWritten

Bytes written.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success