Skip to content

Commit

Permalink
Deploying to gh-pages from @ aa7c069 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@jakubcabal
jakubcabal committed Nov 4, 2024
1 parent e3cb818 commit 54dc172
Show file tree
Hide file tree
Showing 210 changed files with 1,375 additions and 231 deletions.
33 changes: 33 additions & 0 deletions devel/_sources/comp/base/mem/mem_clear/readme.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. _mem_clear:

Memory clear
------------

Simple component that will generate addresses for memory clearing when RST is asserted.

Component port and generics description
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. vhdl:autoentity:: MEM_CLEAR
:noautogenerics:


Instance template
^^^^^^^^^^^^^^^^^

.. code-block::
data_clear_i : entity work.MEM_CLEAR
generic map (
DATA_WIDTH => BOX_WIDTH,
ITEMS => BOX_CNT,
CLEAR_EN => CLEAR_BY_RST
)
port map (
CLK => CLK,
RST => RST,
CLEAR_DONE => RST_DONE,
CLEAR_WR => wr_clear,
CLEAR_ADDR => wr_addr_clear
);
116 changes: 109 additions & 7 deletions devel/_sources/comp/debug/data_logger/readme.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,22 +171,124 @@ Instance template (full usage)
Control SW
^^^^^^^^^^

Folder ``data_logger/sw/`` contains ``Python3`` package that provides:
Folder ``data_logger/sw/`` contains following ``Python3`` packages:

* Module for basic interaction with ``DATA_LOGGER``
* Modules for ``DATA_LOGGER`` wraps like ``MEM_LOGGER``
* Simple graph generator based on `matplotlib` library
* Simple PDF / Markdown report generator
* Common tools
* ``data_logger`` ... basic interaction with ``DATA_LOGGER``
* ``mem_logger`` ... basic interaction with ``MEM_LOGGER``
* ``logger_stats`` ... loading firmware statistics (multiple ``DATA_LOGGERS`` can be organized in tree hierarchy)
* ``graph_tools`` ... simple plot functions for statistics from ``logger_stats``

Package can be installed using this command:

* You also need to install ``python nfb`` package

.. code-block::
python3 -m pip install --upgrade pip
# Install nfb:
cd swbase/pynfb
python3 -m pip install Cython
python3 -m pip install .
cd -
# Install this package:
cd data_logger/sw
python3 setup.py install --user
python3 -m pip install .
Example usage of ``logger_stats`` (for more usage see `mem_logger/mem_logger.py`):

.. code-block::
import logger_stats as Stats
from data_logger.data_logger import DataLogger
def create_stats():
# Create DataLoggers
logger_0 = DataLogger(index=0, dev='/dev/nfb0')
logger_1 = DataLogger(index=1, dev='/dev/nfb0')
# Create Stats hierarchy
stats = Stats.LoggerStats('Example stats')
stats_0 = Stats.LoggerStats('Logger 0 stats', logger=logger_0)
stats_1 = Stats.LoggerStats('Logger 1 stats', logger=logger_1)
stats.add_stat(stats_0)
stats.add_stat(stats_1)
# Add basic statistics
stats_0.add_stat(Stats.Constant(index=7, name='X'))
stats_0.add_stat(Stats.Counter(index=7, name='Y'))
stats_0.add_stat(Stats.Value(index=7, name='Z'))
# FSM state statistic
def fms_convert(v):
states = [
'IDLE',
...
]
if v >= len(states):
return "???"
else:
return states[int(v)]
fsm_format = Stats.FormatDefaultValue(format=Stats.FormatNone)
stats_1.add_stat(Stats.Value(2, 'FSM states', convert=fms_convert, format=fsm_format))
# Latency statistic
FREQ = 200 * 10**6
time_conv = Stats.ConvertTime(FREQ)
time_form = Stats.FormatDefaultValue(units='ns')
stats_1.add_stat(Stats.Value(9, 'Latency', convert=time_conv, format=time_form))
# Add value statistic which includes multiple commands
CMDS = [
'CMD_A',
...
]
stats_1.add_stat(Stats.ValueCMD(7, 'Latency of CMDs', cmd_width=2, cmds=CMDS, convert=time_conv, format=time_form))
# Add multiple counters
counters = [
'Counter A',
...
]
stats_1.add_stats(
name='Counters',
names=counters,
indexes=list(range(len(counters))),
constructor=lambda i, n: Stats.Counter(i, n)
)
return stats
stats = create_stats()
stats.load()
print(stats.to_str())
stats.save('stats.npz')
Example usage of ``graph_tools``:

