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
  • BMCResult
  • BTORMCBackend
  • BasicWitness
  • BoundedCheck
  • Formal
  • FormalBackendAnnotation
  • Sat
  • Unsat
  • Witness

package formal

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.

Source
package.scala
Linear Supertypes
AnyRef, Any
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. formal
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract class BMCResult extends AnyRef

    Result of a Bounded Model Checking run

  2. case class BasicWitness(body: String) extends Witness with Product with Serializable

    Most basic type of witness: simply dumps the ouput from the BMC tool

  3. case class BoundedCheck(depth: Int) extends Product with Serializable

    Annotation placeholder for source compatibility only.

  4. trait Formal extends AnyRef
  5. abstract class FormalBackendAnnotation extends AnyRef

    Bounded Model Checking Backends supported by Formal.

    Bounded Model Checking Backends supported by Formal. Currently only BTORMC is supported.

  6. case class Sat[W <: Witness](witness: W) extends BMCResult with Product with Serializable
  7. abstract class Witness extends AnyRef

    counterexample object for a BMC run

Value Members

  1. def past[T <: Data](x: T): T
    Annotations
    @compileTimeOnly("chiseltest.formal.past is unsupported in this compatibility layer")
  2. def past[T <: Data](x: T, delay: Int = 1): T
    Annotations
    @compileTimeOnly("chiseltest.formal.past is unsupported in this compatibility layer")
  3. case object BTORMCBackend extends FormalBackendAnnotation with Product with Serializable
  4. case object Unsat extends BMCResult with Product with Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped