Packages

c

chisel3.aop.injecting

InjectorAspect

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)

Source
InjectingAspect.scala
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InjectorAspect
  2. Aspect
  3. NoTargetAnnotation
  4. Unserializable
  5. Annotation
  6. Product
  7. Equals
  8. AnyRef
  9. 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 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

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def productArity: Int
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any
    Definition Classes
    Product

Concrete 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 InjectorAspect[T, M] toany2stringadd[InjectorAspect[T, M]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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()
  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: (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
  9. 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
  10. 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
  11. 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
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def productElementName(n: Int): String
    Definition Classes
    Product
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. def productIterator: Iterator[Any]
    Definition Classes
    Product
  24. def productPrefix: String
    Definition Classes
    Product
  25. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. 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

  28. 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
    InjectorAspectAspect
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. 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
    NoTargetAnnotationAnnotation
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

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

Inherited from Aspect[T]

Inherited from NoTargetAnnotation

Inherited from Unserializable

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromInjectorAspect[T, M] to any2stringadd[InjectorAspect[T, M]]

Inherited by implicit conversion StringFormat fromInjectorAspect[T, M] to StringFormat[InjectorAspect[T, M]]

Inherited by implicit conversion Ensuring fromInjectorAspect[T, M] to Ensuring[InjectorAspect[T, M]]

Inherited by implicit conversion ArrowAssoc fromInjectorAspect[T, M] to ArrowAssoc[InjectorAspect[T, M]]

Ungrouped