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 data 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 flatten: Seq[BaseType]

    Permalink
  5. abstract def flattenLocalName: Seq[String]

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

    Permalink
  7. abstract def getBitsWidth: Int

    Permalink

    Return the width of the data

  8. abstract def getZero: Data.this.type

    Permalink

    Create a data set to 0

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

    Permalink

    Set baseType to Combinatorial

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

    Permalink

    Set baseType to reg

  11. 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 data

  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. var _spinalTags: LinkedHashSet[SpinalTag]

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  13. def allowDirectionLessIo(): Data.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

  14. def allowOverride(): Data.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

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

    Permalink

    Allow a register to be partially assigned

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

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

    Permalink
  18. 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 https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

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

    Permalink
  20. def asData: Data

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

    Permalink

    set a data as inout

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

    Permalink

    Set a data as input

  23. final def asInstanceOf[T0]: T0

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

    Permalink

    Set a data as output

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

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

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

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

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

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

    Permalink
  31. def clone(): Data

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

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

    Permalink
    Definition Classes
    Assignable
  34. var compositeAssign: Assignable

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

    Permalink
  36. def dirString(): String

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

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

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

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

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

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

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

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

    Permalink

    flip the direction of the data

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

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

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

    Permalink
  48. final def getClass(): Class[_]

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  51. def getDirection: IODirection

    Permalink
  52. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  53. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  54. def getMode: Byte

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

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

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

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

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

    Permalink
    Definition Classes
    NameableByComponent
  60. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  61. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  63. def getRootParent: Data

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

    Permalink
  65. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  66. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  70. val globalData: GlobalData

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  77. def isAnalog: Boolean

    Permalink
  78. def isComb: Boolean

    Permalink
  79. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  80. def isDirectionLess: Boolean

    Permalink
  81. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  82. def isInOut: Boolean

    Permalink
  83. def isInput: Boolean

    Permalink
  84. def isInputOrInOut: Boolean

    Permalink
  85. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  86. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  87. def isOutput: Boolean

    Permalink
  88. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  90. def isReg: Boolean

    Permalink
  91. def isRegOnAssign: Boolean

    Permalink
  92. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  93. var name: String

    Permalink
    Definition Classes
    Nameable
  94. var nameableRef: Nameable

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

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

    Permalink

    Put the combinatorial logic driving this signal in a separate process

  97. def noCombLoopCheck(): Data.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

  98. final def notify(): Unit

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

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

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

    Permalink
    Definition Classes
    Nameable
  102. var parent: Data

    Permalink
  103. var parentScope: ScopeStatement

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

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

    Permalink

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

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

    Permalink
  107. 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)

  108. var refOwner: RefOwnerType

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  115. def resized: Data.this.type

    Permalink

    Resized data regarding target

  116. var scalaTrace: Throwable

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

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

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

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  146. def toString(): String

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  151. 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