rust-hdl 0.46.0

Write firmware for FPGAs in Rust
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use rust_hdl::prelude::*;

#[derive(LogicBlock)]
struct HostSDRAMControllerTest {
    pc_to_host: SyncFIFO<Bits<8>, 3, 4, 1>,
    host_to_pc: SyncFIFO<Bits<8>, 3, 4, 1>,
    bidi_dev: BidiSimulatedDevice<Bits<8>>,
    host: Host<8>,
    core: SDRAMController<5, 5>,
    buffer: SDRAMOnChipBuffer<16>,
    chip: SDRAMSimulator<5, 5, 10, 16>,
    pub bidi_clock: Signal<In, Clock>,
    pub sys_clock: Signal<In, Clock>,
}

impl Logic for HostSDRAMControllerTest {
    #[hdl_gen]
    fn update(&mut self) {
        FIFOReadController::<Bits<8>>::join(
            &mut self.bidi_dev.data_to_bus,
            &mut self.pc_to_host.bus_read,
        );
        FIFOWriteController::<Bits<8>>::join(
            &mut self.bidi_dev.data_from_bus,
            &mut self.host_to_pc.bus_write,
        );
        clock!(self, bidi_clock, host_to_pc, pc_to_host);
        self.bidi_dev.clock.next = self.bidi_clock.val();
        BidiBusD::<Bits<8>>::join(&mut self.bidi_dev.bus, &mut self.host.bidi_bus);
        self.host.bidi_clock.next = self.bidi_clock.val();
        self.host.sys_clock.next = self.sys_clock.val();
        SoCBusController::<16, 8>::join(&mut self.host.bus, &mut self.core.upstream);
        SDRAMDriver::<16>::join(&mut self.core.dram, &mut self.buffer.buf_in);
        SDRAMDriver::<16>::join(&mut self.buffer.buf_out, &mut self.chip.sdram);
    }
}

impl Default for HostSDRAMControllerTest {
    fn default() -> Self {
        let timings = MemoryTimings::fast_boot_sim(100e6);
        Self {
            pc_to_host: Default::default(),
            host_to_pc: Default::default(),
            bidi_dev: Default::default(),
            host: Default::default(),
            core: SDRAMController::new(3, timings, OutputBuffer::DelayTwo),
            buffer: Default::default(),
            chip: SDRAMSimulator::new(timings),
            bidi_clock: Default::default(),
            sys_clock: Default::default(),
        }
    }
}

#[cfg(test)]
fn make_sdram_test() -> HostSDRAMControllerTest {
    let mut uut = HostSDRAMControllerTest::default();
    uut.pc_to_host.bus_write.data.connect();
    uut.pc_to_host.bus_write.write.connect();
    uut.host_to_pc.bus_read.read.connect();
    uut.connect_all();
    uut
}

#[test]
fn test_sdram_test_synthesizes() {
    let uut = make_sdram_test();
    let vlog = generate_verilog(&uut);
    yosys_validate("sdram_test", &vlog).unwrap();
}

#[test]
fn test_sdram_controller_boots() {
    let uut = make_sdram_test();
    let mut sim = Simulation::new();
    sim.add_clock(5_000, |x: &mut Box<HostSDRAMControllerTest>| {
        x.sys_clock.next = !x.sys_clock.val();
    });
    sim.add_clock(10_000, |x: &mut Box<HostSDRAMControllerTest>| {
        x.bidi_clock.next = !x.bidi_clock.val();
    });
    sim.add_testbench(move |mut sim: Sim<HostSDRAMControllerTest>| {
        let mut x = sim.init()?;
        wait_clock_cycles!(sim, bidi_clock, x, 20); // Wait for reset
        wait_clock_true!(sim, bidi_clock, x);
        hls_host_ping!(sim, bidi_clock, x, pc_to_host, 0x67);
        let reply = hls_host_get_word!(sim, bidi_clock, x, host_to_pc);
        sim_assert_eq!(sim, reply, 0x167, x);
        // Write to the SDRAM chip - first send the data...
        hls_host_write!(
            sim,
            bidi_clock,
            x,
            pc_to_host,
            0,
            [0x1234, 0x5678, 0xDEAD, 0xBEEF]
        );
        // Write the address
        hls_host_write!(sim, bidi_clock, x, pc_to_host, 1, [0x0000, 0x0000]);
        // Write the write command
        hls_host_write!(sim, bidi_clock, x, pc_to_host, 2, [0x0001]);
        // Write to the SDRAM chip at the next set of addresses
        hls_host_write!(
            sim,
            bidi_clock,
            x,
            pc_to_host,
            0,
            [0xCAFE, 0xBABE, 0xEFFE, 0x5EA1]
        );
        hls_host_write!(sim, bidi_clock, x, pc_to_host, 1, [0x0000, 0x0004]);
        hls_host_write!(sim, bidi_clock, x, pc_to_host, 2, [0x0001]);
        // Read from the SDRAM chip
        hls_host_write!(sim, bidi_clock, x, pc_to_host, 1, [0x0000, 0x0000]);
        hls_host_write!(sim, bidi_clock, x, pc_to_host, 2, [0x0000]);
        hls_host_issue_read!(sim, bidi_clock, x, pc_to_host, 3, 0x0004);
        let vals = hls_host_get_words!(sim, bidi_clock, x, host_to_pc, 4);
        sim_assert_eq!(sim, vals, [0x1234, 0x5678, 0xdead, 0xbeef], x);
        hls_host_write!(sim, bidi_clock, x, pc_to_host, 1, [0x0000, 0x0002]);
        hls_host_write!(sim, bidi_clock, x, pc_to_host, 2, [0x0000]);
        hls_host_issue_read!(sim, bidi_clock, x, pc_to_host, 3, 0x0004);
        let vals = hls_host_get_words!(sim, bidi_clock, x, host_to_pc, 4);
        sim_assert_eq!(sim, vals, [0xeffe, 0x5ea1, 0x1234, 0x5678], x);
        wait_clock_cycles!(sim, bidi_clock, x, 100);
        sim.done(x)
    });
    sim.run_to_file(
        Box::new(uut),
        10_000_000,
        &vcd_path!("hls_sdram_controller.vcd"),
    )
    .unwrap();
}