Setting and clearing event bits in FreeRTOS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of event bits in FreeRTOS?

Event bits are used to signal and synchronize tasks by setting or clearing specific bits in an event group, allowing tasks to wait for or react to certain conditions.

beginner

How do you set event bits in FreeRTOS?

Use the function xEventGroupSetBits() to set one or more bits in an event group, signaling that certain events have occurred.

beginner

How do you clear event bits in FreeRTOS?

Use the function xEventGroupClearBits() to clear one or more bits in an event group, indicating that certain events are no longer active.

intermediate

What does the function xEventGroupWaitBits() do?

It allows a task to wait for one or more bits to be set in an event group, optionally clearing the bits before returning, enabling synchronization based on events.

intermediate

Why might you clear event bits after a task wakes up?

Clearing event bits prevents the same event from triggering the task repeatedly and allows the system to detect new events separately.

Which FreeRTOS function sets bits in an event group?

A xEventGroupWaitBits()

B xEventGroupClearBits()

C xEventGroupCreate()

D xEventGroupSetBits()

xEventGroupSetBits() sets one or more bits in an event group.

What happens when you clear event bits in FreeRTOS?

A The bits are set to 1, signaling an event.

B The bits are reset to 0, indicating the event is no longer active.

C The event group is deleted.

D Tasks are suspended.

Clearing bits resets them to 0, showing the event is cleared.

Which function lets a task wait for specific event bits to be set?

A xEventGroupSetBits()

B xEventGroupClearBits()

C xEventGroupWaitBits()

D vTaskDelay()

xEventGroupWaitBits() blocks a task until specified bits are set.

Why would you clear bits after waiting on them?

A To avoid repeated triggers from the same event.

B To create a new event group.

C To suspend the task.

D To reset the scheduler.

Clearing bits prevents the same event from waking the task again.

What data type represents event groups in FreeRTOS?

A EventGroupHandle_t

B TaskHandle_t

C SemaphoreHandle_t

D QueueHandle_t

EventGroupHandle_t is the type used for event groups.

Explain how to set and clear event bits in FreeRTOS and why this is useful.

Think about how tasks communicate using bits to signal events.

Describe the role of xEventGroupWaitBits() and how clearing bits affects task behavior.

Consider what happens when a task waits for an event and how clearing bits changes future waits.

Practice

1. What is the primary purpose of xEventGroupSetBits() in FreeRTOS?

easy

A. To create a new event group

B. To clear (reset) specific bits in an event group

C. To set (signal) specific bits in an event group

D. To delete an existing event group

Solution

1. Step 1: Understand the function name

   xEventGroupSetBits() suggests setting bits, which means signaling events.

2. Step 2: Compare with other functions

   xEventGroupClearBits() is used to clear bits, so setting bits is done by xEventGroupSetBits().

3. Final Answer:

   To set (signal) specific bits in an event group -> Option C

4. Quick Check:

   Set bits = signal events [OK]

Hint: Set bits means signal events, clear bits means reset [OK]

Common Mistakes:

• Confusing setting bits with clearing bits
• Thinking it creates or deletes event groups
• Mixing up function names

2. Which of the following is the correct syntax to clear bits 0x03 in an event group named myEventGroup?

easy

A. xEventGroupClear(myEventGroup, 0x03);

B. xEventGroupSetBits(myEventGroup, 0x03);

C. xClearEventBits(myEventGroup, 0x03);

D. xEventGroupClearBits(myEventGroup, 0x03);

Solution

1. Step 1: Identify the correct function for clearing bits

   The function to clear bits is xEventGroupClearBits().

2. Step 2: Check the syntax

   The correct syntax is xEventGroupClearBits(eventGroupHandle, bitsToClear);. xEventGroupClearBits(myEventGroup, 0x03); matches this exactly.

3. Final Answer:

   xEventGroupClearBits(myEventGroup, 0x03); -> Option D

4. Quick Check:

   Clear bits syntax = xEventGroupClearBits(handle, bits) [OK]

Hint: Clear bits uses xEventGroupClearBits with group and bit mask [OK]

Common Mistakes:

• Using xEventGroupSetBits to clear bits
• Using incorrect function names
• Missing parameters or wrong order

3. Given the code snippet:

EventBits_t bits;
bits = xEventGroupSetBits(myEventGroup, 0x05);
bits = xEventGroupClearBits(myEventGroup, 0x01);

What is the value of bits after these calls if the initial bits were 0x00?

medium

A. 0x00

B. 0x05

C. 0x04

D. 0x01

Solution

1. Step 1: First call - xEventGroupSetBits(myEventGroup, 0x05)

   Initial event group: 0x00. Returns bits BEFORE setting: 0x00 (event group becomes 0x05). bits = 0x00.

2. Step 2: Second call - xEventGroupClearBits(myEventGroup, 0x01)

   Event group now: 0x05. Returns bits BEFORE clearing: 0x05 (event group becomes 0x04). bits = 0x05.

3. Final Answer:

   0x00 -> Option A

4. Quick Check:

   Return value = pre-operation bits [OK]

Hint: xEventGroupSetBits/ClearBits return bits BEFORE operation [OK]

Common Mistakes:

• Confusing return value (pre-op) with post-op event group state
• Miscalculating bitwise operations on event group
• Forgetting return value overwrites 'bits' each call

4. Identify the error in this code snippet:

EventGroupHandle_t myEventGroup;
myEventGroup = xEventGroupCreate();
xEventGroupClearBits(0x01, myEventGroup);

medium

A. Arguments to xEventGroupClearBits are reversed

B. xEventGroupCreate() returns void, not a handle

C. xEventGroupClearBits requires a pointer, not a value

D. Missing include for FreeRTOS headers

Solution

1. Step 1: Check function parameter order

   xEventGroupClearBits() expects (EventGroupHandle_t, EventBits_t). The code passes (0x01, myEventGroup), which is reversed.

2. Step 2: Confirm return type of xEventGroupCreate()

   xEventGroupCreate() returns an EventGroupHandle_t, so assignment is correct.

3. Final Answer:

   Arguments to xEventGroupClearBits are reversed -> Option A

4. Quick Check:

   Function parameters order matters [OK]

Hint: Check parameter order carefully for FreeRTOS API calls [OK]

Common Mistakes:

• Swapping parameters in API calls
• Assuming wrong return types
• Ignoring compiler warnings

5. You want to signal two events represented by bits 0x01 and 0x04, then immediately clear bit 0x01 without affecting others. Which sequence correctly achieves this?

hard

A. xEventGroupClearBits(myEventGroup, 0x05); xEventGroupSetBits(myEventGroup, 0x01);

B. xEventGroupSetBits(myEventGroup, 0x05); xEventGroupClearBits(myEventGroup, 0x01);

C. xEventGroupSetBits(myEventGroup, 0x01); xEventGroupClearBits(myEventGroup, 0x04);

D. xEventGroupClearBits(myEventGroup, 0x01); xEventGroupSetBits(myEventGroup, 0x05);

Solution

1. Step 1: Set bits 0x01 and 0x04 together

   Setting bits 0x05 (binary 0101) signals both events at once.

2. Step 2: Clear only bit 0x01

   Clearing bit 0x01 removes that event signal but leaves 0x04 set.

3. Final Answer:

   xEventGroupSetBits(myEventGroup, 0x05); xEventGroupClearBits(myEventGroup, 0x01); -> Option B

4. Quick Check:

   Set both bits then clear one bit [OK]

Hint: Set all bits first, then clear only the unwanted bit [OK]

Common Mistakes:

• Clearing bits before setting them
• Clearing wrong bits
• Not combining bits correctly