Test

[test] section specifies the configuration for integrated unit test like below:

[test]
simulator = "vcs"

Available configurations

The [test] section

The simulator field

The simulator field specifies default simulator. The available types are below:

  • "verilator"
  • "vcs"
  • "vivado"

The include_files field

The include_files field specifies extra files used for simulation.

[test]
include_files = ["test/mem.hex"]

The waveform_target field

The waveform_target field specifies where the generated waveforms will be placed at. The available types are below:

  • target – as the same directory as the target code
  • directory – specified directory

If you want to use directory, you should specify the target path by path key.

[test]
waveform_target = {type = "directory", path = "[dst dir]"}

The waveform_format field

The waveform_format field specifies in which format the waveform will be dumped. The available formats are:

  • vcd – The default value and most readable format across all vendors. But also not very feature rich
  • fst – This format has some more features, e.g. printing enum values instead of integers. gtkwave and surfer can read this format.

The [test.verilator] section

This section contains configurations of test by Verilator.

ConfigurationValueDescription
compile_args[string]additional arguments to verilator command
simulate_args[string]additional arguments to simulation binary

The [test.vcs] section

This section contains configurations of test by VCS.

ConfigurationValueDescription
compile_args[string]additional arguments to vcs command
simulate_args[string]additional arguments to simulation binary

The [test.vivado] section

This section contains configurations of test by Vivado.

ConfigurationValueDescription
compile_args[string]additional arguments to xvlog command
elaborate_args[string]additional arguments to xelab command
simulate_args[string]additional arguments to xsim command