本文主要介绍在嵌入式开发中用来输出log的方法。
( V2 r2 m9 m! o' e. o7 v9 ^

    最常用的是通过串口输出uart log，这种方法实现简单，大部分嵌入式芯片都有串口功能。但是这样简单的功能有时候却不是那么好用，比如：

• 一款新拿到的芯片，没有串口驱动时如何打印log
• 某些应用下对时序要求比较高，串口输出log占用时间太长怎么办？比如USB枚举。
• 某些bug正常运行时会出现，当打开串口log时又不再复现怎么办
• 一些封装中没有串口，或者串口已经被用作其他用途，要如何输出log
  
  

    下文来讨论这些问题。
% T; x) j2 Q& i& M; b& v

1 输出log信息到SRAM

    准确来说这里并不是输出log，而是以一种方式不使用串口就可以看到log。在芯片开发阶段都可以连接仿真器调试，可以使用打断点的方法调试，但是有些操作如果不能被打断就没法使用断点调试了。    这时候可以考虑将log打印到SRAM中，整个操作结束后再通过仿真器查看SRAM中的log buffer，这样就实现了间接的log输出。本文使用的测试平台是STM32F407 discovery，基于usb host实验代码，对于其他嵌入式平台原理也是通用的。首先定义一个结构体用于打印log，如下:
* k" [; O6 W9 \" }

    定义一段SRAM空间作为log buffer:

1. static u8 log_buffer[LOG_MAX_LEN];

复制代码

7 M4 f) e: ^# L* ]; z

    log buffer是环形缓冲区，在小的buffer就可以无限打印log，缺点也很明显，如果log没有及时输出就会被新的覆盖。Buffer大小根据SRAM大小分配，这里使用1kB。为了方便输出参数，使用printf函数来格式化输出，需要做如下配置（Keil）：

5 g0 X" f- P9 F

    并包含头文件#include <stdio.h>, 在代码中实现函数fputc()：

