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
|
// SPDX-License-Identifier: Apache-2.0
package firrtl
import java.io.File
import firrtl.annotations.NoTargetAnnotation
import firrtl.backends.experimental.smt.{Btor2Emitter, SMTLibEmitter}
import firrtl.backends.experimental.rtlil.RtlilEmitter
import firrtl.backends.proto.{Emitter => ProtoEmitter}
import firrtl.options.Viewer.view
import firrtl.options.{CustomFileEmission, Dependency, HasShellOptions, PhaseException, ShellOption}
import firrtl.passes.PassException
import firrtl.stage.{FirrtlFileAnnotation, FirrtlOptions, RunFirrtlTransformAnnotation}
case class EmitterException(message: String) extends PassException(message)
// ***** Annotations for telling the Emitters what to emit *****
sealed trait EmitAnnotation extends NoTargetAnnotation {
val emitter: Class[_ <: Emitter]
}
case class EmitCircuitAnnotation(emitter: Class[_ <: Emitter]) extends EmitAnnotation
case class EmitAllModulesAnnotation(emitter: Class[_ <: Emitter]) extends EmitAnnotation
object EmitCircuitAnnotation extends HasShellOptions {
val options = Seq(
new ShellOption[String](
longOption = "emit-circuit",
toAnnotationSeq = (a: String) =>
a match {
case "chirrtl" =>
Seq(RunFirrtlTransformAnnotation(new ChirrtlEmitter), EmitCircuitAnnotation(classOf[ChirrtlEmitter]))
case "mhigh" =>
Seq(
RunFirrtlTransformAnnotation(new MinimumHighFirrtlEmitter),
EmitCircuitAnnotation(classOf[MinimumHighFirrtlEmitter])
)
case "high" =>
Seq(RunFirrtlTransformAnnotation(new HighFirrtlEmitter), EmitCircuitAnnotation(classOf[HighFirrtlEmitter]))
case "middle" =>
Seq(
RunFirrtlTransformAnnotation(new MiddleFirrtlEmitter),
EmitCircuitAnnotation(classOf[MiddleFirrtlEmitter])
)
case "low" =>
Seq(RunFirrtlTransformAnnotation(new LowFirrtlEmitter), EmitCircuitAnnotation(classOf[LowFirrtlEmitter]))
case "low-opt" =>
Seq(
RunFirrtlTransformAnnotation(Dependency(LowFirrtlOptimizedEmitter)),
EmitCircuitAnnotation(LowFirrtlOptimizedEmitter.getClass)
)
case "verilog" | "mverilog" =>
Seq(RunFirrtlTransformAnnotation(new VerilogEmitter), EmitCircuitAnnotation(classOf[VerilogEmitter]))
case "sverilog" =>
Seq(
RunFirrtlTransformAnnotation(new SystemVerilogEmitter),
EmitCircuitAnnotation(classOf[SystemVerilogEmitter])
)
case "experimental-btor2" | "btor2" =>
Seq(RunFirrtlTransformAnnotation(Dependency(Btor2Emitter)), EmitCircuitAnnotation(Btor2Emitter.getClass))
case "experimental-smt2" | "smt2" =>
Seq(RunFirrtlTransformAnnotation(Dependency(SMTLibEmitter)), EmitCircuitAnnotation(SMTLibEmitter.getClass))
case "experimental-rtlil" =>
Seq(RunFirrtlTransformAnnotation(Dependency[RtlilEmitter]), EmitCircuitAnnotation(classOf[RtlilEmitter]))
case _ => throw new PhaseException(s"Unknown emitter '$a'! (Did you misspell it?)")
},
helpText = "Run the specified circuit emitter (all modules in one file)",
shortOption = Some("E"),
// the experimental options are intentionally excluded from the help message
helpValueName = Some("<chirrtl|high|middle|low|verilog|mverilog|sverilog>")
),
new ShellOption[String](
longOption = "emit-circuit-protobuf",
toAnnotationSeq = (a: String) =>
a match {
case "chirrtl" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.Chirrtl),
EmitCircuitAnnotation(classOf[ProtoEmitter.Chirrtl])
)
case "mhigh" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.MHigh),
EmitCircuitAnnotation(classOf[ProtoEmitter.MHigh])
)
case "high" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.High),
EmitCircuitAnnotation(classOf[ProtoEmitter.High])
)
case "middle" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.Middle),
EmitCircuitAnnotation(classOf[ProtoEmitter.Middle])
)
case "low" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.Low),
EmitCircuitAnnotation(classOf[ProtoEmitter.Low])
)
case "low-opt" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.OptLow),
EmitCircuitAnnotation(classOf[ProtoEmitter.OptLow])
)
case _ => throw new PhaseException(s"Unknown emitter '$a'! (Did you misspell it?)")
},
helpText = "Run the specified circuit emitter generating a Protocol Buffer format",
shortOption = Some("P"),
// the experimental options are intentionally excluded from the help message
helpValueName = Some(
"<chirrtl|mhigh|high|middle|low|low-opt>"
)
)
)
}
object EmitAllModulesAnnotation extends HasShellOptions {
val options = Seq(
new ShellOption[String](
longOption = "emit-modules",
toAnnotationSeq = (a: String) =>
a match {
case "chirrtl" =>
Seq(RunFirrtlTransformAnnotation(new ChirrtlEmitter), EmitAllModulesAnnotation(classOf[ChirrtlEmitter]))
case "mhigh" =>
Seq(
RunFirrtlTransformAnnotation(new MinimumHighFirrtlEmitter),
EmitAllModulesAnnotation(classOf[MinimumHighFirrtlEmitter])
)
case "high" =>
Seq(
RunFirrtlTransformAnnotation(new HighFirrtlEmitter),
EmitAllModulesAnnotation(classOf[HighFirrtlEmitter])
)
case "middle" =>
Seq(
RunFirrtlTransformAnnotation(new MiddleFirrtlEmitter),
EmitAllModulesAnnotation(classOf[MiddleFirrtlEmitter])
)
case "low" =>
Seq(RunFirrtlTransformAnnotation(new LowFirrtlEmitter), EmitAllModulesAnnotation(classOf[LowFirrtlEmitter]))
case "verilog" | "mverilog" =>
Seq(RunFirrtlTransformAnnotation(new VerilogEmitter), EmitAllModulesAnnotation(classOf[VerilogEmitter]))
case "sverilog" =>
Seq(
RunFirrtlTransformAnnotation(new SystemVerilogEmitter),
EmitAllModulesAnnotation(classOf[SystemVerilogEmitter])
)
case "experimental-rtlil" =>
Seq(RunFirrtlTransformAnnotation(Dependency[RtlilEmitter]), EmitAllModulesAnnotation(classOf[RtlilEmitter]))
case _ => throw new PhaseException(s"Unknown emitter '$a'! (Did you misspell it?)")
},
helpText = "Run the specified module emitter (one file per module)",
shortOption = Some("e"),
helpValueName = Some("<chirrtl|high|middle|low|verilog|mverilog|sverilog>")
),
new ShellOption[String](
longOption = "emit-modules-protobuf",
toAnnotationSeq = (a: String) =>
a match {
case "chirrtl" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.Chirrtl),
EmitAllModulesAnnotation(classOf[ProtoEmitter.Chirrtl])
)
case "mhigh" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.MHigh),
EmitAllModulesAnnotation(classOf[ProtoEmitter.MHigh])
)
case "high" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.High),
EmitAllModulesAnnotation(classOf[ProtoEmitter.High])
)
case "middle" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.Middle),
EmitAllModulesAnnotation(classOf[ProtoEmitter.Middle])
)
case "low" =>
Seq(RunFirrtlTransformAnnotation(new ProtoEmitter.Low), EmitAllModulesAnnotation(classOf[ProtoEmitter.Low]))
case "low-opt" =>
Seq(
RunFirrtlTransformAnnotation(new ProtoEmitter.OptLow),
EmitAllModulesAnnotation(classOf[ProtoEmitter.OptLow])
)
case _ => throw new PhaseException(s"Unknown emitter '$a'! (Did you misspell it?)")
},
helpText = "Run the specified module emitter (one protobuf per module)",
shortOption = Some("p"),
helpValueName = Some("<chirrtl|mhigh|high|middle|low|low-opt>")
),
new ShellOption[String](
longOption = "emission-options",
toAnnotationSeq = s =>
s.split(",")
.map {
case "disableMemRandomization" =>
CustomDefaultRegisterEmission(useInitAsPreset = true, disableRandomization = true)
case "disableRegisterRandomization" => CustomDefaultMemoryEmission(MemoryNoInit)
case a => throw new PhaseException(s"Unknown emission options '$a'! (Did you misspell it?)")
}
.toSeq,
helpText = "Options to disable random initialization for memory and registers",
helpValueName = Some("<disableMemRandomization,disableRegisterRandomization>")
)
)
}
// ***** Annotations for results of emission *****
sealed abstract class EmittedComponent {
def name: String
def value: String
def outputSuffix: String
}
sealed abstract class EmittedCircuit extends EmittedComponent
sealed abstract class EmittedModule extends EmittedComponent
/** Traits for Annotations containing emitted components */
trait EmittedAnnotation[T <: EmittedComponent] extends NoTargetAnnotation with CustomFileEmission {
val value: T
override protected def baseFileName(annotations: AnnotationSeq): String = {
view[FirrtlOptions](annotations).outputFileName.getOrElse(value.name)
}
override protected val suffix: Option[String] = Some(value.outputSuffix)
}
sealed trait EmittedCircuitAnnotation[T <: EmittedCircuit] extends EmittedAnnotation[T] {
override def getBytes = value.value.getBytes
}
sealed trait EmittedModuleAnnotation[T <: EmittedModule] extends EmittedAnnotation[T] {
override def getBytes = value.value.getBytes
}
case class EmittedFirrtlModuleAnnotation(value: EmittedFirrtlModule)
extends EmittedModuleAnnotation[EmittedFirrtlModule]
case class EmittedFirrtlCircuitAnnotation(value: EmittedFirrtlCircuit)
extends EmittedCircuitAnnotation[EmittedFirrtlCircuit] {
override def replacements(file: File): AnnotationSeq = Seq(FirrtlFileAnnotation(file.toString))
}
final case class EmittedFirrtlCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit
final case class EmittedFirrtlModule(name: String, value: String, outputSuffix: String) extends EmittedModule
final case class EmittedVerilogCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit
final case class EmittedVerilogModule(name: String, value: String, outputSuffix: String) extends EmittedModule
case class EmittedVerilogCircuitAnnotation(value: EmittedVerilogCircuit)
extends EmittedCircuitAnnotation[EmittedVerilogCircuit]
case class EmittedVerilogModuleAnnotation(value: EmittedVerilogModule)
extends EmittedModuleAnnotation[EmittedVerilogModule]
|
