diff --git a/docs/amaranth/latest/.buildinfo b/docs/amaranth/latest/.buildinfo index 9ebda14c..13528342 100644 --- a/docs/amaranth/latest/.buildinfo +++ b/docs/amaranth/latest/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 4076b18fd408fa5510f14ff1673098af +config: f93bf0f1860341e37c2fd56db2b980ea tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/amaranth/latest/.doctrees/environment.pickle b/docs/amaranth/latest/.doctrees/environment.pickle index 1c248d17..750c5075 100644 Binary files a/docs/amaranth/latest/.doctrees/environment.pickle and b/docs/amaranth/latest/.doctrees/environment.pickle differ diff --git a/docs/amaranth/latest/.doctrees/stdlib/memory.doctree b/docs/amaranth/latest/.doctrees/stdlib/memory.doctree index fcd2d4a1..afb07d52 100644 Binary files a/docs/amaranth/latest/.doctrees/stdlib/memory.doctree and b/docs/amaranth/latest/.doctrees/stdlib/memory.doctree differ diff --git a/docs/amaranth/latest/_images/example_fifo.svg b/docs/amaranth/latest/_images/example_fifo.svg deleted file mode 100644 index 2b3222c5..00000000 --- a/docs/amaranth/latest/_images/example_fifo.svg +++ /dev/null @@ -1,41 +0,0 @@ - - diff --git a/docs/amaranth/latest/_images/example_hello.svg b/docs/amaranth/latest/_images/example_hello.svg deleted file mode 100644 index 0a43f2f6..00000000 --- a/docs/amaranth/latest/_images/example_hello.svg +++ /dev/null @@ -1,22 +0,0 @@ - - diff --git a/docs/amaranth/latest/_sources/stdlib/memory.rst.txt b/docs/amaranth/latest/_sources/stdlib/memory.rst.txt index 2927a2c6..f5f6ad9b 100644 --- a/docs/amaranth/latest/_sources/stdlib/memory.rst.txt +++ b/docs/amaranth/latest/_sources/stdlib/memory.rst.txt @@ -74,7 +74,25 @@ In the following example, a read-only memory is used to output a fixed message i In this example, the memory read port is asynchronous, and a change of the address input (labelled `a` on the diagram below) results in an immediate change of the data output (labelled `d`). -.. image:: _images/memory/example_hello.svg +.. wavedrom:: memory/example_hello + + { + "signal": [ + {"name": "clk", + "wave": "0P............"}, + {"name": "rd_port.addr", + "wave": "==============", + "data": [0,1,2,3,4,5,6,7,8,9,10,11,0,1], + "node": ".a"}, + {"name": "rd_port.data", + "wave": "==============", + "data": ["H","e","l","l","o"," ","w","o","r","l","d","\\n","H","e"], + "node": ".d"} + ], + "edge": [ + "a-|d" + ] + } First-in, first-out queue @@ -112,7 +130,44 @@ In this example, the memory read and write ports are synchronous. A write operat However, the memory read port is also configured to be *transparent* relative to the memory write port. This means that if a write and a read operation (labelled `t`, `u` respectively) access the same row with address 3, the new contents will be read out, reducing the minimum push-to-pop latency to one cycle, down from two cycles that would be required without the use of transparency. -.. image:: _images/memory/example_fifo.svg +.. wavedrom:: memory/example_fifo + + { + "signal": [ + {"name": "clk", + "wave": "P........"}, + {"name": "push", + "wave": "01..0.10.", + "node": ".x"}, + {"name": "wr_port.addr", + "wave": "=.===..=.", + "data": ["0", "1", "2", "3", "4", "5"]}, + {"name": "wr_port.data", + "wave": "====..=..", + "data": ["00", "AA", "BB", "CC", "DD"], + "node": ".w....t"}, + {"name": "memory[0]", + "wave": "=.=......", + "data": ["00", "AA"], + "node": "..G"}, + {"name": "memory[3]", + "wave": "=......=.", + "data": ["00", "DD"], + "node": ".......H"}, + {"name": "pop", + "wave": "0..1...0.", + "node": "...y"}, + {"name": "rd_port.addr", + "wave": "=...====.", + "data": ["0", "1", "2", "3", "4", "5"]}, + {"name": "rd_port.data", + "wave": "=...====.", + "data": ["00", "AA", "BB", "CC", "DD"], + "node": "....r..u"} + ], "edge": [ + "x-~>G", "w->G", "y-~>r", "t->H", "t->u" + ] + } Memories diff --git a/docs/amaranth/latest/_static/documentation_options.js b/docs/amaranth/latest/_static/documentation_options.js index bc67809b..cd34b8b4 100644 --- a/docs/amaranth/latest/_static/documentation_options.js +++ b/docs/amaranth/latest/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.5.0.dev225', + VERSION: '0.5.0.dev226', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/amaranth/latest/changes.html b/docs/amaranth/latest/changes.html index 24981180..4a01dc7a 100644 --- a/docs/amaranth/latest/changes.html +++ b/docs/amaranth/latest/changes.html @@ -4,7 +4,7 @@ -