Collaboration diagram for Timer emulation:

Macros
#define	xTimerGetTimerDaemonTaskHandle() (!!! "Not implemented" !!!)

Typedefs
typedef struct Timer_t *	TimerHandle_t

typedef void(*	TimerCallbackFunction_t) (TimerHandle_t pxTimer)

typedef void(*	PendedFunction_t) (void *pvParameter1, uint32_t ulParameter2)

Functions
TimerHandle_t	xTimerCreate (const char const pcTimerName, const TickType_t xTimerPeriod, const UBaseType_t uxAutoReload, void const pvTimerID, TimerCallbackFunction_t pxCallbackFunction)

BaseType_t	xTimerIsTimerActive (TimerHandle_t xTimer)

BaseType_t	xTimerStart (TimerHandle_t xTimer, TickType_t xBlockTime)

BaseType_t	xTimerStop (TimerHandle_t xTimer, TickType_t xBlockTime)

BaseType_t	xTimerChangePeriod (TimerHandle_t xTimer, TickType_t xNewPeriod, TickType_t xBlockTime)

BaseType_t	xTimerDelete (TimerHandle_t xTimer, TickType_t xBlockTime)

static BaseType_t	xTimerReset (TimerHandle_t xTimer, TickType_t xBlockTime)

static BaseType_t	xTimerStartFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)

static BaseType_t	xTimerStopFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)

static BaseType_t	xTimerChangePeriodFromISR (TimerHandle_t xTimer, TickType_t xNewPeriod, BaseType_t *pxHigherPriorityTaskWoken)

static BaseType_t	xTimerResetFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)

void *	pvTimerGetTimerID (TimerHandle_t xTimer)

void	vTimerSetTimerID (TimerHandle_t xTimer, void *pvNewID)

const char *	pcTimerGetTimerName (TimerHandle_t xTimer)

BaseType_t	xTimerPendFunctionCall (PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait)

static BaseType_t	xTimerPendFunctionCallFromISR (PendedFunction_t xFunctionToPend, void pvParameter1, uint32_t ulParameter2, BaseType_t pxHigherPriorityTaskWoken)

Detailed Description

Macro Definition Documentation

#define xTimerGetTimerDaemonTaskHandle ( ) (!!! "Not implemented" !!!)

xTimerGetTimerDaemonTaskHandle stub. http://www.freertos.org/FreeRTOS-Software-Timer-API-Functions.html#xTimerGetTimerDaemonTaskHandle

Note

Implementation does not use a timer daemon

Definition at line 545 of file rtos.h.

Typedef Documentation

typedef struct Timer_t* TimerHandle_t

TimerHandle_t type

Definition at line 386 of file rtos.h.

typedef void(* TimerCallbackFunction_t) (TimerHandle_t pxTimer)

TimerCallbackFunction_t type

Definition at line 387 of file rtos.h.

typedef void(* PendedFunction_t) (void *pvParameter1, uint32_t ulParameter2)

PendedFunction_t type

Definition at line 388 of file rtos.h.

Function Documentation

TimerHandle_t xTimerCreate	(	const char *const	pcTimerName,
		const TickType_t	xTimerPeriod,
		const UBaseType_t	uxAutoReload,
		void *const	pvTimerID,
		TimerCallbackFunction_t	pxCallbackFunction
	)

xTimerCreate emulation. http://www.freertos.org/FreeRTOS-timers-xTimerCreate.html

BaseType_t xTimerIsTimerActive ( TimerHandle_t xTimer )

xTimerIsTimerActive emulation. http://www.freertos.org/FreeRTOS-timers-xTimerIsTimerActive.html

BaseType_t xTimerStart	(	TimerHandle_t	xTimer,
		TickType_t	xBlockTime
	)

xTimerStart emulation. http://www.freertos.org/FreeRTOS-timers-xTimerStart.html

Note

xBlockTime is ignored. Timer always starts.

Referenced by xTimerReset(), and xTimerStartFromISR().

BaseType_t xTimerStop	(	TimerHandle_t	xTimer,
		TickType_t	xBlockTime
	)

xTimerStop emulation. http://www.freertos.org/FreeRTOS-timers-xTimerStop.html

Note

xBlockTime is ignored. Timer always stops.
The function is synchronous, no callbacks will be called after it exits.

Referenced by xTimerStopFromISR().

