Task handle usage in FreeRTOS

Introduction

Task handles let you keep track of tasks you create in FreeRTOS. They help you control and communicate with tasks easily.

When you want to delete a task after creating it.

When you need to suspend or resume a specific task.

When you want to check or change the state of a task.

When you want to send notifications or messages to a task.

When you want to get information about a task, like its priority.

Syntax

FreeRTOS

TaskHandle_t xHandle = NULL;

xTaskCreate(
    TaskFunction_t pvTaskCode,
    const char * const pcName,
    configSTACK_DEPTH_TYPE usStackDepth,
    void *pvParameters,
    UBaseType_t uxPriority,
    TaskHandle_t *pxCreatedTask
);

The TaskHandle_t is a pointer type used to identify tasks.

Passing the address of a TaskHandle_t variable to xTaskCreate stores the created task's handle.

Examples

This creates a task named "Task1" and saves its handle in xTaskHandle.

FreeRTOS

TaskHandle_t xTaskHandle = NULL;

xTaskCreate(
    vTaskCode,
    "Task1",
    1000,
    NULL,
    1,
    &xTaskHandle
);

This suspends the task identified by xTaskHandle.

FreeRTOS

vTaskSuspend(xTaskHandle);

This deletes the task using its handle.

FreeRTOS

vTaskDelete(xTaskHandle);

Sample Program

This program creates a task and saves its handle. It runs the task printing a message every second. Then it suspends the task for 2 seconds, resumes it for 2 seconds, and finally deletes it.

FreeRTOS

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

TaskHandle_t xTaskHandle = NULL;

void vTaskFunction(void *pvParameters) {
    for (;;) {
        printf("Task is running\n");
        vTaskDelay(pdMS_TO_TICKS(1000));
    }
}

int main(void) {
    xTaskCreate(
        vTaskFunction,
        "MyTask",
        1000,
        NULL,
        1,
        &xTaskHandle
    );

    vTaskDelay(pdMS_TO_TICKS(3000));

    printf("Suspending task...\n");
    vTaskSuspend(xTaskHandle);

    vTaskDelay(pdMS_TO_TICKS(2000));

    printf("Resuming task...\n");
    vTaskResume(xTaskHandle);

    vTaskDelay(pdMS_TO_TICKS(2000));

    printf("Deleting task...\n");
    vTaskDelete(xTaskHandle);

    for (;;) {}
    return 0;
}

Important Notes

Always check if the task handle is not NULL before using it.

Deleting a task frees its resources, so use vTaskDelete carefully.

Task handles are useful for controlling tasks after creation.

Summary

Task handles identify tasks and let you control them.

Use task handles to suspend, resume, or delete tasks.

Store the handle when creating a task to use it later.

Practice

1.

What is the main purpose of a task handle in FreeRTOS?

easy

A. To allocate memory for tasks

B. To store task priority values

C. To identify and control a specific task

D. To define the task's stack size

Solution

1. Step 1: Understand what a task handle represents

   A task handle is a reference used to identify a task uniquely in FreeRTOS.

2. Step 2: Identify the purpose of the handle

   The handle allows you to control the task, such as suspending or deleting it.

3. Final Answer:

   To identify and control a specific task -> Option C

4. Quick Check:

   Task handle = task control reference [OK]

Hint: Task handles let you control tasks by their ID [OK]

Common Mistakes:

• Confusing handle with task priority
• Thinking handle allocates memory
• Mixing handle with stack size

2.

Which of the following is the correct way to declare a task handle variable in FreeRTOS?

?

easy

A. TaskHandle_t xTaskHandle;

B. TaskHandle xTaskHandle;

C. HandleTask_t xTaskHandle;

D. Task_Handle xTaskHandle;

Solution

1. Step 1: Recall the FreeRTOS type for task handles

   The correct type defined by FreeRTOS for task handles is TaskHandle_t.

2. Step 2: Check the syntax of declaration

   Declaring a variable as TaskHandle_t xTaskHandle; is the correct syntax.

3. Final Answer:

   TaskHandle_t xTaskHandle; -> Option A

4. Quick Check:

   Task handle type = TaskHandle_t [OK]

Hint: Use TaskHandle_t to declare task handles [OK]

Common Mistakes:

• Using incorrect type names
• Adding underscores wrongly
• Confusing with other handle types

3.

What will be the output of the following code snippet?

TaskHandle_t xHandle = NULL;

