class CheckCombLoops extends Transform with RegisteredTransform

Finds and detects combinational logic loops in a circuit, if any exist. Returns the input circuit with no modifications.

Source
CheckCombLoops.scala
Exceptions thrown

firrtl.transforms.CheckCombLoops.CombLoopException if a loop is found

Note

Input form: Low FIRRTL

,

Output form: Low FIRRTL (identity transform)

,

The pass looks for loops through combinational-read memories

,

The pass relies on ExtModulePathAnnotations to find loops through ExtModules

,

The pass will throw exceptions on "false paths"

Linear Supertypes
RegisteredTransform, HasShellOptions, Transform, TransformLike[CircuitState], LazyLogging, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CheckCombLoops
  2. RegisteredTransform
  3. HasShellOptions
  4. Transform
  5. TransformLike
  6. LazyLogging
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CheckCombLoops()

    Exceptions thrown

    firrtl.transforms.CheckCombLoops.CombLoopException if a loop is found

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 addOptions(p: OptionParser[AnnotationSeq]): Unit

    Add all shell (command line) options to an option parser

    Add all shell (command line) options to an option parser

    p

    an option parser

    Definition Classes
    HasShellOptions
  5. def analyze(state: CircuitState): Map[String, DiGraph[String]]

    Returns a Map from Module name to port connectivity

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. 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
    CheckCombLoops → Transform
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def inputForm: LowForm.type

    The firrtl.CircuitForm that this transform requires to operate on

    The firrtl.CircuitForm that this transform requires to operate on

    Definition Classes
    CheckCombLoops → Transform
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val logger: Logger
    Definition Classes
    LazyLogging
  17. 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
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. val options: Seq[ShellOption[Unit]]

    A sequence of options provided

    A sequence of options provided

    Definition Classes
    CheckCombLoops → HasShellOptions
  22. def outputForm: LowForm.type

    The firrtl.CircuitForm that this transform outputs

    The firrtl.CircuitForm that this transform outputs

    Definition Classes
    CheckCombLoops → Transform
  23. 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
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. 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
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. 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

    Definition Classes
    Transform
    Annotations
    @deprecated
    Deprecated

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

Inherited from RegisteredTransform

Inherited from HasShellOptions

Inherited from Transform

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped