RT-Thread-wrapper-of-uCOS-III

RT-Thread操作系统的μC/OS-III兼容层

μC/OS-III RTOS Application Compatibility Layer (ACL) for RT-Thread

让基于μC/OS-III开发的应用层无感地迁移到RT-Thread操作系统

如果喜欢请Star，这是对本开源项目最大的鼓励，谢谢；如果想要贡献PR，请fork

---

[TOC]

0 前排提示

本文含有图片，受限于中国大陆互联网环境，访问github时，readme.md(本文件)的图片一般加载不出来，因此我导出了.pdf文件。如果您需要详细阅读，可以将项目下载或clone下来，阅读docs/中文说明文档.pdf文件。

1 概述

这是一个针对RT-Thread国产操作系统的μCOS-III操作系统兼容层，可以让基于美国Micriμm公司的μCOS-III操作系统的项目快速、无感地迁移到RT-Thread操作系统上。在兼容层的设计、编写上尊重原版μC/OS-III，保证原版μC/OS-III的原汁原味。本项目100%由C语言完成。

支持版本：μC/OS-III 3.00-3.08全部版本

视频介绍&教程：https://www.bilibili.com/video/BV1b54y1U7AG

1.1 RT-Thread的其他RTOS兼容层

• RT-Thread操作系统的μCOS-II兼容层：https://github.com/mysterywolf/RT-Thread-wrapper-of-uCOS-II
• RT-Thread操作系统的FreeRTOS兼容层：https://github.com/RT-Thread-packages/FreeRTOS-Wrapper
• 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

1.2 本兼容层适合于

• 之前学习过μCOS-III操作系统，意图转向学习RT-Thread国产操作系统。本兼容层可以帮您用已有的μCOS-III编程经验和习惯快速将项目跑起来，日后在应用过程中深入熟悉RT-Thread的API函数，逐步向RT-Thread过度，降低您的学习门槛和时间成本。有了本兼容层，对RT-Thread API以及编程风格的不熟悉再也不是您学习RT-Thread的阻力！

• 现有任务（线程）模块采用μCOS-III编写，想要用在基于RT-Thread的工程上

• 老项目需要从μCOS-III操作系统向RT-Thread操作系统迁移

• 当需要快速基于RT-Thread开发产品，但是工程师之前均采用μC/OS开发，从未用过RT-Thread的开发经验。本兼容层可以帮助让工程师快速基于μC/OS-III开发经验开发产品，简化软件的重用、缩短微控制器新开发人员的学习过程，并缩短新设备的上市时间。

• 避免在从μCOS-III迁移到RT-Thread时，由于μCOS-III的编程经验导致的思维定式引发的错误，这种错误一般很难被发现

  ​ 例如：

  1. 两个操作系统对于任务/线程挂起、解挂函数的区别。
     RT-Thread不支持任务嵌套挂起、解挂
     ​μCOS-III支持任务嵌套挂起、解挂

  2. 软件定时器参数的不同

  3. 任务堆栈的数据类型不同

• 本兼容层实现了与Micriμm公司专门为其旗下产品μC/OS等开发的专用软件μC/Probe的对接，可以通过该软件以图像化形式查看、调试RT-Thread内核以及μCOS-III兼容层的相关信息

1.3 版本详细信息

组件名称	版本号	配置文件	说明
RT-Thread nano	3.1.3	rtconfig.h
μC/OS-III	3.03.00	os_cfg_app.h os_cfg.h os_app_hooks.c	兼容层兼容3.00.00-3.08.00全部μCOS-III版本
μC/CPU	1.30.00	cpu_cfg.h	部分升级到最新版本, 兼容所有Micriμm软件
μC/LIB	1.39.00	lib_cfg.h	最新版本

1.4 官网

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仿真工程

本仿真工程是基于STM32F103平台。

Keil工程路径：rt-thread-3.1.3/bsp/stm32f103/Project.uvprojx

需要提前安装好RT-Thread Nano-3.1.3 Keil支持包.

