Skip to content

Commit e7702a2

Browse files
authored
Update file_formats.rst rr_graph.xml desc.
Clarified that the final channel width is the rr_graph written out to rr_graph.xml if we're doing a binary search; fixed a few typos.
1 parent b25f941 commit e7702a2

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/src/vpr/file_formats.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -743,14 +743,16 @@ An example listing for a global net is given below.
743743
Routing Resource Graph File Format (.xml)
744744
-----------------------------------------
745745
The routing resource graph (rr graph) file is an XML file that describes the routing resources within the FPGA.
746-
This file is generated through the last stage of the rr graph generation during routing with the final channel width.
747-
When reading in rr graph from an external file, the rr graph is used during the placement and routing section of VPR.
746+
VPR can generate a rr graph that matches your architecture specifications (from the architecture xml file), or it can read in an externally generated rr graph.
747+
When this file is written by VPR, the rr graph written out is the rr graph generated before routing with a final channel width
748+
(even if multiple routings at different channel widths are performed during a binary search for the minimum channel width).
749+
When reading in rr graph from an external file, the rr graph is used during both the placement and routing phases of VPR.
748750
The file is constructed using tags. The top level is the ``rr_graph`` tag.
749751
This tag contains all the channel, switches, segments, block, grid, node, and edge information of the FPGA.
750752
It is important to keep all the values as high precision as possible. Sensitive values include capacitance and Tdel. As default, these values are printed out with a precision of 30 digits.
751753
Each of these sections are separated into separate tags as described below.
752754

753-
.. note:: Use :option:`vpr --read_rr_graph` to specify an RR graph file to be load.
755+
.. note:: Use :option:`vpr --read_rr_graph` to specify an RR graph file to be loaded.
754756
.. note:: Use :option:`vpr --write_rr_graph` to specify where the RR graph should be written.
755757

756758
Top Level Tags

0 commit comments

Comments
 (0)