Coldwave Documentation

Appearance

EventFlags ​

EventFlag Functions.

Types ​

Name
structosEventFlagsAttr_t
Attributes structure for event flags.

Functions Overview ​

Name
osEventFlagsId_tosEventFlagsNew(const osEventFlagsAttr_t * attr)
Create and Initialize an Event Flags object.
const char *osEventFlagsGetName(osEventFlagsId_t ef_id)
Get name of an Event Flags object.
uint32_tosEventFlagsSet(osEventFlagsId_t ef_id, uint32_t flags)
Set the specified Event Flags.
uint32_tosEventFlagsClear(osEventFlagsId_t ef_id, uint32_t flags)
Clear the specified Event Flags.
uint32_tosEventFlagsGet(osEventFlagsId_t ef_id)
Get the current Event Flags.
uint32_tosEventFlagsWait(osEventFlagsId_t ef_id, uint32_t flags, uint32_t options, uint32_t timeout)
Wait for one or more Event Flags to become signaled.
osStatus_tosEventFlagsDelete(osEventFlagsId_t ef_id)
Delete an Event Flags object.

Defines ​

Name
osFlagsWaitAnyWait for any flag (default).
osFlagsWaitAllWait for all flags.
osFlagsNoClearDo not clear flags which have been specified to wait for.
osFlagsErrorError indicator.
osFlagsErrorUnknownosError (-1).
osFlagsErrorTimeoutosErrorTimeout (-2).
osFlagsErrorResourceosErrorResource (-3).
osFlagsErrorParameterosErrorParameter (-4).
osFlagsErrorISRosErrorISR (-6).

Function Details ​

function osEventFlagsNew ​

cpp
osEventFlagsId_t osEventFlagsNew(
    const osEventFlagsAttr_t * attr
)

Create and Initialize an Event Flags object.

Parameters:

  • attr event flags attributes; NULL: default values.

Return: event flags ID for reference by other functions or NULL in case of error.

function osEventFlagsGetName ​

cpp
const char * osEventFlagsGetName(
    osEventFlagsId_t ef_id
)

Get name of an Event Flags object.

Parameters:

Return: name as null-terminated string.

function osEventFlagsSet ​

cpp
uint32_t osEventFlagsSet(
    osEventFlagsId_t ef_id,
    uint32_t flags
)

Set the specified Event Flags.

Parameters:

  • ef_id event flags ID obtained by osEventFlagsNew.
  • flags specifies the flags that shall be set.

Return: event flags after setting or error code if highest bit set.

function osEventFlagsClear ​

cpp
uint32_t osEventFlagsClear(
    osEventFlagsId_t ef_id,
    uint32_t flags
)

Clear the specified Event Flags.

Parameters:

  • ef_id event flags ID obtained by osEventFlagsNew.
  • flags specifies the flags that shall be cleared.

Return: event flags before clearing or error code if highest bit set.

function osEventFlagsGet ​

cpp
uint32_t osEventFlagsGet(
    osEventFlagsId_t ef_id
)

Get the current Event Flags.

Parameters:

Return: current event flags.

function osEventFlagsWait ​

cpp
uint32_t osEventFlagsWait(
    osEventFlagsId_t ef_id,
    uint32_t flags,
    uint32_t options,
    uint32_t timeout
)

Wait for one or more Event Flags to become signaled.

Parameters:

  • ef_id event flags ID obtained by osEventFlagsNew.
  • flags specifies the flags to wait for.
  • options specifies flags options (osFlagsXxxx).
  • timeout CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Return: event flags before clearing or error code if highest bit set.

function osEventFlagsDelete ​

cpp
osStatus_t osEventFlagsDelete(
    osEventFlagsId_t ef_id
)

Delete an Event Flags object.

Parameters:

Return: status code that indicates the execution status of the function.

Macros Documentation ​

define osFlagsWaitAny ​

cpp
#define osFlagsWaitAny 0x00000000U

Wait for any flag (default).

define osFlagsWaitAll ​

cpp
#define osFlagsWaitAll 0x00000001U

Wait for all flags.

define osFlagsNoClear ​

cpp
#define osFlagsNoClear 0x00000002U

Do not clear flags which have been specified to wait for.

define osFlagsError ​

cpp
#define osFlagsError 0x80000000U

Error indicator.

define osFlagsErrorUnknown ​

cpp
#define osFlagsErrorUnknown 0xFFFFFFFFU

osError (-1).

define osFlagsErrorTimeout ​

cpp
#define osFlagsErrorTimeout 0xFFFFFFFEU

osErrorTimeout (-2).

define osFlagsErrorResource ​

cpp
#define osFlagsErrorResource 0xFFFFFFFDU

osErrorResource (-3).

define osFlagsErrorParameter ​

cpp
#define osFlagsErrorParameter 0xFFFFFFFCU

osErrorParameter (-4).

define osFlagsErrorISR ​

cpp
#define osFlagsErrorISR 0xFFFFFFFAU

osErrorISR (-6).