注意：调试串口使用的是USART2，不是USART1

2.2 迁移步骤

（如果使用的是RT-Thread Nano版请参见以下步骤；若使用RT-Thread完整版可以直接跳转至[Env工具自动化配置到工程中](#6 Env工具自动化配置到工程中)章节）

1. 将uCOS-III、uC-LIB、uC-CPU三个文件夹内的所有文件都加入到你的工程中，最好保持原有文件夹的结构。相较于原版μCOS-III增加了os_rtwrap.c文件，负责对RT-Thread和μCOS-III的转换提供支持。
2. 浏览一下μCOS-III/os.h文件，看一下错误代码，这个错误代码和原版μCOS-III是有一定区别的。
   注意: 请勿随意打开注释掉的错误码枚举体成员， 如果用户使用到了这些注释掉的成员,则会在迁移时编译报错,用以提醒用户这些错误代码在兼容层已经不可用。
3. 配置os_cfg.h和os_cfg_app.h
   每个选项的配置说明和原版μCOS-III一致，若有不同，我已经在注释中有所解释。
   原版μCOS-III配置说明可参见：
   a)《嵌入式实时操作系统μC/OS-III》北京航空航天大学出版社 宫辉等译 邵贝贝审校
   b) Micriμm公司μCOS-III在线文档
4. μCOS-III原版定时器回调函数是在定时器线程中调用的，而非在中断中调用，因此要使用μCOS-III兼容层的软件定时器，需要将rtconfig.h中的宏定义RT_USING_TIMER_SOFT置1。

2.3 os_cfg.h配置文件

#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时的该宏定义参数一致。需要注意的是，虽然在兼容层中定义了软件定时器的时基频率，但是在兼容层内部使用的RT-Thread软件定时器的时基频率等同于OS Ticks，因此OS_TMR结构体的.Match成员变量其保存的数值是以OS Ticks频率来计算的。

2.4 os_cfg_app.h配置文件

该文件仅保留了OS Tick频率的配置、定时器任务以及统计任务的配置。其他配置项本兼容层用不到（例如中断任务），予以删除。

2.5 运行

2.5.1 官方标准手动初始化流程

本兼容层完全兼容官方给出的标准初始化流程，如果您兼容老项目，μCOS-III初始化部分无需做任何修改。具体初始化流程代码参见工程main.c文件，参考文献参见 docs/uCOS-III官方初始化流程.pdf

2.5.2 最简手动初始化流程

最简初始化流程是指本兼容层的初始化流程，不必像官方给出的初始化流程一样复杂。如果您不是想要兼容已有老工程，而是新建一个工程的话，可以采用最简手动初始化流程：

#include <os.h> /*头文件保持和原版μCOS-III相同*/

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.5.3 自动初始化流程

如果您在应用层中不想手动初始化本兼容层，可以在rtconfig.h文件中定义PKG_USING_UCOSIII_WRAPPER_AUTOINIT宏定义。请参见 [6.2.1章节](###6.2.1 Enable uCOS-III wrapper automatically init)（如无特殊要求，建议采用该种方式）。

2.5.4 精简版兼容层

如果你在使用过程中不需要兼容任务/内核对象结构体的成员变量，或者不需要使用uC/Probe软件监控兼容层状态，可以在rtconfig.h文件中定义PKG_USING_UCOSIII_WRAPPER_TINY宏定义。请参见 [6.2.2章节](###6.2.2 Enable uCOS-III wrapper tiny mode)。

2.6 注意

1. μCOS-III的任务堆栈大小单位是sizeof(CPU_STK)，而RT-Thread的线程堆栈大小单位是sizeof(rt_uint8_t)，虽然在兼容层已经做了转换，但是在填写时一定要注意，所有涉及到μ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);
   

2. 切勿将同一个内核对象/线程的RT-Thread和μCOS-III的API混搭使用。
   例如RT-Thread中的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成员变量根本不存在)！

   但是允许非同一个内核对象/线程的RT-Thread和μCOS-III的API混搭使用。例如可以使用OSTaskCreate函数创建任务，同时在该任务内部可以使用RT-Thread的信号量API进行操作。总之，如果你用μCOS-III的API创建内核对象或者线程，在后续对该内核对象或任务的操作必须沿用μCOS-III的API；反之，也必须沿用RT-Thread的API。

