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

docs: cover amaranth.lib.fifo.

Browse source
This commit is contained in:
modwizcode 2021-12-13 00:38:30 -06:00 • committed by Catherine
parent 2adbe59e4f
commit d2c569c45e
3 changed files with 45 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/stdlib.rst
View file

@ -10,3 +10,4 @@ Standard library
stdlib/coding
stdlib/cdc
stdlib/fifo

18
docs/stdlib/fifo.rst Normal file
View file

@ -0,0 +1,18 @@
First-in first-out queues
#########################
.. py:module:: amaranth.lib.fifo
The ``amaranth.lib.fifo`` package provides modules for first-in, first-out queues.
.. autoclass:: FIFOInterface
.. note::
The :class:`FIFOInterface` class can be used directly to substitute a FIFO in tests, or inherited from in a custom FIFO implementation.
.. autoclass:: SyncFIFO(*, width, depth, fwft=True)
.. autoclass:: SyncFIFOBuffered(*, width, depth)
.. autoclass:: AsyncFIFO(*, width, depth, r_domain="read", w_domain="write", exact_depth=False)
.. autoclass:: AsyncFIFOBuffered(*, width, depth, r_domain="read", w_domain="write", exact_depth=False)