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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
// SPDX-License-Identifier: Apache-2.0
use std::collections::HashSet;
use crate::{ConvertibleToPortSliceVec, Intf, ModInst, PhysicalPin, PipelineConfig, PortSlice};
impl Intf {
/// Connects this interface to another interface. Interfaces are connected
/// by matching up ports with the same function name and connecting them.
/// For example, if this interface is {"data": "a_data", "valid": "a_valid"}
/// and the other interface is {"data": "b_data", "valid": "b_valid"}, then
/// "a_data" will be connected to "b_data" and "a_valid" will be connected
/// to "b_valid".
///
/// Unless `allow_mismatch` is `true`, this method will panic if a function
/// in this interface is not in the other interface. Continuing the previous
/// example, if this interface also contained function "ready", but the
/// other interface did not, this method would panic unless `allow_mismatch`
/// was `true`.
pub fn connect(&self, other: &Intf, allow_mismatch: bool) {
self.connect_generic(other, None, allow_mismatch, None::<&[&str]>);
}
/// Jam-connects this interface and `other` LSB-first over the ordered
/// `PortSlice` lists and marks any remainder on either side with
/// `unused_or_tieoff(0)`.
pub fn todo_jam_connect<T: ConvertibleToPortSliceVec>(&self, other: &T) {
let left = self.to_port_slice_vec();
let right = other.to_port_slice_vec();
PortSlice::todo_jam_connect_port_slices(&left, &right);
}
/// Connects this interface to another interface, skipping the specified functions.
pub fn connect_except<'a, I, T>(&self, other: &Intf, skip: Option<I>)
where
I: IntoIterator<Item = &'a T>,
T: AsRef<str> + 'a,
{
self.connect_generic(other, None, false, skip);
}
/// Places this interface across from another interface, matching functions
pub fn place_across_from(&self, other: &Intf, allow_mismatch: bool) {
self.place_across_from_generic(other, allow_mismatch, None::<&[&str]>);
}
/// Places this interface across from another interface, matching functions
/// by name, skipping the specified functions.
pub fn place_across_from_except<'a, I, T>(
&self,
other: &Intf,
allow_mismatch: bool,
skip: Option<I>,
) where
I: IntoIterator<Item = &'a T>,
T: AsRef<str> + 'a,
{
self.place_across_from_generic(other, allow_mismatch, skip);
}
/// Places this interface across from another interface, matching functions
/// by name. See [`PortSlice::place_across_from`] for placement behavior.
fn place_across_from_generic<'a, I, T>(
&self,
other: &Intf,
allow_mismatch: bool,
skip: Option<I>,
) where
I: IntoIterator<Item = &'a T>,
T: AsRef<str> + 'a,
{
let skip_names = skip.map(|i| i.into_iter().map(|i| i.as_ref()).collect::<HashSet<_>>());
let is_skipped = |func_name: &str| {
if let Some(names) = skip_names.as_ref() {
names.contains(func_name)
} else {
false
}
};
let self_ports = self.get_port_slices();
let other_ports = other.get_port_slices();
for (func_name, self_port) in &self_ports {
if is_skipped(func_name) {
continue;
}
if let Some(other_port) = other_ports.get(func_name) {
self_port.place_across_from(other_port.clone());
} else if !allow_mismatch {
panic!(
"Interfaces {} and {} have mismatched functions and allow_mismatch is false. Example: function '{}' is present in {} but not in {}.",
self.debug_string(),
other.debug_string(),
func_name,
self.debug_string(),
other.debug_string()
);
}
}
if !allow_mismatch {
for (func_name, _) in &other_ports {
if is_skipped(func_name) {
continue;
}
if !self_ports.contains_key(func_name) {
panic!(
"Interfaces {} and {} have mismatched functions and allow_mismatch is false. Example: function '{}' is present in {} but not in {}",
self.debug_string(),
other.debug_string(),
func_name,
other.debug_string(),
self.debug_string()
);
}
}
}
}
/// Places this interface across from ModDef ports it is directly connected
/// to within the same module.
pub fn place_across(&self) {
for (_, port_slice) in self.get_port_slices() {
port_slice.place_across();
}
}
/// Places this interface based on what has been connected to it.
pub fn place_abutted(&self) {
for (_, port_slice) in self.get_port_slices() {
port_slice.place_abutted();
}
}
/// For each port slice in this interface, trace its connectivity to
/// determine what existing pin it is connected to, and then place a new
/// pin for the slice that overlaps the connected pin.
pub fn place_overlapped(&self, pin: &PhysicalPin) {
for (_, port_slice) in self.get_port_slices() {
port_slice.place_overlapped(pin);
}
}
pub fn connect_pipeline(&self, other: &Intf, pipeline: PipelineConfig, allow_mismatch: bool) {
self.connect_generic(other, Some(pipeline), allow_mismatch, None::<&[&str]>);
}
pub fn connect_pipeline_except<'a, I, T>(
&self,
other: &Intf,
pipeline: PipelineConfig,
skip: Option<I>,
) where
I: IntoIterator<Item = &'a T>,
T: AsRef<str> + 'a,
{
self.connect_generic(other, Some(pipeline), false, skip);
}
pub(crate) fn connect_generic<'a, I, T>(
&self,
other: &Intf,
pipeline: Option<PipelineConfig>,
allow_mismatch: bool,
skip: Option<I>,
) where
I: IntoIterator<Item = &'a T>,
T: AsRef<str> + 'a,
{
let skip_names = skip.map(|i| i.into_iter().map(|i| i.as_ref()).collect::<HashSet<_>>());
let is_skipped = |func_name: &str| {
if let Some(names) = skip_names.as_ref() {
names.contains(func_name)
} else {
false
}
};
let self_ports = self.get_port_slices();
let other_ports = other.get_port_slices();
for (func_name, self_port) in &self_ports {
if is_skipped(func_name) {
continue;
}
if let Some(other_port) = other_ports.get(func_name) {
self_port.connect_generic(other_port, pipeline.clone());
} else if !allow_mismatch {
panic!(
"Interfaces {} and {} have mismatched functions and allow_mismatch is false. Example: function '{}' is present in {} but not in {}.",
self.debug_string(),
other.debug_string(),
func_name,
self.debug_string(),
other.debug_string()
);
}
}
if !allow_mismatch {
for (func_name, _) in &other_ports {
if is_skipped(func_name) {
continue;
}
if !self_ports.contains_key(func_name) {
panic!(
"Interfaces {} and {} have mismatched functions and allow_mismatch is false. Example: function '{}' is present in {} but not in {}",
self.debug_string(),
other.debug_string(),
func_name,
other.debug_string(),
self.debug_string()
);
}
}
}
}
/// Punches a sequence of feedthroughs through the specified module
/// instances to connect this interface to another interface.
pub fn connect_through(
&self,
other: &Intf,
through: &[&ModInst],
prefix: impl AsRef<str>,
allow_mismatch: bool,
) {
let mut through_generic = Vec::new();
for inst in through {
through_generic.push((*inst, None));
}
self.connect_through_generic(other, &through_generic, prefix, allow_mismatch);
}
/// Punches a sequence of feedthroughs through the specified module
/// instances to connect this interface to another interface, with
/// optional pipelining for each connection.
pub fn connect_through_generic(
&self,
other: &Intf,
through: &[(&ModInst, Option<PipelineConfig>)],
prefix: impl AsRef<str>,
allow_mismatch: bool,
) {
if through.is_empty() {
self.connect(other, allow_mismatch);
return;
}
let flipped = format!("{}_flipped_{}", prefix.as_ref(), self.get_intf_name());
let original = format!("{}_original_{}", prefix.as_ref(), self.get_intf_name());
for (i, (inst, pipeline)) in through.iter().enumerate() {
self.feedthrough_generic(
&inst.get_mod_def(),
&flipped,
&original,
pipeline.as_ref().cloned(),
);
if i == 0 {
self.connect(&inst.get_intf(&flipped), false);
} else {
through[i - 1]
.0
.get_intf(&original)
.connect(&inst.get_intf(&flipped), false);
}
if i == through.len() - 1 {
other.connect(&inst.get_intf(&original), allow_mismatch);
}
}
}
}