嵌入式开发输出调试和日志信息的几种方法

NXP管管

嵌入式开发输出调试和日志信息的几种方法

基于MCU的嵌入式软件开发，可能在某些情况下没有多余存储空间，从而没有在本地有效保存调试和日志信息。

这时，通过某种方式把调试（Debug）和日志（Log）信息输出就显得有意义了。


下面就来讲讲关于嵌入式开发中输出调试和日志信息的几点内容。


1标准库 printf 直接输出
在MCU嵌入式开发中，通过UART串口 printf 输出调试和日志信息的方式是最常见的一种。


在Linux、Windows这种大型系统中，使用标准C库没有问题，但在MCU这种资源有限的平台，通常使用微库。


1.使用微库配置方法
在使用的IDE中，比如 Keil 和 IAR 都需要在工程选项中进行配置才能正常使用微库。


Keil 使用微库：
Project -> Options for Target -> Target，勾选"Use MicroLIB"

IAR 使用微库：
Project -> Options for Node -> General Options -> Library Configuration，选择"Full"

额外说明一下，IAR 中使用库有四个选择：


None：无
Normal：选择常规配置的运行时库
Full：选择完整配置的运行时库
Custom：选择定制运行时库


这里关于微库以及IDE配置，可以参看我的文章：
微库和标准C库有什么区别？


Keil系列教程05_工程目标选项配置（一）
IAR系列教程06_工程节点选项配置（一）

2.重定义函数
你要输出信息，肯定要有路径才行啊，是UART，还是CAN。所以，就需要重定义函数才行。


以UART串口为例，最常见一种方式：

1. 
   
2. #include <stdio.h>
   
3. 
   
4. int fputc(int ch, FILE *f)
   
5. {
   
6.   DEBUG_SendByte((uint8_t)ch);
   
7. 
   
8.   return ch;
   
9. }
   
10. 
    
11. int fgetc(FILE *f)
    
12. {
    
13.   while(USART_GetFlagStatus(DEBUG_COM, USART_FLAG_RXNE) == RESET);
    
14. 
    
15.   return (int)USART_ReceiveData(DEBUG_COM);
    
16. }

复制代码

当然，串口里面具体的实现方式，与你底层有关。


有以上配置，就可以直接使用 printf 函数了。


2自定义 printf 输出
有些情况下，需要指定要求输出调试或日志信息，就需要自定义输出格式。


举例1：
比如：我要设置一个 “DBUGE 开关”，在开发测试阶段，我需要打开开关，产品量产后，我不需要开启调试信息输出。

1. 
   
2. #define DEBUG(Type, ...)   if(DEBUG_EN(Type)) \
   
3.                            { \
   
4.                              printf(__VA_ARGS__); \
   
5.                            }
   

复制代码

说明：__VA_ARGS__它是一个可变参数的宏，就是将左边宏中“...” 的内容原样抄写在右边 __VA_ARGS__ 所在的位置。


举例2：
还比如：输出日志信息，添加“时间戳”：

1. 
   
2. #define DEBUG(Type, ...)   if(DEBUG_EN(Type)) \
   
3.                            { \
   
4.                              printf("%s:", GetTimeStr());\
   
5.                              printf(__VA_ARGS__); \
   
6.                            }

复制代码

更多自定义：
实际项目可能有很多需求，还比如：针对不同类型的传感器，输出日志带有“传感器编号”的日志信息。


所以说，项目需求和复杂不同，其输出调试或日志信息可能有不同的方式，具体要不要实现，还需要综合评估。


3SWO 输出
类似UART串口输出，SWO（Serial Wire Output）串行线输出也是其中的一种，但需要MCU支持SWO功能才行（目前很多MCU都支持）。


可以在线调试时，输出到IDE界面，比如：

还可以离线输出到一些工具界面，比如：

4CLI调试输出信息
上面几种方式都是单纯的输出调试/日志信息，相对更高级一点的做法就是通过CLI（Command Line Interface）命令行的方式获取调试信息。

命令行相信大家不模式，做嵌入式开发的都知道，像Linux的终端就是一个命令行，只是我们这里说的命令行，相对Linux的终端来说要简单的多。但是原理类似，都是通过输入命令来查看数据或执行某个动作。

1.相对printf优势


通过CLI可以任意时刻查看指定信息，执行某种操作。

2.相对printf劣势


需要在代码中集成CLI组件，以及对应的（查看、执行动作等）代码，更占用资源。（当然，可以使用轻量级的CLI，相对不占资源那种）

比如我之前用的一种，估计占用Flash不到1K的空间：

其实，很多RTOS都集成了CLI组件，想用其实也不是想象中的那么复杂，和移植RTOS差不多，甚至更简单。

由于时间和篇幅有限，就写到这里，关于CLI的内容还有很多，后面如果还有时间，争取多分享一些相关内容。

阅读全文