Class

spinal.lib

PackedBundle

Related Doc: package lib

Permalink

class PackedBundle extends Bundle

Similar to Bundle but with bit packing capabilities. Use pack implicit functions to assign fields to bit locations - pack(Range, [Endianness]) - Packs the data into Range aligning to bit Endianness if too wide - packFrom(Position) - Packs the data starting (LSB) at Position. Uses full data length - packTo(Position) - Packs the data ending (MSB) at Position. Uses full data length

Providing no location tag will place the next data value immediately after the last.

Example: 

  1. val regWord = new PackedBundle {
  val init = Bool().packFrom(0) // Bit 0
  val stop = Bool() // Bit 1
  val result = Bits(16 bit).packTo(31) // Bits 16 to 31
}
Linear Supertypes
Bundle, ValCallbackRec, ValCallback, MultiData, Data, InComponent, OverridedEqualsHashCode, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, ScalaLocated, GlobalDataUser, AnyRef, Any
Known Subclasses
PackedWordBundle
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PackedBundle
  2. Bundle
  3. ValCallbackRec
  4. ValCallback
  5. MultiData
  6. Data
  7. InComponent
  8. OverridedEqualsHashCode
  9. SpinalTagReady
  10. Assignable
  11. NameableByComponent
  12. Nameable
  13. OwnableRef
  14. ContextUser
  15. ScalaLocated
  16. GlobalDataUser
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PackedBundle()

    Permalink

