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. def IFparent: Data

    Permalink
    Definition Classes
    Data

  7. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Data → SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    MultiData → SpinalTagReady

  13. def addTags(h: SpinalTag, tail: SpinalTag*): PackedBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  22. def asBits: Bits

    Permalink
    Definition Classes
    MultiData → Data

  23. def asData: Data

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  26. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    MultiData → Data

  28. def assignAllByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    Data

  30. def assignDontCareToUnasigned(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  31. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

  34. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

  36. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Bundle → Assignable

  37. def assignSomeByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  38. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    Bundle

  40. def checkDir(that: Bundle): Boolean

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    Data

  42. def clone(): Bundle

    Permalink
    Definition Classes
    Bundle → Data → AnyRef

  43. def component: Component

    Permalink
    Definition Classes
    ContextUser

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

    Permalink
    Definition Classes
    Assignable

  45. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable

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

    Permalink
    Definition Classes
    MultiData → Data

  47. def dirString(): String

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Bundle → MultiData

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

    Permalink
    Definition Classes
    Bundle

  51. def elementsString: String

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    AnyRef

  53. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  56. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    SpinalTagReady

  58. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  60. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

  66. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  68. def getComponent(): Component

    Permalink
    Definition Classes
    Data → InComponent → NameableByComponent

  69. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    InComponent

  70. def getDirection: IODirection

    Permalink
    Definition Classes
    Data

  71. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  72. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  73. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

  75. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  76. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  77. def getPackedWidth: Int

    Permalink

  78. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    NameableByComponent

  80. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  81. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  82. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  83. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  84. def getRtlPath(separator: String): String

    Permalink
    Definition Classes
    Data

  85. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  86. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  87. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    SpinalTagReady

  89. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  90. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  91. def getZero: PackedBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  92. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  93. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    SpinalTagReady

  95. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  96. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

  99. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  100. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  101. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  102. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  103. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  104. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  105. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  106. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  107. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  108. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  109. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable

  110. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  111. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  112. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  113. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  114. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data

  115. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

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

  117. var name: String

    Permalink
    Definition Classes
    Nameable

  118. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  122. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  123. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Nameable

  126. def packed: Bits

    Permalink

  127. var parent: Data

    Permalink
    Definition Classes
    Data

  128. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  133. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  134. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  140. def resized: PackedBundle.this.type

    Permalink
    Definition Classes
    Data

  141. def rootIF(): Interface

    Permalink
    Definition Classes
    Data

  142. def rootIFList(): List[Interface]

    Permalink
    Definition Classes
    Data

  143. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]

    Permalink
    Definition Classes
    Data

  144. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  161. def setOutputAsReg(): PackedBundle.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  170. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

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

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Nameable

  173. def skipOver(count: BitCount): Unit

    Permalink

    Skips over the specified number of bits.

    Skips over the specified number of bits. The next unspecified field will be placed starting count number of bits after the last placed field.

    count

    Number of bits to skip over

    Attributes
    protected

  174. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  178. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink

  181. def unpack(bits: Bits): Unit

    Permalink

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback

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

    Permalink
    Definition Classes
    ValCallbackRec

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

    Permalink
    Definition Classes
    PackedBundle → Bundle → ValCallbackRec

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

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

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

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

  188. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    Data

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