Trace Stack Monitor APIs

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

Detailed Description

Function Documentation

xTraceStackMonitorAdd()

traceResult xTraceStackMonitorAdd

(

void *

pvTask

)

Adds task/thread to trace stack monitor.

Parameters

[in]

pvTask

Task/Thread.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceStackMonitorGetAtIndex()

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

Gets trace stack monitor tread/task at index.

Parameters

[in]	uiIndex	Index.
[in]	ppvTask	Task/Thread.
[out]	puxLowWaterMark	Low water mark.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceStackMonitorRemove()

traceResult xTraceStackMonitorRemove

(

void *

pvTask

)

Removes task/thread from trace stack monitor.

Parameters

[in]

pvTask

Task/Thread.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

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_FAIL	Failure
TRC_SUCCESS	Success