ILA flow instructions not clear
Nobody has claimed this yet.
- Dominant language
- Tcl
- Stars
- 46
- Forks
- 21
- Avg merge
- 1d 9m
- Merged PRs (30d)
- 9
Description
Hi,
Git dev branch commit = 7a528701c3f17506e5c645399b8b57c82d39632f
"Fix ILA debug flow: correct documented procedure. (#221)"
Referring to the documentation at: https://slash-fpga.readthedocs.io/en/latest/howto/debug-with-ila.html
the usage instructions are not clear (e.g.)
The working order listed is:
a) program the .vbin
b) set the user clock (host setFrequency(), or v80-smi debug clockwiz --set)
c) pause the host
d) arm the ILA and set triggers
e) release the host
Q1) Has this ILA flow been tested wrt existing SLASH example design (examples/00_axilite)
Where all these necessary changes/modifications have been made in the example design and validated?
Q2) Typical ILA debug flow should be:
- added the ILA probes to the user design
- set up the ILA trigger conditions
- run the user design application and view the triggered waveform
Why is there a need to modify the user application? Why are steps b) , c), e) required?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the ILA documentation at howto/debug-with-ila.html and the referenced commit 7a528701c3f17506e5c645399b8b57c82d39632f. Compare the stated sequence with examples/00_axilite and determine whether the flow was tested there. Done means the instructions clearly explain the required steps, application changes, and reasons for setting the clock, pausing the host, and releasing it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100