Class

chisel3.core

Bundle

Related Doc: package core

Permalink

class Bundle extends Record

Base class for data types defined as a bundle of other data types.

Usage: extend this class (either as an anonymous or named class) and define members variables of Data subtypes to be elements in the Bundle.

Example of an anonymous IO bundle

class MyModule extends Module {
  val io = IO(new Bundle {
    val in = Input(UInt(64.W))
    val out = Output(SInt(128.W))
  })
}

Or as a named class

class Packet extends Bundle {
  val header = UInt(16.W)
  val addr   = UInt(16.W)
  val data   = UInt(32.W)
}
class MyModule extends Module {
   val io = IO(new Bundle {
     val inPacket = Input(new Packet)
     val outPacket = Output(new Packet)
   })
   val reg = Reg(new Packet)
   reg <> inPacket
   outPacket <> reg
}
Linear Supertypes
Record, Aggregate, Data, HasId, InstanceId, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bundle
  2. Record
  3. Aggregate
  4. Data
  5. HasId
  6. InstanceId
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bundle()(implicit compileOptions: CompileOptions)

    Permalink

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
    Definition Classes
    Data
  4. final def <>(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

    Permalink
    Definition Classes
    Data
  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.

    Definition Classes
    Data
    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.

    Definition Classes
    Data
    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
    Definition Classes
    Data
  10. def className: String

    Permalink

    Name for Pretty Printing

    Name for Pretty Printing

    Definition Classes
    BundleRecord
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def cloneType: Bundle.this.type

    Permalink

    Internal API; Chisel users should look at chisel3.chiselTypeOf(...).

    Internal API; Chisel users should look at chisel3.chiselTypeOf(...).

    cloneType must be defined for any Chisel object extending Data. It is responsible for constructing a basic copy of the object being cloned.

    returns

    a copy of the object.

    Definition Classes
    BundleData
  13. def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

    Permalink
    Definition Classes
    Data
  14. def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    AggregateData
  15. final lazy val elements: ListMap[String, Data]

    Permalink

    The collection of Data

    The collection of Data

    Elements defined earlier in the Bundle are higher order upon serialization. For example:

    Definition Classes
    BundleRecord
    Example:
    1. class MyBundle extends Bundle {
        val foo = UInt(16.W)
        val bar = UInt(16.W)
      }
      // Note that foo is higher order because its defined earlier in the Bundle
      val bundle = Wire(new MyBundle)
      bundle.foo := 0x1234.U
      bundle.bar := 0x5678.U
      val uint = bundle.asUInt
      assert(uint === "h12345678".U) // This will pass
  16. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. def getElements: Seq[Data]

    Permalink

    Returns a Seq of the immediate contents of this Aggregate, in order.

    Returns a Seq of the immediate contents of this Aggregate, in order.

    Definition Classes
    RecordAggregate
  21. final def getWidth: Int

    Permalink

    Returns the width, in bits, if currently known.

    Returns the width, in bits, if currently known.

    Definition Classes
    Data
    Exceptions thrown

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

  22. def hashCode(): Int

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

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

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

    Permalink
    Definition Classes
    Data
  26. final def isWidthKnown: Boolean

    Permalink

    Returns whether the width is currently known.

    Returns whether the width is currently known.

    Definition Classes
    Data
  27. def litArg(): Option[LitArg]

    Permalink
    Definition Classes
    Data
  28. def litValue(): BigInt

    Permalink
    Definition Classes
    Data
  29. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  32. def parentModName: String

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  37. def toPrintable: Printable

    Permalink

    Default "pretty-print" implementation Analogous to printing a Map Results in "Bundle(elt0.name -> elt0.value, ...)"

    Default "pretty-print" implementation Analogous to printing a Map Results in "Bundle(elt0.name -> elt0.value, ...)"

    Definition Classes
    BundleRecordData
    Note

    The order is reversed from the order of elements in order to print the fields in the order they were defined

  38. def toString(): String

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

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

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

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

    Permalink

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

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

    Definition Classes
    Data

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).

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

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

Inherited from Record

Inherited from Aggregate

Inherited from Data

Inherited from HasId

Inherited from InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped