event_groups.h File Reference

#include "timers.h"

Include dependency graph for event_groups.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

Typedefs
typedef TickType_t	EventBits_t
typedef void *	EventGroupHandle_t

Functions
void	vEventGroupClearBitsCallback (void *pvEventGroup, const uint32_t ulBitsToClear) PRIVILEGED_FUNCTION
void	vEventGroupDelete (EventGroupHandle_t xEventGroup) PRIVILEGED_FUNCTION
void	vEventGroupSetBitsCallback (void *pvEventGroup, const uint32_t ulBitsToSet) PRIVILEGED_FUNCTION
EventBits_t	xEventGroupClearBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear) PRIVILEGED_FUNCTION
EventBits_t	xEventGroupGetBitsFromISR (EventGroupHandle_t xEventGroup) 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	xEventGroupWaitBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait) PRIVILEGED_FUNCTION

Macro Definition Documentation

xEventGroupClearBitsFromISR

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

Definition at line 410 of file event_groups.h.

xEventGroupGetBits

#define xEventGroupGetBits

(

xEventGroup

)

xEventGroupClearBits( xEventGroup, 0 )

Definition at line 708 of file event_groups.h.

xEventGroupSetBitsFromISR

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

Definition at line 562 of file event_groups.h.

Typedef Documentation

EventBits_t

typedef TickType_t EventBits_t

Definition at line 92 of file event_groups.h.

EventGroupHandle_t

typedef void* EventGroupHandle_t

Definition at line 82 of file event_groups.h.

Function Documentation

vEventGroupClearBitsCallback()

void vEventGroupClearBitsCallback	(	void *	pvEventGroup,
		const uint32_t	ulBitsToClear
	)

Definition at line 651 of file event_groups.c.

vEventGroupDelete()

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 599 of file event_groups.c.

vEventGroupSetBitsCallback()

void vEventGroupSetBitsCallback	(	void *	pvEventGroup,
		const uint32_t	ulBitsToSet
	)

Definition at line 643 of file event_groups.c.

xEventGroupClearBits()

EventBits_t xEventGroupClearBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToClear
	)

Definition at line 447 of file event_groups.c.

xEventGroupGetBitsFromISR()

EventBits_t xEventGroupGetBitsFromISR

(

EventGroupHandle_t

xEventGroup

)

Definition at line 489 of file event_groups.c.

xEventGroupSetBits()

EventBits_t xEventGroupSetBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToSet
	)

Definition at line 505 of file event_groups.c.

xEventGroupSync()

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

Definition at line 177 of file event_groups.c.

xEventGroupWaitBits()

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

Definition at line 297 of file event_groups.c.