Percepio Trace Recorder  v4.6.6
trcObject.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_OBJECT_H
16 #define TRC_OBJECT_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 
48 traceResult xTraceObjectRegisterInternal(uint32_t uiEventCode, void* pvObject, const char* szName, TraceUnsignedBaseType_t uxStateCount, TraceUnsignedBaseType_t uxStates[], TraceUnsignedBaseType_t uxOptions, TraceObjectHandle_t* pxObjectHandle);
49 
62 traceResult xTraceObjectRegister(uint32_t uiEventCode, void *pvObject, const char* szName, TraceUnsignedBaseType_t uxState, TraceObjectHandle_t *pxObjectHandle);
63 
74 traceResult xTraceObjectUnregister(TraceObjectHandle_t xObjectHandle, uint32_t uiEventCode, TraceUnsignedBaseType_t uxState);
75 
85 traceResult xTraceObjectSetName(TraceObjectHandle_t xObjectHandle, const char *szName);
86 
96 #define xTraceObjectSetState(xObjectHandle, uxState) xTraceObjectSetSpecificState(xObjectHandle, 0, uxState)
97 
108 #define xTraceObjectSetSpecificState(xObjectHandle, uiIndex, uxState) xTraceEntrySetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, uxState)
109 
119 #define xTraceObjectSetOptions(xObjectHandle, uiOptions) xTraceEntrySetOptions((TraceEntryHandle_t)(xObjectHandle), uiOptions)
120 
132 traceResult xTraceObjectRegisterWithoutHandle(uint32_t uiEventCode, void* pvObject, const char* szName, TraceUnsignedBaseType_t uxState);
133 
144 traceResult xTraceObjectUnregisterWithoutHandle(uint32_t uiEventCode, void* pvObject, TraceUnsignedBaseType_t uxState);
145 
155 traceResult xTraceObjectSetNameWithoutHandle(void* pvObject, const char* szName);
156 
166 #define xTraceObjectSetStateWithoutHandle(pvObject, uxState) xTraceObjectSetSpecificStateWithoutHandle(pvObject, 0, uxState)
167 
179 traceResult xTraceObjectSetSpecificStateWithoutHandle(void* pvObject, uint32_t uiIndex, TraceUnsignedBaseType_t uxState);
180 
190 traceResult xTraceObjectSetOptionsWithoutHandle(void* pvObject, uint32_t uiOptions);
191 
194 #ifdef __cplusplus
195 }
196 #endif
197 
198 #endif /* (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING) */
199 
200 #endif /* (TRC_USE_TRACEALYZER_RECORDER == 1) */
201 
202 #endif /* TRC_OBJECT_H */
xTraceObjectSetSpecificStateWithoutHandle
traceResult xTraceObjectSetSpecificStateWithoutHandle(void *pvObject, uint32_t uiIndex, TraceUnsignedBaseType_t uxState)
Sets trace object specific state without trace object handle.
Definition: trcObject.c:218
xTraceObjectSetName
traceResult xTraceObjectSetName(TraceObjectHandle_t xObjectHandle, const char *szName)
Sets trace object name.
Definition: trcObject.c:137
xTraceObjectSetOptionsWithoutHandle
traceResult xTraceObjectSetOptionsWithoutHandle(void *pvObject, uint32_t uiOptions)
Sets trace object options without trace object handle.
Definition: trcObject.c:241
xTraceObjectRegisterWithoutHandle
traceResult xTraceObjectRegisterWithoutHandle(uint32_t uiEventCode, void *pvObject, const char *szName, TraceUnsignedBaseType_t uxState)
Registers trace object without trace object handle.
Definition: trcObject.c:161
xTraceObjectUnregisterWithoutHandle
traceResult xTraceObjectUnregisterWithoutHandle(uint32_t uiEventCode, void *pvObject, TraceUnsignedBaseType_t uxState)
Unregisters trace object without trace object handle.
Definition: trcObject.c:168
xTraceObjectRegister
traceResult xTraceObjectRegister(uint32_t uiEventCode, void *pvObject, const char *szName, TraceUnsignedBaseType_t uxState, TraceObjectHandle_t *pxObjectHandle)
Registers trace object.
Definition: trcObject.c:100
xTraceObjectUnregister
traceResult xTraceObjectUnregister(TraceObjectHandle_t xObjectHandle, uint32_t uiEventCode, TraceUnsignedBaseType_t uxState)
Unregisters trace object.
Definition: trcObject.c:105
xTraceObjectSetNameWithoutHandle
traceResult xTraceObjectSetNameWithoutHandle(void *pvObject, const char *szName)
Set trace object name without trace object handle.
Definition: trcObject.c:191
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.
Definition: trcObject.c:25