Task handle usage in FreeRTOS - Mini Project: Build & Apply

Task Handle Usage in FreeRTOS

📖 Scenario: You are building a simple FreeRTOS application where two tasks run concurrently. You want to create a task and keep its handle so you can manage it later, such as deleting or suspending the task.

🎯 Goal: Create a FreeRTOS task and store its handle in a variable. Then use the handle to suspend the task. Finally, print a message indicating the task was suspended.

📋 What You'll Learn

Create a task handle variable called Task1Handle

Create a task named Task1 with priority 1

Use xTaskCreate to create the task and store the handle in Task1Handle

Use vTaskSuspend with Task1Handle to suspend the task

Print "Task1 suspended" to the console

💡 Why This Matters

🌍 Real World

Task handles let you control tasks after creation, such as suspending, resuming, or deleting them. This is useful in embedded systems where tasks need to be managed dynamically.

💼 Career

Embedded software developers often use FreeRTOS task handles to manage multitasking in microcontroller applications, making this skill essential for real-time system programming.

1

Create a task handle variable

Declare a variable called Task1Handle of type TaskHandle_t and initialize it to NULL.

FreeRTOS

TaskHandle_t Task1Handle = NULL;  // Your code here

Hint

Task handles are pointers used to refer to tasks. Initialize it to NULL before creating the task.

2

Create the task function

Write a task function called Task1 that takes a void *pvParameters argument and contains an infinite loop with vTaskDelay(1000 / portTICK_PERIOD_MS); inside.

FreeRTOS

TaskHandle_t Task1Handle = NULL;

void Task1(void *pvParameters) {
    // Your code here
}

Hint

The task function must run forever, so use an infinite loop. Use vTaskDelay to wait 1 second each loop.

3

Create the task and store its handle

Use xTaskCreate to create the task Task1 with name "Task1", stack size configMINIMAL_STACK_SIZE, no parameters (NULL), priority 1, and store the task handle in Task1Handle.

FreeRTOS

TaskHandle_t Task1Handle = NULL;

void Task1(void *pvParameters) {
    for (;;) {
        vTaskDelay(1000 / portTICK_PERIOD_MS);
    }
}

// Your code here to create the task and store the handle

Hint

Pass the address of Task1Handle to xTaskCreate to save the created task's handle.

4

Suspend the task and print confirmation

Use vTaskSuspend with Task1Handle to suspend the task. Then use printf to print "Task1 suspended".

FreeRTOS

TaskHandle_t Task1Handle = NULL;

void Task1(void *pvParameters) {
    for (;;) {
        vTaskDelay(1000 / portTICK_PERIOD_MS);
    }
}

xTaskCreate(Task1, "Task1", configMINIMAL_STACK_SIZE, NULL, 1, &Task1Handle);

// Your code here to suspend the task and print message

Hint

Use the task handle to suspend the task. Then print the confirmation message exactly as shown.

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