Update readme

Author: tangzz98

FreeRTOS/portable/rt-thread/portmacro.h

@@ -91,6 +91,8 @@
 
 /*-----------------------------------------------------------*/
 
+    #define FREERTOS_PRIORITY_TO_RTTHREAD(priority)    ( configMAX_PRIORITIES - 1 - ( priority ) )
+    #define RTTHREAD_PRIORITY_TO_FREERTOS(priority)    ( RT_THREAD_PRIORITY_MAX - 1 - ( priority ) )
 /* Use this macro to calculate the buffer size when allocating a queue statically
  * To ensure the buffer can fit the desired number of messages
  */

FreeRTOS/tasks.c

@@ -34,9 +34,6 @@
 #include "FreeRTOS.h"
 #include "task.h"
 
-#define FREERTOS_PRIORITY_TO_RTTHREAD(priority)    ( configMAX_PRIORITIES - 1 - ( priority ) )
-#define RTTHREAD_PRIORITY_TO_FREERTOS(priority)    ( RT_THREAD_PRIORITY_MAX - 1 - ( priority ) )
-
 /* Values that can be assigned to the ucNotifyState member of the TCB. */
 #define taskNOT_WAITING_NOTIFICATION              ( ( uint8_t ) 0 ) /* Must be zero as it is the initialised value. */
 #define taskWAITING_NOTIFICATION                  ( ( uint8_t ) 1 )

readme.md

@@ -8,9 +8,9 @@
 # 2 FreeRTOS功能支持情况
 兼容层对FreeRTOS的支持情况记录在[issue](https://github.com/RT-Thread-packages/FreeRTOS-Wrapper/discussions/31)中记录。一些支持的函数在功能和使用方法上和FreeRTOS略有不同，在迁移过程中需要注意。
 ### vTaskSuspend
-`vTaskSuspend`只支持挂起当前运行的线程，在使用时`xTaskToSuspend`参数必须为`NULL`。
+`vTaskSuspend`只支持挂起当前运行的线程，在使用时`xTaskToSuspend`参数必须为`NULL`。否则会触发断言。
 ### xQueueSendToFront
-`xQueueSendToFront`不支持设置超时，使用时`xTicksToWait`参数会被忽略，消息队列没有空间时会立即返回。
+`xQueueSendToFront`不支持设置超时，使用时`xTicksToWait`参数会被忽略，消息队列没有空间时会立即返回`errQUEUE_FULL`。
 ### xQueueCreateStatic
 静态消息队列需要参考以下的例子创建，确保为消息队列分配的内存足够大：
 ```
@@ -41,7 +41,30 @@ if( xHigherPriorityTaskWoken )
 ```
 RT-Thread不为函数提供FromISR版本，函数可以在中断调用并在内部完成调度。因此在兼容层中使用FromISR函数后不需要手动调度，`xHigherPriorityTaskWoken`总会被设置成`pdFALSE`。
 ### 内存堆
-兼容层保留了FreeRTOS的五种内存分配算法，默认使用`heap_3`，`pvPortMalloc/vPortFree`内部调用`RT_KERNEL_MALLOC/RT_KERNEL_FREE`在RT-Thread内部的内存堆分配。若使用其他算法，需要在`FreeRTOSConfig.h`中通过`configTOTAL_HEAP_SIZE`设置内存堆大小。应用调用`pvPortMalloc/vPortFree`会在一块独立于RT-Thread，大小为`configTOTAL_HEAP_SIZE`的内存堆中分配，RT-Thread内部的内存堆仍然存在，兼容层函数内部分配内存都在RT-Thread的内存堆完成。
+兼容层保留了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等
+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的内存堆完成。
+### 线程优先级
+RT-Threa线程优先级数值越小时优先级越高，而FreeRTOS线程优先级数值越大优先级越高。在使用兼容层的FreeRTOS API，如`xTaskCreate`，使用FreeRTOS的规则为线程指定优先级即可。若在应用中将RT-Thread和FreeRTOS API混合使用，在指定线程优先级时要特别注意。可以使用以下两个宏对RT-Thread和FreeRTOS线程优先级做转换：
+```
+#define FREERTOS_PRIORITY_TO_RTTHREAD(priority)    ( configMAX_PRIORITIES - 1 - ( priority ) )
+#define RTTHREAD_PRIORITY_TO_FREERTOS(priority)    ( RT_THREAD_PRIORITY_MAX - 1 - ( priority ) )
+```
+### 线程堆栈大小
+FreeRTOS线程堆栈大小的单位为`sizeof(StackType_t)`，RT-Thread线程堆栈大小为`sizeof(rt_uint8_t)`。使用FreeRTOS API创建线程时一定要遵守FreeRTOS的规则，切勿混淆。
+### vTaskStartScheduler
+由于RT-Thread和FreeRTOS的内核启动流程不同，使用兼容层时，`main`函数是在一个线程中运行，该线程优先级为`CONFIG_RT_MAIN_THREAD_PRIORITY`。（此选项通过SCons配置，数值越小优先级越高。），此时调度器已经开启。一般的FreeRTOS应用采用以下的方式创建线程：
+```
+xTaskCreate(pxTask1Code, ......);
+xTaskCreate(pxTask2Code, ......);
+......
+vTaskStartScheduler();
+```
+使用兼容层时，任何使用`xTaskCreate`创建的线程若优先级比`CONFIG_RT_MAIN_THREAD_PRIORITY`更高，会立即开始执行。`vTaskStartScheduler`只是为了提供对应用的兼容，没有任何实际效果。在使用兼容层时，创建线程要特别注意，确保在调用`xTaskCreate`时，该线程所需的所有资源已经完成初始化，可以正常运行。
 
 # 3 使用方法
 通过Env工具将兼容层加入到工程中：
@@ -55,15 +78,15 @@ RT-Thread online packages
 ```
 RT_USING_TIMER_SOFT /* 使用FreeRTOS定时器时必须开启*/
 RT_TIMER_THREAD_PRIO  /* 定时器线程优先级。与FreeRTOS相反，该选项数值越小优先级越高 */
-RT_TIMER_THREAD_STACK_SIZE  /* 定时器线程栈大小 */
+RT_TIMER_THREAD_STACK_SIZE  /* 定时器线程栈大小，单位为sizeof(rt_uint8_t) */
 RT_USING_MUTEX  /* 使用FreeRTOS互斥量时必须开启*/
 RT_USING_SEMAPHORE  /* 使用FreeRTOS信号量时必须开启*/
 RT_USING_HEAP /* 使用FreeRTOS动态内存分配时必须开启*/
 RT_TICK_PER_SECOND  /* 相当于FreeRTOS configTICK_RATE_HZ */
 RT_THREAD_PRIORITY_MAX /* 相当于FreeRTOS configMAX_PRIORITIES */
 RT_NAME_MAX /* 相当于FreeRTOS configMAX_TASK_NAME_LEN */
 ```
-在`FreeRTOS/include`提供了`FreeRTOSConfig.h`模版。大部分内容不可以修改或依赖`rtconfig.h`的配置，可以手动修改的内容如下：
+在`FreeRTOS/portable/rt-thread`提供了`FreeRTOSConfig.h`模版。大部分内容不可以修改或依赖RT-Thread内核的配置，可以手动修改的内容如下：
 ```
 /* 可以选择不使用recursive mutex */
 #ifdef RT_USING_MUTEX
@@ -107,3 +130,22 @@ RT_NAME_MAX /* 相当于FreeRTOS configMAX_TASK_NAME_LEN */
 #define configUSE_TASK_NOTIFICATIONS            1
 #define configTASK_NOTIFICATION_ARRAY_ENTRIES   3
 ```
+在`test`目录下提供了一些例程，可以将它们加入BSP目录下的`applications`文件夹中。使用SCons编译并烧录后，可以连接串口，输入相应的msh命令，观察例程的执行结果：
+```
+msh />queue_dynamic
+Task 1 receive data 0 from queue
+Task 1 receive data 1 from queue
+Task 1 receive data 2 from queue
+Task 1 receive data 3 from queue
+Task 1 receive data 4 from queue
+Task 1 receive data 5 from queue
+Task 1 receive data 6 from queue
+Task 1 receive data 7 from queue
+Task 1 receive data 8 from queue
+Task 1 receive data 9 from queue
+Task 1 receive data 10 from queue
+```
+
+# 4 参考资料
+RT-Thread文档 [https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/README](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/README)
+FreeRTOS文档 [https://www.freertos.org/a00106.html](https://www.freertos.org/a00106.html)