Github地址

https://github.com/RT-Thread-packages/FreeRTOS-Wrapper

期待您的Star

本項目是2022年開源之夏，RT-Thread社區項目。已經于2022年9月由唐照洲（美國佐治亞理工學院，大四）順利結項完成。FreeRTOS兼容層目前已經落地到RT-Thread對ESP32-IDF（唐照洲）和core-v-mcu（王順）兩款SDK的兼容項目中。

1 概述

這是一個針對RT-Thread國產操作系統的FreeRTOS操作系統兼容層，可以讓原有基于FreeRTOS操作系統的項目快速、無感地遷移到RT-Thread操作系統上，實現在RT-Thread操作系統上無感的使用FreeRTOS的API，同時可以使用RT-Thread的豐富組件。項目基于FreeRTOS V10.4.6版本。

1.1 RT-Thread的其他RTOS兼容層

• RT-Thread操作系統的μCOS-III兼容層：https://github.com/mysterywolf/RT-Thread-wrapper-of-uCOS-III

• RT-Thread操作系統的μCOS-II兼容層：https://github.com/mysterywolf/RT-Thread-wrapper-of-uCOS-II

• RT-Thread操作系統的RTX(即CMSIS-RTOS1)兼容層：https://github.com/RT-Thread-packages/CMSIS_RTOS1

• RT-Thread操作系統的RTX5(即CMSIS-RTOS2)兼容層：https://github.com/RT-Thread-packages/CMSIS_RTOS2

• RT-Thread操作系統的Arduino生態兼容層：https://github.com/RTduino/RTduino

2 FreeRTOS的API支持情況及使用注意事項

API支持情況詳見，readme 鏈接如下：

https://github.com/RT-Thread-packages/FreeRTOS-Wrapper

（請復制至外部瀏覽器打開）

兼容層對FreeRTOS的支持情況記錄在issue中記錄。一些支持的函數在功能和使用方法上和FreeRTOS略有不同，在遷移過程中需要注意。

2.1線程、消息隊列與互斥量

2.1.1 vTaskSuspend

vTaskSuspend只支持掛起當前運行的線程，在使用時xTaskToSuspend參數必須為NULL。否則會觸發斷言。

2.1.2 xQueueSendToFront

xQueueSendToFront不支持設置超時，使用時xTicksToWait參數會被忽略，消息隊列沒有空間時會立即返回errQUEUE_FULL。

2.1.3 xQueueCreateStatic

靜態消息隊列需要參考以下的例子創建，確保為消息隊列分配的內存足夠大：

 1#defineQUEUE_LENGTH10
 2#defineITEM_SIZEsizeof(uint32_t)
 3
 4/*以下是在原版FreeRTOS分配內存的方法，由于RT-Thread消息隊列內部的實現與FreeRTOS不同，這樣分配的內存不夠存放ITEM_SIZE個消息*/
 5//uint8_tucQueueStorage[QUEUE_LENGTH*ITEM_SIZE];
 6/*要使用QUEUE_BUFFER_SIZE宏分配內存*/
 7uint8_tucQueueStorage[QUEUE_BUFFER_SIZE(QUEUE_LENGTH,ITEM_SIZE)];
 8StaticQueue_txQueueBuffer;
 9QueueHandle_txQueue1;
10xQueue1=xQueueCreate(QUEUE_LENGTH,ITEM_SIZE,&(ucQueueStorage[0]),&xQueueBuffer);

2.1.4 Mutex和Recursive Mutex

FreeRTOS提供了兩種互斥量，Mutex和Recursive Mutex。Recursive Mutex可以由同一個線程重復獲取，Mutex不可以。RT-Thread提供的互斥量是可以重復獲取的，因此兼容層也不對Mutex和Recursive Mutex做區分。

用xSemaphoreCreateMutex和xSemaphoreCreateRecursiveMutex創建的互斥量都是可以重復獲取的。

2.2 定時器

和FreeRTOS不同，RT-Thread不使用一個消息隊列向定時器線程傳遞命令。使用兼容層時任何需要設置超時的定時器函數，如xTimerStart( xTimer, xTicksToWait )，xTicksToWait參數會被忽略，函數會立即完成命令并返回。

2.3 FromISR函數

