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的插件