Exception indicating that a blackbox wasn't found
Handle source for Verilog ExtModules (BlackBoxes)
Handle source for Verilog ExtModules (BlackBoxes)
This transform handles the moving of Verilog source for black boxes into the target directory so that it can be accessed by verilator or other backend compilers While parsing it's annotations it looks for a BlackBoxTargetDir annotation that will set the directory where the Verilog will be written. This annotation is typically be set by the execution harness, or directly in the tests
Finds and detects combinational logic loops in a circuit, if any exist.
Finds and detects combinational logic loops in a circuit, if any exist. Returns the input circuit with no modifications.
firrtl.transforms.CheckCombLoops.CombLoopException
if a loop is found
The pass will throw exceptions on "false paths"
,The pass relies on ExtModulePathAnnotations to find loops through ExtModules
,The pass looks for loops through combinational-read memories
,Output form: Low FIRRTL (identity transform)
,Input form: Low FIRRTL
Combine Cat DoPrims
Combine Cat DoPrims
Expands the arguments of any Cat DoPrims if they are references to other Cat DoPrims. Operates only on Cat DoPrims that are node values.
Use MaxCatLenAnnotation to limit the number of elements that can be concatenated. The default maximum number of elements is 10.
Dead Code Elimination (DCE)
Dead Code Elimination (DCE)
Performs DCE by constructing a global dependency graph starting with top-level outputs, external module ports, and simulation constructs as circuit sinks. External modules can optionally be eligible for DCE via the OptimizableExtModuleAnnotation.
Dead code is eliminated across module boundaries. Wires, ports, registers, and memories are all eligible for removal. Components marked with a DontTouchAnnotation will be treated as a circuit sink and thus anything that drives such a marked component will NOT be removed.
This transform preserves deduplication. All instances of a given firrtl.ir.DefModule are treated as the same individual module. Thus, while certain instances may have dead code due to the circumstances of their instantiation in their parent module, they will still not be removed. To remove such modules, use the NoDedupAnnotation to prevent deduplication.
Only use on legal Firrtl.
Only use on legal Firrtl.
Specifically, the restriction of instance loops must have been checked, or else this pass can infinitely recurse.
Deduped modules are renamed using a chain of 3 RenameMaps. The first RenameMap renames the original annotations.ModuleTargets and relative annotations.InstanceTargets to the groups of absolute annotations.InstanceTargets that they target. These renames only affect instance names and paths and use the old module names. During this rename, modules will also have their instance names renamed if they dedup with a module that has different instance names. The second RenameMap renames all component names within modules that dedup with another module that has different component names. The third RenameMap renames original annotations.ModuleTargets to their deduped annotations.ModuleTarget.
This transform will also emit DedupedResult for deduped modules that only have one instance.
Holds the mapping from original module to the instances the original module pointed to The original module target is unaffected by renaming
Holds the mapping from original module to the instances the original module pointed to The original module target is unaffected by renaming
Original module
Instance target of what the original module now points to
the normalized position of the original module in the original module list, fraction between 0 and 1
A globalized form of HasDontTouches which applies to all ReferenceTargets provided with the annotation
A component that should be preserved
A component that should be preserved
DCE treats the component as a top-level sink of the circuit
Replaces adding a negative literal with subtracting that literal
Replaces adding a negative literal with subtracting that literal
Verilator has a lint warning if a literal is negated in an expression, because it adds a bit to the literal and thus not all expressions in the add are the same. This is fixed here when we directly subtract the literal instead.
Takes flatten annotations for module instances and modules and inline the entire hierarchy of modules down from the annotations.
Takes flatten annotations for module instances and modules and inline the entire hierarchy of modules down from the annotations. This transformation instantiates and is based on the InlineInstances transformation.
Instances of extmodules are not (and cannot be) inlined
,Flattening a module means inlining all its fully-defined child instances
Tags an annotation to be consumed by this transform
Flatten register update
Flatten register update
This transform flattens register updates into a single expression on the rhs of connection to the register
Splits a module into multiple modules by grouping its components via GroupAnnotation's Tries to deduplicate the resulting circuit
Specifies a group of components, within a module, to pull out into their own module Components that are only connected to a group's components will also be included
Specifies a group of components, within a module, to pull out into their own module Components that are only connected to a group's components will also be included
components in this group
suggested name of the new module
suggested name of the instance of the new module
suggested suffix of any output ports of the new module
suggested suffix of any input ports of the new module
Splits a module into multiple modules by grouping its components via GroupAnnotation's
Lets an annotation mark its ReferenceTarget members as DontTouch
Lets an annotation mark its ReferenceTarget members as DontTouch
This permits a transform to run and remove its associated annotations, thus making their ReferenceTargets new candidates for optimization. This removes the need for the pass writer to reason about pre-existing DontTouchAnnotations that may touch the same node.
Infers the concrete type of ResetTypes by their connections
Infers the concrete type of ResetTypes by their connections
There are 3 cases 1. An abstract reset driven by and/or driving only asynchronous resets will be inferred as asynchronous reset 1. An abstract reset driven by and/or driving both asynchronous and synchronous resets will error 1. Otherwise, the reset is inferred as synchronous (i.e. the abstract reset is only invalidated or is driven by or drives only synchronous resets)
This transform should be run before DedupModules so that similar Modules from generator languages like Chisel can infer differently
,This is a global inference because ports can be of type ResetType
Inline nodes that are simple bits
Inline Bool expressions
Inline Bool expressions
The following conditions must be satisfied to inline 1. has type Utils.BoolType 2. is bound to a DefNode with name starting with '_' 3. is bound to a DefNode with a source locator that points at the same file and line number. If it is a MultiInfo source locator, the set of file and line number pairs must be the same. Source locators may point to different column numbers. 4. InlineBooleanExpressionsMax has not been exceeded 5. is not a Mux
Inline nodes that are simple casts
Turns andr for expression > 64-bit into equality check with all ones
Turns andr for expression > 64-bit into equality check with all ones
Workaround a bug in Verilator v4.026 - v4.032 (inclusive). For context, see https://github.com/verilator/verilator/issues/2300
Ensure Clocks and AsyncResets to be emitted are legal Verilog
A case class that represents a net in the circuit.
A case class that represents a net in the circuit. This is necessary since combinational loop checking is an analysis on the netlist of the circuit; the fields are specialized for low FIRRTL. Since all wires are ground types, a given ground type net may only be a subfield of an instance or a memory port. Therefore, it is uniquely specified within its module context by its name, its optional parent instance (a WDefInstance or WDefMemory), and its optional memory port name.
Transform for manipulate all the names in a FIRRTL circuit.
Transform for manipulate all the names in a FIRRTL circuit.
the type of the child transform
Annotation to filter name manipulation to only manipulate specific Targets in a transform that subclasses ManipulateNames.
Annotation to filter name manipulation to only manipulate specific Targets in a transform that subclasses ManipulateNames. Targets will be renamed if they are not listed in a ManipulateNamesBlocklistAnnotation and also listed in this annotation.
Not providing a ManipulateNamesAllowlistAnnotation means that all targets in a circuit may be renamed.
a sub-type of ManipulateNames
FIRRTL IR targets to include in name manipulation
the transform that this should apply to
java.lang.IllegalArgumentException
if any non-local targets are given
All targets must be local. Name modification in a non-local target (e.g., a node in a specific instance) makes no structural modification and will be ignored during deduplication. If you want this behavior, use a combination of a sub-class of this annotation and a NoDedupAnnotation.
Records the result of name changes for any targets included in a ManipulateNamesAllowlistAnnotation
Records the result of name changes for any targets included in a ManipulateNamesAllowlistAnnotation
If targets are later removed, then a target and old target will be removed from this annotation. If all targets are removed, then this annotation will be deleted.
the new targets
the transform that performed this rename
the old targets
Annotation to prevent name manipulation ofTargets in a transform that subclasses ManipulateNames.
Annotation to prevent name manipulation ofTargets in a transform that subclasses ManipulateNames. All listed targets will not be modified.
a sub-type of ManipulateNames
FIRRTL IR targets to exclude from name manipulation
the transform that this should apply to
java.lang.IllegalArgumentException
if any non-local targets are given
All targets must be local. Name modification in a non-local target (e.g., a node in a specific instance) makes no structural modification and will be ignored during deduplication. If you want this behavior, use a combination of a sub-class of this annotation and a NoDedupAnnotation.
Base trait for annotations that control the behavior of transforms that sub-class ManipulateNames
Base trait for annotations that control the behavior of transforms that sub-class ManipulateNames
A component, e.g.
A component, e.g. register etc. Must be declared only once under the TopAnnotation
An firrtl.ir.ExtModule that can be optimized
An firrtl.ir.ExtModule that can be optimized
Firrtl does not know the semantics of an external module. This annotation provides some "greybox" information that the external module does not have any side effects. In particular, this means that the external module can be Dead Code Eliminated.
Unlike DontTouchAnnotation, we don't care if the annotation is deleted
Propagate PresetAnnotations to all children of targeted AsyncResets Leaf Registers are annotated with PresetRegAnnotation All wires, nodes and connectors along the way are suppressed
Propagate PresetAnnotations to all children of targeted AsyncResets Leaf Registers are annotated with PresetRegAnnotation All wires, nodes and connectors along the way are suppressed
Processing of multiples targets are NOT isolated from one another as the expected outcome does not differ Annotations of leaf registers, wires, nodes & connectors does indeed not depend on the initial AsyncReset reference The set of created annotation based on multiple initial AsyncReset PresetAnnotation
This transform consists of 2 successive walk of the AST I./ Propagate
Thanks to the clean-up phase, this transform does not rely on DCE
This pass must run before InlineCastsTransform
Transform that removes collisions with reserved keywords
Replace wires with nodes in a legal, flow-forward order
Replace wires with nodes in a legal, flow-forward order
This pass must run after LowerTypes because Aggregate-type wires have multiple connections that may be impossible to order in a flow-foward way
Rename Modules
Rename Modules
using namespace created by analyses.GetNamespace, create unique names for modules
Replaces non-expanding arithmetic
Replaces non-expanding arithmetic
In the case where the result of add
or sub
immediately throws away the expanded msb, this
transform will replace the operation with a non-expanding operator addw
or subw
respectively.
This replaces some FIRRTL primops with ops that are not actually legal FIRRTL. They are useful for emission to languages that support non-expanding arithmetic (like Verilog)
Lowers memories without splitting them, but without the complexity of ReplaceMemMacros
Transform that removes collisions with Verilog keywords
Transform that applies an identity function.
Transform that applies an identity function. This returns an unmodified CircuitState.
(Since version FIRRTL 1.3) mix-in firrtl.options.IdentityLike[CircuitState]. IdentityTransform will be removed in 1.4.
(Since version FIRRTL 1.4.0) Replaced by LegalizeClocksAndAsyncResetsTransform
Utility functions for DedupModules
If this Annotation exists in an AnnotationSeq, then the firrtl.transforms.DedupModules transform will *NOT* be run on the circuit.
If this Annotation exists in an AnnotationSeq, then the firrtl.transforms.DedupModules transform will *NOT* be run on the circuit.
Indicate that DCE should not be run
Remove Synchronous Reset
Remove Synchronous Reset
This pass must run after LowerTypes
(Since version FIRRTL 1.4.0) Replaced by LegalizeClocksAndAsyncResetsTransform