Document FIFO properties

amaranth-lang / amaranth

A modern hardware definition language and toolchain based on Python

https://amaranth-lang.org/docs/amaranth/

BSD 2-Clause "Simplified" License

1.58k stars 174 forks source link

Document FIFO properties #1538

Open rroohhh opened 4 weeks ago

rroohhh commented 4 weeks ago

It would be nice if various properties of the FIFOs would be documented. What comes to mind is

maximum throughput (SyncFIFO of depth == 1 only does a throughput of 50%, same for SyncFIFOBuffered with depth <=2)
dependencies between the interface signals (does w_stream.ready depend combinatorially on r_stream.ready?, does r_stream.valid depend combinatorially on w_stream.valid?)

whitequark commented 4 weeks ago

We could do that, but I think I'm more interested in deprecating lib.fifo in favor of a stream-based lib.queue with nicer properties (e.g. higher throughput in edge cases).