Skip to content

Commit f11aaea

Browse files
committed
update documentation for segment definition in the architecture file
1 parent 1d3946b commit f11aaea

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/src/arch/reference.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2036,6 +2036,26 @@ The ``<segment>`` tag and its contents are described below.
20362036
20372037
Tag must be included and ``name`` must be the same as the name you give in ``<switch type="mux" name="...``
20382038
2039+
.. arch:tag:: <mux_inc name="string"/>
2040+
2041+
:req_param name:
2042+
Name of the mux switch type used to drive the incremental wires in this segment from both block outputs and other wires.
2043+
Incremental wires are tracks within this segment that are heading in the "right" direction on the x-axis and the "top" direction on the y-axis.
2044+
This information is used during rr-graph construction, and a custom switch block can override this switch type for specific connections if desired.
2045+
2046+
.. note:: For UNIDIRECTIONAL only.
2047+
2048+
.. arch:tag:: <mux_dec name="string">
2049+
2050+
:req_param name:
2051+
Name of the mux switch type used to drive the decremental wires in this segment from both block outputs and other wires.
2052+
Incremental wires are tracks within this segment that are heading in the "left" direction on the x-axis and the "bottom" direction on the y-axis.
2053+
This information is used during rr-graph construction, and a custom switch block can override this switch type for specific connections if desired.
2054+
2055+
.. note:: For UNIDIRECTIONAL only.
2056+
2057+
.. note:: For unidirectional segments, either <mux> tag or both <mux_inc> and <mux_dec> should be defined in the architecture file. If only the <mux> tag is defined, we assume that the same mux drives both incremental and decremental wires within this segment.
2058+
20392059
.. arch:tag:: <wire_switch name="string"/>
20402060
20412061
:req_param name: Name of the switch type used by other wires to drive this type of segment by default. This information is used during rr-graph construction, and a custom switch block can override this switch type for specific connections if desired.

0 commit comments

Comments
 (0)