Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation of MID wires #167

Merged
merged 3 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/source/fabric_definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,17 @@ specifying:
In summary, the example shows how a termination tile can be used to provide more complex interface blocks and all this can be easily modelled and implemented with FABulous.

.. note:: The ``destination_name`` is refering to the port name used at the destination tile. FABulous will throw an error if the destination tile does not provide that port name.

Aside from ``BEGIN`` and ``END``, there also exist ``MID`` ports, which are used for wires spanning over two tiles.
IAmMarcelJung marked this conversation as resolved.
Show resolved Hide resolved
Although they route over two tiles, they also have a tap on the middle tile.
On the middle tile, the sink is called ``MID`` while the source is still a ``BEG`` port with the addition of ``b``.
In the example below this is illustrated. The wire on the left goes from ``E2BEG0`` to ``E2MID`` which is the tap on the middle tile.
Inside the switch matrix, ``E2MID`` and ``E2BEGb`` are connected. The left wire the starts at ``E2BEGb`` and ends at ``E2END``.
IAmMarcelJung marked this conversation as resolved.
Show resolved Hide resolved

.. figure:: figs/mid_wires.*
:alt: Basic tile illustration
:width: 100%
:align: center

* ``X-offset``, ``signed_int``

Expand Down
Binary file added docs/source/figs/mid_wires.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading