Document fud's fpga
Xilinx execution/emulation stage
#1021
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relevant to the overall #876 tracker, and more pertinently to #1019 as part of @nathanielnrn's work this summer.
This just adds some basic documentation of fud's
fpga
stage, which lets you actually runxclbin
files, either in emulation or proper FPGA execution. Unfortunately, this requires setting a lot of annoying environment variables before you run fud; #872 should solve this. But for now, we have the bad-but-working way documented.I also added a note to the existing documentation of the
wdb
stage that it may not be worth using. But I don't want to delete that yet because it may be our only way to get waveforms for now. (As a side note, it would be really good if we had a way to convert fromwdb
waveform trace files to ordinaryvcd
files…)