package stage
The stage package provides an implementation of the FIRRTL compiler using the firrtl.options package. This primarily consists of:
- FirrtlStage, the internal and external (command line) interface to the FIRRTL compiler
- A number of Phases that support and compartmentalize the individual operations of FirrtlStage
- FirrtlOptions, a class representing options that are necessary to drive the FirrtlStage and its Phases
- FirrtlOptionsView, a utility that constructs an OptionsView of FirrtlOptions from an AnnotationSeq
- FirrtlCli, the command line options that the FirrtlStage supports
- FirrtlStageUtils containing miscellaneous utilities for stage
- Source
- package.scala
- Alphabetic
- By Inheritance
- stage
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
sealed
trait
CircuitOption extends Unserializable
Indicates that this Annotation contains information that is directly convertable to a FIRRTL Circuit.
-
case class
CompilerAnnotation(compiler: Compiler = new VerilogCompiler()) extends NoTargetAnnotation with FirrtlOption with Product with Serializable
helpValueName a Compiler that should be run
helpValueName a Compiler that should be run
- set stringly with
-X/--compiler - If unset, a CompilerAnnotation with the default VerilogCompiler
- compiler
compiler name
- set stringly with
-
case class
FirrtlCircuitAnnotation(circuit: Circuit) extends NoTargetAnnotation with FirrtlOption with Product with Serializable
Holds a FIRRTL Circuit
Holds a FIRRTL Circuit
- circuit
a circuit
-
trait
FirrtlCli extends AnyRef
Shell mixin that provides command line options for FIRRTL.
Shell mixin that provides command line options for FIRRTL. This does not include any RegisteredLibrary or RegisteredTransform as those are automatically loaded by the Stage using this Shell.
-
case class
FirrtlFileAnnotation(file: String) extends NoTargetAnnotation with CircuitOption with Product with Serializable
An explicit input FIRRTL file to read
An explicit input FIRRTL file to read
- set with
-i/--input-file - If unset, an FirrtlFileAnnotation with the default input file will not be generated
- file
input filename
- set with
-
sealed
trait
FirrtlOption extends Unserializable
Indicates that this is an Annotation directly used in the construction of a FirrtlOptions view.
-
class
FirrtlOptions extends AnyRef
Internal options used to control the FIRRTL compiler stage.
- class FirrtlPhase extends PhaseManager with PreservesAll[Phase]
-
case class
FirrtlSourceAnnotation(source: String) extends NoTargetAnnotation with CircuitOption with Product with Serializable
Holds a String containing FIRRTL source to read as input
Holds a String containing FIRRTL source to read as input
- set with
--firrtl-source
- set with
- class FirrtlStage extends Stage
-
case class
InfoModeAnnotation(modeName: String = "use") extends NoTargetAnnotation with FirrtlOption with Product with Serializable
Sets the info mode style
Sets the info mode style
- set with
--info-mode
- Note
This cannote be directly converted to Parser.InfoMode as that depends on an optional FirrtlFileAnnotation
- set with
-
case class
OutputFileAnnotation(file: String) extends NoTargetAnnotation with FirrtlOption with Product with Serializable
An explicit output file the emitter will write to
An explicit output file the emitter will write to
- set with
-o/--output-file
- file
output filename
- set with
-
case class
RunFirrtlTransformAnnotation(transform: Transform) extends NoTargetAnnotation with Product with Serializable
Holds the unambiguous class name of a Transform to run
Holds the unambiguous class name of a Transform to run
- will be append to FirrtlExecutionOptions.customTransforms
- set with
-fct/--custom-transforms
- transform
the full class name of the transform
-
class
TransformManager extends Transform with DependencyAPIMigration with DependencyManager[CircuitState, Transform]
A Transform that ensures some other Transforms and their prerequisites are executed.
Value Members
- object CompilerAnnotation extends HasShellOptions with Serializable
- object FirrtlFileAnnotation extends HasShellOptions with Serializable
- object FirrtlMain extends StageMain
- implicit object FirrtlOptionsView extends OptionsView[FirrtlOptions]
- object FirrtlSourceAnnotation extends HasShellOptions with Serializable
-
object
FirrtlStageUtils
Utilities that help with processing FIRRTL options
- object Forms
- object InfoModeAnnotation extends HasShellOptions with Serializable
- object OutputFileAnnotation extends HasShellOptions with Serializable
- object RunFirrtlTransformAnnotation extends HasShellOptions with Serializable
- object TransformManager
This is the documentation for Firrtl.