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 signals

    Concatenation between two signals

    Definition Classes
    Data
  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits

    Permalink

    Return the count time concatenation of the signal.

    Return the count time concatenation of the signal.

    Definition Classes
    Data
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def IFparent: Data

    Permalink
    Definition Classes
    Data
  7. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  8. def addAttribute(attribute: Attribute): Union.this.type

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

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

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

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

    Permalink
    Definition Classes
    MultiDataSpinalTagReady
  13. def addTags(h: SpinalTag, tail: SpinalTag*): Union.this.type

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

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

    Permalink

    Allow a signal of an io Bundle to be directionless.

    Allow a signal of an io Bundle to be directionless.

    Definition Classes
    Data
    See also

    IO Bundle Error Documentation

  16. def allowOverride(): Union.this.type

    Permalink

    Allow a signal to be overridden.

    Allow a signal to be overridden.

    Definition Classes
    Data
    See also

    Assignment overlap Error Documentation

  17. def allowPartialyAssigned(): Union.this.type

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

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

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

    Permalink
    Definition Classes
    Data
  20. 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)

    Definition Classes
    Data
    See also

    "Register with only init" Error Documentation

  21. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  22. def asBits: Bits

    Permalink

    Cast signal to Bits

    Cast signal to Bits

    Definition Classes
    MultiDataData
  23. def asData: Data

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

    Permalink

    Set a signal as inout

    Set a signal as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

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

    Permalink

    Assign the default 'x' value to all signals composing this type.

    Assign the default 'x' value to all signals composing this type.

    Definition Classes
    Data
    See also

    "Don't care term" wikipedia article

    Data type documentation

  29. def assignDontCareToUnasigned(): Union.this.type

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

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

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

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

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

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

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

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

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

    Permalink

    Clear all bits to False and return itself

    Clear all bits to False and return itself

    Definition Classes
    Data
  39. def clone(): Data

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

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

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

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

    Permalink
    Definition Classes
    UnionMultiData
  47. def elementsString: String

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

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

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

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

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

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

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

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

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

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

    Permalink

    Flip the direction of the signal.

    Flip the direction of the signal.

    in and out are swapped, inout stay the same.

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

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

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

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

    Permalink

    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

    Permalink

    Return the width of the data

    Return the width of the data

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

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  66. def getDirection: IODirection

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

    Permalink
    Definition Classes
    Nameable
  68. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  69. def getMode: Byte

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

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

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

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

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

    Permalink
    Definition Classes
    NameableByComponent
  75. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  76. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  78. def getRootParent: Data

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

    Permalink
    Definition Classes
    Data
  80. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  81. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  85. def getTagsOf[T <: SpinalTag]()(implicit tag: ClassTag[T]): Iterable[T]

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

    Permalink

    Create a signal set to 0

    Create a signal set to 0

    Definition Classes
    MultiDataData
  87. var globalData: GlobalData

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  94. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  95. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  96. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  97. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  98. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  99. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  100. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  101. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  103. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  104. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  105. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  107. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  108. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  109. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  110. var name: String

    Permalink
    Definition Classes
    Nameable
  111. var nameableRef: Nameable

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

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

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

    Permalink

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    Definition Classes
    Data
    See also

    Combinatorial loop Error Documentation

  116. final def notify(): Unit

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

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

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

    Permalink
    Definition Classes
    Nameable
  120. var parent: Data

    Permalink
    Definition Classes
    Data
  121. var parentScope: ScopeStatement

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

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

    Permalink
    Definition Classes
    Data
  124. 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
  125. def purify(): Union.this.type

    Permalink
    Definition Classes
    Data
  126. 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
  127. var raw: Bits

    Permalink
  128. var refOwner: RefOwnerType

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

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

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

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

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

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

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

    Permalink

    Return a version of the signal which is allowed to be automatically resized where needed.

    Return a version of the signal which is allowed to be automatically resized where needed.

    The resize operation is deferred until the point of assignment later. The resize may widen or truncate, retaining the LSB.

    Definition Classes
    Data
    See also

    Width checking Documentation

  136. def rootIF(): Interface

    Permalink

    root interface

    root interface

    Definition Classes
    Data
  137. def rootIFList(): List[Interface]

    Permalink
    Definition Classes
    Data
  138. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]

    Permalink
    Definition Classes
    Data
  139. var scalaTrace: Throwable

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

    Permalink

    Set all bits to True and return itself

    Set all bits to True and return itself

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

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    Permalink

    Remove the direction (in, out, inout) to a signal

    Remove the direction (in, out, inout) to a signal

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

    Permalink

    Set baseType to reg

    Set baseType to reg

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  156. def setOutputAsReg(): Union.this.type

    Permalink

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  157. def setPartialName(name: String, namePriority: Byte, owner: Any): Union.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Data
  180. 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