xEventGroupWaitBits()

event_groups.h

1EventBits_t xEventGroupWaitBits(
2                      const EventGroupHandle_t xEventGroup,
3                      const EventBits_t uxBitsToWaitFor,
4                      const BaseType_t xClearOnExit,
5                      const BaseType_t xWaitForAllBits,
6                      TickType_t xTicksToWait );

Read bits within an RTOS event group, optionally entering the Blocked state (with a timeout) to wait for a bit or group of bits to become set.

This function cannot be called from an interrupt.

The RTOS source file FreeRTOS/source/event_groups.c must be included in the build for the

xEventGroupWaitBits()

function to be available.

Parameters:

xEventGroup

The event group in which the bits are being tested. The event group must have previously been created using a call to xEventGroupCreate().
uxBitsToWaitFor

A bitwise value that indicates the bit or bits to test inside the event group. For example, to wait for bit 0 and/or bit 2 set
```
uxBitsToWaitFor
```
to 0x05. To wait for bits 0 and/or bit 1 and/or bit 2 set
```
uxBitsToWaitFor
```
to 0x07. Etc.
```
uxBitsToWaitFor
```
must not be set to 0.
xClearOnExit

If
```
xClearOnExit
```
is set to
```
pdTRUE
```
then any bits set in the value passed as the
```
uxBitsToWaitFor
```
parameter will be cleared in the event group before
```
xEventGroupWaitBits()
```
returns if
```
xEventGroupWaitBits()
```
returns for any reason other than a timeout. The timeout value is set by the
```
xTicksToWait
```
parameter. If
```
xClearOnExit
```
is set to
```
pdFALSE
```
then the bits set in the event group are not altered when the call to
```
xEventGroupWaitBits()
```
returns.
xWaitForAllBits
```
xWaitForAllBits
```
is used to create either a logical AND test (where all bits must be set) or a logical OR test (where one or more bits must be set) as follows:

If
```
xWaitForAllBits
```
is set to
```
pdTRUE
```
then
```
xEventGroupWaitBits()
```
will return when either all the bits set in the value passed as the
```
uxBitsToWaitFor
```
parameter are set in the event group or the specified block time expires.

If
```
xWaitForAllBits
```
is set to
```
pdFALSE
```
then
```
xEventGroupWaitBits()
```
will return when any of the bits set in the value passed as the
```
uxBitsToWaitFor
```
parameter are set in the event group or the specified block time expires.
xTicksToWait

The maximum amount of time (specified in 'ticks') to wait for one/all (depending on the
```
xWaitForAllBits
```
value) of the bits specified by
```
uxBitsToWaitFor
```
to become set.

Returns:

The value of the event group at the time either the event bits being waited for became set, or the block time expired. The current value of the event bits in an event group will be different to the returned value if a higher priority task or interrupt changed the value of an event bit between the calling task leaving the Blocked state and exiting the
```
xEventGroupWaitBits()
```
function.

Test the return value to know which bits were set. If
```
xEventGroupWaitBits()
```
returned because its timeout expired then not all the bits being waited for will be set. If
```
xEventGroupWaitBits()
```
returned because the bits it was waiting for were set then the returned value is the event group value before any bits were automatically cleared because the
```
xClearOnExit
```
parameter was set to
```
pdTRUE
```
.

Example usage:

1#define BIT_0	( 1 << 0 )
2#define BIT_4	( 1 << 4 )
3
4void aFunction( EventGroupHandle_t xEventGroup )
5{
6    EventBits_t uxBits;
7    const TickType_t xTicksToWait = 100 / portTICK_PERIOD_MS;
8
9    /* Wait a maximum of 100ms for either bit 0 or bit 4 to be set within
10       the event group. Clear the bits before exiting. */
11    uxBits = xEventGroupWaitBits(
12               xEventGroup,   /* The event group being tested. */
13               BIT_0 | BIT_4, /* The bits within the event group to wait for. */
14               pdTRUE,        /* BIT_0 & BIT_4 should be cleared before returning. */
15               pdFALSE,       /* Don't wait for both bits, either bit will do. */
16               xTicksToWait );/* Wait a maximum of 100ms for either bit to be set. */
17
18    if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )
19    {
20        /* xEventGroupWaitBits() returned because both bits were set. */
21    }
22    else if( ( uxBits & BIT_0 ) != 0 )
23    {
24        /* xEventGroupWaitBits() returned because just BIT\_0 was set. */
25    }
26    else if( ( uxBits & BIT_4 ) != 0 )
27    {
28        /* xEventGroupWaitBits() returned because just BIT\_4 was set. */
29    }
30    else
31    {
32        /* xEventGroupWaitBits() returned because xTicksToWait ticks passed
33           without either BIT\_0 or BIT\_4 becoming set. */
34    }
35}

xEventGroupWaitBits()

Related links