ice40 0.3.0

An embedded-hal driver for configuration of ice40 FPGA devices.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

[![CI](https://github.com/Atmelfan/ice40-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/Atmelfan/ice40-rs/actions/workflows/ci.yml)

# ice40-rs
This is an [embedded-hal] driver for configuration of [iCE40 series FPGAs](https://www.latticesemi.com/Products.aspx) from [Lattice](https://www.latticesemi.com/).

See technical note [TN1248 - iCE40 Programming and Configuration](https://www.latticesemi.com/~/media/LatticeSemi/Documents/ApplicationNotes/IK/iCE40ProgrammingandConfiguration.pdf) on how the slave configuration interfaceworks.


# Quickstart
```toml
[dependencies]
ice40-rs = "0.3"
```

# Example

```rust
// Configure device with bitstream
let mut device = ice40::Device::new(spi, ss, done, reset, DummyDelay);
device
    .configure(&bitstream[..])
    .expect("Failed to configure FPGA");
```

The examples folder contains a utility for configuring a device using linux and ftdi embedded-hal.

You can use them with the following commands:

## FTDI
Assumes the FTDI circuit is connected like the ice40-breakout board.

`cargo run --example ftdi -- my_image.bin`
```
ice40-rs/ftdi 0.1.0
FTDI demo

USAGE:
    ftdi [OPTIONS] <binary>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -f, --frequency <frequency>    Bus frequency [default: 3000000]

ARGS:
    <binary>    Binary file
```

## Linux
Default arguments are for a Raspberry pi Model 4.

`cargo run --example linux -- my_image.bin`
```
ice40-rs/linux 0.1.0
Linux demo

USAGE:
    linux [OPTIONS] <binary>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --cdone <cdone>            CDONE pin [default: 24]
        --creset <creset>          CRESET pin [default: 25]
    -f, --frequency <frequency>    Bus frequency [default: 3000000]
        --spi <spi>                SPI bus [default: /dev/spidev0.0]
        --ss <ss>                  SS pin [default: 8]

ARGS:
    <binary>    Binary file
```

# Limitations
The library only support volatile configuration of the device, not external nonvolatile memory.

[embedded-hal]: https://github.com/rust-embedded/embedded-hal