[chiselsim] Add SimulatorAPI, reduce DefaultSimulator to nothing #4680
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
@jackkoenig: I'm curious if you have any ideas on how to package up this API. Two options occurred to me:
class Foo extneds AnyFunSpec with Matchers with SimulatorAPI with PeekPokeAPI {
/** body */
}
import chisel3.simulator.DefaultSimulator._If (2), then what should the package/object be?
I'd plan to keep |
Member
Author
|
Maybe for (3) we call this package chisel3.simulator
trait ChiselSim extends PeekPokeAPI with SimulatorAPIpackage chisel3.simulator.scalatest
import chisel3.simulator.{PeekPokeAPI, SimulatorAPI}
trait ChiselSim extends PeekPokeAPI with SimulatorAPI with WithTestingDirectory /** with other ScalaTest stuff */Note: this can either or instead use the wildcard import approach with some slight changes to how |
seldridge
changed the title
Add a new `SimulatorAPI` trait which provides methods for running simulations. This will submsume the existing `DefaultSimulator.simulate` method and extends it with an "ABI" for how to startup simulations of Chisel-generated Verilog. This API includes two methods: 1. simulateRaw -- This is only usable with `RawModule`s where there is no information about the clock and reset. This is the same as `DefaultSimulator.simulate`. 2. simulate -- This is only usable with `Module`s where there is a defined clock and reset. This is the method which implements an "ABI" startup sequence which avoids problems with simulators, time zero behavior, and race conditions. Signed-off-by: Schuyler Eldridge <[email protected]>
Remove all methods from `DefaultSimulator` and replace them with methods provided by the `SimulatorAPI`. This is change to the unreleased `simulate` method for `DefaultSimulator` in that this will now require a `Module` and uses the standard ABI bringup procedure. `EphemeralSimulator` is left unchanged. Signed-off-by: Schuyler Eldridge <[email protected]>
seldridge
force-pushed
the
dev/seldridge/SimulatorAPI
branch
from
71bb8bf to
98aa78c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a new
SimulatorAPItrait which provides methods for runningsimulations. This will submsume the existing
DefaultSimulator.simulatemethod and extends it with an "ABI" for how to startup simulations of
Chisel-generated Verilog.
This API includes two methods:
simulateRaw -- This is only usable with
RawModules where there isno information about the clock and reset. This is the same as
DefaultSimulator.simulate.simulate -- This is only usable with
Modules where there is adefined clock and reset. This is the method which implements an "ABI"
startup sequence which avoids problems with simulators, time zero
behavior, and race conditions.
Remove all methods from
DefaultSimulatorand replace them with methodsprovided by the
SimulatorAPI. This is change to the unreleasedsimulatemethod forDefaultSimulatorin that this will now require aModuleand uses the standard ABI bringup procedure.EphemeralSimulatoris left unchanged.Release Notes
Add a new ChiselSim trait,
SimulatorAPI, which adds methods for running simulations.