topstitch 0.96.0

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
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

// SPDX-License-Identifier: Apache-2.0

use topstitch::{LefDefOptions, ModDef, Orientation, Polygon, Usage};

#[test]
fn placement_basic() {
    let top = ModDef::new("top");

    let block = ModDef::new("block");
    block.set_usage(Usage::EmitStubAndStop);
    block.set_width_height(100, 200);

    // Instantiate and place block in top
    let b_inst = top.instantiate(&block, Some("b_inst_0"), None);
    b_inst.place((10, 20), Orientation::R0);

    // Compute placements and verify absolute shape
    let (placements, _) = top.collect_placements_and_mod_defs(&LefDefOptions::default());
    let b_placed = placements
        .get("b_inst_0")
        .expect("instance b_inst_0 not found");
    let abs_shape = block
        .get_shape()
        .unwrap()
        .apply_transform(&b_placed.transform);
    assert_eq!(
        abs_shape,
        Polygon::new(vec![
            (10, 20).into(),
            (10, 220).into(),
            (110, 220).into(),
            (110, 20).into(),
        ])
    );
}

#[test]
fn placement_skip_level() {
    let top = ModDef::new("top");
    let intermediate = ModDef::new("intermediate");
    let block = ModDef::new("block");

    block.set_usage(Usage::EmitStubAndStop);
    block.set_width_height(100, 200);

    // Instantiate and place block in intermediate hierarchy level
    top.instantiate(&intermediate, Some("i_inst_0"), None);
    let b_inst = intermediate.instantiate(&block, Some("b_inst_0"), None);
    b_inst.place((10, 20), Orientation::R0);

    // Compute placements and verify absolute shape
    let (placements, _) = top.collect_placements_and_mod_defs(&LefDefOptions {
        omit_top_module_in_hierarchy: false,
        divider_char: ".".to_string(),
        ..LefDefOptions::default()
    });
    let b_placed = placements
        .get("top.i_inst_0.b_inst_0")
        .expect("instance top.i_inst_0.b_inst_0 not found");
    let abs_shape = block
        .get_shape()
        .unwrap()
        .apply_transform(&b_placed.transform);
    assert_eq!(
        abs_shape,
        Polygon::new(vec![
            (10, 20).into(),
            (10, 220).into(),
            (110, 220).into(),
            (110, 20).into(),
        ])
    );
}

#[test]
fn placement_relative_basic() {
    let top = ModDef::new("top");
    let intermediate = ModDef::new("intermediate");
    let block = ModDef::new("block");

    block.set_usage(Usage::EmitStubAndStop);
    block.set_width_height(100, 200);

    // Instantiate and place block in intermediate
    let b_inst = intermediate.instantiate(&block, Some("b_inst_0"), None);
    b_inst.place((12, 34), Orientation::R270);

    let i_inst = top.instantiate(&intermediate, Some("i_inst_0"), None);
    i_inst.place((56, 78), Orientation::MY);

    // Compute placements and verify absolute shape
    let (placements, _) = top.collect_placements_and_mod_defs(&LefDefOptions {
        omit_top_module_in_hierarchy: false,
        ..LefDefOptions::default()
    });
    let b_placed = placements
        .get("top/i_inst_0/b_inst_0")
        .expect("instance top/i_inst_0/b_inst_0 not found");
    let abs_shape = block
        .get_shape()
        .unwrap()
        .apply_transform(&b_placed.transform);
    assert_eq!(
        abs_shape,
        Polygon::new(vec![
            (44, 112).into(),
            (-156, 112).into(),
            (-156, 12).into(),
            (44, 12).into(),
        ])
    );
}

#[test]
fn placement_relative_to_parent() {
    let top = ModDef::new("top");
    let intermediate = ModDef::new("intermediate");
    let block = ModDef::new("block");

    block.set_usage(Usage::EmitStubAndStop);
    block.set_width_height(400, 300);

    let b_inst = intermediate.instantiate(&block, Some("b_inst_0"), None);
    b_inst.place((100, 200), Orientation::R0);

    for (index, orientation) in [
        Orientation::R0,
        Orientation::MX,
        Orientation::R180,
        Orientation::MY,
    ]
    .iter()
    .enumerate()
    {
        let i_inst = top.instantiate(&intermediate, Some(&format!("i_inst_{index}")), None);
        i_inst.place((0, 0), *orientation);
    }

    // Compute placements and verify absolute shape
    let (placements, _) = top.collect_placements_and_mod_defs(&LefDefOptions::default());

    let b_placed: std::collections::HashMap<_, _> = placements
        .iter()
        .map(|(inst_name, p)| {
            let abs_shape = block.get_shape().unwrap().apply_transform(&p.transform);
            (inst_name.clone(), abs_shape)
        })
        .collect();

    assert_eq!(
        b_placed.get("i_inst_0/b_inst_0"),
        Some(&Polygon::new(vec![
            (100, 200).into(),
            (100, 500).into(),
            (500, 500).into(),
            (500, 200).into(),
        ]))
    );

    assert_eq!(
        b_placed.get("i_inst_1/b_inst_0"),
        Some(&Polygon::new(vec![
            (100, -200).into(),
            (100, -500).into(),
            (500, -500).into(),
            (500, -200).into(),
        ]))
    );

    assert_eq!(
        b_placed.get("i_inst_2/b_inst_0"),
        Some(&Polygon::new(vec![
            (-100, -200).into(),
            (-100, -500).into(),
            (-500, -500).into(),
            (-500, -200).into(),
        ]))
    );

    assert_eq!(
        b_placed.get("i_inst_3/b_inst_0"),
        Some(&Polygon::new(vec![
            (-100, 200).into(),
            (-100, 500).into(),
            (-500, 500).into(),
            (-500, 200).into(),
        ]))
    );
}