topstitch 0.95.1

Stitch together Verilog modules with 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

// SPDX-License-Identifier: Apache-2.0

use crate::{IO, ModDef, ParameterType, Usage, mod_def::ParameterSpec};
use indexmap::IndexMap;
use num_bigint::BigInt;

#[derive(Debug, Clone)]
pub struct PipelineConfig {
    pub clk: String,
    pub depth: usize,
    pub inst_name: Option<String>,
}

impl Default for PipelineConfig {
    fn default() -> Self {
        PipelineConfig {
            clk: "clk".to_string(),
            depth: 0,
            inst_name: None,
        }
    }
}

impl PipelineConfig {
    pub fn to_mod_def(&self, width: usize) -> ModDef {
        let mod_def = ModDef::new("br_delay_nr");
        mod_def.add_port("clk", IO::Input(1));
        mod_def.add_port("in", IO::Input(width));
        mod_def.add_port("out", IO::Output(width));
        mod_def.add_port("out_stages", IO::Output(width * self.depth));

        let mut parameters = IndexMap::new();
        parameters.insert(
            "Width".to_string(),
            ParameterSpec {
                value: BigInt::from(width),
                ty: ParameterType::Unsigned(32),
            },
        );
        parameters.insert(
            "NumStages".to_string(),
            ParameterSpec {
                value: BigInt::from(self.depth),
                ty: ParameterType::Unsigned(32),
            },
        );

        mod_def.core.write().parameters = parameters;

        mod_def.set_usage(Usage::EmitNothingAndStop);

        mod_def
    }
}

impl ModDef {
    /// Resolve the instance name to use for a pipeline given its configuration.
    /// Ensures uniqueness within this module definition and against a
    /// caller-provided set tracking names chosen during the current
    /// emission.
    pub(crate) fn resolve_pipeline_instance_name(&self, pipeline: &PipelineConfig) -> String {
        if let Some(inst_name) = pipeline.inst_name.as_ref() {
            // Explicit name provided: validate uniqueness
            let core = self.core.read();
            assert!(
                !core.instances.contains_key(inst_name),
                "Cannot use pipeline instance name {}, since that instance name is already used in module definition {}.",
                inst_name,
                core.name
            );
            inst_name.clone()
        } else {
            // Otherwise generate a unique name using the module-local counter
            let mut core = self.core.write();
            loop {
                let name = format!("pipeline_conn_{}", core.pipeline_counter.next().unwrap());
                if !core.instances.contains_key(&name) {
                    break name;
                }
            }
        }
    }
}