Percepio Trace Recorder  v4.6.6
trcDiagnostics.h File Reference

Public trace diagnostic APIs. More...

#include <trcTypes.h>

Go to the source code of this file.

Functions

traceResult xTraceDiagnosticsGet (TraceDiagnosticsType_t xType, TraceBaseType_t *pxValue)
 Retrieve diagnostics value. More...
 
traceResult xTraceDiagnosticsSet (TraceDiagnosticsType_t xType, TraceBaseType_t xValue)
 Set diagnostics value. More...
 
traceResult xTraceDiagnosticsAdd (TraceDiagnosticsType_t xType, TraceBaseType_t xValue)
 Add to diagnostics value. More...
 
traceResult xTraceDiagnosticsIncrease (TraceDiagnosticsType_t xType)
 Increase diagnostics value. More...
 
traceResult xTraceDiagnosticsDecrease (TraceDiagnosticsType_t xType)
 Decrease diagnostics value. More...
 
traceResult xTraceDiagnosticsSetIfHigher (TraceDiagnosticsType_t xType, TraceBaseType_t xValue)
 Set a new diagnostics value if higher than previous value. More...
 
traceResult xTraceDiagnosticsSetIfLower (TraceDiagnosticsType_t xType, TraceBaseType_t xValue)
 Set a new diagnostics value if lower than previous value. More...
 
traceResult xTraceDiagnosticsCheckStatus (void)
 Check the diagnostics status. More...
 

Detailed Description

Public trace diagnostic APIs.

Function Documentation

◆ xTraceDiagnosticsAdd()

traceResult xTraceDiagnosticsAdd ( TraceDiagnosticsType_t  xType,
TraceBaseType_t  xValue 
)

Add to diagnostics value.

Parameters
[in]xTypeDiagnostics type
[in]xValueValue
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceDiagnosticsCheckStatus()

traceResult xTraceDiagnosticsCheckStatus ( void  )

Check the diagnostics status.

Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceDiagnosticsDecrease()

traceResult xTraceDiagnosticsDecrease ( TraceDiagnosticsType_t  xType)

Decrease diagnostics value.

Parameters
[in]xTypeDiagnostics type
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceDiagnosticsGet()

traceResult xTraceDiagnosticsGet ( TraceDiagnosticsType_t  xType,
TraceBaseType_t *  pxValue 
)

Retrieve diagnostics value.

Parameters
[in]xTypeDiagnostics type
[out]pxValuePointer to value
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceDiagnosticsIncrease()

traceResult xTraceDiagnosticsIncrease ( TraceDiagnosticsType_t  xType)

Increase diagnostics value.

Parameters
[in]xTypeDiagnostics type
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceDiagnosticsSet()

traceResult xTraceDiagnosticsSet ( TraceDiagnosticsType_t  xType,
TraceBaseType_t  xValue 
)

Set diagnostics value.

Parameters
[in]xTypeDiagnostics type
[in]xValueValue
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceDiagnosticsSetIfHigher()

traceResult xTraceDiagnosticsSetIfHigher ( TraceDiagnosticsType_t  xType,
TraceBaseType_t  xValue 
)

Set a new diagnostics value if higher than previous value.

Parameters
[in]xTypeDagnostics type
[in]xValueValue
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceDiagnosticsSetIfLower()

traceResult xTraceDiagnosticsSetIfLower ( TraceDiagnosticsType_t  xType,
TraceBaseType_t  xValue 
)

Set a new diagnostics value if lower than previous value.

Parameters
[in]xTypeDagnostics type
[in]xValueValue
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess