Freertos学习：06-任务通知

---
title: rtos-freertos-06-task-notify
date: 2020-06-22 15:49:29
categories:
tags:
- ipc
- freertos
- rtos
---

章节概述：

如何使用任务通知实现轻量级同步。

概述

每个RTOS任务都有一个32位的通知值，任务创建时，这个值被初始化为0。RTOS任务通知相当于直接向任务发送一个事件，接收到通知的任务可以解除因等待通知而引起的阻塞状态。

相比于使用信号量解除任务阻塞，使用任务通知可以快45%、使用更少的RAM。

发送通知的同时，也可以可选的改变接收任务的通知值。

可以通过下列方法向接收任务更新通知：

不覆盖接收任务的通知值
覆盖接收任务的通知值
设置接收任务通知值的某些位
增加接收任务的通知值

虽然RTOS任务通知速度更快并且占用内存更少，但它也有一些限制：

只能有一个任务接收通知事件。
接收通知的任务可以因为等待通知而进入阻塞状态，但是发送通知的任务即便不能立即完成通知发送也不能进入阻塞状态。

相对于用前必须分别创建队列、二进制信号量、计数信号量或事件组的情况，使用任务通知显然更灵活。更好的是，

RTOS任务通知功能默认是使能的，可以通过在文件FreeRTOSConfig.h中设置宏configUSE_TASK_NOTIFICATIONS为0来禁止这个功能，禁止后每个任务节省8字节内存。

发送通知

BaseType_t xTaskNotify( TaskHandle_t xTaskToNotify,
                       uint32_t ulValue,
                       eNotifyAction eAction);
BaseType_t xTaskNotifyGive( xTaskToNotify );
// 中断保护等价函数
BaseType_t xTaskNotifyFromISR( TaskHandle_t xTaskToNotify,
                              uint32_t ulValue,
                              eNotifyAction eAction,
                              pxHigherPriorityTaskWoken );
void vTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify,
                            BaseType_t *pxHigherPriorityTaskWoken );

描述：使用API发送通知，在接收RTOS任务调用API函数xTaskNotifyWait()或ulTaskNotifyTake()之前，这个通知都被保持着。

xTaskNotify

BaseType_t xTaskNotify( TaskHandle_t xTaskToNotify,
                       uint32_t ulValue,
                       eNotifyAction eAction);

描述：向指定任务发送指定的通知值。如果打算使用RTOS任务通知实现轻量级的二进制或计数信号量，推荐使用API函数xTaskNotifyGive()来代替本函数。

参数解析：

xTaskToNotify：被通知的任务句柄。
ulValue：通知更新值
eAction：枚举类型，指明更新通知值的方法

枚举值	描述
eNoAction	发送通知，但不更新值（参数ulValue未使用）
eSetBits	被通知任务的通知值按位或ulValue。（某些场景下可代替事件组，效率更高）
eIncrement	被通知任务的通知值增加1（参数ulValue未使用），相当于`xTaskNotifyGive`
eSetValueWithOverWrite	被通知任务的通知值设置为 ulValue。（某些场景下可代替`xQueueOverwrite`，效率更高）
eSetValueWithoutOverwrite	如果被通知的任务当前没有通知，则被通知的任务的通知值设为ulValue。如果被通知任务没有取走上一个通知，又接收到了一个通知，则这次通知值丢弃，在这种情况下视为调用失败并返回`pdFALSE` （某些场景下可代替`xQueueSend`，效率更高）

返回值：参数eAction为eSetValueWithoutOverwrite时，如果被通知任务还没取走上一个通知，又接收到了一个通知，则这次通知值未能更新并返回pdFALSE，否则返回pdPASS。

注意：此函数不可以在中断服务例程中调用，中断保护等价函数为xTaskNotifyFromISR()。

xTaskNotifyGive

BaseType_t xTaskNotifyGive(TaskHandle_t xTaskToNotify );

描述：本质上相当于xTaskNotify( ( xTaskToNotify ), ( 0 ), eIncrement )。

其实这是一个宏，使用该API函数代替二进制或计数信号量，但速度更快。

参数解析：

xTaskToNotify：被通知的任务句柄。

注意：

应该使用API函数ulTaskNotifyTake()来等待通知，而不应该使用API函数xTaskNotifyWait()。

此函数不可以在中断服务例程中调用，中断保护等价函数为vTaskNotifyGiveFromISR()。

例子：

staticvoid prvTask1( void *pvParameters );
staticvoid prvTask2( void *pvParameters );
/* 保存任务句柄 */
staticTaskHandle_t xTask1 = NULL, xTask2 = NULL;
/* 创建两个任务，它们之间反复发送通知，启动RTOS调度器*/
voidmain( void )
{
    xTaskCreate( prvTask1, "Task1",200, NULL, tskIDLE_PRIORITY, &xTask1 );
    xTaskCreate( prvTask2, "Task2",200, NULL, tskIDLE_PRIORITY, &xTask2 );
    vTaskStartScheduler();
}
/*-----------------------------------------------------------*/
staticvoid prvTask1( void *pvParameters )
{
    for( ;; )
    {
        /*向prvTask2(),发送通知，使其解除阻塞状态 */
        xTaskNotifyGive( xTask2 );
        /* 等待prvTask2()的通知，进入阻塞 */
        ulTaskNotifyTake( pdTRUE, portMAX_DELAY);
    }
}
/*-----------------------------------------------------------*/
staticvoid prvTask2( void *pvParameters )
{
    for( ;; )
    {
        /* 等待prvTask1()的通知，进入阻塞 */
        ulTaskNotifyTake( pdTRUE, portMAX_DELAY);
        /*向prvTask1(),发送通知，使其解除阻塞状态 */
        xTaskNotifyGive( xTask1 );
    }
}

获取通知

uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit,
                          TickType_t xTicksToWait );

描述：专门为使用更轻量级更快的方法来代替二进制或计数信号量而量身打造的。

如果RTOS任务的通知值为0，使用xTaskNotifyTake()可以指定任务进入阻塞状态的时间（可为0），直到该任务的通知值不为0。

参数解析：

xClearCountOnExit：如果该参数设置为pdFALSE，则API函数xTaskNotifyTake()退出前，将任务的通知值减1；如果该参数设置为pdTRUE，则API函数xTaskNotifyTake()退出前，将任务通知值清零。

两种方法处理任务的通知值：

一种方法是在函数退出时将通知值清零，这种方法适用于实现二进制信号量；

另外一种方法是在函数退出时将通知值减1，这种方法适用于实现计数信号量。

xTicksToWait：因等待通知而进入阻塞状态的最大时间。时间单位为系统节拍周期。可用pdMS_TO_TICKS将指定的毫秒时间转化为相应的系统节拍数。

返回值：返回任务的当前通知值，为0或者为调用API函数xTaskNotifyTake()之前的通知值减1。

可以用来代替FreeRTOS获取信号量的API函数xSemaphoreTake()。

当一个任务使用通知值来实现二进制或计数信号量时，其它任务或者中断要使用API函数xTaskNotifyGive()或者使用参数eAction为eIncrement的API函数xTaskNotify()。推荐使用xTaskNotifyGive()函数（其实是个宏，我们这里把它看作一个API函数）。另外需要注意的是，如果在中断中使用，要使用它们的中断保护等价函数：vTaskNotifyGiveFromISR()和xTaskNotifyFromISR()。

例子：

/* 中断处理程序。*/
voidvANInterruptHandler( void )
{
    BaseType_txHigherPriorityTaskWoken;
    prvClearInterruptSource();
    /* xHigherPriorityTaskWoken必须被初始化为pdFALSE。如果调用vTaskNotifyGiveFromISR()会解除vHandlingTask任务的阻塞状态，并且vHandlingTask任务的优先级高于当前处于运行状态的任务，则xHigherPriorityTaskWoken将会自动被设置为pdTRUE。*/
    xHigherPriorityTaskWoken = pdFALSE;
    /*向一个任务发送通知，xHandlingTask是该任务的句柄。*/
    vTaskNotifyGiveFromISR( xHandlingTask,&xHigherPriorityTaskWoken );
    /* 如果xHigherPriorityTaskWoken为pdTRUE，则强制上下文切换。这个宏的实现取决于移植层，可能会调用portEND_SWITCHING_ISR */
    portYIELD_FROM_ISR(xHigherPriorityTaskWoken );
}
/*---------------------------------------------------------------------------------------------------*/
/* 一个因为等待通知而阻塞的任务。*/
voidvHandlingTask( void *pvParameters )
{
    BaseType_txEvent;
    for( ;; )
    {
        /*等待通知，无限期阻塞。参数pdTRUE表示函数退出前会清零通知值。这显然是用于替代二进制信号量的用法。需要注意的是，真实的程序一般不会无限期阻塞。*/
        ulTaskNotifyTake( pdTRUE, portMAX_DELAY);
        /* 当处理完所有事件后，仍然等待下一个通知*/
        do
        {
            xEvent = xQueryPeripheral();
            if( xEvent != NO_MORE_EVENTS )
            {
                vProcessPeripheralEvent( xEvent);
            }
        } while( xEvent != NO_MORE_EVENTS );
    }
}