void vTaskFunction(void *pvParameters) {
    for (;;) {
        vTaskDelay(pdMS_TO_TICKS(1000));
    }
}

int main() {
    xTaskCreate(vTaskFunction, "Task1", 1000, NULL, 1, &xHandle);
    if (xHandle != NULL) {
        printf("Task created successfully\n");
    } else {
        printf("Task creation failed\n");
    }
    return 0;
}

medium

A. Task creation failed

B. Task created successfully

C. Compilation error due to missing includes

D. No output, program hangs

Solution

1. Step 1: Analyze task creation and handle assignment

   The function xTaskCreate assigns the created task's handle to xHandle. If successful, xHandle is not NULL.

2. Step 2: Check the condition and output

   The code checks if xHandle != NULL and prints "Task created successfully" if true.

3. Final Answer:

   Task created successfully -> Option B

4. Quick Check:

   xHandle != NULL means success [OK]

Hint: Check if handle is NULL to confirm task creation [OK]

Common Mistakes:

• Assuming handle is NULL on success
• Ignoring handle assignment
• Confusing task creation return value

4.

Identify the error in the following code snippet related to task handle usage:

TaskHandle_t xTaskHandle;

void vTaskFunction(void *pvParameters) {
    for (;;) {
        vTaskDelay(pdMS_TO_TICKS(500));
    }
}

int main() {
    xTaskCreate(vTaskFunction, "Task", 1000, NULL, 1, xTaskHandle);
    vTaskSuspend(xTaskHandle);
    return 0;
}

medium

A. xTaskCreate should pass &xTaskHandle, not xTaskHandle

B. vTaskSuspend cannot suspend a task

C. Task handle must be initialized to NULL before use

D. Task priority is missing in xTaskCreate

Solution

1. Step 1: Check how task handle is passed to xTaskCreate

   The last parameter of xTaskCreate expects a pointer to the task handle variable, so it should be &xTaskHandle.

2. Step 2: Identify the error in the code

   The code passes xTaskHandle instead of its address, causing incorrect handle assignment.

3. Final Answer:

   xTaskCreate should pass &xTaskHandle, not xTaskHandle -> Option A

4. Quick Check:

   Pass handle address to xTaskCreate [OK]

Hint: Always pass &handle to xTaskCreate [OK]

Common Mistakes:

• Passing handle instead of its address
• Assuming vTaskSuspend needs no handle
• Ignoring task priority parameter

5.

You want to create two tasks and suspend the first one after creation using task handles. Which code snippet correctly achieves this?

void vTask1(void *pvParameters) { for(;;) {} }
void vTask2(void *pvParameters) { for(;;) {} }

int main() {
    TaskHandle_t xHandle1 = NULL, xHandle2 = NULL;
    // Create tasks here
    // Suspend first task here
    return 0;
}

hard

A. xTaskCreate(vTask1, "Task1", 1000, NULL, 1, &xHandle1);
xTaskCreate(vTask2, "Task2", 1000, NULL, 1, &xHandle2);
vTaskSuspend(NULL);

B. xTaskCreate(vTask1, "Task1", 1000, NULL, 1, xHandle1);
xTaskCreate(vTask2, "Task2", 1000, NULL, 1, xHandle2);
vTaskSuspend(xHandle1);

C. xTaskCreate(vTask1, "Task1", 1000, NULL, 1, &xHandle1);
xTaskCreate(vTask2, "Task2", 1000, NULL, 1, &xHandle2);
vTaskSuspend(&xHandle1);

D. xTaskCreate(vTask1, "Task1", 1000, NULL, 1, &xHandle1);
xTaskCreate(vTask2, "Task2", 1000, NULL, 1, &xHandle2);
vTaskSuspend(xHandle1);

Solution

1. Step 1: Correctly create tasks with handles

   Use &xHandle1 and &xHandle2 to store task handles during creation.

2. Step 2: Suspend the first task using its handle

   Call vTaskSuspend(xHandle1); to suspend the first task by passing the handle itself, not its address or NULL.

3. Final Answer:

   Correct creation with &xHandle and suspend with xHandle1 -> Option D

4. Quick Check:

   Create with &handle, suspend with handle [OK]

Hint: Create tasks with &handle, suspend using handle [OK]

Common Mistakes:

• Passing handle instead of &handle to xTaskCreate
• Passing &handle to vTaskSuspend instead of handle
• Suspending with NULL handle