Class

firrtl

Transform

Related Doc: package firrtl

Permalink

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, AnalyzeCircuit, AnalyzeCircuit, BlackBoxSourceHelper, CInferMDir, CInferTypes, CheckChirrtl, CheckCombLoops, CheckFlows, CheckHighForm, CheckInitialization, CheckResets, CheckTypes, CheckWidths, ChirrtlEmitter, ChirrtlToHighFirrtl, ClockList, ClockListTransform, CombineCats, CommonSubexpressionElimination, ConstantPropagation, ConvertFixedToSInt, CoreTransform, CreateMemoryAnnotations, DeadCodeElimination, DeadCodeElimination, DedupModules, EliminateTargetPaths, Emitter, ExpandConnects, ExpandWhens, FirrtlEmitter, FixAddingNegativeLiterals, Flatten, FlattenRegUpdate, GetNamespace, GroupAndDedup, GroupComponents, HighFirrtlEmitter, HighFirrtlToMiddleFirrtl, IRToWorkingIR, IdentityTransform, InferReadWrite, InferReadWritePass, InferResets, InferTypes, InferWidths, InlineBitExtractionsTransform, InlineCastsTransform, InlineInstances, InlineNotsTransform, Legalize, LegalizeAndReductionsTransform, LegalizeClocksTransform, LowFirrtlEmitter, LowFirrtlOptimization, LowerTypes, MiddleFirrtlEmitter, MiddleFirrtlToLowFirrtl, MinimumLowFirrtlOptimization, MinimumVerilogEmitter, PadWidths, Pass, PullMuxes, RemoveAccesses, RemoveAccesses, RemoveAllButClocks, RemoveCHIRRTL, RemoveEmpty, RemoveKeywordCollisions, RemoveReset, RemoveValidIf, RemoveWires, RenameAnnotatedMemoryPorts, RenameModules, ReplSeqMem, ReplaceAccesses, ReplaceMemMacros, ReplaceTruncatingArithmetic, ResolveAndCheck, ResolveFlows, ResolveGenders, ResolveKinds, ResolveMaskGranularity, ResolveMemoryReference, SeqTransform, SimpleMidTransform, SimpleTransform, SimplifyMems, SplitExpressions, SystemVerilogEmitter, ToMemIR, ToWorkingIR, TopWiringTransform, Uniquify, VerilogEmitter, VerilogMemDelays, VerilogModulusCleanup, VerilogPrep, VerilogRename, VerilogRename, Wiring, WiringTransform, ZeroLengthVecs, ZeroWidth
Type Hierarchy
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()

    Permalink

Abstract Value Members

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

    Permalink

    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

    Permalink

    The firrtl.CircuitForm that this transform requires to operate on

  3. abstract def outputForm: CircuitForm

    Permalink

    The firrtl.CircuitForm that this transform outputs

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  9. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. val logger: Logger

    Permalink
    Definition Classes
    LazyLogging

  12. def name: String

    Permalink

    A convenience function useful for debugging and error messages

    A convenience function useful for debugging and error messages

    Definition Classes
    Transform → TransformLike

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  16. final def runTransform(state: CircuitState): CircuitState

    Permalink

    Perform the transform and update annotations.

    Perform the transform and update annotations.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  19. def transform(state: CircuitState): CircuitState

    Permalink

    A mathematical transform on some type

    A mathematical transform on some type

    returns

    an output object of the same type

    Definition Classes
    Transform → TransformLike

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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

    Permalink

    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