教你如何使用SEGGER RTT优雅的实现日志系统

欢迎大家来到IT世界,在知识的湖畔探索吧!

今天开始了 BMS 系统的软件代码部分的搭建，计划是分成三层：硬件驱动，AFE 层和系统应用层。

第一步肯定是先把底层的 IIC 通信调通，CG861xx 的 IIC 通信和 TI 的 BQ769X0 系列一样，IIC 里面有一个 CRC8 的校验，因此调试起来不是很直观，因此想先把调试打印的接口建立好。

首先想到的肯定是把串口调试好，通过 printf 的底层 fputc 函数重映射到串口的发送函数上进行信息输出。

int fputc(int ch, FILE *f) { uint8_t temp[1]={ch}; HAL_UART_Transmit(&huart2, temp, 1, 2); } 

欢迎大家来到IT世界,在知识的湖畔探索吧!

但是，串口还需要多一个 USB 转 TTL 的转接线，无奈手头没有现成的，转眼看到了自己调试用的 JlinkOB，突然想到这上面是有一个 RTT 可以通过 SWD 接口进行信息输出的。

那就折腾起来。

我会把完善后的 RTT 驱动打包放到文末，想使用的同学可以直接copy 到自己的工程中即可使用。

使用 RTT 的好处是：

1. 调试，下载，打印信息只需要一条线。
2. 节省一个串口，可以另做他用，对于资源紧张的小型 MCU 很重要。
3. 在量产产品中可以保留 SWD 端口进行故障排除。

看一眼，JlinkOB 就是这个东西了。

欢迎大家来到IT世界,在知识的湖畔探索吧!

当然使用完整版的 Jlink 也是可以的，不过我比较喜欢简洁而小型化的东西。

RTT的全称是实时传输（Real Time Transmit），是Segger公司推出的，搭配Jlink使用的调试手段，与其它的日志打印手段相比，其具备下列特点：

RTT连接示意图如下图所示：

驱动移植

一、下载Jlink驱动

搞 Arm 单片机的同学对 SEGGER 的Jlink一定不陌生，网络上铺天盖地的盗版和简易版都可以 DIY 的，SEGGER RTT是Jlink驱动里面的功能，我们首先要到官网上去下载驱动
https://www.segger.com/downloads/jlink/

二、提取单片机上的RTT库

打开Jlink驱动的安装位置（默认为：C:\Program Files\SEGGER\JLink），不知道的话可以重新安装一下，或者右键快捷方式选择打开所在位置，然后在这个目录下找到RTT的库文件：

解压后我们会用到压缩包里面的这两个文件夹：

三、移植RTT库

把RTT文件夹放到项目里面去，这些文件都放进去

然后MDK里面建立一个新的文件夹命名为 SEGGER_RTT，然后将相应的 C 文件引入进工程：

include文件夹也需要加入到 C/C++的的环境变量中，这样可以在工程中比较方便的引用。

现在你就可以用如下的代码就行打印的测试了：

欢迎大家来到IT世界,在知识的湖畔探索吧!void SEGGER_RTT_Test(void) { SEGGER_RTT_Init(); uint32_t count = 10; while (count--) { SEGGER_RTT_printf(0, "system init ok\r\n"); } } 

四、上位机的使用

如果有Jlink，可以直接使用J-Link RTT Viewer、J-Link RTT Logger、J-Link RTT Client进行日志查看。就拿最简单的J-Link RTT Viewer举例子，在开始菜单或者是搜索框找到它：

默认情况下只需设置需要调试的芯片跟调试器接口即可，可以参照下图：

设置好点击OK就可以开始愉快的看日志了（SEGGERRTTprintf函数的第一个参数就是指定在哪个Terminal窗口显示，默认是0。

五、封装RTT库接口

使用RTT毕竟是拿来打日志的，直接调用printf还是比较麻烦的，不如重新封装一下，先来看看效果：

有了各种信息的标记以及不同的颜色，是不是显得优雅了很多，我们来看如何做到这样。

首先我们新建个log.h文件，把下面的内容放进去，这样就在RTT的print上面封装了一层。

#ifndef __LOG_H #define __LOG_H #include "SEGGER_RTT.h" #define LOG_DEBUG 1 #if LOG_DEBUG #define LOG_PRINT(type,color,format,...) \ SEGGER_RTT_printf(0,"%s%s"format"%s", \ color, \ type, \ __VA_ARGS__, \ RTT_CTRL_RESET) /* 清屏*/ #define LOG_CLEAR() SEGGER_RTT_WriteString(0, RTT_CTRL_CLEAR) /* 无颜色日志输出 */ #define LOG(format,...) LOG_PRINT("","",format,__VA_ARGS__) /* 有颜色格式日志输出 */ #define LOG_INFO(format,...) LOG_PRINT("LOG: ", RTT_CTRL_TEXT_BRIGHT_GREEN , format, __VA_ARGS__) #define LOG_WARNING(format,...) LOG_PRINT("WAR: ", RTT_CTRL_TEXT_BRIGHT_YELLOW, format, __VA_ARGS__) #define LOG_ERROR(format,...) LOG_PRINT("ERR: ", RTT_CTRL_TEXT_BRIGHT_RED , format, __VA_ARGS__) #else #define LOG_CLEAR() #define LOG #define LOG_INFO(format,...) #define LOG_WARNING(format,...) #define LOG_ERROR(format,...) #endif #endif 

使用的时候，我们先 #include”log.h” ，然后再使用以下函数调用即可：

欢迎大家来到IT世界,在知识的湖畔探索吧!LOG_INFO("Read %d %d %d \r\n",m_ADCOffset,temp1,temp2); m_ADCGain = ((temp2 >> 5) & 0x07) + ((temp1 << 1) & 0x18) + 365; LOG_WARNING("ADC Gain is %d \r\n",m_ADCGain); LOG_ERROR("The ADC Gain is error \r\n"); CG_WriteReg(PROTECT3, 0x11); //测试写入功能 CG_ReadReg(PROTECT3, &temp1); if(temp1 != 0x11) return I2C_TIMEOUT; LOG_INFO(" Test the CG861xx write ok\r\n"); 

通过不同的日志等级还可以有不同的颜色显示，这里先放个效果：

到这里，单片机上需要的工作就结束了，只需要接上Jlink，用USB进行连接就行了。

总结及资料领取

SEGGER RTT毕竟是设计来与Jlink配合进行使用的，日志传输的速度非常快，并且支持在裸机、RTOS环境下运行，下图是官方宣传的理论性能：

作为一种不占用串口的日志输出方式，在部分应用场景下还是值得一试的，以下链接是打包好的代码，可以直接放到自己的工程中调用。

教你如何使用SEGGER RTT优雅的实现日志系统