Documentation of slow_fir_filter release
========================================

This document contains technical documentation for the ``slow_fir_filter`` FPGA module.
It is generated from release ``slow_fir_filter-3.0.1+fa5f281d`` at 2023-02-28 07:21.


Release notes
-------------

Changelogs from Truestream follow the `keep a changelog <https://keepachangelog.com>`__ format.
Version numbers follow the `semantic versioning <https://semver.org>`__ scheme:
``MAJOR.MINOR.PATCH+HASH``.

* ``MAJOR`` will be incremented for incompatible API or functionality changes.
* ``MINOR`` will be incremented when new functionality is added in a backwards compatible manner.
* ``PATCH`` will be incremented for backwards compatible bug fixes.

The ``HASH`` field is the Git SHA that the release was made from.
It is included in the version number for internal traceability.

Release history and changelog follows below.

3.0.1+fa5f281d - (28 february 2023)
___________________________________

Update documentation with note on handshake rules.

3.0.0+fd52a59f - (17 september 2020)
____________________________________

Added

* Make coefficient set selectable per channel.

2.0.0+3c9f30b2 - (16 september 2020)
____________________________________

Added

* Add support for multiple coefficient sets.

1.0.1+ba513de5 - (28 august 2020)
_________________________________

Changes

* Documentation fixes

1.0.0+9c074c1e - (21 august 2020)
_________________________________

Initial release.



Design details
--------------

See the :ref:`module_slow_fir_filter` page for an overview and specification of the
``slow_fir_filter`` module.
Here you will also find a technical description of the different sub-modules.


Requirements
------------

This module has the following dependencies:

* The open-source `hdl_modules <https://hdl-modules.com>`__ project version ``2.0.0``.

* The Truestream module ``fir_filter_common`` version ``0.0.1``.




Library name
------------

This module's source files shall be compiled to a VHDL library symbolically named
``slow_fir_filter``.

.. toctree::
  :caption: Contents
  :hidden:

  modules/slow_fir_filter/slow_fir_filter.rst