{"id":3761,"date":"2018-03-18T16:43:18","date_gmt":"2018-03-18T23:43:18","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=3761"},"modified":"2019-10-24T14:09:48","modified_gmt":"2019-10-24T21:09:48","slug":"diagnosing-internal-openocd-problems-with-visualgdb","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/arm\/openocd\/build\/","title":{"rendered":"Building OpenOCD for Windows and Exploring its Internal Logic"},"content":{"rendered":"

This tutorial shows how to diagnose problems internal to OpenOCD using VisualGDB\u00a0and the Sysprogs OpenOCD fork<\/a>\u00a0that includes convenient CMake build rules. Before you begin, install VisualGDB 5.4 or later.<\/p>\n

We will show how to build OpenOCD from\u00a0our Github repo, configure it to run with meaningful arguments and analyze its internal logic responsible for erasing FLASH memory.<\/p>\n

    \n
  1. Clone\u00a0our OpenOCD repo (including submodules) into a folder on your\u00a0computer:\n
    git clone --recurse-submodules https:\/\/github.com\/sysprogs\/openocd.git<\/pre>\n
    \"02-git\"<\/a><\/li>\n
  2. Ensure you have VisualGDB 5.4 or later installed. Then locate and open the OpenOCD.sln file inside the repository. VisualGDB will ask for the location of the MinGW toolchain:\"tc\"<\/a><\/li>\n
  3. Proceed with the automatic toolchain installation.\u00a0Then build OpenOCD by pressing Ctrl-Shift-B:\"oocd\"<\/a>Warning: As of October 2019, our OpenOCD fork contains all the necessary dependencies and no longer requires a special toolchain, so the regular MinGW32 toolchain will suffice.<\/strong><\/li>\n
  4. Open an embedded project that reproduces the issue you would like to diagnose, go to VisualGDB Project Properties -> Debug Settings\u00a0and click “Test”:
    \n<\/a>     \"06-test\"<\/a><\/li>\n
  5. The “Testing settings” will\u00a0show the command line used to launch OpenOCD. Copy it to clipboard:\"07-cmdline\"<\/a>A typical command line\u00a0for STM32F4 devices is shown below:\n
    -c \"gdb_port 2594\" -c \"telnet_port 2595\" -f interface\/stlink-v2-1.cfg -f target\/stm32f4x.cfg -c init -c \"reset init\" -c \"echo VisualGDB_OpenOCD_Ready\"<\/pre>\n<\/li>\n
  6. Switch back to OpenOCD.sln and open VS Properties for the openocd.exe<\/strong> target.\u00a0Remove the “gdb_port ” and “telnet_port” commands (and the corresponding -“c” flags) from the command line and copy it to the “Command line arguments” field:\"08-copied\"<\/a><\/li>\n
  7. Locate the original OpenOCD installation under %LOCALAPPDATA%\\VisualGDB\\EmbeddedDebugPackages\\com.sysprogs.arm.openocd\\bin<\/strong> and copy all .dll<\/strong> files from its directory to the VisualGDB\\Debug\\src<\/strong> subdirectory of the OpenOCD project:\"09-libs\"<\/a><\/li>\n
  8. Press F5 to start debugging. Confirm that OpenOCD starts listening on port 3333 for gdb\u00a0connections:\"10-openocd\"<\/a><\/li>\n
  9. Now we will show how to\u00a0step through the logic responsible for FLASH erasing.\u00a0Ensure your embedded project is built and\u00a0open its binary in gdb using the following command line:\n
    <sysgcc>\\arm-eabi\\bin\\arm-eabi-gdb.exe\u00a0<ELF file from your embedded project><\/pre>\n
    The ELF file is typically located\u00a0in the VisualGDB\\Debug<\/strong> directory and has no extension. Then enter “target remote :3333” in the gdb command prompt in order to connect to OpenOCD:
    \n<\/a>     \"11-gdb\"<\/a><\/li>\n
  10. Locate the FLASH driver for your device family (e.g. stm32f2x.c for STM32F4) and set a breakpoint in the erase function. Then switch to gdb and run the “load” command in order to program the memory manually. The breakpoint inside OpenOCD will hit:
    \n    \"12-erase\"<\/a>You can now\u00a0step through the code to double-check the\u00a0OpenOCD logic responsible for various parts of the erase process and fine-tune\u00a0parts of it.<\/li>\n
  11. If you want to use a modified version of OpenOCD instead of the one shipped with VisualGDB, simply replace the %LOCALAPPDATA%\\VisualGDB\\EmbeddedDebugPackages\\com.sysprogs.arm.openocd\\bin\\openocd.exe\u00a0<\/strong>executable with the one you built and VisualGDB will use it instead.<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    This tutorial shows how to diagnose problems internal to OpenOCD using VisualGDB\u00a0and the Sysprogs OpenOCD fork\u00a0that includes convenient CMake build<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[9],"tags":[53,133,60,61],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/3761"}],"collection":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/comments?post=3761"}],"version-history":[{"count":5,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/3761\/revisions"}],"predecessor-version":[{"id":5305,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/3761\/revisions\/5305"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=3761"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=3761"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=3761"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}