Percepio Trace Recorder v4.8.0.hotfix1
Loading...
Searching...
No Matches
Trace Extension APIs

Macros

#define xTraceExtensionGetEventId(xExtensionHandle, uiLocalEventId)   ((uint32_t)xTraceEntryGetStateReturn((TraceEntryHandle_t)(xExtensionHandle), TRC_EXTENSION_STATE_INDEX_BASE_EVENT_ID) + (uiLocalEventId))
 Returns extension event id.
 

Functions

traceResult xTraceExtensionInitialize (TraceExtensionData_t *const pxBuffer)
 Initializes the Extension trace system.
 
traceResult xTraceExtensionCreate (const char *szName, uint8_t uiMajor, uint8_t uiMinor, uint16_t uiPatch, uint32_t uiEventCount, TraceExtensionHandle_t *pxExtensionHandle)
 Creates trace extension.
 
traceResult xTraceExtensionGetBaseEventId (TraceExtensionHandle_t xExtensionHandle, uint32_t *puiBaseEventId)
 Gets extension base event id.
 
traceResult xTraceExtensionGetConfigName (TraceExtensionHandle_t xExtensionHandle, const char **pszName)
 Gets extension configuration name.
 

Detailed Description

Macro Definition Documentation

◆ xTraceExtensionGetEventId

#define xTraceExtensionGetEventId (   xExtensionHandle,
  uiLocalEventId 
)    ((uint32_t)xTraceEntryGetStateReturn((TraceEntryHandle_t)(xExtensionHandle), TRC_EXTENSION_STATE_INDEX_BASE_EVENT_ID) + (uiLocalEventId))

Returns extension event id.

Parameters
[in]xExtensionHandlePointer to initialized extension handle.
[in]uiLocalEventIdLocal event id.
Returns
Extension event id

Function Documentation

◆ xTraceExtensionCreate()

traceResult xTraceExtensionCreate ( const char *  szName,
uint8_t  uiMajor,
uint8_t  uiMinor,
uint16_t  uiPatch,
uint32_t  uiEventCount,
TraceExtensionHandle_t *  pxExtensionHandle 
)

Creates trace extension.

Parameters
[in]szNameName.
[in]uiMajorMajor version.
[in]uiMinorMinor version.
[in]uiPatchPatch version.
[in]uiEventCountEvent count.
[out]pxExtensionHandlePointer to uninitialized extension handle.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceExtensionGetBaseEventId()

traceResult xTraceExtensionGetBaseEventId ( TraceExtensionHandle_t  xExtensionHandle,
uint32_t *  puiBaseEventId 
)

Gets extension base event id.

Parameters
[in]xExtensionHandlePointer to initialized extension handle.
[out]puiBaseEventIdBase event id.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceExtensionGetConfigName()

traceResult xTraceExtensionGetConfigName ( TraceExtensionHandle_t  xExtensionHandle,
const char **  pszName 
)

Gets extension configuration name.

Parameters
[in]xExtensionHandlePointer to initialized extension handle.
[out]pszNameName.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceExtensionInitialize()

traceResult xTraceExtensionInitialize ( TraceExtensionData_t *const  pxBuffer)

Initializes the Extension trace system.

Parameters
[in]pxBufferPointer to memory that is used by the extension trace system
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess