好用的嵌入式設(shè)備日志輸出模塊 log.h
相信大多數(shù)嵌入式開發(fā)者都會(huì)碰到對(duì)程序進(jìn)行調(diào)試或者查找BUG的情況,常見的兩種方法都是仿真和通過日志進(jìn)行的。
有條件仿真的是更好,單是在編寫嵌入式軟件程序過程中,并不是所有的硬件都支持仿真或者方便仿真,這樣大多數(shù)方法便是加打印信息進(jìn)行找問題。
打印的接口有很多種,比如串口,網(wǎng)絡(luò),顯示等等。簡單的硬件開發(fā)串口估計(jì)是最常用的。這里簡單記錄下一種日志打印方法。
目的:
- 方便查找打印日志
- 日志格式規(guī)范
- 可以查看用戶添加信息,文件信息,函數(shù)接口,以及文件所在行號(hào)
- 支持format格式
- 可以支持實(shí)時(shí)時(shí)間
基本知識(shí)
C語言中的__FILE__、LINE__和__FUNCTION:
- FILE 用于指示本行代碼所在源文件的文件名;
- __LINE__用于指示本行代碼所在源文件中的位置(行數(shù));
- __FUNCTION__用于指示本行代碼所在函數(shù)(函數(shù)名);
注:
- "FILE "、"LINE"、"FUNCTION"等均大小寫敏感
- 支持需要添加頭文件#include
源碼
#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
源碼主要使用宏定義的方式,為了支持文件、行號(hào),函數(shù)等等,不能使用單獨(dú)的函數(shù)進(jìn)行定義。具體原因可以思考下,不過多贅述。
C文件目前只有一個(gè)數(shù)組定義char szBuf[DEBUG_MAX_SIZE];。
為了兼容,INFO,WARN和ERR三個(gè)共用一個(gè)buf,聲明全局變量更主要的一個(gè)原因是使用了串口的中斷發(fā)送函數(shù)usart1_send_buf_with_txe,而不是循環(huán)發(fā)送完成再退出,這里傳輸是進(jìn)行指針傳遞的,發(fā)送使用中斷的好處就是高效率,不耽誤其他程序跑。
當(dāng)然移植的時(shí)候完全可以根據(jù)自己的接口和實(shí)現(xiàn)方式進(jìn)行更換。
實(shí)現(xiàn)效果:
[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]
圖片