From 117054bb4cdc3c5abf34ba5c99f61bcd590871f0 Mon Sep 17 00:00:00 2001
From: Kevin Laeufer
Date: Tue, 15 Jun 2021 16:36:50 -0700
Subject: make PresetRegAnnotation public (#2254)

* make PresetRegAnnotation public

this annotation is useful outside the firrtl compiler:
- to implement a pass that creates registers which
  need to be initialized at the beginning of simulation
  (e.g., for formal verification)
- to support preset registers in treadle

* add PresetRegAnnotation test and deal with annotation correctly in RemoveReset pass---
 .../firrtl/annotations/PresetAnnotations.scala     | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

(limited to 'src/main/scala/firrtl/annotations')

diff --git a/src/main/scala/firrtl/annotations/PresetAnnotations.scala b/src/main/scala/firrtl/annotations/PresetAnnotations.scala
index 32f24f13..449679cc 100644
--- a/src/main/scala/firrtl/annotations/PresetAnnotations.scala
+++ b/src/main/scala/firrtl/annotations/PresetAnnotations.scala
@@ -17,15 +17,31 @@ case class PresetAnnotation(target: ReferenceTarget)
 
 /**
   * Transform the targeted asynchronously-reset Reg into a bitstream preset Reg
-  * Used internally to annotate all registers associated to an AsyncReset tree
+  * Thus you can use this annotation in order to initialize a register
+  * at the beginning of simulation or through the FPGA bit-stream to its `init` value.
+  *
+  * The register must fulfil the following requirements:
+  * - the reset signal is `UInt(0)`
+  * - the `init` value is a Literal
   *
   * @param target ReferenceTarget to a Reg
   */
-private[firrtl] case class PresetRegAnnotation(
+case class PresetRegAnnotation(
   target: ReferenceTarget)
     extends SingleTargetAnnotation[ReferenceTarget]
-    with RegisterEmissionOption {
+    with RegisterEmissionOption
+    with firrtl.transforms.DontTouchAllTargets {
   def duplicate(n: ReferenceTarget) = this.copy(target = n)
   override def useInitAsPreset = true
   override def disableRandomization = true
 }
+
+object PresetRegAnnotation {
+
+  /** Extracts the names of every preset reg in the design by module. */
+  def collect(annotations: AnnotationSeq, main: String): Map[String, Set[String]] =
+    annotations.collect {
+      case a: PresetRegAnnotation if a.target.circuit == main =>
+        a.target.module -> a.target.ref
+    }.groupBy(_._1).map { case (k, v) => k -> v.map(_._2).toSet }
+}
-- 
cgit v1.2.3