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
|
// See LICENSE for license details.
package chiselTests
import chisel3._
import chisel3.stage.ChiselStage
import chisel3.testers.BasicTester
import chisel3.experimental.BundleLiterals._
import chisel3.experimental.BundleLiteralException
import chisel3.experimental.ChiselEnum
import chisel3.experimental.FixedPoint
class BundleLiteralSpec extends ChiselFlatSpec with Utils {
object MyEnum extends ChiselEnum {
val sA, sB = Value
}
object MyEnumB extends ChiselEnum {
val sA, sB = Value
}
class MyBundle extends Bundle {
val a = UInt(8.W)
val b = Bool()
val c = MyEnum()
}
class LongBundle extends Bundle {
val a = UInt(48.W)
val b = SInt(32.W)
val c = FixedPoint(16.W, 4.BP)
}
"bundle literals" should "pack" in {
assertTesterPasses{ new BasicTester {
val bundleLit = (new MyBundle).Lit(_.a -> 42.U, _.b -> false.B, _.c -> MyEnum.sB)
bundleLit.litOption should equal (Some(169)) // packed as 42 (8-bit), false=0 (1-bit), sB=1 (1-bit)
chisel3.assert(bundleLit.asUInt() === bundleLit.litOption.get.U) // sanity-check consistency with runtime
val longBundleLit = (new LongBundle).Lit(
_.a -> 0xDEADDEADBEEFL.U, _.b -> (-0x0BEEF00DL).S(32.W), _.c -> 4.5.F(16.W, 4.BP))
longBundleLit.litOption should equal (Some(
(BigInt(0xDEADDEADBEEFL) << 48)
+ (BigInt(0xFFFFFFFFL - 0xBEEF00DL + 1) << 16)
+ BigInt(72)))
chisel3.assert(longBundleLit.asUInt() === longBundleLit.litOption.get.U)
stop()
} }
}
"bundle literals" should "work in RTL" in {
val outsideBundleLit = (new MyBundle).Lit(_.a -> 42.U, _.b -> true.B, _.c -> MyEnum.sB)
assertTesterPasses{ new BasicTester{
// TODO: add direct bundle compare operations, when that feature is added
chisel3.assert(outsideBundleLit.a === 42.U)
chisel3.assert(outsideBundleLit.b === true.B)
chisel3.assert(outsideBundleLit.c === MyEnum.sB)
chisel3.assert(outsideBundleLit.isLit())
chisel3.assert(outsideBundleLit.litValue().U === outsideBundleLit.asUInt())
val bundleLit = (new MyBundle).Lit(_.a -> 42.U, _.b -> true.B, _.c -> MyEnum.sB)
chisel3.assert(bundleLit.a === 42.U)
chisel3.assert(bundleLit.b === true.B)
chisel3.assert(bundleLit.c === MyEnum.sB)
chisel3.assert(bundleLit.a === outsideBundleLit.a)
chisel3.assert(bundleLit.b === outsideBundleLit.b)
chisel3.assert(bundleLit.c === outsideBundleLit.c)
val bundleWire = Wire(new MyBundle)
bundleWire := outsideBundleLit
chisel3.assert(bundleWire.a === 42.U)
chisel3.assert(bundleWire.b === true.B)
chisel3.assert(bundleWire.c === MyEnum.sB)
stop()
} }
}
"partial bundle literals" should "work in RTL" in {
assertTesterPasses{ new BasicTester{
val bundleLit = (new MyBundle).Lit(_.a -> 42.U)
chisel3.assert(bundleLit.a === 42.U)
val bundleWire = Wire(new MyBundle)
bundleWire := bundleLit
chisel3.assert(bundleWire.a === 42.U)
stop()
} }
}
class MyOuterBundle extends Bundle {
val a = new MyBundle
val b = new Bundle {
val c = Bool()
val d = UInt(8.W)
val e = MyEnum()
}
val f = MyEnum()
}
"contained bundles" should "work" in {
assertTesterPasses{ new BasicTester{
// Specify the inner Bundle value as a Bundle literal
val explicitBundleLit = (new MyOuterBundle).Lit(
_.a -> (new MyBundle).Lit(_.a -> 42.U, _.b -> true.B, _.c -> MyEnum.sB)
)
chisel3.assert(explicitBundleLit.a.a === 42.U)
chisel3.assert(explicitBundleLit.a.b === true.B)
chisel3.assert(explicitBundleLit.a.c === MyEnum.sB)
chisel3.assert(explicitBundleLit.a.isLit())
chisel3.assert(explicitBundleLit.a.litValue().U === explicitBundleLit.a.asUInt())
// Specify the inner Bundle fields directly
val expandedBundleLit = (new MyOuterBundle).Lit(
_.a.a -> 42.U, _.a.b -> true.B,
_.b.c -> false.B, _.b.d -> 255.U, _.b.e -> MyEnum.sB,
_.f -> MyEnum.sB
)
chisel3.assert(expandedBundleLit.a.a === 42.U)
chisel3.assert(expandedBundleLit.a.b === true.B)
chisel3.assert(expandedBundleLit.f === MyEnum.sB)
chisel3.assert(expandedBundleLit.b.c === false.B)
chisel3.assert(expandedBundleLit.b.d === 255.U)
chisel3.assert(expandedBundleLit.b.e === MyEnum.sB)
chisel3.assert(! expandedBundleLit.a.isLit()) // element e is missing
chisel3.assert(expandedBundleLit.b.isLit())
chisel3.assert(! expandedBundleLit.isLit()) // element a.e is missing
chisel3.assert(expandedBundleLit.b.litValue().U === expandedBundleLit.b.asUInt())
// Anonymously contruct the inner Bundle literal
// A bit of weird syntax that depends on implementation details of the Bundle literal constructor
val childBundleLit = (new MyOuterBundle).Lit(
b => b.b -> b.b.Lit(_.c -> false.B, _.d -> 255.U, _.e -> MyEnum.sB)
)
chisel3.assert(childBundleLit.b.c === false.B)
chisel3.assert(childBundleLit.b.d === 255.U)
chisel3.assert(childBundleLit.b.e === MyEnum.sB)
chisel3.assert(childBundleLit.b.isLit())
chisel3.assert(! childBundleLit.isLit()) // elements a and f are missing
chisel3.assert(childBundleLit.b.litValue().U === childBundleLit.b.asUInt())
stop()
} }
}
"Bundle literals" should "assign" in {
assertTesterPasses{ new BasicTester{
val bundleWire = Wire(Output(new MyBundle))
val bundleLit = (new MyBundle).Lit(_.a -> 42.U, _.b -> true.B, _.c -> MyEnum.sB)
bundleWire := bundleLit
chisel3.assert(bundleWire.a === 42.U)
chisel3.assert(bundleWire.b === true.B)
chisel3.assert(bundleWire.c === MyEnum.sB)
stop()
} }
}
"partially initialized Bundle literals" should "assign" in {
assertTesterPasses{ new BasicTester{
val bundleWire = Wire(Output(new MyBundle))
val bundleLit = (new MyBundle).Lit(_.a -> 42.U)
bundleWire := bundleLit
chisel3.assert(bundleWire.a === 42.U)
stop()
} }
}
"bundle literals with bad field specifiers" should "fail" in {
val exc = intercept[BundleLiteralException] {
extractCause[BundleLiteralException] {
ChiselStage.elaborate {
new RawModule {
val bundle = new MyBundle
bundle.Lit(x => bundle.a -> 0.U) // DONT DO THIS, this gets past a syntax error to exercise the failure
}
}
}
}
exc.getMessage should include ("not a field")
}
"bundle literals with duplicate fields" should "fail" in {
val exc = intercept[BundleLiteralException] {
extractCause[BundleLiteralException] {
ChiselStage.elaborate {
new RawModule {
(new MyBundle).Lit(_.a -> 0.U, _.a -> 0.U)
}
}
}
}
exc.getMessage should include ("duplicate")
exc.getMessage should include (".a")
}
"bundle literals with non-literal values" should "fail" in {
val exc = intercept[BundleLiteralException] {
extractCause[BundleLiteralException] {
ChiselStage.elaborate { new RawModule {
(new MyBundle).Lit(_.a -> UInt())
}
}
}
}
exc.getMessage should include ("non-literal value")
exc.getMessage should include (".a")
}
"bundle literals with non-type-equivalent element fields" should "fail" in {
val exc = intercept[BundleLiteralException] {
extractCause[BundleLiteralException] {
ChiselStage.elaborate {
new RawModule {
(new MyBundle).Lit(_.a -> true.B)
}
}
}
}
exc.getMessage should include ("non-type-equivalent value")
exc.getMessage should include (".a")
}
"bundle literals with non-type-equivalent sub-bundles" should "fail" in {
val exc = intercept[BundleLiteralException] {
extractCause[BundleLiteralException] {
ChiselStage.elaborate {
new RawModule {
(new MyOuterBundle).Lit(_.b -> (new MyBundle).Lit(_.a -> 0.U))
}
}
}
}
exc.getMessage should include ("non-type-equivalent value")
exc.getMessage should include (".b")
}
"bundle literals with non-type-equivalent enum element fields" should "fail" in {
val exc = intercept[BundleLiteralException] {
extractCause[BundleLiteralException] {
ChiselStage.elaborate {
new RawModule {
(new MyBundle).Lit(_.c -> MyEnumB.sB)
}
}
}
}
exc.getMessage should include ("non-type-equivalent enum value")
exc.getMessage should include (".c")
}
"partial bundle literals" should "fail to pack" in {
ChiselStage.elaborate { new RawModule {
val bundleLit = (new MyBundle).Lit(_.a -> 42.U)
bundleLit.litOption should equal (None)
} }
}
}
|
