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

testableBoolExt

implicit final class testableBoolExt extends AnyVal

Source
package.scala
Linear Supertypes
AnyVal, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. testableBoolExt
  2. AnyVal
  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 testableBoolExt(x: Bool)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from testableBoolExt toany2stringadd[testableBoolExt] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (testableBoolExt, B)
    Implicit
    This member is added by an implicit conversion from testableBoolExt toArrowAssoc[testableBoolExt] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def ensuring(cond: (testableBoolExt) => Boolean, msg: => Any): testableBoolExt
    Implicit
    This member is added by an implicit conversion from testableBoolExt toEnsuring[testableBoolExt] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (testableBoolExt) => Boolean): testableBoolExt
    Implicit
    This member is added by an implicit conversion from testableBoolExt toEnsuring[testableBoolExt] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => Any): testableBoolExt
    Implicit
    This member is added by an implicit conversion from testableBoolExt toEnsuring[testableBoolExt] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): testableBoolExt
    Implicit
    This member is added by an implicit conversion from testableBoolExt toEnsuring[testableBoolExt] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def expect(value: Boolean): Unit
  12. def expect(value: Bool): Unit
  13. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def peek(): Bool
  16. def peekBoolean(): Boolean
  17. def poke(value: Boolean): Unit
  18. def poke(value: Bool): Unit
  19. def toString(): String
    Definition Classes
    Any
  20. val x: Bool

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from testableBoolExt toStringFormat[testableBoolExt] 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): (testableBoolExt, B)
    Implicit
    This member is added by an implicit conversion from testableBoolExt toArrowAssoc[testableBoolExt] 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 AnyVal

Inherited from Any

Inherited by implicit conversion any2stringadd fromtestableBoolExt to any2stringadd[testableBoolExt]

Inherited by implicit conversion StringFormat fromtestableBoolExt to StringFormat[testableBoolExt]

Inherited by implicit conversion Ensuring fromtestableBoolExt to Ensuring[testableBoolExt]

Inherited by implicit conversion ArrowAssoc fromtestableBoolExt to ArrowAssoc[testableBoolExt]

Ungrouped