From 1d5a40b424b865c8f3ef940d7809db908344d7a6 Mon Sep 17 00:00:00 2001 From: Purdea Andrei Date: Sun, 4 Aug 2024 22:05:34 +0300 Subject: [PATCH] docs/stdlib/fifo: document fifo stream interfaces --- amaranth/lib/fifo.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/amaranth/lib/fifo.py b/amaranth/lib/fifo.py index 5b8be9cae..5d0aae86c 100644 --- a/amaranth/lib/fifo.py +++ b/amaranth/lib/fifo.py @@ -60,6 +60,10 @@ class FIFOInterface: Does nothing if ``r_rdy`` is not asserted. r_level : Signal(range(depth + 1)), out Number of unread entries. + w_stream : :class:`amaranth.lib.wiring.FlippedInterface` + Returns a flipped :class:`amaranth.lib.stream.Interface`, which is constructed by renaming the usual FIFO write signals. + r_stream : :class:`amaranth.lib.stream.Interface` + Returns a stream interface, which is constructed by renaming the usual FIFO read signals. {r_attributes} """