phases

Type Members

1. class AddCircuit extends Phase

   

   Phase that expands FirrtlFileAnnotation/FirrtlSourceAnnotation into FirrtlCircuitAnnotations and deletes the originals.

   Phase that expands FirrtlFileAnnotation/FirrtlSourceAnnotation into FirrtlCircuitAnnotations and deletes the originals. This is part of the preprocessing done on an input AnnotationSeq by FirrtlStage.

   The types of possible annotations are handled in the following ways:

   • FirrtlFileAnnotations are read as Protocol Buffers if the file extension ends in .pb. Otherwise, these are assumed to be raw FIRRTL text and is sent to the Parser. The original FirrtlFileAnnotation is deleted.
   • FirrtlSourceAnnotations are run through the Parser. The original FirrtlSourceAnnotation is deleted.
   • FirrtlCircuitAnnotations are left untouched (along with all other annotations).

   If a Parser is used, its InfoMode is read from a mandatory InfoModeAnnotation. If using an InfoMode that expects a filename, the filename is used for FirrtlFileAnnotations and [anonymous source] is used for FirrtlSourceAnnotations.

   Note

   This must be run after AddDefaults as this Phase depends on the existence of an InfoModeAnnotation..

2. class AddDefaults extends Phase

   

   Phase that adds default FirrtlOption Annotations.

   Phase that adds default FirrtlOption Annotations. This is a part of the preprocessing done by FirrtlStage.

3. class AddImplicitEmitter extends Phase

   

   Phase that adds a EmitCircuitAnnotation derived from a CompilerAnnotation if one does not already exist.

4. class AddImplicitOutputFile extends Phase

   

   Phase that adds an OutputFileAnnotation if one does not already exist.

   Phase that adds an OutputFileAnnotation if one does not already exist.

   To determine the OutputFileAnnotation, the following precedence is used. Whichever happens first succeeds:

   • Do nothing if an OutputFileAnnotation or EmitAllModulesAnnotation exist
   • Use the main in the first discovered FirrtlCircuitAnnotation (see note below)
   • Use "a"

   The file suffix may or may not be specified, but this may be arbitrarily changed by the Emitter.

   Note

   This Phase has a dependency on AddCircuit. Only a FirrtlCircuitAnnotation will be used to implicitly set the OutputFileAnnotation (not other CircuitOption subclasses).

5. class Checks extends Phase

   

   Phase that strictly validates an AnnotationSeq.

   Phase that strictly validates an AnnotationSeq. The checks applied are intended to be extremeley strict. Nothing is inferred or assumed to take a default value (for default value resolution see AddDefaults).

   The intent of this approach is that after running this Phase, a user can be absolutely certain that other Phases or views will succeed. See FirrtlStage for a list of Phase that commonly run before this.

6. class Compiler extends Phase with Translator[AnnotationSeq, Seq[CompilerRun]]

   

   Runs the FIRRTL compilers on an AnnotationSeq.

   Runs the FIRRTL compilers on an AnnotationSeq. If the input AnnotationSeq contains more than one circuit (i.e., more than one FirrtlCircuitAnnotation), then annotations will be broken up and each run will be executed in parallel.

   The AnnotationSeq will be chunked up into compiler runs using the following algorithm. All annotations that occur before the first FirrtlCircuitAnnotation are treated as global annotations that apply to all circuits. Annotations after a circuit are only associated with their closest preceeding circuit. E.g., for the following annotations (where A, B, and C are some annotations):

   A(a), FirrtlCircuitAnnotation(x), B, FirrtlCircuitAnnotation(y), A(b), C, FirrtlCircuitAnnotation(z)

   Then this will result in three compiler runs:

   • FirrtlCircuitAnnotation(x): A(a), B
   • FirrtlCircuitAnnotation(y): A(a), A(b), C
   • FirrtlCircuitAnnotation(z): A(a)

   A(a) is a default, global annotation. B binds to FirrtlCircuitAnnotation(x). A(a), A(b), and C bind to FirrtlCircuitAnnotation(y). Note: A(b) may overwrite A(a) if this is a CompilerAnnotation. FirrtlCircuitAnnotation(z) has no annotations, so it only gets the default A(a).

7. class WriteEmitted extends Phase

   

   Phase that writes any EmittedAnnotations in an input AnnotationSeq to one or more files.

   Phase that writes any EmittedAnnotations in an input AnnotationSeq to one or more files. The input AnnotationSeq is viewed as both FirrtlOptions and StageOptions to determine the output filenames in the following way:

   • EmittedModuleAnnotations are written to a file in StageOptions.targetDir with the same name as the module and the outputSuffix that the EmittedComponent specified
   • EmittedCircuitAnnotations are written to a file in StageOptions.targetDir using the FirrtlOptions.outputFileName viewed from the AnnotationSeq. If no FirrtlOptions.outputFileName exists, then the top module/main name will be used. The outputSuffix will be appended as needed.

   This does no sanity checking of the input AnnotationSeq. This simply writes any modules or circuits it sees to files. If you need additional checking, then you should stack an appropriate checking phase before this.

   Any annotations written to files will be deleted.