Percepio Trace Recorder  v4.6.6
trcError.h
Go to the documentation of this file.
1 /*
2 * Percepio Trace Recorder for Tracealyzer v4.6.6
3 * Copyright 2021 Percepio AB
4 * www.percepio.com
5 *
6 * SPDX-License-Identifier: Apache-2.0
7 */
8 
15 #ifndef TRC_ERROR_H
16 #define TRC_ERROR_H
17 
18 #if (TRC_USE_TRACEALYZER_RECORDER == 1)
19 
20 #if (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING)
21 
22 #include <trcTypes.h>
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
34 #define TRC_ERROR_BUFFER_SIZE (sizeof(uint32_t) + sizeof(uint32_t) + sizeof(TraceStringHandle_t))
35 
36 typedef struct TraceErrorBuffer
37 {
38  uint32_t buffer[(TRC_ERROR_BUFFER_SIZE) / sizeof(uint32_t)];
39 } TraceErrorBuffer_t;
40 
49 traceResult xTraceErrorInitialize(TraceErrorBuffer_t* pxBuffer);
50 
59 traceResult xTraceWarning(uint32_t uiErrorCode);
60 
69 traceResult xTraceError(uint32_t uiErrorCode);
70 
79 traceResult xTraceErrorGetLast(const char** pszError);
80 
87 traceResult xTraceErrorClear(void);
88 
91 #ifdef __cplusplus
92 }
93 #endif
94 
95 #endif /* (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING) */
96 
97 #endif /* (TRC_USE_TRACEALYZER_RECORDER == 1) */
98 
99 #endif /* TRC_ERROR_H*/
xTraceErrorGetLast
traceResult xTraceErrorGetLast(const char **pszError)
Retrieve the string for the last error.
Definition: trcError.c:106
xTraceError
traceResult xTraceError(uint32_t uiErrorCode)
Register an error.
Definition: trcError.c:73
xTraceWarning
traceResult xTraceWarning(uint32_t uiErrorCode)
Register a warning.
Definition: trcError.c:52
xTraceErrorClear
traceResult xTraceErrorClear(void)
Clears any errors.
Definition: trcError.c:125