from graph_tools.graph_tools import load_data, plot_counter, plot_value, plot_value_2d

stats = load_data('stats.npz')

node = pd.DataFrame.from_dict(stats['Stats A']['Counters'])
selected = ['Counter A', 'Counter B']

# Plot single counter
plot_counter(node['Counter X'], 'Time', 'Requests', 'Plot title')

# Plot multiple counters
plot_counter(node[selected], 'Time', 'Requests', 'Plot title')

# Plot histogram of the value interface
plot_value(node['Value A'], 'Time', 'Blocks', 'Title' log=True)

# Plot 2D histogram of the value interface history
plot_value_2d(node['Value A'], 'Time', 'Blocks', 'Title' log=True)



MI address space
Expand Down
4 changes: 4 additions & 0 deletions devel/_sources/memory.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ Allows setting type of memory (LUT, BRAM, URAM) or automatic mode. Optimized for

**SP_URAM_XILINX** - Structural implementation of single clock URAM memory based on Xilinx specific primitives with one read/write port. Only for Xilinx UltraScale+ FPGAs.

**<MEMORY>_CLEAR** - Wrap around **<MEMORY>** with additional clear logic.
Detailed :ref:`documentation can be found here<mem_clear>`.

.. toctree::
:maxdepth: 1
:hidden:
Expand All @@ -83,6 +86,7 @@ Allows setting type of memory (LUT, BRAM, URAM) or automatic mode. Optimized for
comp/base/mem/sdp_bram/readme
comp/base/mem/mp_bram/readme
comp/base/mem/lvt_mem/readme
comp/base/mem/mem_clear/readme
.. comp/base/mem/<something>
References
Expand Down
3 changes: 2 additions & 1 deletion devel/app-minimal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="fifo.html">FIFO components</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
Expand Down Expand Up @@ -732,7 +733,7 @@ <h2>The application MI offsets<a class="headerlink" href="#the-application-mi-of
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/async.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="fifo.html">FIFO components</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
Expand Down Expand Up @@ -601,7 +602,7 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="comp/base/mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="fifo.html">FIFO components</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
Expand Down Expand Up @@ -599,7 +600,7 @@ <h1>Basic Tools<a class="headerlink" href="#basic-tools" title="Link to this hea
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/comp/base/dsp/dsp_comparator/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="../../mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../../fifo.html">FIFO components</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
Expand Down Expand Up @@ -702,7 +703,7 @@
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/comp/base/fifo/asfifox/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="../../mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 current has-children"><a class="reference internal" href="../../../../fifo.html">FIFO components</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
Expand Down Expand Up @@ -777,7 +778,7 @@ <h2>Block diagram<a class="headerlink" href="#block-diagram" title="Link to this
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/comp/base/fifo/fifox/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="../../mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 current has-children"><a class="reference internal" href="../../../../fifo.html">FIFO components</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
Expand Down Expand Up @@ -803,7 +804,7 @@ <h2>Verification block diagram<a class="headerlink" href="#verification-block-di
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/comp/base/fifo/fifox_multi/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="../../mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 current has-children"><a class="reference internal" href="../../../../fifo.html">FIFO components</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
Expand Down Expand Up @@ -774,7 +775,7 @@ <h2>Read interface behavior<a class="headerlink" href="#read-interface-behavior"
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/comp/base/fifo/reg_fifo/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="../../mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../../fifo.html">FIFO components</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
Expand Down Expand Up @@ -661,7 +662,7 @@
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/comp/base/logic/barrel_shifter/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="../../mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../../fifo.html">FIFO components</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
Expand Down Expand Up @@ -771,7 +772,7 @@
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
3 changes: 2 additions & 1 deletion devel/comp/base/logic/cnt_multi_memx/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
<li class="toctree-l3"><a class="reference internal" href="../../mem/sdp_bram/readme.html#simple-dual-port-bram-with-byte-enable">Simple dual-port BRAM with Byte Enable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mp_bram/readme.html">Multi-port BRAM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/lvt_mem/readme.html">Live value table memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mem/mem_clear/readme.html">Memory clear</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../../fifo.html">FIFO components</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of FIFO components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
Expand Down Expand Up @@ -710,7 +711,7 @@
</div>
<div class="right-details">
<div style="font-size: var(--font-size--small)">
Git branch: devel<br>Git hash: bf3c4314
Git branch: devel<br>Git hash: aa7c0691
</div>

</div>
Expand Down
Loading

0 comments on commit 54dc172

Please sign in to comment.