Percepio Trace Recorder  v4.6.6
Trace Object APIs

Macros

#define xTraceObjectSetState(xObjectHandle, uxState)   xTraceObjectSetSpecificState(xObjectHandle, 0, uxState)
 Sets trace object state. More...
 
#define xTraceObjectSetSpecificState(xObjectHandle, uiIndex, uxState)   xTraceEntrySetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, uxState)
 Sets trace object specific state state. More...
 
#define xTraceObjectSetOptions(xObjectHandle, uiOptions)   xTraceEntrySetOptions((TraceEntryHandle_t)(xObjectHandle), uiOptions)
 Sets trace object options. More...
 
#define xTraceObjectSetStateWithoutHandle(pvObject, uxState)   xTraceObjectSetSpecificStateWithoutHandle(pvObject, 0, uxState)
 Set trace object state without trace object handle. More...
 

Functions

traceResult xTraceObjectRegisterInternal (uint32_t uiEventCode, void *pvObject, const char *szName, TraceUnsignedBaseType_t uxStateCount, TraceUnsignedBaseType_t uxStates[], TraceUnsignedBaseType_t uxOptions, TraceObjectHandle_t *pxObjectHandle)
 Registers trace object. More...
 
traceResult xTraceObjectRegister (uint32_t uiEventCode, void *pvObject, const char *szName, TraceUnsignedBaseType_t uxState, TraceObjectHandle_t *pxObjectHandle)
 Registers trace object. More...
 
traceResult xTraceObjectUnregister (TraceObjectHandle_t xObjectHandle, uint32_t uiEventCode, TraceUnsignedBaseType_t uxState)
 Unregisters trace object. More...
 
traceResult xTraceObjectSetName (TraceObjectHandle_t xObjectHandle, const char *szName)
 Sets trace object name. More...
 
traceResult xTraceObjectRegisterWithoutHandle (uint32_t uiEventCode, void *pvObject, const char *szName, TraceUnsignedBaseType_t uxState)
 Registers trace object without trace object handle. More...
 
traceResult xTraceObjectUnregisterWithoutHandle (uint32_t uiEventCode, void *pvObject, TraceUnsignedBaseType_t uxState)
 Unregisters trace object without trace object handle. More...
 
traceResult xTraceObjectSetNameWithoutHandle (void *pvObject, const char *szName)
 Set trace object name without trace object handle. More...
 
traceResult xTraceObjectSetSpecificStateWithoutHandle (void *pvObject, uint32_t uiIndex, TraceUnsignedBaseType_t uxState)
 Sets trace object specific state without trace object handle. More...
 
traceResult xTraceObjectSetOptionsWithoutHandle (void *pvObject, uint32_t uiOptions)
 Sets trace object options without trace object handle. More...
 

Detailed Description

Macro Definition Documentation

◆ xTraceObjectSetOptions

#define xTraceObjectSetOptions (   xObjectHandle,
  uiOptions 
)    xTraceEntrySetOptions((TraceEntryHandle_t)(xObjectHandle), uiOptions)

Sets trace object options.

Parameters
[in]xObjectHandlePointer to initialized trace object.
[in]uiOptionsOptions.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectSetSpecificState

#define xTraceObjectSetSpecificState (   xObjectHandle,
  uiIndex,
  uxState 
)    xTraceEntrySetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, uxState)

Sets trace object specific state state.

Parameters
[in]xObjectHandlePointer to initialized trace object.
[in]uiIndexState Index.
[in]uxStateState.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectSetState

#define xTraceObjectSetState (   xObjectHandle,
  uxState 
)    xTraceObjectSetSpecificState(xObjectHandle, 0, uxState)

Sets trace object state.

Parameters
[in]xObjectHandlePointer to initialized trace object.
[in]uxStateState.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectSetStateWithoutHandle

#define xTraceObjectSetStateWithoutHandle (   pvObject,
  uxState 
)    xTraceObjectSetSpecificStateWithoutHandle(pvObject, 0, uxState)

Set trace object state without trace object handle.

Parameters
[in]pvObjectObject.
[in]uxStateState.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

Function Documentation

◆ xTraceObjectRegister()

traceResult xTraceObjectRegister ( uint32_t  uiEventCode,
void *  pvObject,
const char *  szName,
TraceUnsignedBaseType_t  uxState,
TraceObjectHandle_t *  pxObjectHandle 
)

Registers trace object.

Parameters
[in]uiEventCodeEvent code.
[in]pvObjectObject.
[in]szNameName.
[in]uxStateState.
[out]pxObjectHandlePointer to uninitialized trace object.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectRegisterInternal()

traceResult xTraceObjectRegisterInternal ( uint32_t  uiEventCode,
void *  pvObject,
const char *  szName,
TraceUnsignedBaseType_t  uxStateCount,
TraceUnsignedBaseType_t  uxStates[],
TraceUnsignedBaseType_t  uxOptions,
TraceObjectHandle_t *  pxObjectHandle 
)

Registers trace object.

Parameters
[in]uiEventCodeEvent code.
[in]pvObjectObject.
[in]szNameName.
[in]uxStateCountState count.
[in]uxStatesStates.
[in]uxOptionsOptions.
[out]pxObjectHandlePointer to uninitialized trace object.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectRegisterWithoutHandle()

traceResult xTraceObjectRegisterWithoutHandle ( uint32_t  uiEventCode,
void *  pvObject,
const char *  szName,
TraceUnsignedBaseType_t  uxState 
)

Registers trace object without trace object handle.

Parameters
[in]uiEventCodeEvent code.
[in]pvObjectObject.
[in]szNameName.
[in]uxStateState.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectSetName()

traceResult xTraceObjectSetName ( TraceObjectHandle_t  xObjectHandle,
const char *  szName 
)

Sets trace object name.

Parameters
[in]xObjectHandlePointer to initialized trace object.
[in]szNameName.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectSetNameWithoutHandle()

traceResult xTraceObjectSetNameWithoutHandle ( void *  pvObject,
const char *  szName 
)

Set trace object name without trace object handle.

Parameters
[in]pvObjectObject.
[in]szNameName.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectSetOptionsWithoutHandle()

traceResult xTraceObjectSetOptionsWithoutHandle ( void *  pvObject,
uint32_t  uiOptions 
)

Sets trace object options without trace object handle.

Parameters
[in]pvObjectObject.
[in]uiOptionsOptions.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectSetSpecificStateWithoutHandle()

traceResult xTraceObjectSetSpecificStateWithoutHandle ( void *  pvObject,
uint32_t  uiIndex,
TraceUnsignedBaseType_t  uxState 
)

Sets trace object specific state without trace object handle.

Parameters
[in]pvObjectObject.
[in]uiIndexState index.
[in]uxStateState.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectUnregister()

traceResult xTraceObjectUnregister ( TraceObjectHandle_t  xObjectHandle,
uint32_t  uiEventCode,
TraceUnsignedBaseType_t  uxState 
)

Unregisters trace object.

Parameters
[in]xObjectHandlePointer to initialized trace object.
[in]uiEventCodeEvent code.
[in]uxStateState.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceObjectUnregisterWithoutHandle()

traceResult xTraceObjectUnregisterWithoutHandle ( uint32_t  uiEventCode,
void *  pvObject,
TraceUnsignedBaseType_t  uxState 
)

Unregisters trace object without trace object handle.

Parameters
[in]uiEventCodeEvent code.
[in]pvObjectObject.
[in]uxStateState.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess