Cli

Adds -DchiselOpts=<space-delimited-chisel-options>

This allows for extra options to be passed directly to Chisel elaboration. Options are space-delimited. To pass multiple options use single quotes, e.g.:

-DchiselOpts='-foo -bar'

Adds -DemitFsdb=[1,true]

This causes a simulation to dump an FSDB wave starting at time zero. Finer grained control can be achieved with chisel3.simulator.ControlAPI.disableWaves and chisel3.simulator.ControlAPI.enableWaves.

If the simulator does not support FSDB waves, then using this option will throw an IllegalArgumentException when the option is used.

Adds -DemitVcd=[1,true]

This causes a simulation to dump a VCD wave starting at time zero. Finer grained control can be achieved with chisel3.simulator.ControlAPI.disableWaves and chisel3.simulator.ControlAPI.enableWaves.

Adds -DemitVpd=[1,true]

This causes a simulation to dump a VPD wave starting at time zero. Finer grained control can be achieved with chisel3.simulator.ControlAPI.disableWaves and chisel3.simulator.ControlAPI.enableWaves.

If the simulator does not support VPD waves, then using this option will throw an IllegalArgumentException when the option is used.

Adds -DfirtoolOpts=<space-delimited-firtool-options>

This allows for extra options to be passed directly to firtool. Options are space-delimited. To pass multiple options use single quotes, e.g.:

-DfirtoolOpts='-foo -bar'

Adds -Dscale=<double>

This adds an option which can be used to control the "scaling factor" of the test. This option can be used by the test author to "scale" the test to make it longer or shorter.

This is inteded to be used with randomized testing or some testing which does not have a natural end point or an end point which may be dependent on execution context. E.g., you can use this to make a test which runs for briefly in a pre-merge Continuous Integration (CI) flow, but runs for much longer in nightly CI.

Note that the interpretation of the "scaling factor" is test dependent. In order to document this and help end users, this trait has an abstract member scaleHelpText which must be overridden to document what the scale affects in the test. E.g., if the scale is used to lengthen a test, a test author could write:

override protected def scaleHelpText = "scales the runtime of a test"

While this adds the low-level scale option. A user of this should use the member functions that this trait adds, e.d., scaled.

Adds -Dsimulator to choose the simulator at runtime.

This trait adds an option for controlling the simulator at runtime.

If a user wants to add more simulators or simulators with different options, they should override the cliSimulatorMap with their chosen simulators.

If a user wants to change the default simulator, they should override defaultCliSimulator. Making this a None will require the user to always specify a simulator, i.e., there is no default.