Class/Object

treadle

TreadleTester

Related Docs: object TreadleTester | package treadle

Permalink

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)

    Permalink

    input

    a firrtl program contained in a string

    optionsManager

    collection of options for the engine

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val clockInfoList: Seq[ClockInfo]

    Permalink
  6. val clockStepper: ClockStepper

    Permalink
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val combinationalDelay: Long

    Permalink
  9. def cycleCount: Long

    Permalink
  10. val engine: ExecutionEngine

    Permalink
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def expect(name: String, expectedValue: BigInt, message: String = ""): Unit

    Permalink

    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

    Permalink

    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

    Permalink
  16. def fail(ex: Throwable, msg: Option[String] = None): Nothing

    Permalink

    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

    Permalink
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def finish: Boolean

    Permalink
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def isOK: Boolean

    Permalink
  24. def makeSnapshot(): Unit

    Permalink
  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def peek(name: String): BigInt

    Permalink

    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

    Permalink
  30. def poke(name: String, value: BigInt): Unit

    Permalink

    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

    Permalink

    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

    Permalink

    A simplistic report of the number of expects that passed

  33. def reportString: String

    Permalink
  34. def reset(timeRaised: Long): Unit

    Permalink
  35. val resetName: String

    Permalink
  36. def setVerbose(value: Boolean = true): Unit

    Permalink
  37. val startTime: Long

    Permalink
  38. def step(n: Int = 1): Unit

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
  40. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  41. val treadleOptions: TreadleOptions

    Permalink
  42. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. val wallTime: UTC

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped