Willkommen bei OpenOCD

OpenOCD bietet Unterstützung für On-Chip-Programmierung und Debugging mit einer geschichteten Architektur aus JTAG-Schnittstelle und TAP-Unterstützung, einschließlich:

• (X)SVF-Wiedergabe zur automatisierten Boundary-Scan- und FPGA/CPLD-Programmierung;
• Debug-Zielunterstützung (z. B. ARM, MIPS): Einzelschrittausführung, Breakpoints/Watchpoints, Gprof-Profiling usw.;
• Flash-Chip-Treiber (z. B. CFI, NAND, interner Flash);
• eingebetteter Tcl-Interpreter für einfache Skripterstellung.

Für die Interaktion mit OpenOCD stehen mehrere Netzwerkschnittstellen zur Verfügung: Telnet, Tcl und GDB. Der GDB-Server ermöglicht es OpenOCD, als "Remote-Ziel" für das Debugging auf Quellcode-Ebene eingebetteter Systeme mit dem GNU GDB-Programm (und anderen, die das GDB-Protokoll sprechen, z. B. IDA Pro) zu fungieren.

Diese README-Datei enthält eine Übersicht über folgende Themen:

• Schnellstartanweisungen,
• wie Sie weitere OpenOCD-Dokumentation finden und erstellen,
• Liste der unterstützten Hardware,
• Installations- und Build-Prozess,
• Tipps zur Paketerstellung.

Schnellstart für Ungeduldige

Wenn Sie ein gängiges Board haben, starten Sie OpenOCD einfach mit dessen Konfiguration, z. B.:

openocd -f board/stm32f4discovery.cfg

Wenn Sie einen bestimmten Adapter mit einem spezifischen Ziel verbinden, müssen Sie sowohl die JTAG-Schnittstellen- als auch die Zielkonfiguration einbinden, z. B.:

openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \
        -f target/ti/calypso.cfg

openocd -f interface/stlink.cfg -c "transport select swd" \
        -f target/stm32l0.cfg

Nach dem Start von OpenOCD verbinden Sie GDB mit

(gdb) target extended-remote localhost:3333

Installieren von OpenOCD

Der einfachste Weg, OpenOCD zu installieren, ist über den Paketmanager Ihres Betriebssystems.

• Debian / Ubuntu

  sudo apt install openocd
  

• Fedora

  sudo dnf install openocd
  

• macOS (via Homebrew)

  brew install open-ocd
  

• Windows (via MSYS2)

  pacman -S mingw-w64-x86_64-openocd
  

Diese Pakete sind oft stabiler als der neueste Git-Mainline-Zweig, in dem die aktive Entwicklung stattfindet. "Paketersteller" erstellen binäre Veröffentlichungen von OpenOCD, nachdem die Entwickler neue Quellcode-Versionen veröffentlicht haben. Ältere OpenOCD-Versionen sind nicht geeignet, um Probleme in der aktuellen Version zu diagnostizieren. Benutzer sollten mit ihren Distributionsbetreuern oder Schnittstellenanbietern in Kontakt bleiben, um sicherzustellen, dass regelmäßig geeignete Updates bereitgestellt werden.

Wenn Sie eines dieser binären Pakete verwenden, müssen Sie sich für Support oder neuere binäre Versionen an den Paketersteller wenden. Die OpenOCD-Entwickler bieten keine direkte Unterstützung für gepackte Binärdateien.

Ein Hinweis an OpenOCD-Paketersteller

Sie sind ein PAKETIERER von OpenOCD, wenn Sie:

• Dongles verkaufen und vorgefertigte Binärdateien beilegen;
• Werkzeuge oder IDEs (eine Entwicklungslösung, die OpenOCD integriert) bereitstellen;
• Pakete (z. B. RPM- oder DEB-Dateien für eine GNU/Linux-Distribution) erstellen.

Als PAKETIERER werden Sie die ersten Berichte über die meisten Probleme erhalten. Wenn Sie diese Probleme für Ihre Benutzer beheben, kann Ihre Lösung dazu beitragen, Hunderte (wenn nicht Tausende) von Fragen anderer Benutzer zu verhindern.

Wenn etwas bei Ihnen nicht funktioniert, informieren Sie bitte die OpenOCD-Entwickler darüber, wie das System oder die Dokumentation verbessert werden kann, um zukünftige Probleme zu vermeiden, und helfen Sie uns, sicherzustellen, dass das Problem in unseren zukünftigen Veröffentlichungen vollständig behoben wird.

Trotzdem möchten die OpenOCD-Entwickler, dass Sie einige Vorschläge befolgen:

• Senden Sie Patches, einschließlich Konfigurationsdateien, an die Entwickler und beteiligen Sie sich an den Diskussionen;
• Aktivieren Sie alle Optionen, die OpenOCD unterstützt, auch solche, die nichts mit Ihrer spezifischen Hardware zu tun haben;
• Verwenden Sie den "ftdi"-Schnittstellenadaptertreiber für FTDI-basierte Geräte.

OpenOCD-Dokumentation

Zusätzlich zur im Source-Baum enthaltenen Dokumentation können die neuesten Handbücher online unter den folgenden URLs eingesehen werden:

