Skip to content

Commit c70db45

Browse files
committed
updates based on Vaughn's comments
1 parent 23651f1 commit c70db45

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

doc/src/vpr/command_line_usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ Use the options below to override this default naming behaviour.
346346

347347
Path to input :ref:`flat placement file <vpr_flat_placement_file>`.
348348

349-
**Default:** :option:`circuit <circuit>`.route
349+
**Default:** :option:`circuit <circuit>`.flat_place
350350

351351
.. option:: --sdc_file <file>
352352

@@ -1873,7 +1873,7 @@ The following options are available when VPR's legalizer is invoked to reconstru
18731873
.. option:: --write_fixed_clusters <file>
18741874

18751875
Write out a (possibly incomplete) clustered placement file listing placement coordinates for clusters reconstructed from an input flat placement file.
1876-
If placement is run after legalization, this file is automatically set as an input placement constraints file.
1876+
If placement is run after legalization (in the same vpr run), this file is automatically used to constrain the placement of the clusters listed within it. If placement is run in a separate vpr run, this file should be specified using :option:`--fix_clusters <file>`.
18771877

18781878
**Default:** ``fixed_clusters.out``
18791879

doc/src/vpr/file_formats.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -744,7 +744,7 @@ Flat Placement File Format (.flat_place)
744744
----------------------------------------
745745
The flat placement file contains the information needed for VPR's legalizer to reconstruct a clustering and placement solution,
746746
inferring mode and intra-cluster routing information and correcting legality violations as needed.
747-
747+
This input file format can be used as an alternative to the packed netlist (.net) and clustered placment (.place) files; the more succinct and higher-level input format permits an external tool to more easily provide a packing and placement solution to VPR.
748748
Each line in the flat placement file corresponds to a netlist primitive and has the following format::
749749

750750
primitive_name X Y subtile site # optional extra info
@@ -797,14 +797,16 @@ Example flat placement file entries are shown below:
797797
hh_core:hh_core_0|Add0~78 53 24 0 19 # 86 lcell_comb
798798
799799
For complex pack molecules such as carry chains (see :ref:`Pack Patterns in <arch_complex_blocks>`), it is only necessary to include the root primitive in the flat placement file; the legalizer ignores non-root primitives and places all primitives in each pack molecule based on the root primitive entry. In the example file above, all lcell_comb instances shown are part of a carry chain segment, and so all except the root primitive are ignored.
800-
VPR's legalizer does not require the flat placement file to contain every primitive in the netlist; it will reconstruct the portion of the netlist and print a warning if the file does not cover the entire netlist. This functionality is useful for debugging legalization in an external placement tool.
800+
VPR's legalizer does not require the flat placement file to contain every primitive in the netlist; it will reconstruct the packing and placement for the specified portion of the netlist and print a warning if the file does not cover the entire netlist. This functionality is useful for debugging legalization in an external placement tool.
801801

802802
.. note:: Use :option:`vpr --legalize` and :option:`vpr --flat_place_file <file>` to invoke the legalizer and specify an input flat placement file.
803803

804804
.. note: Use :option:`vpr --write_flat_place <file>` to write out a post-placement flat placement file. Use :option:`vpr --echo_file on` to write out a (possibly incomplete) post-legalization flat placement file (the file will be named `post_legalizer_flat_placement.echo`).
805805
806806
.. note: A flat placement file must correspond to a specific XML architecture file and a specific fixed size device layout (see :ref:`FPGA Grid Layout <arch_grid_layout>`). Use :option:`vpr --device <fixed layout name>` to specify a fixed device layout.
807807
808+
.. note: Currently, this file format only supports 2D FPGA architectures.
809+
808810
.. _vpr_route_resource_file:
809811

810812
Routing Resource Graph File Format (.xml)

0 commit comments

Comments
 (0)