| 1 |
# Unstable IceStorm module |
| 2 |
|
| 3 |
This module is available since version 0.45.0. |
| 4 |
|
| 5 |
**Note**: this module is unstable. It is only provided as a technology |
| 6 |
preview. Its API may change in arbitrary ways between releases or it |
| 7 |
might be removed from Meson altogether. |
| 8 |
|
| 9 |
## Usage |
| 10 |
|
| 11 |
This module provides an experimental method to create FPGA bitstreams |
| 12 |
using the [IceStorm](http://www.clifford.at/icestorm/) suite of tools. |
| 13 |
|
| 14 |
The module exposes only one method called `project` and it is used |
| 15 |
like this: |
| 16 |
|
| 17 |
is.project('projname', |
| 18 |
<verilog files>, |
| 19 |
constraint_file : <pcf file>, |
| 20 |
) |
| 21 |
|
| 22 |
The input to this function is the set of Verilog files and a |
| 23 |
constraint file. This produces output files called `projname.asc`, |
| 24 |
`projname.blif` and `projname.bin`. In addition it creates two run |
| 25 |
targets called `projname-time` for running timing analysis and |
| 26 |
`projname-upload` that uploads the generated bitstream to an FPGA |
| 27 |
device using the `iceprog` programming executable. |