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	eventCLEAR_EVENTS_ON_EXIT_BIT   ( ( uint16_t ) 0x0100U )
#define	eventUNBLOCKED_DUE_TO_BIT_SET   ( ( uint16_t ) 0x0200U )
#define	eventWAIT_FOR_ALL_BITS   ( ( uint16_t ) 0x0400U )
#define	eventEVENT_BITS_CONTROL_BYTES   ( ( uint16_t ) 0xff00U )
#define	xEventGroupClearBitsFromISR(xEventGroup, uxBitsToClear)
#define	xEventGroupSetBitsFromISR(xEventGroup, uxBitsToSet, pxHigherPriorityTaskWoken)
#define	xEventGroupGetBits(xEventGroup)

Typedefs
typedef struct EventGroupDef_t *	EventGroupHandle_t
typedef TickType_t	EventBits_t

Functions
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, uint32_t ulBitsToSet) PRIVILEGED_FUNCTION
void	vEventGroupClearBitsCallback (void *pvEventGroup, uint32_t ulBitsToClear) PRIVILEGED_FUNCTION

Macro Definition Documentation

eventCLEAR_EVENTS_ON_EXIT_BIT

#define eventCLEAR_EVENTS_ON_EXIT_BIT   ( ( uint16_t ) 0x0100U )

eventEVENT_BITS_CONTROL_BYTES

#define eventEVENT_BITS_CONTROL_BYTES   ( ( uint16_t ) 0xff00U )

eventUNBLOCKED_DUE_TO_BIT_SET

#define eventUNBLOCKED_DUE_TO_BIT_SET   ( ( uint16_t ) 0x0200U )

eventWAIT_FOR_ALL_BITS

#define eventWAIT_FOR_ALL_BITS   ( ( uint16_t ) 0x0400U )

xEventGroupClearBitsFromISR

#define xEventGroupClearBitsFromISR	(		xEventGroup,
			uxBitsToClear )

Value:

    xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) ( xEventGroup ), ( uint32_t ) ( uxBitsToClear ), NULL )

xEventGroupGetBits

#define xEventGroupGetBits

(

xEventGroup

)

Value:

xEventGroupClearBits( ( xEventGroup ), 0 )

xEventGroupSetBitsFromISR

#define xEventGroupSetBitsFromISR	(		xEventGroup,
			uxBitsToSet,
			pxHigherPriorityTaskWoken )

Value:

    xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) ( xEventGroup ), ( uint32_t ) ( uxBitsToSet ), ( pxHigherPriorityTaskWoken ) )

Typedef Documentation

EventBits_t

typedef TickType_t EventBits_t

EventGroupHandle_t

typedef struct EventGroupDef_t* EventGroupHandle_t

Function Documentation

vEventGroupClearBitsCallback()

void vEventGroupClearBitsCallback	(	void *	pvEventGroup,
		uint32_t	ulBitsToClear )

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.

The configUSE_EVENT_GROUPS configuration constant must be set to 1 for vEventGroupDelete() to be available.

Parameters

xEventGroup

The event group being deleted.

vEventGroupSetBitsCallback()

void vEventGroupSetBitsCallback	(	void *	pvEventGroup,
		uint32_t	ulBitsToSet )

event_groups.h

BaseType_t xEventGroupGetStaticBuffer( EventGroupHandle_t xEventGroup,
                                       StaticEventGroup_t ** ppxEventGroupBuffer );

Retrieve a pointer to a statically created event groups's data structure buffer. It is the same buffer that is supplied at the time of creation.

The configUSE_EVENT_GROUPS configuration constant must be set to 1 for xEventGroupGetStaticBuffer() to be available.

Parameters

xEventGroup	The event group for which to retrieve the buffer.
ppxEventGroupBuffer	Used to return a pointer to the event groups's data structure buffer.

Returns

pdTRUE if the buffer was retrieved, pdFALSE otherwise.

xEventGroupClearBits()

EventBits_t xEventGroupClearBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToClear )

xEventGroupGetBitsFromISR()

EventBits_t xEventGroupGetBitsFromISR

(

EventGroupHandle_t

xEventGroup

)

xEventGroupSetBits()

EventBits_t xEventGroupSetBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToSet )

xEventGroupSync()

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

xEventGroupWaitBits()

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