Skip to content

Commit f47d752

Browse files
committed
[vpr][place] update constraint doc
1 parent 53b0cad commit f47d752

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

doc/src/vpr/placement_constraints.rst

+5-11
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A Placement Constraints File Example
1818
<partition_list>
1919
<partition name="Part0">
2020
<add_atom name_pattern="li354"/>
21-
<add_atom name_pattern="alu*"/> <!-- Regular expressions can be used to provide name patterns of the primitives to be added -->
21+
<add_atom name_pattern="alu.*"/> <!-- Regular expressions can be used to provide name patterns of the primitives to be added -->
2222
<add_atom name_pattern="n877"/>
2323
<add_region x_low="3" y_low="1" x_high="7" y_high="2"/> <!-- Two rectangular regions are specified, together describing an L-shaped region -->
2424
<add_region x_low="7" y_low="3" x_high="7" y_high="6"/>
@@ -78,7 +78,10 @@ An ``<add_atom>`` tag is used to add an atom that must be constrained to the par
7878
:req_param name_pattern:
7979
The name of the atom.
8080

81-
The ``name_pattern`` can be the exact name of the atom from the input atom netlist that was passed to VPR. It can also be a regular expression, in which case VPR will add all atoms from the netlist which have a portion of their name matching the regular expression to the partition. For example, if a module contains primitives named in the pattern of "alu[0]", "alu[1]", and "alu[2]", the regular expression "alu*" would add all of the primitives from that module.
81+
The ``name_pattern`` can either be the exact name of an atom from the input atom netlist passed to VPR, or a regular expression pattern matching one or more atom names. VPR first searches the netlist for an exact match. If no exact match is found, it then searches for atoms whose names match the regex pattern.
82+
83+
For example, to add all atoms ``alu[0]``, ``alu[1]``, and ``alu[2]`` to the partition ``Part0``, the user can use ``alu.*`` as the ``name_pattern`` in the ``<add_atom>`` tag.
84+
8285

8386
Region
8487
^^^^^^
@@ -124,12 +127,3 @@ It is strongly recommended that different partitions do not overlap. The packing
124127
blocks and the number of physical blocks in a region to decide pack atoms inside a partition more aggressively when
125128
there are not enough resources in a partition. Overlapping partitions causes some physical blocks to be counted in more
126129
than one partition.
127-
128-
129-
130-
131-
132-
133-
134-
135-

0 commit comments

Comments
 (0)