chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package aop
  Definition Classes
    chisel3
-  package injecting
  Definition Classes
    aop
- InjectStatement
- InjectingAspect
- InjectingPhase
- InjectorAspect

c

chisel3.aop.injecting

# InjectingAspect

###

#### case class InjectingAspect[T <: RawModule, M <: RawModule](selectRoots: (T) => Iterable[M], injection: (M) => Unit) extends InjectorAspect[T, M] with Product with Serializable

Aspect to inject Chisel code into a module of type M

T

  Type of top-level module

M

  Type of root module (join point)

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)

Source
  InjectingAspect.scala

Linear Supertypes
Serializable, InjectorAspect[T, M], Aspect[T], NoTargetAnnotation, Unserializable, Annotation, Product, Equals, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. InjectingAspect
2. Serializable
3. InjectorAspect
4. Aspect
5. NoTargetAnnotation
6. Unserializable
7. Annotation
8. Product
9. Equals
10. AnyRef
11. 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 InjectingAspect(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)

### 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 InjectingAspect[T, M] toany2stringadd[InjectingAspect[T, M]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (InjectingAspect[T, M], B)
   Implicit
     This member is added by an implicit conversion from InjectingAspect[T, M] toArrowAssoc[InjectingAspect[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: (InjectingAspect[T, M]) => Boolean, msg: => Any): InjectingAspect[T, M]
   Implicit
     This member is added by an implicit conversion from InjectingAspect[T, M] toEnsuring[InjectingAspect[T, M]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (InjectingAspect[T, M]) => Boolean): InjectingAspect[T, M]
   Implicit
     This member is added by an implicit conversion from InjectingAspect[T, M] toEnsuring[InjectingAspect[T, M]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): InjectingAspect[T, M]
    Implicit
      This member is added by an implicit conversion from InjectingAspect[T, M] toEnsuring[InjectingAspect[T, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): InjectingAspect[T, M]
    Implicit
      This member is added by an implicit conversion from InjectingAspect[T, M] toEnsuring[InjectingAspect[T, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
14.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
15.  val injection: (M) => Unit
16.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
17.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
18.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
19.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  def productElementNames: Iterator[String]
    Definition Classes
      Product
21.  val selectRoots: (T) => Iterable[M]
22.  def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
      Annotation
    Note

      rarely used

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

    Definition Classes
      InjectorAspect
25.  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
26.  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
27.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
28.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
29.  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 InjectingAspect[T, M] toStringFormat[InjectingAspect[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): (InjectingAspect[T, M], B)
   Implicit
     This member is added by an implicit conversion from InjectingAspect[T, M] toArrowAssoc[InjectingAspect[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 Serializable

### Inherited from InjectorAspect[T, M]

### 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 fromInjectingAspect[T, M] to any2stringadd[InjectingAspect[T, M]]

### Inherited by implicit conversion StringFormat fromInjectingAspect[T, M] to StringFormat[InjectingAspect[T, M]]

### Inherited by implicit conversion Ensuring fromInjectingAspect[T, M] to Ensuring[InjectingAspect[T, M]]

### Inherited by implicit conversion ArrowAssoc fromInjectingAspect[T, M] to ArrowAssoc[InjectingAspect[T, M]]

### Ungrouped