5 B( [5 q, W$ |  }/ x

8 c9 j( i! g! y, ?7 i% H

    写入数据到SRAM：

( {6 Y6 n2 `: P+ I0 n& [( J

+ ^! Y2 g4 V; t, y' T* y    为了方便控制log打印格式，在头文件中再添加自定义的打印函数。

' n; [: r" Z; T7 a8 c' @

    在需要打印log的地方直接调用DEBUG()即可，最终效果如下，从Memory窗口可以看到打印的log：

  f* t$ \. j. l% A0 g2 M  {7 p0 r2 t; H

2 通过SWO输出log

, A% L! k3 d+ D5 Y$ ?% g# m& W

    通过打印log到SRAM的方式可以看到log，但是数据量多的时候可能来不及查看就被覆盖了。为了解决这个问题，可以使用St-link的SWO输出log，这样就不用担心log被覆盖。查看原理图f407 discovery的SWO已经连接了，否则需要自己飞线连接：
8 e! y- C# B3 k+ z

    在log结构体中添加SWO的操作函数集：

1. typedef struct
   
2. {
   5 R" W0 y  c$ q" [- N2 ^! o. V1 [
3.     u8 (*init)(void* arg);
   : D7 }& B2 `. I3 \3 w0 ~9 _
4.     u8 (*print)(u8 ch);
   / T3 _$ w) P. M
5.     u8 (*print_dma)(u8* buffer, u32 len);
   ; X2 _# l' z% }) x! F
6. }log_func;
   
7. 
   
8. typedef struct
   
9. {
   6 B$ _# T3 Q3 X/ n9 H: r8 f
10.     volatile u8     type;
    
11.     u8*             buffer;
    $ X0 j8 A  J; B
12.     volatile u32    write_idx;
    
13.     volatile u32    read_idx;
    
14.     //SWO
    " f  i. D6 H: x
15.     log_func*       swo_log_func;
    
16. }log_dev;

复制代码

& }% S' t& c, u- T' G# ^

    SWO只需要print操作函数，实现如下：

1. u8 swo_print_ch(u8 ch)
   & D( i' O. K2 H/ V
2. {
   # S8 g7 @- x$ L% r9 p+ O
3.     ITM_SendChar(ch);
   
4.     return 0;
   7 E' y$ n6 ^4 i9 E$ k6 z4 e
5. }

复制代码

& b2 |! g# t( a5 H

    使用SWO输出log同样先输出到log buffer，然后在系统空闲时再输出，当然也可以直接输出。log延迟输出会影响log的实时性，而直接输出会影响到对时间敏感的代码运行，所以如何取舍取决于需要输出log的情形。

    在while循环中调用output_ch()函数，就可以实现在系统空闲时输出log。

1. /*output log buffer to I/O*/
   
2. void output_ch(void)
   
3. {   
   # d4 H- g" r/ U8 K2 q* G" ^
4.     u8 ch;
   
5.     volatile u32 tmp_write,tmp_read;
   2 D! q7 v4 s: n( p/ D0 D$ c: i
6.     tmp_write = log_dev_ptr->write_idx;
   # l# e* Z: D# ?# K" X9 W6 g
7.     tmp_read = log_dev_ptr->read_idx;
   
8. 
   
9.     if(tmp_write != tmp_read)
   $ k* S  E& Z8 ]( c) I" F. b
10.     {
    
11.         ch = log_dev_ptr->buffer[tmp_read++];
    3 h7 [+ v  g- a, w
12.         //swo
    
13.         if(log_dev_ptr->swo_log_func)
    8 k  r6 f$ ?$ z- \$ U+ `
14.             log_dev_ptr->swo_log_func->print(ch);
    
15.         if(tmp_read >= LOG_MAX_LEN)
    . S7 g; [5 @$ t# A6 F: ~
16.         {
    
17.             log_dev_ptr->read_idx = 0;
    
18.         }
      J5 G* X  U3 q( D' ]: ]
19.         else
    ( l9 L$ n( J, t0 v
20.         {
    $ m, m4 x7 W1 x# R
21.             log_dev_ptr->read_idx = tmp_read;
    
22.         }
    
23.     }
    ! B0 I" {4 R0 `8 b8 B# K9 c+ w
24. }

复制代码

. v6 `. ]/ K. o& t. m, G" C

# _8 Z. x- Y1 o9 j6 n0 |2.1 通过IDE输出

    使用IDE中SWO输出功能需要做如下配置（Keil）：

( y9 Z* M& I) r& F, r2 k

    在窗口可以看到输出的log：

" a, g3 f- ]9 e7 o( ]3 w+ R% @2.2 通过STM32 ST-LINK Utility输出

    使用STM32 ST-LINK Utility不需要做特别的设置，直接打开ST-LINK菜单下的Printf via SWO viewer，然后按start：

3 通过串口输出log

    以上都是在串口log暂时无法使用，或者只是临时用一下的方法，而适合长期使用的还是需要通过串口输出log，毕竟大部分时候没法连接仿真器。添加串口输出log只需要添加串口的操作函数集即可：

1. typedef struct
   
2. {
   
3.     volatile u8     type;
   ' i- k% n# @7 N, O, j- T
4.     u8*             buffer;
   ; }9 `9 ^$ P9 i! f' A
5.     volatile u32    write_idx;
   / @" L  G  O5 M4 P+ u  B
6.     volatile u32    read_idx;
   
7.     volatile u32    dma_read_idx;
   
8.     //uart
   / G# R3 x% G0 L" {# u
9.     log_func*       uart_log_func;
   
10.     //SWO
    & @: @$ |9 r" |8 w
11.     log_func*       swo_log_func;
    
12. }log_dev;

复制代码

    实现串口驱动函数：

' L2 _; K' r3 i: ]

$ ?0 _9 D* m" l& a

    添加串口输出log与通过SWO过程类似，不再多叙述。而下面要讨论的问题是，串口的速率较低，输出数据需要较长时间，严重影响系统运行。

    虽然可以通过先打印到SRAM再延时输出的办法来减轻影响，但是如果系统中断频繁，或者需要做耗时运算，则可能会丢失log。要解决这个问题，就是要解决CPU与输出数据到串口同时进行的问题，嵌入式工程师立马可以想到DMA正是好的解决途径。

    使用DMA搬运log数据到串口输出，同时又不影响CPU运行，这样就可以解决输出串口log耗时影响系统的问题。串口及DMA初始化函数如下：

1. u8 uart_log_init(void* arg)
   
2. {
   * L% q7 m) ?. H" r: \
3.     DMA_InitTypeDef DMA_InitStructure;
   6 t9 y9 `! b: Z
4.     u32* bound = (u32*)arg;
   
5.     //GPIO端口设置
   9 }0 ?8 l, q* K& p6 n: f
6.     GPIO_InitTypeDef GPIO_InitStructure;
   , K; J2 V9 U  c
7.     USART_InitTypeDef USART_InitStructure;
   
8. 
   " ^" S: w* B3 B- a! t3 c3 s
9.     RCC_AHB1PeriphClockCmd(RCC_AHB1Periph_GPIOA,ENABLE); //使能GPIOA时钟
   * f" e- g8 R$ u7 H6 A
10.     RCC_APB1PeriphClockCmd(RCC_APB1Periph_USART2,ENABLE);//使能USART2时钟
    # O2 t5 e, S+ {0 G
11.     //串口2对应引脚复用映射
    
12.     GPIO_PinAFConfig(GPIOA,GPIO_PinSource2,GPIO_AF_USART2);
    
13.     //USART2端口配置
    
14.     GPIO_InitStructure.GPIO_Pin = GPIO_Pin_2;
    + K- O. d1 \+ t6 Q' V, p  i+ q$ j
15.     GPIO_InitStructure.GPIO_Mode = GPIO_Mode_AF;//复用功能
    - ^( E6 ^( {  R- E6 g( v, a2 l0 N
16.     GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;   //速度50MHz
    
17.     GPIO_InitStructure.GPIO_OType = GPIO_OType_PP; //推挽复用输出
    8 ?% D; i$ |1 H& \
18.     GPIO_InitStructure.GPIO_PuPd = GPIO_PuPd_UP; //上拉
    5 k  j0 i5 Z; Q1 X
19.     GPIO_Init(GPIOA,&GPIO_InitStructure);
    
20.     //USART2初始化设置
    
21.     USART_InitStructure.USART_BaudRate = *bound;//波特率设置
    
22.     USART_InitStructure.USART_WordLength = USART_WordLength_8b;//字长为8位数据格式
    
23.     USART_InitStructure.USART_StopBits = USART_StopBits_1;//一个停止位
    , d" b5 ?8 C) w/ \
24.     USART_InitStructure.USART_Parity = USART_Parity_No;//无奇偶校验位
    
25.     USART_InitStructure.USART_HardwareFlowControl = USART_HardwareFlowControl_None;//无硬件数据流控制
    * k# P* g7 b. M, [$ h
26.     USART_InitStructure.USART_Mode = USART_Mode_Tx; //收发模式
    2 x& \- a, z# L; `0 R! @
27.     USART_Init(USART2, &USART_InitStructure); //初始化串口1
    
28.     #ifdef LOG_UART_DMA_EN  
    
29.     USART_DMACmd(USART2,USART_DMAReq_Tx,ENABLE);
    5 V# J) V, L% [2 A" @
30.     #endif  
    
31.     USART_Cmd(USART2, ENABLE);  //使能串口1
    
32.     USART_ClearFlag(USART2, USART_FLAG_TC);
    * C8 J6 @! y: O& [
33.     while (USART_GetFlagStatus(USART2, USART_FLAG_TC) == RESET);
    # H7 o+ K$ P4 }1 V* V! `* T# Z
34.     #ifdef LOG_UART_DMA_EN
    
35.     RCC_AHB1PeriphClockCmd(RCC_AHB1Periph_DMA1, ENABLE);
    
36.     //Config DMA channel, uart2 TX usb DMA1 Stream6 Channel
    
37.     DMA_DeInit(DMA1_Stream6);
    
38.     DMA_InitStructure.DMA_Channel = DMA_Channel_4;
    2 p/ |) P/ a6 Y1 a, G& x
39.     DMA_InitStructure.DMA_PeripheralBaseAddr = (uint32_t)(&USART2->DR);
    / ~9 j- X1 k* k2 t/ q6 e& }- d
40.     DMA_InitStructure.DMA_DIR = DMA_DIR_MemoryToPeripheral;
    
41.     DMA_InitStructure.DMA_PeripheralInc = DMA_PeripheralInc_Disable;
    
42.     DMA_InitStructure.DMA_MemoryInc = DMA_MemoryInc_Enable;
    
43.     DMA_InitStructure.DMA_PeripheralDataSize = DMA_PeripheralDataSize_Byte;
    
44.     DMA_InitStructure.DMA_MemoryDataSize = DMA_PeripheralDataSize_Byte;
    
45.     DMA_InitStructure.DMA_Mode = DMA_Mode_Normal;
    ( S7 v7 E7 k$ `. X/ D  o6 Y; r
46.     DMA_InitStructure.DMA_Priority = DMA_Priority_High;
    8 o$ w. ~7 `, |1 V
47.     DMA_InitStructure.DMA_FIFOMode = DMA_FIFOMode_Disable;
    
48.     DMA_InitStructure.DMA_MemoryBurst = DMA_MemoryBurst_Single;
    
49.     DMA_InitStructure.DMA_PeripheralBurst = DMA_PeripheralBurst_Single;
    
50.     DMA_Init(DMA1_Stream6, &DMA_InitStructure);
    % U1 h; V; c2 w% z; [4 {
51.     RCC_AHB1PeriphClockCmd(RCC_AHB1Periph_DMA1, ENABLE);
    
52.     #endif
    
53.     return 0;
    
54. }

复制代码

    DMA输出到串口的函数如下：

9 W0 x$ Q$ F6 ?' g$ z! R

    这里为了方便直接使用了查询DMA状态寄存器，有需要可以修改为DMA中断方式，查Datasheet可以找到串口2使用DMA1 channel4的stream6：

: U& u9 x; m: t* G; U3 d

/ u3 c7 `! O$ s% E# M/ b

    最后在PC端串口助手可以看到log输出：

    使用DMA搬运log buffer中数据到串口，同时CPU可以处理其他事情，这种方式对系统影响最小，并且输出log及时，是实际使用中用的最多的方式。并且不仅可以用串口，其他可以用DMA操作的接口（如SPI、USB）都可以使用这种方法来打印log。

4 使用IO口模拟串口输出log

    最后要讨论的是在一些封装中没有串口，或者串口已经被用作其他用途时如何输出log，这时可以找一个空闲的普通IO，模拟UART协议输出log到上位机的串口工具。常用的UART协议如下：

7 n9 {4 L6 K+ x3 ]- k: N
7 b" C  v) m& m# _: P2 Y" W

    只要在确定的时间在IO上输出高低电平就可以模拟出波形，这个确定的时间就是串口波特率。为了得到精确延时，这里使用TIM4定时器产生1us的延时。注意：定时器不能重复用，在测试工程中TIM2、3都被用了，如果重复用就错乱了。初始化函数如下：

1. u8 simu_log_init(void* arg)
   
2. {
   ) o. X8 A$ m# g6 F# _- P
3.     TIM_TimeBaseInitTypeDef TIM_InitStructure;  
   8 _0 r/ v! f0 g7 X' I& `% Y
4.     u32* bound = (u32*)arg;
   # ?0 T) c* s* _
5.     //GPIO端口设置
   6 B0 ^+ N6 n! `  t
6.     GPIO_InitTypeDef GPIO_InitStructure;
   
7.     RCC_AHB1PeriphClockCmd(RCC_AHB1Periph_GPIOA,ENABLE); //使能GPIOA时钟
   6 y; {* R. N3 C
8.     GPIO_InitStructure.GPIO_Pin = GPIO_Pin_2;
   
9.     GPIO_InitStructure.GPIO_Mode = GPIO_Mode_OUT;
   ( j* e' ]' o  ]6 q+ C  ]0 _
10.     GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;   //速度50MHz
    & l( Y" v' ]( o6 V
11.     GPIO_InitStructure.GPIO_OType = GPIO_OType_PP; //推挽复用输出
    / l* {$ t; D/ V
12.     GPIO_InitStructure.GPIO_PuPd = GPIO_PuPd_UP; //上拉
    5 K+ }0 E$ A/ u
13.     GPIO_Init(GPIOA,&GPIO_InitStructure);
    " _. u5 b/ X  n+ W
14.     GPIO_SetBits(GPIOA, GPIO_Pin_2);
    ) _1 A* o% T+ e! ~( u8 V, w5 T
15.     //Config TIM
    
16.     RCC_APB1PeriphClockCmd(RCC_APB1Periph_TIM4,ENABLE); //使能TIM4时钟
    
17.     TIM_DeInit(TIM4);
    ' {& k; `7 M  V( S
18.     TIM_InitStructure.TIM_Prescaler = 1;        //2分频
    . _0 m4 C4 v3 l: T! j( R
19.     TIM_InitStructure.TIM_CounterMode = TIM_CounterMode_Up;
    * I& H2 J" f$ m5 |2 j1 [
20.     TIM_InitStructure.TIM_Period = 41;          //1us timer
    8 }) J6 S5 b( E" v' Q
21.     TIM_InitStructure.TIM_ClockDivision = TIM_CKD_DIV1;
    
22.     TIM_TimeBaseInit(TIM4, &TIM_InitStructure);
    
23.     TIM_ClearFlag(TIM4, TIM_FLAG_Update);
    ! D- @" L) h  M1 y8 I- Q; a
24.     baud_delay = 1000000/(*bound);          //根据波特率计算每个bit延时
    9 M/ ]% f& q, `
25.     return 0;
    9 j) t7 K+ f7 S; I7 o# ^7 \1 w  A
26. }

复制代码

    使用定时器的delay函数为：

* g3 k# {: l3 {& @* m8 X  G

    最后是模拟输出函数，注意：输出前必须要关闭中断，一个byte输出完再打开，否则会出现乱码：

1. 
   6 y. b& a" M  m  N& M. y- b- R
2. u8 simu_print_ch(u8 ch)
   
3. {
   
4.     volatile u8 i=8;
   1 B" ^9 T& z+ c* ~
5.     __asm("cpsid i");
   
6.     //start bit
   
7.     GPIO_ResetBits(GPIOA, GPIO_Pin_2);
   
8.     simu_delay(baud_delay);
   & K3 w( f6 N$ B9 Z; _
9.     while(i--)
   ( Q/ F9 d; |& h. B
10.     {
    8 {& F* a. j9 H3 _/ b7 J1 P8 o5 i
11.         if(ch & 0x01)
    
12.         GPIO_SetBits(GPIOA, GPIO_Pin_2);
    
13.         else
    
14.         GPIO_ResetBits(GPIOA, GPIO_Pin_2);
    
15.         ch >>= 1;
    
16.         simu_delay(baud_delay);
    1 E4 n, a% h+ m4 K  B; a
17.     }
    
18.     //stop bit
    
19.     GPIO_SetBits(GPIOA, GPIO_Pin_2);
    
20.     simu_delay(baud_delay);
    
21.     simu_delay(baud_delay);
    $ B& M: |3 g* q( h
22.     __asm("cpsie i");
    
23.     return 0;
    ; }% `, a7 B/ A/ q: ^
24. }

复制代码

) W5 d8 p- w; E8 R

    使用IO模拟可以达到与真实串口类似的效果，并且只需要一个普通IO，在小封装芯片上比较使用。

; H9 ~4 x: q: H# L2 F