Packages

c

spinal.lib

PackedBundle

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

Instance Constructors

  1. new PackedBundle()

Type Members

  1. implicit class DataPositionEnrich[T <: Data] extends AnyRef
  2. abstract type RefOwnerType
    Definition Classes
    OwnableRef
  3. class TagBitPackExact extends SpinalTag

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits
    Definition Classes
    Data
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def IFparent: Data
    Definition Classes
    Data
  7. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  8. def addAttribute(attribute: Attribute): PackedBundle.this.type
    Definition Classes
    Data → SpinalTagReady
  9. def addAttribute(name: String, value: Int): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String, value: String): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  11. def addAttribute(name: String): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  12. def addTag[T <: SpinalTag](spinalTag: T): PackedBundle.this.type
    Definition Classes
    MultiData → SpinalTagReady
  13. def addTags(h: SpinalTag, tail: SpinalTag*): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  14. def addTags[T <: SpinalTag](tags: Iterable[T]): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  15. def allowDirectionLessIo(): PackedBundle.this.type
    Definition Classes
    Data
  16. def allowOverride(): PackedBundle.this.type
    Definition Classes
    Data
  17. def allowPartialyAssigned(): PackedBundle.this.type
    Definition Classes
    Data
  18. def allowPruning(): PackedBundle.this.type
    Definition Classes
    Data
  19. def allowSimplifyIt(): PackedBundle.this.type
    Definition Classes
    Data
  20. def allowUnsetRegToAvoidLatch(): PackedBundle.this.type
    Definition Classes
    Data
  21. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  22. def asBits: Bits
    Definition Classes
    MultiData → Data
  23. def asData: Data
    Definition Classes
    Data
  24. def asInOut(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  25. def asInput(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  26. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  27. def asOutput(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  28. def assignAllByName(that: Bundle): Unit
    Definition Classes
    Bundle
  29. def assignDontCare(): PackedBundle.this.type
    Definition Classes
    Data
  30. def assignDontCareToUnasigned(): PackedBundle.this.type
    Definition Classes
    Data
  31. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  32. final def assignFrom(that: AnyRef, target: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Data
  33. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  34. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  35. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  36. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    Bundle → Assignable
  37. def assignSomeByName(that: Bundle): Unit
    Definition Classes
    Bundle
  38. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  39. def bundleAssign(that: Bundle)(f: (Data, Data) => Unit): Unit
    Definition Classes
    Bundle
  40. def checkDir(that: Bundle): Boolean
    Definition Classes
    Bundle
  41. def clearAll(): PackedBundle.this.type
    Definition Classes
    Data
  42. def clone(): Bundle
    Definition Classes
    Bundle → Data → AnyRef
  43. def component: Component
    Definition Classes
    ContextUser
  44. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  45. val compositeAssign: Assignable
    Definition Classes
    Assignable
  46. def copyDirectionOfImpl(that: Data): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  47. def dirString(): String
    Definition Classes
    Data
  48. def dontSimplifyIt(): PackedBundle.this.type
    Definition Classes
    Data
  49. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  50. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  51. def elementsString: String
    Definition Classes
    MultiData
  52. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  54. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  55. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  56. def find(name: String): Data
    Definition Classes
    MultiData
  57. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  58. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  59. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    MultiData → Data
  60. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  61. def flip(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  62. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  63. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  64. def freeze(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  65. def getAheadValue(): PackedBundle.this.type
    Definition Classes
    Data
  66. def getBitsWidth: Int
    Definition Classes
    MultiData → Data
  67. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  68. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  69. def getComponents(): Seq[Component]
    Definition Classes
    InComponent
  70. def getDirection: IODirection
    Definition Classes
    Data
  71. def getDisplayName(): String
    Definition Classes
    Nameable
  72. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  73. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  74. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  75. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  76. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  77. def getPackedWidth: Int
  78. def getPartialName(): String
    Definition Classes
    Nameable
  79. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  80. def getRealSource: Any
    Definition Classes
    Assignable
  81. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  82. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  83. def getRootParent: Data
    Definition Classes
    Data
  84. def getRtlPath(separator: String): String
    Definition Classes
    Data
  85. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  86. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  87. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  88. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  89. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  90. def getTypeString: String
    Definition Classes
    Bundle
  91. def getZero: PackedBundle.this.type
    Definition Classes
    MultiData → Data
  92. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  93. var hardtype: HardType[_]
    Definition Classes
    Bundle
  94. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  95. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  96. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  97. final def initFrom(that: AnyRef, target: AnyRef): Unit
    Definition Classes
    Data
  98. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  99. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  100. def isAnalog: Boolean
    Definition Classes
    Data
  101. def isComb: Boolean
    Definition Classes
    Data
  102. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  103. def isDirectionLess: Boolean
    Definition Classes
    Data
  104. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  105. def isInOut: Boolean
    Definition Classes
    Data
  106. def isInput: Boolean
    Definition Classes
    Data
  107. def isInputOrInOut: Boolean
    Definition Classes
    Data
  108. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  109. final def isNamed: Boolean
    Definition Classes
    Nameable
  110. def isOutput: Boolean
    Definition Classes
    Data
  111. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  112. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  113. def isReg: Boolean
    Definition Classes
    Data
  114. def isRegOnAssign: Boolean
    Definition Classes
    Data
  115. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  116. def mappings: ArrayBuffer[(Range, Data)]

    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. val name: String
    Definition Classes
    Nameable
  118. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  119. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  120. def noBackendCombMerge(): PackedBundle.this.type
    Definition Classes
    Data
  121. def noCombLoopCheck(): PackedBundle.this.type
    Definition Classes
    Data
  122. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  123. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  124. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  125. def overrideLocalName(name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  126. def packed: Bits
  127. val parent: Data
    Definition Classes
    Data
  128. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  129. def pull(propagateName: Boolean): PackedBundle.this.type
    Definition Classes
    Data
  130. def pull(): PackedBundle.this.type
    Definition Classes
    Data
  131. def purify(): PackedBundle.this.type
    Definition Classes
    Data
  132. def randBoot(u: Unit): PackedBundle.this.type
    Definition Classes
    Data
  133. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  134. def reflectNames(): Unit
    Definition Classes
    Nameable
  135. def removeAssignments(data: Boolean, init: Boolean, initial: Boolean): PackedBundle.this.type
    Definition Classes
    Data
  136. def removeDataAssignments(): PackedBundle.this.type
    Definition Classes
    Data
  137. def removeInitAssignments(): PackedBundle.this.type
    Definition Classes
    Data
  138. def removeTag(spinalTag: SpinalTag): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  139. def removeTags(tags: Iterable[SpinalTag]): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  140. def resized: PackedBundle.this.type
    Definition Classes
    Data
  141. def rootIF(): Interface
    Definition Classes
    Data
  142. def rootIFList(): List[Interface]
    Definition Classes
    Data
  143. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  144. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  145. def setAll(): PackedBundle.this.type
    Definition Classes
    Data
  146. def setAsAnalog(): PackedBundle.this.type
    Definition Classes
    Data
  147. def setAsComb(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  148. def setAsDirectionLess(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  149. def setAsReg(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  150. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  151. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  152. def setCompositeName(nameable: Nameable, postfix: String): PackedBundle.this.type
    Definition Classes
    Nameable
  153. def setCompositeName(nameable: Nameable, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  154. def setCompositeName(nameable: Nameable, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  155. def setCompositeName(nameable: Nameable): PackedBundle.this.type
    Definition Classes
    Nameable
  156. def setLambdaName(isNameBody: => Boolean)(nameGen: => String): PackedBundle.this.type
    Definition Classes
    Nameable
  157. def setName(name: String, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  158. def setName(name: String, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  159. def setName(name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  160. def setNameAsWeak(): PackedBundle.this.type
    Definition Classes
    Nameable
  161. def setOutputAsReg(): PackedBundle.this.type
    Definition Classes
    Data
  162. def setPartialName(name: String, namePriority: Byte, owner: Any): PackedBundle.this.type
    Definition Classes
    Nameable
  163. def setPartialName(name: String, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  164. def setPartialName(name: String, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  165. def setPartialName(owner: Nameable, name: String, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  166. def setPartialName(owner: Nameable, name: String, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  167. def setPartialName(name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  168. def setPartialName(owner: Nameable, name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  169. def setPartialName(owner: Nameable): PackedBundle.this.type
    Definition Classes
    Nameable
  170. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  171. def setScalaLocated(source: ScalaLocated): PackedBundle.this.type
    Definition Classes
    ScalaLocated
  172. def setWeakName(name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  173. def skipOver(count: BitCount): Unit

    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]
    Definition Classes
    SpinalTagReady
  175. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  176. def toIo(): PackedBundle.this.type
    Definition Classes
    Data
  177. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  178. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  179. def unfreeze(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  180. def unpack(bits: Bits, hi: Int, lo: Int): Unit
  181. def unpack(bits: Bits): Unit
  182. def unsetName(): PackedBundle.this.type
    Definition Classes
    Nameable
  183. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  184. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  185. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    PackedBundle → Bundle → ValCallbackRec
  186. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  187. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  188. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  189. def wrapNext(): PackedBundle.this.type
    Definition Classes
    Data
  190. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)]): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): PackedBundle.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  3. def genIf(cond: Boolean): PackedBundle.this.type
    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