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 chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package experimental

    Package for experimental features, which may have their API changed, be removed, etc.

    Package for experimental features, which may have their API changed, be removed, etc.

    Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

    Definition Classes
    chisel3
  • package dataview
    Definition Classes
    experimental
  • package hierarchy
    Definition Classes
    experimental
  • package inlinetest
    Definition Classes
    experimental
  • HasTests
  • TestHarness
  • TestHarnessGenerator
  • TestHarnessWithResult
  • TestParameters
  • TestResultBundle
  • package util
    Definition Classes
    experimental

package inlinetest

Content Hierarchy
Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. trait HasTests extends AnyRef

    Provides methods to build unit testharnesses inline after this module is elaborated.

  2. abstract class TestHarness[M <: RawModule, R] extends FixedIOModule[TestResultBundle] with Public

    TestHarnesses for inline tests should extend this.

    TestHarnesses for inline tests should extend this. This abstract class sets the correct desiredName for the module, instantiates the DUT, and provides methods to generate the test. The resetType matches that of the DUT, or is Synchronous if it must be inferred (this can be overriden).

    A TestHarness has the following ports:

    - clock: shall be driven at a constant frequency by the simulation. - reset: shall be asserted for one cycle from the first positive edge of clock by the simulation. - reset: shall be asserted for one cycle from the first positive edge of clock by the simulation. - finish: the test shall be considered complete on the first positive edge of finish.

    M

    the type of the DUT module

    R

    the type of the result returned by the test body

  3. trait TestHarnessGenerator[M <: RawModule, R] extends AnyRef

    An implementation of a testharness generator.

    An implementation of a testharness generator. This is a type class that defines how to generate a testharness. It is passed to each invocation of HasTests.test.

    M

    the type of the DUT module

    R

    the type of the result returned by the test body

  4. abstract class TestHarnessWithResult[M <: RawModule] extends TestHarness[M, TestResultBundle]

    TestHarnesses for inline tests should extend this.

    TestHarnesses for inline tests should extend this. This abstract class sets the correct desiredName for the module, instantiates the DUT, and provides methods to generate the test. The resetType matches that of the DUT, or is Synchronous if it must be inferred (this can be overriden).

    M

    the type of the DUT module

  5. final class TestParameters[M <: RawModule, R] extends AnyRef

    Per-test parametrization needed to build a testharness that instantiates the DUT and elaborates a test body.

    Per-test parametrization needed to build a testharness that instantiates the DUT and elaborates a test body.

    M

    the type of the DUT module

    R

    the type of the result returned by the test body

  6. final class TestResultBundle extends Bundle

    IO that reports the status of the test implemented by a testharness.

Value Members

  1. object TestHarnessGenerator

Ungrouped