ulTaskNotifyTake() for binary/counting notification in FreeRTOS

Introduction

ulTaskNotifyTake() helps a task wait for a signal or event from another task or interrupt. It makes tasks sleep until something important happens.

When a task needs to wait for a simple yes/no signal from another task.

When a task should wait for multiple signals and count how many happened.

When you want to avoid busy waiting and save CPU by sleeping until notified.

When synchronizing tasks without using heavy mechanisms like semaphores.

When an interrupt signals a task to start work or update data.

Syntax

FreeRTOS

uint32_t ulTaskNotifyTake(BaseType_t xClearCountOnExit, TickType_t xTicksToWait);

xClearCountOnExit: Use 1 (pdTRUE) to reset the notification count to zero after taking it (binary behavior). Use 0 (pdFALSE) to keep counting notifications (counting behavior).

xTicksToWait: How long the task waits if no notification is available. Use portMAX_DELAY to wait forever.

Examples

Wait forever for a single notification, then clear the count (binary notification).

FreeRTOS

ulTaskNotifyTake(pdTRUE, portMAX_DELAY);

Wait up to 100 ticks for notifications, keep counting them (counting notification).

FreeRTOS

ulTaskNotifyTake(pdFALSE, 100);

Sample Program

This program creates two tasks. The sender sends three notifications with 500ms delay each. The receiver waits and counts notifications using ulTaskNotifyTake() in counting mode (xClearCountOnExit = pdFALSE). It prints how many notifications it got each time. When it receives all three, it stops.

FreeRTOS

#include "FreeRTOS.h"
#include "task.h"
#include <stdio.h>

TaskHandle_t xTaskHandle = NULL;

void vSenderTask(void *pvParameters) {
    for (int i = 1; i <= 3; i++) {
        vTaskDelay(pdMS_TO_TICKS(500));
        xTaskNotifyGive(xTaskHandle); // Send notification
        printf("Sender: Notification %d sent\n", i);
    }
    vTaskDelete(NULL);
}

void vReceiverTask(void *pvParameters) {
    uint32_t ulCount;
    uint32_t ulTotalCount = 0;
    while (1) {
        ulCount = ulTaskNotifyTake(pdFALSE, portMAX_DELAY); // Counting mode
        printf("Receiver: Got %lu notifications\n", ulCount);
        ulTotalCount += ulCount;
        if (ulTotalCount >= 3) {
            printf("Receiver: Received all notifications, exiting.\n");
            break;
        }
    }
    vTaskDelete(NULL);
}

int main(void) {
    xTaskCreate(vReceiverTask, "Receiver", 1000, NULL, 2, &xTaskHandle);
    xTaskCreate(vSenderTask, "Sender", 1000, NULL, 2, NULL);
    vTaskStartScheduler();
    return 0;
}

Important Notes

ulTaskNotifyTake() returns the number of notifications received since last call if counting mode is used.

Use pdTRUE for binary notification to clear count after taking it.

ulTaskNotifyTake() is efficient and lightweight compared to semaphores.

Summary

ulTaskNotifyTake() lets a task wait for notifications from other tasks or interrupts.

Use xClearCountOnExit = pdTRUE for binary (single) notification, pdFALSE for counting multiple notifications.

It helps tasks sleep and save CPU until something important happens.

Practice

1. What does the ulTaskNotifyTake() function do in FreeRTOS?

easy

A. It deletes a task from the scheduler.

B. It creates a new task in the system.

C. It sends a notification to another task.

D. It blocks a task until a notification is received.

Solution

1. Step 1: Understand the purpose of ulTaskNotifyTake()

   This function is designed to make a task wait (block) until it receives a notification from another task or interrupt.

2. Step 2: Differentiate from other task functions

   Creating, sending, or deleting tasks are done by other FreeRTOS functions, not ulTaskNotifyTake().

3. Final Answer:

   It blocks a task until a notification is received. -> Option D

4. Quick Check:

   ulTaskNotifyTake() waits for notification [OK]

Hint: ulTaskNotifyTake() makes task wait for notification [OK]

Common Mistakes:

• Confusing ulTaskNotifyTake() with task creation functions
• Thinking it sends notifications instead of receiving
• Assuming it deletes tasks

2. Which parameter of ulTaskNotifyTake() controls whether the notification count resets on exit?

