Class

spinal.core

XFix

Related Doc: package core

Permalink

abstract class XFix[T <: XFix[T, R], R <: BitVector with Num[R]] extends MultiData with MinMaxDecimalProvider

Base class for SFix and UFix

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XFix
  2. MinMaxDecimalProvider
  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 XFix(maxExp: Int, bitCount: Int)

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Abstract Value Members

  1. abstract def fixFactory(maxExp: ExpNumber, resolution: ExpNumber): T

    Permalink
  2. abstract def fixFactory(maxExp: ExpNumber, bitCount: BitCount): T

    Permalink
  3. abstract def fixFactory(exp: Int, bitCount: Int): T

    Permalink
  4. abstract def maxValue: BigDecimal

    Permalink
    Definition Classes
    MinMaxDecimalProvider
  5. abstract def minExp: Int

    Permalink
  6. abstract def minValue: BigDecimal

    Permalink
    Definition Classes
    MinMaxDecimalProvider
  7. abstract def rawFactory(exp: Int, bitCount: Int): R

    Permalink
  8. abstract def resolution: BigDecimal

    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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  13. def alignLsb(that: T): (R, R)

    Permalink
  14. def allowDirectionLessIo(): XFix.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
  15. def allowOverride(): XFix.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
  16. def allowPartialyAssigned(): XFix.this.type

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  17. def allowPruning(): XFix.this.type

    Permalink
    Definition Classes
    Data
  18. def allowSimplifyIt(): XFix.this.type

    Permalink
    Definition Classes
    Data
  19. def allowUnsetRegToAvoidLatch(): XFix.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
  20. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  21. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  22. def asData: Data

    Permalink
    Definition Classes
    Data
  23. def asInOut(): XFix.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    MultiDataData
  24. def asInput(): XFix.this.type

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    MultiDataData
  27. def assignDontCare(): XFix.this.type

    Permalink
    Definition Classes
    Data
  28. def assignDontCareToUnasigned(): XFix.this.type

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    XFixAssignable
  35. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData
  36. def autoConnect(that: Data)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    XFixMultiDataData
  37. val bitCount: Int

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

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

    Permalink
    Definition Classes
    MultiDataData
  44. def difLsb(that: T): Int

    Permalink
  45. def dirString(): String

    Permalink
    Definition Classes
    Data
  46. def doAddSub(that: T, sub: Boolean): T

    Permalink
  47. def doShiftLeft(that: Int): T

    Permalink
  48. def doShiftLeftBorned(that: Int): T

    Permalink
  49. def doShiftRight(that: Int): T

    Permalink
  50. def doShiftRightBorned(that: Int): T

    Permalink
  51. def doSmaller(that: T): Bool

    Permalink
  52. def doSmallerEguals(that: T): Bool

    Permalink
  53. def dontSimplifyIt(): XFix.this.type

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

    Permalink
    Definition Classes
    XFixMultiData
  55. def elementsString: String

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    MultiDataData
  65. def flip(): XFix.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  68. def freeze(): XFix.this.type

    Permalink
    Definition Classes
    MultiDataData
  69. def getAheadValue(): XFix.this.type

    Permalink
    Definition Classes
    Data
  70. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  74. def getDirection: IODirection

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

    Permalink
    Definition Classes
    Nameable
  76. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  77. def getMode: Byte

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

    Permalink
    Definition Classes
    XFixData
  79. def getName(default: String): String

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

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

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

    Permalink
    Definition Classes
    NameableByComponent
  83. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  84. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  86. def getRootParent: Data

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

    Permalink
    Definition Classes
    Data
  88. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  89. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  93. def getZero: XFix.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  94. var globalData: GlobalData

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  101. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  102. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  103. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  104. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  105. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  106. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  107. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  108. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  110. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  111. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  112. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  114. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  115. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  116. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  117. val maxExp: Int

    Permalink
  118. var name: String

    Permalink
    Definition Classes
    Nameable
  119. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  121. def noBackendCombMerge(): XFix.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
  122. def noCombLoopCheck(): XFix.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
  123. final def notify(): Unit

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  126. def overrideLocalName(name: String): XFix.this.type

    Permalink
    Definition Classes
    Nameable
  127. var parent: Data

    Permalink
    Definition Classes
    Data
  128. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  129. def pull(propagateName: Boolean): XFix.this.type

    Permalink
    Definition Classes
    Data
  130. def pull(): XFix.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
  131. def purify(): XFix.this.type

    Permalink
    Definition Classes
    Data
  132. def randBoot(u: Unit): XFix.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
  133. val raw: R

    Permalink
  134. var refOwner: RefOwnerType

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

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

    Permalink
    Definition Classes
    Data
  137. def removeDataAssignments(): XFix.this.type

    Permalink
    Definition Classes
    Data
  138. def removeInitAssignments(): XFix.this.type

    Permalink
    Definition Classes
    Data
  139. def removeTag(spinalTag: SpinalTag): XFix.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  141. def resized: XFix.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  142. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  143. def setAll(): XFix.this.type

    Permalink
    Definition Classes
    Data
  144. def setAsAnalog(): XFix.this.type

    Permalink
    Definition Classes
    Data
  145. def setAsComb(): XFix.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  146. def setAsDirectionLess(): XFix.this.type

    Permalink

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

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

    Definition Classes
    MultiDataData
  147. def setAsReg(): XFix.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  153. def setCompositeName(nameable: Nameable): XFix.this.type

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

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

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

    Permalink
    Definition Classes
    Nameable
  157. def setName(name: String): XFix.this.type

    Permalink
    Definition Classes
    Nameable
  158. def setNameAsWeak(): XFix.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  164. def setPartialName(name: String): XFix.this.type

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

    Permalink
    Definition Classes
    Nameable
  166. def setPartialName(owner: Nameable): XFix.this.type

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

    Permalink
    Definition Classes
    OwnableRef
  168. def setScalaLocated(source: ScalaLocated): XFix.this.type

    Permalink
    Definition Classes
    ScalaLocated
  169. def setWeakName(name: String): XFix.this.type

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

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

    Permalink
    Definition Classes
    AnyRef
  172. def toIo(): XFix.this.type

    Permalink
    Definition Classes
    Data
  173. def toMuxInput[M <: Data](muxOutput: M): M

    Permalink
    Definition Classes
    XFixData
  174. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  175. def truncated(maxExp: ExpNumber, resolution: ExpNumber): T

    Permalink
  176. def truncated(maxExp: ExpNumber, bitCount: BitCount): T

    Permalink
  177. def truncated: XFix.this.type

    Permalink
  178. def unfreeze(): XFix.this.type

    Permalink
    Definition Classes
    MultiDataData
  179. def unsetName(): XFix.this.type

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  183. def wrapNext(): XFix.this.type

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

    Permalink
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): XFix.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): XFix.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 MinMaxDecimalProvider

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