补充readme

Author: Yaochenger

readme.md

@@ -3,17 +3,22 @@
 ## 让基于FreeRTOS开发的应用层无感地迁移到RT-Thread操作系统
 
 # 1 概述
-这是一个针对RT-Thread国产操作系统的FreeRTOS操作系统兼容层，可以让基于FreeRTOS操作系统的项目快速、无感地迁移到RT-Thread操作系统上。项目基于FreeRTOS V10.4.6版本。
+这是一个针对RT-Thread国产操作系统的FreeRTOS操作系统兼容层，可以让原有基于FreeRTOS操作系统的项目快速、无感地迁移到RT-Thread操作系统上，实现在RT-Thread操作系统上无感的使用FreeRTOS的API，同时可以使用RT-Thread的丰富组件。项目基于FreeRTOS V10.4.6版本。
 
-# 2 FreeRTOS功能支持情况
+# 2 FreeRTOS的API支持情况
 兼容层对FreeRTOS的支持情况记录在[issue](https://github.com/RT-Thread-packages/FreeRTOS-Wrapper/discussions/31)中记录。一些支持的函数在功能和使用方法上和FreeRTOS略有不同，在迁移过程中需要注意。
-### vTaskSuspend
+
+### 2.1线程、消息队列与互斥量
+
+### (1)vTaskSuspend
 `vTaskSuspend`只支持挂起当前运行的线程，在使用时`xTaskToSuspend`参数必须为`NULL`。否则会触发断言。
-### xQueueSendToFront
+
+### (2)xQueueSendToFront
 `xQueueSendToFront`不支持设置超时，使用时`xTicksToWait`参数会被忽略，消息队列没有空间时会立即返回`errQUEUE_FULL`。
-### xQueueCreateStatic
+
+### (3)xQueueCreateStatic
 静态消息队列需要参考以下的例子创建，确保为消息队列分配的内存足够大：
-```
+```c
 #define QUEUE_LENGTH 10
 #define ITEM_SIZE sizeof( uint32_t )
 
@@ -25,13 +30,13 @@ StaticQueue_t xQueueBuffer;
 QueueHandle_t xQueue1;
 xQueue1 = xQueueCreate( QUEUE_LENGTH, ITEM_SIZE, &( ucQueueStorage[ 0 ] ), &xQueueBuffer );
 ```
-### Mutex和Recursive Mutex
+### (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`参数会被忽略，函数会立即完成命令并返回。
-### FromISR函数
+### 2.3FromISR函数
 FreeRTOS为一些函数提供了在中断中使用的FromISR版本，如果这些函数唤醒了更高优先级的线程，需要手动调度，如下所示：
-```
+```c
 BaseType_t xHigherPrioritTaskWoken = pdFALSE;
 xQueueSendToFrontFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );
 if( xHigherPriorityTaskWoken )
@@ -40,25 +45,26 @@ if( xHigherPriorityTaskWoken )
 }
 ```
 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`，选择相应的源文件
-```
-# 可将heap_3.c替换成heap_1.c等
+
+```c
+#可将heap_3.c替换成heap_1.c等
 src += 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线程优先级做转换：
-```
+```c
 #define FREERTOS_PRIORITY_TO_RTTHREAD(priority)    ( configMAX_PRIORITIES - 1 - ( priority ) )
 #define RTTHREAD_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的规则，切勿混淆。
-### vTaskStartScheduler
+### 2.7vTaskStartScheduler
 由于RT-Thread和FreeRTOS的内核启动流程不同，使用兼容层时，`main`函数是在一个线程中运行，该线程优先级为`CONFIG_RT_MAIN_THREAD_PRIORITY`。（此选项通过SCons配置，数值越小优先级越高。），此时调度器已经开启。一般的FreeRTOS应用采用以下的方式创建线程：
-```
+```c
 xTaskCreate(pxTask1Code, ......);
 xTaskCreate(pxTask2Code, ......);
 ......
@@ -68,14 +74,14 @@ vTaskStartScheduler();
 
 # 3 使用方法
 通过Env工具将兼容层加入到工程中：
-```
+```shell
 RT-Thread online packages
     system packages --->
         [*] FreeRTOS Wrapper --->
             Version (latest)
 ```
 使用`scons --menuconfig`配置RT-Thread内核，以下选项会影响到FreeRTOS兼容层：
-```
+```c
 RT_USING_TIMER_SOFT /* 使用FreeRTOS定时器时必须开启*/
 RT_TIMER_THREAD_PRIO  /* 定时器线程优先级。与FreeRTOS相反，该选项数值越小优先级越高 */
 RT_TIMER_THREAD_STACK_SIZE  /* 定时器线程栈大小，单位为sizeof(rt_uint8_t) */
@@ -87,7 +93,7 @@ RT_THREAD_PRIORITY_MAX /* 相当于FreeRTOS configMAX_PRIORITIES */
 RT_NAME_MAX /* 相当于FreeRTOS configMAX_TASK_NAME_LEN */
 ```
 在`FreeRTOS/portable/rt-thread`提供了`FreeRTOSConfig.h`模版。大部分内容不可以修改或依赖RT-Thread内核的配置，可以手动修改的内容如下：
-```
+```c
 /* 可以选择不使用recursive mutex */
 #ifdef RT_USING_MUTEX
     #define configUSE_RECURSIVE_MUTEXES         1
@@ -131,7 +137,7 @@ RT_NAME_MAX /* 相当于FreeRTOS configMAX_TASK_NAME_LEN */
 #define configTASK_NOTIFICATION_ARRAY_ENTRIES   3
 ```
 在`test`目录下提供了一些例程，可以将它们加入BSP目录下的`applications`文件夹中。使用SCons编译并烧录后，可以连接串口，输入相应的msh命令，观察例程的执行结果：
-```
+```shell
 msh />queue_dynamic
 Task 1 receive data 0 from queue
 Task 1 receive data 1 from queue