NetlistSynthesizer class

A simple Synthesizer that produces netlist-compatible JSON.

Leverages SynthModuleDefinition for signal tracing, naming, and constant resolution, then maps the resulting SynthLogics to integer wire-bit IDs for netlist JSON output.

Leaf modules (those with no sub-modules, or special cases like FlipFlop) do not get their own module definition -- they appear only as cells inside their parent.

Usage:

const configuration = NetlistSynthesizerConfiguration(
  collapseTransparentClusters: true,
);
final synth = NetlistSynthesizer(configuration: configuration);
final builder = SynthBuilder(topModule, synth);
final json = synth.synthesizeToJson(topModule);
Inheritance

Constructors

NetlistSynthesizer({NetlistSynthesizerConfiguration configuration = const NetlistSynthesizerConfiguration()})
Creates a NetlistSynthesizer.

Properties

configuration → NetlistSynthesizerConfiguration
The configuration controlling netlist synthesis.
final
hashCode → int
The hash code for this object.
no setterinherited
moduleStopPolicy → SynthModuleStopPolicy
The hierarchy stopping policy used by this synthesizer.
no setter
netlistCellMapper → NetlistCellMapper
Convenience accessor for the netlist-cell mapper.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

applyPostProcessingPasses(Map<String, Map<String, Object?>> modules) → void
Apply all post-processing passes to the modules map.
buildModulesMap(SynthBuilder synth, Module top, {String? packageRoot, bool? slimMode, SourceTraceFileTable? fileTable}) → Map<String, Map<String, Object?>>
Build the processed modules map from a SynthBuilder's results.
generateCombinedJson(SynthBuilder synth, Module top, {String? packageRoot, bool? slimMode}) → String
Generate the combined netlist JSON from a SynthBuilder's results.
generatesDefinition(Module module) → bool
Determines whether module needs a separate definition or can just be described in-line.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
synthesize(Module module, String getInstanceTypeOfModule(Module module), {SynthesisResult? lookupExistingResult(Module module)?, Map<Module, SynthesisResult>? existingResults}) → SynthesisResult
Synthesizes module into a SynthesisResult, given the mapping provided by getInstanceTypeOfModule.
override
synthesizeToJson(Module top, {String? packageRoot, bool? slimMode}) → String
Convenience: synthesize top into a combined netlist JSON string.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

formatVersion → const String
The version of the ROHD extensions to the Yosys JSON netlist format.