class ChiselStage extends Stage
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md. Please switch to circt.stage.ChiselStage.
- Source
- ChiselStage.scala
- Alphabetic
- By Inheritance
- ChiselStage
- Stage
- Phase
- DependencyAPI
- TransformLike
- LazyLogging
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ChiselStage()
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 ChiselStage toany2stringadd[ChiselStage] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ChiselStage, B)
- Implicit
- This member is added by an implicit conversion from ChiselStage toArrowAssoc[ChiselStage] 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() @HotSpotIntrinsicCandidate()
- final def emitChirrtl(gen: => RawModule, args: Array[String] = Array.empty, annotations: AnnotationSeq = Seq.empty): String
Convert a Chisel module to a CHIRRTL string
Convert a Chisel module to a CHIRRTL string
- gen
a call-by-name Chisel module
- args
additional command line arguments to pass to Chisel
- annotations
additional annotations to pass to Chisel
- returns
a string containing the Verilog output
- final def emitFirrtl(gen: => RawModule, args: Array[String] = Array.empty, annotations: AnnotationSeq = Seq.empty): String
Convert a Chisel module to a FIRRTL string
Convert a Chisel module to a FIRRTL string
- gen
a call-by-name Chisel module
- args
additional command line arguments to pass to Chisel
- annotations
additional annotations to pass to Chisel
- returns
a string containing the FIRRTL output
- final def emitSystemVerilog(gen: => RawModule, args: Array[String] = Array.empty, annotations: AnnotationSeq = Seq.empty): String
Convert a Chisel module to SystemVerilog
Convert a Chisel module to SystemVerilog
- gen
a call-by-name Chisel module
- args
additional command line arguments to pass to Chisel
- annotations
additional annotations to pass to Chisel
- returns
a string containing the SystemVerilog output
- final def emitVerilog(gen: => RawModule, args: Array[String] = Array.empty, annotations: AnnotationSeq = Seq.empty): String
Convert a Chisel module to Verilog
Convert a Chisel module to Verilog
- gen
a call-by-name Chisel module
- args
additional command line arguments to pass to Chisel
- annotations
additional annotations to pass to Chisel
- returns
a string containing the Verilog output
- def ensuring(cond: (ChiselStage) => Boolean, msg: => Any): ChiselStage
- Implicit
- This member is added by an implicit conversion from ChiselStage toEnsuring[ChiselStage] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ChiselStage) => Boolean): ChiselStage
- Implicit
- This member is added by an implicit conversion from ChiselStage toEnsuring[ChiselStage] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ChiselStage
- Implicit
- This member is added by an implicit conversion from ChiselStage toEnsuring[ChiselStage] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ChiselStage
- Implicit
- This member is added by an implicit conversion from ChiselStage toEnsuring[ChiselStage] 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
- final def execute(args: Array[String], annotations: AnnotationSeq): AnnotationSeq
- Definition Classes
- Stage
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getLogger: Logger
- Definition Classes
- LazyLogging
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def invalidates(a: Phase): Boolean
- Definition Classes
- ChiselStage → DependencyAPI
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val logger: Logger
- Attributes
- protected
- Definition Classes
- LazyLogging
- lazy val name: String
- Definition Classes
- Phase → TransformLike
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def optionalPrerequisiteOf: Seq[Dependency[FirrtlStage]]
- Definition Classes
- ChiselStage → DependencyAPI
- def optionalPrerequisites: Seq[Nothing]
- Definition Classes
- ChiselStage → DependencyAPI
- final lazy val phaseManager: ChiselPhase
- def prerequisites: Seq[Nothing]
- Definition Classes
- ChiselStage → DependencyAPI
- def run(annotations: AnnotationSeq): AnnotationSeq
- Definition Classes
- ChiselStage → Stage
- val shell: Shell
- Definition Classes
- ChiselStage → Stage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val targets: Seq[PhaseDependency]
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def transform(annotations: AnnotationSeq): AnnotationSeq
- Definition Classes
- Stage → TransformLike
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def dependents: Seq[Dependency[Phase]]
- Definition Classes
- DependencyAPI
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ChiselStage toStringFormat[ChiselStage] 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,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ChiselStage, B)
- Implicit
- This member is added by an implicit conversion from ChiselStage toArrowAssoc[ChiselStage] 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
,FixedPoint
,Clock
, andReg
, the abstract typesBits
,Aggregate
, andData
, and the aggregate typesBundle
andVec
.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
util
package.The
testers
package defines the basic interface for chisel testers.