Percepio Trace Recorder  v4.6.6
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

Trace Entry Table Buffer Structure

Function Documentation

◆ xTraceEntryCreate()

traceResult xTraceEntryCreate ( TraceEntryHandle_t *  pxEntryHandle)

Creates trace entry.

Parameters
[out]pxEntryHandlePointer to uninitialized trace entry handle.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEntryDelete()

traceResult xTraceEntryDelete ( TraceEntryHandle_t  xEntryHandle)

Deletes trace entry.

Parameters
[in]xEntryHandlePointer to initialized trace entry handle.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEntryFind()

traceResult xTraceEntryFind ( void *  pvAddress,
TraceEntryHandle_t *  pxEntryHandle 
)

Finds trace entry mapped to object address.

Parameters
[in]pvAddressAddress of object.
[out]pxEntryHandlePointer to uninitialized trace entry handle.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEntryGetAtIndex()

traceResult xTraceEntryGetAtIndex ( uint32_t  index,
TraceEntryHandle_t *  pxEntryHandle 
)

Gets trace table entry at index.

Parameters
[in]indexEntry index.
[out]pxEntryHandlePointer to uninitialized trace entry handle.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEntryGetCount()

traceResult xTraceEntryGetCount ( uint32_t *  puiCount)

Gets the number of entries in the trace entry table.

Parameters
[out]puiCountCount.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEntrySetSymbol()

traceResult xTraceEntrySetSymbol ( TraceEntryHandle_t  xEntryHandle,
const char *  szSymbol 
)

Sets symbol for entry.

Parameters
[in]xEntryHandlePointer to initialized trace entry handle.
[out]szSymbolPointer to symbol string, set by function
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess