使用ITM机制实现调试stm32单片机，实现printf与scanf。

8 r# O$ X( d) y' K1. ITM简介
* Y) H* X( _! g0 Q6 C4 lITM机制是一种调试机制，是新一代调试方式，在这之前，有一种比较出名的调试方式，称为半主机（semihosting）方式。
! u7 E- x$ C0 I( ?+ D3 \, B' w
- ]0 O  P; v' ]在pc上编写过C语言的人都知道，printf可以向控制台输出，scanf可以从控制台获取输入，这里的printf/scanf都是标准库函数，利用操作系统的这些函数，我们可以很方便的调试程序。在嵌入式设备上（如stm32单片机平台上）开发工具（如MDK/IAR）也都提供了标准库函，自然也提供了printf/scanf函数，那么这些函数是否可以使用呢？ 问题来了，printf向哪里输出呢？并且大部分情况下，也没有键盘，又如何使用scanf实现输入呢？

我们都知道，嵌入式设备一般的使用仿真器，如常见Jlink/ulink，可以实现烧录，单步，下断点，查看变量，等等。仿真器将PC机和单片机连接器来。聪明的设计者们就在考虑是否可以借助仿真器，使得单片机可以借助PC机的屏幕以及PC机的键盘实现printf的输出和scanf的按键获取。
% X* h& }: F$ u2 \% j* A* }也就是说，如下的hello，world程序

. r8 w' ]8 h) Z3 ]/ p% R8 \

1. #include <stdio.h>  
   ! g, u+ d# l" b- N8 F. H
2. int main()  
   
3. {  
   ' O5 H9 V4 ]4 O; |7 H5 n" _
4.         //硬件初始化  
   
5.         //....  
   2 _$ G6 g, u/ f0 @/ K
6.         printf("hello, world");  
   
7.         for(;;);  
   
8. }  

复制代码

. g$ k# H$ T8 S' H
( M  s' k$ ]# E: H# J1 `
( s' i" {/ M" g. c4 P3 b- G' p+ K这个程序烧录到单片机中后，仿真器连接接单片机与PC，开始在线调试后，那么这个程序会将"Hello, world"输出到PC机上，在开发工具（MDK/IAR等）的某个窗口中显示。
- X2 |; M/ b! X" J! N" K' w: f8 l
5 L! [) D9 L" r+ j这就相当于，单片机借助了PC机的显示/输入设备实现了自己的输出/输入。这种方式无疑可以方便程序开发者调试。

这种机制有多种实现方式，比较著名的就是semihosting（半主机机制）和ITM机制。
ITM是ARM在推出semihosting之后推出的新一代调试机制。现在我们来尝试一下这种方式调试。
6 h/ u( S( a. i8 i
- u% m. T: Y& Y( i* S6 z2. stm32使用ITM调试
4 m; [" [; k  z0 t' ZMCU：stm32f207VG
( J8 A" @7 Q  w- c6 x* C9 @仿真器：Jlink V8
IDE：MDK4.50
- i0 z8 ]4 s" X% D5 R0 _# i
6 y. v! K; V- n. @/ d2.1 硬件连接
! k" [0 U, Z2 Z" Z7 {0 d8 r9 kITM机制要求使用SWD方式接口，并需要连接SWO线，一般的四线SWD方式（VCC SDCLK，SDIO，GND）是不行的。标准的20针JTAG接口是可以的，只需要在MDK里设置使用SWD接口即可。
8 S) q( }; x% z7 D+ b" U2 R6 @
6 x% W3 ~7 q3 t0 y9 w/ {8 r( P. M2.2 添加重定向文件
6 q8 k% c' [2 a将下面的文件保存成任意C文件，并添加到工程中。这里对这个文件简单说明一下，要知道我们的程序是在单片机上运行的，为什么printf可以输出到MDK窗口里去呢？这是因为 标准库中的printf实际上调用 fputc实现输出，所以我们需要自己编写一个fputc函数，这个函数会借助ITM（类似于USART）提供的寄存器，实现数据的发送，仿真器会收到这些数据，并发往PC机。

  K  I9 z) C; |$ f  u1 K( N/ S实际上，如果你的单片机和一块LCD连接，那么你只需要重新实现fputc函数，并向LCD上输出即可，那么你调用printf时就会输出到LCD上了。这中机制，就是所谓的重定向机制。


8 P2 n; `# I% f, O7 O9 o4 r6 U

1. #include <stdio.h>  
   
2.   
   
3. #define ITM_Port8(n)    (*((volatile unsigned char *)(0xE0000000+4*n)))  
   
4. #define ITM_Port16(n)   (*((volatile unsigned short*)(0xE0000000+4*n)))  
   ! Y& L$ n& V% p- i5 M
5. #define ITM_Port32(n)   (*((volatile unsigned long *)(0xE0000000+4*n)))  
   
6. #define DEMCR           (*((volatile unsigned long *)(0xE000EDFC)))  
   
7. #define TRCENA          0x01000000  
   
8.   
   + ~$ z9 M7 J# i% b; J* U
9. struct __FILE { int handle; /* Add whatever you need here */ };  
     U: H' ?& l4 u  P# h" s/ O3 }
10.     FILE __stdout;  
    % a* x3 k* N& I; l8 G# i# E4 s' b
11.     FILE __stdin;  
    % ]! N6 S8 H7 n, r, L, C; y
12.       
    ! O) F+ s  U8 X1 k
13. int fputc(int ch, FILE *f)   
    / y9 y* x% l0 Q: E8 G, G
14. {  
    3 e4 U4 n/ l$ _1 c+ T# V3 s
15.     if (DEMCR & TRCENA)   
    
16.     {  
    
17.         while (ITM_Port32(0) == 0);  
    ; y- b! x3 M' l, m9 n. L! {
18.         ITM_Port8(0) = ch;  
    
19.     }  
    
20.     return(ch);  
    
21. }  

复制代码

% r. ~# F7 h8 a
2.2 配置JLINK的初始化配置文件
, O5 {; f# {4 c3 I  W; v
将下面文件放置在你的工程下，并取任意名称，这里笔者取名为 STM32DBG.ini
. u5 N  A% g* Y  ?6 q
  W4 }+ }( R+ [7 O

1. /******************************************************************************/  
   0 S! A- T( u1 L4 ~, P4 L" n# K
2. /* STM32DBG.INI: STM32 Debugger Initialization File                           */  
   
3. /******************************************************************************/  
   
4. // <<< Use Configuration Wizard in Context Menu >>>                           //   
   8 C# o$ b4 [5 t" Z
5. /******************************************************************************/  
   - B, N: j! \( E. V$ K" i$ K$ [
6. /* This file is part of the uVision/ARM development tools.                    */  
   + W; Z. @( s8 |5 O
7. /* Copyright (c) 2005-2007 Keil Software. All rights reserved.                */  
   
8. /* This software may only be used under the terms of a valid, current,        */  
   
9. /* end user licence from KEIL for a compatible version of KEIL software       */  
   " F! S1 g6 R  D+ u4 h# d
10. /* development tools. Nothing else gives you the right to use this software.  */  
    
11. /******************************************************************************/  
    
12.   
    
13.   
    5 C: }) \( ]( t6 v+ M) P+ O$ N
14. FUNC void DebugSetup (void) {  
    - y- b3 R4 l1 ?2 n7 R- X3 k
15. // <h> Debug MCU Configuration  
    % D0 ?5 ~. y8 h6 G4 Q$ s
16. //   <o1.0>    DBG_SLEEP     <i> Debug Sleep Mode  
    8 L3 l/ V  \  a6 Q* K, i. r
17. //   <o1.1>    DBG_STOP      <i> Debug Stop Mode  
    
18. //   <o1.2>    DBG_STANDBY   <i> Debug Standby Mode  
    5 i) p" n* ^- e
19. //   <o1.5>    TRACE_IOEN    <i> Trace I/O Enable   
    
20. //   <o1.6..7> TRACE_MODE    <i> Trace Mode  
    1 a1 B% N) F  @4 _
21. //             <0=> Asynchronous  
    
22. //             <1=> Synchronous: TRACEDATA Size 1  
    
23. //             <2=> Synchronous: TRACEDATA Size 2  
    
24. //             <3=> Synchronous: TRACEDATA Size 4  
    ' [3 h2 ~; ~; u3 c0 H
25. //   <o1.8>    DBG_IWDG_STOP <i> Independant Watchdog Stopped when Core is halted  
    
26. //   <o1.9>    DBG_WWDG_STOP <i> Window Watchdog Stopped when Core is halted  
    - s( V/ P5 P+ y% v4 m
27. //   <o1.10>   DBG_TIM1_STOP <i> Timer 1 Stopped when Core is halted  
    6 \" ]; q; C+ ^/ g' C% w
28. //   <o1.11>   DBG_TIM2_STOP <i> Timer 2 Stopped when Core is halted  
    
29. //   <o1.12>   DBG_TIM3_STOP <i> Timer 3 Stopped when Core is halted  
    7 g9 ^" e  J6 B8 I$ n0 e, E0 T
30. //   <o1.13>   DBG_TIM4_STOP <i> Timer 4 Stopped when Core is halted  
    
31. //   <o1.14>   DBG_CAN_STOP  <i> CAN Stopped when Core is halted  
    
32. // </h>  
    
33. _WDWORD(0xE0042004, 0x00000027);  // DBGMCU_CR  
    
34. _WDWORD(0xE000ED08, 0x20000000);   // Setup Vector Table Offset Register  
    ! s5 ^9 L0 ?2 l" A
35. }  
    % h" X5 E" a9 y% H0 ]& W  V
36.   
    1 B" b- z+ H) p0 w$ Z
37. DebugSetup();                       // Debugger Setup

复制代码

7 e; ^0 Y) b8 x* ?
这里对这个文件做简单的解释，
_WDWORD(0xE0042004, 0x00000027); // DBGMCU_CR
这一句表示想 0xE0042004地址处写入 0x000000027，这个寄存器是各个位表示的含义在注释中给出了详细的解释。 0x27即表示
        BIT0 DBG_SLEEP
4 J: L6 {& O; [' E        BIT1 DBG_STOP
        BIT2 DBG_STANDBY
3 U1 z$ p6 x; J8 O7 o        BIT5 TRACE_IOEN
% Y9 e2 q% q0 {- \) k, v) i注意，要使用ITM机制，必须要打开BIT5。
" H% Z. S% R3 q
打开MDK工程，按照下图修改。

. ^0 S2 m! X- g# b- C

2.3 MDK中对JLINK的配置
, f1 N2 W( j& x9 ^. V% S) [9 K9 T

7 h' L! \; K3 O2 {. D0 Q下图中注意两点
1). 这里的CoreClock是120M，因为笔者使用的是stm32F207VG这款芯片，并且时钟配置为120M，所以这里填入120M，如果你使用stm32F10x，时钟配置成72M，那么这里需要填入72M。即需要跟实际情况保持一致。
2). 最后一定要将 0处打勾，并将其他bit位上的勾去掉，最好与此图保持一致，除CoreClock外。

& W0 d0 Y% O4 Y6 r9 _, g) j/ |* C7 Y

) x7 [' K/ F$ R) _2 i& @2.4 烧录程序，并启动调试。可以看到，笔者在程序源码中插入了一句printf语句输出，然后按照下图，就可以看到程序的输出了。
; D. Y4 J& N  p

  V) [( N% `! I/ @$ q/ O, n

- G& H/ F0 G: {' I  c- g3. 综合版本使用scanf和printf
6 ]0 g0 ]7 G% N% q/ U/ T: \) s3.1 添加retarget文件
3 R; i$ M' y7 b7 D2 }# Z% ^将如下代码保存成retarget.c，然后加入到工程中。

5 l$ ]0 l$ y5 h! K6 t! J6 d
- U$ a0 d% L" p$ Y0 t, C, Z

1. #pragma import(__use_no_semihosting_swi)  
   ! o( D+ E5 |0 _$ d, w7 o
2.   
   
3. struct __FILE { int handle; /* Add whatever you need here */ };  
   
4.     FILE __stdout;  
   
5.     FILE __stdin;  
   - V9 g8 b; b. v" h1 e  _5 {
6.       
   4 w. U$ L" ~3 r8 r) b
7. int fputc(int ch, FILE *f)   
   ! U2 c$ }4 x$ a
8. {  
   
9.     return ITM_SendChar(ch);  
   
10. }  
    # A( \7 m" G5 T
11.   
    
12. volatile int32_t ITM_RxBuffer;  
    
13. int fgetc(FILE *f)  
    9 f% D" k% H% h4 M8 }, O: D
14. {  
    ) ^. a: m, s1 F, H3 w+ ~* ]8 ^
15.   while (ITM_CheckChar() != 1) __NOP();  
    
16.   return (ITM_ReceiveChar());  
    
17. }  
    9 N" T+ k4 p, @* P
18.   
    
19. int ferror(FILE *f)  
    3 C  ?3 i. E* h' y" V
20. {  
    
21.     /* Your implementation of ferror */  
    
22.     return EOF;  
    
23. }  
    & i* Q% r; I! n4 }# N! K& A
24.   
    
25. void _ttywrch(int c)  
      O% @& _) P. s# ^& q3 |: ]5 b' B
26. {  
    4 k, S( o% a2 Y
27.     fputc(c, 0);  
    9 s5 ]8 G5 Z9 z+ S
28. }  
    " L# I3 N( Z& w, @+ F
29.   
    1 T" R* p: ~; o8 c5 o
30. int __backspace()  
    ! G9 O& ?3 l% J. h! P  |
31. {  
    
32.     return 0;  
    8 X# G, h9 W) B! k
33. }  
    
34. void _sys_exit(int return_code)  
    
35. {  
    
36. label:  
    
37.     goto label;  /* endless loop */  
    + F% m2 E- _$ F, t. D1 A0 `
38. }  

复制代码

+ z0 B7 J" l0 O) {  F9 v1 h5 j
) F- D% x9 c) f
- t3 `# u2 y9 E5 m4 f, q3.2 编译运行
6 f2 p: R' }$ Q8 `6 @编译，烧录，运行，打开Debug (printf) viewer，就可以看到输入，参看下图
8 }3 `+ i3 T- E

: m# W$ \# n/ V0 J5 W0 K( _3 [

3 V7 a4 o. d0 m/ S- O. k" v' R# X" _这里对retarget.c文件做几点说明.
) H9 \1 X+ _' t8 T# n1). 上面的代码实际是在X:\Keil\ARM\Startup\Retarget.c上修改而成的，scanf依赖的函数共有两个，fgetc和__backspace都需要实现，如果缺少__backespace函数，则scanf胡无法从Debug Viewer Dialog 窗口获取输入。另外上面提供的代码只是个demo，用于演示效果，用于生产时应该处理的更完善一些。见参考文献[1]

2). 函数ITM_SendChar，ITM_CheckChar，ITM_ReceiveChar在库文件CMSIS\Include\core_cm3.h中。
! j8 W9 [) ]& \0 M. T4 G4 y9 F' T
3) 查看函数的符号引用关系，可以通过生成详细的map文件来查看。命令行增加 --verbose --list rtt.map选项即可生成名为rtt.map的文件。

& H8 Y7 X& l% f) F4. ITM与RTT结合(待实现)
2 X0 n$ K0 C9 {4 S( A0 ]$ c" Rgrissiom 写道:
! n# Q8 C# {& }6 E5 ]- U8 M忽然想到，或许可以把这个半主机做成 device，然后 rt_console_set_device("semi") 就可以直接用半主机做 finsh/rt_kprintf 了…… 不知可行不可行……
' K  v6 a; j& Q) V0 l7 r
0 w* @+ x! y" ?" Kprife: ITM的接收不知道是否支持中断，目前接收字符使用是轮询方式。如果是中断才有意义。这样可以把ITM设备做成一个 rtt 的device了，让finsh跑在 Debug printf Viewer窗口上。以后只要接一个jtag/SWD口就可以调试了，不用再接串口线了
% I7 J9 L# Z: S" W) z$ U

楼主厉害

学习，，来看看。。
6 t, _" q6 j8 T7 V& x8 ^+ z

搞不定，全是编译错误

赞赞！！！！