Packages

class Union extends MultiData with PostInitCallback

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Union
  2. PostInitCallback
  3. MultiData
  4. Data
  5. InComponent
  6. OverridedEqualsHashCode
  7. SpinalTagReady
  8. Assignable
  9. NameableByComponent
  10. Nameable
  11. OwnableRef
  12. ContextUser
  13. ScalaLocated
  14. GlobalDataUser
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Union(selfBuild: Boolean = true)

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Concatenation between two data

    Concatenation between two data

    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): Union.this.type
    Definition Classes
    Data → SpinalTagReady
  8. def addAttribute(name: String, value: Int): Union.this.type
    Definition Classes
    SpinalTagReady
  9. def addAttribute(name: String, value: String): Union.this.type
    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String): Union.this.type
    Definition Classes
    SpinalTagReady
  11. def addTag[T <: SpinalTag](spinalTag: T): Union.this.type
    Definition Classes
    MultiData → SpinalTagReady
  12. def addTags(h: SpinalTag, tail: SpinalTag*): Union.this.type
    Definition Classes
    SpinalTagReady
  13. def addTags[T <: SpinalTag](tags: Iterable[T]): Union.this.type
    Definition Classes
    SpinalTagReady
  14. def allowDirectionLessIo(): Union.this.type

    Allow a Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

    Definition Classes
    Data
  15. def allowOverride(): Union.this.type

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  16. def allowPartialyAssigned(): Union.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  17. def allowPruning(): Union.this.type
    Definition Classes
    Data
  18. def allowSimplifyIt(): Union.this.type
    Definition Classes
    Data
  19. def allowUnsetRegToAvoidLatch(): Union.this.type

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

    Definition Classes
    Data
  20. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  21. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiData → Data
  22. def asData: Data
    Definition Classes
    Data
  23. def asInOut(): Union.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    MultiData → Data
  24. def asInput(): Union.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    MultiData → Data
  25. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  26. def asOutput(): Union.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    MultiData → Data
  27. def assignDontCare(): Union.this.type
    Definition Classes
    Data
  28. def assignDontCareToUnasigned(): Union.this.type
    Definition Classes
    Data
  29. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  30. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  31. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  32. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  33. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  34. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    Union → Assignable
  35. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  36. def build(): Unit
  37. def clearAll(): Union.this.type
    Definition Classes
    Data
  38. def clone(): Data
    Definition Classes
    Data → AnyRef
  39. def component: Component
    Definition Classes
    ContextUser
  40. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  41. val compositeAssign: Assignable
    Definition Classes
    Assignable
  42. def copyDirectionOfImpl(that: Data): Union.this.type
    Definition Classes
    MultiData → Data
  43. def dirString(): String
    Definition Classes
    Data
  44. def dontSimplifyIt(): Union.this.type
    Definition Classes
    Data
  45. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Union → MultiData
  46. def elementsString: String
    Definition Classes
    MultiData
  47. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  49. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  50. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  51. def find(name: String): Data
    Definition Classes
    MultiData
  52. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  53. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  54. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    MultiData → Data
  55. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  56. def flip(): Union.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiData → Data
  57. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  58. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  59. def freeze(): Union.this.type
    Definition Classes
    MultiData → Data
  60. def getAheadValue(): Union.this.type
    Definition Classes
    Data
  61. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiData → Data
  62. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  63. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  64. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    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 getZero: Union.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiData → Data
  85. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  86. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  87. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  88. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  89. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  90. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  91. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  92. def isAnalog: Boolean
    Definition Classes
    Data
  93. def isComb: Boolean
    Definition Classes
    Data
  94. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  95. def isDirectionLess: Boolean
    Definition Classes
    Data
  96. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  97. def isInOut: Boolean
    Definition Classes
    Data
  98. def isInput: Boolean
    Definition Classes
    Data
  99. def isInputOrInOut: Boolean
    Definition Classes
    Data
  100. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  101. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  102. def isOutput: Boolean
    Definition Classes
    Data
  103. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  104. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  105. def isReg: Boolean
    Definition Classes
    Data
  106. def isRegOnAssign: Boolean
    Definition Classes
    Data
  107. def isUnnamed: Boolean
    Definition Classes
    Nameable
  108. val name: String
    Definition Classes
    Nameable
  109. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  110. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  111. def newElement[T <: Data](t: HardType[T]): UnionElement[T]
  112. def noBackendCombMerge(): Union.this.type

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

    Definition Classes
    Data
  113. def noCombLoopCheck(): Union.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  114. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  115. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  116. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  117. def overrideLocalName(name: String): Union.this.type
    Definition Classes
    Nameable
  118. val parent: Data
    Definition Classes
    Data
  119. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  120. def postInitCallback(): Union.this.type
    Definition Classes
    Union → PostInitCallback
  121. def pull(propagateName: Boolean): Union.this.type
    Definition Classes
    Data
  122. def pull(): Union.this.type

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  123. def purify(): Union.this.type
    Definition Classes
    Data
  124. def randBoot(u: Unit): Union.this.type

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Definition Classes
    Data
  125. var raw: Bits
  126. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  127. def reflectNames(): Unit
    Definition Classes
    Nameable
  128. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Union.this.type
    Definition Classes
    Data
  129. def removeDataAssignments(): Union.this.type
    Definition Classes
    Data
  130. def removeInitAssignments(): Union.this.type
    Definition Classes
    Data
  131. def removeTag(spinalTag: SpinalTag): Union.this.type
    Definition Classes
    SpinalTagReady
  132. def removeTags(tags: Iterable[SpinalTag]): Union.this.type
    Definition Classes
    SpinalTagReady
  133. def resized: Union.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  134. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  135. def rootIFList(): List[Interface]
    Definition Classes
    Data
  136. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  137. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  138. def setAll(): Union.this.type
    Definition Classes
    Data
  139. def setAsAnalog(): Union.this.type
    Definition Classes
    Data
  140. def setAsComb(): Union.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiData → Data
  141. def setAsDirectionLess(): Union.this.type

    remove the direction (in,out,inout) to a data

    remove the direction (in,out,inout) to a data

    Definition Classes
    MultiData → Data
  142. def setAsReg(): Union.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiData → Data
  143. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Union.this.type
    Definition Classes
    Nameable
  144. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Union.this.type
    Definition Classes
    Nameable
  145. def setCompositeName(nameable: Nameable, postfix: String): Union.this.type
    Definition Classes
    Nameable
  146. def setCompositeName(nameable: Nameable, namePriority: Byte): Union.this.type
    Definition Classes
    Nameable
  147. def setCompositeName(nameable: Nameable, weak: Boolean): Union.this.type
    Definition Classes
    Nameable
  148. def setCompositeName(nameable: Nameable): Union.this.type
    Definition Classes
    Nameable
  149. def setLambdaName(isNameBody: => Boolean)(nameGen: => String): Union.this.type
    Definition Classes
    Nameable
  150. def setName(name: String, namePriority: Byte): Union.this.type
    Definition Classes
    Nameable
  151. def setName(name: String, weak: Boolean): Union.this.type
    Definition Classes
    Nameable
  152. def setName(name: String): Union.this.type
    Definition Classes
    Nameable
  153. def setNameAsWeak(): Union.this.type
    Definition Classes
    Nameable
  154. def setOutputAsReg(): Union.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  155. def setPartialName(name: String, namePriority: Byte, owner: Any): Union.this.type
    Definition Classes
    Nameable
  156. def setPartialName(name: String, namePriority: Byte): Union.this.type
    Definition Classes
    Nameable
  157. def setPartialName(name: String, weak: Boolean): Union.this.type
    Definition Classes
    Nameable
  158. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Union.this.type
    Definition Classes
    Nameable
  159. def setPartialName(owner: Nameable, name: String, weak: Boolean): Union.this.type
    Definition Classes
    Nameable
  160. def setPartialName(name: String): Union.this.type
    Definition Classes
    Nameable
  161. def setPartialName(owner: Nameable, name: String): Union.this.type
    Definition Classes
    Nameable
  162. def setPartialName(owner: Nameable): Union.this.type
    Definition Classes
    Nameable
  163. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  164. def setScalaLocated(source: ScalaLocated): Union.this.type
    Definition Classes
    ScalaLocated
  165. def setWeakName(name: String): Union.this.type
    Definition Classes
    Nameable
  166. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  167. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  168. def toIo(): Union.this.type
    Definition Classes
    Data
  169. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  170. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  171. val uTypes: ArrayBuffer[UnionElement[Data]]
  172. def unfreeze(): Union.this.type
    Definition Classes
    MultiData → Data
  173. def unsetName(): Union.this.type
    Definition Classes
    Nameable
  174. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  175. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  176. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  177. def wrapNext(): Union.this.type
    Definition Classes
    Data
  178. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): Union.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): Union.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

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

Inherited from PostInitCallback

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