t

chiseltest.simulator

SimulatorContext

trait SimulatorContext extends AnyRef

context for a running firrtl circuit simulation

Linear Supertypes
AnyRef, Any
Known Subclasses
DebugPrintWrapper
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimulatorContext
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def finish(): Unit

    Needs to be called after the context is no longer needed.

    Needs to be called after the context is no longer needed.

    Note

    only after finish has been successfully returned is a potential waveform file guaranteed to exists on disk.

    ,

    after finish no other functions besides sim or getCoverage may be called.

  2. abstract def peek(signal: String): BigInt

    Returns the latest value of an output or input port on the top-level module.

    Returns the latest value of an output or input port on the top-level module.

    Note

    the simulator has to take care of recomputing signals after any change

  3. abstract def poke(signal: String, value: BigInt): Unit

    Change the value of an input port on the top-level module.

  4. abstract def sim: Simulator

    Returns a reference the Simulator that created this context.

  5. abstract def step(n: Int = 1): StepResult

    Step the main clock n times.

    Step the main clock n times. Throws a NoClockException if the circuit does not have a clock input.

    returns

    StepInterrupted if a stop/assert/assume statement fired during execution, StepOk otherwise.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def getCoverage(): List[(String, Long)]

    Returns the current value of the coverage counters.

    Returns the current value of the coverage counters.

    Note

    only some simulators support calling getCoverage _before_ finish

    ,

    for more information on the coverage format, please consult the documentation for chiseltest.coverage.TestCoverage

  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def peekMemory(signal: String, index: Long): BigInt

    Returns the latest value of a memory location.

    Returns the latest value of a memory location. Only supported by some simulators.

    Note

    the simulator has to take care of recomputing signals after any change

  16. def pokeMemory(signal: String, index: Long, value: BigInt): Unit

    Change the value of memory location.

    Change the value of memory location. Only supported by some simulators.

  17. def resetCoverage(): Unit

    Resets all coverage counters to zero.

    Resets all coverage counters to zero.

    Note

    Not supported by all simulators. Must result in a NotImplementedError if not supported.

  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped