Skip to content

Commit a5e8bde

Browse files
committed
updated comments
1 parent a3a188a commit a5e8bde

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

doc/src/arch/reference.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2403,9 +2403,11 @@ The full format is documented below.
24032403

24042404
:opt_param switch_override:
24052405

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.
2406+
Specifies the name of a switch to be used to override the wire_switch of the segments in the ``to`` set.
2407+
Can be used to create switch patterns where different switches are used for different types of connections.
2408+
By using a zero-delay and zero-resistance switch one can also create T and L shaped wire segments.
24072409

2408-
**Default:** If no override is specified, the normal interconnect will be used.
2410+
**Default:** If no override is specified, the usual wire_switch that drives the ``to`` wire will be used.
24092411

24102412
.. arch:tag:: <from type="string" switchpoint="int, int, int, ..."/>
24112413

libs/libarchfpga/src/parse_switchblocks.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ void read_sb_switchfuncs(pugi::xml_node Node, t_switchblock_inf* sb, const pugiu
342342
}
343343

344344
static void parse_switch_override(const char* switch_override, t_wireconn_inf& wireconn, const t_arch_switch_inf* switches, int num_switches) {
345-
// check to see if user did not specify a switch_override
345+
// sentinel value to use default driving switch for the receiving wire type
346346
if (switch_override == std::string("")) {
347347
wireconn.switch_override_indx = DEFAULT_SWITCH; //Default
348348
return;

libs/libarchfpga/src/physical_types.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1689,6 +1689,7 @@ struct t_wireconn_inf {
16891689
SwitchPointOrder from_switchpoint_order = SwitchPointOrder::FIXED; //The desired from_switchpoint_set ordering
16901690
SwitchPointOrder to_switchpoint_order = SwitchPointOrder::FIXED; //The desired to_switchpoint_set ordering
16911691
int switch_override_indx = DEFAULT_SWITCH; // index in switch array of the switch used to override wire_switch of the 'to' set.
1692+
// DEFAULT_SWITCH is a sentinel value (i.e. the usual driving switch from a wire for the receiving wire will be used)
16921693

16931694
std::string num_conns_formula; /* Specifies how many connections should be made for this wireconn.
16941695
*

0 commit comments

Comments
 (0)