Export netlists from Yosys to DigitalJS
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests
.gitignore
.travis.yml
LICENSE
README.md
index.js
package-lock.json
package.json
process.js
run_tests.sh

README.md

Build Status

yosys2digitaljs

This program converts JSON netlist output generated by Yosys circuit synthesis software for use with the DigitalJS graphical circuit simulator.

Usage

You need to have Yosys installed to run yosys2digitaljs. For example, in Debian/Ubuntu, run:

apt install yosys

Clone the repository and install dependencies using npm:

git clone https://github.com/tilk/yosys2digitaljs.git
cd yosys2digitaljs
npm install

Now you can run yosys2digitaljs on your Verilog or SystemVerilog files:

./process.js file.v file.sv ...

The generated JSON is printed on standard output.

API

Yosys2digitaljs can be used as a library. The API is promise (or async/await) based. Available functions are:

  • process_sv(sv_text) - converts a single SystemVerilog source passed as a string.
  • process_files(texts) - converts multiple Verilog/SystemVerilog sources. The texts parameter is an object, with keys being file names, and corresponding values containing the file contents as strings. Example: { 'test.sv': 'module test; ...' }.
  • process(filenames, dirname) - converts Verilog/SystemVerilog sources saved on the filesystem under names filenames in the directory dirname.

The functions return a promise, which fulfills with an object value with following keys:

  • output: the conversion result as JS object, which can be stringified to JSON.
  • yosys_stdout and yosys_stderr: standard output and error output received from Yosys.

For bigger example, see the online app demo.