freertos-8.2.3/Source/include/event_groups.h File Reference

#include "timers.h"

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
	event_groups.h More...
void	vEventGroupSetBitsCallback (void *pvEventGroup, const uint32_t ulBitsToSet) PRIVILEGED_FUNCTION
EventBits_t	xEventGroupClearBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear) PRIVILEGED_FUNCTION
EventGroupHandle_t	xEventGroupCreate (void) 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

#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 )

typedef TickType_t EventBits_t

typedef void* EventGroupHandle_t

void vEventGroupClearBitsCallback	(	void *	pvEventGroup,
		const uint32_t	ulBitsToClear
	)

References xEventGroupClearBits().

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.

References configASSERT, eventUNBLOCKED_DUE_TO_BIT_SET, listCURRENT_LIST_LENGTH, mtCOVERAGE_TEST_MARKER, pdFALSE, xMINI_LIST_ITEM::pxNext, traceEVENT_GROUP_DELETE, vPortFree(), vTaskRemoveFromUnorderedEventList(), vTaskSuspendAll(), xLIST::xListEnd, xTaskRemoveFromUnorderedEventList(), xTaskResumeAll(), and xEventGroupDefinition::xTasksWaitingForBits.

void vEventGroupSetBitsCallback	(	void *	pvEventGroup,
		const uint32_t	ulBitsToSet
	)

References xEventGroupSetBits().

EventBits_t xEventGroupClearBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToClear
	)

References configASSERT, eventEVENT_BITS_CONTROL_BYTES, taskENTER_CRITICAL, taskEXIT_CRITICAL, traceEVENT_GROUP_CLEAR_BITS, and xEventGroupDefinition::uxEventBits.

Referenced by about_task(), main_task(), and vEventGroupClearBitsCallback().

EventGroupHandle_t xEventGroupCreate

(

void

)

References NULL, pvPortMalloc(), traceEVENT_GROUP_CREATE, traceEVENT_GROUP_CREATE_FAILED, xEventGroupDefinition::uxEventBits, vListInitialise(), and xEventGroupDefinition::xTasksWaitingForBits.

EventBits_t xEventGroupGetBitsFromISR

(

EventGroupHandle_t

xEventGroup

)

References portCLEAR_INTERRUPT_MASK_FROM_ISR, portSET_INTERRUPT_MASK_FROM_ISR, and xEventGroupDefinition::uxEventBits.

EventBits_t xEventGroupSetBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToSet
	)

References configASSERT, eventCLEAR_EVENTS_ON_EXIT_BIT, eventEVENT_BITS_CONTROL_BYTES, eventUNBLOCKED_DUE_TO_BIT_SET, eventWAIT_FOR_ALL_BITS, listGET_END_MARKER, listGET_HEAD_ENTRY, listGET_LIST_ITEM_VALUE, listGET_NEXT, mtCOVERAGE_TEST_MARKER, pdFALSE, pdTRUE, traceEVENT_GROUP_SET_BITS, xEventGroupDefinition::uxEventBits, vTaskRemoveFromUnorderedEventList(), vTaskSuspendAll(), xTaskRemoveFromUnorderedEventList(), xTaskResumeAll(), and xEventGroupDefinition::xTasksWaitingForBits.

Referenced by main_task(), vEventGroupSetBitsCallback(), and xEventGroupSync().

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

References configASSERT, eventCLEAR_EVENTS_ON_EXIT_BIT, eventEVENT_BITS_CONTROL_BYTES, eventUNBLOCKED_DUE_TO_BIT_SET, eventWAIT_FOR_ALL_BITS, mtCOVERAGE_TEST_MARKER, pdFALSE, pdTRUE, portYIELD_WITHIN_API, taskENTER_CRITICAL, taskEXIT_CRITICAL, taskSCHEDULER_SUSPENDED, traceEVENT_GROUP_SYNC_BLOCK, traceEVENT_GROUP_SYNC_END, xEventGroupDefinition::uxEventBits, uxTaskResetEventItemValue(), vTaskPlaceOnUnorderedEventList(), vTaskSuspendAll(), xEventGroupSetBits(), xTaskGetSchedulerState(), xTaskResumeAll(), and xEventGroupDefinition::xTasksWaitingForBits.

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

References configASSERT, eventCLEAR_EVENTS_ON_EXIT_BIT, eventEVENT_BITS_CONTROL_BYTES, eventUNBLOCKED_DUE_TO_BIT_SET, eventWAIT_FOR_ALL_BITS, mtCOVERAGE_TEST_MARKER, pdFALSE, pdTRUE, portYIELD_WITHIN_API, prvTestWaitCondition(), taskENTER_CRITICAL, taskEXIT_CRITICAL, taskSCHEDULER_SUSPENDED, traceEVENT_GROUP_WAIT_BITS_BLOCK, traceEVENT_GROUP_WAIT_BITS_END, xEventGroupDefinition::uxEventBits, uxTaskResetEventItemValue(), vTaskPlaceOnUnorderedEventList(), vTaskSuspendAll(), xTaskGetSchedulerState(), xTaskResumeAll(), and xEventGroupDefinition::xTasksWaitingForBits.

Referenced by about_task(), graph_task(), and terminal_task().