Trace Entry Table APIs

Data Structures
struct	TraceEntry

Typedefs
typedef struct TraceEntry	TraceEntry_t

Functions
traceResult	xTraceEntryCreate (TraceEntryHandle_t *pxEntryHandle)
	Creates trace entry.
traceResult	xTraceEntryDelete (TraceEntryHandle_t xEntryHandle)
	Deletes trace entry.
traceResult	xTraceEntryFind (const void *const pvAddress, TraceEntryHandle_t *pxEntryHandle)
	Finds trace entry mapped to object address.
traceResult	xTraceEntryGetCount (uint32_t *puiCount)
	Gets the number of entries in the trace entry table.
traceResult	xTraceEntryGetAtIndex (uint32_t index, TraceEntryHandle_t *pxEntryHandle)
	Gets trace table entry at index.
traceResult	xTraceEntrySetSymbol (const TraceEntryHandle_t xEntryHandle, const char *szSymbol, uint32_t uiLength)
	Sets symbol for entry.

Detailed Description

Typedef Documentation

TraceEntry_t

typedef struct TraceEntry TraceEntry_t

Trace Entry Structure

Function Documentation

xTraceEntryCreate()

traceResult xTraceEntryCreate

(

TraceEntryHandle_t *

pxEntryHandle

)

Creates trace entry.

Parameters

[out]

pxEntryHandle

Pointer to uninitialized trace entry handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEntryDelete()

traceResult xTraceEntryDelete

(

TraceEntryHandle_t

xEntryHandle

)

Deletes trace entry.

Parameters

[in]

xEntryHandle

Pointer to initialized trace entry handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEntryFind()

traceResult xTraceEntryFind	(	const void *const	pvAddress,
		TraceEntryHandle_t *	pxEntryHandle )

Finds trace entry mapped to object address.

Parameters

[in]	pvAddress	Address of object.
[out]	pxEntryHandle	Pointer to uninitialized trace entry handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEntryGetAtIndex()

traceResult xTraceEntryGetAtIndex	(	uint32_t	index,
		TraceEntryHandle_t *	pxEntryHandle )

Gets trace table entry at index.

Parameters

[in]	index	Entry index.
[out]	pxEntryHandle	Pointer to uninitialized trace entry handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEntryGetCount()

traceResult xTraceEntryGetCount

(

uint32_t *

puiCount

)

Gets the number of entries in the trace entry table.

Parameters

[out]

puiCount

Count.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEntrySetSymbol()

traceResult xTraceEntrySetSymbol	(	const TraceEntryHandle_t	xEntryHandle,
		const char *	szSymbol,
		uint32_t	uiLength )

Sets symbol for entry.

Parameters

[in]	xEntryHandle	Pointer to initialized trace entry handle.
[in]	szSymbol	Pointer to symbol string, set by function
[in]	uiLength	Symbol length

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success