easy

A. xClearCountOnExit

B. xTicksToWait

C. ulNotificationValue

D. xNotifyOption

Solution

1. Step 1: Identify parameters of ulTaskNotifyTake()

   ulTaskNotifyTake() takes two parameters: xClearCountOnExit and xTicksToWait.

2. Step 2: Understand xClearCountOnExit role

   This parameter decides if the notification count resets to zero when the function exits (pdTRUE) or not (pdFALSE).

3. Final Answer:

   xClearCountOnExit -> Option A

4. Quick Check:

   xClearCountOnExit resets count [OK]

Hint: xClearCountOnExit resets notification count [OK]

Common Mistakes:

• Mixing xClearCountOnExit with xTicksToWait
• Assuming ulNotificationValue is a parameter
• Confusing with notification sending options

3. Consider this code snippet:

uint32_t count = ulTaskNotifyTake(pdFALSE, portMAX_DELAY);
// Assume 3 notifications were sent before this call

What will be the value of count after this call?

medium

A. 1

B. 0

C. 3

D. portMAX_DELAY

Solution

1. Step 1: Analyze xClearCountOnExit parameter

   pdFALSE means the notification count is not cleared on exit, so it counts all notifications received.

2. Step 2: Understand the count returned

   Since 3 notifications were sent before, ulTaskNotifyTake() returns the total count, which is 3.

3. Final Answer:

   3 -> Option C

4. Quick Check:

   pdFALSE keeps count, so count = 3 [OK]

Hint: pdFALSE keeps count, so returns total notifications [OK]

Common Mistakes:

• Assuming count resets to 1 regardless
• Confusing portMAX_DELAY as return value
• Thinking count is zero if notifications sent before

4. What is wrong with this code snippet?

uint32_t count = ulTaskNotifyTake(pdTRUE, 100);
if(count == 0) {
    // No notification received
}
// Task expects to count multiple notifications

medium

A. Using pdTRUE clears count, so multiple notifications can't be counted.

B. Timeout value 100 is invalid and causes error.

C. ulTaskNotifyTake() cannot be used with if statements.

D. count variable should be int, not uint32_t.

Solution

1. Step 1: Check xClearCountOnExit usage

   pdTRUE clears the notification count on exit, so only a binary notification is counted, not multiple.

2. Step 2: Understand task expectation

   The task expects to count multiple notifications, but pdTRUE resets count, so it cannot accumulate multiple counts.

3. Final Answer:

   Using pdTRUE clears count, so multiple notifications can't be counted. -> Option A

4. Quick Check:

   pdTRUE clears count, no multiple counting [OK]

Hint: pdTRUE clears count; use pdFALSE for counting multiple [OK]

Common Mistakes:

• Thinking timeout 100 is invalid
• Believing ulTaskNotifyTake() can't be in if
• Confusing variable type for count

5. You want a task to sleep until it receives exactly 2 notifications, then proceed. Which ulTaskNotifyTake() usage is correct?

hard

A. Call ulTaskNotifyTake(pdFALSE, portMAX_DELAY) twice and sum results.

B. Call ulTaskNotifyTake(pdFALSE, portMAX_DELAY) once and check if return is 2.

C. Call ulTaskNotifyTake(pdTRUE, 0) in a loop until count is 2.

D. Call ulTaskNotifyTake(pdTRUE, portMAX_DELAY) once and check if return is 2.

Solution

1. Step 1: Understand counting notifications

   Using pdFALSE keeps the count of notifications, so the function returns the total number received.

2. Step 2: Use single call to wait indefinitely

   Calling ulTaskNotifyTake(pdFALSE, portMAX_DELAY) waits until at least one notification arrives and returns the count accumulated.

3. Step 3: Check if count equals 2

   After the call returns, check if the count is exactly 2 to proceed.

4. Final Answer:

   Call ulTaskNotifyTake(pdFALSE, portMAX_DELAY) once and check if return is 2. -> Option B

5. Quick Check:

   pdFALSE counts notifications; check return for 2 [OK]

Hint: Use pdFALSE and check return count for exact notifications [OK]

Common Mistakes:

• Calling ulTaskNotifyTake multiple times and summing counts
• Using pdTRUE which resets count
• Using zero timeout causing immediate return