chiseltest

Type Members

trait ChiselScalatestTester extends Assertions with TestSuiteMixin with TestEnvInterface

trait ChiselUtestTester extends TestSuite with TestEnvInterface

Using utest as test framework

// define test spec in trait
trait HasTestChipSpec {
  import chisel3.tester._
  def testChipSpec(dut: TestChip): Unit = { c =>
    // body of the unit test, c is a reference
    c.io.input.poke(1.U)
    c.io.output.expect(2.U)
  }
}

object SomeCircuitSpecTester extends ChiselUtestTester with HasSomeCircuitSpec {
  // define test by Tests macro
  val tests: Tests = Tests {
    // invoke test with test(""){}
    test("comments or name to a test"){
      // test function runs here
      testCircuit(new SomeCircuit, Seq(WriteVcdAnnotation))(SomeCircuitSpec)
    }
  }
}

class ClockResolutionException extends Exception
class DecoupledDriver[T <: Data] extends AnyRef
class LiteralTypeException extends Exception
class NotLiteralException extends Exception
sealed class Region extends AnyRef

Base class for regions, akin to Verilog regions for ordering events between threads within the same timestep.
Base class for regions, akin to Verilog regions for ordering events between threads within the same timestep. order is the order regions run in, with 0 being the default, and incrementing regions running later. TODO: have a more extensible ordering than ints.
class TemporalParadox extends Exception
class ThreadOrderDependentException extends Exception
class TimeoutException extends Exception
class UnpokeableException extends Exception
class UnsupportedOperationException extends Exception
class ValidDriver[T <: Data] extends AnyRef
implicit class testableClock extends AnyRef
implicit class testableData[T <: Data] extends AnyRef

Value Members

object ClockResolutionUtils

Provides clock-resolution-specific abstractions on top of getVar/setVar.
Provides clock-resolution-specific abstractions on top of getVar/setVar. For library builders, not top-level test writers.
object DecoupledDriver
object Monitor extends Region
object RawTester

This is a simple tester that does not require that it be within the scope of a scalatest in order to run.
This is a simple tester that does not require that it be within the scope of a scalatest in order to run. This form is suitable for running in the Jupyter notebook.
object Region
object TestInstance
object TestdriverMain extends Region
object ValidDriver
package backends
implicit def decoupledToDriver[T <: Data](x: ReadyValidIO[T]): DecoupledDriver[T]
package experimental

Your warranty is now void.
Your warranty is now void.
experimental contains cutting edge features that are, well, experimental, and carry no expectation of long-term support. We may break experimental APIs at any time. These may not work as expected, or may have unforeseen side effects, or may be powerful yet dangerous.
You have been warned.
object fork extends ForkBuilder
package internal
package legacy
def parallel(run1: ⇒ Unit, run2: ⇒ Unit): Unit
def timescope(contents: ⇒ Unit): Unit
implicit def validToDriver[T <: Data](x: ValidIO[T]): ValidDriver[T]

package chiseltest

Type Members

trait ChiselScalatestTester extends Assertions with TestSuiteMixin with TestEnvInterface

trait ChiselUtestTester extends TestSuite with TestEnvInterface

class ClockResolutionException extends Exception

class DecoupledDriver[T <: Data] extends AnyRef

class LiteralTypeException extends Exception

class NotLiteralException extends Exception

sealed class Region extends AnyRef

class TemporalParadox extends Exception

class ThreadOrderDependentException extends Exception

class TimeoutException extends Exception

class UnpokeableException extends Exception

class UnsupportedOperationException extends Exception

class ValidDriver[T <: Data] extends AnyRef

implicit class testableClock extends AnyRef

implicit class testableData[T <: Data] extends AnyRef

Value Members

object ClockResolutionUtils

object DecoupledDriver

object Monitor extends Region

object RawTester

object Region

object TestInstance

object TestdriverMain extends Region

object ValidDriver

package backends

implicit def decoupledToDriver[T <: Data](x: ReadyValidIO[T]): DecoupledDriver[T]

package experimental

object fork extends ForkBuilder

package internal

package legacy

def parallel(run1: ⇒ Unit, run2: ⇒ Unit): Unit

def timescope(contents: ⇒ Unit): Unit

implicit def validToDriver[T <: Data](x: ValidIO[T]): ValidDriver[T]

Inherited from AnyRef

Inherited from Any

Ungrouped