celox 0.4.1

Celox HDL Simulator
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

//! Correctness tests for linear SEC (single-error correction) P=6 Hamming code.

use celox::{DeadStorePolicy, Simulator};

#[path = "test_utils/mod.rs"]
#[macro_use]
#[allow(unused_macros)]
mod test_utils;

fn linear_sec_source() -> String {
    format!(
        "{}\n{}\n{}",
        test_utils::veryl_std::source(&["coding", "linear_sec_encoder.veryl"]),
        test_utils::veryl_std::source(&["coding", "linear_sec_decoder.veryl"]),
        include_str!("../testdata/veryl/linear_sec_top.veryl"),
    )
}

fn build_sim() -> Simulator {
    Simulator::builder(&linear_sec_source(), "Top")
        .build()
        .unwrap()
}

fn build_sim_dse() -> Simulator {
    Simulator::builder(&linear_sec_source(), "Top")
        .dead_store_policy(DeadStorePolicy::PreserveTopPorts)
        .build()
        .unwrap()
}

/// Encode→decode roundtrip: output should equal input for all test values.
#[test]
fn roundtrip_no_error() {
    let mut sim = build_sim();
    let i_word = sim.signal("i_word");
    let o_word = sim.signal("o_word");
    let o_corrected = sim.signal("o_corrected");

    for input in [0u64, 1, 42, 0x1FF_FFFF_FFFF_FFFF, 0x155_5555_5555_5555] {
        sim.modify(|io| io.set(i_word, input)).unwrap();
        let out: u64 = sim.get_as(o_word);
        let corrected: u8 = sim.get_as(o_corrected);
        assert_eq!(out, input, "roundtrip failed for input={input:#x}");
        assert_eq!(corrected, 0, "o_corrected should be 0 when no error");
    }
}

/// Same test with DSE enabled.
#[test]
fn roundtrip_no_error_dse() {
    let mut sim = build_sim_dse();
    let i_word = sim.signal("i_word");
    let o_word = sim.signal("o_word");
    let o_corrected = sim.signal("o_corrected");

    for input in [0u64, 1, 42, 0x1FF_FFFF_FFFF_FFFF, 0x155_5555_5555_5555] {
        sim.modify(|io| io.set(i_word, input)).unwrap();
        let out: u64 = sim.get_as(o_word);
        let corrected: u8 = sim.get_as(o_corrected);
        assert_eq!(out, input, "DSE roundtrip failed for input={input:#x}");
        assert_eq!(corrected, 0, "DSE o_corrected should be 0 when no error");
    }
}

/// Exhaustive roundtrip for small input range.
#[test]
fn roundtrip_exhaustive_small() {
    let mut sim = build_sim_dse();
    let i_word = sim.signal("i_word");
    let o_word = sim.signal("o_word");

    for input in 0u64..1024 {
        sim.modify(|io| io.set(i_word, input)).unwrap();
        let out: u64 = sim.get_as(o_word);
        assert_eq!(out, input, "exhaustive roundtrip failed for input={input}");
    }
}