3.5.1.8.4 Generated Files
(Ask a Question)To aid in the process of instrumentation and debugging, the SmartHLS™ Automatic On-Chip Instrumentation feature
generates the following files under the hls_output/scripts/instrument
directory:
| File | Purpose |
|---|---|
| fifo_list | File with a list of all the FIFOs in the design, as well as their almost_full and almost_empty values. |
| instrument_config.tcl | Configuration file with information required by both the monitoring script and visualizing scripts. |
| monitor.tcl | Script that repeatedly runs the debugger for the purpose of monitoring. This should be run by identify_debugger. |
| prj_<HLS PROJECT_NAME>_hls_identify.tcl | Instrumentation script that opens the Synplify synthesis project, and then instruments the SmartHLS modules by sourcing <HLS PROJECT_NAME>_hls_identify.tcl |
| <HLS PROJECT_NAME>_hls_identify.tcl | Instrumentation script that creates the IICE for the SmartHLS project. Then it sources all the identify_instrument_<TOP LEVEL MODULE NAME>.tcl files. |
| identify_instrument_<TOP LEVEL MODULE NAME>.tcl | Script to instrument (add) all the selected signals based on the selected log level for the TOP LEVEL MODULE NAME. One of these files is generated for every top-level module in your SmartHLS project. |
| update_vcd.tcl | Script used to refresh the waveform viewer with new samples (debugging mode), or append new samples on the existing waveform (monitoring mode). |
| wave_template.do | Waveform template that automatically groups the instrumented HLS signals. This should be run in your ModelSim waveform viewer. |
| fifo_dashboard_wave_template.do | Waveform template that arranges all the FIFOs' occupancy (usedw signals) at the bottom of the waveform for easy viewing. This should be run in ModelSim waveform viewer. |
| vsim_keyboard_binding | Keyboard binding for ModelSim that refreshes the waveform with newly captured signals every time Ctrl+R is pressed for convenience. |
Examples of how to use each script while debugging are in the Github example available at the following location: github.com/MicrochipTech/fpga-hls-examples/tree/main/auto-instrument