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
|
// See LICENSE for license details.
package chiselTests.naming
import chisel3._
import chisel3.aop.Select
import chisel3.experimental.{prefix, treedump}
import chiselTests.{ChiselFlatSpec, Utils}
class NamePluginSpec extends ChiselFlatSpec with Utils {
implicit val minimumScalaVersion: Int = 12
"Scala plugin" should "name internally scoped components" in {
class Test extends MultiIOModule {
{ val mywire = Wire(UInt(3.W))}
}
aspectTest(() => new Test) {
top: Test => Select.wires(top).head.toTarget.ref should be("mywire")
}
}
"Scala plugin" should "name internally scoped instances" in {
class Inner extends MultiIOModule { }
class Test extends MultiIOModule {
{ val myinstance = Module(new Inner) }
}
aspectTest(() => new Test) {
top: Test => Select.instances(top).head.instanceName should be("myinstance")
}
}
"Scala plugin" should "interact with prefixing" in {
class Test extends MultiIOModule {
def builder() = {
val wire = Wire(UInt(3.W))
}
prefix("first") {
builder()
}
prefix("second") {
builder()
}
}
aspectTest(() => new Test) {
top: Test => Select.wires(top).map(_.instanceName) should be (List("first_wire", "second_wire"))
}
}
"Scala plugin" should "interact with prefixing so last val name wins" in {
class Test extends MultiIOModule {
def builder() = {
val wire1 = Wire(UInt(3.W))
val wire2 = Wire(UInt(3.W))
wire2
}
{
val x1 = prefix("first") {
builder()
}
}
{
val x2 = prefix("second") {
builder()
}
}
}
aspectTest(() => new Test) {
top: Test => Select.wires(top).map(_.instanceName) should be (List("x1_first_wire1", "x1", "x2_second_wire1", "x2"))
}
}
"Naming on option" should "work" in {
class Test extends MultiIOModule {
def builder(): Option[UInt] = {
val a = Wire(UInt(3.W))
Some(a)
}
{ val blah = builder() }
}
aspectTest(() => new Test) {
top: Test =>
Select.wires(top).map(_.instanceName) should be (List("blah"))
}
}
"Naming on iterables" should "work" in {
class Test extends MultiIOModule {
def builder(): Seq[UInt] = {
val a = Wire(UInt(3.W))
val b = Wire(UInt(3.W))
Seq(a, b)
}
{
val blah = {
builder()
}
}
}
aspectTest(() => new Test) {
top: Test =>
Select.wires(top).map(_.instanceName) should be (List("blah_0", "blah_1"))
}
}
"Naming on nested iterables" should "work" in {
class Test extends MultiIOModule {
def builder(): Seq[Seq[UInt]] = {
val a = Wire(UInt(3.W))
val b = Wire(UInt(3.W))
val c = Wire(UInt(3.W))
val d = Wire(UInt(3.W))
Seq(Seq(a, b), Seq(c, d))
}
{
val blah = {
builder()
}
}
}
aspectTest(() => new Test) {
top: Test =>
Select.wires(top).map(_.instanceName) should be (
List(
"blah_0_0",
"blah_0_1",
"blah_1_0",
"blah_1_1"
))
}
}
"Naming on custom case classes" should "not work" in {
case class Container(a: UInt, b: UInt)
class Test extends MultiIOModule {
def builder(): Container = {
val a = Wire(UInt(3.W))
val b = Wire(UInt(3.W))
Container(a, b)
}
{ val blah = builder() }
}
aspectTest(() => new Test) {
top: Test =>
Select.wires(top).map(_.instanceName) should be (List("a", "b"))
}
}
"Multiple names on an IO within a module" should "get the first name" in {
class Test extends RawModule {
{
val a = IO(Output(UInt(3.W)))
val b = a
}
}
aspectTest(() => new Test) {
top: Test =>
Select.ios(top).map(_.instanceName) should be (List("a"))
}
}
"Multiple names on a non-IO" should "get the last name" in {
class Test extends MultiIOModule {
{
val a = Wire(UInt(3.W))
val b = a
}
}
aspectTest(() => new Test) {
top: Test =>
Select.wires(top).map(_.instanceName) should be (List("b"))
}
}
"Unapply assignments" should "still be named" in {
class Test extends MultiIOModule {
{
val (a, b) = (Wire(UInt(3.W)), Wire(UInt(3.W)))
}
}
aspectTest(() => new Test) {
top: Test =>
Select.wires(top).map(_.instanceName) should be (List("a", "b"))
}
}
"Recursive types" should "not infinitely loop" in {
// When this fails, it causes a StackOverflow when compiling the tests
// Unfortunately, this doesn't seem to work with assertCompiles(...), it probably ignores the
// custom project scalacOptions
def func(x: String) = {
// We only check types of vals, we don't actually want to run this code though
val y = scala.xml.XML.loadFile(x)
y
}
}
"Nested val declarations" should "all be named" in {
class Test extends MultiIOModule {
{
val a = {
val b = {
val c = Wire(UInt(3.W))
Wire(UInt(3.W))
}
Wire(UInt(3.W))
}
}
}
aspectTest(() => new Test) {
top: Test => Select.wires(top).map(_.instanceName) should be (List("a_b_c", "a_b", "a"))
}
}
}
|
