chisel/chisel3/chisel3.simulator/SimulatorAPI

SimulatorAPI

chisel3.simulator.SimulatorAPI

Attributes

Source: SimulatorAPI.scala
Graph
Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait ChiselSim

Members list

Value members

Concrete methods

def simulate[T <: Module](module: => T, chiselOpts: Array[String] = ..., firtoolOpts: Array[String] = ..., settings: Settings[T] = ..., additionalResetCycles: Int = ..., subdirectory: Option[String] = ...)(stimulus: T => Unit)(implicit hasSimulator: HasSimulator, testingDirectory: HasTestingDirectory, chiselOptsModifications: ChiselOptionsModifications, firtoolOptsModifications: FirtoolOptionsModifications, commonSettingsModifications: CommonSettingsModifications, backendSettingsModifications: BackendSettingsModifications): Unit

Simulate a Module using a standard initialization procedure.

For details of the initialization procedure see ResetProcedure.

Value parameters

additionalResetCycles: a number of additional cycles to assert reset for
chiselOpts: command line options to pass to Chisel
firtoolOpts: command line options to pass to firtool
module: the Chisel module to generate
settings: ChiselSim-related settings used for simulation
stimulus: directed stimulus to use
subdirectory: an optional subdirectory for the test. This will be a subdirectory under what is provided by testingDirectory.
testingDirectory: a type class implementation that can be used to change the behavior of where files will be created

Attributes

Note: Take care when passing chiselOpts. The following options are set by default and if you set incompatible options, the simulation will fail.
Source: SimulatorAPI.scala

def simulateRaw[T <: RawModule](module: => T, chiselOpts: Array[String] = ..., firtoolOpts: Array[String] = ..., settings: Settings[T] = ..., subdirectory: Option[String] = ...)(stimulus: T => Unit)(implicit hasSimulator: HasSimulator, testingDirectory: HasTestingDirectory, chiselOptsModifications: ChiselOptionsModifications, firtoolOptsModifications: FirtoolOptionsModifications, commonSettingsModifications: CommonSettingsModifications, backendSettingsModifications: BackendSettingsModifications): Unit

Simulate a RawModule without any initialization procedure.

Use of this method is not advised when simulate can be used instead. This method may cause problems with certain simulators as it is up to the user to ensure that race conditions will not exist during the time zero and reset procedure.

Value parameters

chiselOpts: command line options to pass to Chisel
firtoolOpts: command line options to pass to firtool
module: the Chisel module to generate
settings: ChiselSim-related settings used for simulation
stimulus: directed stimulus to use
subdirectory: an optional subdirectory for the test. This will be a subdirectory under what is provided by testingDirectory.
testingDirectory: a type class implementation that can be used to change the behavior of where files will be created

Attributes

Note: Take care when passing chiselOpts. The following options are set by default and if you set incompatible options, the simulation will fail.
Source: SimulatorAPI.scala

In this article

Generated with