Skip to content

Commit 5bebbde

Browse files
committed
[doc] complete crr doc and add it to index
1 parent d129693 commit 5bebbde

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

doc/src/vpr/custom_rr_graph.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,23 @@ On each side, there should be:
9999

100100
For the columns, the count should be:
101101

102-
- ``4`` (number of sides) × ``160/2`` (number of tracks in one direction) ÷ ``4`` (number of starting tracks per lane) = ``80`` columns.
102+
- ``4`` (number of sides) × ``160/2`` (number of tracks in one direction) ÷ ``4`` (number of starting tracks per lane) = ``80`` columns.
103+
104+
Each switch block template file must contain the number of rows and columns
105+
determined in the previous section. After creating the template file with the
106+
correct dimensions, you can populate the spreadsheet by placing the switch
107+
delay values in the appropriate cells (i.e., in the cells representing valid
108+
connections between source and sink nodes).
109+
110+
Once the switch block map file and template files are created, include the
111+
following arguments in the VPR command line:
112+
113+
- ``--sb_maps <switch_block_map_file>``
114+
- ``--sb_templates <switch_block_template_directory>``
115+
- ``--sb_count_dir <switch_block_count_directory>`` (optional):
116+
If provided, VPR will generate a CSV file for each switch block template,
117+
indicating how many times each switch defined in the template is used in the
118+
final routing results.
119+
120+
For additional arguments, refer to the command-line usage section on the
121+
:ref:`vpr_command_line_usage` page.

doc/src/vpr/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,4 @@ The purpose of VPR is to make the packing, placement, and routing stages of the
6060

6161
file_formats
6262
debug_aids
63+
custom_rr_graph

0 commit comments

Comments
 (0)