FreeRTOS 快速入门（八）之任务通知

---

一、任务通知

1、基本概念

FreeRTOS 从 V8.2.0 版本开始提供任务通知这个功能，每个任务都有 一个 32 位 的通知值，在大多数情况下，任务通知可以 替代二值信号量、计数信号量、事件组，也可以替代长度为 1 的队列（可以保存一个 32 位整数或指针值）。

相对于以前使用 FreeRTOS 内核通信的资源，必须创建队列、二进制信号量、计数信号量或事件组的情况，使用任务通知显然更灵活。按照 FreeRTOS 官方的说法，使用任务通知比通过信号量等 ICP 通信方式解除阻塞的任务要快 45%，并且更加省 RAM 内存空间（使用 GCC 编译器，-o2 优化级别），任务通知的使用无需创建队列。

想要使用任务通知，必须将 FreeRTOSConfig.h 中的宏定义 configUSE_TASK_NOTIFICATIONS 设置为 1，其实FreeRTOS 默认是为 1 的，所以任务通知是默认使能的。

FreeRTOS 提供以下几种方式发送通知给任务 ：

• 发送通知给任务， 如果有通知未读，不覆盖通知值。
• 发送通知给任务，直接覆盖通知值。
• 发送通知给任务，设置通知值的一个或者多个位 ，可以当做事件组来使用。
• 发送通知给任务，递增通知值，可以当做计数信号量使用。

通过对以上任务通知方式的合理使用，可以在一定场合下替代 FreeRTOS 的信号量，队列、事件组等。

2、优势及限制

任务通知的优势：

• 效率更高：使用任务通知来发送事件、数据给某个任务时，效率更高。比队列、信号量、事件组都有大的优势。
• 更节省内存：使用其他方法时都要先创建对应的结构体，使用任务通知时无需额外创建结构体。

任务通知的限制：

• 不能发送数据给 ISR：ISR 并没有任务结构体，所以无法使用任务通知的功能给 ISR 发送数据。但是 ISR 可以使用任务通知的功能，发数据给任务。
• 数据只能给该任务独享
• 无法缓冲数据
• 无法广播给多个任务
• 如果发送受阻，发送方无法进入阻塞状态等待

3、通知状态和通知值

每个任务都有一个结构体：TCB（Task Control Block），里面有 2 个成员：

• 一个是 uint8_t 类型，用来表示通知状态
• 一个是 uint32_t 类型，用来表示通知值

typedef struct tskTaskControlBlock
{
	......
	/* configTASK_NOTIFICATION_ARRAY_ENTRIES = 1 */
	volatile uint32_t ulNotifiedValue[ configTASK_NOTIFICATION_ARRAY_ENTRIES ];
	volatile uint8_t ucNotifyState[ configTASK_NOTIFICATION_ARRAY_ENTRIES ];
	......
} tskTCB;

通知状态有 3 种取值：

• taskNOT_WAITING_NOTIFICATION：任务没有在等待通知
• taskWAITING_NOTIFICATION：任务在等待通知
• taskNOTIFICATION_RECEIVED：任务接收到了通知，也被称为 pending(有数据了，待处理)

#define taskNOT_WAITING_NOTIFICATION ( ( uint8_t ) 0 ) /* 也是初始状态 */
#define taskWAITING_NOTIFICATION ( ( uint8_t ) 1 )
#define taskNOTIFICATION_RECEIVED ( ( uint8_t ) 2 )

通知值可以有很多种类型：

• 计数值
• 位(类似事件组)
• 任意数值

二、任务通知的使用

使用任务通知，可以实现轻量级的队列（长度为 1）、邮箱(覆盖的队列)、计数型信号量、二进制信号量、事件组。

任务通知有两套函数，简化版、专业版，列表如下：

• 简化版函数的使用比较简单，它实际上也是使用专业版函数实现的
• 专业版函数支持很多参数，可以实现很多功能

	简化版	专业版
发出通知	xTaskNotifyGive vTaskNotifyGiveFromISR	xTaskNotify xTaskNotifyFromISR
取出通知	ulTaskNotifyTake	xTaskNotifyWait

1、xTaskNotifyGive/ulTaskNotifyTake

在任务中使用 xTaskNotifyGive 函数，在 ISR 中使用 vTaskNotifyGiveFromISR 函数，都是直接给其他任务
发送通知：

• 使得通知值加一
• 并使得通知状态变为"pending"，也就是 taskNOTIFICATION_RECEIVED，表示有数据了、待处理

可以使用 ulTaskNotifyTake 函数来取出通知值：

• 如果通知值等于 0，则阻塞(可以指定超时时间)
• 当通知值大于 0 时，任务从阻塞态进入就绪态
• 在 ulTaskNotifyTake 返回之前，还可以做些清理工作：把通知值减一，或者把通知值清零

使用 ulTaskNotifyTake 函数可以实现轻量级的、高效的二进制信号量、计数型信号量。

原型如下：

