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
|
// SPDX-License-Identifier: Apache-2.0
package firrtl.transforms
import firrtl.annotations.TargetToken.Instance
import firrtl.annotations.{Annotation, NoTargetAnnotation, ReferenceTarget, SingleTargetAnnotation}
import firrtl.options.{CustomFileEmission, Dependency, HasShellOptions, ShellOption}
import firrtl.stage.TransformManager.TransformDependency
import firrtl.stage.{Forms, RunFirrtlTransformAnnotation}
import firrtl.{AnnotationSeq, CircuitState, DependencyAPIMigration, Transform}
/** Contains a static map from signal value(BigInt) to signal name(String)
* This is useful for enumeration(finite state machine, bus transaction name, etc)
*
* @param name identifier for this alias
* @param filters a sequence of translation filter
* @param width width of this alias
*/
case class CustomRadixDefAnnotation(name: String, filters: Seq[(BigInt, String)], width: Int) extends NoTargetAnnotation
/** A annotation making a ReferenceTarget to be a specific [[CustomRadixDefAnnotation]].
*
* @param target the ReferenceTarget which the alias applied to
* @param name the identifier for the alias
*/
case class CustomRadixApplyAnnotation(target: ReferenceTarget, name: String)
extends SingleTargetAnnotation[ReferenceTarget] {
override def duplicate(n: ReferenceTarget): Annotation = this.copy(n)
}
/** Dumps a JSON config file for custom radix. Users can generate script using the emitted file.
*
* @param signals which alias contains which signals, the signals should be converted from ReferenceTarget to String
* @param filters sequence of [[CustomRadixDefAnnotation]], the name should match [[signals]].map(_._1)
*/
case class CustomRadixConfigFileAnnotation(
signals: Seq[(String, Seq[String])],
filters: Seq[CustomRadixDefAnnotation])
extends NoTargetAnnotation
with CustomFileEmission {
def waveViewer = "config"
def baseFileName(annotations: AnnotationSeq): String = "custom_radix"
def suffix: Option[String] = Some(".json")
def getBytes: Iterable[Byte] = {
import org.json4s.JsonDSL.WithBigDecimal._
import org.json4s.native.JsonMethods._
val aliasMap = signals.toMap
pretty(
render(
filters.map { a =>
val values = a.filters.map {
case (int, str) =>
("digit" -> int) ~
("alias" -> str)
}
a.name -> (
("width" -> a.width) ~
("values" -> values) ~
("signals" -> aliasMap(a.name))
)
}
)
)
}.getBytes
}
/** A Transform that generate scripts or config file for Custom Radix */
object CustomRadixTransform extends Transform with DependencyAPIMigration with HasShellOptions {
val options = Seq(
new ShellOption[String](
longOption = "wave-viewer-script",
toAnnotationSeq = str => {
RunFirrtlTransformAnnotation(Dependency(CustomRadixTransform)) +: str.toLowerCase
.split(',')
.map {
case "json" | "" => CustomRadixConfigFileAnnotation(Seq.empty, Seq.empty)
}
.toSeq
},
helpText = "<json>, you can combine them like 'json', pass empty string will generate json",
shortOption = None
)
)
// in case of any rename during transforms.
override def optionalPrerequisites: Seq[TransformDependency] = Forms.BackendEmitters
override def invalidates(a: Transform) = false
protected def execute(state: CircuitState): CircuitState = {
val annos = state.annotations
def toVerilogName(target: ReferenceTarget) =
(target.circuit +: target.tokens.collect { case Instance(i) => i } :+ target.ref).mkString(".")
// todo if scalaVersion >= 2.13: use groupMap
val filters = annos.collect { case a: CustomRadixDefAnnotation => a }
val signals = annos.collect {
case CustomRadixApplyAnnotation(target, name) =>
assert(filters.exists(_.name == name), s"$name not found in CustomRadixDefAnnotation.")
name -> target
}
.groupBy(_._1)
.mapValues(_.map(t => toVerilogName(t._2)))
.toSeq
.sortBy(_._1)
assert(filters.groupBy(_.name).forall(_._2.length == 1), "name collision in CustomRadixDefAnnotation detected.")
state.copy(annotations = annos.map {
case _: CustomRadixConfigFileAnnotation => CustomRadixConfigFileAnnotation(signals, filters)
case a => a
})
}
}
|
