Deprecate everything in package firrtl (#4878)

Previously, we tried to avoid this by deprecating any imports from the
firrtl package, but this missed things. Instead, we deprecate every
public class, object, and trait.

Also delete the previous attempt using the DeprecateSFCComponent in the
compiler plugin. It is now redundant.

Author: jackkoenig

build.mill

@@ -77,7 +77,7 @@ object v extends Module {
 
   val scala2WarnConf = Seq(
     "msg=APIs in chisel3.internal:s",
-    "msg=Importing from firrtl:s",
+    "msg=All APIs in package firrtl:s",
     "msg=migration to the MLIR:s",
     "msg=method hasDefiniteSize in trait IterableOnceOps is deprecated:s", // replacement `knownSize` is not in 2.12
     "msg=object JavaConverters in package collection is deprecated:s",

firrtl/src/main/scala/firrtl/AttributeAnnotation.scala

@@ -7,6 +7,7 @@ import firrtl.annotations.{Named, SingleTargetAnnotation}
   * @param target       target component to tag with attribute
   * @param description  Attribute string to add to target
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class AttributeAnnotation(target: Named, description: String) extends SingleTargetAnnotation[Named] {
   def duplicate(n: Named): AttributeAnnotation = this.copy(target = n, description = description)
 }

firrtl/src/main/scala/firrtl/Compiler.scala

@@ -5,9 +5,11 @@ package firrtl
 import firrtl.annotations._
 
 /** Container of all annotations for a Firrtl compiler */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 class AnnotationSeq private (underlying: Seq[Annotation]) {
   def toSeq: Seq[Annotation] = underlying
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object AnnotationSeq {
   def apply(xs: Seq[Annotation]): AnnotationSeq = new AnnotationSeq(xs)
 }

firrtl/src/main/scala/firrtl/Emitter.scala

@@ -9,6 +9,7 @@ import firrtl.stage.FirrtlOptions
 import firrtl.stage.FirrtlOptionsView
 
 // ***** Annotations for results of emission *****
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed abstract class EmittedComponent {
   def name: String
 
@@ -17,9 +18,11 @@ sealed abstract class EmittedComponent {
   def outputSuffix: String
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed abstract class EmittedCircuit extends EmittedComponent
 
 /** Traits for Annotations containing emitted components */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait EmittedAnnotation[T <: EmittedComponent] extends NoTargetAnnotation with CustomFileEmission {
   val value: T
 
@@ -30,20 +33,27 @@ trait EmittedAnnotation[T <: EmittedComponent] extends NoTargetAnnotation with C
   override protected val suffix: Option[String] = Some(value.outputSuffix)
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed trait EmittedCircuitAnnotation[T <: EmittedCircuit] extends EmittedAnnotation[T] {
   override def getBytes = value.value.getBytes
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class EmittedFirrtlCircuitAnnotation(value: EmittedFirrtlCircuit)
     extends EmittedCircuitAnnotation[EmittedFirrtlCircuit]
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 final case class EmittedFirrtlCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 final case class EmittedBtor2Circuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class EmittedBtor2CircuitAnnotation(value: EmittedBtor2Circuit)
     extends EmittedCircuitAnnotation[EmittedBtor2Circuit]
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 final case class EmittedVerilogCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class EmittedVerilogCircuitAnnotation(value: EmittedVerilogCircuit)
     extends EmittedCircuitAnnotation[EmittedVerilogCircuit]

firrtl/src/main/scala/firrtl/FirrtlException.scala

@@ -9,6 +9,7 @@ import scala.util.control.NoStackTrace
   * These exceptions indicate a problem due to bad input and thus do not include a stack trace.
   * This can be extended by custom transform writers.
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 class FirrtlUserException(message: String, cause: Throwable = null)
     extends RuntimeException(message, cause)
     with NoStackTrace

firrtl/src/main/scala/firrtl/Parser.scala

@@ -2,6 +2,7 @@
 
 package firrtl
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object Parser {
 
   sealed abstract class InfoMode

firrtl/src/main/scala/firrtl/PrimOps.scala

@@ -6,6 +6,7 @@ import logger.LazyLogging
 import firrtl.ir._
 
 /** Definitions and Utility functions for [[ir.PrimOp]]s */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object PrimOps extends LazyLogging {
 
   /** Addition */

firrtl/src/main/scala/firrtl/RenameMap.scala

@@ -9,6 +9,7 @@ import firrtl.renamemap._
 
 import scala.collection.mutable
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object RenameMap {
   def apply(map: collection.Map[Named, Seq[Named]], circuitName: String): RenameMap =
     MutableRenameMap.fromNamed(map, circuitName)
@@ -31,6 +32,7 @@ object RenameMap {
   * @define noteDistinct @note Rename to/tos will be made distinct
   */
 // TODO This should probably be refactored into immutable and mutable versions
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed trait RenameMap {
 
   // Records the name of the circuit to which this rename map applies.  This is
@@ -521,6 +523,7 @@ sealed trait RenameMap {
 
 // This must be in same file as RenameMap because RenameMap is sealed
 package object renamemap {
+  @deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
   object MutableRenameMap {
     def fromNamed(map: collection.Map[Named, Seq[Named]], circuitName: String): MutableRenameMap = {
       val rm = new MutableRenameMap(circuitName)
@@ -538,6 +541,7 @@ package object renamemap {
     def apply(circuitName: String): MutableRenameMap = new MutableRenameMap(circuitName)
   }
 
+  @deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
   final class MutableRenameMap private[firrtl] (
     override protected val circuitName: String,
     protected val _underlying: mutable.HashMap[CompleteTarget, Seq[CompleteTarget]] =

firrtl/src/main/scala/firrtl/Utils.scala

@@ -6,6 +6,7 @@ import firrtl.ir._
 
 import _root_.logger.LazyLogging
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object Utils extends LazyLogging {
 
   /** Unwind the causal chain until we hit the initial exception (which may be the first).

firrtl/src/main/scala/firrtl/WIR.scala

@@ -4,20 +4,26 @@ package firrtl
 
 import firrtl.ir._
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 abstract class MPortDir extends FirrtlNode
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case object MInfer extends MPortDir {
   def serialize: String = "infer"
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case object MRead extends MPortDir {
   def serialize: String = "read"
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case object MWrite extends MPortDir {
   def serialize: String = "write"
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case object MReadWrite extends MPortDir {
   def serialize: String = "rdwr"
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class CDefMemory(
   info:           Info,
   name:           String,
@@ -39,6 +45,7 @@ case class CDefMemory(
   def foreachString(f: String => Unit):           Unit = f(name)
   def foreachInfo(f:   Info => Unit):             Unit = f(info)
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class CDefMPort(info: Info, name: String, tpe: Type, mem: String, exps: Seq[Expression], direction: MPortDir)
     extends Statement
     with HasInfo

firrtl/src/main/scala/firrtl/annotations/Annotation.scala

@@ -5,9 +5,11 @@ package annotations
 
 import org.json4s.JValue
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class AnnotationException(message: String) extends Exception(message)
 
 /** Base type of auxiliary information */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait Annotation extends Product {
 
   /** Update the target based on how signals are renamed */
@@ -24,11 +26,13 @@ trait Annotation extends Product {
 /** If an Annotation does not target any [[Named]] thing in the circuit, then all updates just
   * return the Annotation itself
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait NoTargetAnnotation extends Annotation {
   def update(renames: RenameMap): Seq[NoTargetAnnotation] = Seq(this)
 }
 
 /** An Annotation that targets a single [[Named]] thing */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait SingleTargetAnnotation[T <: Named] extends Annotation {
   val target: T
 
@@ -71,6 +75,8 @@ trait SingleTargetAnnotation[T <: Named] extends Annotation {
   }
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object Annotation
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class UnrecognizedAnnotation(underlying: JValue) extends NoTargetAnnotation

firrtl/src/main/scala/firrtl/annotations/AnnotationUtils.scala

@@ -7,19 +7,26 @@ import java.io.File
 
 import firrtl.ir._
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class InvalidAnnotationFileException(file: File, cause: FirrtlUserException = null)
     extends FirrtlUserException(s"$file", cause)
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class UnrecogizedAnnotationsException(msg: String) extends FirrtlUserException(s"Unrecognized annotations $msg")
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class InvalidAnnotationJSONException(msg: String) extends FirrtlUserException(msg)
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class AnnotationFileNotFoundException(file: File)
     extends FirrtlUserException(
       s"Annotation file $file not found!"
     )
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class AnnotationClassNotFoundException(className: String)
     extends FirrtlUserException(
       s"Annotation class $className not found! Please check spelling and classpath"
     )
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 class UnserializableAnnotationException private (msg: String) extends FirrtlUserException(msg)
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object UnserializableAnnotationException {
   private def toMessage(pair: (Annotation, Throwable)): String =
     s"Failed to serialiaze annotation of type ${pair._1.getClass.getName} because '${pair._2.getMessage}'"
@@ -30,6 +37,7 @@ object UnserializableAnnotationException {
   }
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object AnnotationUtils {
 
   /** Returns true if a valid Module name */

firrtl/src/main/scala/firrtl/annotations/JsonProtocol.scala

@@ -17,6 +17,7 @@ import org.json4s.native.Serialization.{read, write, writePretty}
 import scala.collection.mutable
 import java.io.{StringWriter, Writer}
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait HasSerializationHints {
   // For serialization of complicated constructor arguments, let the annotation
   // writer specify additional type hints for relevant classes that might be
@@ -25,8 +26,10 @@ trait HasSerializationHints {
 }
 
 /** Wrapper [[Annotation]] for Annotations that cannot be serialized */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class UnserializeableAnnotation(error: String, content: String) extends NoTargetAnnotation
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object JsonProtocol extends LazyLogging {
   private val GetClassPattern = "[^']*'([^']+)'.*".r
 

firrtl/src/main/scala/firrtl/annotations/LoadMemoryAnnotation.scala

@@ -8,10 +8,12 @@ import firrtl.FirrtlUserException
 
 /** Representation of the two types of `readmem` statements available in Verilog.
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed abstract class MemoryLoadFileType(val value: String) {
   def serialize: String = value
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object MemoryLoadFileType {
   // purely for backwards compatibility with chisel3's ChiselLoadMemoryAnnotation
   type FileType = MemoryLoadFileType
@@ -30,6 +32,7 @@ object MemoryLoadFileType {
   * @param fileName      name of input file
   * @param hexOrBinary   use `\$readmemh` or `\$readmemb`
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class LoadMemoryAnnotation(
   target:                ComponentName,
   fileName:              String,

firrtl/src/main/scala/firrtl/annotations/MemoryInitAnnotation.scala

@@ -7,11 +7,13 @@ package firrtl.annotations
   * While not supported on normal ASIC flows, it can be useful for simulation and FPGA flows.
   * This annotation is consumed by the verilog emitter.
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed trait MemoryInitAnnotation extends SingleTargetAnnotation[ReferenceTarget] {
   def isRandomInit: Boolean
 }
 
 /** Initialize the `target` memory with inline readmem[hb] statement. */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class MemoryFileInlineAnnotation(
   target:      ReferenceTarget,
   filename:    String,

firrtl/src/main/scala/firrtl/annotations/Target.scala

@@ -17,6 +17,7 @@ import scala.collection.mutable
   *   - Complete: moduleOpt is non-empty, and all Instance(_) are followed by OfModule(_)
   *   - Local: tokens does not refer to things through an instance hierarchy (no Instance(_) or OfModule(_) tokens)
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed trait Target extends Named {
 
   /** @return Module name, if it exists */
@@ -79,6 +80,7 @@ sealed trait Target extends Named {
   def path: Seq[(Instance, OfModule)]
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object Target {
   def asTarget(m: ModuleTarget)(e: Expression): ReferenceTarget = e match {
     case r: ir.Reference => m.ref(r.name)
@@ -193,6 +195,7 @@ object Target {
   * @param moduleOpt Optional module name
   * @param tokens [[TargetToken]]s to represent the target in a module
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class GenericTarget(moduleOpt: Option[String], tokens: Vector[TargetToken]) extends Target {
 
   override def toGenericTarget: GenericTarget = this
@@ -342,6 +345,7 @@ case class GenericTarget(moduleOpt: Option[String], tokens: Vector[TargetToken])
 /** Concretely points to a FIRRTL target, no generic selectors
   * IsLegal
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait CompleteTarget extends Target {
 
   def getComplete: Option[CompleteTarget] = Some(this)
@@ -363,6 +367,7 @@ trait CompleteTarget extends Target {
 /** A member of a FIRRTL Circuit
   * Concrete Subclasses are: [[ModuleTarget]], [[InstanceTarget]], and [[ReferenceTarget]]
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait IsMember extends CompleteTarget {
 
   /** @return Root module, e.g. top-level module of this target */
@@ -414,6 +419,7 @@ trait IsMember extends CompleteTarget {
 
 /** References a module-like target (e.g. a [[ModuleTarget]] or an [[InstanceTarget]])
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait IsModule extends IsMember {
 
   /** @return Creates a new Target, appending a ref */
@@ -427,6 +433,7 @@ trait IsModule extends IsMember {
 
 /** A component of a FIRRTL Module (e.g. cannot point to a ModuleTarget)
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait IsComponent extends IsMember {
 
   /** Removes n levels of instance hierarchy
@@ -477,6 +484,7 @@ trait IsComponent extends IsMember {
 /** Target pointing to a FIRRTL [[firrtl.ir.DefModule]]
   * @param module Name of the module
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class ModuleTarget(module: String) extends IsModule {
 
   override def moduleOpt: Option[String] = Some(module)
@@ -520,6 +528,7 @@ case class ModuleTarget(module: String) extends IsModule {
   * @param ref Name of component
   * @param component Subcomponent of this reference, e.g. field or index
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class ReferenceTarget(
   module:            String,
   override val path: Seq[(Instance, OfModule)],
@@ -613,6 +622,7 @@ case class ReferenceTarget(
   * @param instance Name of the instance
   * @param ofModule Name of the instance's module
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class InstanceTarget(
   module:            String,
   override val path: Seq[(Instance, OfModule)],
@@ -677,15 +687,18 @@ case class InstanceTarget(
 }
 
 /** Named classes associate an annotation with a component in a Firrtl circuit */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed trait Named {
   def toTarget: CompleteTarget
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 final case class ModuleName(name: String) extends Named {
   if (!validModuleName(name)) throw AnnotationException(s"Illegal module name: $name")
   def toTarget: ModuleTarget = ModuleTarget(name)
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 final case class ComponentName(name: String, module: ModuleName) extends Named {
   if (!validComponentName(name)) throw AnnotationException(s"Illegal component name: $name")
   def expr: Expression = toExp(name)