o

firrtl2.passes

CheckHighForm

object CheckHighForm extends Pass with CheckHighFormLike

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CheckHighForm
  2. CheckHighFormLike
  3. Pass
  4. Transform
  5. DependencyAPI
  6. TransformLike
  7. LazyLogging
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class IllegalChirrtlMemException extends PassException
  2. type NameSet = HashSet[String]
    Definition Classes
    CheckHighFormLike
  3. class BadPrintfException extends PassException
    Definition Classes
    CheckHighFormLike
  4. class BadPrintfIncorrectNumException extends PassException
    Definition Classes
    CheckHighFormLike
  5. class BadPrintfTrailingException extends PassException
    Definition Classes
    CheckHighFormLike
  6. class DefnameConflictException extends PassException
    Definition Classes
    CheckHighFormLike
  7. class DefnameDifferentPortsException extends PassException
    Definition Classes
    CheckHighFormLike
  8. class IllegalMemLatencyException extends PassException
    Definition Classes
    CheckHighFormLike
  9. class IncorrectNumArgsException extends PassException
    Definition Classes
    CheckHighFormLike
  10. class IncorrectNumConstsException extends PassException
    Definition Classes
    CheckHighFormLike
  11. class InstanceLoop extends PassException
    Definition Classes
    CheckHighFormLike
  12. class InvalidAccessException extends PassException
    Definition Classes
    CheckHighFormLike
  13. class InvalidLOCException extends PassException
    Definition Classes
    CheckHighFormLike
  14. class LsbLargerThanMsbException extends PassException
    Definition Classes
    CheckHighFormLike
  15. class MemWithFlipException extends PassException
    Definition Classes
    CheckHighFormLike
  16. class ModuleNameNotUniqueException extends PassException
    Definition Classes
    CheckHighFormLike
  17. class ModuleNotDefinedException extends PassException
    Definition Classes
    CheckHighFormLike
  18. class NegArgException extends PassException
    Definition Classes
    CheckHighFormLike
  19. class NegMemSizeException extends PassException
    Definition Classes
    CheckHighFormLike
  20. class NegUIntException extends PassException
    Definition Classes
    CheckHighFormLike
  21. class NegVecSizeException extends PassException
    Definition Classes
    CheckHighFormLike
  22. class NegWidthException extends PassException
    Definition Classes
    CheckHighFormLike
  23. class NoTopModuleException extends PassException
    Definition Classes
    CheckHighFormLike
  24. class NotUniqueException extends PassException
    Definition Classes
    CheckHighFormLike
  25. class PoisonWithFlipException extends PassException
    Definition Classes
    CheckHighFormLike
  26. class RegWithFlipException extends PassException
    Definition Classes
    CheckHighFormLike
  27. class ResetExtModuleOutputException extends PassException
    Definition Classes
    CheckHighFormLike
  28. class ResetInputException extends PassException
    Definition Classes
    CheckHighFormLike
  29. class UndeclaredReferenceException extends PassException
    Definition Classes
    CheckHighFormLike

Value Members

  1. def errorOnChirrtl(info: Info, mname: String, s: Statement): Option[PassException]
    Definition Classes
    CheckHighFormCheckHighFormLike
  2. 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
    PassTransform
  3. def getLogger: Logger
    Definition Classes
    LazyLogging
  4. def invalidates(a: Transform): 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
    CheckHighFormDependencyAPI
  5. def name: String

    A convenience function useful for debugging and error messages

    A convenience function useful for debugging and error messages

    Definition Classes
    TransformTransformLike
  6. def optionalPrerequisiteOf: Seq[Dependency[Transform]]

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

  7. def optionalPrerequisites: Seq[Dependency[Transform]]

    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.

  8. def prerequisites: Seq[TransformDependency]

    All transform that must run before this transform

    All transform that must run before this transform

    Definition Classes
    CheckHighFormDependencyAPI
    Note

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

  9. def run(c: Circuit): Circuit
    Definition Classes
    CheckHighFormLike
  10. 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
  11. 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
    TransformTransformLike

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

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