FreeRTOS学习 -- 任务相关API函数

一、任务创建和删除API函数

FreeRTOS 最基本的功能就是任务管理，而任务管理最基本的操作就是创建和删除任务。

FreeRTOS的任务创建和删除API函数如下：
在这里插入图片描述

1、函数 xTaskCreate()

此函数用来创建一个任务，任务需要 RAM 来保存于任务有关的状态信息（任务控制块），任务也需要一定的 RAM 来作为任务堆栈。如果使用函数 xTaskCreate() 来创建任务的话，那么这些所需的 RAM 就会自动的从 FreeRTOS 的堆栈中分配，因此必须提供内存管理文件，默认我们使用的 heap_4.c 这个内存管理文件，而且宏 configSUPPORT_DYNAMIC_ALLOCATION 必须为 1。

如果使用函数 xTaskCreateStatic()创建的话这些 RAM 就需要用户来提供了。新创建的任务默认就是就绪态的，如果当前没有比它更高优先级的任务运行那么此任务就会立即进入运行态开始运行，不管在任务调度器启动前还是启动后，都可以创建任务。
在这里插入图片描述

参数：

pxTaskCode 任务函数
pcName 任务名字，一般用于追踪和调试，任务名字长度不能超过 configMAX_TASK_NAME_LEN。
usStackDepth 任务堆栈大小，需要注意实际申请到的堆栈是 usStackDepth 的 4倍。其中空闲任务的任务堆栈大小为 configMINIMAL_STACK_SIZE。
pvParameters 传递给任务函数的参数。
uxPriority 任务优先级，范围 0~ configMAX_PRIORITIES-1。其中 0 是最低优先级，configMAX_PRIORITIES-1 是最高优先级。注意和 uC/OS 的区别，uC/OS 中 0 是最高优先级！宏 configMAX_PRIORITIES 不能超过 32 ！也就是优先级不能超过 32 级。
pxCreatedTask 任务句柄，任务创建成功以后会返回任务的任务句柄。这个句柄其实就是任务的任务堆栈。此参数就用来保存这个任务句柄。

返回值：

pdPASS: 任务创建成功。
errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY：任务创建失败，因为堆内存不足！

示例：
在这里插入图片描述

2、函数 xTaskCreateStatic()

此函数和 xTaskCreate() 的功能相同，噎死用来创建任务的。但是使用此函数创建的任务的 RAM 需要用户来提供。如果使用此函数的话需要将宏
configSUPPORT_STATIC_ALLOCATION 定义为 1。
在这里插入图片描述

参数：

pxTaskCode 任务函数
pcName 任务名字，一般用于追踪和调试，任务名字长度不能超过 configMAX_TASK_NAME_LEN。
usStackDepth 任务堆栈大小，需要注意实际申请到的堆栈是 usStackDepth 的 4倍。其中空闲任务的任务堆栈大小为 configMINIMAL_STACK_SIZE。
pvParameters 传递给任务函数的参数。
uxPriority 任务优先级，范围 0~ configMAX_PRIORITIES-1。其中 0 是最低优先级，configMAX_PRIORITIES-1 是最高优先级。注意和 uC/OS 的区别，uC/OS 中 0 是最高优先级！宏 configMAX_PRIORITIES 不能超过 32 ！也就是优先级不能超过 32 级。
puxStackBuffer: 任务堆栈，一般为数组，数组类型要为 StackType_t 类型。
pxTaskBuffer: 任务控制块。

返回值：

NULL：任务创建失败，puxStackBuffer 或 pxTaskBuffer 为 NULL 的时候会导致这个错误的发生。
其他值: 任务创建成功，返回任务的任务句柄。

示例：
在这里插入图片描述

3、函数 xTaskCreateRestricted()

此函数也是用来创建任务的，只不过此函数要求所使用的 MCU 有 MPU（内存保护单元），用此函数创建的任务会受到 MPU 的保护。其他的功能和函数 xTaskCreate() 一样。
在这里插入图片描述

参数：

pxTaskDefinition: 指向一个结构体 TaskParameters_t，这个结构体描述了任务的任务函数、堆栈大小、优先级等。此结构体在文件 task.h 中有定义。
pxCreatedTask: 任务句柄。

返回值：

pdPASS: 任务创建成功。
其他值: 任务未创建成功，很有可能是因为 FreeRTOS 的堆太小了。

4、函数 vTaskDelete()

删除一个用函数 xTaskCreate()和xTaskCreateStatic() 创建的任务，被删除了的任务不再存在，也就是说再也不会进入运行态。任务被删除以后就不能再使用此任务的句柄。如果此任务是使用动态方法（ xTaskCreate()）创建的，那么此任务被删除以后此任务之前申请的堆栈和控制块内存会再空闲任务重被释放掉，因此当调佣函数 vTaskDelete() 删除任务以后必须给空闲任务一定的运行时间。

只有那些由内核分配给任务的内存才会在任务被删除以后自动的释放掉，用户分配给任务的内存需要用户自行释放掉。比如某个任务中用户调用函数 pvPortMalloc()分配了 500 字节的内存，那么在此任务被删除以后用户也必须调用函数 vPortFree()将这 500 字节的内存释放掉，否则会导致内存泄露。

在这里插入图片描述
参数：

xTaskToDelete 要删除的任务的句柄。

二、任务挂起和恢复 API 函数

当某个任务要停止运行一段时间的话就将这个任务挂起，当要重新运行这个任务的话就恢复这个任务的运行。
FreeRTOS 的任务挂起和恢复 API 函数如下：
在这里插入图片描述

1、函数 vTaskSuspend()

此函数用于将某个任务设置为挂起态，进入挂起态的任务永远都不会进入运行态。退出挂起态的唯一方法就是调用任务恢复函数 vTaskResume() 或 xTaskResumeFromISR()。
在这里插入图片描述
参数：

xTaskToSuspend 要挂起的任务的任务句柄，创建任务的时候会为每个任务分配一个任务句柄。
如果使用函数 xTaskCreate() 创建任务的话那么函数的参数 pxCreatedTask 就是此任务的任务句柄，如果使用函数 xTaskCreateStatic()创建任务的话那么函数的返回值就是此任务的任务句柄。也可以通过函数 xTaskGetHandle()来根据任务名字来获取某个任务的任务句柄。注意！如果参数为 NULL 的话表示挂起任务自己。