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, 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 chiseltest

    ChiselTest Compatibility Layer for Chisel 7

    ChiselTest Compatibility Layer for Chisel 7

    This package provides a drop-in replacement for the ChiselTest library that was removed in Chisel 7. It preserves the familiar ChiselTest API while delegating to Chisel 7's ChiselSim underneath.

    Usage:

    import chiseltest._
    import org.scalatest.flatspec.AnyFlatSpec
    
    class MyTest extends AnyFlatSpec with ChiselScalatestTester {
      it should "work" in {
        test(new MyModule) { dut =>
          dut.io.in.poke(42.U)
          dut.clock.step()
          dut.io.out.expect(42.U)
        }
      }
    }

    Key Components: - testableData, testableUInt, testableBoolExt: Implicit conversions for poke/peek/expect - testableClock: Clock stepping and control - DecoupledIOOps: Utilities for Decoupled interface testing - ChiselScalatestTester: ScalaTest integration trait

    See README.md for detailed documentation.

    Definition Classes
    root
  • package formal

    Formal compatibility API placeholders.

    Formal compatibility API placeholders.

    Formal verification is currently unsupported in this compatibility layer. Any usage should fail at compile time to avoid vacuously passing tests.

    Definition Classes
    chiseltest
  • ChiselScalatestTester
  • DecoupledDriver
  • DecoupledIOOps
  • ForkHandle
  • VerilatorBackendAnnotation
  • WriteVcdAnnotation
  • testableBoolExt
  • testableClock
  • testableData
  • testableReset
  • testableUInt
c

chiseltest

DecoupledDriver

final class DecoupledDriver extends AnyRef

Compatibility placeholder for ChiselTest's DecoupledDriver class.

Decoupled enqueue/dequeue helpers are provided via implicit extensions in package object chiseltest. Use import chiseltest._ to access: - enqueueNow, enqueueSeq - expectDequeueNow, expectDequeueSeq - initSource, initSink

Source
DecoupledDriver.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DecoupledDriver
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DecoupledDriver()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from DecoupledDriver toany2stringadd[DecoupledDriver] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DecoupledDriver, B)
    Implicit
    This member is added by an implicit conversion from DecoupledDriver toArrowAssoc[DecoupledDriver] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (DecoupledDriver) => Boolean, msg: => Any): DecoupledDriver
    Implicit
    This member is added by an implicit conversion from DecoupledDriver toEnsuring[DecoupledDriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (DecoupledDriver) => Boolean): DecoupledDriver
    Implicit
    This member is added by an implicit conversion from DecoupledDriver toEnsuring[DecoupledDriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): DecoupledDriver
    Implicit
    This member is added by an implicit conversion from DecoupledDriver toEnsuring[DecoupledDriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): DecoupledDriver
    Implicit
    This member is added by an implicit conversion from DecoupledDriver toEnsuring[DecoupledDriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DecoupledDriver toStringFormat[DecoupledDriver] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (DecoupledDriver, B)
    Implicit
    This member is added by an implicit conversion from DecoupledDriver toArrowAssoc[DecoupledDriver] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDecoupledDriver to any2stringadd[DecoupledDriver]

Inherited by implicit conversion StringFormat fromDecoupledDriver to StringFormat[DecoupledDriver]

Inherited by implicit conversion Ensuring fromDecoupledDriver to Ensuring[DecoupledDriver]

Inherited by implicit conversion ArrowAssoc fromDecoupledDriver to ArrowAssoc[DecoupledDriver]

Ungrouped