Trace Entry Table APIs

Data Structures
struct	TraceEntry
struct	TraceEntryTableBuffer

Typedefs
typedef struct TraceEntry	TraceEntry_t
typedef struct TraceEntryTableBuffer	TraceEntryTableBuffer_t

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

Detailed Description

Typedef Documentation

TraceEntry_t

typedef struct TraceEntry TraceEntry_t

Trace Entry Structure

TraceEntryTableBuffer_t

typedef struct TraceEntryTableBuffer TraceEntryTableBuffer_t

Trace Entry Table Buffer 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	(	void *	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	(	TraceEntryHandle_t	xEntryHandle,
		const char *	szSymbol
	)

Sets symbol for entry.

Parameters

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

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success