summaryrefslogtreecommitdiff
path: root/core/src/main/scala/chisel3/aop
diff options
context:
space:
mode:
authorJack Koenig2020-03-22 18:13:58 -0700
committerJack Koenig2020-03-25 19:17:15 -0700
commitfbf5e6f1a0e8bf535d465b748ad554575fe62156 (patch)
tree578858ab6d219ca6daf44cf87b73f75054989097 /core/src/main/scala/chisel3/aop
parentb2e004fb615a3c931d910a338b9faa99c1c975d7 (diff)
Rename subprojects to more canonical names
* Rename coreMacros to macros * Rename chiselFrontend to core Also make each subproject publish with "chisel3-" as a prefix
Diffstat (limited to 'core/src/main/scala/chisel3/aop')
-rw-r--r--core/src/main/scala/chisel3/aop/Aspect.scala40
1 files changed, 40 insertions, 0 deletions
diff --git a/core/src/main/scala/chisel3/aop/Aspect.scala b/core/src/main/scala/chisel3/aop/Aspect.scala
new file mode 100644
index 00000000..9f10a0dd
--- /dev/null
+++ b/core/src/main/scala/chisel3/aop/Aspect.scala
@@ -0,0 +1,40 @@
+// See LICENSE for license details.
+
+package chisel3.aop
+
+import chisel3.RawModule
+import firrtl.annotations.{Annotation, NoTargetAnnotation}
+import firrtl.options.Unserializable
+import firrtl.AnnotationSeq
+
+/** Represents an aspect of a Chisel module, by specifying
+ * what behavior should be done to instance, via the FIRRTL Annotation Mechanism
+ * @tparam T Type of top-level module
+ */
+abstract class Aspect[T <: RawModule] extends Annotation with Unserializable with NoTargetAnnotation {
+ /** Convert this Aspect to a seq of FIRRTL annotation
+ * @param top
+ * @return
+ */
+ def toAnnotation(top: T): AnnotationSeq
+
+ /** Called by [[chisel3.stage.phases.AspectPhase]] to resolve this Aspect into annotations
+ * @param top
+ * @return
+ */
+ private[chisel3] def resolveAspect(top: RawModule): AnnotationSeq = {
+ toAnnotation(top.asInstanceOf[T])
+ }
+}
+
+/** Holds utility functions for Aspect stuff */
+object Aspect {
+
+ /** Converts elaborated Chisel components to FIRRTL modules
+ * @param chiselIR
+ * @return
+ */
+ def getFirrtl(chiselIR: chisel3.internal.firrtl.Circuit): firrtl.ir.Circuit = {
+ chisel3.internal.firrtl.Converter.convert(chiselIR)
+ }
+}