Class

spinal.lib

PackedWordBundle

Related Doc: package lib

Permalink

class PackedWordBundle extends PackedBundle

An enhanced form of PackedBundle with Word-centric packing. Offers all the same implicit packing assignment functions, but applies packing to an assigned word. - inWord(WordIndex) - Indicates which word to pack into. Must be used after a pack assigment. If no pack range was given then the entire data length will be assumed. Ranges that exceed the word will wrap into subsequent words.

Like PackedBundle, providing no pack or word assignments will place data immediately after the last.

Example: 

  1. val wordPacked = PackedWordBundle(8 bits) {
  val aNumber = UInt(8 bits).word(0) // Bits 7 downto 0
  val bNumber = UInt(8 bits).pack(0 to 7).word(1) // Bits 8 to 15
  val large   = Bits(18 bits).word(2) // Bits 33 downto 16
  val flag    = Bool() // Bit 34
Linear Supertypes
PackedBundle, 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. PackedWordBundle
  2. PackedBundle
  3. Bundle
  4. ValCallbackRec
  5. ValCallback
  6. MultiData
  7. Data
  8. InComponent
  9. OverridedEqualsHashCode
  10. SpinalTagReady
  11. Assignable
  12. NameableByComponent
  13. Nameable
  14. OwnableRef
  15. ContextUser
  16. ScalaLocated
  17. GlobalDataUser
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PackedWordBundle(wordWidth: BitCount)

    Permalink

    wordWidth

    Width of a word, as BitCount

Type Members

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

    Permalink
    Definition Classes
    PackedBundle

  2. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  3. class TagBitPackExact extends SpinalTag

    Permalink
    Definition Classes
    PackedBundle

  4. implicit class WordEnrich[T <: Data] extends AnyRef

    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): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data → SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    MultiData → SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  18. def allowUnsetRegToAvoidLatch(): PackedWordBundle.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(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  24. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    MultiData → Data

  26. def assignAllByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    Data

  28. def assignDontCareToUnasigned(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  29. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

  32. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Attributes
    protected
    Definition Classes
    Bundle → Assignable

  35. def assignSomeByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  36. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    Bundle

  38. def clearAll(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  39. def clone(): Bundle

    Permalink
    Definition Classes
    Bundle → Data → AnyRef

  40. def component: Component

    Permalink
    Definition Classes
    ContextUser

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

    Permalink
    Definition Classes
    Assignable

  42. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable

  43. def copyDirectionOfImpl(that: Data): PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  44. def dirString(): String

    Permalink
    Definition Classes
    Data

  45. def dontSimplifyIt(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Bundle → MultiData

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

    Permalink
    Definition Classes
    Bundle

  48. def elementsString: String

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    AnyRef

  50. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  53. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    SpinalTagReady

  55. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  57. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiData → Data

  58. def flip(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    SpinalTagReady

  61. def freeze(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  62. def getAheadValue(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  63. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  65. def getComponent(): Component

    Permalink
    Definition Classes
    Data → InComponent → NameableByComponent

  66. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    InComponent

  67. def getDirection: IODirection

    Permalink
    Definition Classes
    Data

  68. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  69. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  70. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

  72. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  73. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  74. def getPackedWidth: Int

    Permalink
    Definition Classes
    PackedBundle

  75. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    NameableByComponent

  77. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  78. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  79. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  80. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  81. def getRtlPath(separator: String): String

    Permalink
    Definition Classes
    Data

  82. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  83. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  84. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    SpinalTagReady

  86. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  87. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  88. def getZero: PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  89. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  90. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    SpinalTagReady

  92. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  93. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

  96. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  97. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  98. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  99. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  100. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  101. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  102. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  103. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  104. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  105. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  106. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  107. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  108. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  109. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  110. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  111. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data

  112. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

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

    Definition Classes
    PackedBundle

  114. var name: String

    Permalink
    Definition Classes
    Nameable

  115. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

  117. def noBackendCombMerge(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  118. def noCombLoopCheck(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  119. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  120. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    SpinalTagReady

  122. def overrideLocalName(name: String): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  123. def packed: Bits

    Permalink
    Definition Classes
    PackedBundle

  124. var parent: Data

    Permalink
    Definition Classes
    Data

  125. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  126. def pull(propagateName: Boolean): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  127. def pull(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  128. def purify(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  129. def randBoot(u: Unit): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  130. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  131. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

  132. def removeAssignments(data: Boolean, init: Boolean, initial: Boolean): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  133. def removeDataAssignments(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  134. def removeInitAssignments(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  135. def removeTag(spinalTag: SpinalTag): PackedWordBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  136. def removeTags(tags: Iterable[SpinalTag]): PackedWordBundle.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  137. def resized: PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  138. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated

  139. def setAll(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  140. def setAsAnalog(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  141. def setAsComb(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  142. def setAsDirectionLess(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  143. def setAsReg(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

  144. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  145. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  146. def setCompositeName(nameable: Nameable, postfix: String): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  147. def setCompositeName(nameable: Nameable, namePriority: Byte): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  148. def setCompositeName(nameable: Nameable, weak: Boolean): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  149. def setCompositeName(nameable: Nameable): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  150. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  151. def setName(name: String, namePriority: Byte): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  152. def setName(name: String, weak: Boolean): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  153. def setName(name: String): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  154. def setNameAsWeak(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  155. def setOutputAsReg(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

  156. def setPartialName(name: String, namePriority: Byte, owner: Any): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  157. def setPartialName(name: String, namePriority: Byte): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  158. def setPartialName(name: String, weak: Boolean): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  159. def setPartialName(owner: Nameable, name: String, namePriority: Byte): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  160. def setPartialName(owner: Nameable, name: String, weak: Boolean): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  161. def setPartialName(name: String): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  162. def setPartialName(owner: Nameable, name: String): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  163. def setPartialName(owner: Nameable): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  164. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

  165. def setScalaLocated(source: ScalaLocated): PackedWordBundle.this.type

    Permalink
    Definition Classes
    ScalaLocated

  166. def setWeakName(name: String): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

  167. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    AnyRef

  169. def toIo(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  171. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

  172. def unfreeze(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    PackedBundle

  174. def unpack(bits: Bits): Unit

    Permalink
    Definition Classes
    PackedBundle

  175. def unsetName(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback

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

    Permalink
    Definition Classes
    ValCallbackRec

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

    Permalink
    Definition Classes
    PackedBundle → Bundle → ValCallbackRec

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

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

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

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

  181. final def wait(): Unit

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

  182. def wrapNext(): PackedWordBundle.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): PackedWordBundle.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): PackedWordBundle.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 PackedBundle

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