Skip to content

Commit

Permalink
Merge pull request #1292 from lnis-uofu/xt_shrink_boundary_doc
Browse files Browse the repository at this point in the history
[doc] add description about new option ``shrink_boundary``
  • Loading branch information
tangxifan authored Aug 13, 2023
2 parents 69e5db6 + 0c4245c commit 696116b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions docs/source/manual/arch_lang/addon_vpr_syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ Layout
.. option:: through_channel="<bool>"

Allow routing channels to pass through multi-width and multi-height programable blocks. This is mainly used in heterogeneous FPGAs to increase routability, as illustrated in :numref:`fig_thru_channel`.
By default, it is ``off``.
By default, it is ``false``.

.. _fig_thru_channel:

.. figure:: ./figures/thru_channel.png
:scale: 80%
:width: 100%
:alt: Impact of through channel

Impact on routing architecture when through channel in multi-width and multi-height programmable blocks: (a) disabled; (b) enabled.
Expand All @@ -73,12 +73,26 @@ Layout

.. warning:: You cannot use ``spread`` pin location for the ``height > 1`` or ``width >1`` tiles when using the tileable routing resource graph!!! Otherwise, it will cause undriven pins in your device!!!

.. option:: shrink_boundary="<bool>"

Remove all the routing wires in empty regions. This is mainly used in non-rectangle FPGAs to avoid redundant routing wires in blank area, as illustrated in :numref:`fig_shrink_boundary`.
By default, it is ``false``.

.. _fig_shrink_boundary:

.. figure:: ./figures/shrink_boundary.png
:width: 100%
:alt: Impact of shrink boundary

Impact on routing architecture when shrink-boundary: (a) disabled; (b) enabled.

.. warning:: Do NOT enable ``shrink_boundary`` if you are not using the tileable routing resource graph generator!

A quick example to show tileable routing is enabled and through channels are disabled:
A quick example to show tileable routing is enabled, other options, e.g., through channels are disabled:

.. code-block:: xml
<layout tileable="true" through_channel="false">
<layout tileable="true" through_channel="false" shrink_boundary="false">
</layout>
Switch Block
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 696116b

Please sign in to comment.