Trait/Object

spinal.core

Data

Related Docs: object Data | package core

Permalink

trait Data extends ContextUser with NameableByComponent with Assignable with SpinalTagReady with GlobalDataUser with ScalaLocated with OwnableRef with OverridedEqualsHashCode with InComponent

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Data
  2. InComponent
  3. OverridedEqualsHashCode
  4. SpinalTagReady
  5. Assignable
  6. NameableByComponent
  7. Nameable
  8. OwnableRef
  9. ContextUser
  10. ScalaLocated
  11. GlobalDataUser
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Abstract Value Members

  1. abstract def asBits: Bits

    Permalink

    Cast signal to Bits

  2. abstract def assignFromBits(bits: Bits, hi: Int, low: Int): Unit

    Permalink
  3. abstract def assignFromBits(bits: Bits): Unit

    Permalink
  4. abstract def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Assignable
  5. abstract def flatten: Seq[BaseType]

    Permalink
  6. abstract def flattenLocalName: Seq[String]

    Permalink
  7. abstract def freeze(): Data.this.type

    Permalink
  8. abstract def getBitsWidth: Int

    Permalink

    Return the width of the data

  9. abstract def getZero: Data.this.type

    Permalink

    Create a signal set to 0

  10. abstract def setAsComb(): Data.this.type

    Permalink

    Set baseType to Combinatorial

  11. abstract def setAsReg(): Data.this.type

    Permalink

    Set baseType to reg

  12. abstract def unfreeze(): Data.this.type

    Permalink

Concrete Value Members

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

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

    Permalink

    Concatenation between two signals

  3. final def ##(): Int

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

    Permalink
  5. final def ==(arg0: Any): Boolean

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

    Permalink
  7. var _spinalTags: LinkedHashSet[SpinalTag]

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

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

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

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

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

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

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

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

    Permalink

    Allow a signal of an io Bundle to be directionless.

    Allow a signal of an io Bundle to be directionless.

    See also

    IO Bundle Error Documentation

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

    Permalink

    Allow a signal to be overridden.

    Allow a signal to be overridden.

    See also

    Assignment overlap Error Documentation

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

    Permalink

    Allow a register to be partially assigned

  18. def allowPruning(): Data.this.type

    Permalink
  19. def allowSimplifyIt(): Data.this.type

    Permalink
  20. def allowUnsetRegToAvoidLatch(): Data.this.type

    Permalink

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

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

    See also

    "Register with only init" Error Documentation

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

    Permalink
  22. def asData: Data

    Permalink
  23. def asInOut(): Data.this.type

    Permalink

    Set a signal as inout

  24. def asInput(): Data.this.type

    Permalink

    Set a data as input

  25. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  26. def asOutput(): Data.this.type

    Permalink

    Set a data as output

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

    Permalink
  28. def assignDontCareToUnasigned(): Data.this.type

    Permalink
  29. def assignFormalRandom(kind: RandomExpKind): Unit

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

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

    Permalink
  32. def clearAll(): Data.this.type

    Permalink
  33. def clone(): Data

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

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

    Permalink
    Definition Classes
    Assignable
  36. var compositeAssign: Assignable

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

    Permalink
  38. def dirString(): String

    Permalink
  39. def dontSimplifyIt(): Data.this.type

    Permalink
  40. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  45. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
  46. def flip(): Data.this.type

    Permalink

    Flip the direction of the signal.

    Flip the direction of the signal.

    in and out are swapped, inout stay the same.

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  49. def getAheadValue(): Data.this.type

    Permalink

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

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

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  53. def getDirection: IODirection

    Permalink
  54. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  55. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  56. def getMode: Byte

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

    Permalink
  58. def getName(default: String): String

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

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

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

    Permalink
    Definition Classes
    NameableByComponent
  62. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  63. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  65. def getRootParent: Data

    Permalink
  66. def getRtlPath(separator: String = "/"): String

    Permalink
  67. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  68. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  72. var globalData: GlobalData

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  79. def isAnalog: Boolean

    Permalink
  80. def isComb: Boolean

    Permalink
  81. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  82. def isDirectionLess: Boolean

    Permalink
  83. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  84. def isInOut: Boolean

    Permalink
  85. def isInput: Boolean

    Permalink
  86. def isInputOrInOut: Boolean

    Permalink
  87. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  88. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  89. def isOutput: Boolean

    Permalink
  90. def isOutputOrInOut: Boolean

    Permalink
  91. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  92. def isReg: Boolean

    Permalink
  93. def isRegOnAssign: Boolean

    Permalink
  94. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  95. var name: String

    Permalink
    Definition Classes
    Nameable
  96. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  98. def noBackendCombMerge(): Data.this.type

    Permalink

    Put the combinatorial logic driving this signal in a separate process

  99. def noCombLoopCheck(): Data.this.type

    Permalink

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See also

    Combinatorial loop Error Documentation

  100. final def notify(): Unit

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  103. def overrideLocalName(name: String): Data.this.type

    Permalink
    Definition Classes
    Nameable
  104. var parent: Data

    Permalink
  105. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  106. def pull(propagateName: Boolean): Data.this.type

    Permalink
  107. def pull(): Data.this.type

    Permalink

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

  108. def purify(): Data.this.type

    Permalink
  109. def randBoot(u: Unit): Data.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)

  110. var refOwner: RefOwnerType

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

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

    Permalink
  113. def removeDataAssignments(): Data.this.type

    Permalink
  114. def removeInitAssignments(): Data.this.type

    Permalink
  115. def removeTag(spinalTag: SpinalTag): Data.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  117. def resized: Data.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.

    See also

    Width checking Documentation

  118. def rootIF(): Interface

    Permalink

    root interface

  119. def rootIFList(): List[Interface]

    Permalink
  120. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]

    Permalink
  121. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  122. def setAll(): Data.this.type

    Permalink
  123. def setAsAnalog(): Data.this.type

    Permalink
  124. def setAsDirectionLess(): Data.this.type

    Permalink

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

  125. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Data.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  130. def setCompositeName(nameable: Nameable): Data.this.type

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

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

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

    Permalink
    Definition Classes
    Nameable
  134. def setName(name: String): Data.this.type

    Permalink
    Definition Classes
    Nameable
  135. def setNameAsWeak(): Data.this.type

    Permalink
    Definition Classes
    Nameable
  136. def setOutputAsReg(): Data.this.type

    Permalink

    Recursively set baseType to reg only for output

  137. def setPartialName(name: String, namePriority: Byte, owner: Any): Data.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  142. def setPartialName(name: String): Data.this.type

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

    Permalink
    Definition Classes
    Nameable
  144. def setPartialName(owner: Nameable): Data.this.type

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

    Permalink
    Definition Classes
    OwnableRef
  146. def setScalaLocated(source: ScalaLocated): Data.this.type

    Permalink
    Definition Classes
    ScalaLocated
  147. def setWeakName(name: String): Data.this.type

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

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

    Permalink
    Definition Classes
    AnyRef
  150. def toIo(): Data.this.type

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

    Permalink
  152. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  153. def unsetName(): Data.this.type

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  157. def wrapNext(): Data.this.type

    Permalink

Deprecated Value Members

  1. def asDirectionLess(): Data.this.type

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

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Annotations
    @deprecated
    Deprecated

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

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