Skip to content

Latest commit

 

History

History
274 lines (164 loc) · 12.9 KB

10.Porting_Manual_for_KEIL.md

File metadata and controls

274 lines (164 loc) · 12.9 KB
Raw

TencentOS tiny 内核移植参考指南（Keil 版）

一、移植前的准备

1. 准备目标硬件（开发板/芯片/模组）

TencentOS tiny 目前主要支持 ARM Cortex M 核芯片的移植，比如 STM32 基于 Cortex M 核全系列、NXP 基于 Cortex M 核全系列等。本教程将使用 STM32 官方 Demo 开发板 NUCLEO-L073RZ 进行示例移植，其他 ARM Cortex M 系列开发板和芯片移植方法类似。

调试 ARM Cortex M 核还需要仿真器，NUCLEO-L073RZ 自带 ST-Link 调试器，如果您的开发板或者芯片模组没有板载仿真器，就需要连接外置的仿真器，如 J-Link、U-Link 之类的。

2.准备编译器环境

本移植指南针对的是 Keil 编译器，所以我们移植内核前需要先安装 Keil 编译器，能编译 ARM Cortex M 核的 Keil 编译器现在也叫 MDK，最新版本 5.28a，下载地址为：https://www.keil.com/demo/eval/arm.htm 填写注册信息即可下载，下载完成在 windows 环境下按照提示安装即可，安装完成后需要自行购买软件 License，避免 32K Flash 下载限制。 由于新版本的 MDK 编译器和芯片支持包是分离的，所以 MDK（Keil）安装完成后，还需要安装对应芯片的器件支持包（PACK 包），比如本教程示例的 NUCLEO-L037RZ 开发板的芯片是 STM32L073RZ，就需要安装Keil.STM32L0xx_DFP.2.0.1.pack系列器件支持包，MDK 所有支持芯片的 PACK 包下载地址为：http://www.keil.com/dd2/Pack/#/eula-container ，您只需要根据您的芯片型号下载对应的 PACK 包即可，当然您也可以在 MDK 集成开发环境中在线下载安装。

3. 准备芯片对应的裸机工程

移植 TencentOS tiny 基础内核需要您提前准备一个芯片对应的裸机工程，裸机工程包含基本的芯片启动文件、基础配置（时钟、主频等）、以及串口、基本 GPIO 驱动用于 RTOS 测试。

本教程使用 ST 官方的 STM32CubeMX 软件来自动化生成 MDK 裸机工程，STM32CubeMX 的下载地址为：

https://www.st.com/content/st_com/zh/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-configurators-and-code-generators/stm32cubemx.html

安装 STM32CubeMx 还需要事先安装好 JDK 环境，您可以在互联网上查找如何安装和配置 JDK 环境，此处不再赘述。

CubeMX 安装完成后，我们就可以使用 CubeMX 来给 NUCLEO-L073RZ 开发板生成裸机工程了，如果您的芯片不是 STM32，而是其他厂商的 ARM Cortex M 系列，您可以根据产商的指导准备裸机工程，后续的内核移植步骤是一致的。

3.1 首先启动 STM32CubeMX，新建工程

3.2 选择 MCU 型号

如上图所示：通过 MCU 筛选来找到自己开发板对应的芯片型号，双击后弹出工程配置界面，如下图：

3.3 Pin 设置界面配置时钟源

3.4 Pin 设置界面配置串口

3.5 Pin 设置界面配置 GPIO

3.6 配置总线时钟

3.7 工程生成参数配置

3.8 代码生成方式配置

3.9 生成工程

3.10 keil 下的裸机工程

点击生成代码后，生成的裸机工程效果如下：

这样 NUCLEO-L073RZ 裸机工程生成完成，该工程可直接编译并烧写在板子上运行。

4. 准备 TencentOS tiny 的源码

TencentOS tiny 的源码已经开源，GitHub 下载地址为：https://github.com/Tencent/TencentOS-tiny.git

一级目录 二级目录 说明
arch arm TencentOS tiny 适配的 IP 核架构（含 M 核中断、调度、tick 相关代码）
board NUCLEO_L073RZ 移植目标芯片的工程文件
kernel core TencentOS tiny 内核源码
pm TencentOS tiny 低功耗模块源码
osal cmsis_os TencentOS tiny 提供的 cmsis os 适配

由于本教程只介绍 TencentOS tiny 的内核移植，所以这里只需要用到 arch、board、kernel、osal 四个目录下的源码。

二、内核移植

1. 代码目录规划

如图所示，新建 TencentOS_tiny 主目录，并在主目录下添加四个子目录，其中 arch、kernel、osal 从代码仓直接拷贝过来即可，而 board 目录下则放入我们前面生成的裸机工程代码，我们移植的开发板取名叫 NUCLEO_L073RZ，裸机代码全部拷贝到下面即可，如下图所示：

接下来进入 TencentOS_tiny\board\NUCLEO_L073RZ\MDK-ARM 目录，打开 keil 工程，我们开始添加 TencentOS tiny 的内核代码。

2. 添加 arch 平台代码

tos_cpu.c 是 TencentOS tiny 的 CPU 适配文件，包括堆栈初始化，中断适配等，如果您的芯片是 ARM Cortex M 核，该文件可以不做改动，M0、M3、M4、M7 是通用的，其他 IP 核需要重新适配；

port_s.S 文件是 TencentOS tiny 的任务调度汇编代码，主要做弹栈压栈等处理的，port_c.c 适配 systick 等，这两个文件 每个 IP 核和编译器都是不一样的，如果您的芯片是 ARM Cortex M 核，我们都已经适配好，比如现在我们移植的芯片是 STM32L073RZ，是 ARM Cortex M0+核，使用的编译器是 KEIL，所以我们选择 arch\arm\arm-v7m\cortex-m0+\armcc 下的适配代码，如果你的开发板是 STM32F429IG，M4 核，编译器是 GCC，则可以选择 arch\arm\arm-v7m\cortex-m4\gcc 目录下的适配文件。

3. 添加内核源码

内核源码 kerne 目录下包含 core 和 pm 两个目录，其中 core 下为基础内核，pm 是内核中的低功耗组件；基础移植的时候可以不添加 pm 目录下的代码，如下图所示，添加全部基本内核源码：

4. 添加 cmsis os 源码

cmsis os 是 TencentOS tiny 为了兼容 cmsis 标准而适配的 OS 抽象层，可以简化大家将业务从其他 RTOS 迁移到 TencentOS tiny 的工作量。

5. 添加 TencentOS tiny 头文件目录

添加头文件目录前，我们在要移植的工程目录下新增一个 TOS_CONFIG 文件夹，用于存放 TencentOS tiny 的配置头文件，也就是接下来要新建的 tos_config.h 文件；

TencentOS tiny 所有要添加的头文件目录如下：

6. 新建 TencentOS tiny 系统配置文件 tos_config.h

#ifndef _TOS_CONFIG_H_
#define  _TOS_CONFIG_H_

#include "stm32l0xx.h"	// 目标芯片头文件，用户需要根据情况更改

#define TOS_CFG_TASK_PRIO_MAX           10u 	// 配置TencentOS tiny默认支持的最大优先级数量

#define TOS_CFG_ROUND_ROBIN_EN          0u		// 配置TencentOS tiny的内核是否开启时间片轮转

#define TOS_CFG_OBJECT_VERIFY_EN           1u	// 配置TencentOS tiny是否校验指针合法

#define TOS_CFG_TASK_DYNAMIC_CREATE_EN  1u		// TencentOS tiny 动态任务创建功能宏

#define TOS_CFG_EVENT_EN                1u		// TencentOS tiny 事件模块功能宏

#define TOS_CFG_MMBLK_EN                1u		//配置TencentOS tiny是否开启内存块管理模块

#define TOS_CFG_MMHEAP_EN               1u		//配置TencentOS tiny是否开启动态内存模块

#define TOS_CFG_MMHEAP_DEFAULT_POOL_EN  1u		// TencentOS tiny 默认动态内存池功能宏

#define TOS_CFG_MMHEAP_DEFAULT_POOL_SIZE        0x100	// 配置TencentOS tiny默认动态内存池大小

#define TOS_CFG_MUTEX_EN                1u		// 配置TencentOS tiny是否开启互斥锁模块

#define TOS_CFG_MESSAGE_QUEUE_EN        1u		// 配置TencentOS tiny是否开启消息队列模块

#define TOS_CFG_MAIL_QUEUE_EN           1u		// 配置TencentOS tiny是否开启消息邮箱模块

