Class

chisel3.core

Data

Related Doc: package core

Permalink

abstract class Data extends HasId

This forms the root of the type system for wire data types. The data value must be representable as some number (need not be known at Chisel compile time) of bits, and must have methods to pack / unpack structured data to / from bits.

Linear Supertypes
HasId, InstanceId, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Data
  2. HasId
  3. InstanceId
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Data()

    Permalink

Abstract Value Members

  1. abstract def cloneType: Data.this.type

    Permalink

    cloneType must be defined for any Chisel object extending Data.

    cloneType must be defined for any Chisel object extending Data. It is responsible for constructing a basic copy of the object being cloned. If cloneType needs to recursively clone elements of an object, it should call the cloneType methods on those elements.

    returns

    a copy of the object.

  2. abstract def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  3. abstract def toPrintable: Printable

    Permalink

    Default pretty printing

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def :=(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

    Permalink
  4. final def <>(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

    Permalink
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. macro def asTypeOf[T <: Data](that: T): T

    Permalink

    Does a reinterpret cast of the bits in this node into the format that provides.

    Does a reinterpret cast of the bits in this node into the format that provides. Returns a new Wire of that type. Does not modify existing nodes.

    x.asTypeOf(that) performs the inverse operation of x = that.toBits.

    Note

    that should have known widths

    ,

    bit widths are NOT checked, may pad or drop bits from input

  8. final macro def asUInt(): UInt

    Permalink

    Reinterpret cast to UInt.

    Reinterpret cast to UInt.

    Note

    Aggregates are recursively packed with the first element appearing in the least-significant bits of the result.

    ,

    value not guaranteed to be preserved: for example, a SInt of width 3 and value -1 (0b111) would become an UInt with value 7

  9. def binding_=(target: Binding): Unit

    Permalink
    Attributes
    protected
  10. def chiselCloneType: Data.this.type

    Permalink

    chiselCloneType is called at the top-level of a clone chain.

    chiselCloneType is called at the top-level of a clone chain. It calls the client's cloneType() method to construct a basic copy of the object being cloned, then performs any fixups required to reconstruct the appropriate core state of the cloned object.

    returns

    a copy of the object with appropriate core state.

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

    Permalink
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def getWidth: Int

    Permalink

    Returns the width, in bits, if currently known.

    Returns the width, in bits, if currently known.

    Exceptions thrown

    java.util.NoSuchElementException if the width is not known.

  18. def hashCode(): Int

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  19. def instanceName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def isLit(): Boolean

    Permalink
  22. final def isWidthKnown: Boolean

    Permalink

    Returns whether the width is currently known.

  23. def litArg(): Option[LitArg]

    Permalink
  24. def litValue(): BigInt

    Permalink
  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def parentModName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  29. def parentPathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  30. def pathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  31. def suggestName(name: ⇒ String): Data.this.type

    Permalink
    Definition Classes
    HasId
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def widthOption: Option[Int]

    Permalink

    Returns Some(width) if the width is known, else None.

Deprecated Value Members

  1. def toBits(implicit compileOptions: CompileOptions): UInt

    Permalink

    Packs the value of this object as plain Bits.

    Packs the value of this object as plain Bits.

    This performs the inverse operation of fromBits(Bits).

    Annotations
    @deprecated
    Deprecated

    (Since version chisel3) Best alternative, .asUInt()

Inherited from HasId

Inherited from InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped