单片机笔记如何编写一个清晰的串口日志输出DEBUG文件（附源码）

Posted 2022-12-03 沉默的小宇宙

前言：

相信大多数嵌入式开发者都会碰到对程序进行调试或者查找BUG的情况，常见的两种方法都是仿真和通过日志进行的。有条件仿真的是更好，单是在编写嵌入式软件程序过程中，并不是所有的硬件都支持仿真或者方便仿真，这样大多数方法便是加打印信息进行找问题。打印的接口有很多种，比如串口，网络，显示等等。简单的硬件开发串口估计是最常用的。这里简单记录下我最近设计的一种日志打印方法。

目的：

1）方便查找打印日志

2）日志格式规范

3）可以查看用户添加信息，文件信息，函数接口，以及文件所在行号

4）支持format格式

5）*可以支持实时时间

基本知识：

C语言中的__FILE__、__LINE__和__FUNCTION__

1、__FILE__ 用于指示本行代码所在源文件的文件名；

2、__LINE__用于指示本行代码所在源文件中的位置（行数）；

3、__FUNCTION__用于指示本行代码所在函数（函数名）；

注：

1）"__FILE__ "、"__LINE__"、"__FUNCTION__"等均大小写敏感

2）支持需要添加头文件#include<stdio.h>

源码

#define DEBUG_EN (1u)

#if (DEBUG_EN)

#define DEBUG_MAX_SIZE 512
extern char szBuf[DEBUG_MAX_SIZE];

#define DEBUG_INFO( format, ... ) do\\
	u16 unLen = 0;\\
	unLen += snprintf(szBuf+unLen,DEBUG_MAX_SIZE, "[INFO][%s][@%s][#%d]:",__FILE__,__FUNCTION__,__LINE__);\\
	unLen += snprintf(szBuf+unLen,DEBUG_MAX_SIZE-unLen, format, ## __VA_ARGS__ );\\
	usart1_send_buf_with_txe((u8 *)szBuf,unLen);\\
while(0)

#define DEBUG_WARN( format, ... ) do\\
	u16 unLen = 0;\\
	unLen += snprintf(szBuf+unLen,DEBUG_MAX_SIZE, "[WARN][%s][@%s][#%d]:",__FILE__,__FUNCTION__,__LINE__);\\
	unLen += snprintf(szBuf+unLen,DEBUG_MAX_SIZE-unLen, format, ## __VA_ARGS__ );\\
	usart1_send_buf_with_txe((u8 *)szBuf,unLen);\\
while(0)

#define DEBUG_ERR( format, ... ) do\\
	u16 unLen = 0;\\
	unLen += snprintf(szBuf+unLen,DEBUG_MAX_SIZE, "[ERR][%s][@%s][#%d]:",__FILE__,__FUNCTION__,__LINE__);\\
	unLen += snprintf(szBuf+unLen,DEBUG_MAX_SIZE-unLen, format, ## __VA_ARGS__ );\\
	usart1_send_buf_with_txe((u8 *)szBuf,unLen);\\
while(0)

#elif 

#define DEBUG_INFO(...)
#define DEBUG_WARN(...)
#define DEBUG_ERR(...)

#endif

源码主要使用宏定义的方式，为了支持文件、行号，函数等等，不能使用单独的函数进行定义。具体原因可以思考下，不过多赘述。

C文件目前只有一个数组定义char szBuf[DEBUG_MAX_SIZE];。为了兼容，INFO，WARN和ERR三个公用一个buf，声明全局变量更主要的一个原因是使用了串口的中断发送函数usart1_send_buf_with_txe，而不是循环发送完成再退出，这里传输是进行指针传递的，发送使用中断的好处就是高效率，不耽误其他程序跑。当然移植的时候完全可以根据自己的接口和实现方式进行更换。

实现效果

[INFO][..\\source\\main.c][@main][#36]:testStr[111],testInt[111],testHex[0x000015BC]
[WARN][..\\source\\main.c][@main][#37]:testStr[111],testInt[111],testHex[0x000015BC]
[ERR][..\\source\\main.c][@main][#38]:testStr[111],testInt[111],testHex[0x000015BC]

更多资料及技术问题可以加技术交流群：733945348

 By Urien 2021年8月7日 14:33:10