SystemVerilog to Verilog conversion
The primary goal of this project is to create a completely free and open-source tool for converting SystemVerilog to Verilog. While methods for performing this conversion already exist, they generally either rely on commercial tools, or are limited in scope.
The idea for this project was shared with me while I was an undergraduate at Carnegie Mellon University as part of a joint Computer Science and Electrical and Computer Engineering research project on open hardware under Professors Ken Mai and Dave Eckhardt. I have greatly enjoyed collaborating with the team at CMU since January 2019, even after my graduation the following May.
All of sv2v's dependencies are free and open-source.
Binaries for Ubuntu, macOS, and Windows are available on the releases page. If your system is not covered, or you would like to build the latest commit, simple instructions for building from source are below.
You must have Stack installed to build sv2v. Then you can:
git clone https://github.com/zachjs/sv2v.git cd sv2v make
This creates the executable at
./bin/sv2v. Stack takes care of installing exact (compatible) versions of the compiler and sv2v's build dependencies.
You can install the binary to your local bin path (typically
~/.local/bin) by running
stack install, or copy over the executable manually.
sv2v takes in a list of files and prints the converted Verilog to
--write=adjacentwill create a converted
.svinput file rather than printing to
Users may specify
includesearch paths, define macros during preprocessing, and exclude some of the conversions. Specifying
-as an input file will read from
Below is the current usage printout. This interface is subject to change.
sv2v [OPTIONS] [FILES]
Preprocessing: -I --incdir=DIR Add directory to include search path -D --define=NAME[=VALUE] Define a macro for preprocessing --siloed Lex input files separately, so macros from earlier files are not defined in later files --skip-preprocessor Disable preprocessor Conversion: -E --exclude=CONV Exclude a particular conversion (always, assert, interface, or logic) -v --verbose Retain certain conversion artifacts -w --write=MODE How to write output; default is 'stdout'; use 'adjacent' to create a .v file next to each input Other: --help Display help message --version Print version information --numeric-version Print just the version number
sv2v supports most synthesizable SystemVerilog features. Current notable exceptions include
defparamon interface instances and references to typedefs within interface instances. Assertions are also supported, but are simply dropped during conversion.
If you find a bug or have a feature request, please create an issue. Preference will be given to issues which include examples or test cases.
This project contains a preprocessor, lexer, and parser, and an abstract syntax tree representation for a subset of the SystemVerilog specification. The parser is not very strict. The AST allows for the representation of syntactically (and semantically) invalid Verilog. The goal is to be more general in the representation to enable more standardized and straightforward conversion procedures. This could be extended into an independent and more fully-featured front end if there is significant interest.
Once the test dependencies are installed, tests can be run with
make test. GitHub Actions is used to automatically test commits.
There is also a SystemVerilog compliance suite being created to test open-source tools' SystemVerilog support. Although not every test in the suite is applicable, it has been a valuable asset in finding edge cases.
This project was originally forked from Tom Hawkin's Verilog parser. While the front end has changed substantially to support the larger SystemVerilog standard, his project was a great starting point.
Reid Long was invaluable in developing this tool, providing significant tests and advice, and isolating many bugs. His projects can be found here.
Edric Kusuma helped me with the ins and outs of SystemVerilog, with which I had no prior experience, and has also helped with test cases.
Since sv2v's public release, several people have taken the time to file detailed bug reports and feature requests. I greatly appreciate their help in furthering the project.
See the LICENSE file for copyright and licensing information.