chipyard
chipyard copied to clipboard
'Debugging with JTAG' section incomplete in docs
Background Work
- [X] Yes, I searched the mailing list
- [X] Yes, I searched the documentation
Feature Description
Include detailed instructions in the Chipyard documentation to debug with JTAG in simulation with OpenOCD + GDB.
Motivating Example
Need to debug simulation via JTAG in Chipyard. Chipyard links to this page, which leads to nothing.
See https://chipyard.readthedocs.io/en/stable/Advanced-Concepts/Chip-Communication.html#debugging-with-jtag. Step 3 leads to https://github.com/chipsalliance/rocket-chip#4-launch-openocd.
This leads to the Rocket Chip repo, where the README contains a table of contents with a 'Debugging with GDB' section. This link is broken and/or no documentation exists.
Here's the fixed link: https://github.com/chipsalliance/rocket-chip/tree/v1.6#4-launch-openocd (if something got removed from a git repository you can check the git history) but this doesn't look quite right...
A PR to inline these docs into the chipyard docs, since they were removed from rocket-chip, would be greatly appreciated