List of all netlists of each declared scope, ordered from closest to farthest
List of all netlists of each declared scope, ordered from closest to farthest
Note immutable.Map because conversion from mutable.LinkedHashMap to mutable.Map is VERY slow
Collects Info data serialized names for nodes, aggregating into MultiInfo when necessary
Maps a reference to whatever connects to it.
Maps a reference to whatever connects to it. Used to resolve last connect semantics
Contains all simulation constructs
Maps an expression to a declared node name.
Maps an expression to a declared node name. Used to memoize predicates
(Since version FIRRTL 1.3.2) This will be removed in FIRRTL 1.4.0
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
Expands a module's when statements
Expands a module's when statements
Module to expand
Statement contains all declarations in the module (including DefNode's)
,Seq[Attach] contains all Attach statements (unsimplified)
,Simlist contains all simulation constructs in m
,Netlist maps a reference to whatever connects to it
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
A convenience function useful for debugging and error messages
A convenience function useful for debugging and error messages
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.
Returns circuit with when and last connection semantics resolved
Returns circuit with when and last connection semantics resolved
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
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
Expand Whens
This pass does the following things: $ - Remove last connect semantics $ - Remove conditional blocks $ - Eliminate concept of scoping $ - Consolidate attaches
Assumes all references are declared
,Assumes bulk connects and isInvalids have been expanded