Percepio Trace Recorder  v4.6.6
Trace Stack Monitor APIs

Functions

traceResult xTraceStackMonitorAdd (void *pvTask)
 Adds task/thread to trace stack monitor. More...
 
traceResult xTraceStackMonitorRemove (void *pvTask)
 Removes task/thread from trace stack monitor. More...
 
traceResult xTraceStackMonitorGetAtIndex (uint32_t uiIndex, void **ppvTask, TraceUnsignedBaseType_t *puxLowWaterMark)
 Gets trace stack monitor tread/task at index. More...
 
traceResult xTraceStackMonitorReport (void)
 Performs trace stack monitor reporting. More...
 

Detailed Description

Function Documentation

◆ xTraceStackMonitorAdd()

traceResult xTraceStackMonitorAdd ( void *  pvTask)

Adds task/thread to trace stack monitor.

Parameters
[in]pvTaskTask/Thread.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceStackMonitorGetAtIndex()

traceResult xTraceStackMonitorGetAtIndex ( uint32_t  uiIndex,
void **  ppvTask,
TraceUnsignedBaseType_t *  puxLowWaterMark 
)

Gets trace stack monitor tread/task at index.

Parameters
[in]uiIndexIndex.
[in]ppvTaskTask/Thread.
[out]puxLowWaterMarkLow water mark.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceStackMonitorRemove()

traceResult xTraceStackMonitorRemove ( void *  pvTask)

Removes task/thread from trace stack monitor.

Parameters
[in]pvTaskTask/Thread.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceStackMonitorReport()

traceResult xTraceStackMonitorReport ( void  )

Performs trace stack monitor reporting.

This routine performs a trace stack monitor check and report for TRC_CFG_STACK_MONITOR_MAX_REPORTS number of registered tasks/threads.

Return values
TRC_FAILFailure
TRC_SUCCESSSuccess