Skip to content

Commit bde66ab

Browse files
committed
added documentation for switch_override
1 parent a31de39 commit bde66ab

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

doc/src/arch/reference.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2301,7 +2301,7 @@ The full format is documented below.
23012301
Defined under the ``<switchfuncs>`` XML node, one or more ``<func...>`` entries is used to specify permutation functions that connect different sides of a switch block.
23022302

23032303

2304-
.. arch:tag:: <wireconn num_conns="expr" from_type="string, string, string, ..." to_type="string, string, string, ..." from_switchpoint="int, int, int, ..." to_switchpoint="int, int, int, ..." from_order="{fixed | shuffled}" to_order="{fixed | shuffled}"/>
2304+
.. arch:tag:: <wireconn num_conns="expr" from_type="string, string, string, ..." to_type="string, string, string, ..." from_switchpoint="int, int, int, ..." to_switchpoint="int, int, int, ..." from_order="{fixed | shuffled}" to_order="{fixed | shuffled}" switch_override="string"/>
23052305
23062306
:req_param num_conns:
23072307
Specifies how many connections should be created between the from_type/from_switchpoint set and the to_type/to_switchpoint set.
@@ -2401,6 +2401,12 @@ The full format is documented below.
24012401
24022402
.. note:: See ``from_switchpoint_order`` for value descritpions.
24032403

2404+
:opt_param switch_override:
2405+
2406+
Specifies the name of a switch to be used to override the wire_switch of the segments in the ``to`` set. Can be used to create more complicated wire structures such as T and L shaped segments.
2407+
2408+
**Default:** If no override is specified, the normal interconnect will be used.
2409+
24042410
.. arch:tag:: <from type="string" switchpoint="int, int, int, ..."/>
24052411
24062412
:req_param type:

0 commit comments

Comments
 (0)