MiddleFirrtlCompiler
Related Doc:
package firrtl
Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.
Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.
Input Firrtl AST
A transformed Firrtl AST
A convenience function useful for debugging and error messages
A convenience function useful for debugging and error messages
Perform the transform and update annotations.
Perform the transform and update annotations.
Input Firrtl AST
A transformed Firrtl AST
A mathematical transform on some type
A mathematical transform on some type
an output object of the same type
The sequence of transforms this compiler will execute
The sequence of transforms this compiler will execute
The inputForm of a given transform must be higher than or equal to the ouputForm of the preceding transform. See CircuitForm
Perform compilation
Perform compilation
Emission will only be performed if EmitAnnotations are present
The Firrtl AST to compile
Any custom Transforms that will be inserted into the compilation process by CompilerUtils.mergeTransforms
result of compilation
(Since version FIRRTL 1.3.3)
Perform compilation
Perform compilation
The Firrtl AST to compile
The java.io.Writer where the output of compilation will be emitted
Any custom Transforms that will be inserted into the compilation process by CompilerUtils.mergeTransforms
(Since version FIRRTL 1.0)
Perform compilation and emit the whole Circuit
Perform compilation and emit the whole Circuit
This is intended as a convenience method wrapping up Annotation creation for the common case. It creates a EmitCircuitAnnotation that will be consumed by this Transform's emitter. The EmittedCircuit can be extracted from the returned CircuitState via CircuitState.emittedCircuitOption
The Firrtl AST to compile
Any custom Transforms that will be inserted into the compilation process by CompilerUtils.mergeTransforms
result of compilation with emitted circuit annotated
(Since version FIRRTL 1.3.3)
All transforms that must run after this transform
All transforms that must run after this transform
This is a means of prerequisite injection into some other transform. Normally a transform will define its own prerequisites. Dependents exist for two main situations:
First, they improve the composition of optional transforms. If some first transform is optional (e.g., an expensive validation check), you would like to be able to conditionally cause it to run. If it is listed as a prerequisite on some other, second transform then it must always run before that second transform. There's no way to turn it off. However, by listing the second transform as a dependent of the first transform, the first transform will only run (and be treated as a prerequisite of the second transform) if included in a list of target transforms that should be run.
Second, an external library would like to inject some first transform before a second transform inside FIRRTL. In this situation, the second transform cannot have any knowledge of external libraries. The use of a dependent here allows for prerequisite injection into FIRRTL proper.
(Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
firrtl.passes.CheckTypes for an example of an optional checking firrtl.Transform
Convenience method to get annotations relevant to this Transform
Convenience method to get annotations relevant to this Transform
The CircuitState form which to extract annotations
A collection of annotations
(Since version 1.1) Just collect the actual Annotation types the transform wants
(Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre
(Since version FIRRTL 1.3) Use Dependency API methods for equivalent functionality. See: https://bit.ly/2Voppre
Emits middle Firrtl input circuit
(Since version FIRRTL 1.3) Use stage.{FirrtlStage, FirrtlMain} stage.transforms.Compiler(Dependency[MiddleFirrtlEmitter])