3. 兼容层取消了原版μCOS-III中的时间戳功能
   在μCOS-III中，时间戳主要用于测量中断关闭时间，以及任务单次执行时间以及最大时间等涉及到精度较高的时长测量。该特性在μCOS-II以及RT-Thread中均没有，因此本兼容层不予实现。

3 接口

3.1 没有实现兼容的API（仅2个）

RT-Thread目前没有动态更改时间片大小的功能：

void  OSTaskTimeQuantaSet (OS_TCB *p_tcb, OS_TICK time_quanta, OS_ERR *p_err);

兼容层取消原版μCOS-III中的多内核对象等待(Multi-Pend)功能，该功能在原版3.05.00版本开始向用户发出警告不要使用该功能(原文措辞为deprecated)，从3.06.00版本开始删除了该功能，因此本兼容层没有实现该函数的兼容：

OS_OBJ_QTY  OSPendMulti (OS_PEND_DATA  *p_pend_data_tbl,
                         OS_OBJ_QTY     tbl_size,
                         OS_TICK        timeout,
                         OS_OPT         opt,
                         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_TaskSwHook (void);
void  App_OS_TimeTickHook (void);

3.3 统计任务（OS_StatTask()、os_stat.c）

在μCOS-III中，统计任务是一个系统任务，通过OS_CFG_STAT_TASK_EN宏决定是否开启，可以在系统运行时做一些统计工作。例如统计总的CPU使用率（0.00% - 100.00%）、各任务的CPU使用率（0.00% - 100.00%）以及各任务的堆栈使用量。CPU的利用率用一个0-10000之间的整数表示（对应0.00% - 100.00%）。

但是RT-Thread并没有统计任务，因此需要创建一个任务来兼容原版μCOS-III的统计任务，完成上述功能。该统计任务会在兼容层初始化时自动创建，用户无需干预。用户仅需调用OSStatTaskCPUUsage全局变量即可获取当前的CPU使用率，CPU使用率的计算策略和原版μCOS-III完全一致。

目前统计任务实现的功能：

1. 计算全局CPU使用率
2. 计算每个任务的任务堆栈使用情况（当 OS_CFG_DBG_EN 和 OS_CFG_STAT_TASK_STK_CHK_EN 为1）

注意：一旦开启统计任务，则该优先级强烈建议不要被其他任务使用，统计任务的优先级总是为OS_CFG_PRIO_MAX-2u 。

3.4 任务控制块、内核对象控制块（结构体）

本兼容层尽可能的兼容任务、内核对象控制块（结构体）的每个成员变量，确保迁移过来的老程序如果直接访问这些结构体的成员变量也是可以直接运行，无需做修改的（尽管直接访问结构体的成员变量μCOS-III官方并不建议甚至十分反对）。

例如，OS_TCB结构体的各个成员变量如下，可以看到，其包含了原版绝大多数成员变量。如果不用兼容原版成员变量，可以定义宏PKG_USING_UCOSIII_WRAPPER_TINY，可以看到OS_TCB结构体大幅度缩减。也可以将OS_CFG_TASK_SEM_EN 、OS_CFG_TASK_Q_EN 、OS_CFG_TASK_REG_TBL_SIZE 关闭以进一步裁剪。

struct os_tcb
{
    struct rt_thread Task;                                  /* 任务,要确保该成员位于结构体第一个                      */
#if OS_CFG_TASK_SEM_EN > 0u
    OS_SEM           Sem;                                   /* 任务内建信号量                                         */
    CPU_BOOLEAN      SemCreateSuc;                          /* 标记任务内建信号量是否创建成功                         */
#endif
#if OS_CFG_TASK_Q_EN > 0u      
    OS_Q             MsgQ;                                  /* 任务内建消息队列                                       */
    void            *MsgPtr;                                /* 任务内建消息队列消息指针                               */
    OS_MSG_SIZE      MsgSize;                               /* 任务内建消息队列消息大小                               */
    CPU_BOOLEAN      MsgCreateSuc;                          /* 标记任务内建消息队列是否创建成功                       */
#endif    
    void            *ExtPtr;                                /* 指向用户附加区指针                                     */
#if OS_CFG_TASK_REG_TBL_SIZE > 0u       
    OS_REG           RegTbl[OS_CFG_TASK_REG_TBL_SIZE];      /* 任务寄存器                                             */
#endif
    OS_STATUS        PendStatus;                            /* Pend status：OS_STATUS_PEND_ABORT OS_STATUS_PEND_OK可用*/ 
#if OS_CFG_TASK_SUSPEND_EN > 0u
    OS_NESTING_CTR   SuspendCtr;                            /* Nesting counter for OSTaskSuspend()                    */
#endif
#if OS_CFG_STAT_TASK_STK_CHK_EN > 0u
    CPU_STK_SIZE     StkUsed;                               /* Number of stack elements used from the stack           */
    CPU_STK_SIZE     StkFree;                               /* Number of stack elements free on   the stack           */
#endif
    OS_STATE         TaskState;                             /* See OS_TASK_STATE_xxx                                  */
    OS_STATE         PendOn;                                /* Indicates what task is pending on                      */

#ifndef PKG_USING_UCOSIII_WRAPPER_TINY
#if (OS_CFG_DBG_EN > 0u)
    OS_TCB          *DbgPrevPtr;
    OS_TCB          *DbgNextPtr;  
    CPU_CHAR        *DbgNamePtr;                            /* 正在等待内核对象的名称                                 */
    CPU_STK         *StkPtr;                                /* (非实时)该数据在本兼容层中不能反映实时SP指针位置,数据在统计任务中更新*/
    CPU_CHAR        *NamePtr;                               /* Pointer to task name                                   */    
#endif
    OS_TICK          TimeQuanta;
    OS_TICK          TimeQuantaCtr;
    OS_SEM_CTR       SemCtr;                                /* Task specific semaphore counter                        */  
    OS_OPT           Opt;                                   /* Task options as passed by OSTaskCreate()               */    
    CPU_STK          StkSize;                               /* 任务堆栈大小*/    
    CPU_STK         *StkLimitPtr;                           /* Pointer used to set stack 'watermark' limit            */
    CPU_STK         *StkBasePtr;                            /* Pointer to base address of stack                       */
    OS_TASK_PTR      TaskEntryAddr;                         /* Pointer to task entry point address                    */
    void            *TaskEntryArg;                          /* Argument passed to task when it was created            */
    OS_PRIO          Prio;                                  /* Task priority (0 == highest)                           */          
#if OS_CFG_FLAG_EN > 0u
    OS_FLAGS         FlagsPend;                             /* Event flag(s) to wait on */
    OS_FLAGS         FlagsRdy;                              /* Event flags that made task ready to run                */
    OS_OPT           FlagsOpt;                              /* Options (See OS_OPT_FLAG_xxx)                          */
#endif
#endif
};

3.5 全局变量

目前，本兼容层可以使用以下μCOS-III原版全局变量（位于os.h）。这些全局变量的具体含义请参见[2.2节](#2.2 迁移步骤)中所列举出的参考资料。

#define           OSSchedLockNestingCtr     rt_critical_level()         /* Lock nesting level                         */
#define           OSIntNestingCtr           rt_interrupt_get_nest()     /* Interrupt nesting level                    */
#define           OSTCBCurPtr               ((OS_TCB*)rt_thread_self()) /* Pointer to currently running TCB           */
                                                                       /* PRIORITIES ------------------------------- */
#define           OSPrioCur                 rt_current_priority         /* Priority of current task                   */
#define           OSPrioTbl                 rt_thread_priority_table

#if OS_CFG_APP_HOOKS_EN > 0u
OS_EXT            OS_APP_HOOK_TCB           OS_AppTaskCreateHookPtr;    /* Application hooks                          */
OS_EXT            OS_APP_HOOK_TCB           OS_AppTaskDelHookPtr;
OS_EXT            OS_APP_HOOK_VOID          OS_AppIdleTaskHookPtr;
OS_EXT            OS_APP_HOOK_VOID          OS_AppStatTaskHookPtr;
#endif

OS_EXT            OS_STATE                  OSRunning;                  /* Flag indicating that kernel is running     */
OS_EXT            OS_STATE                  OSInitialized;              /* Flag indicating the kernel is initialized  */

#ifdef OS_SAFETY_CRITICAL_IEC61508
OS_EXT            CPU_BOOLEAN               OSSafetyCriticalStartFlag;  /* Flag indicating that all init. done        */
#endif

                                                                       /* SEMAPHORES ------------------------------- */
#if OS_CFG_SEM_EN > 0u
#ifndef PKG_USING_UCOSIII_WRAPPER_TINY
#if OS_CFG_DBG_EN > 0u 
OS_EXT            OS_SEM                   *OSSemDbgListPtr;
#endif
OS_EXT            OS_OBJ_QTY                OSSemQty;                   /* Number of semaphores created               */
#endif
#endif

                                                                       /* QUEUES ----------------------------------- */
#if OS_CFG_Q_EN   > 0u
#ifndef PKG_USING_UCOSIII_WRAPPER_TINY
#if OS_CFG_DBG_EN > 0u
OS_EXT            OS_Q                     *OSQDbgListPtr;
#endif
OS_EXT            OS_OBJ_QTY                OSQQty;                     /* Number of message queues created           */
#endif
#endif

                                                                       /* MUTEX MANAGEMENT ------------------------- */
#if OS_CFG_MUTEX_EN > 0u
#ifndef PKG_USING_UCOSIII_WRAPPER_TINY
#if OS_CFG_DBG_EN > 0u
OS_EXT            OS_MUTEX                 *OSMutexDbgListPtr;
#endif
OS_EXT            OS_OBJ_QTY                OSMutexQty;                 /* Number of mutexes created                  */
#endif
#endif

                                                                       /* FLAGS ------------------------------------ */
#if OS_CFG_FLAG_EN > 0u
#ifndef PKG_USING_UCOSIII_WRAPPER_TINY
#if OS_CFG_DBG_EN > 0u
OS_EXT            OS_FLAG_GRP              *OSFlagDbgListPtr;
#endif
OS_EXT            OS_OBJ_QTY                OSFlagQty;
#endif
#endif

                                                                       /* MEMORY MANAGEMENT ------------------------ */
#if OS_CFG_MEM_EN > 0u
#if OS_CFG_DBG_EN > 0u
OS_EXT            OS_MEM                   *OSMemDbgListPtr;
#endif
OS_EXT            OS_OBJ_QTY                OSMemQty;                   /* Number of memory partitions created        */
#endif

                                                                       /* TASKS ------------------------------------ */
#ifndef PKG_USING_UCOSIII_WRAPPER_TINY
#if OS_CFG_DBG_EN > 0u
OS_EXT            OS_TCB                   *OSTaskDbgListPtr;
#endif
OS_EXT            OS_OBJ_QTY                OSTaskQty;                  /* Number of tasks created                    */
#endif
#if OS_CFG_TASK_REG_TBL_SIZE > 0u
OS_EXT            OS_REG_ID                 OSTaskRegNextAvailID;       /* Next available Task Register ID            */
#endif
#if OS_CFG_SCHED_ROUND_ROBIN_EN > 0u
OS_EXT            OS_TICK                   OSSchedRoundRobinDfltTimeQuanta;
OS_EXT            CPU_BOOLEAN               OSSchedRoundRobinEn;        /* Enable/Disable round-robin scheduling      */
#endif

#if OS_CFG_STAT_TASK_EN > 0u
                                                                       /* IDLE TASK -------------------------------- */
OS_EXT            OS_IDLE_CTR               OSIdleTaskCtr;              

                                                                       /* STATISTICS ------------------------------- */
OS_EXT            CPU_BOOLEAN               OSStatResetFlag;            /* Force the reset of the computed statistics */
OS_EXT            OS_CPU_USAGE              OSStatTaskCPUUsage;         /* CPU Usage in %                             */
OS_EXT            OS_CPU_USAGE              OSStatTaskCPUUsageMax;      /* CPU Usage in % (Peak)                      */
OS_EXT            OS_TICK                   OSStatTaskCtr;
OS_EXT            OS_TICK                   OSStatTaskCtrMax;
OS_EXT      

提示：代码过长已自动截断

4 μC/Probe

4.1 介绍

μC/Probe 是由Micriμm公司研发的一款基于Windows操作系统的、专门针对Micriμm公司旗下产品（μC/OS-II、μC/OS-III、uC/TCP-IP等）的应用程序。该软件以可视化的模式实时查看目标系统的内部变量，并且在不中断系统正常运行的情况下改变系统内部全局变量。全局变量可以通过刻度指针、数字表、柱状图、虚拟LED等可视化对象显示出来，通过滑块、开关或者按钮等来修改变量值。用户不需要编写任何代码就可以实现这些功能。目前μC/Probe也已经支持对FreeRTOS的调试。

μC/Probe可以通过多种方式与板卡通信，以获取调试信息：

• J-Link
• CMSIS-DAP
• 与Keil-MDK编译器联合调试 （硬件在线仿真以及软件仿真两种方式都支持，软件仿真模式下不需要板卡）
• IAR Embedded Workbench plugin for µC/Probe
• Analog Devices CCES 2.6.0 or newer
• Eclipse plugin for µC/Probe
• TCP/IP （需要板载驻留代码支持）
• USB （需要板载驻留代码支持）
• RS-232/串口 （需要板载驻留代码支持）

μC/Probe软件界面展示：

用户可以通过控件搭建自己的监控界面：

4.2 下载

由于官方服务器部署在美国，在中国大陆访问非常慢，需要注册才能下载，而且软件是放在国外的dropbox云盘上，国内根本上不去，因此我已经帮大家下载整理好，与官网最新版保持一致。

4.2.1 百度云

更新时可能导致当前百度云链接失效，此百度云链接会随时更新（如果发现链接失效请用issue告诉我）：

链接：https://pan.baidu.com/s/1WarXJcl0cf0sXfougtJ5bg 提取码：0000

4.2.2 腾讯微云

更新时可能导致当前微云链接失效，此微云链接会随时更新（如果发现链接失效请用issue告诉我）：

链接：https://share.weiyun.com/BSBqVvO5

4.3 使用

本兼容层已经实现与μC/Probe的对接，虽然不能和原版μCOS-III一样将所有内核信息全部显示，但是绝大多数信息以及所有内核关键信息均已实现与μC/Probe的对接。同时用户可以借助本兼容层，实现通过μC/Probe直接显示、调试RT-Thread内核信息和数据。如果出现一些奇奇怪怪的问题，请以管理员身份运行该软件！

目前可以查看的任务以及内核对象信息，如下所示。

4.3.1 Task(s)选项卡可用项

可用项名称	说明
Item	列表序号
Name	任务名称
Prio	任务优先级
State	任务状态 Ready 任务就绪 Pend 任务正在等待内核对象 Suspend 任务挂起 Delay 任务延时中
Pending On Object	若任务处于Pend等待内核对象状态，则显示等待内核对象的种类
Pending On	若任务处于Pend等待内核对象状态，则显示等待内核对象的名称
#Used	任务堆栈最大使用情况
#Free	任务堆栈最小剩余情况
Size	初始分配任务堆栈的大小
Stack Usage	堆栈使用率
Name	堆栈静态数组名称
SP	堆栈指针/堆栈基地址

4.3.2 Semaphore(s) 选项卡可用项

可用项名称	说明
Item	列表序号
Name	信号量名称
Counter	信号量的计数值
High Priority Task Waiting	等待该信号量的列表中最高优先级任务的名称

4.3.3 Mutex(s)选项卡可用项

可用项名称	说明
Item	列表序号
Name	互斥量名称
Nesting Counter	互斥量递归调用深度
Owner Original Prio	拥有该互斥量的任务的原始优先级
High Priority Task Waiting	等待该互斥量的列表中最高优先级任务的名称

4.3.4 Event Flag(s)选项卡可用项

可用项名称	说明
Item	列表序号
Name	事件标志组名称
Flags	事件
High Priority Task Waiting	等待该事件标志组的列表中最高优先级任务的名称

4.3.5 Queue(s)选项卡可用项

可用项名称	说明
Item	列表序号
Name	消息队列名称
High Priority Task Waiting	等待该事件标志组的列表中最高优先级任务的名称

4.3.6 Timers选项卡可用项

可用项名称	说明
Item	列表序号
Name	定时器名称
Mode	定时器模式
State	定时器状态
Time Remain	定时器剩余时长
Start Delay	首次延时时长
Period	定时器周期延时时长
Callback Function Pointer	定时器回调函数地址
Callback Function Argument	定时器回调函数参数地址

4.3.7 Tick Lists选项卡可用项

无可用项。

4.3.8 Memory Partition(s)选项卡可用项

全部可用。

5 FinSH命令

本兼容层向RT-Thread FinSH注册了msh命令用以显示兼容层相关信息，用户在调试台中输入ucos --help即可显示可查的兼容层信息。

 \ | /
- RT -     Thread Operating System
 / | \     3.1.3 build Jul 27 2020
 2006 - 2019 Copyright by rt-thread team
msh >ucos --help
-v version
-u cpu usage
-t task
-s sem
-m mutex
-q message queue
-f event flag
-r timer

6 Env工具自动化配置到工程中

6.1 配置方法

uCOS-III兼容层在RT-Thread Nano版中需要手动添加到工程中，但如果使用RT-Thread完整版，则可以通过Env工具进行自动化添加到工程中。方法如下：

RT-Thread online packages
    system packages --->
        [*] Micrium: Micrium software products porting for RT-Thread --->
            [*] uCOS-III Wrapper --->
                [*]   Enable uCOS-III wrapper automatically init
                [*]   Enable uCOS-III wrapper tiny mode
                Version (latest)  --->

6.2 可选功能说明

6.2.1 Enable uCOS-III wrapper automatically init

uCOS-III兼容层支持按照uCOS-III原版的初始化步骤进行初始化，但是在有些情况，用户不想手动初始化uCOS-III兼容层，想要直接运行应用层任务或模块，则可以使用该宏定义。在rtconfig.h中定义本宏定义后，在RT-Thread初始化完成并进入到main线程之前会自动将uCOS-III兼容层初始化完毕，用户仅需要专注于uCOS-III的应用级任务即可。

若将该功能开启，则会在rtconfig.h文件中中定义PKG_USING_UCOSIII_WRAPPER_AUTOINIT宏。在os_rtwrap.c文件中的以下函数将被使能并在RT-Thread初始化时自动执行。

若没有使用完整版（即nano版）也想使用本功能，可以在rtconfig.h中手动添加定义宏定义PKG_USING_UCOSIII_WRAPPER_AUTOINIT。

/**
 * 自动初始化
 * uCOS-III兼容层支持按照uCOS-III原版的初始化步骤进行初始化，但是在有些情况，
 * 用户不想手动初始化uCOS-III兼容层，想要直接运行应用层任务或模块，则可以使用该
 * 宏定义。在rtconfig.h中定义本宏定义后，在RT-Thread初始化完成并进入到main线程之前
 * 会自动将uCOS-III兼容层初始化完毕，用户仅需要专注于uCOS-III的应用级任务即可。
 * The wrapper supports uCOS-III standard startup procedure. Alternatively,
 * if you want to run uCOS-III apps directly and ignore the startup procedure, 
 * you can choose this option.
 */
#ifdef PKG_USING_UCOSIII_WRAPPER_AUTOINIT
#include <os_app_hooks.h>
static int rt_ucosiii_autoinit(void)
{
    OS_ERR err;
    
    OSInit(&err);                                   /*uCOS-III操作系统初始化*/
    OSStart(&err);                                  /*开始运行uCOS-III操作系统*/
    
    CPU_Init();
    
#if OS_CFG_APP_HOOKS_EN > 0u
    App_OS_SetAllHooks();                           /*设置钩子函数*/
#endif  
    
#if OS_CFG_STAT_TASK_EN > 0u
    OSStatTaskCPUUsageInit(&err);  	                /*统计任务*/    
    OSStatReset(&err);                              /*复位统计数据*/    
#endif
    
    return 0;
}
INIT_PREV_EXPORT(rt_ucosiii_autoinit);
#endif

6.2.2 Enable uCOS-III wrapper tiny mode

如果你在使用过程中不需要兼容任务/内核对象结构体的成员变量，或者不需要使用uC/Probe软件监控兼容层状态，可使能该选项。ENV将自动在rtconfig.h文件中定义PKG_USING_UCOSIII_WRAPPER_TINY宏定义。以OS_SEM结构体为例：

struct  os_sem { 
    struct  rt_semaphore  Sem;
#ifndef PKG_USING_UCOSIII_WRAPPER_TINY
    OS_OBJ_TYPE           Type;
#if (OS_CFG_DBG_EN > 0u)
    CPU_CHAR             *NamePtr;                          /* Pointer to Semaphore Name (NUL terminated ASCII)       */
    OS_SEM               *DbgPrevPtr;
    OS_SEM               *DbgNextPtr;
    CPU_CHAR             *DbgNamePtr;                       /* 等待该内核对象挂起表中第一个任务的名字                 */
#endif
    OS_SEM_CTR            Ctr;    
#endif
};

可以看到，在定义PKG_USING_UCOSIII_WRAPPER_TINY后，OS_SEM结构体得到了大幅度精简。该模式可满足所有API的基本兼容需求，建议勾选该选项。

7 友情链接

7.1 RT-Thread Nano移植教程

官方文档：

https://www.rt-thread.org/document/site/tutorial/nano/an0038-nano-introduction/

视频教程：

基于 MDK 移植 RT-Thread Nano：https://www.bilibili.com/video/BV1TJ411673o

基于 IAR 移植 RT-Thread Nano：https://www.bilibili.com/video/BV1BJ41177CW

基于 CubeMX 移植 RT-Thread Nano：https://www.bilibili.com/video/BV1KJ41167qg

7.2 RT-Thread FinSH控制台教程

官方文档：

https://www.rt-thread.org/document/site/programming-manual/finsh/finsh/

视频教程：

https://www.bilibili.com/video/BV1r741137sY?p=1

8 其他

8.1 联系方式

维护：Meco Man

联系方式：[email protected]

8.2 主页

https://github.com/mysterywolf/RT-Thread-wrapper-of-uCOS-III

https://gitee.com/mysterywolf/RT-Thread-wrapper-of-uCOS-III （国内镜像，定时同步）

8.3 致谢

感谢RT-Thread工程师Willian Chan的技术支持

感谢RT-Thread工程师yangjie的技术支持

8.4 开源协议

采用 Apache-2.0 开源协议，细节请阅读项目中的 LICENSE 文件内容。

8.5 支持

如果您喜欢本项目可以在本页右上角点一下Star，可以赏我五毛钱，用以满足我小小的虚荣心，并激励我继续维护好这个项目。