Percepio Trace Recorder v4.11.0
Loading...
Searching...
No Matches
Trace Thread APIs

Macros

#define xTraceThreadRegister(szName, uxPriority, uxProcess, pxThreadHandle)
 Register trace thread in the trace.
#define xTraceThreadRegisterWithoutHandle(pvThread, szName, uxPriority, uxProcess)
 Registers trace thread without trace thread handle.
#define xTraceThreadUnregister(xThreadHandle, uxPriority)
 Unregister trace thread from trace.
#define xTraceThreadUnregisterWithoutHandle(pvThread, uxPriority)
 Unregisters trace thread without trace thread handle.
#define xTraceThreadSetPriority(xThreadHandle, uxPriority)
 Sets trace thread priority.
#define xTraceThreadSetPriorityWithoutHandle(pvThread, uxPriority)
 Sets trace thread priority without trace thread handle.
#define xTraceThreadSwitch(xThread, uxPriority)
 Registers trace thread switch event.

Detailed Description

Macro Definition Documentation

◆ xTraceThreadRegister

#define xTraceThreadRegister ( szName,
uxPriority,
uxProcess,
pxThreadHandle )
Value:
xTraceObjectRegister2(PSF_EVENT_THREAD_CREATE, (void*)0, szName, uxPriority, (TraceUnsignedBaseType_t)(uxProcess), (TraceObjectHandle_t*)(pxThreadHandle))
traceResult xTraceObjectRegister2(uint32_t uiEventCode, void *const pvObject, const char *szName, TraceUnsignedBaseType_t uxState1, TraceUnsignedBaseType_t uxState2, TraceObjectHandle_t *pxObjectHandle)
Registers trace object with two initial states.
Definition trcObject.c:113

Register trace thread in the trace.

Parameters
[in]szNameName.
[in]uxPriorityPriority.
[in]uxProcessProcess address or handle used when registering process.
[out]pxThreadHandlePointer to uninitialized trace thread.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceThreadRegisterWithoutHandle

#define xTraceThreadRegisterWithoutHandle ( pvThread,
szName,
uxPriority,
uxProcess )
Value:
xTraceObjectRegisterWithoutHandle2(PSF_EVENT_THREAD_CREATE, (void*)(pvThread), szName, uxPriority, (TraceUnsignedBaseType_t)(uxProcess))
traceResult xTraceObjectRegisterWithoutHandle2(uint32_t uiEventCode, void *pvObject, const char *szName, TraceUnsignedBaseType_t uxState1, TraceUnsignedBaseType_t uxState2)
Registers trace object with two initial states without trace object handle.
Definition trcObject.c:193

Registers trace thread without trace thread handle.

Parameters
[in]pvThreadThread.
[in]szNameName.
[in]uxPriorityPriority.
[in]uxProcessProcess address or handle used when registering process.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceThreadSetPriority

#define xTraceThreadSetPriority ( xThreadHandle,
uxPriority )
Value:
xTraceTaskSetPriority((TraceTaskHandle_t)(xThreadHandle), uxPriority)
traceResult xTraceTaskSetPriority(TraceTaskHandle_t xTaskHandle, TraceUnsignedBaseType_t uxPriority)
Sets trace task priority.
Definition trcTask.c:46

Sets trace thread priority.

Parameters
[in]xThreadHandleHandle to initialized trace thread.
[in]uxPriorityPriority.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceThreadSetPriorityWithoutHandle

#define xTraceThreadSetPriorityWithoutHandle ( pvThread,
uxPriority )
Value:
traceResult xTraceTaskSetPriorityWithoutHandle(void *pvTask, TraceUnsignedBaseType_t uxPriority)
Sets trace task priority without trace task handle.
Definition trcTask.c:61

Sets trace thread priority without trace thread handle.

Parameters
[in]pvThreadThread.
[in]uxPriorityPriority.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceThreadSwitch

#define xTraceThreadSwitch ( xThread,
uxPriority )
Value:
xTraceTaskSwitch((void*)(xThread), uxPriority)
traceResult xTraceTaskSwitch(void *pvTask, TraceUnsignedBaseType_t uxPriority)
Registers trace task switch event.
Definition trcTask.c:79

Registers trace thread switch event.

Parameters
[in]xThreadThread address or thread handle used when registering thread.
[in]uxPriorityPriority.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceThreadUnregister

#define xTraceThreadUnregister ( xThreadHandle,
uxPriority )
Value:
xTraceObjectUnregister((TraceObjectHandle_t)(xThreadHandle), PSF_EVENT_THREAD_DELETE, uxPriority)
traceResult xTraceObjectUnregister(TraceObjectHandle_t xObjectHandle, uint32_t uiEventCode, TraceUnsignedBaseType_t uxState)
Unregisters trace object.
Definition trcObject.c:119

Unregister trace thread from trace.

Parameters
[in]xThreadHandlePointer to initialized trace thread.
[in]uxPriorityPriority.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceThreadUnregisterWithoutHandle

#define xTraceThreadUnregisterWithoutHandle ( pvThread,
uxPriority )
Value:
xTraceObjectUnregisterWithoutHandle(PSF_EVENT_THREAD_DELETE, (void*)(pvThread), uxPriority)
traceResult xTraceObjectUnregisterWithoutHandle(uint32_t uiEventCode, void *pvObject, TraceUnsignedBaseType_t uxState)
Unregisters trace object without trace object handle.
Definition trcObject.c:201

Unregisters trace thread without trace thread handle.

Parameters
[in]pvThreadThread.
[in]uxPriorityPriority.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess