docs: formatting and readability improvements.

This commit is contained in:
Catherine 2021-12-13 06:33:36 +00:00
parent 18837b9029
commit 2adbe59e4f
3 changed files with 9 additions and 8 deletions

View file

@ -27,7 +27,7 @@ class FFSynchronizer(Elaboratable):
o_domain : str
Name of output clock domain.
reset : int
Reset value of the flip-flops. On FPGAs, even if ``reset_less`` is True,
Reset value of the flip-flops. On FPGAs, even if ``reset_less`` is ``True``,
the :class:`FFSynchronizer` is still set to this value during initialization.
reset_less : bool
If ``True`` (the default), this :class:`FFSynchronizer` is unaffected by ``o_domain``
@ -39,10 +39,6 @@ class FFSynchronizer(Elaboratable):
Maximum delay from the input signal's clock to the first synchronization stage, in seconds.
If specified and the platform does not support it, elaboration will fail.
Platform overrides
------------------
Define the ``get_ff_sync`` platform method to override the implementation of
:class:`FFSynchronizer`, e.g. to instantiate library cells directly.
.. note::
@ -51,7 +47,7 @@ class FFSynchronizer(Elaboratable):
the FPGA loads its configuration.
However, in designs where the value of the :class:`FFSynchronizer` must be valid immediately
after reset, consider setting ``reset_less`` to False if any of the following is true:
after reset, consider setting ``reset_less`` to ``False`` if any of the following is true:
- You are targeting an ASIC, or an FPGA that does not allow arbitrary initial flip-flop states;
- Your design features warm (non-power-on) resets of ``o_domain``, so the one-time
@ -60,6 +56,11 @@ class FFSynchronizer(Elaboratable):
its reset value until ``o_domain`` reset specifically is deasserted.
:class:`FFSynchronizer` is reset by the ``o_domain`` reset only.
Platform overrides
------------------
Define the ``get_ff_sync`` platform method to override the implementation of
:class:`FFSynchronizer`, e.g. to instantiate library cells directly.
"""
def __init__(self, i, o, *, o_domain="sync", reset=0, reset_less=True, stages=2,
max_input_delay=None):

View file

@ -3,7 +3,7 @@ Clock domain crossing
.. py:module:: amaranth.lib.cdc
The ``amaranth.lib.cdc`` package provides modules for transferring data between clock domains.
The :mod:`amaranth.lib.cdc` package provides modules for transferring data between clock domains.
.. autoclass:: FFSynchronizer()

View file

@ -3,7 +3,7 @@ Code conversion
.. py:module:: amaranth.lib.coding
The ``amaranth.lib.coding`` package provides modules for conversion between different encodings of binary numbers.
The :mod:`amaranth.lib.coding` package provides modules for conversion between different encodings of binary numbers.
One-hot coding