Task handle usage in FreeRTOS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Task Handle in FreeRTOS?

A Task Handle is a reference or pointer to a task in FreeRTOS. It allows you to identify and manage the task after it is created, such as suspending, resuming, or deleting the task.

beginner

How do you create a task and get its handle in FreeRTOS?

You use the xTaskCreate() function, which has a parameter to store the task handle. For example:

TaskHandle_t xHandle = NULL;
xTaskCreate(TaskFunction, "TaskName", stackSize, NULL, priority, &xHandle);

beginner

Why is it useful to keep a Task Handle after creating a task?

Keeping a Task Handle lets you control the task later. You can suspend, resume, delete, or change its priority by passing the handle to FreeRTOS API functions.

intermediate

How do you suspend and resume a task using its handle?

Use vTaskSuspend() to pause the task and vTaskResume() to continue it. Both functions take the Task Handle as an argument. For example:

vTaskSuspend(xHandle);
vTaskResume(xHandle);

intermediate

What happens if you pass NULL as the Task Handle to vTaskSuspend() or vTaskResume()?

Passing NULL means the function will act on the current running task. So, vTaskSuspend(NULL) suspends the task that calls it.

What type is used to store a task handle in FreeRTOS?

A TaskHandle_t

B int

C void*

D TaskID

TaskHandle_t is the FreeRTOS type specifically for task handles.

Which function creates a task and can return its handle?

A vTaskStartScheduler()

B xQueueCreate()

C xTaskCreate()

D vTaskDelete()

xTaskCreate() creates a task and can provide its handle via a pointer parameter.

How do you suspend a task using its handle?

A xTaskCreate(handle)

B vTaskDelete(handle)

C vTaskResume(handle)

D vTaskSuspend(handle)

vTaskSuspend() pauses the task identified by the handle.

What does passing NULL to vTaskResume() do?

A Resumes all tasks

B Resumes the current running task

C Causes an error

D Resumes the idle task

Passing NULL means the function acts on the current task.

Why should you store a task handle when creating a task?

A To control the task later (suspend, resume, delete)

B To increase the task's stack size

C To change the task's name

D To start the scheduler

The handle lets you manage the task after creation.

Explain what a Task Handle is and how it is used in FreeRTOS.

Think about how you keep a reference to a task to control it later.

Describe the steps to create a task and then suspend and resume it using its handle.

Focus on the functions and the role of the handle.

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