package stage
- Alphabetic
- By Inheritance
- stage
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- sealed trait CIRCTOption extends Unserializable
An option used to construct a CIRCTOptions
- class CIRCTOptions extends AnyRef
Options associated with CIRCT
- case class CIRCTTargetAnnotation(target: Type) extends NoTargetAnnotation with CIRCTOption with Product with Serializable
Annotation that tells CIRCT what target to compile to
- trait CLI extends BareShell
- class ChiselStage extends Stage
Entry point for running Chisel with the CIRCT compiler.
Entry point for running Chisel with the CIRCT compiler.
- Note
The companion object, ChiselStage$, has a cleaner API for compiling and returning a string.
- case class EmittedMLIR(filename: String, value: String, suffix: Option[String]) extends NoTargetAnnotation with CustomFileEmission with Product with Serializable
Annotation holding an emitted MLIR string
Annotation holding an emitted MLIR string
- filename
the name of the file where this should be written
- value
a string of MLIR
- suffix
an optional suffix added to the filename when this is written to disk
- case class FirtoolBinaryPath(option: String) extends NoTargetAnnotation with CIRCTOption with Product with Serializable
Annotation that tells CIRCT what firtool executable to use
- case class FirtoolOption(option: String) extends NoTargetAnnotation with CIRCTOption with Product with Serializable
Annotation that passes a command line option to
firtool
.Annotation that passes a command line option to
firtool
.- option
an option to pass to
firtool
- case class PreserveAggregate(mode: Type) extends NoTargetAnnotation with CIRCTOption with Product with Serializable
Preserve passive aggregate types in CIRCT.
Value Members
- implicit object CIRCTOptionsView extends OptionsView[CIRCTOptions]
- object CIRCTTarget
Object storing types associated with different CIRCT target languages, e.g., RTL or SystemVerilog
- object CIRCTTargetAnnotation extends HasShellOptions with Serializable
- object ChiselMain extends StageMain
Command line entry point to ChiselStage
- object ChiselStage
Utilities for compiling Chisel
- object FirtoolOption extends HasShellOptions with Serializable
- object PreserveAggregate extends HasShellOptions with Serializable
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 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.