Public trace diagnostic APIs.
More...
#include <trcTypes.h>
Go to the source code of this file.
Public trace diagnostic APIs.
◆ xTraceDiagnosticsAdd()
traceResult xTraceDiagnosticsAdd |
( |
TraceDiagnosticsType_t |
xType, |
|
|
TraceBaseType_t |
xValue |
|
) |
| |
Add to diagnostics value.
- Parameters
-
[in] | xType | Diagnostics type |
[in] | xValue | Value |
- Return values
-
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
◆ xTraceDiagnosticsCheckStatus()
traceResult xTraceDiagnosticsCheckStatus |
( |
void |
| ) |
|
Check the diagnostics status.
- Return values
-
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
◆ xTraceDiagnosticsDecrease()
traceResult xTraceDiagnosticsDecrease |
( |
TraceDiagnosticsType_t |
xType | ) |
|
Decrease diagnostics value.
- Parameters
-
[in] | xType | Diagnostics type |
- Return values
-
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
◆ xTraceDiagnosticsGet()
traceResult xTraceDiagnosticsGet |
( |
TraceDiagnosticsType_t |
xType, |
|
|
TraceBaseType_t * |
pxValue |
|
) |
| |
Retrieve diagnostics value.
- Parameters
-
[in] | xType | Diagnostics type |
[out] | pxValue | Pointer to value |
- Return values
-
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
◆ xTraceDiagnosticsIncrease()
traceResult xTraceDiagnosticsIncrease |
( |
TraceDiagnosticsType_t |
xType | ) |
|
Increase diagnostics value.
- Parameters
-
[in] | xType | Diagnostics type |
- Return values
-
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
◆ xTraceDiagnosticsSet()
traceResult xTraceDiagnosticsSet |
( |
TraceDiagnosticsType_t |
xType, |
|
|
TraceBaseType_t |
xValue |
|
) |
| |
Set diagnostics value.
- Parameters
-
[in] | xType | Diagnostics type |
[in] | xValue | Value |
- Return values
-
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
◆ xTraceDiagnosticsSetIfHigher()
traceResult xTraceDiagnosticsSetIfHigher |
( |
TraceDiagnosticsType_t |
xType, |
|
|
TraceBaseType_t |
xValue |
|
) |
| |
Set a new diagnostics value if higher than previous value.
- Parameters
-
[in] | xType | Dagnostics type |
[in] | xValue | Value |
- Return values
-
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
◆ xTraceDiagnosticsSetIfLower()
traceResult xTraceDiagnosticsSetIfLower |
( |
TraceDiagnosticsType_t |
xType, |
|
|
TraceBaseType_t |
xValue |
|
) |
| |
Set a new diagnostics value if lower than previous value.
- Parameters
-
[in] | xType | Dagnostics type |
[in] | xValue | Value |
- Return values
-
TRC_FAIL | Failure |
TRC_SUCCESS | Success |