saji/yosys4gal
1
0
Fork 0
mirror of https://github.com/annoyatron255/yosys4gal.git synced 2024-12-22 10:42:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Create compiler README.md

Browse source
This commit is contained in:
Saji 2024-05-06 02:19:05 -05:00 committed by GitHub
parent f1da587c47
commit f3584421dd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
compiler/README.md Normal file
View file

@ -0,0 +1,30 @@
# `ver2gal`: Yosys Netlist-to-JEDEC compiler
This program converts a Yosys JSON netlist that has been techmapped with the GAL techlib to a JEDEC fuse file to be flashed to hardware.
## Build and Install
You'll need a relatively recent version of Rust and `cargo`, the package manager. If the version included in your distribution is too old, install `rustup` to install
a recent stable release.
Build with `cargo build`. This will produce a `ver2gal` binary in `target/debug`. The program can be installed globally with `cargo install --path .`.
## Usage
The primary mode is the `synth` subcommand:
```
Usage: ver2gal synth [OPTIONS] <NETLIST> <CONSTRAINTS>
Arguments:
<NETLIST>
<CONSTRAINTS>
Options:
--chip <CHIP> [default: gal16v8] [possible values: gal16v8, gal22v10]
-h, --help Print help
```
When provided a netlist JSON file and a PCF constraints file it will produce a `.jed` fuse file called `output.jed`.
**Important Note**: This program should be run in the same directory as the `shrink_sop.tcl` script, as it will automatically call the script
if a SOP needs to be split. This should only be necessary in the `gal22v10` mode.