usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

hdl.ast: update documentation for Signal.

Browse source 
Fixes #288.
This commit is contained in:
whitequark 2020-02-01 23:15:18 +00:00
parent 49758a3a0c
commit a295e3599c
1 changed files with 6 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
nmigen/hdl/ast.py
View file

@ -773,15 +773,13 @@ class Signal(Value, DUID):
Parameters Parameters
---------- ----------
shape : int or tuple or None shape : ``Shape``-castable object or None
Either an integer ``width`` or a tuple ``(width, signed)`` specifying the number of bits Specification for the number of bits in this ``Signal`` and its signedness (whether it
in this ``Signal`` and whether it is signed (can represent negative values). can represent negative values). See ``Shape.cast`` for details.
``shape`` defaults to 1-bit and non-signed. If not specified, ``shape`` defaults to 1-bit and non-signed.
name : str name : str
Name hint for this signal. If ``None`` (default) the name is inferred from the variable Name hint for this signal. If ``None`` (default) the name is inferred from the variable
name this ``Signal`` is assigned to. Name collisions are automatically resolved by name this ``Signal`` is assigned to.
prepending names of objects that contain this ``Signal`` and by appending integer
sequences.
reset : int or integral Enum reset : int or integral Enum
Reset (synchronous) or default (combinatorial) value. Reset (synchronous) or default (combinatorial) value.
When this ``Signal`` is assigned to in synchronous context and the corresponding clock When this ``Signal`` is assigned to in synchronous context and the corresponding clock
@ -792,11 +790,6 @@ class Signal(Value, DUID):
If ``True``, do not generate reset logic for this ``Signal`` in synchronous statements. If ``True``, do not generate reset logic for this ``Signal`` in synchronous statements.
The ``reset`` value is only used as a combinatorial default or as the initial value. The ``reset`` value is only used as a combinatorial default or as the initial value.
Defaults to ``False``. Defaults to ``False``.
min : int or None
max : int or None
If ``shape`` is ``None``, the signal bit width and signedness are
determined by the integer range given by ``min`` (inclusive,
defaults to 0) and ``max`` (exclusive, defaults to 2).
attrs : dict attrs : dict
Dictionary of synthesis attributes. Dictionary of synthesis attributes.
decoder : function or Enum decoder : function or Enum
@ -813,6 +806,7 @@ class Signal(Value, DUID):
reset : int reset : int
reset_less : bool reset_less : bool
attrs : dict attrs : dict
decoder : function
""" """
def __init__(self, shape=None, *, name=None, reset=0, reset_less=False, def __init__(self, shape=None, *, name=None, reset=0, reset_less=False,