#define TOS_CFG_PRIORITY_MESSAGE_QUEUE_EN	1u	// 配置TencentOS tiny是否开启优先级消息队列模块

#define TOS_CFG_PRIORITY_MAIL_QUEUE_EN	1u		// 配置TencentOS tiny是否开启优先级消息邮箱模块

#define TOS_CFG_TIMER_EN                1u		// 配置TencentOS tiny是否开启软件定时器模块

#define TOS_CFG_PWR_MGR_EN              0u		// 配置TencentOS tiny是否开启外设电源管理模块

#define TOS_CFG_TICKLESS_EN             0u		// 配置Tickless 低功耗模块开关

#define TOS_CFG_SEM_EN                  1u		// 配置TencentOS tiny是否开启信号量模块

#define TOS_CFG_TASK_STACK_DRAUGHT_DEPTH_DETACT_EN      1u	// 配置TencentOS tiny是否开启任务栈深度检测

#define TOS_CFG_FAULT_BACKTRACE_EN      0u		// 配置TencentOS tiny是否开启异常栈回溯功能

#define TOS_CFG_IDLE_TASK_STK_SIZE      128u	// 配置TencentOS tiny空闲任务栈大小

#define TOS_CFG_CPU_TICK_PER_SECOND     1000u	// 配置TencentOS tiny的tick频率

#define TOS_CFG_CPU_CLOCK               (SystemCoreClock)	// 配置TencentOS tiny CPU频率

#define TOS_CFG_TIMER_AS_PROC           1u		// 配置是否将TIMER配置成函数模式

#endif

按照上面的模板配置好 TencentOS tiny 的各项功能后，将 tos_config.h 文件放入要移植的 board 工程目录下即可，例如本教程是放到 board\NUCLEO_L073RZ\TOS_CONFIG 目录下。

这样，TencentOS tiny 的源码就全部添加完毕了。

三、创建 TencentOS tiny 任务，测试移植结果

1. 修改部分代码

修改 stm32l0xx_it.c 的中断函数，在 stm32l0xx_it.c 文件中包含 tos_k.h 头文件

在 stm32l0xx_it.c 文件中的 PendSV_Handler 函数前添加___weak 关键字，因为该函数在 TencentOS tiny 的调度汇编中已经重新实现；同时在 SysTick_Handler 函数中添加 TencentOS tiny 的调度处理函数，如下图所示：

2. 编写 TencentOS tiny 测试任务

在 main.c 中添加 TencentOS tiny 头文件，编写任务函数

   #include "cmsis_os.h"
   //task1
   #define TASK1_STK_SIZE		256
   void task1(void *pdata);
   osThreadDef(task1, osPriorityNormal, 1, TASK1_STK_SIZE);

   //task2
   #define TASK2_STK_SIZE		256
   void task2(void *pdata);
   osThreadDef(task2, osPriorityNormal, 1, TASK2_STK_SIZE);

   void task1(void *pdata)
   {
       int count = 1;
       while(1)
       {
           printf("\r\nHello world!\r\n###This is task1 ,count is %d \r\n", count++);
           HAL_GPIO_TogglePin(LED_GPIO_Port,LED_Pin);
           osDelay(2000);
       }
   }
   void task2(void *pdata)
   {
       int count = 1;
       while(1)
       {
           printf("\r\nHello TencentOS !\r\n***This is task2 ,count is %d \r\n", count++);
           osDelay(1000);
       }
   }

   int fputc(int ch, FILE *f)
   {
     if (ch == '\n')
     {
       HAL_UART_Transmit(&huart2, (void *)"\r", 1,30000);
     }
     HAL_UART_Transmit(&huart2, (uint8_t *)&ch, 1, 0xFFFF);
     return ch;
   }

如图：

继续在 main.c 的 main 函数中硬件外设初始化代码后添加 TencentOS tiny 的初始化代码：

     osKernelInitialize(); //TOS Tiny kernel initialize
     osThreadCreate(osThread(task1), NULL);// Create task1
     osThreadCreate(osThread(task2), NULL);// Create task2
     osKernelStart();//Start TOS Tiny

如图：

3. 编译下载测试 TencentOS tiny 移植结果

按照上图指示，进行编译下载到开发板即可完成 TencentOS tiny 的测试，如下图所示，可以看到串口交替打印信息，表示两个任务正在进行调度，切换运行：