• OpenOCD-Benutzerhandbuch: http://openocd.org/doc/html/index.html

• OpenOCD-Entwicklerhandbuch: http://openocd.org/doc/doxygen/html/index.html

Diese spiegeln die neuesten Entwicklungsversionen wider. Der folgende Abschnitt erläutert, wie die vollständige Dokumentation aus dem Paket erstellt wird.

Weitere Informationen finden Sie in diesen Dokumenten oder kontaktieren Sie die Entwickler, indem Sie die OpenOCD-Entwickler-Mailingliste abonnieren: [email protected]

Erstellen der OpenOCD-Dokumentation

Standardmäßig bereitet der OpenOCD-Build-Prozess die Dokumentation im "Info-Format" vor und installiert sie auf dem üblichen Weg, sodass info openocd darauf zugreifen kann.

Zusätzlich kann das OpenOCD-Benutzerhandbuch in den folgenden Formaten erstellt werden:

Wenn PDFVIEWER gesetzt ist, wird das PDF-Benutzerhandbuch erstellt und angezeigt.

make pdf && ${PDFVIEWER} doc/openocd.pdf

Wenn HTMLVIEWER gesetzt ist, wird das HTML-Benutzerhandbuch erstellt und angezeigt.

make html && ${HTMLVIEWER} doc/openocd.html/index.html

Das OpenOCD-Entwicklerhandbuch enthält Informationen über die interne Architektur und andere Details zum Code:

Hinweis: Stellen Sie sicher, dass doxygen installiert ist, geben Sie doxygen --version ein.

make doxygen && ${HTMLVIEWER} doxygen/index.html

Unterstützte Hardware

JTAG-Adapter

AM335x, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432, BCM2835, Bus Blaster, Buspirate, Cadence DPI, Cadence vdebug, Chameleon, CMSIS-DAP, Cortino, Cypress KitProg, DENX, Digilent JTAG-SMT2, DLC 5, DLP-USB1232H, embedded projects, Espressif USB JTAG Programmer, eStick, FlashLINK, FlossJTAG, Flyswatter, Flyswatter2, FTDI FT232R, Gateworks, Hoegl, ICDI, ICEBear, J-Link, JTAG VPI, JTAGkey, JTAGkey2, JTAG-lock-pick, KT-Link, Linux GPIOD, Lisa/L, LPC1768-Stick, Mellanox rshim, MiniModule, NGX, Nuvoton Nu-Link, Nu-Link2, NXHX, NXP IMX GPIO, OOCDLink, Opendous, OpenJTAG, Openmoko, OpenRD, OSBDM, Presto, Redbee, Remote Bitbang, RLink, SheevaPlug devkit, Stellaris evkits, ST-LINK (SWO-Tracing unterstützt), STM32-PerformanceStick, STR9-comStick, sysfsgpio, Tigard, TI XDS110, TUMPA, Turtelizer, ULINK, USB-A9260, USB-Blaster, USB-JTAG, USBprog, VPACLink, VSLLink, Wiggler, XDS100v2, Xilinx XVC/PCIe, Xverve.

Debug-Ziele

ARM: AArch64, ARM11, ARM7, ARM9, Cortex-A/R (v7-A/R), Cortex-M (ARMv{6/7/8}-M), FA526, Feroceon/Dragonite, XScale. ARCv2, AVR32, DSP563xx, DSP5680xx, EnSilica eSi-RISC, EJTAG (MIPS32, MIPS64), ESP32, ESP32-S2, ESP32-S3, Intel Quark, LS102x-SAP, RISC-V, ST STM8, Xtensa.

Flash-Treiber

ADUC702x, AT91SAM, AT91SAM9 (NAND), ATH79, ATmega128RFA1, Atmel SAM, AVR, CFI, DSP5680xx, EFM32, EM357, eSi-RISC, eSi-TSMC, EZR32HG, FM3, FM4, Freedom E SPI, GD32, i.MX31, Kinetis, LPC8xx/LPC1xxx/LPC2xxx/LPC541xx, LPC2900, LPC3180, LPC32xx, LPCSPIFI, Marvell QSPI, MAX32, Milandr, MXC, NIIET, nRF51, nRF52 , NuMicro, NUC910, Nuvoton NPCX, onsemi RSL10, Orion/Kirkwood, PIC32mx, PSoC4/5LP/6, Raspberry RP2040, Renesas RPC HF and SH QSPI, S3C24xx, S3C6400, SiM3x, SiFive Freedom E, Stellaris, ST BlueNRG, STM32, STM32 QUAD/OCTO-SPI for Flash/FRAM/EEPROM, STMSMI, STR7x, STR9x, SWM050, TI CC13xx, TI CC26xx, TI CC32xx, TI MSP432, Winner Micro w600, Xilinx XCF, XMC1xxx, XMC4xxx.

Erstellen von OpenOCD

Die Datei INSTALL enthält allgemeine Anweisungen zum Ausführen von configure und zum Kompilieren des OpenOCD-Quellcodes. Diese Datei wird standardmäßig für alle GNU-Autotools-Pakete bereitgestellt. Wenn Sie mit den GNU-Autotools nicht vertraut sind, sollten Sie diese Anweisungen zuerst lesen.