Packages

c

firrtl

Transform

abstract class Transform extends TransformLike[CircuitState]

The basic unit of operating on a Firrtl AST

Source
Compiler.scala
Linear Supertypes
TransformLike[CircuitState], LazyLogging, AnyRef, Any
Known Subclasses
AddDescriptionNodes, ChirrtlEmitter, ChirrtlToHighFirrtl, CoreTransform, Emitter, FirrtlEmitter, HighFirrtlEmitter, HighFirrtlToMiddleFirrtl, IRToWorkingIR, LowFirrtlEmitter, LowFirrtlOptimization, MiddleFirrtlEmitter, MiddleFirrtlToLowFirrtl, MinimumLowFirrtlOptimization, MinimumVerilogEmitter, ResolveAndCheck, SeqTransform, SystemVerilogEmitter, VerilogEmitter, GetNamespace, EliminateTargetPaths, CheckResets, CInferMDir, CInferTypes, CheckChirrtl, CheckFlows, CheckHighForm, CheckInitialization, CheckTypes, CheckWidths, CommonSubexpressionElimination, ConvertFixedToSInt, DeadCodeElimination, ExpandConnects, ExpandWhens, InferTypes, InferWidths, InlineInstances, Legalize, LowerTypes, PadWidths, Pass, PullMuxes, RemoveAccesses, RemoveAccesses, RemoveCHIRRTL, RemoveEmpty, RemoveValidIf, ReplaceAccesses, ResolveFlows, ResolveKinds, SplitExpressions, ToWorkingIR, Uniquify, VerilogModulusCleanup, VerilogPrep, ZeroWidth, ClockList, ClockListTransform, RemoveAllButClocks, CreateMemoryAnnotations, InferReadWrite, InferReadWritePass, RenameAnnotatedMemoryPorts, ReplSeqMem, ReplaceMemMacros, ResolveMaskGranularity, ResolveMemoryReference, SimpleMidTransform, SimpleTransform, ToMemIR, VerilogMemDelays, Wiring, WiringTransform, BlackBoxSourceHelper, CheckCombLoops, CombineCats, ConstantPropagation, DeadCodeElimination, DedupModules, Flatten, FlattenRegUpdate, GroupAndDedup, GroupComponents, IdentityTransform, InferResets, RemoveKeywordCollisions, RemoveReset, RemoveWires, RenameModules, ReplaceTruncatingArithmetic, SimplifyMems, TopWiringTransform, VerilogRename, AnalyzeCircuit, AnalyzeCircuit, ResolveGenders, VerilogRename
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Transform
  2. TransformLike
  3. LazyLogging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Transform()

Abstract Value Members

  1. abstract def execute(state: CircuitState): CircuitState

    Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.

    Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

    Attributes
    protected
  2. abstract def inputForm: CircuitForm

    The firrtl.CircuitForm that this transform requires to operate on

  3. abstract def outputForm: CircuitForm

    The firrtl.CircuitForm that this transform outputs

Concrete 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()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val logger: Logger
    Definition Classes
    LazyLogging
  13. def name: String

    A convenience function useful for debugging and error messages

    A convenience function useful for debugging and error messages

    Definition Classes
    Transform → TransformLike
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def runTransform(state: CircuitState): CircuitState

    Perform the transform and update annotations.

    Perform the transform and update annotations.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. def transform(state: CircuitState): CircuitState

    A mathematical transform on some type

    A mathematical transform on some type

    returns

    an output object of the same type

    Definition Classes
    Transform → TransformLike
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Deprecated Value Members

  1. final def getMyAnnotations(state: CircuitState): Seq[Annotation]

    Convenience method to get annotations relevant to this Transform

    Convenience method to get annotations relevant to this Transform

    state

    The CircuitState form which to extract annotations

    returns

    A collection of annotations

    Annotations
    @deprecated
    Deprecated

    (Since version 1.1) Just collect the actual Annotation types the transform wants

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped