stage

Type Members

1. sealed trait CircuitOption extends Unserializable

   

   Indicates that this Annotation contains information that is directly convertable to a FIRRTL Circuit.

2. 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

3. case class FirrtlCircuitAnnotation(circuit: Circuit) extends NoTargetAnnotation with FirrtlOption with Product with Serializable

   

   Holds a FIRRTL Circuit

   Holds a FIRRTL Circuit

   circuit

   a circuit

4. 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.

5. 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

6. sealed trait FirrtlOption extends Unserializable

   

   Indicates that this is an Annotation directly used in the construction of a FirrtlOptions view.

7. class FirrtlOptions extends AnyRef

   

   Internal options used to control the FIRRTL compiler stage.

8. 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

9. class FirrtlStage extends Stage

   

10. 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

11. 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

12. 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