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

hdl.ast: improve ClockSignal, ResetSignal documentation.

Browse source
This commit is contained in:
whitequark 2018-12-15 14:58:31 +00:00
parent 790eb05a92
commit f603b735e8
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
nmigen/hdl/ast.py
View file

@ -606,10 +606,11 @@ class Signal(Value, DUID):
class ClockSignal(Value):
"""Clock signal for a given clock domain.
"""Clock signal for a clock domain.
``ClockSignal`` s for a given clock domain can be retrieved multiple
times. They all ultimately refer to the same signal.
Any ``ClockSignal`` is equivalent to ``cd.clk`` for a clock domain with the corresponding name.
All of these signals ultimately refer to the same signal, but they can be manipulated
independently of the clock domain, even before the clock domain is created.
Parameters
----------
@ -633,10 +634,11 @@ class ClockSignal(Value):
class ResetSignal(Value):
"""Reset signal for a given clock domain
"""Reset signal for a clock domain.
``ResetSignal`` s for a given clock domain can be retrieved multiple
times. They all ultimately refer to the same signal.
Any ``ResetSignal`` is equivalent to ``cd.rst`` for a clock domain with the corresponding name.
All of these signals ultimately refer to the same signal, but they can be manipulated
independently of the clock domain, even before the clock domain is created.
Parameters
----------