RT-Thread操作系统μC/OS-III兼容层 发布啦
RT-Thread操作系统μC/OS-III兼容层
μCOS-III Wrapper
https://github.com/mysterywolf/RT-Thread-wrapper-of-uCOS-III
1 概述
这是一个针对国产RT-Thread操作系统的μCOS-III操作系统兼容层，可以让基于美国Micriμm公司的μCOS-III操作系统的项目快速迁移到RT-Thread操作系统上。
1.1 本兼容层适合于：
- 老项目需要从μCOS-III操作系统向RT-Thread操作系统迁移
- 之前学习过μCOS-III操作系统，意图转向学习RT-Thread国产操作系统。本兼容层可以帮您用已有的μCOS-III编程经验和习惯快速将项目跑起来，日后再慢慢深入熟悉RT-Thread的API函数，逐步向RT-Thread过度。降低您的学习门槛和时间成本。有了本兼容层，对RT-Thread API以及编程风格的不熟悉再也不是您学习RT-Thread的阻力！
1.2 版本详细信息
| 组件名称 | 版本号 |
|---|---|
| RT-Thread nano | 3.1.3 |
| μC/OS-III | 3.03.00 |
| μC/CPU | 1.30.00 |
| μC/LIB | 1.37.02 |
兼容uCOS-III 3.00-3.08全系列
1.3 官网
RT-Thread：https://www.rt-thread.org/
文档中心：https://www.rt-thread.org/document/site/tutorial/nano/an0038-nano-introduction/
μCOS-III：https://www.micrium.com/
文档中心：https://doc.micrium.com/display/kernel304/uC-OS-III+Documentation+Home
2 使用
2.1 Keil-MDK仿真工程
本仿真工程是基于STM32F103RB平台。
Keil工程路径：<u>RT-Thread-wrapper-of-uCOS-IIIrt_thread_3.1.3-ucosiii_3.03-wrapperrt-thread-3.1.3bspstm32f103-msh-628Project.uvprojx</u>
需要提前安装好RT-Thread Nano-3.1.3 Keil支持包：https://www.rt-thread.org/download/mdk/RealThread.RT-Thread.3.1.3.pack
注意：调试串口使用的是USART2，不是USART1
2.2 迁移步骤
- 浏览一下μC-CPU/cpu.h文件，看一下头文件中的定义是否符合你的CPU，一般不需要改这个文件
- 浏览一下μCOS-III/os.h文件，看一下错误代码，这个错误代码和原版μCOS-III是有一定区别的。
注意: 请勿随意打开注释掉的枚举体成员,如果用户使用到了这些注释掉的成员,则会在迁移时编译报错,用以提醒用户这些错误代码在兼容层已经不可用。 软件定时器：μCOS-III原版的软件定时器回调函数是两个参数，本兼容层由于RT-Thread的回调函数仅为一个参数，因此改为一个参数（详见μCOS-III/os.h）。
μCOS-III原版软件定时器回调函数定义：
typedef void (*OS_TMR_CALLBACK_PTR)(void *p_tmr, void *p_arg);本兼容层软件定时器回调函数定义：
typedef void (*OS_TMR_CALLBACK_PTR)(void *parameter);- 配置os_cfg.h和os_cfg_app.h
每个选项的配置说明和原版μCOS-III一致，若有不同，我已经在注释中有所解释。
原版μCOS-III配置说明可参见：
a)《嵌入式实时操作系统μC/OS-III》北京航空航天大学出版社 宫辉等译 邵贝贝审校
b) Micriμm公司文档中心: https://doc.micrium.com/display/kernel304/uC-OS-III+Features+os_cfg.h
2.3 os_cfg.h配置文件
#define OS_CFG_DBG_EN 1 /* Enable (1) debug code/variables */ 该宏定义定义是否启用兼容层调试，建议在第一次迁移时打开，因为在兼容层内部，一部分uCOS-III原版功能没有实现，如果用户用到了这部分没有实现的功能，将会通过调试的方式输出，予以提示。用户务必对业务逻辑予以修改。
#define OS_CFG_TMR_TASK_RATE_HZ 100u /* Rate for timers (100 Hz Typ.) */ 在原版μCOS-III中，该宏定义定义了软件定时器的时基信号，这与RT-Thread的软件定时器有本质的不同，在RT-Thread中，软件定时器的时基信号就等于OS ticks。因此为了能够将μCOS-III软件定时器时间参数转为RT-Thread软件定时器的时间参数，需要用到该宏定义。请使该宏定义与原工程使用μCOS-III时的该宏定义参数一致。
2.4 os_cfg_app.h配置文件
RT-Thread无需实现μCOS-III的中断任务，因此相关配置予以取消。
2.5 运行
int main(void) /*RT-Thread main线程*/
{
OS_ERR err;
OSInit(&err); /*uCOS-III操作系统初始化*/
OSStart(&err); /*开始运行uCOS-III操作系统*/
#if OS_CFG_APP_HOOKS_EN > 0u
App_OS_SetAllHooks(); /*设置钩子函数*/
#endif
#if OS_CFG_STAT_TASK_EN > 0u
OSStatTaskCPUUsageInit(&err); /*统计任务*/
OSStatReset(&err); /*复位统计数据*/
#endif
}
2.6 注意
- 由于μCOS-III支持8、16、32位CPU，而RT-Thread支持32、64位CPU，因此本兼容层仅能对基于32位CPU的已有工程进行兼容。
μCOS-III的任务堆栈大小单位是sizeof(CPU_STK)，而RT-Thread的线程堆栈大小单位是Byte，虽然在兼容层已经做了转换，但是在填写时一定要注意，所有涉及到μCOS-III的API、宏定义全部是按照μCOS-III的标准，即堆栈大小为sizeof(CPU_STK)，切勿混搭！这种错误极其隐晦，一定要注意！下面是混搭的错误示例：
ALIGN(RT_ALIGN_SIZE) static rt_uint8_t thread2_stack[1024];//错误：混搭RT-Thread的数据类型定义线程堆栈 OSTaskCreate(&thread2, (CPU_CHAR*)"thread2", thread2_entry, RT_NULL, THREAD_PRIORITY, thread2_stack, sizeof(thread2_stack)/10,//任务堆栈深度限位(错误：这个参数的单位是sizeof(CPU_STK)) sizeof(thread2_stack),//任务堆栈大小(错误：这个参数的单位是sizeof(CPU_STK)) 0, THREAD_TIMESLICE, 0, OS_OPT_TASK_STK_CHK|OS_OPT_TASK_STK_CLR, &err);下面是正确写法：
#define THREAD_STACK_SIZE 256 //正确，要通过宏定义单独定义堆栈大小，单位为sizeof(CPU_STK) ALIGN(RT_ALIGN_SIZE) static CPU_STK thread2_stack[THREAD_STACK_SIZE];//正确，使用uCOS-III自己的数据类型定义任务堆栈 OSTaskCreate(&thread2, (CPU_CHAR*)"thread2", thread2_entry, RT_NULL, THREAD_PRIORITY, thread2_stack, THREAD_STACK_SIZE/10,//任务堆栈深度限位(正确) THREAD_STACK_SIZE,//任务堆栈大小(正确) 0, THREAD_TIMESLICE, 0, OS_OPT_TASK_STK_CHK|OS_OPT_TASK_STK_CLR, &err);- 切勿将RT-Thread和μCOS-III的API混搭使用。
例如RTT中的rt_thread_suspend / rt_thread_resume仅支持一次挂起/解挂；而μCOS-III的OSTaskSuspend / OSTaskResume是支持嵌套挂起/解挂的，为此需要继承struct rt_thread结构体并在其基础上增加成员.SuspendCtr变量实现该功能。若采用rt_thread_init初始化线程，该函数并不会管理μCOS-III兼容层的成员变量，.SuspendCtr也不会创建和初始化，若此时调用OSTaskSuspend / OSTaskResume函数试图指向.SuspendCtr成员变量，将会访问非法内存地址(因为rt_thread_init初始化的线程.SuspendCtr成员变量根本不存在)！
- 兼容层取消了原版μCOS-III中的时间戳功能
在μCOS-III中，时间戳主要用于测量中断关闭时间，以及任务单次执行时间以及最大时间等涉及到精度较高的时长测量。该特性在μCOS-II以及RT-Thread中均没有，因此不予实现。
- μCOS-III原版定时器回调函数是在定时器线程中调用的，而非在中断中调用，因此要使用μCOS-III兼容层的软件定时器，需要将rtconfig.h中的宏定义RT_USING_TIMER_SOFT置1。
3 接口
3.1 没有实现兼容的API（仅2个）
虽然RT-Thread没有任务内建消息队列、任务内建信号量、任务内建寄存器机制，但是本兼容层均已实现，可以正常兼容。但是由于RT-Thread没有提供相关接口，以下μCOS-III API无法兼容：
void OSTaskChangePrio (OS_TCB *p_tcb, OS_PRIO prio_new, OS_ERR *p_err);
void OSTaskTimeQuantaSet (OS_TCB *p_tcb, OS_TICK time_quanta, OS_ERR *p_err);3.2 钩子函数
μCOS-III的钩子函数仅对μCOS-III兼容层负责。 即如果你注册了OSTaskDelHook函数，他仅会在调用OSTaskDel函数时被调用，不会在调用rt_thread_detach函数时被调用(这个由RTT的钩子函数负责)。这样做是为了层次分明，防止μCOS-III兼容层插手RT-Thread内部事务。
μCOS-III的钩子函数在两个文件中实现：os_cpu_c.c和os_app_hooks.c 。按照μCOS-III的思想，os_cpu_c.c提供原始的钩子函数（即这些钩子函数被相应的函数直接调用），该文件以及其内部的钩子函数是移植工程师编写的内容，应用工程师不应该操作这个文件的内容，os_cpu_c.c文件的钩子函数提供相应的函数指针供os_app_hooks.c文件内的钩子函数注册和使用，这个文件内的钩子函数应用工程师是可以操作的。换句话说，我们有什么需要在钩子函数中调用的函数，应该放在os_app_hooks.c文件中。
以下原版μCOS-III钩子函数将予以取消，由RT-Thread接管相关钩子函数接管：
void OSTaskReturnHook (OS_TCB *p_tcb);
void OSTaskSwHook (void);
void OSTimeTickHook (void); 同时，上述钩子函数对应的应用级钩子函数也被取消：
void App_OS_TaskReturnHook (OS_TCB *p_tcb);
void App_OS_InitHook (void);/*按照手册要求OS初始化的钩子函数不应该出现在应用层,在3.03版本中出现应该是失误,在3.08版本中已经将该应用级钩子函数取消*/
void App_OS_TaskSwHook (void);
void App_OS_TimeTickHook (void);3.3 统计任务（OS_StatTask()、os_stat.c）
在μCOS-III中，统计任务是一个系统任务，可以在系统运行时做一些统计工作，例如统计总的CPU使用率（0.00% - 100.00%）、各任务的CPU使用率（0.00% - 100.00%）以及各任务的堆栈使用量。从内核版本V3.03.00起，CPU的利用率用一个0-10000之间的整数表示（对应0.00% - 100.00%）。
但是RT-Thread并没有统计任务，因此需要创建一个任务来兼容原版μCOS-III的统计任务，完成上述功能。该统计任务会在兼容层初始化时自动创建，用户无需干预。用户仅需调用OSStatTaskCPUUsage全局变量即可获取当前的CPU使用率，CPU使用率的计算策略和原版μCOS-III完全一致
目前统计任务实现的功能：
- 计算全局CPU使用率
- 计算每个任务的任务堆栈使用情况（当 OS_CFG_DBG_EN 和 OS_CFG_STAT_TASK_STK_CHK_EN 为1）
3.4 全局变量
目前，本兼容层可以使用以下μCOS-III原版全局变量（位于os.h）。这些全局变量的具体含义请参见2.2节中所列举出的参考资料。（论坛放不下了，请大家到github上去看详细介绍吧！）
这个插件牛叉啊，之前学过μC/OSII，也做个几个小项目，但是始终是因为收费，所以放弃。
有这个插件了，估计用μC/OS很多项目会转移锅过来，RTT的这招够狠！
@Mars.CN 大佬给github一个star并给这个文章一个赞吧~~