Type Members

1.  case class BlackBoxFactoriesAnnotation(blackBoxFactories: Seq[ScalaBlackBoxFactory]) extends NoTargetAnnotation with TreadleOption with Product with Serializable
2.  case class ClockInfoAnnotation(clockInfoSeq: Seq[ClockInfo] = Seq(ClockInfo())) extends NoTargetAnnotation with TreadleOption with Product with Serializable

   Sets one or more clocks including their frequencies and phase

3.  abstract class Command extends AnyRef
4.  case class DataStorePlugInAnnotation(name: String, getPlugin: (ExecutionEngine) ⇒ DataStorePlugin) extends NoTargetAnnotation with TreadleOption with Product with Serializable

   Using this annotation allows external users of a TreadleTester to supply their own custom treadle.executable.DataStorePlugins.

   Using this annotation allows external users of a TreadleTester to supply their own custom treadle.executable.DataStorePlugins. See that code for examples of use.

   name

   A unique name for this plugin

   getPlugin

   A function that returns a DataStorePlugin subclass

   Note

   this annotation cannot be generated from the command line

5.  case class MemoryToVCD(specifier: String) extends NoTargetAnnotation with TreadleOption with Product with Serializable

   Controls whether changes to memory locations are written to vcd output

   Controls whether changes to memory locations are written to vcd output

   specifier

   controls which memories and which locations of those memories are logged to vcd output When not present not memories are logged "all" log all values at all locations of all memories "mem1:all" log all values at all locations for memory mem1 "mem1:0-4" log values at locations 0-4 for memory mem1 "mem1:b0-b100" log values at locations 0-4 but show addresses in binary for memory mem1 "mem1:h0-hff" log values at locations 0-255 but show addresses in hex for memory mem1 "mem1:o0-o377" log values at locations 0-255 but show addresses in octal for memory mem1 This annotation may occur more than once in order to specify multiple memories

6.  case class PlusArgsAnnotation(plusArgs: Seq[String]) extends NoTargetAnnotation with TreadleOption with Product with Serializable

   Sets verilog plus args that will be passed to black boxes

7.  case class RandomSeedAnnotation(seed: Long = 0L) extends NoTargetAnnotation with TreadleOption with Product with Serializable

   Sets the seed for treadle's private random number generator

8.  case class ResetNameAnnotation(symbolNames: String = "") extends NoTargetAnnotation with TreadleOption with Product with Serializable

   used with treadle's default reset operations

9.  case class RollBackBuffersAnnotation(rollbackBufferDepth: Int = TreadleDefaults.RollbackBuffers) extends NoTargetAnnotation with TreadleOption with Product with Serializable

   Sets the number of rollback buffers in simulator, useful to see why wires have their values

10.  trait ScalaBlackBox extends AnyRef

    This is the template for writing Scala functions that implement the behaviour of a black box.

    This is the template for writing Scala functions that implement the behaviour of a black box. Implementing classes should add internal variables to hold any state information.

11.  abstract class ScalaBlackBoxFactory extends AnyRef

    For each instantiation of an ExtModule the engine needs a separate instance of a BlackBoxImplementation.

    For each instantiation of an ExtModule the engine needs a separate instance of a BlackBoxImplementation. This factory provides it.

    Example:

    1. class ExampleBBFactory extends BlackBoxFactory {
         override def createInstance(instanceName: String, blackBoxName: String): Option[BlackBoxImplementation] = {
           instanceName match {
             case "bb1" => Some(add(new BB1Impl))
             case "bb2" => Some(add(new BB2Impl))
             case "bb3" => Some(add(new BB3Impl))
             case _ => throw Exception(s"ExampleBBBFactory does not know how to create " + instanceName)
           }
         }
       }

12.  case class SymbolsToWatchAnnotation(symbolNames: Seq[String] = Seq.empty) extends NoTargetAnnotation with TreadleOption with Product with Serializable

    Sets a list of symbols that will be rendered during execution

13.  case class TreadleCircuitAnnotation(circuit: Circuit) extends NoTargetAnnotation with TreadleOption with Product with Serializable

    The circuit used to build a TreadleTester

    The circuit used to build a TreadleTester

    circuit

    a firrtl ast

14.  case class TreadleCircuitStateAnnotation(state: CircuitState) extends NoTargetAnnotation with Product with Serializable

    used to pass parsed firrtl to the TreadleTester

    used to pass parsed firrtl to the TreadleTester

    state

    the state to be passed along

15.  class TreadleLibrary extends RegisteredLibrary

    Constructs this as a registered library that will be auto-detected by projects who have a dependency on Treadle

16.  sealed trait TreadleOption extends Unserializable
17.  class TreadleRepl extends AnyRef

    Considered by many to be the world's best Treadle Repl

18.  class TreadleTester extends AnyRef

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

    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

19.  case class TreadleTesterAnnotation(tester: TreadleTester) extends NoTargetAnnotation with TreadleOption with Product with Serializable

    Used to pass a tester on to a test harness

    Used to pass a tester on to a test harness

    tester

    The TreadleTester to be passed on

20.  case class VcdReplayEventsToRun(count: Int) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable
21.  case class VcdReplaySkipEvents(count: Int) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable
22.  class VcdReplayTester extends LazyLogging

    This tester runs a VCD file against a circuit expressed in a firrtl file.

    This tester runs a VCD file against a circuit expressed in a firrtl file. The VCD file should have been produced by running a test harness against the circuit. This test can be used to generate circuit behavior while running symbolic or concolic testing. It can also be used to determine if later changes to a circuit have changed since some original correct **golden** run of the circuit For example use the main below to run the VcdAdder files contained in the src/test/resources directory

    sbt 'runMain treadle.VcdReplayTester -fs src/test/resources/VcdAdder.fir -vcd src/test/resources/VcdAdder.vcd'

23.  trait VcdReplayTesterCli extends AnyRef
24.  sealed trait VcdReplayTesterOptions extends Unserializable
25.  class VcdReplayTesterStage extends Stage
26.  case class VcdReplayVcdFile(fileName: String) extends NoTargetAnnotation with VcdReplayTesterOptions with Product with Serializable
27.  case class TreadleFirrtlFormHint(form: Any) extends NoTargetAnnotation with Product with Serializable

    Provides an input form hint to treadle to know how to best handle the input it receives

    Provides an input form hint to treadle to know how to best handle the input it receives

    form

    the input form

    Annotations

    @deprecated

    Deprecated

    (Since version 1.3.x) Remove references, this has no effect