Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, FixedPoint, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package testers

    The testers package provides the basic interface for chisel testers.

    The testers package provides the basic interface for chisel testers.

    Definition Classes
    chisel3
  • BasicTester
  • TesterDriver
o

chisel3.testers

TesterDriver

object TesterDriver extends BackendCompilationUtilities

Annotations
@nowarn()
Source
TesterDriver.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TesterDriver
  2. BackendCompilationUtilities
  3. LazyLogging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class AddImplicitTesterDirectory extends Phase

    Set the target directory to the name of the top module after elaboration

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. lazy val TestDirectory: File
    Definition Classes
    BackendCompilationUtilities
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def copyResourceToFile(name: String, file: File): Unit
    Definition Classes
    BackendCompilationUtilities
  8. def cppToExe(prefix: String, dir: File): ProcessBuilder
    Definition Classes
    BackendCompilationUtilities
  9. def createTestDirectory(testName: String): File
    Definition Classes
    BackendCompilationUtilities
  10. val defaultBackend: Backend
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def execute(t: () => BasicTester, additionalVResources: Seq[String] = Seq(), annotations: AnnotationSeq = Seq(), nameHint: Option[String] = None, processLogger: ProcessLogger = loggingProcessLogger): Boolean

    For use with modules that should successfully be elaborated by the frontend, and which can be turned into executables with assertions.

  14. def executeExpectingFailure(prefix: String, dir: File, assertionMsg: String = ""): Boolean
    Definition Classes
    BackendCompilationUtilities
  15. def executeExpectingSuccess(prefix: String, dir: File): Boolean
    Definition Classes
    BackendCompilationUtilities
  16. def finishWrapper(test: () => BasicTester): () => BasicTester

    Calls the finish method of an BasicTester or a class that extends it.

    Calls the finish method of an BasicTester or a class that extends it. The finish method is a hook for code that augments the circuit built in the constructor.

  17. def firrtlToVerilog(prefix: String, dir: File): ProcessBuilder
    Definition Classes
    BackendCompilationUtilities
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def getLogger: Logger
    Definition Classes
    LazyLogging
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
  23. def loggingProcessLogger: ProcessLogger
    Definition Classes
    BackendCompilationUtilities
  24. def makeHarness(template: (String) => String, post: String)(f: File): File
    Definition Classes
    BackendCompilationUtilities
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def timeStamp: String
    Definition Classes
    BackendCompilationUtilities
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. def verilatorOnly: AnnotationSeq

    Use this to force a test to be run only with backends that are restricted to verilator backend

  32. def verilogToCpp(dutFile: String, dir: File, vSources: Seq[File], cppHarness: File, suppressVcd: Boolean = false, resourceFileName: String = firrtl.transforms.BlackBoxSourceHelper.defaultFileListName): ProcessBuilder
    Definition Classes
    BackendCompilationUtilities
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. case object VerilatorBackend extends Backend with Product with Serializable

Deprecated Value Members

  1. def compileFirrtlToVerilog(prefix: String, dir: File): Boolean

    Compile Chirrtl to Verilog by invoking Firrtl inside the same JVM

    Compile Chirrtl to Verilog by invoking Firrtl inside the same JVM

    prefix

    basename of the file

    dir

    directory where file lives

    returns

    true if compiler completed successfully

    Definition Classes
    BackendCompilationUtilities
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use ChiselStage instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped