class InferWidths extends Transform with ResolvedAnnotationPaths with DependencyAPIMigration

Infers the widths of all signals with unknown widths

Is a global width inference algorithm - Instances of the same module with unknown input port widths will be assigned the largest width of all assignments to each of its instance ports - If you don't want the global inference behavior, then be sure to define all your input widths

Infers the smallest width is larger than all assigned widths to a signal - Note that this means that dummy assignments that are overwritten by last-connect-semantics can still influence width inference - E.g. wire x: UInt x <= UInt<5>(15) x <= UInt<1>(1)

Since width inference occurs before lowering, it infers x's width to be 5 but with an assignment of UInt(1):

wire x: UInt<5> x <= UInt<1>(1)

Uses firrtl.constraint package to infer widths

Source
InferWidths.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InferWidths
  2. DependencyAPIMigration
  3. ResolvedAnnotationPaths
  4. Transform
  5. DependencyAPI
  6. TransformLike
  7. LazyLogging
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new InferWidths()

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. val annotationClasses: Seq[Class[WidthGeqConstraintAnnotation]]
    Definition Classes
    InferWidthsResolvedAnnotationPaths
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. 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
    InferWidthsTransform
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getLogger: Logger
    Definition Classes
    LazyLogging
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. 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
    InferWidthsDependencyAPIMigrationResolvedAnnotationPathsTransformDependencyAPI
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val logger: Logger
    Attributes
    protected
    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
    TransformTransformLike
  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. def optionalPrerequisiteOf: Seq[TransformDependency]
    Definition Classes
    DependencyAPIMigration
  22. def optionalPrerequisites: Seq[TransformDependency]
    Definition Classes
    DependencyAPIMigration
  23. def prepare(state: CircuitState): CircuitState
    Definition Classes
    ResolvedAnnotationPaths
  24. def prerequisites: Seq[TransformDependency]

    All transform that must run before this transform

    All transform that must run before this transform

    Definition Classes
    InferWidthsDependencyAPIMigrationTransformDependencyAPI
    Note

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

  25. def run(c: Circuit)(implicit constraintSolver: ConstraintSolver): Circuit
  26. 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
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. 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
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

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

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

Inherited from ResolvedAnnotationPaths

Inherited from Transform

Inherited from DependencyAPI[Transform]

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped