bensampson5 / libsv Goto Github PK

Applies to all branches

Task list:

• Implement format check for C++ files
• Implement format check for SystemVerilog/Verilog files

Useful badges:

• current pypi version
• main ci status
• docs build status (on main branch)

Implement a BCD encoder

The catalog needs to be started with at least one kind of IP. Let's pick a parameterized counter that counts up.

Tasks:

• Create a new Verilog file counter.v
• Write a testbench for it
• Simulate it to validate it's operation

Develop a purely combinatorial circuit for a BCD decoder (bcd -> bin)

Add IP block for constant values of variable width

Using readthedocs

Must update to resolve issue with multiple tags being generated for only getting the right one from ${{ steps.docker_meta.outputs.tags }}. Also migrate to metadata-action instead of crazy-max/ghaction-docker-meta

https://github.com/marketplace/actions/create-issue-branch

Thought that https://github.com/SymbiFlow/sphinxcontrib-hdl-diagrams might be a good fit but it doesn't parse SystemVerilog. Maybe we can follow up with them to get support for SystemVerilog because it looks like Yosys can synthesize SV.

Test should always run after Docker so we get the new image to run tests with!

Add a linter for SystemVerilog/Verilog.

I think Verilator has one but Verible definitely has one. So compare and pick one

Add functionality to ci.yml so that each branch gets its own docker image on openhdl's docker hub. Here are the rules:

1. If new branch created, then retag the source branch's docker image so that new branch has it's own image
2. If branch == "main" or starts with "docker-" then always build and push a new docker image with every commit
3. All other CI steps run with the specific branch's docker image
4. Upon branch deletion, then remove that docker image from Docker Hub

clang-tidy?

Add Include What You Use (IWYU) check for C++ code

Consider adding a github action to automatically delete a docker hub openhdl image if the branch was deleted in the openhdl github repository

Currently ModuleWrapper requires 1 clock and 1 reset signal in the module. Make this optional.

Use clang-format. Will have to pick a style

Task list:

• Pick a formatting style
• Add format style file to project
• Add C++ formatting step to precommit script

Create a CONTRIBUTING.md with instructions on how to add to the project

Maybe use pip initially?

Task list:

• Should not be startsWith for main comparison, should just be ==
• Retag docker image on new remote branch creation (only builds docker if branch == main or starts with "docker-"

A docker image is completely rebuilt on a push to a new branch but this is very time consuming. Ideally, the better alternative is just to retag the docker image from the source branch for the new created branch.

.cmake-format.yaml?

Oops. Forgot to change it back

Ultimately, I would like to add some examples as well where you can view the waveform

How to build docker image, how to run testbenches and view simulation results