Skip to content

Commit 01ddb1b

Browse files
Clarify corner case behavior of --device option
1 parent b3b3084 commit 01ddb1b

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

doc/src/vpr/command_line_usage.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -200,12 +200,19 @@ General Options
200200

201201
.. option:: --device <string>
202202

203-
Specifies which device layout/floorplan to use from the architecture file.
203+
Specifies which device layout/floorplan to use from the architecture file. Valid values are:
204204

205-
``auto`` uses the smallest device satisfying the circuit's resource requirements.
206-
Other values are assumed to be the names of device layouts defined in the :ref:`arch_grid_layout` section of the architecture file.
205+
* ``auto`` VPR uses the smallest device satisfying the circuit's resource requirements, with device layout specified using the ``auto_layout`` section of the architecture file.
206+
* Any string matching ``name`` attribute of a device layout defined with a ``fixed_layout`` tag in the :ref:`arch_grid_layout` section of the architecture file.
207207

208-
.. note:: If the architecture contains both ``<auto_layout>`` and ``<fixed_layout>`` specifications, specifying an ``auto`` device will use the ``<auto_layout>``.
208+
If the value specified is neither ``auto`` nor matches the ``name`` attribute value of a ``<fixed_layout>`` tag, VPR issues an error.
209+
210+
In the event that no ``<auto_layout>`` tag is present in the architecture file, this option has the following behaviour:
211+
212+
* ``auto`` VPR uses the smallest device amongst all ``fixed_layout`` specifications into which the design can be packed.
213+
* Otherwise, the value of the ``fixed_layout`` attribute ``name`` is matched as when an ``<auto_layout>`` tag is present.
214+
215+
.. note:: If the only layout in the architecture file is a single device specified using ``<fixed_layout>``, it is recommended to always specify the ``--device`` option; this prevents the value ``--device auto`` from interfering with operations supported only for ``<fixed_layout>`` grids.
209216

210217
**Default:** ``auto``
211218

0 commit comments

Comments
 (0)