FreeRTOS為一些函數提供了在中斷中使用的FromISR版本，如果這些函數喚醒了更高優先級的線程，需要手動調度，如下所示：

1BaseType_txHigherPrioritTaskWoken=pdFALSE;
2xQueueSendToFrontFromISR(xRxQueue,&cIn,&xHigherPriorityTaskWoken);
3if(xHigherPriorityTaskWoken)
4{
5taskYIELD();
6}

RT-Thread不為函數提供FromISR版本，函數可以在中斷調用并在內部完成調度。因此在兼容層中使用FromISR函數后不需要手動調度，xHigherPriorityTaskWoken總會被設置成pdFALSE。

2.4 內存堆

兼容層保留了FreeRTOS的五種內存分配算法，默認使用heap_3，pvPortMalloc/vPortFree內部調用RT_KERNEL_MALLOC/RT_KERNEL_FREE在RT-Thread內部的內存堆分配。這種情況下內存堆的大小由RT-Thread BSP配置決定，無法在FreeRTOSConfig.h中通過configTOTAL_HEAP_SIZE設置。若使用其他算法，需要修改FreeRTOS/sSConscript，選擇相應的源文件

1#可將heap_3.c替換成heap_1.c等
2src+=Glob(os.path.join("portable","MemMang","heap_3.c"))

在FreeRTOS/portable/rt-thread/FreeRTOSConfig.h中通過configTOTAL_HEAP_SIZE設置內存堆大小。應用調用pvPortMalloc/vPortFree會在一塊獨立于RT-Thread，大小為configTOTAL_HEAP_SIZE的內存堆中分配，RT-Thread內部的內存堆仍然存在，兼容層函數內部分配內存都在RT-Thread的內存堆完成。

2.5 線程優先級

RT-Threa線程優先級數值越小時優先級越高，而FreeRTOS線程優先級數值越大優先級越高。在使用兼容層的FreeRTOS API，如xTaskCreate，使用FreeRTOS的規則為線程指定優先級即可。若在應用中將RT-Thread和FreeRTOS API混合使用，在指定線程優先級時要特別注意。可以使用以下兩個宏對RT-Thread和FreeRTOS線程優先級做轉換：

1#defineFREERTOS_PRIORITY_TO_RTTHREAD(priority)(configMAX_PRIORITIES-1-(priority))
2#defineRTTHREAD_PRIORITY_TO_FREERTOS(priority)(RT_THREAD_PRIORITY_MAX-1-(priority))

2.6 線程堆棧大小

FreeRTOS線程堆棧大小的單位為sizeof(StackType_t)，RT-Thread線程堆棧大小為sizeof(rt_uint8_t)。使用FreeRTOS API創建線程時一定要遵守FreeRTOS的規則，切勿混淆。

2.7 vTaskStartScheduler

由于RT-Thread和FreeRTOS的內核啟動流程不同，使用兼容層時，main函數是在一個線程中運行，該線程優先級為CONFIG_RT_MAIN_THREAD_PRIORITY。（此選項通過SCons配置，數值越小優先級越高。），此時調度器已經開啟。一般的FreeRTOS應用采用以下的方式創建線程：

1xTaskCreate(pxTask1Code,......);
2xTaskCreate(pxTask2Code,......);
3......
4vTaskStartScheduler();

使用兼容層時，任何使用xTaskCreate創建的線程若優先級比CONFIG_RT_MAIN_THREAD_PRIORITY更高，會立即開始執行。vTaskStartScheduler只是為了提供對應用的兼容，沒有任何實際效果。在使用兼容層時，創建線程要特別注意，確保在調用xTaskCreate時，該線程所需的所有資源已經完成初始化，可以正常運行。

3 使用方法

通過Env工具將兼容層加入到工程中：

1RT-Threadonlinepackages
2systempackages--->
3[*]FreeRTOSWrapper--->
4Version(latest)

使用scons --menuconfig配置RT-Thread內核，以下選項會影響到FreeRTOS兼容層：

1RT_USING_TIMER_SOFT/*使用FreeRTOS定時器時必須開啟*/
2RT_TIMER_THREAD_PRIO/*定時器線程優先級。與FreeRTOS相反，該選項數值越小優先級越高*/
3RT_TIMER_THREAD_STACK_SIZE/*定時器線程棧大小，單位為sizeof(rt_uint8_t)*/
4RT_USING_MUTEX/*使用FreeRTOS互斥量時必須開啟*/
5RT_USING_SEMAPHORE/*使用FreeRTOS信號量時必須開啟*/
6RT_USING_HEAP/*使用FreeRTOS動態內存分配時必須開啟*/
7RT_TICK_PER_SECOND/*相當于FreeRTOSconfigTICK_RATE_HZ*/
8RT_THREAD_PRIORITY_MAX/*相當于FreeRTOSconfigMAX_PRIORITIES*/
9RT_NAME_MAX/*相當于FreeRTOSconfigMAX_TASK_NAME_LEN*/

在FreeRTOS/portable/rt-thread提供了FreeRTOSConfig.h模版。大部分內容不可以修改或依賴RT-Thread內核的配置，可以手動修改的內容如下：

 1/*可以選擇不使用recursivemutex*/
 2#ifdefRT_USING_MUTEX
 3#defineconfigUSE_RECURSIVE_MUTEXES1
 4#defineconfigUSE_MUTEXES1
 5#endif
 6
 7/*可以選擇不使用countingsemaphore*/
 8#ifdefRT_USING_SEMAPHORE
 9#defineconfigUSE_COUNTING_SEMAPHORES1
10#endif
11
12/*若不使用heap_3，可以通過configTOTAL_HEAP_SIZE配置內存堆大小*/
13#defineconfigSUPPORT_STATIC_ALLOCATION1
14#ifdefRT_USING_HEAP
15#defineconfigSUPPORT_DYNAMIC_ALLOCATION1
16#defineconfigTOTAL_HEAP_SIZE10240
17#defineconfigAPPLICATION_ALLOCATED_HEAP0
18#endif
19
20#defineconfigMINIMAL_STACK_SIZE128
21
22/*可以選擇的函數和功能*/
23#defineINCLUDE_vTaskPrioritySet1
24#defineINCLUDE_uxTaskPriorityGet1
25#defineINCLUDE_vTaskDelete1
26#defineINCLUDE_vTaskSuspend1
27#defineINCLUDE_xTaskDelayUntil1
28#defineINCLUDE_vTaskDelay1
29#defineINCLUDE_xTaskGetIdleTaskHandle1
30#defineINCLUDE_xTaskAbortDelay1
31#defineINCLUDE_xSemaphoreGetMutexHolder1
32#defineINCLUDE_xTaskGetHandle1
33#defineINCLUDE_uxTaskGetStackHighWaterMark1
34#defineINCLUDE_uxTaskGetStackHighWaterMark21
35#defineINCLUDE_eTaskGetState1
36#defineINCLUDE_xTaskResumeFromISR1
37#defineINCLUDE_xTaskGetSchedulerState1
38#defineINCLUDE_xTaskGetCurrentTaskHandle1
39#defineconfigUSE_APPLICATION_TASK_TAG1
40#defineconfigUSE_TASK_NOTIFICATIONS1
41#defineconfigTASK_NOTIFICATION_ARRAY_ENTRIES3

在test目錄下提供了一些例程，可以將它們加入BSP目錄下的applications文件夾中。使用SCons編譯并燒錄后，可以連接串口，輸入相應的msh命令，觀察例程的執行結果：

 1msh/>queue_dynamic
 2Task1receivedata0fromqueue
 3Task1receivedata1fromqueue
 4Task1receivedata2fromqueue
 5Task1receivedata3fromqueue
 6Task1receivedata4fromqueue
 7Task1receivedata5fromqueue
 8Task1receivedata6fromqueue
 9Task1receivedata7fromqueue
10Task1receivedata8fromqueue
11Task1receivedata9fromqueue
12Task1receivedata10fromqueue

4 參考資料

RT-Thread文檔

https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/README

FreeRTOS文檔

https://www.freertos.org/a00106.html

Github地址

https://github.com/RT-Thread-packages/FreeRTOS-Wrapper

期待您的Star

———————End———————

你可以添加微信：rtthread2020 為好友，注明：公司+姓名，拉進RT-Thread官方微信交流群！