Trace Counter APIs

Macros
#define	xTraceCounterAdd(xCounterHandle, xValue)
	Adds value to trace counter.
#define	xTraceCounterGet(xCounterHandle, pxValue)
	Gets trace counter value.
#define	xTraceCounterIncrease(xCounterHandle)
	Increases trace counter value.
#define	xTraceCounterDecrease(xCounterHandle)
	Decreases trace counter value.
#define	xTraceCounterGetUpperLimit(xCounterHandle, pxValue)
	Gets trace counter upper limit.
#define	xTraceCounterGetLowerLimit(xCounterHandle, pxValue)
	Gets trace counter lower limit.
#define	xTraceCounterGetName(xCounterHandle, pszName)
	Gets trace counter name.

Functions
traceResult	xTraceCounterInitialize (TraceCounterData_t *pxBuffer)
	Initializes the Counter trace system.
traceResult	xTraceCounterSetCallback (TraceCounterCallback_t xCallback)
	Sets trace counter callback.
traceResult	xTraceCounterCreate (const char *szName, TraceBaseType_t xInitialValue, TraceBaseType_t xLowerLimit, TraceBaseType_t xUpperLimit, TraceCounterHandle_t *pxCounterHandle)
	Creates trace counter.
traceResult	xTraceCounterSet (TraceCounterHandle_t xCounterHandle, TraceBaseType_t xValue)
	Sets trace counter value.

Detailed Description

Macro Definition Documentation

xTraceCounterAdd

#define xTraceCounterAdd	(		xCounterHandle,
			xValue )

Value:

xTraceCounterSet(xCounterHandle, (TraceBaseType_t)(xTraceObjectGetSpecificStateReturn((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX)) + (xValue))

Adds value to trace counter.

Parameters

[in]	xCounterHandle	Initialized trace counter handle.
[in]	xValue	Value.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterDecrease

#define xTraceCounterDecrease

(

xCounterHandle

)

Value:

xTraceCounterAdd(xCounterHandle, -1)

Decreases trace counter value.

Parameters

[in]

xCounterHandle

Initialized trace counter handle

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterGet

#define xTraceCounterGet	(		xCounterHandle,
			pxValue )

Value:

xTraceObjectGetSpecificState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX, (TraceUnsignedBaseType_t*)(pxValue))

Gets trace counter value.

Parameters

[in]	xCounterHandle	Initialized trace counter handle.
[out]	pxValue	Returned value.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterGetLowerLimit

#define xTraceCounterGetLowerLimit	(		xCounterHandle,
			pxValue )

Value:

xTraceObjectGetSpecificState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_LOWER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))

Gets trace counter lower limit.

Parameters

[in]	xCounterHandle	Initialized trace counter handle
[out]	pxValue	Returned value

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterGetName

#define xTraceCounterGetName	(		xCounterHandle,
			pszName )

Value:

xTraceObjectGetName((TraceObjectHandle_t)(xCounterHandle), pszName)

Gets trace counter name.

Parameters

[in]	xCounterHandle	Initialized trace counter handle.
[out]	pszName	Returned name.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterGetUpperLimit

#define xTraceCounterGetUpperLimit	(		xCounterHandle,
			pxValue )

Value:

xTraceObjectGetSpecificState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_UPPER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))

Gets trace counter upper limit.

Parameters

[in]	xCounterHandle	Initialized trace counter handle
[out]	pxValue	Returned value

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterIncrease

#define xTraceCounterIncrease

(

xCounterHandle

)

Value:

xTraceCounterAdd(xCounterHandle, 1)

Increases trace counter value.

Parameters

[in]

xCounterHandle

Initialized trace counter handle

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

Function Documentation

xTraceCounterCreate()

traceResult xTraceCounterCreate	(	const char *	szName,
		TraceBaseType_t	xInitialValue,
		TraceBaseType_t	xLowerLimit,
		TraceBaseType_t	xUpperLimit,
		TraceCounterHandle_t *	pxCounterHandle )

Creates trace counter.

Parameters

[in]	szName	Name.
[in]	xInitialValue	Initial value.
[in]	xLowerLimit	Lower limit.
[in]	xUpperLimit	Upper limit.
[out]	pxCounterHandle	Uninitialized trace counter handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterInitialize()

traceResult xTraceCounterInitialize

(

TraceCounterData_t *

pxBuffer

)

Initializes the Counter trace system.

Parameters

[in]

pxBuffer

Pointer to memory that is used by the counter system

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterSet()

traceResult xTraceCounterSet	(	TraceCounterHandle_t	xCounterHandle,
		TraceBaseType_t	xValue )

Sets trace counter value.

Parameters

[in]	xCounterHandle	Initialized trace counter handle.
[in]	xValue	Value.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceCounterSetCallback()

traceResult xTraceCounterSetCallback

(

TraceCounterCallback_t

xCallback

)

Sets trace counter callback.

Parameters

[in]

xCallback

Callback

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success