一、头文件
#include "FreeRTOS.h"
#include "task.h"
二、任务创建与启动
2.1 相关API说明
2.1.1 TaskHandle_t
任务句柄。例如，对xTaskCreate的调用返回。可用作参数到vTaskDelete以删除任务。
/**
* task. h
*
* Type by which tasks are referenced. For example, a call to xTaskCreate
* returns (via a pointer parameter) an TaskHandle_t variable that can then
* be used as a parameter to vTaskDelete to delete the task.
*
* \defgroup TaskHandle_t TaskHandle_t
* \ingroup Tasks
*/
typedef void * TaskHandle_t;
2.1.2 xTaskCreate
使用动态内存的方法创建一个任务。
| 函数 | BaseType_t xTaskCreate ( TaskFunction_t pxTaskCode, const char * const pcName, const configSTACK_DEPTH_TYPE usStackDepth, void * const pvParameters, UBaseType_t uxPriority, TaskHandle_t * const pxCreatedTask ) |
|---|---|
| 参数 | pxTaskCode：任务入口函数，即任务函数的名称，需要自定义并且实现 pcName：任务名字，字符串形式，任务名字最好与任务入口函数名字一致，方便调试 usStackDepth：任务堆栈大小，单位为字，在32位处理器（STM32），一个字等于4字节，如果传入512那么任务大小为512*4字节 pvParameters：任务入口函数形参，不用的时候配置为0或NULL即可 uxPriority：任务的优先级，在 FreeRTOS 中，数值越大优先级越高，0 代表最低优先级 pxCreatedTask：用于回传一个句柄（ID），创建任务后可以使用这个句柄引用任务 |
| 返回值 | pdPASS：任务创建成功 errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY：由于内存堆空间不足，FreeRTOS 无法分配足够的空间来保存任务结构数据和任务栈，因此无法创建任务 |
2.1.3 vTaskDelete
删除自己或其它任务。任务被删除后就不复存在，也不会再进入运行态。
| 函数 | void vTaskDelete( TaskHandle_t xTaskToDelete ) |
|---|---|
| 参数 | xTaskToDelete：被删除任务的句柄(目标任务)。如果是删除自身， 则形参为 NULL |
| 返回值 | 无 |
要想使用该函数必须在 FreeRTOSConfig.h 中把 INCLUDE_vTaskDelete 定义为 1 来使能。
2.1.4 vTaskStartScheduler
在创建完任务的时候，我们需要开启调度器，因为创建仅仅是把任务添加到系统中，还没真正调度，并且空闲任务也没实现，定时器任务也没实现，这些都是在开启调度函数 vTaskStartScheduler() 中实现的。为什么要空闲任务？因为 FreeRTOS 一旦启动，就必须要保证系统中每时每刻都有一个任务处于运行态（Runing），并且空闲任务不可以被挂起与删除，空闲任务的优先级是最低的，以便系统中其他任务能随时抢占空闲任务的 CPU 使用权。
| 函数 | void vTaskStartScheduler( void ) |
|---|---|
| 参数 | 无 |
| 返回值 | 无 |
2.2 示例
#include "FreeRTOS.h"
#include "task.h"
#include "bsp_led.h"
#include "bsp_usart.h"
/****************** 任务句柄 ******************/
/*
* 任务句柄是一个指针，用于指向一个任务，当任务创建好之后，它就具有了一个任务句柄
* 以后我们要想操作这个任务都需要通过这个任务句柄，如果是自身的任务操作自己，那么
* 这个句柄可以为NULL。
*/
/* 创建任务句柄 */
static TaskHandle_t AppTaskCreate_Handle = NULL;
/* LED1 任务句柄 */
static TaskHandle_t LED1_Task_Handle = NULL;
/* LED2 任务句柄 */
static TaskHandle_t LED2_Task_Handle = NULL;
/*
*************************************************************************
* 函数声明
*************************************************************************
*/
static void AppTaskCreate(void);/* 用于创建任务 */
static void LED1_Task(void* pvParameters);/* LED1_Task 任务实现 */
static void LED2_Task(void* pvParameters);/* LED2_Task 任务实现 */
/*****************************************************************
* @brief 主函数
* @param 无
* @retval 无
* @note 第一步：开发板硬件初始化
第二步：创建 APP 应用任务
第三步：启动 FreeRTOS，开始多任务调度
****************************************************************/
int main(void)
{
BaseType_t xReturn = pdPASS;/* 定义一个创建信息返回值，默认为 pdPASS */
/* 开发板硬件初始化 */
BSP_Init();
/* 创建 AppTaskCreate 任务 */
xReturn = xTaskCreate((TaskFunction_t )AppTaskCreate, /* 任务入口函数 */
(const char* )"AppTaskCreate",/* 任务名字 */
(uint16_t )512, /* 任务栈大小 */
(void* )NULL,/* 任务入口函数参数 */
(UBaseType_t )1, /* 任务的优先级 */
(TaskHandle_t* )&AppTaskCreate_Handle);/* 任务控制块指针 */
/* 启动任务调度 */
if (pdPASS == xReturn)
{
vTaskStartScheduler(); /* 启动任务，开启调度 */
}
else
{
return -1;
}
while (1); /* 正常不会执行到这里 */
}
/***********************************************************************
* @ 函数名 ： AppTaskCreate
* @ 功能说明： 为了方便管理，所有的任务创建函数都放在这个函数里面
* @ 参数 ： 无
* @ 返回值 ： 无
**********************************************************************/
static void AppTaskCreate(void)
{
BaseType_t xReturn = pdPASS;/* 定义一个创建信息返回值，默认为 pdPASS */
taskENTER_CRITICAL(); //进入临界区
/* 创建 LED_Task 任务 */
xReturn = xTaskCreate((TaskFunction_t )LED1_Task, /* 任务入口函数 */
(const char* )"LED1_Task",/* 任务名字 */
(uint16_t )512, /* 任务栈大小 */
(void* )NULL, /* 任务入口函数参数 */
(UBaseType_t )2, /* 任务的优先级 */
(TaskHandle_t* )&LED1_Task_Handle);/* 任务控制块指针 */
if (pdPASS == xReturn)
{
printf("创建 LED1_Task 任务成功!\r\n");
}
/* 创建 LED_Task 任务 */
xReturn = xTaskCreate((TaskFunction_t )LED2_Task, /* 任务入口函数 */
(const char* )"LED2_Task",/* 任务名字 */
(uint16_t )512, /* 任务栈大小 */
(void* )NULL, /* 任务入口函数参数 */
(UBaseType_t )3, /* 任务的优先级 */
(TaskHandle_t* )&LED2_Task_Handle);/* 任务控制块指针 */
if (pdPASS == xReturn)
{
printf("创建 LED2_Task 任务成功!\r\n");
}
vTaskDelete(AppTaskCreate_Handle); //删除 AppTaskCreate 任务
taskEXIT_CRITICAL(); //退出临界区
}
/**********************************************************************
* @ 函数名 ： LED1_Task
* @ 功能说明： LED1_Task 任务主体
* @ 参数 ：
* @ 返回值 ： 无
********************************************************************/
static void LED1_Task(void* parameter)
{
while (1)
{
LED1_ON;
vTaskDelay(500); /* 延时 500 个 tick */
printf("led1_task running,LED1_ON\r\n");
LED1_OFF;
vTaskDelay(500); /* 延时 500 个 tick */
printf("led1_task running,LED1_OFF\r\n");
}
}
/**********************************************************************
* @ 函数名 ： LED2_Task
* @ 功能说明： LED2_Task 任务主体
* @ 参数 ：
* @ 返回值 ： 无
********************************************************************/
static void LED2_Task(void* parameter)
{
while (1)
{
LED2_ON;
vTaskDelay(1000); /* 延时 1000 个 tick */
printf("led1_task running,LED2_ON\r\n");
LED2_OFF;
vTaskDelay(1000); /* 延时 1000 个 tick */
printf("led1_task running,LED2_OFF\r\n");
}
}
/***********************************************************************
* @ 函数名 ： BSP_Init
* @ 功能说明： 板级外设初始化，所有板子上的初始化均可放在这个函数里面
* @ 参数 ：
* @ 返回值 ： 无
*********************************************************************/
static void BSP_Init(void)
{
/*
* STM32 中断优先级分组为 4，即 4bit 都用来表示抢占优先级，范围为：0~15
* 优先级分组只需要分组一次即可，以后如果有其他的任务需要用到中断，
* 都统一用这个优先级分组，千万不要再分组，切忌。
*/
NVIC_PriorityGroupConfig( NVIC_PriorityGroup_4 );
/* LED 初始化 */
LED_GPIO_Config();
/* 串口初始化*/
USART_Config();
}
三、任务延时
3.1 相关API说明
3.1.1 vTaskDelay
相对延时函数。用于阻塞延时，调用该函数后，任务将进入阻塞状态，进入阻塞态的任务将让出 CPU 资源
| 函数 | void vTaskDelay( const TickType_t xTicksToDelay ) |
|---|---|
| 参数 | xTicksToDelay：单位为系统节拍周期， 比如系统的时钟节拍周期为 1ms，那么调用 vTaskDelay(1) 的延时时间则为 1ms |
| 返回值 | 无 |
要想使用该函数必须在 FreeRTOSConfig.h 中把 INCLUDE_vTaskDelay 定义为 1 来使能。
3.1.2 vTaskDelayUntil
绝对延时函数。常用于较精确的周期运行任务，比如我有一个任务，希望它以固定频率定期执行，而不受外部的影响，任务从上一次运行开始到下一次运行开始的时间间隔是绝对的，而不是相对的
| 函数 | void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement ) |
|---|---|
| 参数 | pxPreviousWakeTime：任务上一次离开阻塞态(被唤醒)的时刻。这个时刻被用作一个参考点来计算该任务下一次离开阻塞态的时刻 xTimeIncrement：用于实现某个任务以固定频率周期性执行 —— 这个频率就是由 xTimeIncrement 指定的。单位是心跳周期，可以使用常量 portTICK_RATE_MS 将毫秒转换为心跳周期 |
| 返回值 | 无 |
要想使用该函数必须在 FreeRTOSConfig.h 中把 INCLUDE_vTaskDelayUntil 定义为 1 来使能。
3.2 示例
3.2.1 相对延时
void vTaskA( void * pvParameters )
{
while (1)
{
// ...
// 这里为任务主体代码
// ...
/* 调用相对延时函数,阻塞 1000 个 tick */
vTaskDelay( 1000 );
}
}
3.2.2 绝对延时
注意：在使用的时候要将延时时间转化为系统节拍，在任务主体之前要调用延时函数。
void vTaskA( void * pvParameters )
{
/* 用于保存上次时间。调用后系统自动更新 */
static portTickType PreviousWakeTime;
/* 设置延时时间，将时间转为节拍数 */
const portTickType TimeIncrement = pdMS_TO_TICKS(1000);
/* 获取当前系统时间 */
PreviousWakeTime = xTaskGetTickCount();
while (1)
{
/* 调用绝对延时函数,任务时间间隔为 1000 个 tick */
vTaskDelayUntil( &PreviousWakeTime，TimeIncrement );
// ...
// 这里为任务主体代码
// ...
}
}
四、任务挂起与恢复
4.1 相关API说明
4.1.1 vTaskSuspend
挂起指定任务。被挂起的任务绝不会得到 CPU 的使用权，不管该任务具有什么优先级。
| 函数 | void vTaskSuspend( TaskHandle_t xTaskToSuspend ) |
|---|---|
| 参数 | xTaskToSuspend：挂起指定任务的任务句柄，任务必须为已创建的任务，可以通过传递 NULL 来挂起任务自己 |
| 返回值 | 无 |
要想使用该函数必须在 FreeRTOSConfig.h 中把 INCLUDE_vTaskSuspend 定义为 1 来使能。
4.1.2 vTaskSuspendAll
将所有的任务都挂起。
| 函数 | void vTaskSuspendAll( void ) |
|---|---|
| 参数 | 无 |
| 返回值 | 无 |
4.1.3 vTaskResume
让挂起的任务重新进入就绪状态，恢复的任务会保留挂起前的状态信息，在恢复的时候根据挂起时的状态继续运行。如果被恢复任务在所有就绪态任务中，处于最高优先级列表的第一位，那么系统将进行任务上下文的切换。
| 函数 | void vTaskResume( TaskHandle_t xTaskToResume ) |
|---|---|
| 参数 | xTaskToResume：恢复指定任务的任务句柄 |
| 返回值 | 无 |
4.1.4 xTaskResumeFromISR
xTaskResumeFromISR() 与 vTaskResume() 一样都是用于恢复被挂起的任务，不一样的是 xTaskResumeFromISR() 专门用在中断服务程序中 。
| 函数 | void vTaskResume( TaskHandle_t xTaskToResume ) |
|---|---|
| 参数 | xTaskToResume：恢复指定任务的任务句柄 |
| 返回值 | 无 |
要想使用该函数必须在 FreeRTOSConfig.h 中把 INCLUDE_vTaskSuspend 和 INCLUDE_vTaskResumeFromISR 定义为 1 来使能。
4.1.5 xTaskResumeAll
将所有的任务都恢复。
| 函数 | void xTaskResumeAll( void ) |
|---|---|
| 参数 | 无 |
| 返回值 | 无 |
4.2 示例
4.2.1 挂起
/**************************** 任务句柄 ********************************/
/*
* 任务句柄是一个指针，用于指向一个任务，当任务创建好之后，它就具有了一个任务句柄
* 以后我们要想操作这个任务都需要通过这个任务句柄，如果是自身的任务操作自己，那么
* 这个句柄可以为 NULL。
*/
static TaskHandle_t LED_Task_Handle = NULL;/* LED 任务句柄 */
static void KEY_Task(void* parameter)
{
while (1)
{
if ( Key_Scan(KEY1_GPIO_PORT,KEY1_GPIO_PIN) == KEY_ON )
{
/* K1 被按下 */
printf("挂起 LED 任务！\n");
vTaskSuspend(LED_Task_Handle);/* 挂起 LED 任务 */
}
vTaskDelay(20);/* 延时 20 个 tick */
}
}
4.2.2 恢复
/**************************** 任务句柄 ********************************/
/*
* 任务句柄是一个指针，用于指向一个任务，当任务创建好之后，它就具有了一个任务句柄
* 以后我们要想操作这个任务都需要通过这个任务句柄，如果是自身的任务操作自己，那么
* 这个句柄可以为 NULL。
*/
static TaskHandle_t LED_Task_Handle = NULL;/* LED 任务句柄 */
static void KEY_Task(void* parameter)
{
while (1)
{
if ( Key_Scan(KEY2_GPIO_PORT,KEY2_GPIO_PIN) == KEY_ON )
{
/* K2 被按下 */
printf("恢复 LED 任务！\n");
vTaskResume(LED_Task_Handle);/* 恢复 LED 任务！ */
}
vTaskDelay(20);/* 延时 20 个 tick */
}
}
4.2.3 中断服务中恢复
使用 xTaskResumeFromISR()的时候有几个需要注意的地方：
- 当函数的返回值为 pdTRUE 时：恢复运行的任务的优先级等于或高于正在运行的任务，表明在中断服务函数退出后必 须进行一次上下文切换 ， 使用 portYIELD_FROM_ISR() 进行上下文切换。当函数的返回值为 pdFALSE 时：恢复运行的任务的优先级低于当前正在运行的任务，表明在中断服务函数退出后不需 要进行上下文切换。
- xTaskResumeFromISR() 通常被认为是一个危险的函数，因为它的调用并非是固定的，中断可能随时来来临。所以 xTaskResumeFromISR()不能用于任务和中断间的同步，如果中断恰巧在任务被挂起之前到达，这就会导致一次中断丢失（任务还没有挂起，调用 xTaskResumeFromISR()函数是没有意义的，只能等下一次中断）。这种情况下，可以使用信号量或者任务通知来同步就可以避免这种情况。
void vAnExampleISR( void )
{
BaseType_t xYieldRequired;
/* 恢复被挂起的任务 */
xYieldRequired = xTaskResumeFromISR( xHandle );
if ( xYieldRequired == pdTRUE )
{
/* 执行上下文切换， ISR 返回的时候将运行另外一个任务 */
portYIELD_FROM_ISR();
}
}
4.2.4 全部恢复
xTaskResumeAll 函数的使用方法很简单，但是要注意，调用了多少次 vTaskSuspendAll() 函数就必须同样调用多少次 xTaskResumeAll() 函数。
void vDemoFunction( void )
{
vTaskSuspendAll();
/* 处理 xxx 代码 */
vTaskSuspendAll();
/* 处理 xxx 代码 */
vTaskSuspendAll();
/* 处理 xxx 代码 */
xTaskResumeAll();
xTaskResumeAll();
xTaskResumeAll();
}
五、获取任务状态
5.1 相关API说明
5.1.1 eTaskGetState
获取任务当前状态。
| 函数 | eTaskState eTaskGetState( TaskHandle_t xTask ) |
|---|---|
| 参数 | xTask：任务句柄 |
| 返回值 | 以下值 |
/* Task states returned by eTaskGetState. */
typedef enum
{
eRunning = 0, /* A task is querying the state of itself, so must be running. */
eReady, /* The task being queried is in a read or pending ready list. */
eBlocked, /* The task being queried is in the Blocked state. */
eSuspended, /* The task being queried is in the Suspended state, or is in the Blocked state with an infinite time out. */
eDeleted, /* The task being queried has been deleted, but its TCB has not yet been freed. */
eInvalid /* Used as an 'invalid state' value. */
} eTaskState;
• 由 Leung 写于 2020 年 10 月 30 日
• 参考：野火FreeRTOS视频与PDF教程