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
|
// See LICENSE for license details.
package chiselTests
import java.io.File
import chisel3._
import chisel3.experimental.ExtModule
import chisel3.stage.{ChiselGeneratorAnnotation, ChiselStage}
import chisel3.util.{HasExtModuleInline, HasExtModulePath, HasExtModuleResource}
import firrtl.FirrtlExecutionSuccess
import firrtl.options.TargetDirAnnotation
import firrtl.stage.FirrtlCircuitAnnotation
import firrtl.transforms.BlackBoxNotFoundException
import org.scalacheck.Test.Failed
import org.scalatest.{FreeSpec, Matchers, Succeeded}
//scalastyle:off magic.number
class ExtModuleAdd(n: Int) extends ExtModule with HasExtModuleInline {
val io = IO(new Bundle {
val in = Input(UInt(16.W))
val out = Output(UInt(16.W))
})
//scalastyle:off regex
setInline("ExtModuleAdd.v", s"""
|module ExtModuleAdd(
| input [15:0] in,
| output [15:0] out
|);
| assign out = in + $n;
|endmodule
""".stripMargin)
}
class UsesExtModuleAddViaInline extends Module {
val io = IO(new Bundle {
val in = Input(UInt(16.W))
val out = Output(UInt(16.W))
})
val blackBoxAdd = Module(new ExtModuleAdd(5))
blackBoxAdd.io.in := io.in
io.out := blackBoxAdd.io.out
}
class ExtModuleMinus extends ExtModule with HasExtModuleResource {
val io = IO(new Bundle {
val in1 = Input(UInt(16.W))
val in2 = Input(UInt(16.W))
val out = Output(UInt(16.W))
})
addResource("/chisel3/BlackBoxTest.v")
}
class ExtModuleMinusPath extends ExtModule with HasExtModulePath {
val io = IO(new Bundle {
val in1 = Input(UInt(16.W))
val in2 = Input(UInt(16.W))
val out = Output(UInt(16.W))
})
addPath(
new File("src/test/resources/chisel3/BlackBoxTest.v").getCanonicalPath
)
}
class UsesExtModuleMinusViaResource extends Module {
val io = IO(new Bundle {
val in1 = Input(UInt(16.W))
val in2 = Input(UInt(16.W))
val out = Output(UInt(16.W))
})
val mod0 = Module(new ExtModuleMinus)
mod0.io.in1 := io.in1
mod0.io.in2 := io.in2
io.out := mod0.io.out
}
class UsesExtModuleMinusViaPath extends Module {
val io = IO(new Bundle {
val in1 = Input(UInt(16.W))
val in2 = Input(UInt(16.W))
val out = Output(UInt(16.W))
})
val mod0 = Module(new ExtModuleMinusPath)
mod0.io.in1 := io.in1
mod0.io.in2 := io.in2
io.out := mod0.io.out
}
class ExtModuleResourceNotFound extends HasExtModuleResource {
val io = IO(new Bundle{})
addResource("/missing.resource")
}
class UsesMissingExtModuleResource extends RawModule {
val foo = Module(new ExtModuleResourceNotFound)
}
class ExtModuleImplSpec extends FreeSpec with Matchers {
"ExtModule can have verilator source implementation" - {
"Implementations can be contained in-line" in {
val targetDir = "test_run_dir/extmodule-inline"
val annotations = Seq(
TargetDirAnnotation(targetDir),
ChiselGeneratorAnnotation(() => new UsesExtModuleAddViaInline)
)
val newAnnotations = (new ChiselStage).transform(annotations)
newAnnotations.exists(_.isInstanceOf[FirrtlCircuitAnnotation]) should be (true)
val verilogOutput = new File(targetDir, "ExtModuleAdd.v")
verilogOutput.exists() should be(true)
verilogOutput.delete()
}
"Implementations can be contained in resource files" in {
val targetDir = "test_run_dir/extmodule-resource"
val annotations = Seq(
TargetDirAnnotation(targetDir),
ChiselGeneratorAnnotation(() => new UsesExtModuleMinusViaResource)
)
val newAnnotations = (new ChiselStage).transform(annotations)
newAnnotations.exists(_.isInstanceOf[FirrtlCircuitAnnotation]) should be (true)
val verilogOutput = new File(targetDir, "BlackBoxTest.v")
verilogOutput.exists() should be(true)
verilogOutput.delete()
}
"Implementations can be contained in arbitrary files" in {
val targetDir = "test_run_dir/extmodule-path"
val annotations = Seq(
TargetDirAnnotation(targetDir),
ChiselGeneratorAnnotation(() => new UsesExtModuleMinusViaPath)
)
val newAnnotations = (new ChiselStage).transform(annotations)
newAnnotations.exists(_.isInstanceOf[FirrtlCircuitAnnotation]) should be (true)
val verilogOutput = new File(targetDir, "BlackBoxTest.v")
verilogOutput.exists() should be(true)
verilogOutput.delete()
}
"Resource files that do not exist produce Chisel errors" in {
assertThrows[BlackBoxNotFoundException]{
ChiselStage.emitChirrtl(new UsesMissingExtModuleResource)
}
}
}
}
|
