【源码】STM32的printf重定向解决方案—

【源码】STM32的printf重定向解决方案——史上最强？

[复制链接]

radio2radio 发布时间：2020-12-13 19:15

文章
文章封面:	-
文章简介:	-

为什么要用printf，废话，不用你用啥？我在下面的把printf换了一个名，LOG，少打3个字。您也可以换成您喜欢的字母组合，这不是重点。

说是“解决方案+史上最强”，也不过就是下面的几行代码。
笔者仅在CubeMX+HAL+MDK+AC5下，测试过F1和F4。其他环境要修改后使用。

#include <stdio.h>* x+ u: H6 z; O9 J! J* R
#include <stdlib.h>" ?, d0 q- J4 a2 p2 ?
#include <string.h>6 ?% S U! p: ]: E
6 B2 Q) m' _# T+ E% h. t
//Debug mode On/Off switch $ f& W% F7 E$ }, S+ ^
#define DEBUG 1 //set=0, disable all LOG lines
- Z, q" B1 a4 q5 [) I
2 `$ i/ H. O* `/ |4 G) c
//select one of the following "printf" retarget methods
% a5 w7 J" m( `3 T1 Y5 }. |! o
#define PRINTF_UART 0 //printf using UART port, 1-use this, 0-not. U' ]5 P. N1 q4 L, t4 X/ J
#define PRINTF_RTT 1 //printf using Segger RTT, 1-use this, 0-not
! d6 I, G; Y! ^
#define PRINTF_SWO 0 //printf using SWO port, 1-use this, 0-not% a( I1 \/ T+ ]8 p& S5 p3 }, l
#define PRINTF_CDC 0 //printf using USBD_CDC, 1-use this, 0-not
/ G8 n% k% \% O' h! u
1 T6 x8 L# W- O) N
#if ((PRINTF_UART + PRINTF_CDC + PRINTF_SWO + PRINTF_RTT) != 1)
, y. F$ k; [( [5 P% ~3 V* R
#error "!!!!!! printf retarget function Not define or Multi-defined !!!!!!"
: f6 N" N3 s# Y
#endif
& I) U/ N0 j' y3 Y- j
8 [8 ^4 n, M, A& w
#if DEBUG
% ?% A# A5 r3 E, T \9 V
#if PRINTF_RTT
" t! H# S: f# f9 ?9 p% y4 f
#include "SEGGER_RTT.h"' k$ \- l l* B* x
#define LOG(format, args...) SEGGER_RTT_printf(0, "[%s:%d] "format, __FILE__, __LINE__, ##args)
% V$ a, p1 z2 F* s5 v! v* M' x
#define printf(format, args...) SEGGER_RTT_printf(0, format, ##args)' x/ n; a; V5 o( }2 ?4 I2 h# O
1 u5 O1 D' d/ J0 d0 U
#else //#if PRINTF_RTT" ^/ x2 f! h# h0 b% `% _
#define LOG(format, args...) printf("[%s:%d] "format, __FILE__, __LINE__, ##args)
0 @' u( D8 O9 _
% f' r# c: \ x' q4 G: j G7 Z
#if PRINTF_CDC
: n$ |! q2 ]$ d6 a# X$ G
#include "usbd_cdc_if.h"7 Z& T9 o8 E! j2 R( _; p
#endif7 J% A" `6 G: S2 O, F! w; x
, Q. K8 b V& q: B- e! o2 b
int fputc(int ch, FILE *f)/ G/ Z8 e# k7 X G
{
# F7 O6 m* ?) K2 f V0 y4 b+ `1 K! }
#if PRINTF_UART
1 C( Y' |4 }! r& e) \3 ^) t
HAL_UART_Transmit(&huart3, (uint8_t*)(&ch), 1, 1000); //UART3
U+ a3 m0 A9 s7 a
1 ]' J" C# {# C- P2 ]/ V9 `- z
#elif PRINTF_SWO+ V) Y0 K) }/ E
ITM_SendChar(ch);
3 E" Q- j7 L$ u" m: V( {
* }3 s2 b0 n0 N+ v9 N; j
#elif PRINTF_CDC( w, ~: {* Z5 R. B* P; `2 s
uint8_t u8Temp = 0;
- N$ X, S6 k. \/ N( w3 e9 Q5 g9 Y
while(CDC_Transmit_FS((uint8_t*)(&ch), 1) != USBD_OK)
9 L% S* I$ {4 W4 {
{2 m0 H' N6 U; X O7 o2 @
HAL_Delay(1);$ X( J3 ]; o3 j& C
if (++u8Temp >= 3) break;! n1 M7 ^5 A" o% z7 Z' o% c
}
" i, e3 v: n5 B1 p' h
#endif //#if PRINTF_UART; [6 U( Q* T4 e4 A
$ J3 V) k9 j6 L& S
return(ch);8 `0 T. |' m+ }/ c: L8 G
}' b$ v. [8 a" e" y9 X; h
#endif //#if PRINTF_RTT( r% @0 ^0 O* s0 B1 h
4 A. n5 K% ]9 t; D: B9 w5 }, o
#else //#if DEBUG == 09 n# V p0 n& h# u" i9 h
#define LOG(args...) //disable all LOGs when compiling5 `7 E$ P+ P' G8 L" e% L2 D1 z# ?1 I
#endif //#if DEBUG6 c2 U& A1 a' A

复制代码

这里有4种方法重定向printf，必有一款适合你：

1. PRINTF_UART == 1，串口方法。
优点：就是最多人使用的，大家也最熟悉。配置简单，容易使用。各种“PC终端软件”都能用。
缺点：硬件上要有串口可以用，有时还需要UART转USB接口板（或者仿真器自带VCP/CDC的东东）配合。

2. PRINTF_RTT == 1，Segger_RTT 方法。  （笔者推荐此方法，至少值得尝试一次），要安装RTT包，简单！
优点：不占用额外的硬件资源，据说速度超级快。有多快，我不知道。
缺点：要使用专用的PC软件接收，既然是仿真器大佬Segger的产品，自然是Segger的驱动程序功能多多。
         使用J-LINK仿真器，就一定要用JLinkRTTViewer等终端软件。
         使用CMSIS-DAP仿真器，可以用DRTTView终端软件，多谢XIVN1987网友，不然DAP就不能用RTT了。
         使用STLINK仿真器，对不起，用不了。

3. PRINTF_SWO == 1，SWO的方法，这个是启动内核的ITM功能。
优点：对原程序流的影响最小。标准的JTAG/SWD/STLINK连接器，都已经准备好了SWO线，也算方便。
缺点：相比2线的SWD，需要硬件连接一条SWO的输出线。不能实现双向通信（其他方法都能）。
         软件配置SWO功能比较复杂很容易失败，重点是要做SWO速度匹配。
         SWO方法不能在JTAG模式下使用，只能是SWD模式。另外，ARM Cotex-M0/M0+也不能用。
         MDK/Keil有内置的SWO Viewer，不过不好用，一定要进入Debug模式，好处是各种仿真器都可以用。
         J-LINK 和 STLINK 仿真器，有自己的独立的SWO Viewer，不需要Keil进入Debug模式那么麻烦。

4. PRINTF_CDC == 1， CDC的方法，比较逆天的，属于玩具级别，你想用我都拦不住。
优点：用法与UART一样，各种串口终端软件通杀。
         不占用串口。利用IC本身的CDC-VCP节省了UART转USB接口板。
缺点： IC要有USB硬件，代码增加，软件复杂度增加。

实用中，还有一种方法，称为半主机模式（semihosting），据说速度慢和影响原程序运行严重，没有认真研究过。我甚至怀疑，上面的4种方法里面，有可能有后台使用了半主机模式，知道详情的朋友，请介绍一下。

毕竟printf指令对原程序流是多余的操作，或多或少都会干扰原程序流，特别是在一些速度比较慢的MCU上面。因此，printf的输出项要尽量简短，避免大量连续使用。如果估计占用MCU时间太多，就要做需求评估。

附件是F103/F407用的完整的工程，与github上传的一样，上面的4种方法都有，可以试一试实现。
github：https://github.com/RadioOperator/STM32_HAL_retarget_printf