Stage
Related Doc:
package options
The type used to express dependencies: a class which itself has dependencies.
The type used to express dependencies: a class which itself has dependencies.
Run this stage on some input annotations
Run this stage on some input annotations
input annotations
output annotations
A utility that helps convert command line options to annotations
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.
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
Run this stage on on a mix of arguments and annotations
Run this stage on on a mix of arguments and annotations
command line arguments
output annotations
OptionsException if command line or annotation validation fails
A function that, given *another* transform (parameter a) will return true if this transform invalidates/undos the
effects of the *other* transform (parameter a).
A function that, given *another* transform (parameter a) will return true if this transform invalidates/undos the
effects of the *other* transform (parameter a).
transform
The name of this Phase.
The name of this Phase. This will be used to generate debug/error messages or when deleting
annotations. This will default to the simpleName of the class.
this phase's name
Override this with your own implementation for different naming behavior.
All transform that must run before this transform
All transform that must run before this transform
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
Execute this stage on some input annotations.
Execute this stage on some input annotations. Annotations will be read from any input annotation files.
input annotations
output annotations
OptionsException if command line or annotation validation fails
A Stage represents one stage in the FIRRTL hardware compiler framework. A Stage is, conceptually, a Phase that includes a command line interface.
The FIRRTL compiler is a stage as well as any frontend or backend that runs before/after FIRRTL. Concretely, Chisel is a Stage as is FIRRTL's Verilog emitter. Each stage performs a mathematical transformation on an AnnotationSeq where some input annotations are processed to produce different annotations. Command line options may be pulled in if available.