File event_groups.h

FileList > FreeRTOS > include > event_groups.h

#include "timers.h"

Public Types

Type	Name
typedef TickType_t	EventBits_t
typedef struct EventGroupDef_t *	EventGroupHandle_t

Public Functions

Type	Name
void	vEventGroupClearBitsCallback (void * pvEventGroup, const uint32_t ulBitsToClear)
void	vEventGroupDelete (EventGroupHandle_t xEventGroup)
void	vEventGroupSetBitsCallback (void * pvEventGroup, const uint32_t ulBitsToSet)
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)
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)

Macros

Type	Name
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 )

Public Types Documentation

typedef EventBits_t

typedef TickType_t EventBits_t;

typedef EventGroupHandle_t

typedef struct EventGroupDef_t* EventGroupHandle_t;

Public Functions Documentation

function vEventGroupClearBitsCallback

void vEventGroupClearBitsCallback (
    void * pvEventGroup,
    const uint32_t ulBitsToClear
)

function vEventGroupDelete

void vEventGroupDelete (
    EventGroupHandle_t xEventGroup
)

event_groups.h

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.

function vEventGroupSetBitsCallback

void vEventGroupSetBitsCallback (
    void * pvEventGroup,
    const uint32_t ulBitsToSet
)

function xEventGroupClearBits

EventBits_t xEventGroupClearBits (
    EventGroupHandle_t xEventGroup,
    const EventBits_t uxBitsToClear
)

function xEventGroupGetBitsFromISR

EventBits_t xEventGroupGetBitsFromISR (
    EventGroupHandle_t xEventGroup
)

function xEventGroupSetBits

EventBits_t xEventGroupSetBits (
    EventGroupHandle_t xEventGroup,
    const EventBits_t uxBitsToSet
)

function xEventGroupSync

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

function xEventGroupWaitBits

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

Macro Definition Documentation

define xEventGroupClearBitsFromISR

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

define xEventGroupGetBits

#define xEventGroupGetBits (
    xEventGroup
) xEventGroupClearBits( xEventGroup, 0 )

define xEventGroupSetBitsFromISR

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

The documentation for this class was generated from the following file fw/rbcx-coprocessor/lib/FreeRTOS/include/event_groups.h