等待通知

如果打算使用RTOS任务通知实现轻量级的二进制或计数信号量，推荐使用API函数ulTaskNotifyTake()来代替本函数。

BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry,
                           uint32_t ulBitsToClearOnExit,
                           uint32_t*pulNotificationValue,
                           TickType_t xTicksToWait );

描述：进入阻塞状态，等待通知；当接收到通知后，任务解除阻塞并清除通知。

参数解析：

ulBitsToClearOnEntry：在使用通知之前，先将任务的通知值与参数ulBitsToClearOnEntry的按位取反值按位与操作。设置参数ulBitsToClearOnEntry为0xFFFFFFFF(ULONG_MAX)，表示清零任务通知值。
ulBitsToClearOnExit：在函数xTaskNotifyWait()退出前，将任务的通知值与参数ulBitsToClearOnExit的按位取反值按位与操作。设置参数ulBitsToClearOnExit为0xFFFFFFFF(ULONG_MAX)，表示清零任务通知值。
pulNotificationValue：用于向外回传任务的通知值。这个通知值在参数ulBitsToClearOnExit起作用前将通知值拷贝到*pulNotificationValue中。如果不需要返回任务的通知值，这里设置成NULL。
xTicksToWait：因等待通知而进入阻塞状态的最大时间。时间单位为系统节拍周期。可用pdMS_TO_TICKS将指定的毫秒时间转化为相应的系统节拍数。

返回值：如果接收到通知，返回pdTRUE，如果API函数xTaskNotifyWait()等待超时，返回pdFALSE。

例子：

/*这个任务使用任务通知值的位来传递不同的事件，这在某些情况下可以代替事件组。*/
voidvAnEventProcessingTask( void *pvParameters )
{
    uint32_tulNotifiedValue;
    for( ;; )
    {
        /*等待通知，无限期阻塞（没有超时，所以不用检查函数返回值）。其它任务或者中断设置的通知值中的不同位表示不同的事件。参数0x00表示使用通知前不清除任务的通知值位，参数ULONG_MAX 表示函数xTaskNotifyWait()退出前将任务通知值设置为0*/
        xTaskNotifyWait( 0x00, ULONG_MAX,&ulNotifiedValue, portMAX_DELAY );
        /*根据通知值处理事件*/
        if( ( ulNotifiedValue & 0x01 ) != 0)
        {
            prvProcessBit0Event();
        }
        if( ( ulNotifiedValue & 0x02 ) != 0)
        {
            prvProcessBit1Event();
        }
        if( ( ulNotifiedValue & 0x04 ) != 0)
        {
            prvProcessBit2Event();
        }
        /* ……*/
    }
}

任务通知并查询

BaseType_t xTaskNotifyAndQuery(TaskHandle_t xTaskToNotify,
                               uint32_tulValue,
                               eNotifyActioneAction,
                               uint32_t*pulPreviousNotifyValue );

描述：此函数与任务通知API函数xTaskNotify()非常像，只不过此函数具有一个附加参数，用来回传任务当前的通知值，然后根据参数ulValue和eAction更新任务的通知值。

参数解析：

xTaskToNotify：被通知的任务句柄。
ulValue：通知更新值
eAction：枚举类型，指明更新通知值的方法，枚举变量成员以及作用见xTaskNotify()一节。
pulPreviousNotifyValue：回传未被更新的任务通知值。如果不需要回传未被更新的任务通知值，这里设置为NULL，这样就等价于调用xTaskNotify()函数。

注意：此函数不能在中断服务例程中使用，在中断服务例程中使用xTaskNotifyAndQueryFromISR()函数。