File event_groups.c

FileList > FreeRTOS > src > event_groups.c

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

Classes

Type	Name
struct	EventGroupDef_t

Public Types

Type	Name
typedef struct EventGroupDef_t	EventGroup_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)

Public Static Functions

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

Macros

Type	Name
define	MPU_WRAPPERS_INCLUDED_FROM_API_FILE
define	eventCLEAR_EVENTS_ON_EXIT_BIT 0x01000000UL
define	eventEVENT_BITS_CONTROL_BYTES 0xff000000UL
define	eventUNBLOCKED_DUE_TO_BIT_SET 0x02000000UL
define	eventWAIT_FOR_ALL_BITS 0x04000000UL

Public Types Documentation

typedef EventGroup_t

typedef struct EventGroupDef_t EventGroup_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
)

Public Static Functions Documentation

function prvTestWaitCondition

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

Macro Definition Documentation

define MPU_WRAPPERS_INCLUDED_FROM_API_FILE

#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE

define eventCLEAR_EVENTS_ON_EXIT_BIT

#define eventCLEAR_EVENTS_ON_EXIT_BIT 0x01000000UL

define eventEVENT_BITS_CONTROL_BYTES

#define eventEVENT_BITS_CONTROL_BYTES 0xff000000UL

define eventUNBLOCKED_DUE_TO_BIT_SET

#define eventUNBLOCKED_DUE_TO_BIT_SET 0x02000000UL

define eventWAIT_FOR_ALL_BITS

#define eventWAIT_FOR_ALL_BITS 0x04000000UL

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