p

treadle2

package treadle2

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

Package Members

  1. package blackboxes
  2. package chronometry
  3. package executable
  4. package stage
  5. package utils
  6. package vcd

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. 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 treadle2.executable.DataStorePlugins.

    Using this annotation allows external users of a TreadleTester to supply their own custom treadle2.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

  4. 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

  5. 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

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

    Sets the seed for treadle's private random number generator

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

    used with treadle's default reset operations

  8. 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.

  9. 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)
    }
  }
}
  10. 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

  11. 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

  12. 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

  13. class TreadleLibrary extends RegisteredLibrary

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

  14. sealed trait TreadleOption extends Unserializable
  15. 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

  16. 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

Deprecated Type Members

  1. 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

Value Members

  1. val Big0: BigInt
  2. val Big1: BigInt
  3. val BitsRequiredOverflowSizeBigInt: BigInt
  4. val DangerShiftSize: Int
  5. def bigIntBitsToDouble(bigInt: BigInt): Double
  6. def boolToBigInt(condition: Boolean): BigInt
  7. def boolToInt(condition: Boolean): Int
  8. def ceilingLog2(x: Int): Int
  9. def computeBits(n: BigInt): Int

    Utility function that computes bits required for a number

    Utility function that computes bits required for a number

    n

    number of interest

  10. def doubleToBigIntBits(double: Double): BigInt
  11. def extremaOfSIntOfWidth(width: Int): (BigInt, BigInt)

    computes the smallest and largest values that will fit in an SInt

    computes the smallest and largest values that will fit in an SInt

    width

    width of SInt

    returns

    tuple(minVale, maxValue)

  12. def extremaOfUIntOfWidth(width: Int): (BigInt, BigInt)

    computes the smallest and largest values that will fit in a UInt

    computes the smallest and largest values that will fit in a UInt

    width

    width of SInt

    returns

    tuple(minVale, maxValue)

  13. def makeRandom(tpe: Type): BigInt
  14. val random: Random
  15. def randomBigInt(width: Int): BigInt
  16. def requiredBitsForSInt(num: BigInt): Int

    return the smallest number of bits required to hold the given number in an SInt Note: positive numbers will get one minimum width one higher than would be required for a UInt

    return the smallest number of bits required to hold the given number in an SInt Note: positive numbers will get one minimum width one higher than would be required for a UInt

    num

    number to find width for

    returns

    minimum required bits for an SInt

  17. def requiredBitsForUInt(num: BigInt): Int

    return the smallest number of bits required to hold the given number in an UInt

    return the smallest number of bits required to hold the given number in an UInt

    num

    number to find width for

    returns

    minimum required bits for an SInt

  18. def typeToWidth(tpe: Type): Int
  19. def widthToInt(width: Width): Int
  20. case object AllowCyclesAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to allow cycles

  21. case object CallResetAtStartupAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tell treadle to call it's own internal reset at startup.

    Tell treadle to call it's own internal reset at startup. This is typically handled by the unit test framework and not needed for users

  22. case object ClockInfoAnnotation extends HasShellOptions with Product with Serializable
  23. case object DontRunLoweringCompilerLoadAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to not run its own lowering pass on firrtl input (not recommended)

  24. case object EnableCoverageAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Controls whether coverage information will be gathered or not during the execution of a test.

  25. case object MemoryToVCD extends HasShellOptions with Product with Serializable
  26. case object PlusArgsAnnotation extends HasShellOptions with Product with Serializable
  27. case object PrefixPrintfWithWallTime extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to prefix printf strings with a wall time

  28. object RandomSeedAnnotation extends HasShellOptions with Serializable
  29. case object RandomizeAtStartupAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to Randomize circuit at startup

  30. case object ResetNameAnnotation extends HasShellOptions with Product with Serializable
  31. case object SaveFirrtlAtLoadAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to show the low firrtl it is starting out with

  32. case object ShowFirrtlAtLoadAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to show the low firrtl it is starting out with

  33. case object SymbolsToWatchAnnotation extends HasShellOptions with Product with Serializable
  34. object TreadleDefaults
  35. object TreadleFirrtlFile extends HasShellOptions

    Factory for FirrtlFileAnnotation annotation, this is an alias for Firrtl Cli

  36. object TreadleFirrtlString extends HasShellOptions

    Factory for FirrtlSourceAnnotation, this is an alias for FirrtlCli

  37. object TreadleRocketBlackBoxes extends HasShellOptions

    Adds the treadle blackboxes for rocket black box factory

  38. object TreadleTester
  39. case object ValidIfIsRandomAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to present random value when validIf's condition is off

  40. case object VcdShowUnderScoredAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to include _T_* and _GEN_* wires in VCD output

  41. case object VerboseAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to execute verbosely

  42. case object WriteCoverageCSVAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to write coverage report in CSV format after simulation

  43. case object WriteVcdAnnotation extends NoTargetAnnotation with TreadleOption with HasShellOptions with Product with Serializable

    Tells treadle to write a vcd file during simulation

Deprecated Value Members

  1. object TreadleFirrtlFormHint extends HasShellOptions with Serializable
    Annotations
    @deprecated
    Deprecated

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

Inherited from AnyRef

Inherited from Any

Ungrouped