docs: Add links to binutils

esp-rs · Nov 6, 2023 · fc144ae · fc144ae
1 parent dd7fa07
commit fc144ae
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/src/tooling/debugging/openocd.md b/src/tooling/debugging/openocd.md
@@ -5,6 +5,8 @@ Similar to [`probe-rs`][probe-rs], OpenOCD doesn't have support for the `Xtensa`
 
 Instructions on how to install `openocd-esp32` for your platform can be found in [the Espressif documentation][espressif-documentation].
 
+GDB with all the Espressif products supported can be obtained in [`espressif/binutils-gdb`][binutils-repo].
+
 Once installed, it's as simple as running `openocd` with the correct arguments. For chips with the built-in  [`USB-JTAG-SERIAL` peripheral][usb-jtag-serial], there is normally a config file that will work out of the box, for example on the ESP32-C3:
 
 ```shell
@@ -20,6 +22,7 @@ openocd -f interface/jlink.cfg -f target/esp32.cfg
 [probe-rs]: ./probe-rs.md
 [espressif-openocd-esp32]: https://github.com/espressif/openocd-esp32
 [espressif-documentation]: https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/jtag-debugging/index.html#setup-of-openocd
+[binutils-repo]: https://github.com/espressif/binutils-gdb
 [usb-jtag-serial]: index.md#usb-jtag-serial-peripheral
 
 ## VS Code Extension
@@ -57,7 +60,7 @@ OpenOCD can be used in VS Code via the [`cortex-debug`][cortex-debug] extension
       "toolchainPrefix": "xtensa-esp32-elf", //!MODIFY
       "openOCDPreConfigLaunchCommands": ["set ESP_RTOS none"],
       "serverpath": "C:/Espressif/tools/openocd-esp32/v0.11.0-esp32-20220411/openocd-esp32/bin/openocd.exe", //!MODIFY
-      "gdbPath": "C:/Espressif/tools/riscv32-esp-elf-gdb/12.1_20221002/riscv32-esp-elf-gdb/bin/riscv32-esp-elf-gdb", //!MODIFY
+      "gdbPath": "C:/Espressif/tools/riscv32-esp-elf-gdb/riscv32-esp-elf-gdb/bin/riscv32-esp-elf-gdb.exe", //!MODIFY
       "configFiles": ["board/esp32-wrover-kit-3.3v.cfg"], //!MODIFY
       "overrideAttachCommands": [
         "set remote hardware-watchpoint-limit 2",

diff --git a/src/tooling/debugging/probe-rs.md b/src/tooling/debugging/probe-rs.md
@@ -134,4 +134,8 @@ The `Launch` configuration will flash the device and start debugging process whi
 
 ## GDB Integration
 
-`probe-rs` includes a GDB stub to integrate into your usual workflow with common tools. The `gdb` command runs a GDB server, by default in port, `1337`.
+`probe-rs` includes a GDB stub to integrate into your usual workflow with common tools. The `probe-rs gdb` command runs a GDB server, by default in port, `1337`.
+
+GDB with all the Espressif products supported can be obtained in [`espressif/binutils-gdb`][binutils-repo]
+
+[binutils-repo]: https://github.com/espressif/binutils-gdb