instantiationVerilog method Null safety

  1. @override
String instantiationVerilog(
  1. String instanceType,
  2. String instanceName,
  3. Map<String, String> inputs,
  4. Map<String, String> outputs
)
override

Generates custom SystemVerilog to be injected in place of a module instantiation.

The instanceType and instanceName represent the type and name, respectively of the module that would have been instantiated had it not been overridden. The Maps inputs and outputs are a mapping from the Module's port names to the names of the signals that are passed into those ports in the generated SystemVerilog.

Implementation

@override
String instantiationVerilog(String instanceType, String instanceName,
    Map<String, String> inputs, Map<String, String> outputs) {
  if (inputs.isNotEmpty || outputs.length != 1) {
    throw Exception(
        'SimpleClockGenerator has exactly one output and no inputs,'
        ' but saw inputs $inputs and outputs $outputs.');
  }
  final clk = outputs['clk']!;
  return '''
// $instanceName
initial begin
$clk = 0;
forever begin
  #${clockPeriod ~/ 2};
  $clk = ~$clk;
end
end
''';
}