Skip to content

Commit 6752cf7

Browse files
Merge pull request #3746 from mg-04/patch-1
Fix XML syntax in reference documentation `arch/reference.rst`
2 parents f6f4929 + 01c9d6f commit 6752cf7

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

doc/src/arch/reference.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ One example is the IDELAYCTRL of the Series7 devices, which takes as input a ref
4747
Each model tag must contain 2 tags: ``<input_ports>`` and ``<output_ports>``.
4848
Each of these contains ``<port>`` tags:
4949

50-
.. arch:tag:: <port name="string" is_clock="{0 | 1} clock="string" combinational_sink_ports="string1 string2 ..."/>
50+
.. arch:tag:: <port name="string" is_clock="{0 | 1}" clock="string" combinational_sink_ports="string1 string2 ..."/>
5151
5252
:req_param name: The port name.
5353

@@ -421,7 +421,7 @@ Grid Location Tags
421421
.. code-block:: xml
422422
423423
<!-- Create IO's around the device perimeter -->
424-
<perimeter type="io" priority=10"/>
424+
<perimeter type="io" priority="10"/>
425425
426426
<!-- Create a column of RAMs starting at column 2, and
427427
repeating every 3 columns. Note that a vertical offset
@@ -475,7 +475,7 @@ Grid Location Tags
475475

476476
<row> DSP example
477477

478-
.. arch:tag:: <region type="string" priority="int" startx="expr" endx="expr repeatx="expr" incrx="expr" starty="expr" endy="expr" repeaty="expr" incry="expr"/>
478+
.. arch:tag:: <region type="string" priority="int" startx="expr" endx="expr" repeatx="expr" incrx="expr" starty="expr" endy="expr" repeaty="expr" incry="expr"/>
479479
480480
:req_param type:
481481
The name of the top-level complex block type (i.e. ``<pb_type>``) being specified.
@@ -586,7 +586,7 @@ Grid Layout Example
586586
<!-- Specifies an auto-scaling square FPGA floorplan -->
587587
<auto_layout aspect_ratio="1.0">
588588
<!-- Create I/Os around the device perimeter -->
589-
<perimeter type="io" priority=10"/>
589+
<perimeter type="io" priority="10"/>
590590
591591
<!-- Nothing in the corners -->
592592
<corners type="EMPTY" priority="100"/>
@@ -1394,7 +1394,7 @@ The following tags are common to all ``<tile>`` tags:
13941394
<sb_loc type="full" xoffset="1" yoffset="0"> <!-- Right edge -->
13951395
<sb_loc type="full" xoffset="1" yoffset="1"> <!-- Right edge -->
13961396
<sb_loc type="full" xoffset="1" yoffset="2"> <!-- Top Right -->
1397-
<switchblock_locations/>
1397+
</switchblock_locations>
13981398
13991399
.. _arch_complex_blocks:
14001400

@@ -1880,7 +1880,7 @@ Timing is specified through tags contained with in ``pb_type``, ``complete``, ``
18801880
4.6e-10 1.9e-10 2.2e-10
18811881
4.5e-10 6.7e-10 3.5e-10
18821882
7.1e-10 2.9e-10 8.7e-10
1883-
</delay>
1883+
</delay_matrix>
18841884
18851885
.. note:: To specify both ``max`` and ``min`` delays two ``<delay_matrix>`` should be used.
18861886

@@ -2977,7 +2977,7 @@ The full format is documented below.
29772977
<wireconn num_conns_type="to"/>
29782978
<from type="L4" switchpoint="0,1,2,3"/>
29792979
<from type="L16" switchpoint="0,4,8,12"/>
2980-
<to type="L4" switchpoint="0/>
2980+
<to type="L4" switchpoint="0"/>
29812981
</wireconn>
29822982
29832983
This specifies that the 'from' set is the union of L4 switchpoints 0, 1, 2 and 3; and L16 switchpoints 0, 4, 8 and 12.
@@ -3014,30 +3014,30 @@ An example is shown below:
30143014
<gather>
30153015
<!-- Gather 30 connections from the 0, 4, 8 or 12 position of L16 wires of all four sides of a switchblock location -->
30163016
<wireconn num_conns="30" from_type="L16" from_switchpoint="0,12,8,4" side="rltb"/>
3017-
<gather/>
3017+
</gather>
30183018
30193019
<scatter>
30203020
<!-- Scatter 30 connections to the starting position of L16 wires of all four sides of a switchblock location -->
30213021
<wireconn num_conns="30" to_type="L16" to_switchpoint="0" side="rtlb"/>
3022-
<scatter/>
3022+
</scatter>
30233023
30243024
<sg_link_list>
30253025
<!-- Link going up one layer, using the '3D_SB_MUX' multiplexer to gather connections from the bottom layer and using the 'TSV' node/wire to move up one layer -->
30263026
<sg_link name="L_UP" z_offset="1" x_offset="0" y_offset="0" mux="3D_SB_MUX" seg_type="TSV"/>
30273027
<!-- Same as above but moving one layer down -->
30283028
<sg_link name="L_DOWN" z_offset="-1" mux="3D_SB_MUX" seg_type="TSV"/>
3029-
<sg_link_list/>
3029+
</sg_link_list>
30303030
30313031
<!-- Instantiate 10 'L_UP' sg_links per switchblock location everywhere on the device -->
30323032
<sg_location type="EVERYWHERE" num="10" sg_link="L_UP"/>
30333033
<!-- Instantiate 10 'L_DOWN' sg_links per switchblock location everywhere on the device -->
30343034
<sg_location type="EVERYWHERE" num="10" sg_link="L_DOWN"/>
3035-
<sg_pattern/>
3035+
</sg_pattern>
30363036
30373037
<sg_pattern name="interposer_conn_sg" type="bidir">
30383038
... <!-- Another scatter-gather pattern specification -->
3039-
<sg_pattern/>
3040-
<scatter_gather_list/>
3039+
</sg_pattern>
3040+
</scatter_gather_list>
30413041
30423042
.. arch:tag:: <sg_pattern name="string" type={unidir|bidir}>
30433043
@@ -3341,7 +3341,7 @@ In the tileable architecture file, you may define additional attributes for each
33413341
33423342
<direct_connection>
33433343
<direct name="string" circuit_model_name="string" interconnection_type="string" x_dir="string" y_dir="string"/>
3344-
</directlist>
3344+
</direct_connection>
33453345
33463346
.. note:: these options are optional. However, if ``interconnection_type`` is set to ``inter_column`` or ``inter_row``, then ``x_dir`` and ``y_dir`` are required.
33473347

0 commit comments

Comments
 (0)