firrtl.stage.phases.DriverCompatibility
The type used to express dependencies: a class which itself has dependencies.
The type used to express dependencies: a class which itself has dependencies.
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
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.
Try to add an InputAnnotationFileAnnotation implicitly specified by an AnnotationSeq.
Try to add an InputAnnotationFileAnnotation implicitly specified by an AnnotationSeq.
an output object of the same type
Add an implicit annotation file derived from the determined top name of the circuit if no InputAnnotationFileAnnotation is present.
The implicit annotation file is determined through the following complicated semantics:
main
in a Circuit) is discernable (see below) and a file calledtopName.anno
(exactly, nottopName.anno.json
) exists, then this will add an InputAnnotationFileAnnotation using thattopName.anno
The precedence for determining the
topName
is the following (first one wins):topName
in a TopNameAnnotationmain
FirrtlCircuitAnnotationmain
in a parsed FirrtlSourceAnnotationmain
in the first FirrtlFileAnnotation using either ProtoBuf or parsing as determined by file extensionoutput annotations