使用ITM機制實現調試stm32單片機,實現printf與scanf。
1. ITM簡介
ITM機制是一種調試機制,是新一代調試方式,在這之前,有一種比較出名的調試方式,稱爲半主機(semihosting)方式。
在pc上編寫過C語言的人都知道,printf可以向控制檯輸出,scanf可以從控制檯獲取輸入,這裏的printf/scanf都是標準庫函數,利用操作系統的這些函數,我們可以很方便的調試程序。在嵌入式設備上(如stm32單片機平臺上)開發工具(如MDK/IAR)也都提供了標準庫函,自然也提供了printf/scanf函數,那麼這些函數是否可以使用呢? 問題來了,printf向哪裏輸出呢?並且大部分情況下,也沒有鍵盤,又如何使用scanf實現輸入呢?
我們都知道,嵌入式設備一般的使用仿真器,如常見Jlink/ulink,可以實現燒錄,單步,下斷點,查看變量,等等。仿真器將PC機和單片機連接器來。聰明的設計者們就在考慮是否可以藉助仿真器,使得單片機可以藉助PC機的屏幕以及PC機的鍵盤實現printf的輸出和scanf的按鍵獲取。
也就是說,如下的hello,world程序
- #include <stdio.h>
- int main()
- {
- //硬件初始化
- //....
- printf("hello, world");
- for(;;);
- }
這個程序燒錄到單片機中後,仿真器連接接單片機與PC,開始在線調試後,那麼這個程序會將"Hello, world"輸出到PC機上,在開發工具(MDK/IAR等)的某個窗口中顯示。
這就相當於,單片機藉助了PC機的顯示/輸入設備實現了自己的輸出/輸入。這種方式無疑可以方便程序開發者調試。
這種機制有多種實現方式,比較著名的就是semihosting(半主機機制)和ITM機制。
ITM是ARM在推出semihosting之後推出的新一代調試機制。現在我們來嘗試一下這種方式調試。
2. stm32使用ITM調試
MCU:stm32f207VG
仿真器:Jlink V8
IDE:MDK4.50
2.1 硬件連接
ITM機制要求使用SWD方式接口,並需要連接SWO線,一般的四線SWD方式(VCC SDCLK,SDIO,GND)是不行的。標準的20針JTAG接口是可以的,只需要在MDK裏設置使用SWD接口即可。
2.2 添加重定向文件
將下面的文件保存成任意C文件,並添加到工程中。這裏對這個文件簡單說明一下,要知道我們的程序是在單片機上運行的,爲什麼printf可以輸出到MDK窗口裏去呢?這是因爲 標準庫中的printf實際上調用 fputc實現輸出,所以我們需要自己編寫一個fputc函數,這個函數會藉助ITM(類似於USART)提供的寄存器,實現數據的發送,仿真器會收到這些數據,併發往PC機。
實際上,如果你的單片機和一塊LCD連接,那麼你只需要重新實現fputc函數,並向LCD上輸出即可,那麼你調用printf時就會輸出到LCD上了。這中機制,就是所謂的重定向機制。
- #include <stdio.h>
- #define ITM_Port8(n) (*((volatile unsigned char *)(0xE0000000+4*n)))
- #define ITM_Port16(n) (*((volatile unsigned short*)(0xE0000000+4*n)))
- #define ITM_Port32(n) (*((volatile unsigned long *)(0xE0000000+4*n)))
- #define DEMCR (*((volatile unsigned long *)(0xE000EDFC)))
- #define TRCENA 0x01000000
- struct __FILE { int handle; /* Add whatever you need here */ };
- FILE __stdout;
- FILE __stdin;
- int fputc(int ch, FILE *f)
- {
- if (DEMCR & TRCENA)
- {
- while (ITM_Port32(0) == 0);
- ITM_Port8(0) = ch;
- }
- return(ch);
- }
2.2 配置JLINK的初始化配置文件
將下面文件放置在你的工程下,並取任意名稱,這裏筆者取名爲 STM32DBG.ini
- /******************************************************************************/
- /* STM32DBG.INI: STM32 Debugger Initialization File */
- /******************************************************************************/
- // <<< Use Configuration Wizard in Context Menu >>> //
- /******************************************************************************/
- /* This file is part of the uVision/ARM development tools. */
- /* Copyright (c) 2005-2007 Keil Software. All rights reserved. */
- /* This software may only be used under the terms of a valid, current, */
- /* end user licence from KEIL for a compatible version of KEIL software */
- /* development tools. Nothing else gives you the right to use this software. */
- /******************************************************************************/
- FUNC void DebugSetup (void) {
- // <h> Debug MCU Configuration
- // <o1.0> DBG_SLEEP <i> Debug Sleep Mode
- // <o1.1> DBG_STOP <i> Debug Stop Mode
- // <o1.2> DBG_STANDBY <i> Debug Standby Mode
- // <o1.5> TRACE_IOEN <i> Trace I/O Enable
- // <o1.6..7> TRACE_MODE <i> Trace Mode
- // <0=> Asynchronous
- // <1=> Synchronous: TRACEDATA Size 1
- // <2=> Synchronous: TRACEDATA Size 2
- // <3=> Synchronous: TRACEDATA Size 4
- // <o1.8> DBG_IWDG_STOP <i> Independant Watchdog Stopped when Core is halted
- // <o1.9> DBG_WWDG_STOP <i> Window Watchdog Stopped when Core is halted
- // <o1.10> DBG_TIM1_STOP <i> Timer 1 Stopped when Core is halted
- // <o1.11> DBG_TIM2_STOP <i> Timer 2 Stopped when Core is halted
- // <o1.12> DBG_TIM3_STOP <i> Timer 3 Stopped when Core is halted
- // <o1.13> DBG_TIM4_STOP <i> Timer 4 Stopped when Core is halted
- // <o1.14> DBG_CAN_STOP <i> CAN Stopped when Core is halted
- // </h>
- _WDWORD(0xE0042004, 0x00000027); // DBGMCU_CR
- _WDWORD(0xE000ED08, 0x20000000); // Setup Vector Table Offset Register
- }
- DebugSetup(); // Debugger Setup
這裏對這個文件做簡單的解釋,
_WDWORD(0xE0042004, 0x00000027); // DBGMCU_CR
這一句表示想 0xE0042004地址處寫入 0x000000027,這個寄存器是各個位表示的含義在註釋中給出了詳細的解釋。 0x27即表示
BIT0 DBG_SLEEP
BIT1 DBG_STOP
BIT2 DBG_STANDBY
BIT5 TRACE_IOEN
注意,要使用ITM機制,必須要打開BIT5。
打開MDK工程,按照下圖修改。
2.3 MDK中對JLINK的配置
下圖中注意兩點
1). 這裏的CoreClock是120M,因爲筆者使用的是stm32F207VG這款芯片,並且時鐘配置爲120M,所以這裏填入120M,如果你使用stm32F10x,時鐘配置成72M,那麼這裏需要填入72M。即需要跟實際情況保持一致。
2). 最後一定要將 0處打勾,並將其他bit位上的勾去掉,最好與此圖保持一致,除CoreClock外。
2.4 燒錄程序,並啓動調試。可以看到,筆者在程序源碼中插入了一句printf語句輸出,然後按照下圖,就可以看到程序的輸出了。
3. 綜合版本使用scanf和printf
3.1 添加retarget文件
將如下代碼保存成retarget.c,然後加入到工程中。
- #pragma import(__use_no_semihosting_swi)
- struct __FILE { int handle; /* Add whatever you need here */ };
- FILE __stdout;
- FILE __stdin;
- int fputc(int ch, FILE *f)
- {
- return ITM_SendChar(ch);
- }
- volatile int32_t ITM_RxBuffer;
- int fgetc(FILE *f)
- {
- while (ITM_CheckChar() != 1) __NOP();
- return (ITM_ReceiveChar());
- }
- int ferror(FILE *f)
- {
- /* Your implementation of ferror */
- return EOF;
- }
- void _ttywrch(int c)
- {
- fputc(c, 0);
- }
- int __backspace()
- {
- return 0;
- }
- void _sys_exit(int return_code)
- {
- label:
- goto label; /* endless loop */
- }
3.2 編譯運行
編譯,燒錄,運行,打開Debug (printf) viewer,就可以看到輸入,參看下圖
這裏對retarget.c文件做幾點說明.
1). 上面的代碼實際是在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中。
3) 查看函數的符號引用關係,可以通過生成詳細的map文件來查看。命令行增加 --verbose --list rtt.map選項即可生成名爲rtt.map的文件。
4. ITM與RTT結合(待實現)
grissiom 寫道:
忽然想到,或許可以把這個半主機做成 device,然後 rt_console_set_device("semi") 就可以直接用半主機做 finsh/rt_kprintf 了…… 不知可行不可行……
prife: ITM的接收不知道是否支持中斷,目前接收字符使用是輪詢方式。如果是中斷纔有意義。這樣可以把ITM設備做成一個 rtt 的device了,讓finsh跑在 Debug printf Viewer窗口上。以後只要接一個jtag/SWD口就可以調試了,不用再接串口線了
參考文獻
[1] MDK help. Indirect semihosting C library function dependencies
[2] MDK help ARM Development Tools.
Debugger Adapter User's Guides
J-Link/J-Trace User's Guide
Libraries and Floating Point Support Referencee
Libraries and Floating Point Support Guide
Linker Reference Guide