/*
 * xTaskToNotify : 任务句柄(创建任务时得到)，给哪个任务发通知
 * 返回值 : 必定返回pdPASS
 */
BaseType_t xTaskNotifyGive( TaskHandle_t xTaskToNotify );

/*
 * xTaskHandle : 任务句柄(创建任务时得到)，给哪个任务发通知
 * pxHigherPriorityTaskWoken : 被通知的任务，可能正处于阻塞状态。此函数发出通知后，
      会把它从阻塞状态切换为就绪态。如果被唤醒的任务的优先级，高于当前任务的优先级，则 
      *pxHigherPriorityTaskWoken 被设置为pdTRUE，这表示在中断返回之前要进行任务切换。
 */
void vTaskNotifyGiveFromISR( TaskHandle_t xTaskHandle, BaseType_t
						*pxHigherPriorityTaskWoken );

/*
 * xClearCountOnExit : 函数返回前是否清零：
 *                    pdTRUE：把通知值清零
 *                    pdFALSE：如果通知值大于0，则把通知值减一
 * xTicksToWait : 任务进入阻塞态的超时时间，它在等待通知值大于0。
 *                 0：不等待，即刻返回；
 *                 portMAX_DELAY：一直等待，直到通知值大于0；
 *                 其他值：Tick Count，可以用pdMS_TO_TICKS() 把ms转换为Tick Count
 */
uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t 
						  xTicksToWait
						);

2、xTaskNotify/xTaskNotifyWait

xTaskNotify 函数功能更强大，可以使用不同参数实现各类功能，比如：

• 让接收任务的通知值加一：这时 xTaskNotify() 等同于 xTaskNotifyGive()
• 设置接收任务的通知值的某一位、某些位，这就是一个轻量级的、更高效的事件组
• 把一个新值写入接收任务的通知值：上一次的通知值被读走后，写入才成功。这就是轻量级的、长度为1的队列
• 用一个新值覆盖接收任务的通知值：无论上一次的通知值是否被读走，覆盖都成功。类似 xQueueOverwrite() 函数，这就是轻量级的邮箱。

xTaskNotify() 比 xTaskNotifyGive() 更灵活、强大，使用上也就更复杂。xTaskNotifyFromISR() 是它对应的 ISR 版本。

使用 xTaskNotifyWait() 函数来取出任务通知。它比 ulTaskNotifyTake() 更复杂：

• 可以让任务等待(可以加上超时时间)，等到任务状态为"pending"(也就是有数据)
• 还可以在函数进入、退出时，清除通知值的指定位

原型如下：

/*
 * xTaskToNotify：接收通知的任务句
 * ulValue：用于更新接收任务通知的任务通知值，具体如何更新由形参 eAction 决定
 * eAction：任务通知值更新方式，具体见下面表格
 * 返回值：参数 eAction 为 eSetValueWithoutOverwrite 时，如果被通知任务还没取走上一个通知，
 		又接收到了一个通知，则这次通知值未能更新并返回 pdFALSE，而其他情况均返回 pdPASS
 */
BaseType_t xTaskNotify( TaskHandle_t xTaskToNotify, 
						uint32_t ulValue,
						eNotifyAction eAction );

/*
 * xTaskToNotify：接收通知的任务句
 * ulValue：用于更新接收任务通知的任务通知值，具体如何更新由形参 eAction
 * eAction：任务通知值更新方式，具体见下面表格
 * pxHigherPriorityTaskWoken：在使用之前必须先初始化为 pdFALSE。当调用该函数发送一个任务通知时，
   		目标任务接收到通知后将从阻塞态变为就绪态，并且如果其优先级比当前运行的任务的优先级高，
   		那么 *pxHigherPriorityTaskWoken 会被设置为 pdTRUE，然后在中断退出前执行一次上下文切换，
   		去执行刚刚被唤醒的中断优先级较高的任务。pxHigherPriorityTaskWoken 是一个可选的参数可以设置为 NULL
 * 返回值：参数 eAction 为 eSetValueWithoutOverwrite 时，如果被通知任务还没取走上一个通知，
 		又接收到了一个通知，则这次通知值未能更新并返回 pdFALSE，而其他情况均返回 pdPASS
 */
BaseType_t xTaskNotifyFromISR( TaskHandle_t xTaskToNotify,
						        uint32_t ulValue,
								eNotifyAction eAction,
								BaseType_t *pxHigherPriorityTaskWoken );

/*
 * ulBitsToClearOnEntry：ulBitsToClearOnEntry 表示在使用通知之前，将任务通知值的哪些位清 0，
 		实现过程就是将任务的通知值与参数 ulBitsToClearOnEntry 的按位取反值按位与操作。
 		如果 ulBitsToClearOnEntry 设置为 0x01，那么在函数进入前，任务通知值的位1会被清0，其他位保持不变。
 		如果 ulBitsToClearOnEntry 设置为 0xFFFFFFFF (ULONG_MAX)，那么在进入函数前任务通知值的所有位都
 		会被清 0，表示清零任务通知值
 * pulNotificationValue：用于保存接收到的任务通知值。如果接收到的任务通知不需要使用，则设置为 NULL 即可。
 		这个通知值在参数 ulBitsToClearOnExit 起作用前将通知值拷贝到 *pulNotificationValue 中
 * xTicksToWait：等待超时时间，单位为系统节拍周期。宏 pdMS_TO_TICKS 用于将单位毫秒转化为系统节拍数
 * 返回值：如果获取任务通知成功则返回 pdTRUE，失败则返回 pdFALSE
 */
BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry,
							uint32_t ulBitsToClearOnExit,
							uint32_t *pulNotificationValue,
							TickType_t xTicksToWait );

其中，eAcrtion 的取值如下：

eAction 取值	含义
eNoAction	对象任务接收任务通知，但是任务自身的任务通知值不更新，即形参 ulValue 没有用。
eSetBits	对象任务接收任务通知，同时任务自身的任务通知值与 ulValue 按位或。 如果 ulValue 设置为 0x01，那么任务的通知值的位 0 将被置为 1。 同样的如果 ulValue 设置为 0x04，那么任务的通知值的位 2 将被置为 1。 在这种方式下，任务通知可以看成是事件标志的一种轻量型的实现，速度更快。
eIncrement	对象任务接收任务通知，任务自身的任务通知值加 1，即形参ulValue 没有用。 这个时候调用 xTaskNotify() 等同于调用 xTaskNotifyGive()。
eSetValueWithOverwrite	对象任务接收任务通知，且任务自身的任务通知值会无条件的被设置为 ulValue。 在这种方式下，任务通知可以看成是函数 xQueueOverwrite() 的一种轻量型的实现，速度更快。
eSetValueWithoutOverwrite	对象任务接收任务通知，且对象任务没有通知值，那么通知值就会被设置为 ulValue。 对象任务接收任务通知，但是上一次接收到的通知值并没有取走，那么本次的通知值将不会更新，同时函数返回 pdFALSE。 在这种方式下，任务通知可以看成是函数 xQueueSend() 应用在队列深度为 1 的队列上的一种轻量型实现，速度更快。

3、xTaskNotifyAndQuery

xTaskNotifyAndQuery() 与 xTaskNotify() 很像，都是调用通用的任务通知发送函数 xTaskGenericNotify() 来实现通知的发送，不同的是多了一个附加的参数 pulPreviousNotifyValue 用于回传接收任务的上一个通知值。

xTaskNotifyAndQuery() 函数不能用在中断中，而是必须使用带中断保护功能的 xTaskNotifyAndQuery()FromISR 来代替。

/*
 * xTaskToNotify：接收通知的任务句
 * ulValue：用于更新接收任务通知的任务通知值，具体如何更新由形参 eAction 决定
 * eAction：任务通知值更新方式，具体见上面表格
 * pulPreviousNotifyValue：对象任务的上一个任务通知值，如果为 NULL，则不需要回传，
 		这个时候就等价于函数 xTaskNotify()
 * 返回值：参数 eAction 为 eSetValueWithoutOverwrite 时，如果被通知任务还没取走上一个通知，
 		又接收到了一个通知，则这次通知值未能更新并返回 pdFALSE，而其他情况均返回 pdPASS
 */
BaseType_t xTaskNotifyAndQuery( TaskHandle_t xTaskToNotify, 
								uint32_t ulValue, 
								eNotifyAction eAction, 
								uint32_t *pulPreviousNotifyValue )

/*
 * xTaskToNotify：接收通知的任务句
 * ulValue：用于更新接收任务通知的任务通知值，具体如何更新由形参 eAction 决定
 * eAction：任务通知值更新方式，具体见上面表格
 * pulPreviousNotifyValue：对象任务的上一个任务通知值，如果为 NULL，则不需要回传，
 		这个时候就等价于函数 xTaskNotify()
 * pxHigherPriorityTaskWoken：在使用之前必须先初始化为 pdFALSE。当调用该函数发送一个任务通知时，
 		目标任务接收到通知后将从阻塞态变为就绪态，并且如果其优先级比当前运行的任务的优先级高，那么 
 		*pxHigherPriorityTaskWoken 会被设置为 pdTRUE，然后在中断退出前执行一次上下文切换，
 		去执行刚刚被唤醒的中断优先级较高的任务。
 		pxHigherPriorityTaskWoken 是一个可选的参数可以设置为 NULL
 * 返回值：参数 eAction 为 eSetValueWithoutOverwrite 时，如果被通知任务还没取走上一个通知，
 		又接收到了一个通知，则这次通知值未能更新并返回 pdFALSE，而其他情况均返回 pdPASS
 */
BaseType_t xTaskNotifyAndQueryFromISR(  TaskHandle_t xTaskToNotify, 
										uint32_t ulValue, 
										eNotifyAction eAction, 
										uint32_t *pulPreviousNotifyValue, 
										BaseType_t *pxHigherPriorityTaskWoken )