BaseType_t xTimerChangePeriod	(	TimerHandle_t	xTimer,
		TickType_t	xNewPeriod,
		TickType_t	xBlockTime
	)

xTimerChangePeriod emulation. http://www.freertos.org/FreeRTOS-timers-xTimerChangePeriod.html

Note

xBlockTime is ignored. Timer always stops.

Referenced by xTimerChangePeriodFromISR().

BaseType_t xTimerDelete	(	TimerHandle_t	xTimer,
		TickType_t	xBlockTime
	)

xTimerDelete emulation. http://www.freertos.org/FreeRTOS-timers-xTimerDelete.html

Note

xBlockTime is ignored. Timer always stops.

static BaseType_t xTimerReset	(	TimerHandle_t	xTimer,
		TickType_t	xBlockTime
	)

inlinestatic

xTimerReset emulation. http://www.freertos.org/FreeRTOS-timers-xTimerReset.html

Note

xBlockTime is ignored. Timer always stops.

Definition at line 455 of file rtos.h.

References xTimerStart().

Referenced by xTimerResetFromISR().

static BaseType_t xTimerStartFromISR	(	TimerHandle_t	xTimer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

inlinestatic

xTimerStartFromISR emulation. http://www.freertos.org/FreeRTOS-timers-xTimerStartFromISR.html

Note

Implementation never requests context switch from an ISR
This function can not be called from a hard irq context

Definition at line 469 of file rtos.h.

References xTimerStart().

static BaseType_t xTimerStopFromISR	(	TimerHandle_t	xTimer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

inlinestatic

xTimerStopFromISR emulation. http://www.freertos.org/FreeRTOS-timers-xTimerStopFromISR.html

Note

Implementation never requests context switch from an ISR
The function is synchronous, no callbacks will be called after it exits.
This function can not be called from a hard irq context

Definition at line 484 of file rtos.h.

References xTimerStop().

static BaseType_t xTimerChangePeriodFromISR	(	TimerHandle_t	xTimer,
		TickType_t	xNewPeriod,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

inlinestatic

xTimerChangePeriodFromISR emulation. http://www.freertos.org/FreeRTOS-timers-xTimerChangePeriodFromISR.html

Note

Implementation never requests context switch from an ISR
This function can not be called from a hard irq context

Definition at line 498 of file rtos.h.

References xTimerChangePeriod().

static BaseType_t xTimerResetFromISR	(	TimerHandle_t	xTimer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

inlinestatic

xTimerResetFromISR emulation. http://www.freertos.org/FreeRTOS-timers-xTimerResetFromISR.html

Note

Implementation never requests context switch from an ISR
This function can not be called from a hard irq context

Definition at line 513 of file rtos.h.

References pcTimerGetTimerName(), pvTimerGetTimerID(), vTimerSetTimerID(), and xTimerReset().

void* pvTimerGetTimerID ( TimerHandle_t xTimer )

pvTimerGetTimerID emulation. http://www.freertos.org/FreeRTOS-timers-pvTimerGetTimerID.html

Referenced by xTimerResetFromISR().

void vTimerSetTimerID	(	TimerHandle_t	xTimer,
		void *	pvNewID
	)

vTimerSetTimerID emulation. http://www.freertos.org/FreeRTOS-timers-vTimerSetTimerID.html

Referenced by xTimerResetFromISR().

const char* pcTimerGetTimerName ( TimerHandle_t xTimer )

pcTimerGetTimerName emulation. http://www.freertos.org/FreeRTOS-Software-Timer-API-Functions.html

Referenced by xTimerResetFromISR().

BaseType_t xTimerPendFunctionCall	(	PendedFunction_t	xFunctionToPend,
		void *	pvParameter1,
		uint32_t	ulParameter2,
		TickType_t	xTicksToWait
	)

xTimerPendFunctionCall emulation. http://www.freertos.org/xTimerPendFunctionCall.html

Referenced by xTimerPendFunctionCallFromISR().

static BaseType_t xTimerPendFunctionCallFromISR	(	PendedFunction_t	xFunctionToPend,
		void *	pvParameter1,
		uint32_t	ulParameter2,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

inlinestatic

xTimerPendFunctionCallFromISR emulation. http://www.freertos.org/xTimerPendFunctionCallFromISR.html

Note

This function can be called from a hard irq context
The xFunctionToPend will be executed in a soft irq context

Definition at line 564 of file rtos.h.

References xTimerPendFunctionCall().

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation