Skip to content

Commit 87c5450

Browse files
committed
docs: vpr: add description of --write_timing_summary and --write_block_usage
Signed-off-by: Pawel Czarnecki <[email protected]>
1 parent 952b2d7 commit 87c5450

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

doc/src/vpr/command_line_usage.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -626,6 +626,12 @@ For people not working on CAD, you can probably leave all the options to their d
626626

627627
**Default:** ``2``
628628

629+
.. option:: --write_block_usage <file>
630+
631+
Writes out to the file under path <file> block usage summary in machine
632+
readable (JSON or XML) or human readable (TXT) format. Format is selected
633+
based on the extension of <file>.
634+
629635
.. _placer_options:
630636

631637
Placer Options
@@ -1035,6 +1041,17 @@ VPR uses a negotiated congestion algorithm (based on Pathfinder) to perform rout
10351041

10361042
**Default:** ``off``
10371043

1044+
.. option:: --write_timing_summary <file>
1045+
1046+
Writes out to the file under path <file> final timing summary in machine
1047+
readable (JSON or XML) or human readable (TXT) format. Format is selected
1048+
based on the extension of <file>. The summary consists of parameters:
1049+
1050+
* `cpd` - Final critical path delay (least slack) [ns]
1051+
* `fmax` - Maximal frequency of the implemented circuit [MHz]
1052+
* `swns` - setup Worst Negative Slack (sWNS) [ns]
1053+
* `stns` - Setup Total Negative Slack (sTNS) [ns]
1054+
10381055
.. _timing_driven_router_options:
10391056

10401057
Timing-Driven Router Options

0 commit comments

Comments
 (0)