Skip to content

Commit 8d5b442

Browse files
update the arch reference to for segment z axis
1 parent eeb9dbf commit 8d5b442

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/src/arch/reference.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2001,16 +2001,16 @@ Wire Segments
20012001
The content within the ``<segmentlist>`` tag consists of a group of ``<segment>`` tags.
20022002
The ``<segment>`` tag and its contents are described below.
20032003
2004-
.. arch:tag:: <segment axis="{x|y}" name="unique_name" length="int" type="{bidir|unidir}" res_type="{GCLK|GENERAL}" freq="float" Rmetal="float" Cmetal="float">content</segment>
2004+
.. arch:tag:: <segment axis="{x|y|z}" name="unique_name" length="int" type="{bidir|unidir}" res_type="{GCLK|GENERAL}" freq="float" Rmetal="float" Cmetal="float">content</segment>
20052005
20062006
20072007
:opt_param axis:
2008-
Specifies if the given segment applies to either x or y channels only. If this tag is not given, it is assumed that the given segment
2009-
description applies to both x-directed and y-directed channels.
2008+
Specifies if the given segment applies to x, y, or z channels only. If this tag is not given, it is assumed that the given segment
2009+
description applies to both x-directed and y-directed channels (and not to z-directed channels).
20102010
20112011
.. note:: It is required that both x and y segment axis details are given or that at least one segment within ``segmentlist``
20122012
is specified without the ``axis`` tag (i.e. at least one segment applies to both x-directed and y-directed
2013-
chanels).
2013+
chanels). For 3-d architectures, it is required that at least one write segment with `axis="z"` is defined.
20142014
20152015
:req_param name:
20162016
A unique alphanumeric name to identify this segment type.

0 commit comments

Comments
 (0)