case class ForceNameAnnotation(target: IsMember, name: String) extends SingleTargetAnnotation[IsMember] with Product with Serializable
Links the user-specified name to force to, with the signal/instance in the FIRRTL design
- target
signal/instance to force the name
- name
name to force it to be
- 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
- Exceptions thrown
firrtl.CustomTransformException
when the signal is renamed to >1 target
- Alphabetic
- By Inheritance
- ForceNameAnnotation
- Serializable
- SingleTargetAnnotation
- Annotation
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ForceNameAnnotation(target: IsMember, name: String)
- target
signal/instance to force the name
- name
name to force it to be
- Exceptions thrown
firrtl.CustomTransformException
when the signal is renamed to >1 target
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ForceNameAnnotation toany2stringadd[ForceNameAnnotation] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ForceNameAnnotation, B)
- Implicit
- This member is added by an implicit conversion from ForceNameAnnotation toArrowAssoc[ForceNameAnnotation] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def duplicate(n: IsMember): ForceNameAnnotation
- Definition Classes
- ForceNameAnnotation → SingleTargetAnnotation
- def ensuring(cond: (ForceNameAnnotation) => Boolean, msg: => Any): ForceNameAnnotation
- Implicit
- This member is added by an implicit conversion from ForceNameAnnotation toEnsuring[ForceNameAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ForceNameAnnotation) => Boolean): ForceNameAnnotation
- Implicit
- This member is added by an implicit conversion from ForceNameAnnotation toEnsuring[ForceNameAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ForceNameAnnotation
- Implicit
- This member is added by an implicit conversion from ForceNameAnnotation toEnsuring[ForceNameAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ForceNameAnnotation
- Implicit
- This member is added by an implicit conversion from ForceNameAnnotation toEnsuring[ForceNameAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getTargets: Seq[Target]
- Definition Classes
- SingleTargetAnnotation → Annotation
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serialize: String
- Definition Classes
- Annotation
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val target: IsMember
- Definition Classes
- ForceNameAnnotation → SingleTargetAnnotation
- def update(renames: RenameMap): Seq[Annotation]
- Definition Classes
- ForceNameAnnotation → SingleTargetAnnotation → Annotation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ForceNameAnnotation toStringFormat[ForceNameAnnotation] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ForceNameAnnotation, B)
- Implicit
- This member is added by an implicit conversion from ForceNameAnnotation toArrowAssoc[ForceNameAnnotation] 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.
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt
,SInt
,Bool
,FixedPoint
,Clock
, andReg
, the abstract typesBits
,Aggregate
, andData
, and the aggregate typesBundle
andVec
.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
util
package.The
testers
package defines the basic interface for chisel testers.