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
  • object Data
    Definition Classes
    chisel3
  • AsReadOnly
  • ConnectableDefault
  • ConnectableVecDefault
  • DataEquality
c

chisel3.Data

DataEquality

implicit class DataEquality[T <: Data] extends AnyRef

Provides generic, recursive equality for Bundle and Vec hardware. This avoids the need to use workarounds such as bundle1.asUInt === bundle2.asUInt by allowing users to instead write bundle1 === bundle2.

Static type safety of this comparison is guaranteed at compile time as the extension method requires the same parameterized type for both the left-hand and right-hand sides. It is, however, possible to get around this type safety using Bundle subtypes that can differ during runtime (e.g. through a generator). These cases are subsequently raised as elaboration errors.

Source
Data.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataEquality
  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 DataEquality(lhs: T)(implicit sourceInfo: SourceInfo)

    lhs

    The Data hardware on the left-hand side of the equality

Value Members

  1. def ===(rhs: T): Bool

    Dynamic recursive equality operator for generic Data

    Dynamic recursive equality operator for generic Data

    rhs

    a hardware Data to compare lhs to

    returns

    a hardware Bool asserted if lhs is equal to rhs

    Exceptions thrown

    ChiselException when lhs and rhs are different types during elaboration time