package stage
- Alphabetic
- By Inheritance
- stage
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class ChiselCircuitAnnotation(circuit: Circuit) extends NoTargetAnnotation with ChiselOption with Unserializable with Product with Serializable
Stores a Chisel Circuit
Stores a Chisel Circuit
- circuit
a Chisel Circuit
- trait ChiselCli extends AnyRef
- Annotations
- @nowarn()
- 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
An firrtl.annotations.Annotation storing a function that returns a Chisel module
- gen
a generator function
- sealed trait ChiselOption extends AnyRef
Mixin that indicates that this is an firrtl.annotations.Annotation used to generate a ChiselOptions view.
- class ChiselOptions extends AnyRef
- case class ChiselOutputFileAnnotation(file: String) extends NoTargetAnnotation with ChiselOption with Unserializable with Product with Serializable
- case class CircuitSerializationAnnotation(circuit: Circuit, filename: String, format: Format) extends NoTargetAnnotation with BufferedCustomFileEmission with Product with Serializable
Wraps a
Circuit
for serialization viaCustomFileEmission
Wraps a
Circuit
for serialization viaCustomFileEmission
- circuit
a Chisel Circuit
- filename
name of destination file (excludes file extension)
- format
serialization file format (sets file extension)
- case class DesignAnnotation[DUT <: RawModule](design: DUT) extends NoTargetAnnotation with Unserializable with Product with Serializable
Contains the top-level elaborated Chisel design.
Contains the top-level elaborated Chisel design.
By default is created during Chisel elaboration and passed to the FIRRTL compiler.
- DUT
Type of the top-level Chisel design
- design
top-level Chisel design
- case class SourceRootAnnotation(directory: File) extends NoTargetAnnotation with Unserializable with ChiselOption with Product with Serializable
A root directory for source files, used for enhanced error reporting
A root directory for source files, used for enhanced error reporting
More than one may be provided. If a source file is found in more than one source root, the first match will be used in error reporting.
Deprecated Type Members
- 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.
Value Members
- final val pleaseSwitchToCIRCT: String("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.")
- object ChiselGeneratorAnnotation extends HasShellOptions with Serializable
- implicit object ChiselOptionsView extends OptionsView[ChiselOptions]
- Annotations
- @nowarn()
- object ChiselOutputFileAnnotation extends HasShellOptions with Serializable
- object CircuitSerializationAnnotation extends Serializable
- case object PrintFullStackTraceAnnotation extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable
On an exception, this will cause the full stack trace to be printed as opposed to a pruned stack trace.
- object SourceRootAnnotation extends HasShellOptions with Serializable
- case object ThrowOnFirstErrorAnnotation extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable
On recoverable errors, this will cause Chisel to throw an exception instead of continuing.
- case object WarningsAsErrorsAnnotation extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable
When enabled, warnings will be treated as errors.
Deprecated Value Members
- object ChiselMain extends StageMain
- 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.
- object ChiselStage
Helper methods for working with ChiselStage
Helper methods for working with ChiselStage
- 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.
- case object NoRunFirrtlCompilerAnnotation extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable
Disable the execution of the FIRRTL compiler by Chisel
Disable the execution of the FIRRTL compiler by Chisel
- 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. Use "--target chirrtl" with circt.stage.ChiselStage.
- case object WarnReflectiveNamingAnnotation extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable
Warn when reflective naming changes names of signals
Warn when reflective naming changes names of signals
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Support for reflective naming has been removed, this object no longer does anything
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.