abstract class InjectorAspect[T <: RawModule, M <: RawModule] extends Aspect[T]
Extend to inject Chisel code into a module of type M
- T
Type of top-level module
- M
Type of root module (join point)
- Annotations
- @deprecated
- Deprecated
(Since version 6.6.0) injecting aspects are being removed in Chisel 7
- Source
- InjectingAspect.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- InjectorAspect
- Aspect
- NoTargetAnnotation
- Unserializable
- Annotation
- Product
- Equals
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new InjectorAspect(selectRoots: (T) => Iterable[M], injection: (M) => Unit)
- selectRoots
Given top-level module, pick the instances of a module to apply the aspect (root module)
- injection
Function to generate Chisel hardware that will be injected to the end of module m Signals in m can be referenced and assigned to as if inside m (yes, it is a bit magical)
Abstract Value Members
Concrete 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 InjectorAspect[T, M] toany2stringadd[InjectorAspect[T, M]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (InjectorAspect[T, M], B)
- Implicit
- This member is added by an implicit conversion from InjectorAspect[T, M] toArrowAssoc[InjectorAspect[T, M]] 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()
- def ensuring(cond: (InjectorAspect[T, M]) => Boolean, msg: => Any): InjectorAspect[T, M]
- Implicit
- This member is added by an implicit conversion from InjectorAspect[T, M] toEnsuring[InjectorAspect[T, M]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (InjectorAspect[T, M]) => Boolean): InjectorAspect[T, M]
- Implicit
- This member is added by an implicit conversion from InjectorAspect[T, M] toEnsuring[InjectorAspect[T, M]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): InjectorAspect[T, M]
- Implicit
- This member is added by an implicit conversion from InjectorAspect[T, M] toEnsuring[InjectorAspect[T, M]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): InjectorAspect[T, M]
- Implicit
- This member is added by an implicit conversion from InjectorAspect[T, M] toEnsuring[InjectorAspect[T, M]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- 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
- 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 productElementName(n: Int): String
- Definition Classes
- Product
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def productPrefix: String
- Definition Classes
- Product
- def serialize: String
Optional pretty print
Optional pretty print
- Definition Classes
- Annotation
- Note
rarely used
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toAnnotation(modules: Iterable[M], circuit: String, moduleNames: Seq[String]): AnnotationSeq
Returns annotations which contain all injection logic
Returns annotations which contain all injection logic
- modules
The modules to inject into
- circuit
Top level circuit
- moduleNames
The names of all existing modules in the original circuit, to avoid name collisions
- final def toAnnotation(top: T): AnnotationSeq
Convert this Aspect to a seq of FIRRTL annotation
Convert this Aspect to a seq of FIRRTL annotation
- Definition Classes
- InjectorAspect → Aspect
- def toString(): String
- Definition Classes
- AnyRef → Any
- def update(renames: RenameMap): Seq[NoTargetAnnotation]
Update the target based on how signals are renamed
Update the target based on how signals are renamed
- Definition Classes
- NoTargetAnnotation → Annotation
- 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()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from InjectorAspect[T, M] toStringFormat[InjectorAspect[T, M]] 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): (InjectorAspect[T, M], B)
- Implicit
- This member is added by an implicit conversion from InjectorAspect[T, M] toArrowAssoc[InjectorAspect[T, M]] 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.