case class ChiselGeneratorAnnotation(gen: () => RawModule) extends NoTargetAnnotation with Unserializable with Product with Serializable
An firrtl.annotations.Annotation storing a function that returns a Chisel module
- gen
a generator function
- Source
- ChiselAnnotations.scala
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- ChiselGeneratorAnnotation
- Serializable
- Unserializable
- NoTargetAnnotation
- Annotation
- Product
- Equals
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
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 ChiselGeneratorAnnotation toany2stringadd[ChiselGeneratorAnnotation] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ChiselGeneratorAnnotation, B)
- Implicit
- This member is added by an implicit conversion from ChiselGeneratorAnnotation toArrowAssoc[ChiselGeneratorAnnotation] 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 elaborate: AnnotationSeq
Run elaboration on the Chisel module generator function stored by this firrtl.annotations.Annotation
- def ensuring(cond: (ChiselGeneratorAnnotation) => Boolean, msg: => Any): ChiselGeneratorAnnotation
- Implicit
- This member is added by an implicit conversion from ChiselGeneratorAnnotation toEnsuring[ChiselGeneratorAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ChiselGeneratorAnnotation) => Boolean): ChiselGeneratorAnnotation
- Implicit
- This member is added by an implicit conversion from ChiselGeneratorAnnotation toEnsuring[ChiselGeneratorAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ChiselGeneratorAnnotation
- Implicit
- This member is added by an implicit conversion from ChiselGeneratorAnnotation toEnsuring[ChiselGeneratorAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ChiselGeneratorAnnotation
- Implicit
- This member is added by an implicit conversion from ChiselGeneratorAnnotation toEnsuring[ChiselGeneratorAnnotation] 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])
- val gen: () => RawModule
- final def getClass(): Class[_ <: AnyRef]
- 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 productElementNames: Iterator[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
- 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 ChiselGeneratorAnnotation toStringFormat[ChiselGeneratorAnnotation] 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): (ChiselGeneratorAnnotation, B)
- Implicit
- This member is added by an implicit conversion from ChiselGeneratorAnnotation toArrowAssoc[ChiselGeneratorAnnotation] 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.