Packages

trait Phase extends TransformLike[AnnotationSeq] with DependencyAPI[Phase]

A mathematical transformation of an AnnotationSeq.

A Phase forms one unit in the Chisel/FIRRTL Hardware Compiler Framework (HCF). The HCF is built from a sequence of Phases applied to an AnnotationSeq. Note that a Phase may consist of multiple phases internally.

Annotations
@deprecated
Deprecated

(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.

Source
Phase.scala
Linear Supertypes
DependencyAPI[Phase], TransformLike[AnnotationSeq], LazyLogging, AnyRef, Any
Known Subclasses
AddDedupGroupAnnotations, AddImplicitOutputAnnotationFile, AddImplicitOutputFile, AddSerializationAnnotations, Checks, Convert, Elaborate, Emitter, ChiselStage, AddImplicitOutputFile, CIRCT, Checks, PhaseManager, Stage, AddDefaults, Checks, GetIncludes, WriteOutputAnnotations, AddDefaults, Checks, Checks
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Phase
  2. DependencyAPI
  3. TransformLike
  4. LazyLogging
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def transform(a: AnnotationSeq): AnnotationSeq

    A mathematical transform on some type

    A mathematical transform on some type

    a

    an input object

    returns

    an output object of the same type

    Definition Classes
    TransformLike

Concrete Value Members

  1. def getLogger: Logger
    Definition Classes
    LazyLogging
  2. 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
    DependencyAPI
  3. 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.

  4. 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
    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.

  5. 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.

  6. def prerequisites: Seq[Dependency[Phase]]

    All transform that must run before this transform

    All transform that must 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.