Packages

  • package root

    This is the documentation for Firrtl.

    This is the documentation for Firrtl.

    Definition Classes
    root
  • package firrtl
    Definition Classes
    root
  • package stage

    The stage package provides an implementation of the FIRRTL compiler using the firrtl.options package.

    The stage package provides an implementation of the FIRRTL compiler using the firrtl.options package. This primarily consists of:

    Definition Classes
    firrtl
  • package phases
    Definition Classes
    stage
  • object DriverCompatibility

    Provides compatibility methods to replicate deprecated Driver semantics.

    Provides compatibility methods to replicate deprecated Driver semantics.

    At a high level, the Driver tries extremely hard to figure out what the user meant and to enable them to not be explicit with command line options. As an example, the --top-name option is not used for any FIRRTL top module determination, but to find a FIRRTL file by that name and/or an annotation file by that name. This mode of file discovery is only used if no explicit FIRRTL file/source/circuit and/or annotation file is given. Going further, the --top-name argument is implicitly specified by the main of an input circuit if not explicit and can be used to derive an annotation file. Summarily, the Phases provided by this enable this type of resolution.

    Only use these methods if you are intending to replicate old Driver semantics for a good reason. Otherwise, opt for more explicit specification by the user.

    Definition Classes
    phases
  • AddImplicitAnnotationFile
  • AddImplicitEmitter
  • AddImplicitFirrtlFile
  • AddImplicitOutputFile
  • EmitOneFilePerModuleAnnotation
  • TopNameAnnotation
c

firrtl.stage.phases.DriverCompatibility

AddImplicitAnnotationFile

class AddImplicitAnnotationFile extends Phase

Add an implicit annotation file derived from the determined top name of the circuit if no InputAnnotationFileAnnotation is present.

The implicit annotation file is determined through the following complicated semantics:

The precedence for determining the topName is the following (first one wins):

returns

output annotations

Source
DriverCompatibility.scala
Linear Supertypes
Phase, DependencyAPI[Phase], TransformLike[AnnotationSeq], LazyLogging, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AddImplicitAnnotationFile
  2. Phase
  3. DependencyAPI
  4. TransformLike
  5. LazyLogging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AddImplicitAnnotationFile()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def getLogger: Logger
    Definition Classes
    LazyLogging
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def invalidates(a: Phase): Boolean

    A function that, given *another* transform (parameter a) will return true if this transform invalidates/undos the effects of the *other* transform (parameter a).

    A function that, given *another* transform (parameter a) will return true if this transform invalidates/undos the effects of the *other* transform (parameter a).

    a

    transform

    Definition Classes
    AddImplicitAnnotationFile → DependencyAPI
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
  14. lazy val name: String

    The name of this Phase.

    The name of this Phase. This will be used to generate debug/error messages or when deleting annotations. This will default to the simpleName of the class.

    returns

    this phase's name

    Definition Classes
    Phase → TransformLike
    Note

    Override this with your own implementation for different naming behavior.

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def optionalPrerequisiteOf: Seq[Dependency[Phase]]

    A sequence of transforms to add this transform as an optionalPrerequisite.

    A sequence of transforms to add this transform as an optionalPrerequisite. The use of optionalPrerequisiteOf enables the transform declaring them to always run before some other transforms. However, declaring optionalPrerequisiteOf will not result in the sequence of transforms executing.

    This is useful for providing an ordering constraint to guarantee that other transforms (e.g., emitters) will not be scheduled before you.

    Definition Classes
    AddImplicitAnnotationFile → DependencyAPI
    Note

    This method **will not** result in the listed transforms running. If you want to add multiple transforms at once, you should use a DependencyManager with multiple targets.

  19. def optionalPrerequisites: Seq[Dependency[Phase]]

    All transforms that, if a prerequisite of *another* transform, will run before this transform.

    All transforms that, if a prerequisite of *another* transform, will run before this transform.

    Definition Classes
    DependencyAPI
    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

  20. def prerequisites: Seq[Dependency[AddImplicitFirrtlFile]]

    All transform that must run before this transform

    All transform that must run before this transform

    Definition Classes
    AddImplicitAnnotationFile → DependencyAPI
    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def transform(annotations: AnnotationSeq): AnnotationSeq

    Try to add an InputAnnotationFileAnnotation implicitly specified by an AnnotationSeq.

    Try to add an InputAnnotationFileAnnotation implicitly specified by an AnnotationSeq.

    returns

    an output object of the same type

    Definition Classes
    AddImplicitAnnotationFile → TransformLike
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def dependents: Seq[Dependency[Phase]]

    All transforms that must run after this transform

    All transforms that must run after this transform

    This is a means of prerequisite injection into some other transform. Normally a transform will define its own prerequisites. Dependents exist for two main situations:

    First, they improve the composition of optional transforms. If some first transform is optional (e.g., an expensive validation check), you would like to be able to conditionally cause it to run. If it is listed as a prerequisite on some other, second transform then it must always run before that second transform. There's no way to turn it off. However, by listing the second transform as a dependent of the first transform, the first transform will only run (and be treated as a prerequisite of the second transform) if included in a list of target transforms that should be run.

    Second, an external library would like to inject some first transform before a second transform inside FIRRTL. In this situation, the second transform cannot have any knowledge of external libraries. The use of a dependent here allows for prerequisite injection into FIRRTL proper.

    Definition Classes
    DependencyAPI
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.

    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

    See also

    firrtl.passes.CheckTypes for an example of an optional checking firrtl.Transform

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Phase

Inherited from DependencyAPI[Phase]

Inherited from TransformLike[AnnotationSeq]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped