Packages

c

spinal.core

Union

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

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

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  18. def allowPruning(): Union.this.type
    Definition Classes
    Data
  19. def allowSimplifyIt(): Union.this.type
    Definition Classes
    Data
  20. 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
  21. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  22. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

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

    set a data as inout

    set a data as inout

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

    Set a data as input

    Set a data as input

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

    Set a data as output

    Set a data as output

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

    flip the direction of the data

    flip the direction of the data

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

    For a register, get the value it will have at the next clock, as a combinational signal.

    For a register, get the value it will have at the next clock, as a combinational signal.

    Definition Classes
    Data
  62. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

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

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  66. def getDirection: IODirection
    Definition Classes
    Data
  67. def getDisplayName(): String
    Definition Classes
    Nameable
  68. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  69. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  70. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  71. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  72. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  73. def getPartialName(): String
    Definition Classes
    Nameable
  74. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  75. def getRealSource: Any
    Definition Classes
    Assignable
  76. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  77. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  78. def getRootParent: Data
    Definition Classes
    Data
  79. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  80. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  81. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  82. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  83. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  84. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  85. def getZero: Union.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiData → Data
  86. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  87. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  88. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  89. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  90. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  91. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  92. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  93. def isAnalog: Boolean
    Definition Classes
    Data
  94. def isComb: Boolean
    Definition Classes
    Data
  95. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  96. def isDirectionLess: Boolean
    Definition Classes
    Data
  97. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  98. def isInOut: Boolean
    Definition Classes
    Data
  99. def isInput: Boolean
    Definition Classes
    Data
  100. def isInputOrInOut: Boolean
    Definition Classes
    Data
  101. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  102. final def isNamed: Boolean
    Definition Classes
    Nameable
  103. def isOutput: Boolean
    Definition Classes
    Data
  104. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  105. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  106. def isReg: Boolean
    Definition Classes
    Data
  107. def isRegOnAssign: Boolean
    Definition Classes
    Data
  108. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  109. val name: String
    Definition Classes
    Nameable
  110. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  111. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  112. def newElement[T <: Data](t: HardType[T]): UnionElement[T]
  113. 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
  114. 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
  115. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  116. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  117. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  118. def overrideLocalName(name: String): Union.this.type
    Definition Classes
    Nameable
  119. val parent: Data
    Definition Classes
    Data
  120. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  121. def postInitCallback(): Union.this.type
    Definition Classes
    Union → PostInitCallback
  122. def pull(propagateName: Boolean): Union.this.type
    Definition Classes
    Data
  123. 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
  124. def purify(): Union.this.type
    Definition Classes
    Data
  125. 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
  126. var raw: Bits
  127. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  128. def reflectNames(): Unit
    Definition Classes
    Nameable
  129. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Union.this.type
    Definition Classes
    Data
  130. def removeDataAssignments(): Union.this.type
    Definition Classes
    Data
  131. def removeInitAssignments(): Union.this.type
    Definition Classes
    Data
  132. def removeTag(spinalTag: SpinalTag): Union.this.type
    Definition Classes
    SpinalTagReady
  133. def removeTags(tags: Iterable[SpinalTag]): Union.this.type
    Definition Classes
    SpinalTagReady
  134. def resized: Union.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  135. def rootIF(): Interface

    root interface

    root interface

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

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiData → Data
  142. 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
  143. def setAsReg(): Union.this.type

    Set baseType to reg

    Set baseType to reg

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

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

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