class TreadleTester extends AnyRef

Works a lot like the chisel classic tester compiles a firrtl input string and allows poke, peek, expect and step

pokes invalidate the underlying circuit peek, expect and step, recompute (re-validate) the circuit before executing

Important note: port names in LoFirrtl have replaced dot notation with underscore notation so that io.a.b must be referenced as io_a_b

Source
TreadleTester.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TreadleTester
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TreadleTester(input: String, optionsManager: HasTreadleSuite = new TreadleOptionsManager)

    input

    a firrtl program contained in a string

    optionsManager

    collection of options for the engine

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. val clockInfoList: Seq[ClockInfo]
  6. val clockStepper: ClockStepper
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. val combinationalDelay: Long
  9. def cycleCount: Long
  10. val engine: ExecutionEngine
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def expect(name: String, expectedValue: BigInt, message: String = ""): Unit

    require that a value be present on the named component

    require that a value be present on the named component

    name

    component name

    expectedValue

    the BigInt value required

  14. def expectMemory(name: String, index: Int, expectedValue: BigInt, message: String = ""): Unit

    require that a value be present on the named component

    require that a value be present on the named component

    name

    component name

    expectedValue

    the BigInt value required

  15. var expectationsMet: Int
  16. def fail(ex: Throwable, msg: Option[String] = None): Nothing

    Indicate failure due to an exception.

    Indicate failure due to an exception.

    ex

    exception causing the failure

    msg

    optional message to be printed

  17. def fail(code: Int): Unit
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def finish: Boolean
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isOK: Boolean
  24. def makeSnapshot(): Unit
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def peek(name: String): BigInt

    inspect a value of a named circuit component

    inspect a value of a named circuit component

    name

    the name of a circuit component

    returns

    A BigInt value currently set at name

  29. def peekMemory(name: String, index: Int): BigInt
  30. def poke(name: String, value: BigInt): Unit

    Pokes value to the port referenced by string Warning: pokes to components other than input ports is currently not supported but does not cause an error warning This feature should be supported soon

    Pokes value to the port referenced by string Warning: pokes to components other than input ports is currently not supported but does not cause an error warning This feature should be supported soon

    name

    the name of a port

    value

    a value to put on that port

  31. def pokeMemory(name: String, index: Int, value: BigInt): Unit

    Pokes value to the named memory at offset

    Pokes value to the named memory at offset

    name

    the name of a memory

    index

    the offset in the memory

    value

    a value to put on that port

  32. def report(): Unit

    A simplistic report of the number of expects that passed

  33. def reportString: String
  34. def reset(timeRaised: Long): Unit
  35. val resetName: String
  36. def setVerbose(value: Boolean = true): Unit
  37. val startTime: Long
  38. def step(n: Int = 1): Unit

    Cycles the circuit n steps (with a default of one) At each step registers and memories are advanced and all other elements recomputed

    Cycles the circuit n steps (with a default of one) At each step registers and memories are advanced and all other elements recomputed

    n

    cycles to perform

  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. val treadleOptions: TreadleOptions
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  45. val wallTime: UTC

Inherited from AnyRef

Inherited from Any

Ungrouped