Trace Heap APIs

Macros
#define	xTraceHeapGetCurrent(xHeapHandle, puxCurrent)
	Gets trace heap current allocation size.
#define	xTraceHeapSetCurrent(xHeapHandle, uxCurrent)
	Sets trace heap current allocation size.
#define	xTraceHeapGetHighWaterMark(xHeapHandle, puxHighWaterMark)
	Gets trace heap high water mark.
#define	xTraceHeapSetHighWaterMark(xHeapHandle, uxHighWaterMark)
	Sets trace heap high water mark.
#define	xTraceHeapGetMax(xHeapHandle, puxMax)
	Gets trace heap max size.
#define	xTraceHeapSetMax(xHeapHandle, uxMax)
	Sets trace heap max size.

Functions
traceResult	xTraceHeapCreate (const char *szName, TraceUnsignedBaseType_t uxCurrent, TraceUnsignedBaseType_t uxHighWaterMark, TraceUnsignedBaseType_t uxMax, TraceHeapHandle_t *pxHeapHandle)
	Creates trace heap.
traceResult	xTraceHeapAlloc (TraceHeapHandle_t xHeapHandle, void *pvAddress, TraceUnsignedBaseType_t uxSize)
	Signals trace heap alloc.
traceResult	xTraceHeapFree (TraceHeapHandle_t xHeapHandle, void *pvAddress, TraceUnsignedBaseType_t uxSize)
	Signals trace heap free.

Detailed Description

Macro Definition Documentation

xTraceHeapGetCurrent

#define xTraceHeapGetCurrent	(		xHeapHandle,
			puxCurrent )

Value:

xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, puxCurrent)

Gets trace heap current allocation size.

Parameters

[in]	xHeapHandle	Trace heap handle.
[out]	puxCurrent	Current.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceHeapGetHighWaterMark

#define xTraceHeapGetHighWaterMark	(		xHeapHandle,
			puxHighWaterMark )

Value:

xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, puxHighWaterMark)

Gets trace heap high water mark.

Parameters

[in]	xHeapHandle	Trace heap handle.
[out]	puxHighWaterMark	High water mark.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceHeapGetMax

#define xTraceHeapGetMax	(		xHeapHandle,
			puxMax )

Value:

xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, puxMax)

Gets trace heap max size.

Parameters

[in]	xHeapHandle	Trace heap handle.
[out]	puxMax	Max.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceHeapSetCurrent

#define xTraceHeapSetCurrent	(		xHeapHandle,
			uxCurrent )

Value:

xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, uxCurrent)

Sets trace heap current allocation size.

Parameters

[in]	xHeapHandle	Trace heap handle.
[in]	uxCurrent	Current.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceHeapSetHighWaterMark

#define xTraceHeapSetHighWaterMark	(		xHeapHandle,
			uxHighWaterMark )

Value:

xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, uxHighWaterMark)

Sets trace heap high water mark.

Parameters

[in]	xHeapHandle	Trace heap handle.
[in]	uxHighWaterMark	High water mark.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceHeapSetMax

#define xTraceHeapSetMax	(		xHeapHandle,
			uxMax )

Value:

xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, uxMax)

Sets trace heap max size.

Parameters

[in]	xHeapHandle	Trace heap handle.
[in]	uxMax	Max heap size.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

Function Documentation

xTraceHeapAlloc()

traceResult xTraceHeapAlloc	(	TraceHeapHandle_t	xHeapHandle,
		void *	pvAddress,
		TraceUnsignedBaseType_t	uxSize )

Signals trace heap alloc.

Parameters

[in]	xHeapHandle	Trace heap handle.
[in]	pvAddress	Address.
[in]	uxSize	Size.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceHeapCreate()

traceResult xTraceHeapCreate	(	const char *	szName,
		TraceUnsignedBaseType_t	uxCurrent,
		TraceUnsignedBaseType_t	uxHighWaterMark,
		TraceUnsignedBaseType_t	uxMax,
		TraceHeapHandle_t *	pxHeapHandle )

Creates trace heap.

Parameters

[in]	szName	Name.
[in]	uxCurrent	Current level.
[in]	uxHighWaterMark	High water mark
[in]	uxMax	Maximum level.
[out]	pxHeapHandle	Pointer to uninitialized trace heap handle.

Returns

traceResult

xTraceHeapFree()

traceResult xTraceHeapFree	(	TraceHeapHandle_t	xHeapHandle,
		void *	pvAddress,
		TraceUnsignedBaseType_t	uxSize )

Signals trace heap free.

Parameters

[in]	xHeapHandle	Trace heap handle.
[in]	pvAddress	Address.
[in]	uxSize	Size.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success