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
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. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  7. def addAttribute(attribute: Attribute): PackedBundle.this.type
    Definition Classes
    Data → SpinalTagReady
  8. def addAttribute(name: String, value: Int): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  9. def addAttribute(name: String, value: String): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  11. def addTag[T <: SpinalTag](spinalTag: T): PackedBundle.this.type
    Definition Classes
    MultiData → SpinalTagReady
  12. def addTags[T <: SpinalTag](tags: Iterable[T]): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  13. def allowDirectionLessIo(): PackedBundle.this.type
    Definition Classes
    Data
  14. def allowOverride(): PackedBundle.this.type
    Definition Classes
    Data
  15. def allowPartialyAssigned(): PackedBundle.this.type
    Definition Classes
    Data
  16. def allowPruning(): PackedBundle.this.type
    Definition Classes
    Data
  17. def allowSimplifyIt(): PackedBundle.this.type
    Definition Classes
    Data
  18. def allowUnsetRegToAvoidLatch(): PackedBundle.this.type
    Definition Classes
    Data
  19. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  20. def asBits: Bits
    Definition Classes
    PackedBundle → MultiData → Data
  21. def asData: Data
    Definition Classes
    Data
  22. def asInOut(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  23. def asInput(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  24. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  25. def asOutput(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  26. def assignAllByName(that: Bundle): Unit
    Definition Classes
    Bundle
  27. def assignDontCare(): PackedBundle.this.type
    Definition Classes
    Data
  28. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  29. final def assignFrom(that: AnyRef, target: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Data
  30. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    PackedBundle → MultiData → Data
  31. def assignFromBits(bits: Bits): Unit
    Definition Classes
    PackedBundle → MultiData → Data
  32. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  33. def assignSomeByName(that: Bundle): Unit
    Definition Classes
    Bundle
  34. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  35. def bundleAssign(that: Bundle)(f: (Data, Data) => Unit): Unit
    Definition Classes
    Bundle
  36. def clone(): Bundle
    Definition Classes
    Bundle → Data → AnyRef
  37. def component: Component
    Definition Classes
    ContextUser
  38. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  39. val compositeAssign: Assignable
    Definition Classes
    Assignable
  40. def copyDirectionOfImpl(that: Data): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  41. def dirString(): String
    Definition Classes
    Data
  42. def dontSimplifyIt(): PackedBundle.this.type
    Definition Classes
    Data
  43. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  44. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  45. def elementsString: String
    Definition Classes
    MultiData
  46. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  48. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  49. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  50. def find(name: String): Data
    Definition Classes
    MultiData
  51. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  52. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  53. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    MultiData → Data
  54. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  55. def flip(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  56. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  57. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  58. def freeze(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  59. def genIf(cond: Boolean): PackedBundle.this.type
    Definition Classes
    Data
  60. def getAheadValue(): PackedBundle.this.type
    Definition Classes
    Data
  61. def getBitsWidth: Int
    Definition Classes
    PackedBundle → MultiData → Data
  62. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  63. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  64. def getComponents(): Seq[Component]
    Definition Classes
    InComponent
  65. def getDirection: IODirection
    Definition Classes
    Data
  66. def getDisplayName(): String
    Definition Classes
    Nameable
  67. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  68. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  69. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  70. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  71. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  72. def getPartialName(): String
    Definition Classes
    Nameable
  73. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  74. def getRealSource: Any
    Definition Classes
    Assignable
  75. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  76. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  77. def getRootParent: Data
    Definition Classes
    Data
  78. def getRtlPath(separator: String): String
    Definition Classes
    Data
  79. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  80. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  81. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  82. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  83. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  84. def getTypeString: String
    Definition Classes
    Bundle
  85. def getZero: PackedBundle.this.type
    Definition Classes
    MultiData → Data
  86. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  87. var hardtype: HardType[_]
    Definition Classes
    Bundle
  88. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  89. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  90. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  91. final def initFrom(that: AnyRef, target: AnyRef): Unit
    Definition Classes
    Data
  92. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  93. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  94. def isAnalog: Boolean
    Definition Classes
    Data
  95. def isComb: Boolean
    Definition Classes
    Data
  96. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  97. def isDirectionLess: Boolean
    Definition Classes
    Data
  98. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  99. def isInOut: Boolean
    Definition Classes
    Data
  100. def isInput: Boolean
    Definition Classes
    Data
  101. def isInputOrInOut: Boolean
    Definition Classes
    Data
  102. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  103. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  104. def isOutput: Boolean
    Definition Classes
    Data
  105. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  106. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  107. def isReg: Boolean
    Definition Classes
    Data
  108. def isRegOnAssign: Boolean
    Definition Classes
    Data
  109. def isUnnamed: Boolean
    Definition Classes
    Nameable
  110. val name: String
    Definition Classes
    Nameable
  111. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  112. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  113. def noBackendCombMerge(): PackedBundle.this.type
    Definition Classes
    Data
  114. def noCombLoopCheck(): PackedBundle.this.type
    Definition Classes
    Data
  115. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  116. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  117. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  118. def overrideLocalName(name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  119. val parent: Data
    Definition Classes
    Data
  120. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  121. def pull(propagateName: Boolean): PackedBundle.this.type
    Definition Classes
    Data
  122. def pull(): PackedBundle.this.type
    Definition Classes
    Data
  123. def purify(): PackedBundle.this.type
    Definition Classes
    Data
  124. def randBoot(u: Unit): PackedBundle.this.type
    Definition Classes
    Data
  125. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  126. def reflectNames(): Unit
    Definition Classes
    Nameable
  127. def removeAssignments(data: Boolean, init: Boolean, initial: Boolean): PackedBundle.this.type
    Definition Classes
    Data
  128. def removeDataAssignments(): PackedBundle.this.type
    Definition Classes
    Data
  129. def removeInitAssignments(): PackedBundle.this.type
    Definition Classes
    Data
  130. def removeTag(spinalTag: SpinalTag): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  131. def removeTags(tags: Iterable[SpinalTag]): PackedBundle.this.type
    Definition Classes
    SpinalTagReady
  132. def resized: PackedBundle.this.type
    Definition Classes
    Data
  133. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  134. def setAsAnalog(): PackedBundle.this.type
    Definition Classes
    Data
  135. def setAsComb(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  136. def setAsDirectionLess(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  137. def setAsReg(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  138. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  139. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  140. def setCompositeName(nameable: Nameable, postfix: String): PackedBundle.this.type
    Definition Classes
    Nameable
  141. def setCompositeName(nameable: Nameable, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  142. def setCompositeName(nameable: Nameable, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  143. def setCompositeName(nameable: Nameable): PackedBundle.this.type
    Definition Classes
    Nameable
  144. def setLambdaName(isNameBody: => Boolean)(nameGen: => String): PackedBundle.this.type
    Definition Classes
    Nameable
  145. def setName(name: String, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  146. def setName(name: String, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  147. def setName(name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  148. def setNameAsWeak(): PackedBundle.this.type
    Definition Classes
    Nameable
  149. def setPartialName(name: String, namePriority: Byte, owner: Any): PackedBundle.this.type
    Definition Classes
    Nameable
  150. def setPartialName(name: String, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  151. def setPartialName(name: String, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  152. def setPartialName(owner: Nameable, name: String, namePriority: Byte): PackedBundle.this.type
    Definition Classes
    Nameable
  153. def setPartialName(owner: Nameable, name: String, weak: Boolean): PackedBundle.this.type
    Definition Classes
    Nameable
  154. def setPartialName(name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  155. def setPartialName(owner: Nameable, name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  156. def setPartialName(owner: Nameable): PackedBundle.this.type
    Definition Classes
    Nameable
  157. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  158. def setScalaLocated(source: ScalaLocated): PackedBundle.this.type
    Definition Classes
    ScalaLocated
  159. def setWeakName(name: String): PackedBundle.this.type
    Definition Classes
    Nameable
  160. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  161. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  162. def toIo(): PackedBundle.this.type
    Definition Classes
    Data
  163. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  164. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  165. def unfreeze(): PackedBundle.this.type
    Definition Classes
    MultiData → Data
  166. def unsetName(): PackedBundle.this.type
    Definition Classes
    Nameable
  167. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  168. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  169. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  170. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  171. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  172. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  173. def wrapNext(): PackedBundle.this.type
    Definition Classes
    Data
  174. 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

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