Skip to content

Commit 3ffd5b1

Browse files
authored
Merge pull request #1387 from ucb-bar/docs-visualization
Add graphml visualization section to docs
2 parents 4f74f29 + c7ea3b6 commit 3ffd5b1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/Simulation/Software-RTL-Simulation.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,16 @@ An open-source vcd-capable waveform viewer is `GTKWave <http://gtkwave.sourcefor
188188
For a VCS simulation, this will generate a vpd file (this is a proprietary waveform representation format used by Synopsys) that can be loaded to vpd-supported waveform viewers.
189189
If you have Synopsys licenses, we recommend using the DVE waveform viewer.
190190

191+
Visualizing Chipyard SoCs
192+
--------------------------
193+
194+
During verilog creation, a graphml file is emitted that will allow you to visualize your Chipyard SoC as a diplomacy graph.
195+
196+
To view the graph, first download a viewer such as `yEd <https://www.yworks.com/products/yed/>`__.
197+
198+
The ``*.graphml`` file will be located in ``generated-src/<...>/``. Open the file in the graph viewer.
199+
To get a clearer view of the SoC, switch to "hierarchical" view. For yEd, this would be done by selecting ``layout`` -> ``hierarchical``, and then choosing "Ok" without changing any settings.
200+
191201
.. _sw-sim-verilator-opts:
192202

193203
Additional Verilator Options

0 commit comments

Comments
 (0)