event_groups.h File Reference

#include "timers.h"

Go to the source code of this file.

Macros
#define	xEventGroupClearBitsFromISR(xEventGroup, uxBitsToClear)   xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL )
#define	xEventGroupSetBitsFromISR(xEventGroup, uxBitsToSet, pxHigherPriorityTaskWoken)   xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken )
#define	xEventGroupGetBits(xEventGroup)   xEventGroupClearBits( xEventGroup, 0 )

Typedefs
typedef void *	EventGroupHandle_t
typedef TickType_t	EventBits_t

Functions
EventGroupHandle_t	xEventGroupCreate (void) PRIVILEGED_FUNCTION
EventBits_t	xEventGroupWaitBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
EventBits_t	xEventGroupClearBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear) PRIVILEGED_FUNCTION
EventBits_t	xEventGroupSetBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet) PRIVILEGED_FUNCTION
EventBits_t	xEventGroupSync (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
EventBits_t	xEventGroupGetBitsFromISR (EventGroupHandle_t xEventGroup) PRIVILEGED_FUNCTION
void	vEventGroupDelete (EventGroupHandle_t xEventGroup) PRIVILEGED_FUNCTION
void	vEventGroupSetBitsCallback (void *pvEventGroup, const uint32_t ulBitsToSet) PRIVILEGED_FUNCTION
void	vEventGroupClearBitsCallback (void *pvEventGroup, const uint32_t ulBitsToClear) PRIVILEGED_FUNCTION

Macro Definition Documentation

#define xEventGroupClearBitsFromISR	(		xEventGroup,
			uxBitsToClear
	)		xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL )

Definition at line 385 of file event_groups.h.

#define xEventGroupGetBits

(

xEventGroup

)

xEventGroupClearBits( xEventGroup, 0 )

Definition at line 683 of file event_groups.h.

#define xEventGroupSetBitsFromISR	(		xEventGroup,
			uxBitsToSet,
			pxHigherPriorityTaskWoken
	)		xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken )

Definition at line 537 of file event_groups.h.

Typedef Documentation

typedef TickType_t EventBits_t

Definition at line 132 of file event_groups.h.

typedef void* EventGroupHandle_t

Definition at line 122 of file event_groups.h.

Function Documentation

void vEventGroupClearBitsCallback	(	void *	pvEventGroup,
		const uint32_t	ulBitsToClear
	)

Definition at line 607 of file event_groups.c.

void vEventGroupDelete

(

EventGroupHandle_t

xEventGroup

)

event_groups.h

   void xEventGroupDelete( EventGroupHandle_t xEventGroup );

Delete an event group that was previously created by a call to xEventGroupCreate(). Tasks that are blocked on the event group will be unblocked and obtain 0 as the event group's value.

Parameters

xEventGroup

The event group being deleted.

Definition at line 574 of file event_groups.c.

void vEventGroupSetBitsCallback	(	void *	pvEventGroup,
		const uint32_t	ulBitsToSet
	)

Definition at line 599 of file event_groups.c.

EventBits_t xEventGroupClearBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToClear
	)

Definition at line 422 of file event_groups.c.

EventGroupHandle_t xEventGroupCreate

(

void

)

Definition at line 138 of file event_groups.c.

EventBits_t xEventGroupGetBitsFromISR

(

EventGroupHandle_t

xEventGroup

)

Definition at line 464 of file event_groups.c.

EventBits_t xEventGroupSetBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToSet
	)

Definition at line 480 of file event_groups.c.

EventBits_t xEventGroupSync	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToSet,
		const EventBits_t	uxBitsToWaitFor,
		TickType_t	xTicksToWait
	)

Definition at line 158 of file event_groups.c.

EventBits_t xEventGroupWaitBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToWaitFor,
		const BaseType_t	xClearOnExit,
		const BaseType_t	xWaitForAllBits,
		TickType_t	xTicksToWait
	)

Definition at line 274 of file event_groups.c.