o

firrtl.passes

CheckTypes

object CheckTypes extends Pass with PreservesAll[Transform]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CheckTypes
  2. PreservesAll
  3. Pass
  4. DependencyAPIMigration
  5. Transform
  6. DependencyAPI
  7. TransformLike
  8. LazyLogging
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class AccessIndexNotUInt extends PassException
  2. class EnNotUInt extends PassException
  3. class EnableNotUInt extends PassException
  4. class IllegalAnalogDeclaration extends PassException
  5. class IllegalAttachExp extends PassException
  6. class IllegalResetType extends PassException
  7. class IllegalUnknownType extends PassException
  8. class IndexNotUInt extends PassException
  9. class IndexOnNonVector extends PassException
  10. class IndexTooLarge extends PassException
  11. class InvalidConnect extends PassException
  12. class InvalidRegInit extends PassException
  13. class MuxClock extends PassException
  14. class MuxCondUInt extends PassException
  15. class MuxPassiveTypes extends PassException
  16. class MuxSameType extends PassException
  17. class NodePassiveType extends PassException
  18. class OpNoMixFix extends PassException
  19. class OpNotAllSameType extends PassException
  20. class OpNotAllUInt extends PassException
  21. class OpNotAnalog extends PassException
  22. class OpNotCorrectType extends PassException
  23. class OpNotGround extends PassException
  24. class OpNotUInt extends PassException
  25. class PredNotUInt extends PassException
  26. class PrintfArgNotGround extends PassException
  27. class RegReqClk extends PassException
  28. class ReqClk extends PassException
  29. class SubfieldNotInBundle extends PassException
  30. class SubfieldOnNonBundle extends PassException
  31. class ValidIfCondUInt extends PassException
  32. class ValidIfPassiveTypes extends PassException

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

    Definition Classes
    Pass → Transform
  9. def fits(bigger: Constraint, smaller: Constraint): Boolean
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def invalidates(a: Transform): Boolean
    Definition Classes
    PreservesAll
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def legalResetType(tpe: Type): Boolean
  15. val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
  16. 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
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def optionalPrerequisiteOf: Seq[Dependency[Transform with DependencyAPIMigration]]

    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
    CheckTypes → DependencyAPIMigration → Transform → 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.

  21. def optionalPrerequisites: Seq[TransformDependency]
    Definition Classes
    DependencyAPIMigration
  22. def prerequisites: Seq[TransformDependency]

    All transform that must run before this transform

    All transform that must run before this transform

    Definition Classes
    CheckTypes → DependencyAPIMigration → Transform → DependencyAPI
    Note

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

  23. def run(c: Circuit): Circuit
    Definition Classes
    CheckTypes → Pass
  24. 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

    Definition Classes
    Transform
  25. def st: SIntType
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. 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
  29. def ut: UIntType
  30. def validConnect(con: Connect): Boolean
  31. def validConnect(locTpe: Type, expTpe: Type): Boolean
  32. def validPartialConnect(con: PartialConnect): Boolean
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

    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
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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

    Definition Classes
    Transform
    Annotations
    @deprecated
    Deprecated

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

  4. final def inputForm: CircuitForm
    Definition Classes
    DependencyAPIMigration
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre

  5. final def outputForm: CircuitForm
    Definition Classes
    DependencyAPIMigration
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre

Inherited from PreservesAll[Transform]

Inherited from Pass

Inherited from DependencyAPIMigration

Inherited from Transform

Inherited from DependencyAPI[Transform]

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped