Packages

c

chisel3.util.experimental

ForceNamesTransform

class ForceNamesTransform extends Transform with DependencyAPIMigration

Forces the name of marked signals to a certain name

  • If there is a conflict in the enclosing module's namespace, throws an exception
  • Renames signals of ground types only. If you rename an intermediate module, it will throw an error
  • Renames instances as well (as well as port names) Common usages:
  • Use to avoid prefixing behavior on specific instances whose enclosing modules are inlined
Annotations
@deprecated
Deprecated

(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.

Source
ForceNames.scala
Linear Supertypes
DependencyAPIMigration, Transform, DependencyAPI[Transform], TransformLike[CircuitState], LazyLogging, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ForceNamesTransform
  2. DependencyAPIMigration
  3. Transform
  4. DependencyAPI
  5. TransformLike
  6. LazyLogging
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ForceNamesTransform()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ForceNamesTransform toany2stringadd[ForceNamesTransform] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ForceNamesTransform, B)
    Implicit
    This member is added by an implicit conversion from ForceNamesTransform toArrowAssoc[ForceNamesTransform] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (ForceNamesTransform) => Boolean, msg: => Any): ForceNamesTransform
    Implicit
    This member is added by an implicit conversion from ForceNamesTransform toEnsuring[ForceNamesTransform] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ForceNamesTransform) => Boolean): ForceNamesTransform
    Implicit
    This member is added by an implicit conversion from ForceNamesTransform toEnsuring[ForceNamesTransform] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ForceNamesTransform
    Implicit
    This member is added by an implicit conversion from ForceNamesTransform toEnsuring[ForceNamesTransform] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ForceNamesTransform
    Implicit
    This member is added by an implicit conversion from ForceNamesTransform toEnsuring[ForceNamesTransform] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def execute(state: CircuitState): CircuitState
    Definition Classes
    ForceNamesTransform → Transform
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getLogger: Logger
    Definition Classes
    LazyLogging
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def invalidates(a: Transform): Boolean
    Definition Classes
    ForceNamesTransform → DependencyAPIMigration → Transform → DependencyAPI
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
  22. def name: String
    Definition Classes
    Transform → TransformLike
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def optionalPrerequisiteOf: Seq[TransformDependency]
    Definition Classes
    ForceNamesTransform → DependencyAPIMigration → Transform → DependencyAPI
  27. def optionalPrerequisites: Seq[TransformDependency]
    Definition Classes
    ForceNamesTransform → DependencyAPIMigration → Transform → DependencyAPI
  28. def prerequisites: Seq[TransformDependency]
    Definition Classes
    ForceNamesTransform → DependencyAPIMigration → Transform → DependencyAPI
  29. final def runTransform(state: CircuitState): CircuitState
    Definition Classes
    Transform
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def transform(state: CircuitState): CircuitState
    Definition Classes
    Transform → TransformLike
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def dependents: Seq[Dependency[Transform]]
    Definition Classes
    DependencyAPI
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ForceNamesTransform toStringFormat[ForceNamesTransform] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

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

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

  5. def →[B](y: B): (ForceNamesTransform, B)
    Implicit
    This member is added by an implicit conversion from ForceNamesTransform toArrowAssoc[ForceNamesTransform] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from DependencyAPIMigration

Inherited from Transform

Inherited from DependencyAPI[Transform]

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromForceNamesTransform to any2stringadd[ForceNamesTransform]

Inherited by implicit conversion StringFormat fromForceNamesTransform to StringFormat[ForceNamesTransform]

Inherited by implicit conversion Ensuring fromForceNamesTransform to Ensuring[ForceNamesTransform]

Inherited by implicit conversion ArrowAssoc fromForceNamesTransform to ArrowAssoc[ForceNamesTransform]

Ungrouped