event_groups.c File Reference

#include <stdlib.h>
#include "FreeRTOS.h"
#include "task.h"
#include "timers.h"
#include "event_groups.h"

Include dependency graph for event_groups.c:

Go to the source code of this file.

Classes
struct	EventGroupDef_t

Macros
#define	MPU_WRAPPERS_INCLUDED_FROM_API_FILE

Typedefs
typedef struct EventGroupDef_t	EventGroup_t

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

Macro Definition Documentation

MPU_WRAPPERS_INCLUDED_FROM_API_FILE

#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE

Definition at line 35 of file event_groups.c.

Typedef Documentation

EventGroup_t

typedef struct EventGroupDef_t EventGroup_t

Function Documentation

prvTestWaitCondition()

BaseType_t prvTestWaitCondition ( const EventBits_t uxCurrentEventBits, const EventBits_t uxBitsToWaitFor, const BaseType_t xWaitForAllBits )

static

Definition at line 714 of file event_groups.c.

References mtCOVERAGE_TEST_MARKER, pdFALSE, and pdTRUE.

Referenced by xEventGroupWaitBits().

vEventGroupClearBitsCallback()

void vEventGroupClearBitsCallback	(	void *	pvEventGroup,
		const uint32_t	ulBitsToClear )

Definition at line 707 of file event_groups.c.

References xEventGroupClearBits().

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

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

Referenced by osEventFlagsDelete().

vEventGroupSetBitsCallback()

void vEventGroupSetBitsCallback	(	void *	pvEventGroup,
		const 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.

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.

Definition at line 698 of file event_groups.c.

References xEventGroupSetBits().

xEventGroupClearBits()

EventBits_t xEventGroupClearBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToClear )

Definition at line 458 of file event_groups.c.

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

Referenced by osEventFlagsClear(), and vEventGroupClearBitsCallback().

xEventGroupGetBitsFromISR()

EventBits_t xEventGroupGetBitsFromISR

(

EventGroupHandle_t

xEventGroup

)

Definition at line 502 of file event_groups.c.

References portCLEAR_INTERRUPT_MASK_FROM_ISR, portSET_INTERRUPT_MASK_FROM_ISR, and EventGroupDef_t::uxEventBits.

Referenced by osEventFlagsClear(), osEventFlagsGet(), and osEventFlagsSet().

xEventGroupSetBits()

EventBits_t xEventGroupSetBits	(	EventGroupHandle_t	xEventGroup,
		const EventBits_t	uxBitsToSet )

Definition at line 518 of file event_groups.c.

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, EventGroupDef_t::uxEventBits, vTaskRemoveFromUnorderedEventList(), vTaskSuspendAll(), xTaskResumeAll(), and EventGroupDef_t::xTasksWaitingForBits.

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

xEventGroupSync()

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

Definition at line 179 of file event_groups.c.

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, EventGroupDef_t::uxEventBits, uxTaskResetEventItemValue(), vTaskPlaceOnUnorderedEventList(), vTaskSuspendAll(), xEventGroupSetBits(), xTaskGetSchedulerState(), xTaskResumeAll(), and EventGroupDef_t::xTasksWaitingForBits.

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

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, EventGroupDef_t::uxEventBits, uxTaskResetEventItemValue(), vTaskPlaceOnUnorderedEventList(), vTaskSuspendAll(), xTaskGetSchedulerState(), xTaskResumeAll(), and EventGroupDef_t::xTasksWaitingForBits.

Referenced by osEventFlagsWait().