Type Members

  1. implicit class DataPositionEnrich[T <: Data] extends AnyRef

    Permalink

  2. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  3. class TagBitPackExact extends SpinalTag

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. def ##(right: Data): Bits

    Permalink
    Definition Classes
    Data

  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  4. def #*(count: Int): Bits

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  7. def addAttribute(attribute: Attribute): PackedBundle.this.type

    Permalink
    Definition Classes
    Data → SpinalTagReady

  8. def addAttribute(name: String, value: Int): PackedBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  9. def addAttribute(name: String, value: String): PackedBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  10. def addAttribute(name: String): PackedBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  11. def addTag[T <: SpinalTag](spinalTag: T): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → SpinalTagReady

  12. def addTags[T <: SpinalTag](tags: Iterable[T]): PackedBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  13. def allowDirectionLessIo(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  14. def allowOverride(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  15. def allowPartialyAssigned(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  16. def allowPruning(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  17. def allowSimplifyIt(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  18. def allowUnsetRegToAvoidLatch(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  19. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data

  20. def asBits: Bits

    Permalink
    Definition Classes
    MultiData → Data

  21. def asData: Data

    Permalink
    Definition Classes
    Data

  22. def asInOut(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  23. def asInput(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  24. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  25. def asOutput(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  26. def assignAllByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  27. def assignDontCare(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  28. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiData → Data

  29. final def assignFrom(that: AnyRef, target: AnyRef)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Data

  30. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Permalink
    Definition Classes
    MultiData → Data

  31. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiData → Data

  32. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Permalink
    Definition Classes
    Data

  33. def assignSomeByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  34. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData

  35. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Bundle

  36. def clearAll(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  37. def clone(): Bundle

    Permalink
    Definition Classes
    Bundle → Data → AnyRef

  38. def component: Component

    Permalink
    Definition Classes
    ContextUser

  39. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assignable

  40. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable

  41. def copyDirectionOfImpl(that: Data): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  42. def dirString(): String

    Permalink
    Definition Classes
    Data

  43. def dontSimplifyIt(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  44. def elements: ArrayBuffer[(String, Data)]

    Permalink
    Definition Classes
    Bundle → MultiData

  45. var elementsCache: ArrayBuffer[(String, Data)]

    Permalink
    Definition Classes
    Bundle

  46. def elementsString: String

    Permalink
    Definition Classes
    MultiData

  47. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  48. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

  49. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  50. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  51. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData

  52. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  53. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiData → Data

  54. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    MultiData → Data

  55. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiData → Data

  56. def flip(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  57. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable

  58. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady

  59. def freeze(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  60. def getAheadValue(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  61. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

  62. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  63. def getComponent(): Component

    Permalink
    Definition Classes
    Data → InComponent → NameableByComponent

  64. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    InComponent

  65. def getDirection: IODirection

    Permalink
    Definition Classes
    Data

  66. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  67. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  68. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  69. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

    Permalink
    Definition Classes
    Data

  70. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  71. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  72. def getPackedWidth: Int

    Permalink

  73. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

  74. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent

  75. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  76. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  77. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  78. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  79. def getRtlPath(separator: String): String

    Permalink
    Definition Classes
    Data

  80. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  81. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  82. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

  83. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady

  84. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  85. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  86. def getZero: PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  87. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  88. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

  89. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  90. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  91. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

  92. final def initFrom(that: AnyRef, target: AnyRef): Unit

    Permalink
    Definition Classes
    Data

  93. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  94. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  95. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  96. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  97. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  98. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  99. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  100. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  101. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  102. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  103. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  104. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  105. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  106. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  107. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  108. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  109. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data

  110. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  111. def mappings: ArrayBuffer[(Range, Data)]

    Permalink

    Gets the mappings of Range to Data for this PackedBundle

    Gets the mappings of Range to Data for this PackedBundle

    returns

    Seq of (Range,Data) for all elements

  112. var name: String

    Permalink
    Definition Classes
    Nameable

  113. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  114. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  115. def noBackendCombMerge(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  116. def noCombLoopCheck(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  117. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  118. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  119. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady

  120. def overrideLocalName(name: String): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  121. def packed: Bits

    Permalink

  122. var parent: Data

    Permalink
    Definition Classes
    Data

  123. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  124. def pull(propagateName: Boolean): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  125. def pull(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  126. def purify(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  127. def randBoot(u: Unit): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  128. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  129. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

  130. def removeAssignments(data: Boolean, init: Boolean, initial: Boolean): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  131. def removeDataAssignments(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  132. def removeInitAssignments(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  133. def removeTag(spinalTag: SpinalTag): PackedBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  134. def removeTags(tags: Iterable[SpinalTag]): PackedBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  135. def resized: PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  136. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated

  137. def setAll(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  138. def setAsAnalog(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  139. def setAsComb(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  140. def setAsDirectionLess(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  141. def setAsReg(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  142. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  143. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  144. def setCompositeName(nameable: Nameable, postfix: String): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  145. def setCompositeName(nameable: Nameable, namePriority: Byte): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  146. def setCompositeName(nameable: Nameable, weak: Boolean): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  147. def setCompositeName(nameable: Nameable): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  148. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  149. def setName(name: String, namePriority: Byte): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  150. def setName(name: String, weak: Boolean): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  151. def setName(name: String): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  152. def setNameAsWeak(): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  153. def setPartialName(name: String, namePriority: Byte, owner: Any): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  154. def setPartialName(name: String, namePriority: Byte): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  155. def setPartialName(name: String, weak: Boolean): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  156. def setPartialName(owner: Nameable, name: String, namePriority: Byte): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  157. def setPartialName(owner: Nameable, name: String, weak: Boolean): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  158. def setPartialName(name: String): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  159. def setPartialName(owner: Nameable, name: String): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  160. def setPartialName(owner: Nameable): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  161. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

  162. def setScalaLocated(source: ScalaLocated): PackedBundle.this.type

    Permalink
    Definition Classes
    ScalaLocated

  163. def setWeakName(name: String): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  164. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  165. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  166. def toIo(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  167. def toMuxInput[T <: Data](muxOutput: T): T

    Permalink
    Definition Classes
    Data

  168. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

  169. def unfreeze(): PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  170. def unpack(bits: Bits, hi: Int, lo: Int): Unit

    Permalink

  171. def unpack(bits: Bits): Unit

    Permalink

  172. def unsetName(): PackedBundle.this.type

    Permalink
    Definition Classes
    Nameable

  173. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback

  174. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec

  175. def valCallbackRec(ref: Any, name: String): Unit

    Permalink
    Definition Classes
    PackedBundle → Bundle → ValCallbackRec

  176. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  177. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  178. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  179. def wrapNext(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  180. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)]): ArrayBuffer[(BaseType, BaseType)]

    Permalink
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  3. def genIf(cond: Boolean): PackedBundle.this.type

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

Inherited from Bundle

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from MultiData

Inherited from Data

Inherited from InComponent

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped