Class

spinal.core

Union

Related Doc: package core

Permalink

class Union extends MultiData with PostInitCallback

Linear Supertypes
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)

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Permalink

    Concatenation between two data

    Concatenation between two data

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

    Permalink
    Definition Classes
    DataSpinalTagReady
  8. def addAttribute(name: String, value: Int): Union.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  9. def addAttribute(name: String, value: String): Union.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String): Union.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  11. def addTag[T <: SpinalTag](spinalTag: T): Union.this.type

    Permalink
    Definition Classes
    MultiDataSpinalTagReady
  12. def addTags[T <: SpinalTag](tags: Iterable[T]): Union.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  13. def allowDirectionLessIo(): Union.this.type

    Permalink

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

    Permalink

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

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

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

    Permalink
    Definition Classes
    Data
  17. def allowSimplifyIt(): Union.this.type

    Permalink
    Definition Classes
    Data
  18. def allowUnsetRegToAvoidLatch(): Union.this.type

    Permalink

    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
  19. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  20. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  21. def asData: Data

    Permalink
    Definition Classes
    Data
  22. def asInOut(): Union.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    MultiDataData
  23. def asInput(): Union.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    MultiDataData
  24. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  25. def asOutput(): Union.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    MultiDataData
  26. def assignDontCare(): Union.this.type

    Permalink
    Definition Classes
    Data
  27. def assignDontCareToUnasigned(): Union.this.type

    Permalink
    Definition Classes
    Data
  28. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiDataData
  29. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Data
  30. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Permalink
    Definition Classes
    MultiDataData
  31. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiDataData
  32. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Permalink
    Definition Classes
    Data
  33. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    UnionAssignable
  34. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData
  35. def build(): Unit

    Permalink
  36. def clearAll(): Union.this.type

    Permalink
    Definition Classes
    Data
  37. def clone(): Data

    Permalink
    Definition Classes
    Data → AnyRef
  38. def component: Component

    Permalink
    Definition Classes
    ContextUser
  39. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assignable
  40. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable
  41. def copyDirectionOfImpl(that: Data): Union.this.type

    Permalink
    Definition Classes
    MultiDataData
  42. def dirString(): String

    Permalink
    Definition Classes
    Data
  43. def dontSimplifyIt(): Union.this.type

    Permalink
    Definition Classes
    Data
  44. def elements: ArrayBuffer[(String, Data)]

    Permalink
    Definition Classes
    UnionMultiData
  45. def elementsString: String

    Permalink
    Definition Classes
    MultiData
  46. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  47. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  48. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  49. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  50. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData
  51. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  52. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiDataData
  53. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    MultiDataData
  54. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiDataData
  55. def flip(): Union.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiDataData
  56. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  57. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  58. def freeze(): Union.this.type

    Permalink
    Definition Classes
    MultiDataData
  59. def getAheadValue(): Union.this.type

    Permalink
    Definition Classes
    Data
  60. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiDataData
  61. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  62. def getComponent(): Component

    Permalink
    Definition Classes
    DataInComponentNameableByComponent
  63. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  64. def getDirection: IODirection

    Permalink
    Definition Classes
    Data
  65. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  66. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  67. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  68. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

    Permalink
    Definition Classes
    Data
  69. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  70. def getName(): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  71. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  72. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  73. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  74. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    DataAssignable
  75. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  76. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  77. def getRtlPath(separator: String = "/"): String

    Permalink
    Definition Classes
    Data
  78. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  79. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  80. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  81. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady
  82. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  83. def getZero: Union.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  84. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  85. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  86. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  87. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  88. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  89. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  90. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  91. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  92. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  93. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  94. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  95. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  96. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  97. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  98. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  99. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  100. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  101. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  102. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  103. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  104. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  105. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  106. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  107. var name: String

    Permalink
    Definition Classes
    Nameable
  108. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  109. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  110. def newElement[T <: Data](t: HardType[T]): UnionElement[T]

    Permalink
  111. def noBackendCombMerge(): Union.this.type

    Permalink

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

    Permalink

    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
  113. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  114. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  115. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  116. def overrideLocalName(name: String): Union.this.type

    Permalink
    Definition Classes
    Nameable
  117. var parent: Data

    Permalink
    Definition Classes
    Data
  118. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  119. def postInitCallback(): Union.this.type

    Permalink
    Definition Classes
    Union → PostInitCallback
  120. def pull(propagateName: Boolean): Union.this.type

    Permalink
    Definition Classes
    Data
  121. def pull(): Union.this.type

    Permalink

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

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

    Definition Classes
    Data
  122. def purify(): Union.this.type

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

    Permalink

    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
  124. var raw: Bits

    Permalink
  125. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  126. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  127. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Union.this.type

    Permalink
    Definition Classes
    Data
  128. def removeDataAssignments(): Union.this.type

    Permalink
    Definition Classes
    Data
  129. def removeInitAssignments(): Union.this.type

    Permalink
    Definition Classes
    Data
  130. def removeTag(spinalTag: SpinalTag): Union.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  131. def removeTags(tags: Iterable[SpinalTag]): Union.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  132. def resized: Union.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  133. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  134. def setAll(): Union.this.type

    Permalink
    Definition Classes
    Data
  135. def setAsAnalog(): Union.this.type

    Permalink
    Definition Classes
    Data
  136. def setAsComb(): Union.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  137. def setAsDirectionLess(): Union.this.type

    Permalink

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

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

    Definition Classes
    MultiDataData
  138. def setAsReg(): Union.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiDataData
  139. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Union.this.type

    Permalink
    Definition Classes
    Nameable
  140. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Union.this.type

    Permalink
    Definition Classes
    Nameable
  141. def setCompositeName(nameable: Nameable, postfix: String): Union.this.type

    Permalink
    Definition Classes
    Nameable
  142. def setCompositeName(nameable: Nameable, namePriority: Byte): Union.this.type

    Permalink
    Definition Classes
    Nameable
  143. def setCompositeName(nameable: Nameable, weak: Boolean): Union.this.type

    Permalink
    Definition Classes
    Nameable
  144. def setCompositeName(nameable: Nameable): Union.this.type

    Permalink
    Definition Classes
    Nameable
  145. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Union.this.type

    Permalink
    Definition Classes
    Nameable
  146. def setName(name: String, namePriority: Byte): Union.this.type

    Permalink
    Definition Classes
    Nameable
  147. def setName(name: String, weak: Boolean): Union.this.type

    Permalink
    Definition Classes
    Nameable
  148. def setName(name: String): Union.this.type

    Permalink
    Definition Classes
    Nameable
  149. def setNameAsWeak(): Union.this.type

    Permalink
    Definition Classes
    Nameable
  150. def setPartialName(name: String, namePriority: Byte, owner: Any): Union.this.type

    Permalink
    Definition Classes
    Nameable
  151. def setPartialName(name: String, namePriority: Byte): Union.this.type

    Permalink
    Definition Classes
    Nameable
  152. def setPartialName(name: String, weak: Boolean): Union.this.type

    Permalink
    Definition Classes
    Nameable
  153. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Union.this.type

    Permalink
    Definition Classes
    Nameable
  154. def setPartialName(owner: Nameable, name: String, weak: Boolean): Union.this.type

    Permalink
    Definition Classes
    Nameable
  155. def setPartialName(name: String): Union.this.type

    Permalink
    Definition Classes
    Nameable
  156. def setPartialName(owner: Nameable, name: String): Union.this.type

    Permalink
    Definition Classes
    Nameable
  157. def setPartialName(owner: Nameable): Union.this.type

    Permalink
    Definition Classes
    Nameable
  158. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  159. def setScalaLocated(source: ScalaLocated): Union.this.type

    Permalink
    Definition Classes
    ScalaLocated
  160. def setWeakName(name: String): Union.this.type

    Permalink
    Definition Classes
    Nameable
  161. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  162. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  163. def toIo(): Union.this.type

    Permalink
    Definition Classes
    Data
  164. def toMuxInput[T <: Data](muxOutput: T): T

    Permalink
    Definition Classes
    Data
  165. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  166. val uTypes: ArrayBuffer[UnionElement[Data]]

    Permalink
  167. def unfreeze(): Union.this.type

    Permalink
    Definition Classes
    MultiDataData
  168. def unsetName(): Union.this.type

    Permalink
    Definition Classes
    Nameable
  169. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  170. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  171. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  172. def wrapNext(): Union.this.type

    Permalink
    Definition Classes
    Data
  173. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]

    Permalink
    Definition Classes
    MultiData

Deprecated Value Members

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

    Permalink

    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