Percepio Trace Recorder  v4.6.6
Trace Counter APIs

Macros

#define xTraceCounterAdd(xCounterHandle, xValue)   xTraceCounterSet(xCounterHandle, (TraceBaseType_t)(xTraceEntryGetStateReturn((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX)) + (xValue))
 Adds value to trace counter. More...
 
#define xTraceCounterGet(xCounterHandle, pxValue)   xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX, (TraceUnsignedBaseType_t*)(pxValue))
 Gets trace counter value. More...
 
#define xTraceCounterIncrease(xCounterHandle)   xTraceCounterAdd(xCounterHandle, 1)
 Increases trace counter value. More...
 
#define xTraceCounterDecrease(xCounterHandle)   xTraceCounterAdd(xCounterHandle, -1)
 Decreases trace counter value. More...
 
#define xTraceCounterGetUpperLimit(xCounterHandle, pxValue)   xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_UPPER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))
 Gets trace counter upper limit. More...
 
#define xTraceCounterGetLowerLimit(xCounterHandle, pxValue)   xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_LOWER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))
 Gets trace counter lower limit. More...
 
#define xTraceCounterGetName(xCounterHandle, pszName)   xTraceEntryGetSymbol((TraceEntryHandle_t)(xCounterHandle), pszName)
 Gets trace counter name. More...
 

Functions

traceResult xTraceCounterSetCallback (TraceCounterCallback_t xCallback)
 Sets trace counter callback. More...
 
traceResult xTraceCounterCreate (const char *szName, TraceBaseType_t xInitialValue, TraceBaseType_t xLowerLimit, TraceBaseType_t xUpperLimit, TraceCounterHandle_t *pxCounterHandle)
 Creates trace counter. More...
 
traceResult xTraceCounterSet (TraceCounterHandle_t xCounterHandle, TraceBaseType_t xValue)
 Sets trace counter value. More...
 

Detailed Description

Macro Definition Documentation

◆ xTraceCounterAdd

#define xTraceCounterAdd (   xCounterHandle,
  xValue 
)    xTraceCounterSet(xCounterHandle, (TraceBaseType_t)(xTraceEntryGetStateReturn((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX)) + (xValue))

Adds value to trace counter.

Parameters
[in]xCounterHandleInitialized trace counter handle.
[in]xValueValue.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceCounterDecrease

#define xTraceCounterDecrease (   xCounterHandle)    xTraceCounterAdd(xCounterHandle, -1)

Decreases trace counter value.

Parameters
[in]xCounterHandleInitialized trace counter handle
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceCounterGet

#define xTraceCounterGet (   xCounterHandle,
  pxValue 
)    xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX, (TraceUnsignedBaseType_t*)(pxValue))

Gets trace counter value.

Parameters
[in]xCounterHandleInitialized trace counter handle.
[out]pxValueReturned value.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceCounterGetLowerLimit

#define xTraceCounterGetLowerLimit (   xCounterHandle,
  pxValue 
)    xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_LOWER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))

Gets trace counter lower limit.

Parameters
[in]xCounterHandleInitialized trace counter handle
[out]pxValueReturned value
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceCounterGetName

#define xTraceCounterGetName (   xCounterHandle,
  pszName 
)    xTraceEntryGetSymbol((TraceEntryHandle_t)(xCounterHandle), pszName)

Gets trace counter name.

Parameters
[in]xCounterHandleInitialized trace counter handle.
[out]pszNameReturned name.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceCounterGetUpperLimit

#define xTraceCounterGetUpperLimit (   xCounterHandle,
  pxValue 
)    xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_UPPER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))

Gets trace counter upper limit.

Parameters
[in]xCounterHandleInitialized trace counter handle
[out]pxValueReturned value
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceCounterIncrease

#define xTraceCounterIncrease (   xCounterHandle)    xTraceCounterAdd(xCounterHandle, 1)

Increases trace counter value.

Parameters
[in]xCounterHandleInitialized trace counter handle
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

Function Documentation

◆ xTraceCounterCreate()

traceResult xTraceCounterCreate ( const char *  szName,
TraceBaseType_t  xInitialValue,
TraceBaseType_t  xLowerLimit,
TraceBaseType_t  xUpperLimit,
TraceCounterHandle_t *  pxCounterHandle 
)

Creates trace counter.

Parameters
[in]szNameName.
[in]xInitialValueInitial value.
[in]xLowerLimitLower limit.
[in]xUpperLimitUpper limit.
[out]pxCounterHandleUninitialized trace counter handle.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceCounterSet()

traceResult xTraceCounterSet ( TraceCounterHandle_t  xCounterHandle,
TraceBaseType_t  xValue 
)

Sets trace counter value.

Parameters
[in]xCounterHandleInitialized trace counter handle.
[in]xValueValue.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceCounterSetCallback()

traceResult xTraceCounterSetCallback ( TraceCounterCallback_t  xCallback)

Sets trace counter callback.

Parameters
[in]xCallbackCallback
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess