ITM,(英文:Instrumentation Trace Macrocell,指令跟踪宏单元),是一种针对MCU进行跟踪调试的新方法,与打断点(Breakpoint)不同,ITM方法不需要暂停程序运行,可以在程序全速运行的过程中实时输出变量的数值以便观察,即Trace功能。对于有一定产品开发经验的工程师而言,会马上意识到ITM的独到用处:调试跟“通讯”有关的代码将非常有用,后文将介绍一个调试USB设备应用代码的实例。文章分为下面几个部分:
1、ITM的硬件环境
2、ITM的软件环境与代码实现方式
3、ITM在KEIL MDK上的实现
7、ITM应用实例:USB设备(模拟一个鼠标)代码调试
其中1、2、3在本文中介绍,4、5、6、7分别在后续文章中介绍。
1、ITM的硬件环境
ITM可以理解为一个可以提供调试数据结果的MCU内部的东东,他首先是一个硬件存在,在Cortex-M3,M4,M7上都支持(很遗憾,性价比很高的M0,M0+是不支持的),在代码调试过程中,他与ST-LINK(或其他debugger设备)结合,可以实时查看MCU中变量的数值(其实ITM功能很强大,能显示时间戳、记录中断的进出等,本文不详述了),既然是实时的,就免不了有额外的硬件开销,使用ST-LINK打断点调试时,“信号”通路上只需要两根线:SWDIO和SWCLK,一个是双向的数据,一个是时钟信号。ITM则不同,除了这两根线,还需要额外的一个叫做SWO的信号线来传输Trace数据。也就是说,目标板MCU上会有一个pin跟ST-LINK的某一个pin连接,以ST官方的开发板NUCLEO-F411RE为例,其电路原理图如下,其中PB3用作了调试输出管脚SWO:
再来看板载ST-LINK的电路部分:
可见,MCU的PB3最终是跟ST-LINK上的PA10管脚相连接的(也就是说,市面上买到的ST-LINK,如果没有提供SWO管脚,是无法做ITM跟踪调试的,这个本人没有实测过,哪位网友如果知道是否能用ITM,请留言告知,谢谢),这样就具备了ITM调试的硬件基础。
2、ITM的软件环境与代码实现方式
有了正确的硬件连接作为调试基础,下面还要做两件事情:添加代码利用ITM输出我们想看的变量,同时配置主机上的IDE(KEIL,IAR,ST-LINK)来“接收”这个变量的数值。本文先不讲printf怎样通过“重定向”来实现,而是先实现一个最简单的单个字符的输出与接收,目的是验证整个调试的硬件环境和软件环境是否配置正确。
以 NUCLEO-F411RE 板子为例,使用STM32CUBEMX生成一个最简单的应用,能闪灯即可(小灯LD2的管脚是PA5),先让板子能正常跑起来。然后在main()中只需增加一个HAL函数调用:
ITM_SendChar('A');
这句话的意思是,通过ITM机制向调试器送出一个字符‘A’。
3、ITM在KEIL MDK上的实现
下面来配置KEIL工程选项来正确接收这个字符‘A’。所有配置都在KEIL工程Options -- Debug 选项卡中操作:
点击上图中的 Settings ,在弹出的窗口中选择 Trace 选项卡:
这里的配置非常重要,首先要将 Trace Enable 打勾,否则上图中大部分选项都是灰色的;然后要正确设置 Core Clock 的数值,这个就是你的目标板上MCU的实际运行频率,单位是MHz。这个频率数值必须输入正确,否则后面就看不到ITM的输出了。最后检查一下 ITM Stimulus Ports 中的“端口”0是否是打勾的。默认情况下,貌似所有Port都是打勾的,这也没问题的。至于 Privilege ,是否勾选不重要,不影响结果。这里所谓的Ports,是说ITM中有32个“端口”来输出变量数值,我们只使用了0#端口,所以把0#端口打上勾就行了。至于Privilege,相当于把8个端口编成一组,由Privilege来控制这一组端口是否使能,在MCU的代码中需要检查Privilege是否正确配置了(HAL函数中已经为我们配置好了),KEIL中不要管他,打不打勾都可以。
然后就是编译、下载、调试了。为了看到ITM的输出,还需要在KEIL中打开相应的观察窗口:
启动调试、并全速运行,在 Debug (printf)Viewer 窗口中将显示我们之前写的 ITM_SendChar('A'); 语句输出的字符A。
也许有细心的宝宝问了:上面的代码中没有指定ITM的端口0呀,为什么是在端口0输出的字符A呢?
ITM_SendChar()函数在 core_cm4.h 中定义:
__STATIC_INLINE uint32_t ITM_SendChar (uint32_t ch)
{
if (((ITM->TCR & ITM_TCR_ITMENA_Msk) != 0UL) && /* ITM enabled */
((ITM->TER & 1UL) != 0UL) ) /* ITM Port #0 enabled */
{
while (ITM->PORT[0U].u32 == 0UL)
{
__NOP();
}
ITM->PORT[0U].u8 = (uint8_t)ch;
}
return (ch);
}
嗯,HAL中明确了只使用PORT[0]。
小结:
ITM相对于传统的断点调试有许多增强的性能,但需要调试器支持SWO。
为了正确使用ITM功能,需要正确配置IDE软件环境。
ITM的关键代码是HAL函数 ITM_SendChar()。
本文结束,请见下一篇:在IAR中如何配置ITM。