Added documentation to IceStorm module.

pull/2228/head
Jussi Pakkanen 7 years ago
parent 2601cbe8a8
commit 80ac62c1a5
  1. 27
      docs/markdown/Icestorm-module.md
  2. 12
      docs/markdown/snippets/fpga.md
  3. 1
      docs/sitemap.txt

@ -0,0 +1,27 @@
# Unstable SIMD module
This module provides is available since version 0.45.0.
**Note**: this module is unstable. It is only provided as a technology
preview. Its API may change in arbitrary ways between releases or it
might be removed from Meson altogether.
## Usage
This module provides an experimental to create FPGA bitstreams using
the [IceStorm](http://www.clifford.at/icestorm/) suite of tools.
The module exposes only one method called `project` and it is used
like this:
is.project('projname',
<verilog files>,
constraint_file : <pcf file>,
)
The input to this function is the set of Verilog files and a
constraint file. This produces output files called `projname.asc`,
`projname.blif` and `projname.bin`. In addition it creates two run
targets called `projname-time` for running timing analysis and
`projname-upload` that uploads the generated bitstream to an FPGA
devide using the `iceprog` programming executable.

@ -0,0 +1,12 @@
## Experimental FPGA support
This version adds support for generating, analysing and uploading FPGA
programs using the [IceStorm
toolchain](http://www.clifford.at/icestorm/). This support is
experimental and is currently limited to the `iCE 40` series of FPGA
chips.
FPGA generation integrates with other parts of Meson seamlessly. As an
example, [here](https://github.com/jpakkane/lm32) is an example
project that compiles a simple firmware into Verilog and combines that
with an lm32 softcore processor.

@ -30,6 +30,7 @@ index.md
Modules.md
Gnome-module.md
i18n-module.md
Icestorm-module.md
Pkgconfig-module.md
Python-3-module.md
Qt4-module.md

Loading…
Cancel
Save