Arithmetic Units

Collection of arithmetic units written in SystemVerilog.

Setup

Tested in Ubuntu 24.04.

1. Set up the python environment:

   1. Install Miniconda.

   2. Create the environment (only the first time):

      conda env create -f environment.yml

   3. Activate the environment (every time you open a new terminal):

      conda activate arithmetic_units

2. Install the Icarus Verilog simulator. We currently use version 12.0. In Ubuntu 24.04, you can do this with:

   sudo apt install iverilog

3. Install Verible for SystemVerilog linting and formatting. We currently use version v0.0-4023-gc1271a00. In Ubuntu, you can do this with:

   export VERIBLE_VERSION=v0.0-4023-gc1271a00
   wget https:wget https://github.com/chipsalliance/verible/releases/download/${VERIBLE_VERSION}/verible-${VERIBLE_VERSION}-linux-static-x86_64.tar.gz
   tar -xf verible-${VERIBLE_VERSION}-linux-static-x86_64.tar.gz

   Then you can install it to your preferred location. For example, to install it in /home/$USER/tools, run:

   mkdir -p /home/$USER/tools/verible/${VERIBLE_VERSION}/
   mv verible-${VERIBLE_VERSION}/* /home/$USER/tools/verible/${VERIBLE_VERSION}/

   You can remove the previous download from the current path with:

   rm -rf verible-${VERIBLE_VERSION}*

   Finally, add the /home/$USER/tools/verible/${VERIBLE_VERSION}/bin to your PATH environment variable.

Running the Tests

The test setup is based on cocotb and pytest. You can find all the tests in the test folder.

To run the tests, run:

make test

If you want the detailed output, run:

pytest -rA -v

Running Formatting and Linting

To format your code run:

make format

To run the Verible linter for SystemVerilog run:

make verible-lint

Bibliography

[1] M. D. Ercegovac and T. Lang, Digital Arithmetic. 2003. doi: 10.1016/B978-1-55860-798-9.X5000-3. [2] J.-M. Muller et al., Handbook of Floating-Point Arithmetic. Cham: Springer International Publishing, 2018. doi: 10.1007/978-3-319-76526-6.

License

This project is licensed under the CERN Open Hardware Licence Version 2 - Weakly Reciprocal or later, unless specified otherwise. The license is also included in this repository in the LICENSES directory. SPDX-License-Identifier: CERN-OHL-W-2.0+

The software (i.e. all code inside the test directory) is licensed under the GNU Lesser General Public License v3.0 or later, unless specified otherwise. The license is also included in this repository in the LICENSES directory. SPDX-License-Identifier: LGPL-3.0-or-later

This project uses the REUSE tool to manage licenses. For more information, please refer to https://reuse.software/. To check the compliance of this repository with the REUSE guidelines, run:

reuse lint