From 01ddb1ba6c0847c7a8154f6130b20177afe2f888 Mon Sep 17 00:00:00 2001 From: petergrossmann21 Date: Thu, 17 Oct 2024 15:13:26 -0400 Subject: [PATCH 1/2] Clarify corner case behavior of --device option --- doc/src/vpr/command_line_usage.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/src/vpr/command_line_usage.rst b/doc/src/vpr/command_line_usage.rst index 7954cdc3fd5..de4acb612e3 100644 --- a/doc/src/vpr/command_line_usage.rst +++ b/doc/src/vpr/command_line_usage.rst @@ -200,12 +200,19 @@ General Options .. option:: --device - Specifies which device layout/floorplan to use from the architecture file. + Specifies which device layout/floorplan to use from the architecture file. Valid values are: - ``auto`` uses the smallest device satisfying the circuit's resource requirements. - Other values are assumed to be the names of device layouts defined in the :ref:`arch_grid_layout` section of the architecture file. + * ``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. + * 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. - .. note:: If the architecture contains both ```` and ```` specifications, specifying an ``auto`` device will use the ````. + If the value specified is neither ``auto`` nor matches the ``name`` attribute value of a ```` tag, VPR issues an error. + + In the event that no ```` tag is present in the architecture file, this option has the following behaviour: + + * ``auto`` VPR uses the smallest device amongst all ``fixed_layout`` specifications into which the design can be packed. + * Otherwise, the value of the ``fixed_layout`` attribute ``name`` is matched as when an ```` tag is present. + + .. note:: If the only layout in the architecture file is a single device specified using ````, it is recommended to always specify the ``--device`` option; this prevents the value ``--device auto`` from interfering with operations supported only for ```` grids. **Default:** ``auto`` From 76c3ab0049aeafb550445e50a908ec3cb4f29eb9 Mon Sep 17 00:00:00 2001 From: petergrossmann21 Date: Fri, 18 Oct 2024 08:22:49 -0400 Subject: [PATCH 2/2] Incorporate PR feedback --- doc/src/vpr/command_line_usage.rst | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/doc/src/vpr/command_line_usage.rst b/doc/src/vpr/command_line_usage.rst index de4acb612e3..be5724431f4 100644 --- a/doc/src/vpr/command_line_usage.rst +++ b/doc/src/vpr/command_line_usage.rst @@ -202,17 +202,12 @@ General Options Specifies which device layout/floorplan to use from the architecture file. Valid values are: - * ``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. - * 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. + * ``auto`` VPR uses the smallest device satisfying the circuit's resource requirements. This option will use the ```` tag if it is present in the architecture file in order to construct the smallest FPGA that has sufficient resources to fit the design. If the ```` tag is not present, the ``auto`` option chooses the smallest device amongst all the architecture file's ```` specifications into which the design can be packed. + * Any string matching ``name`` attribute of a device layout defined with a ```` tag in the :ref:`arch_grid_layout` section of the architecture file. If the value specified is neither ``auto`` nor matches the ``name`` attribute value of a ```` tag, VPR issues an error. - - In the event that no ```` tag is present in the architecture file, this option has the following behaviour: - - * ``auto`` VPR uses the smallest device amongst all ``fixed_layout`` specifications into which the design can be packed. - * Otherwise, the value of the ``fixed_layout`` attribute ``name`` is matched as when an ```` tag is present. - - .. note:: If the only layout in the architecture file is a single device specified using ````, it is recommended to always specify the ``--device`` option; this prevents the value ``--device auto`` from interfering with operations supported only for ```` grids. + + .. note:: If the only layout in the architecture file is a single device specified using ````, it is recommended to always specify the ``--device`` option; this prevents the value ``--device auto`` from interfering with operations supported only for ```` grids. **Default:** ``auto``