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
|
// See LICENSE for license details.
package firrtlTests
import java.io._
import org.scalatest._
import org.scalatest.prop._
import firrtl._
import firrtl.annotations._
import firrtl.ir.Circuit
import firrtl.passes._
import firrtl.Parser.IgnoreInfo
import FirrtlCheckers._
class DoPrimVerilog extends FirrtlFlatSpec {
"Xorr" should "emit correctly" in {
val compiler = new VerilogCompiler
val input =
"""circuit Xorr :
| module Xorr :
| input a: UInt<4>
| output b: UInt<1>
| b <= xorr(a)""".stripMargin
val check =
"""module Xorr(
| input [3:0] a,
| output b
|);
| assign b = ^a;
|endmodule
|""".stripMargin.split("\n") map normalized
executeTest(input, check, compiler)
}
"Andr" should "emit correctly" in {
val compiler = new VerilogCompiler
val input =
"""circuit Andr :
| module Andr :
| input a: UInt<4>
| output b: UInt<1>
| b <= andr(a)""".stripMargin
val check =
"""module Andr(
| input [3:0] a,
| output b
|);
| assign b = &a;
|endmodule
|""".stripMargin.split("\n") map normalized
executeTest(input, check, compiler)
}
"Orr" should "emit correctly" in {
val compiler = new VerilogCompiler
val input =
"""circuit Orr :
| module Orr :
| input a: UInt<4>
| output b: UInt<1>
| b <= orr(a)""".stripMargin
val check =
"""module Orr(
| input [3:0] a,
| output b
|);
| assign b = |a;
|endmodule
|""".stripMargin.split("\n") map normalized
executeTest(input, check, compiler)
}
"Rem" should "emit correctly" in {
val compiler = new VerilogCompiler
val input =
"""circuit Test :
| module Test :
| input in : UInt<8>
| output out : UInt<1>
| out <= rem(in, UInt<1>("h1"))
|""".stripMargin
val check =
"""module Test(
| input [7:0] in,
| output out
|);
| wire [7:0] _GEN_0;
| assign out = _GEN_0[0];
| assign _GEN_0 = in % 8'h1;
|endmodule
|""".stripMargin.split("\n") map normalized
executeTest(input, check, compiler)
}
}
class VerilogEmitterSpec extends FirrtlFlatSpec {
"Ports" should "emit with widths aligned and names aligned" in {
val compiler = new VerilogCompiler
val input =
"""circuit Test :
| module Test :
| input a : UInt<25000>
| output b : UInt
| input c : UInt<32>
| output d : UInt
| input e : UInt<1>
| input f : Analog<32>
| b <= a
| d <= add(c, e)
|""".stripMargin
val check = Seq(
" input [24999:0] a,",
" output [24999:0] b,",
" input [31:0] c,",
" output [32:0] d,",
" input e,",
" inout [31:0] f"
)
// We don't use executeTest because we care about the spacing in the result
val writer = new java.io.StringWriter
compiler.compile(CircuitState(parse(input), ChirrtlForm), writer)
val lines = writer.toString.split("\n")
for (c <- check) {
lines should contain (c)
}
}
"The Verilog Emitter" should "support Modules with no ports" in {
val compiler = new VerilogCompiler
val input =
"""circuit Test :
| module Test :
| wire x : UInt<32>
| x <= UInt(0)
""".stripMargin
compiler.compile(CircuitState(parse(input), ChirrtlForm), new java.io.StringWriter)
}
"AsClock" should "emit correctly" in {
val compiler = new VerilogCompiler
val input =
"""circuit Test :
| module Test :
| input in : UInt<1>
| output out : Clock
| out <= asClock(in)
|""".stripMargin
val check =
"""module Test(
| input in,
| output out
|);
| assign out = in;
|endmodule
|""".stripMargin.split("\n") map normalized
executeTest(input, check, compiler)
}
"The Verilog Emitter" should "support pads with width <= the width of the argument" in {
// We do just a few passes instead of using the VerilogCompiler to ensure that the pad actually
// reaches the VerilogEmitter and isn't removed by an optimization transform
val passes = Seq(
ToWorkingIR,
ResolveKinds,
InferTypes
)
def input(n: Int) =
s"""circuit Test :
| module Test :
| input in : UInt<8>
| output out : UInt<8>
| out <= pad(in, $n)
|""".stripMargin
for (w <- Seq(6, 8)) {
val circuit = passes.foldLeft(parse(input(w))) { case (c, p) => p.run(c) }
val state = CircuitState(circuit, LowForm, Seq(EmitCircuitAnnotation(classOf[VerilogEmitter])))
val emitter = new VerilogEmitter
val result = emitter.execute(state)
result should containLine ("assign out = in;")
}
}
"The verilog emitter" should "offer support for generating bindable forms of modules" in {
val emitter = new VerilogEmitter
val input =
"""circuit Test :
| module Test :
| input a : UInt<25000>
| output b : UInt
| input c : UInt<32>
| output d : UInt
| input e : UInt<1>
| input f : Analog<32>
| b <= a
| d <= add(c, e)
|""".stripMargin
val check =
"""
|module BindsToTest(
| input [24999:0] a,
| output [24999:0] b,
| input [31:0] c,
| output [32:0] d,
| input e,
| inout [31:0] f
|);
|
|$readmemh("file", memory);
|
|endmodule""".stripMargin.split("\n")
// We don't use executeTest because we care about the spacing in the result
val writer = new java.io.StringWriter
val initialState = CircuitState(parse(input), ChirrtlForm)
val compiler = new LowFirrtlCompiler()
val state = compiler.compile(initialState, Seq.empty)
val moduleMap = state.circuit.modules.map(m => m.name -> m).toMap
val module = state.circuit.modules.filter(module => module.name == "Test").collectFirst { case m: firrtl.ir.Module => m }.get
val renderer = emitter.getRenderer(module, moduleMap)(writer)
renderer.emitVerilogBind("BindsToTest",
"""
|$readmemh("file", memory);
|
|""".stripMargin)
val lines = writer.toString.split("\n")
val outString = writer.toString
// This confirms that the module io's were emitted
for (c <- check) {
lines should contain (c)
}
}
}
|
