A description of higher level tools for programming and debugging. The goal of this section is to provide everything you need to get started with and use the included tools.

Including:

• bobbin-cli by @jcsoo
• OpenOCD

What is a debugger and how to use it, focussing on GDB at this time due to issues with LLVM remote targets.

Including:

• Tools, GDB server and gdb and how they interact
• Commands, how to launch and use GDB
• Workflows, how to fit both together?

A section with a page describing the use of each of the following tools (used with GDB). The goal of this section is to help people get started and use a specific piece of debugging hardware.

• JLink hardware + JLink software
• STLink hardware + texane/stlink
• BLackMagic Probe (BMP) hardware
• CMSIS-DAP/DapLink

Before starting on these, we should perhaps decide on a common format to follow. If you're working on a page, please create an issue with a reference back to this one.

A description of how embedded programming and debugging works with links out to other sections, this is likely to be arm focussed at the moment.
The goal of this section is to let people know what is available / currently used / they need to learn.

Including:

• Why programmers / debuggers
• Interfaces / Protocols (SWD, JTAG)
• Debuggers (BM, STLink, Segger, OpenOCD)
• Tools (GDB, LLDB)
• Semihosting (and the JLink specific equivalent)?

From @japaric on August 10, 2018 2:43

From @ryankurte on July 5, 2018 22:23

As mentioned here it'd be great to develop Running and Debugging into a useful tool-independent resource.

As far as I see it, we need:

• A common description of how embedded debugging works
  • JTAG
  • SWD
• An intro to embedded debugging
  • GDB for now
  • LLDB one day?
• An overview of available tools (hardware and software) and how to identify them
• An intro to the higher level tools (w/ arbitrary hardware)
  • bobbin-cli by @jcsoo
  • OpenOCD
• A page on the use of each tool for each of
  • JLink hardware + JLink software + GDB,
  • STLink hardware + texane/stlink + GDB,
  • BLackMagic Probe (BMP) hardware + GDB
  • CMSIS-DAP/DapLink

At this stage lldb isn't really viable for embedded debugging, so there's going to be a requirement for target GDB at least for now.

Any thoughts?

(@therealprof, @kjetilkjeka, @korken89)

Copied from original issue: rust-embedded/wg#112

Copied from original issue: rust-embedded/book#10

As a rust newbie I am frustrated by the amount of info which is outdated. I've wasted days following along tutorials which are poorly tested, and do not work with the latest tools and version of rust.
This project doesn't even appear to be that good. There is zero content, appears to be abandoned, and is just another waste of 5 minutes of everyone's time.
Sorry to be harsh

An introduction to our old friend GDB

• How it works (gdb server vs. client etc.)
• How to run against a compiled rust target
• Common debugging commands
• Useful references

As mentioned in #9, it would be good to have explanations of how to coerce output files into different types using scripts or cargo-binutils, as well as perhaps in the use of map and nm (though iirc these are introduced in other books?)

See #12

Debugging with GDB works for the most part, however it struggles to find the rust source files. I believe this is because the rust library is compiled in /rustc/{GIT_COMMIT_HASH} which only exists on the build server.

You can use a set substitute-path command to substitute this for the RUST_SRC_PATH environment variable, however this still needs to be updated every time a new rust version is released.

Should I add this to the debugonomicon for now anyway? I can't really think of any better option besides doing something clever with the build.rs script perhaps.