OpenOCD上手心得

1. OpenOCD是什么

OpenOCD是一个用来调试嵌入式SOC的软件，需要搭配debug adapter（比如JLink，ST-Link，DAP-Link）和GDB（或Telnet）一起使用。如下图所示：

                                                                             图1

注："elf"指的是编译C代码生成的目标文件，相当于MDK的axf文件。有了它才能单步调试。

2. 为什么要用OpenOCD

• 开源免费
• 支持的SOC和debug adapter非常众多
• 使用命令行交互，好定制
• 支持Windows，Linux
• 稳定

3. 怎样安装OpenOCD

3.1 准备

• PC：Ubuntu16.04（Intel 64Bit）
• OpenOCD源码：openocd-0.10.0.tar.bz2（下载）

安装依赖软件：

sudo apt-get install libusb-1.0-0-dev libftdi1-dev

# 这里是安装HIDAPI，如果你的机器报了没有这个再装
$ sudo apt-get install autotools-dev autoconf automake libtool
$ git clone git://github.com/signal11/hidapi.git
$ cd hidapi
$ ./bootstrap
$ ./configure
$ make
$ sudo make install

Tips：

• 对于apt-get install失败的软件，你可能要先sudo apt-get update一下
• 用OpenOCD源码安装是因为这样才能安装最新版的OpenOCD
• Windows的安装我没试过，不过应该不难

3.2 编译

$ tar xjf openocd-0.10.0.tar.bz2
$ cd openocd-0.10.0
$ ./configure --enable-jlink --enable-openjtag --enable-cmsis-dap --enable-ulink --enable-stlink
$ make
$ sudo make install

3.3 完成

编译完成，可见支持的debug adapter还是蛮多的。

OpenOCD configuration summary
--------------------------------------------------
MPSSE mode of FTDI based devices        yes (auto)
ST-Link JTAG Programmer                 yes
TI ICDI JTAG Programmer                 yes (auto)
Keil ULINK JTAG Programmer              yes
Altera USB-Blaster II Compatible        yes (auto)
Versaloon-Link JTAG Programmer          yes (auto)
OSBDM (JTAG only) Programmer            yes (auto)
eStick/opendous JTAG Programmer         yes (auto)
Andes JTAG Programmer                   yes (auto)
USBProg JTAG Programmer                 no
Raisonance RLink JTAG Programmer        no
Olimex ARM-JTAG-EW Programmer           no
CMSIS-DAP Compliant Debugger            yes
Altera USB-Blaster Compatible           yes (auto)
ASIX Presto Adapter                     yes (auto)
OpenJTAG Adapter                        yes
SEGGER J-Link Programmer                yes

4. 怎样使用OpenOCD

OpenOCD运行起来需要3种文件：interface，target和board。它们分别用于配置debug adapter，SOC和开发板，位于："/usr/local/share/openocd/scripts/"目录（不同的机子可能会不同）。OpenOCD已经把常见的都写好了。

这3种文件使用-f指定，格式如下：

$ openocd -f interface/ADAPTER.cfg -f board/MYBOARD.cfg

Tips：

• 这3种文件可能存在互相包含的关系，所以有时你并不需要3个文件全都指定
• 如果OpenOCD提供的配置文件不符合的你的实际情况，你就得自己改了，用Jim-TCL语言
• -c是指定命令的意思。你可以用-c和-f混合配置，甚至全部使用-c

 

接下来，以STM32F429I-DISCOVERY这块开发板为例。

在使用Telnet或者GDB连接之前，要做一些准备工作：

首先获取配置文件：

$ cp /usr/local/share/openocd/scripts/board/stm32f429discovery.cfg ~/openocd.cfg

然后启动OpenOCD 

$ sudo openocd

正常启动后的打印如下：

$ openocd
Open On-Chip Debugger 0.10.0
Licensed under GNU GPL v2
For bug reports, read
        http://openocd.org/doc/doxygen/bugs.html
Info : The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD
adapter speed: 2000 kHz
adapter_nsrst_delay: 100
none separate
srst_only separate srst_nogate srst_open_drain connect_deassert_srst
Info : Unable to match requested speed 2000 kHz, using 1800 kHz
Info : Unable to match requested speed 2000 kHz, using 1800 kHz
Info : clock speed 1800 kHz
Info : STLINK v2 JTAG v31 API v2 SWIM v0 VID 0x0483 PID 0x3748
Info : using stlink api v2
Info : Target voltage: 2.892706
Info : stm32f4x.cpu: hardware has 6 breakpoints, 4 watchpoints

接着另开一个SSH就可以连接OpenOCD了。 

4.1 用Telnet连接OpenOCD

$ telnet localhost 4444

连接成功后如下： 

$ telnet localhost 4444
Trying ::1...
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
Open On-Chip Debugger
>

然后你就可以输入各种命令调试机器了，这里列出部分命令：（更多的命令请参考http://openocd.org/doc-release/pdf/openocd.pdf）

halt	停止SOC
resume	恢复SOC
reg	查看寄存器
program	烧录FLASH
flash read_bank	读取FLASH

 

 

 

 

 

 

这里给出一个比较实用的烧录bin文件的例子：

$ openocd -f board/stm32f429discovery.cfg -c "program Yourtarget.bin verify reset exit 0x08000000"

• Yourtarget.bin是你要烧录的bin文件
• verify指的是烧录完成后校验一遍
• reset指的是校验完成后复位SOC
• exit指的是所有命令结束后退出OpenOCD
• 0x08000000指的是bin文件烧录地址
• 注意这个命令运行不需要你先开一个SSH运行OpenOCD

你可以把这个命令做成一个Linux的Shell脚本或者Windows的批处理文件，然后双击运行，比使用图形界面的烧录工具快捷不少。

Tips：

• Ubuntu可能没有原装telnet，你得apt安装一下
• telnet退出方式是按住Ctrl+]，然后输入quit

4.2 用GDB连接OpenOCD

$ arm-none-eabi-gdb build/winterboot.elf
(gdb) target remote localhost:3333
(gdb) monitor reset halt
(gdb) load
(gdb) b main
(gdb) c

接下来就可以使用GDB命令正常调试了。

Tips：

• 可以在arm-none-eabi-gdb build/winterboot.elf的后面加上--tui或者在进入GDB以后输入-激活TUI调试，会更直观一些
• GDB启动后输入那一串命令很麻烦，你可以把它们都放到一个文件里去，然后启动GDB时加上-x指定它
• GDB里的monitor命令是用来跟外部程序交互的。如果你在GDB中想输入OpenOCD的命令，就要在OpenOCD命令前加上monitor
• 如果嫌OpenOCD+GDB的命令行太难看，可以试试OpenOCD+eclipse，当然你得装个OpenOCD的插件

 

5. 其他

用OpenOCD+STLink单步调试STM32+Linux