case class GenericTarget(moduleOpt: Option[String], tokens: Vector[TargetToken]) extends Target with Product with Serializable
Represents incomplete or non-standard Targets
- moduleOpt
Optional module name
- tokens
TargetTokens to represent the target in a module
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- Source
- Target.scala
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- GenericTarget
- Serializable
- Product
- Equals
- Target
- Named
- AnyRef
- Any
Implicitly
- by convertNamed2Target
- by convertTarget2Named
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new GenericTarget(moduleOpt: Option[String], tokens: Vector[TargetToken])
- moduleOpt
Optional module name
- tokens
TargetTokens to represent the target in a module
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 GenericTarget toany2stringadd[GenericTarget] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (GenericTarget, B)
- Implicit
- This member is added by an implicit conversion from GenericTarget toArrowAssoc[GenericTarget] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def add(token: TargetToken): GenericTarget
Appends a target token to tokens, asserts legality
- 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 GenericTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Definition Classes
- CompleteTarget
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- lazy val astModule: Option[String]
- 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
- Definition Classes
- Target
- def encapsulatedBy(other: IsModule): Boolean
Checks whether this is inside of other
Checks whether this is inside of other
- Definition Classes
- Target
- def ensuring(cond: (GenericTarget) => Boolean, msg: => Any): GenericTarget
- Implicit
- This member is added by an implicit conversion from GenericTarget toEnsuring[GenericTarget] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (GenericTarget) => Boolean): GenericTarget
- Implicit
- This member is added by an implicit conversion from GenericTarget toEnsuring[GenericTarget] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): GenericTarget
- Implicit
- This member is added by an implicit conversion from GenericTarget toEnsuring[GenericTarget] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): GenericTarget
- Implicit
- This member is added by an implicit conversion from GenericTarget toEnsuring[GenericTarget] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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 getComplete: Option[CompleteTarget]
- returns
If legal, convert this Target into a CompleteTarget
- Definition Classes
- GenericTarget → Target
- def getInstanceOf: Option[(String, String)]
If complete and an instance target, return the instance and ofmodule
- def getPath: Option[Seq[(Instance, OfModule)]]
If complete, return this GenericTarget's path
- def getRef: Option[(String, Seq[TargetToken])]
If complete and a reference, return the reference and subcomponents
- def isComplete: Boolean
Checks whether the component is legal and complete, meaning the moduleOpt is nonEmpty and all Instance(_) are followed by OfModule(_)
- def isComponentTarget: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLegal: Boolean
Checks whether the component is legal (incomplete is ok)
- def isLocal: Boolean
Whether the target is directly instantiated in its root module
Whether the target is directly instantiated in its root module
- Definition Classes
- GenericTarget → Target
- def isModuleTarget: Boolean
- def modify(moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget
- returns
Returns a new GenericTarget with new values
- Definition Classes
- Target
- val moduleOpt: Option[String]
- returns
Module name, if it exists
- Definition Classes
- GenericTarget → Target
- 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 optAdd(token: TargetToken): Option[Target]
Optionally tries to append token to tokens, fails return is not a legal Target
- lazy val parentModule: Option[String]
- def path: Vector[(Instance, OfModule)]
- returns
Returns the instance hierarchy path, if one exists
- Definition Classes
- GenericTarget → Target
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def remove(n: Int): GenericTarget
Removes n number of target tokens from the right side of tokens
- def serialize: String
- returns
Human-readable serialization
- Definition Classes
- Target
- def sharedRoot(other: Target): Boolean
Share root module
Share root module
- Definition Classes
- Target
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toGenericTarget: GenericTarget
- returns
Converts this Target into a GenericTarget
- Definition Classes
- GenericTarget → Target
- def toNamed: Named
- returns
Converts this Target into either a ModuleName, or ComponentName
- Definition Classes
- GenericTarget → Target
- def toString(): String
- Implicit
- This member is added by an implicit conversion from GenericTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Definition Classes
- CompleteTarget → AnyRef → Any
- def toTarget: CompleteTarget
- Definition Classes
- GenericTarget → Named
- val tokens: Vector[TargetToken]
- returns
Target tokens
- Definition Classes
- GenericTarget → Target
- def tryToComplete: Target
- returns
Converts this Target into a CompleteTarget, or if it can't, return original Target
- Definition Classes
- 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 GenericTarget 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:(genericTarget: CompleteTarget).complete
- Definition Classes
- Target
- 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 GenericTarget 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:(genericTarget: CompleteTarget).encapsulatedBy(other)
- Definition Classes
- Target
- def getComplete: Option[CompleteTarget]
- returns
If legal, convert this Target into a CompleteTarget
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: 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 GenericTarget 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:(genericTarget: CompleteTarget).isLocal
- Definition Classes
- Target
- 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 GenericTarget 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:(genericTarget: CompleteTarget).modify(moduleOpt, tokens)
- Definition Classes
- Target
- def moduleOpt: Option[String]
- returns
Module name, if it exists
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: CompleteTarget).moduleOpt
- Definition Classes
- Target
- def path: Seq[(Instance, OfModule)]
- returns
Returns the instance hierarchy path, if one exists
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: CompleteTarget).path
- Definition Classes
- Target
- def serialize: String
- returns
Human-readable serialization
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: CompleteTarget).serialize
- Definition Classes
- Target
- def sharedRoot(other: Target): Boolean
Share root module
Share root module
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: CompleteTarget).sharedRoot(other)
- Definition Classes
- Target
- def toGenericTarget: GenericTarget
- returns
Converts this Target into a GenericTarget
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: CompleteTarget).toGenericTarget
- Definition Classes
- Target
- def toNamed: Named
- returns
Converts this Target into either a ModuleName, or ComponentName
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: CompleteTarget).toNamed
- Definition Classes
- Target
- def toTarget: CompleteTarget
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: CompleteTarget).toTarget
- Definition Classes
- CompleteTarget → Named
- def toTarget: CompleteTarget
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: Named).toTarget
- Definition Classes
- Named
- def tokens: Seq[TargetToken]
- returns
Target tokens
- Implicit
- This member is added by an implicit conversion from GenericTarget 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:(genericTarget: CompleteTarget).tokens
- Definition Classes
- Target
- 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 GenericTarget 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:(genericTarget: CompleteTarget).tryToComplete
- Definition Classes
- Target
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from GenericTarget toStringFormat[GenericTarget] 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): (GenericTarget, B)
- Implicit
- This member is added by an implicit conversion from GenericTarget toArrowAssoc[GenericTarget] 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.