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

《论语》有云:“工欲善其事,必先利其器”。输出调试信息是软件开发中必不可少的调试利器,在出现bug时如果没有调试信息将会是一件令人头痛的事。本文主要介绍在嵌入式开发中用来输出log的方法,这些方法都是在实际开发过程中使用过的。
嵌入式开发的一个特点是很多时候没有操作系统,或者没有文件系统,常规的打印log到文件的方法基本不适用。最常用的是通过串口输出uart log,例如51单片机,只要实现串口驱动,然后通过串口输出就可以了。
这种方法实现简单,大部分嵌入式芯片都有串口功能。但是这样简单的功能有时候却不是那么好用,比如:
(1) 一款新拿到的芯片,没有串口驱动时如何打印log
(2) 某些应用下对时序要求比较高,串口输出log占用时间太长怎么办?比如usb枚举。
(3) 某些bug正常运行时会出现,当打开串口log时又不再复现怎么办
(4) 一些封装中没有串口,或者串口已经被用作其他用途,要如何输出log下面来讨论这些问题:
1、输出log信息到sram
准确来说这里并不是输出log,而是以一种方式不使用串口就可以看到log。在芯片开发阶段都可以连接仿真器调试,可以使用打断点的方法调试,但是有些操作如果不能被打断就没法使用断点调试了。
这时候可以考虑将log打印到sram中,整个操作结束后再通过仿真器查看sram中的log buffer,这样就实现了间接的log输出。
本文使用的测试平台是stm32f407 discovery,基于usb host实验代码,对于其他嵌入式平台原理也是通用的。首先定义一个结构体用于打印log,如下:
typedef struct {    volatile u8     type;    u8*             buffer;             /* log buffer指针*/    volatile u32    write_idx;          /* log写入位置*/    volatile u32    read_idx;           /* log 读取位置*/}log_dev;  
定义一段sram空间作为log buffer:
static u8 log_buffer[log_max_len];  
log buffer是环形缓冲区,在小的buffer就可以无限打印log,缺点也很明显,如果log没有及时输出就会被新的覆盖。buffer大小根据sram大小分配,这里使用1kb。为了方便输出参数,使用printf函数来格式化输出,需要做如下配置(keil):
并包含头文件#include , 在代码中实现函数fputc():
//redirect fputcint fputc(int ch, file *f){    print_ch((u8)ch);    return ch;}  
写入数据到sram:
/*write log to bufffer or i/o*/void print_ch(u8 ch){    log_dev_ptr->buffer[log_dev_ptr->write_idx++] = ch;    if(log_dev_ptr->write_idx >= log_max_len){        log_dev_ptr->write_idx = 0;    }}  
为了方便控制log打印格式,在头文件中再添加自定义的打印函数
#ifdef debug_log_en#define debug(...)      printf(usb_printer:__va_args__)#else#define debug(...)#endif  
在需要打印log的地方直接调用debug()即可,最终效果如下,从memory窗口可以看到打印的log:
2、通过swo输出log
通过打印log到sram的方式可以看到log,但是数据量多的时候可能来不及查看就被覆盖了。为了解决这个问题,可以使用st-link的swo输出log,这样就不用担心log被覆盖。查看原理图f407 discovery的swo已经连接了,否则需要自己飞线连接:
在log结构体中添加swo的操作函数集:
typedef struct{    u8 (*init)(void* arg);    u8 (*print)(u8 ch);    u8 (*print_dma)(u8* buffer, u32 len);}log_func;typedef struct {    volatile u8     type;    u8*             buffer;    volatile u32    write_idx;    volatile u32    read_idx;    //swo    log_func*       swo_log_func;}log_dev;  
swo只需要print操作函数,实现如下:
u8 swo_print_ch(u8 ch){    itm_sendchar(ch);    return 0;}  
使用swo输出log同样先输出到log buffer,然后在系统空闲时再输出,当然也可以直接输出。log延迟输出会影响log的实时性,而直接输出会影响到对时间敏感的代码运行,所以如何取舍取决于需要输出log的情形。
在while循环中调用output_ch()函数,就可以实现在系统空闲时输出log。
/*output log buffer to i/o*/void output_ch(void){       u8 ch;    volatile u32 tmp_write,tmp_read;    tmp_write = log_dev_ptr->write_idx;    tmp_read = log_dev_ptr->read_idx;    if(tmp_write != tmp_read)    {        ch = log_dev_ptr->buffer[tmp_read++];        //swo        if(log_dev_ptr->swo_log_func)            log_dev_ptr->swo_log_func->print(ch);        if(tmp_read >= log_max_len)        {            log_dev_ptr->read_idx = 0;        }        else        {            log_dev_ptr->read_idx = tmp_read;        }    }}  
2.1 通过ide输出
使用ide中swo输出功能需要做如下配置(keil):
在窗口可以看到输出的log:
2.2 通过stm32 st-link utility输出
使用stm32 st-link utility不需要做特别的设置,直接打开st-link菜单下的printf via swo viewer,然后按start:
3、通过串口输出log
以上都是在串口log暂时无法使用,或者只是临时用一下的方法,而适合长期使用的还是需要通过串口输出log,毕竟大部分时候没法连接仿真器。添加串口输出log只需要添加串口的操作函数集即可:
typedef struct {    volatile u8     type;    u8*             buffer;    volatile u32    write_idx;    volatile u32    read_idx;    volatile u32    dma_read_idx;    //uart    log_func*       uart_log_func;    //swo    log_func*       swo_log_func;}log_dev;  
实现串口驱动函数:
log_func uart_log_func = {    uart_log_init,    uart_print_ch,    0,};  
添加串口输出log与通过swo过程类似,不再多叙述。而下面要讨论的问题是,串口的速率较低,输出数据需要较长时间,严重影响系统运行。
虽然可以通过先打印到sram再延时输出的办法来减轻影响,但是如果系统中断频繁,或者需要做耗时运算,则可能会丢失log。要解决这个问题,就是要解决cpu与输出数据到串口同时进行的问题,嵌入式工程师立马可以想到dma正是好的解决途径。
使用dma搬运log数据到串口输出,同时又不影响cpu运行,这样就可以解决输出串口log耗时影响系统的问题。串口及dma初始化函数如下:
u8 uart_log_init(void* arg){    dma_inittypedef dma_initstructure;    u32* bound = (u32*)arg;    //gpio端口设置    gpio_inittypedef gpio_initstructure;    usart_inittypedef usart_initstructure;    rcc_ahb1periphclockcmd(rcc_ahb1periph_gpioa,enable); //使能gpioa时钟    rcc_apb1periphclockcmd(rcc_apb1periph_usart2,enable);//使能usart2时钟    //串口2对应引脚复用映射    gpio_pinafconfig(gpioa,gpio_pinsource2,gpio_af_usart2);    //usart2端口配置    gpio_initstructure.gpio_pin = gpio_pin_2;    gpio_initstructure.gpio_mode = gpio_mode_af;//复用功能    gpio_initstructure.gpio_speed = gpio_speed_50mhz;   //速度50mhz    gpio_initstructure.gpio_otype = gpio_otype_pp; //推挽复用输出    gpio_initstructure.gpio_pupd = gpio_pupd_up; //上拉    gpio_init(gpioa,&gpio_initstructure);    //usart2初始化设置    usart_initstructure.usart_baudrate = *bound;//波特率设置    usart_initstructure.usart_wordlength = usart_wordlength_8b;//字长为8位数据格式    usart_initstructure.usart_stopbits = usart_stopbits_1;//一个停止位    usart_initstructure.usart_parity = usart_parity_no;//无奇偶校验位    usart_initstructure.usart_hardwareflowcontrol = usart_hardwareflowcontrol_none;//无硬件数据流控制    usart_initstructure.usart_mode = usart_mode_tx; //收发模式    usart_init(usart2, &usart_initstructure); //初始化串口1    #ifdef log_uart_dma_en      usart_dmacmd(usart2,usart_dmareq_tx,enable);    #endif      usart_cmd(usart2, enable);  //使能串口1     usart_clearflag(usart2, usart_flag_tc);    while (usart_getflagstatus(usart2, usart_flag_tc) == reset);    #ifdef log_uart_dma_en    rcc_ahb1periphclockcmd(rcc_ahb1periph_dma1, enable);    //config dma channel, uart2 tx usb dma1 stream6 channel    dma_deinit(dma1_stream6);    dma_initstructure.dma_channel = dma_channel_4;    dma_initstructure.dma_peripheralbaseaddr = (uint32_t)(&usart2->dr);    dma_initstructure.dma_dir = dma_dir_memorytoperipheral;    dma_initstructure.dma_peripheralinc = dma_peripheralinc_disable;    dma_initstructure.dma_memoryinc = dma_memoryinc_enable;    dma_initstructure.dma_peripheraldatasize = dma_peripheraldatasize_byte;    dma_initstructure.dma_memorydatasize = dma_peripheraldatasize_byte;    dma_initstructure.dma_mode = dma_mode_normal;    dma_initstructure.dma_priority = dma_priority_high;    dma_initstructure.dma_fifomode = dma_fifomode_disable;     dma_initstructure.dma_memoryburst = dma_memoryburst_single;    dma_initstructure.dma_peripheralburst = dma_peripheralburst_single;    dma_init(dma1_stream6, &dma_initstructure);    rcc_ahb1periphclockcmd(rcc_ahb1periph_dma1, enable);    #endif    return 0;}  
dma输出到串口的函数如下:
u8 uart_print_dma(u8* buffer, u32 len){    if((dma1_stream6->cr & dma_sxcr_en) != reset)    {        //dma not ready        return 1;    }    if(dma_getflagstatus(dma1_stream6,dma_it_tcif6) != reset)    {        dma_clearflag(dma1_stream6,dma_flag_tcif6);        dma_cmd(dma1_stream6,disable);    }    dma_setcurrdatacounter(dma1_stream6,len);    dma_memorytargetconfig(dma1_stream6, (u32)buffer, dma_memory_0);    dma_cmd(dma1_stream6,enable);    return 0;}  
这里为了方便直接使用了查询dma状态寄存器,有需要可以修改为dma中断方式,查datasheet可以找到串口2使用dma1 channel4的stream6:
最后在pc端串口助手可以看到log输出:
使用dma搬运log buffer中数据到串口,同时cpu可以处理其他事情,这种方式对系统影响最小,并且输出log及时,是实际使用中用的最多的方式。并且不仅可以用串口,其他可以用dma操作的接口(如spi、usb)都可以使用这种方法来打印log。
4、使用io模拟串口输出log
最后要讨论的是在一些封装中没有串口,或者串口已经被用作其他用途时如何输出log,这时可以找一个空闲的普通io,模拟uart协议输出log到上位机的串口工具。常用的uart协议如下:
只要在确定的时间在io上输出高低电平就可以模拟出波形,这个确定的时间就是串口波特率。为了得到精确延时,这里使用tim4定时器产生1us的延时。注意:定时器不能重复用,在测试工程中tim2、3都被用了,如果重复用就错乱了。初始化函数如下:
u8 simu_log_init(void* arg){    tim_timebaseinittypedef tim_initstructure;      u32* bound = (u32*)arg;    //gpio端口设置    gpio_inittypedef gpio_initstructure;    rcc_ahb1periphclockcmd(rcc_ahb1periph_gpioa,enable); //使能gpioa时钟    gpio_initstructure.gpio_pin = gpio_pin_2;    gpio_initstructure.gpio_mode = gpio_mode_out;    gpio_initstructure.gpio_speed = gpio_speed_50mhz;   //速度50mhz    gpio_initstructure.gpio_otype = gpio_otype_pp; //推挽复用输出    gpio_initstructure.gpio_pupd = gpio_pupd_up; //上拉    gpio_init(gpioa,&gpio_initstructure);    gpio_setbits(gpioa, gpio_pin_2);    //config tim    rcc_apb1periphclockcmd(rcc_apb1periph_tim4,enable); //使能tim4时钟    tim_deinit(tim4);    tim_initstructure.tim_prescaler = 1;        //2分频    tim_initstructure.tim_countermode = tim_countermode_up;    tim_initstructure.tim_period = 41;          //1us timer    tim_initstructure.tim_clockdivision = tim_ckd_div1;    tim_timebaseinit(tim4, &tim_initstructure);    tim_clearflag(tim4, tim_flag_update);    baud_delay = 1000000/(*bound);          //根据波特率计算每个bit延时    return 0;}  
使用定时器的delay函数为:
void simu_delay(u32 us){    volatile u32 tmp_us = us;    tim_setcounter(tim4, 0);    tim_cmd(tim4, enable);    while(tmp_us--)    {        while(tim_getflagstatus(tim4, tim_flag_update) == reset);        tim_clearflag(tim4, tim_flag_update);    }       tim_cmd(tim4, disable);}  
最后是模拟输出函数,注意:输出前必须要关闭中断,一个byte输出完再打开,否则会出现乱码:
u8 simu_print_ch(u8 ch){    volatile u8 i=8;    __asm(cpsid i);    //start bit    gpio_resetbits(gpioa, gpio_pin_2);    simu_delay(baud_delay);    while(i--)    {        if(ch & 0x01)        gpio_setbits(gpioa, gpio_pin_2);        else        gpio_resetbits(gpioa, gpio_pin_2);        ch >>= 1;        simu_delay(baud_delay);    }    //stop bit    gpio_setbits(gpioa, gpio_pin_2);    simu_delay(baud_delay);    simu_delay(baud_delay);    __asm(cpsie i);    return 0;}  
使用io模拟可以达到与真实串口类似的效果,并且只需要一个普通io,在小封装芯片上比较使用。
总结
介绍了几种开发中使用过的打印调试信息的方法,方法总是死的,关键在于能灵活使用;通过打印有效的调试信息,可以帮助解决开发及后期维护中遇到的问题,少走弯路。


焊接机器人出现焊偏怎么办,该如何解决
局部中浓电解液实现高比能锂金属电池的构建
Microchip推出全新时钟缓冲器 远超PCIe®第五代(Gen 5)防抖标准
什么是MIPS,PowerPC是什么?
疫情下的5G建设是机遇还是阻碍
嵌入式开发输出调试信息的几种方法
GSMA发布报告:中国将成为5G商用的领跑者
中国电信发布了今年100G DWDM/OTN设备集中采购项目第一批中标结果
中国晶圆,震撼世界!全球第二!
APS生产计划排产助力智能装备行业智能化
香橙派Orange Pi AI Stick 2801解析
DCS在热电厂机组改造后的效果及其应用
智能制造的发展对于智慧交通有何影响
Arm架构在中国市场的潜力与隐忧
电缆接地箱的电缆护层如何进行安装
CAN总线与以太网嵌入式网关电路设计之间有什么差异
日本将关闭多家加密货币交易所
三星note7爆炸之后苹果不甘落后iphone6plus玩自燃
国家信息光电子创新中心成立,光通信行业强“芯”之旅正式起航
米家行车记录仪正式发布,只需349元