sealed trait Target extends Named
Refers to something in a FIRRTL firrtl.ir.Circuit. Used for Annotation targets.
Can be in various states of completion/resolved:
- Legal: TargetToken's in tokens are in an order that makes sense
- Complete: moduleOpt is non-empty, and all Instance(_) are followed by OfModule(_)
- Local: tokens does not refer to things through an instance hierarchy (no Instance(_) or OfModule(_) tokens)
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- Source
- Target.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- Target
- Named
- AnyRef
- Any
Implicitly
- by convertNamed2Target
- by convertTarget2Named
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Abstract Value Members
- abstract def getComplete: Option[CompleteTarget]
- returns
If legal, convert this Target into a CompleteTarget
- abstract def isLocal: Boolean
Whether the target is directly instantiated in its root module
- abstract def moduleOpt: Option[String]
- returns
Module name, if it exists
- abstract def path: Seq[(Instance, OfModule)]
- returns
Returns the instance hierarchy path, if one exists
- abstract def toTarget: CompleteTarget
- Definition Classes
- Named
- abstract def tokens: Seq[TargetToken]
- returns
Target tokens
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Target, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addHierarchy(root: String, instance: String): IsComponent
Adds another level of instance hierarchy Example: Given root=A and instance=b, transforms (Top, B)/c:C -> (Top, A)/b:B/c:C
Adds another level of instance hierarchy Example: Given root=A and instance=b, transforms (Top, B)/c:C -> (Top, A)/b:B/c:C
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Definition Classes
- CompleteTarget
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def complete: CompleteTarget
- returns
Converts this Target into a CompleteTarget
- def encapsulatedBy(other: IsModule): Boolean
Checks whether this is inside of other
- def ensuring(cond: (Target) => Boolean, msg: => Any): Target
- def ensuring(cond: (Target) => Boolean): Target
- def ensuring(cond: Boolean, msg: => Any): Target
- def ensuring(cond: Boolean): Target
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def modify(moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget
- returns
Returns a new GenericTarget with new values
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def serialize: String
- returns
Human-readable serialization
- def sharedRoot(other: Target): Boolean
Share root module
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toGenericTarget: GenericTarget
- returns
Converts this Target into a GenericTarget
- def toNamed: Named
- returns
Converts this Target into either a ModuleName, or ComponentName
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tryToComplete: Target
- returns
Converts this Target into a CompleteTarget, or if it can't, return original Target
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
Shadowed Implicit Value Members
- def complete: CompleteTarget
- returns
Converts this Target into a CompleteTarget
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).complete
- def encapsulatedBy(other: IsModule): Boolean
Checks whether this is inside of other
Checks whether this is inside of other
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).encapsulatedBy(other)
- def getComplete: Option[CompleteTarget]
- returns
If legal, convert this Target into a CompleteTarget
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).getComplete
- Definition Classes
- CompleteTarget → Target
- def isLocal: Boolean
Whether the target is directly instantiated in its root module
Whether the target is directly instantiated in its root module
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).isLocal
- def modify(moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget
- returns
Returns a new GenericTarget with new values
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).modify(moduleOpt, tokens)
- def moduleOpt: Option[String]
- returns
Module name, if it exists
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).moduleOpt
- def path: Seq[(Instance, OfModule)]
- returns
Returns the instance hierarchy path, if one exists
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).path
- def serialize: String
- returns
Human-readable serialization
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).serialize
- def sharedRoot(other: Target): Boolean
Share root module
Share root module
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).sharedRoot(other)
- def toGenericTarget: GenericTarget
- returns
Converts this Target into a GenericTarget
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).toGenericTarget
- def toNamed: Named
- returns
Converts this Target into either a ModuleName, or ComponentName
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).toNamed
- def toString(): String
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).toString()
- Definition Classes
- CompleteTarget → AnyRef → Any
- def toTarget: CompleteTarget
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).toTarget
- Definition Classes
- CompleteTarget → Named
- def toTarget: CompleteTarget
- Implicit
- This member is added by an implicit conversion from Target toNamed performed by method convertTarget2Named in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: Named).toTarget
- Definition Classes
- Named
- def tokens: Seq[TargetToken]
- returns
Target tokens
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).tokens
- def tryToComplete: Target
- returns
Converts this Target into a CompleteTarget, or if it can't, return original Target
- Implicit
- This member is added by an implicit conversion from Target toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(target: CompleteTarget).tryToComplete
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Target toStringFormat[Target] 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,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Target, B)
- Implicit
- This member is added by an implicit conversion from Target toArrowAssoc[Target] 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,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.