Packages

class UInt extends BitVector with Num[UInt] with MinMaxProvider with DataPrimitives[UInt] with BaseTypePrimitives[UInt] with BitwiseOp[UInt]

The UInt type corresponds to a vector of bits that can be used for unsigned integer arithmetic.

Example: 

  1. val myUInt = UInt(8 bits)
 myUInt := U(2,8 bits)
 myUInt := U(2)
 myUInt := U"0000_0101"
 myUInt := U"h1A"
See also

UInt Documentation

Linear Supertypes
BitwiseOp[UInt], BaseTypePrimitives[UInt], DataPrimitives[UInt], MinMaxProvider, Num[UInt], BitVector, Widthable, WidthProvider, BaseType, Expression, StatementDoubleLinkedContainer[BaseType, AssignmentStatement], DoubleLinkedContainer[BaseType, AssignmentStatement], DeclarationStatement, LeafStatement, Statement, BaseNode, ExpressionContainer, Data, InComponent, OverridedEqualsHashCode, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, ScalaLocated, GlobalDataUser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UInt
  2. BitwiseOp
  3. BaseTypePrimitives
  4. DataPrimitives
  5. MinMaxProvider
  6. Num
  7. BitVector
  8. Widthable
  9. WidthProvider
  10. BaseType
  11. Expression
  12. StatementDoubleLinkedContainer
  13. DoubleLinkedContainer
  14. DeclarationStatement
  15. LeafStatement
  16. Statement
  17. BaseNode
  18. ExpressionContainer
  19. Data
  20. InComponent
  21. OverridedEqualsHashCode
  22. SpinalTagReady
  23. Assignable
  24. NameableByComponent
  25. Nameable
  26. OwnableRef
  27. ContextUser
  28. ScalaLocated
  29. GlobalDataUser
  30. AnyRef
  31. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UInt()

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef
  2. type T = UInt

    Used to know the data type of the children class of BitVector

    Used to know the data type of the children class of BitVector

    Definition Classes
    UInt → BitVector

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. def %(right: UInt): UInt

    Modulo

    Modulo

    Definition Classes
    UInt → Num
  6. def &(right: UInt): UInt

    Bitwise AND operator

    Bitwise AND operator

    Definition Classes
    UInt → BitwiseOp
  7. def *(right: UInt): UInt

    Multiplication

    Multiplication

    Definition Classes
    UInt → Num
  8. def +(right: UInt): UInt

    Addition

    Addition

    Definition Classes
    UInt → Num
  9. def +^(right: UInt): UInt

    Safe Addition with 1 bit expand

    Safe Addition with 1 bit expand

    Definition Classes
    UInt → Num
  10. def +|(right: UInt): UInt

    Safe Addition with saturation

    Safe Addition with saturation

    Definition Classes
    UInt → Num
  11. def -(right: UInt): UInt

    Substraction

    Substraction

    Definition Classes
    UInt → Num
  12. def -^(right: UInt): UInt

    Safe Substraction with 1 bit expand

    Safe Substraction with 1 bit expand

    Definition Classes
    UInt → Num
  13. def -|(right: UInt): UInt

    Safe Substraction with saturation

    Safe Substraction with saturation

    Definition Classes
    UInt → Num
  14. def /(right: UInt): UInt

    Division

    Division

    Definition Classes
    UInt → Num
  15. def :=(value: String): Unit
  16. def :=(rangesValue: (Any, Any), _rangesValues: (Any, Any)*): Unit

    Assign a range value to an UInt

    Assign a range value to an UInt

    rangesValue

    The first range value

    _rangesValues

    Others range values

    Example: 

    1. core.io.interrupt = (0 -> uartCtrl.io.interrupt, 1 -> timerCtrl.io.interrupt, default -> false)
  17. def :=(that: UInt)(implicit loc: Location): Unit

    Assign a data to this

    Assign a data to this

    Definition Classes
    DataPrimitives
  18. def <(right: UInt): Bool

    Is less than right

    Is less than right

    Definition Classes
    UInt → Num
  19. def <<(that: UInt): UInt

    Logical shift Left (output width will increase of w(this) + max(that) bits

    Logical shift Left (output width will increase of w(this) + max(that) bits

    Definition Classes
    UInt → Num
  20. def <<(that: Int): UInt

    Arithmetic left shift (w(T) = w(this) + shift)

    Arithmetic left shift (w(T) = w(this) + shift)

    Definition Classes
    UInt → Num
  21. def <=(right: UInt): Bool

    Is equal or less than right

    Is equal or less than right

    Definition Classes
    UInt → Num
  22. def <>(that: UInt)(implicit loc: Location): Unit

    Auto connection between two data

    Auto connection between two data

    Definition Classes
    DataPrimitives
  23. def =/=(that: UInt): Bool
    Definition Classes
    DataPrimitives
  24. def =/=(that: MaskedLiteral): Bool

    BitVector is not equal to MaskedLiteral

    BitVector is not equal to MaskedLiteral

    Definition Classes
    BitVector
  25. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  26. def ===(that: UInt): Bool

    Comparison between two data

    Comparison between two data

    Definition Classes
    DataPrimitives
  27. def ===(that: MaskedLiteral): Bool

    Compare a BitVector with a MaskedLiteral (M"110--0")

    Compare a BitVector with a MaskedLiteral (M"110--0")

    that

    the maskedLiteral

    returns

    a Bool data containing the result of the comparison

    Definition Classes
    BitVector
    Example: 

    1. val myBool = myBits === M"0-1"
  28. def >(right: UInt): Bool

    Is greater than right

    Is greater than right

    Definition Classes
    UInt → Num
  29. def >=(right: UInt): Bool

    Is equal or greater than right

    Is equal or greater than right

    Definition Classes
    UInt → Num
  30. def >>(that: UInt): UInt

    Logical shift Right (output width = input width)

    Logical shift Right (output width = input width)

    that

    the number of shift

    returns

    a Bits of width : w(this)

    Definition Classes
    UInt → Num
    Example: 

    1. val result = myUInt >> myUIntShift
  31. def >>(that: Int): UInt

    Arithmetic right shift (w(T) = w(this) - shift)

    Arithmetic right shift (w(T) = w(this) - shift)

    Definition Classes
    UInt → Num
  32. def @*(count: Int): UInt
  33. def @@(that: Bool): UInt

    Concatenation between a UInt and a Bool

  34. def @@(that: UInt): UInt

    Concatenation between two UInt

    Concatenation between two UInt

    that

    an UInt to append

    returns

    a new UInt of width (w(this) + w(right))

    Example: 

    1. val myUInt = uInt1 @@ uInt2
  35. def IFparent: Data
    Definition Classes
    Data
  36. def Q: QFormat
    Definition Classes
    Num
  37. def \(that: UInt): UInt

    Use as \= to have the same behavioral as VHDL variable

    Use as \= to have the same behavioral as VHDL variable

    Definition Classes
    DataPrimitives
  38. def ^(right: UInt): UInt

    Bitwise XOR operator

    Bitwise XOR operator

    Definition Classes
    UInt → BitwiseOp
  39. def _data: UInt
    Definition Classes
    UInt → DataPrimitives
  40. def _fixEntry(roundN: Int, roundType: RoundType, satN: Int): UInt
    Attributes
    protected
  41. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  42. def addAttribute(attribute: Attribute): UInt.this.type
    Definition Classes
    BaseType → Data → SpinalTagReady
  43. def addAttribute(name: String, value: Int): UInt.this.type
    Definition Classes
    SpinalTagReady
  44. def addAttribute(name: String, value: String): UInt.this.type
    Definition Classes
    SpinalTagReady
  45. def addAttribute(name: String): UInt.this.type
    Definition Classes
    SpinalTagReady
  46. def addTag[T <: SpinalTag](spinalTag: T): UInt.this.type
    Definition Classes
    SpinalTagReady
  47. def addTags(h: SpinalTag, tail: SpinalTag*): UInt.this.type
    Definition Classes
    SpinalTagReady
  48. def addTags[T <: SpinalTag](tags: Iterable[T]): UInt.this.type
    Definition Classes
    SpinalTagReady
  49. val algoIncrementale: Int
    Definition Classes
    BaseNode
  50. val algoInt: Int
    Definition Classes
    BaseNode
  51. def allowDirectionLessIo(): UInt.this.type

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

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

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  54. def allowPruning(): UInt.this.type
    Definition Classes
    Data
  55. def allowSimplifyIt(): UInt.this.type
    Definition Classes
    BaseType → Data
  56. def allowUnsetRegToAvoidLatch(): UInt.this.type

    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
  57. def andMask(that: Bool): UInt.this.type
    Definition Classes
    BitVector
  58. def andR: Bool

    Logical AND of all bits

    Logical AND of all bits

    Definition Classes
    BitVector
  59. def apply(offset: UInt, bitCount: BitCount): UInt.this.type

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Definition Classes
    UInt → BitVector
    Example: 

    1. val myBool = myBits(myUInt, 2 bits)
  60. def apply(offset: Int, bitCount: BitCount): UInt.this.type

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Definition Classes
    UInt → BitVector
    Example: 

    1. val myBool = myBits(3, 2 bits)
  61. def apply(bitId: UInt): Bool

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    UInt → BitVector
    Example: 

    1. val myBool = myBits(myUInt)
  62. def apply(bitId: Int): Bool

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    UInt → BitVector
    Example: 

    1. val myBool = myBits(3)
  63. def apply(range: Range): UInt.this.type

    Return a range of bits

    Return a range of bits

    Definition Classes
    BitVector
    Example: 

    1. val myBool = myBits(3 downto 1)
  64. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  65. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    UInt → Data
  66. def asBool: Bool
    Definition Classes
    BitVector
  67. def asBools: Vec[Bool]

    Cast the BitVector into a Vector of Bool

    Cast the BitVector into a Vector of Bool

    returns

    a vector of Bool

    Definition Classes
    BitVector
  68. def asData: Data
    Definition Classes
    Data
  69. def asInOut(): UInt.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    BaseType → Data
  70. def asInput(): UInt.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    BaseType → Data
  71. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  72. def asOutput(): UInt.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  73. def asSInt: SInt

    Cast an UInt to a SInt

    Cast an UInt to a SInt

    returns

    a SInt data

    Example: 

    1. mySInt := myUInt.asSInt
  74. def assignDontCare(): UInt.this.type
    Definition Classes
    UInt → Data
  75. def assignDontCareToUnasigned(): UInt.this.type
    Definition Classes
    Data
  76. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    UInt → Data
  77. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  78. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    UInt → Data
  79. def assignFromBits(bits: Bits): Unit
    Definition Classes
    UInt → Data
  80. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  81. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    BaseType → Assignable
  82. def assignMask(maskedLiteral: MaskedLiteral): Unit

    Assign a mask to the output signal

    Assign a mask to the output signal

    maskedLiteral

    masked literal value

    Example: 

    1. output4 assignMask M"1111
  83. def bitsRange: Range
    Definition Classes
    BitVector
  84. def ceil(n: Int, align: Boolean = true): UInt

    UInt ceil ceil(x) return if(align) w(this)-n bits else w(this)-n+1 bits

    UInt ceil ceil(x) return if(align) w(this)-n bits else w(this)-n+1 bits

    Definition Classes
    UInt → Num
  85. def ceil(width: BitCount, align: Boolean): UInt

    lowest n bits Round Operation by BitCount

    lowest n bits Round Operation by BitCount

    Definition Classes
    Num
  86. def ceilToInf(n: Int, align: Boolean = true): UInt
    Definition Classes
    UInt → Num
  87. def ceilToInf(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  88. def cldCount: Int
    Definition Classes
    DoubleLinkedContainer
  89. def clearAll(): UInt.this.type

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector → Data
  90. def clearedLow(n: Int): UInt
  91. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  92. def clone(): UInt.this.type
    Definition Classes
    BitVector → BaseType → Data → AnyRef
  93. def component: Component
    Definition Classes
    ContextUser
  94. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  95. val compositeAssign: Assignable
    Definition Classes
    Assignable
  96. def copyDirectionOf(that: UInt): Unit
    Definition Classes
    DataPrimitives
  97. def copyDirectionOfImpl(that: Data): UInt.this.type
    Definition Classes
    BaseType → Data
  98. def default(that: ⇒ UInt): UInt

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  99. def dirString(): String
    Definition Classes
    Data
  100. def dlcAppend(that: AssignmentStatement): UInt.this.type
    Definition Classes
    DoubleLinkedContainer
  101. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  102. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  103. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  104. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  105. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  106. def dlcPrepend(that: AssignmentStatement): UInt.this.type
    Definition Classes
    DoubleLinkedContainer
  107. def dontSimplifyIt(): UInt.this.type
    Definition Classes
    BaseType → Data
  108. def drop(n: Int): Bits

    Drop lowerst n bits

    Drop lowerst n bits

    returns

    data10bits(9 downto 4)

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.drop(4)
  109. def dropHigh(n: Int): Bits

    Drop highest n bits

    Drop highest n bits

    returns

    data10bits(5 downto 0)

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.dropHigh(4)
  110. def dropLow(n: Int): Bits
    Definition Classes
    BitVector
  111. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  112. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  113. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  114. def expand: UInt
  115. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  116. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  117. def fixTo(q: QFormat): UInt
  118. def fixTo(q: QFormat, roundType: RoundType): UInt
  119. def fixTo(section: Inclusive): UInt
  120. def fixTo(section: Inclusive, roundType: RoundType): UInt
  121. def flatten: Seq[BaseType]
    Definition Classes
    BaseType → Data
  122. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    BaseType → Data
  123. def flattenLocalName: Seq[String]
    Definition Classes
    BaseType → Data
  124. def flip(): UInt.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  125. def floor(n: Int): UInt

    UInt ceil floor(x) return w(this)-n bits

    UInt ceil floor(x) return w(this)-n bits

    Definition Classes
    UInt → Num
  126. def floor(width: BitCount): UInt
    Definition Classes
    Num
  127. def floorToZero(n: Int): UInt
    Definition Classes
    UInt → Num
  128. def floorToZero(width: BitCount): UInt
    Definition Classes
    Num
  129. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit
    Definition Classes
    BaseType → Statement
  130. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  131. def foreachExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  132. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  133. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit
    Definition Classes
    StatementDoubleLinkedContainer
  134. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  135. def freeze(): UInt.this.type
    Definition Classes
    BaseType → Data
  136. def getAheadValue(): UInt.this.type

    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
    BaseType → Data
  137. def getAllTrue: UInt.this.type
    Definition Classes
    UInt → BitVector
  138. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    BitVector → Data
  139. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  140. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  141. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  142. def getDirection: IODirection
    Definition Classes
    Data
  143. def getDisplayName(): String
    Definition Classes
    Nameable
  144. def getDrivingReg(reportError: Boolean = true): UInt.this.type
    Definition Classes
    BaseType
  145. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  146. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  147. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    BitVector → Data
  148. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  149. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  150. def getPartialName(): String
    Definition Classes
    Nameable
  151. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  152. def getRealSource: Any
    Definition Classes
    Assignable
  153. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  154. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  155. def getRootParent: Data
    Definition Classes
    Data
  156. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  157. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  158. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  159. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  160. def getSingleDriver: Option[UInt.this.type]
    Definition Classes
    BaseType
  161. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  162. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  163. def getTypeObject: TypeUInt.type
    Definition Classes
    UInt → Expression
  164. def getWidth: Int
    Definition Classes
    Widthable → WidthProvider
  165. def getWidthNoInferation: Int

    Return the width

    Return the width

    Definition Classes
    BitVector
  166. def getWidthStringNoInferation: String
    Definition Classes
    BitVector
  167. def getZero: UInt.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    UInt → Data
  168. def getZeroUnconstrained: UInt.this.type
    Definition Classes
    UInt → BitVector
  169. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  170. def hasAssignement: Boolean
    Definition Classes
    BaseType
  171. def hasDataAssignment: Boolean
    Definition Classes
    BaseType
  172. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  173. def hasOnlyOneStatement: Boolean
    Definition Classes
    StatementDoubleLinkedContainer
  174. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  175. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  176. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  177. def head: AssignmentStatement
    Definition Classes
    StatementDoubleLinkedContainer
  178. def high: Int

    Return the upper bound

    Return the upper bound

    Definition Classes
    BitVector
  179. def init(that: UInt): UInt

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  180. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  181. def initial(that: UInt): UInt
    Definition Classes
    BaseTypePrimitives
  182. def initialFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    BaseType
  183. def insertNext(s: Statement): Unit
    Definition Classes
    Statement
  184. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  185. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  186. def intoSInt: SInt
  187. def invertedMsb: Bits
  188. def isAnalog: Boolean
    Definition Classes
    BaseType → Data
  189. def isComb: Boolean
    Definition Classes
    BaseType → Data
  190. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  191. def isDirectionLess: Boolean
    Definition Classes
    Data
  192. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  193. def isFrozen(): Boolean
    Definition Classes
    BaseType
  194. def isInOut: Boolean
    Definition Classes
    Data
  195. def isInput: Boolean
    Definition Classes
    Data
  196. def isInputOrInOut: Boolean
    Definition Classes
    Data
  197. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  198. final def isNamed: Boolean
    Definition Classes
    Nameable
  199. def isOutput: Boolean
    Definition Classes
    Data
  200. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  201. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  202. def isReg: Boolean
    Definition Classes
    BaseType → Data
  203. def isRegOnAssign: Boolean
    Definition Classes
    BitVector → Data
  204. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  205. def isUnknown: Bool
    Definition Classes
    BitVector
  206. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  207. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  208. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  209. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  210. val lastScopeStatement: Statement
    Definition Classes
    Statement
  211. def lsb: Bool

    Return the least significant bit

    Return the least significant bit

    Definition Classes
    BitVector
  212. def max(right: UInt): UInt

    Return the maximum value between this and right

    Return the maximum value between this and right

    Definition Classes
    Num
  213. def maxValue: BigInt
    Definition Classes
    UInt → MinMaxProvider
  214. def min(right: UInt): UInt

    Return the minimum value between this and right

    Return the minimum value between this and right

    Definition Classes
    Num
  215. def minValue: BigInt
    Definition Classes
    UInt → MinMaxProvider
  216. def msb: Bool

    Return the most significant bit

    Return the most significant bit

    Definition Classes
    BitVector
  217. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  218. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  219. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  220. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  221. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  222. val name: String
    Definition Classes
    Nameable
  223. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  224. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  225. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating)(implicit loc: Location): UInt.this.type

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

    Definition Classes
    BitVector
  226. def newExtract(hi: Int, lo: Int, accessFactory: ⇒ BitVectorRangedAccessFixed): UInt.this.type

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

    Definition Classes
    BitVector
  227. def newExtract(bitId: UInt, extract: BitVectorBitAccessFloating): Bool

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  228. def newExtract(bitId: Int, extract: BitVectorBitAccessFixed): Bool

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  229. val nextScopeStatement: Statement
    Definition Classes
    Statement
  230. def noBackendCombMerge(): UInt.this.type

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

    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
  232. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  233. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  234. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  235. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  236. def opName: String
    Definition Classes
    UInt → Expression
  237. def orMask(that: Bool): UInt.this.type
    Definition Classes
    BitVector
  238. def orR: Bool

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  239. def overrideLocalName(name: String): UInt.this.type
    Definition Classes
    Nameable
  240. val parent: Data
    Definition Classes
    Data
  241. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  242. def pull(propagateName: Boolean): UInt.this.type
    Definition Classes
    Data
  243. def pull(): UInt.this.type

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

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

    Definition Classes
    Data
  244. def purify(): UInt.this.type
    Definition Classes
    Data
  245. def randBoot(u: Unit): UInt.this.type

    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
  246. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  247. def reflectNames(): Unit
    Definition Classes
    Nameable
  248. def remapClockDomain(func: (ClockDomain) ⇒ ClockDomain): Unit
    Definition Classes
    BaseType → Statement
  249. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  250. def remapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  251. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): UInt.this.type

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseType → Data
  252. def removeDataAssignments(): UInt.this.type
    Definition Classes
    Data
  253. def removeInitAssignments(): UInt.this.type
    Definition Classes
    Data
  254. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  255. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  256. def removeTag(spinalTag: SpinalTag): UInt.this.type
    Definition Classes
    SpinalTagReady
  257. def removeTags(tags: Iterable[SpinalTag]): UInt.this.type
    Definition Classes
    SpinalTagReady
  258. def resize(width: BitCount): UInt.this.type
    Definition Classes
    UInt → BitVector
  259. def resize(width: Int): UInt.this.type

    Resize the bitVector to width

    Resize the bitVector to width

    returns

    a resized bitVector

    Definition Classes
    UInt → BitVector
    Example: 

    1. val res = myBits.resize(10)
  260. def resized: UInt.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  261. def reversed: UInt.this.type
    Definition Classes
    UInt → BitVector
  262. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  263. def rootIFList(): List[Interface]
    Definition Classes
    Data
  264. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  265. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  266. def rotateLeft(that: Int): UInt

    Left rotation of that bits

    Left rotation of that bits

    Definition Classes
    UInt → BitVector
  267. def rotateLeft(that: UInt): T

    Left rotation of that Bits

    Left rotation of that Bits

    Definition Classes
    BitVector
  268. def rotateRight(that: Int): UInt

    Right rotation of that bits

    Right rotation of that bits

    Definition Classes
    UInt → BitVector
  269. def rotateRight(that: UInt): T

    Right rotation of that Bits

    Right rotation of that Bits

    Definition Classes
    BitVector
  270. def round(n: Int, align: Boolean = true): UInt
    Definition Classes
    UInt → Num
  271. def round(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  272. def roundDown(n: Int, align: Boolean): UInt

    UInt roundDown ceil(x - 0.5) return w(this)-n bits

    UInt roundDown ceil(x - 0.5) return w(this)-n bits

    Definition Classes
    UInt → Num
  273. def roundDown(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  274. def roundToEven(n: Int, align: Boolean): UInt
    Definition Classes
    UInt → Num
  275. def roundToEven(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  276. def roundToInf(n: Int, align: Boolean = true): UInt
    Definition Classes
    UInt → Num
  277. def roundToInf(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  278. def roundToOdd(n: Int, align: Boolean): UInt
    Definition Classes
    UInt → Num
  279. def roundToOdd(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  280. def roundToZero(n: Int, align: Boolean = true): UInt
    Definition Classes
    UInt → Num
  281. def roundToZero(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  282. def roundUp(n: Int, align: Boolean = true): UInt

    UInt roundUp floor(x + 0.5) return if(align) w(this)-n bits else w(this)-n+1 bits

    UInt roundUp floor(x + 0.5) return if(align) w(this)-n bits else w(this)-n+1 bits

    Definition Classes
    UInt → Num
  283. def roundUp(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  284. def sat(m: Int): UInt

    highest m bits Saturation

    highest m bits Saturation

    Definition Classes
    UInt → Num
  285. def sat(width: BitCount): UInt
    Definition Classes
    Num
  286. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  287. def setAll(): UInt.this.type

    Set all bits

    Set all bits

    Definition Classes
    UInt → BitVector → Data
  288. def setAllTo(value: Bool): UInt.this.type

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  289. def setAllTo(value: Boolean): UInt.this.type

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  290. def setAsAnalog(): UInt.this.type
    Definition Classes
    BaseType → Data
  291. def setAsComb(): UInt.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType → Data
  292. def setAsDirectionLess(): UInt.this.type

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

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

    Definition Classes
    BaseType → Data
  293. def setAsReg(): UInt.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType → Data
  294. def setAsTypeNode(): UInt.this.type

    Set baseType to Node

    Set baseType to Node

    Definition Classes
    BaseType
  295. def setAsVital(): UInt.this.type

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  296. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  297. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  298. def setCompositeName(nameable: Nameable, postfix: String): UInt.this.type
    Definition Classes
    Nameable
  299. def setCompositeName(nameable: Nameable, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  300. def setCompositeName(nameable: Nameable, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  301. def setCompositeName(nameable: Nameable): UInt.this.type
    Definition Classes
    Nameable
  302. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): UInt.this.type
    Definition Classes
    Nameable
  303. def setName(name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  304. def setName(name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  305. def setName(name: String): UInt.this.type
    Definition Classes
    Nameable
  306. def setNameAsWeak(): UInt.this.type
    Definition Classes
    Nameable
  307. def setOutputAsReg(): UInt.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  308. def setPartialName(name: String, namePriority: Byte, owner: Any): UInt.this.type
    Definition Classes
    Nameable
  309. def setPartialName(name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  310. def setPartialName(name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  311. def setPartialName(owner: Nameable, name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  312. def setPartialName(owner: Nameable, name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  313. def setPartialName(name: String): UInt.this.type
    Definition Classes
    Nameable
  314. def setPartialName(owner: Nameable, name: String): UInt.this.type
    Definition Classes
    Nameable
  315. def setPartialName(owner: Nameable): UInt.this.type
    Definition Classes
    Nameable
  316. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  317. def setScalaLocated(source: ScalaLocated): UInt.this.type
    Definition Classes
    ScalaLocated
  318. def setWeakName(name: String): UInt.this.type
    Definition Classes
    Nameable
  319. def setWidth(width: Int): UInt.this.type

    Set the width of the BitVector

    Set the width of the BitVector

    width

    the width of the data

    returns

    the BitVector of a given size

    Definition Classes
    BitVector
  320. def simplifyNode: Expression
    Definition Classes
    Expression
  321. def sliceBy(divisor: List[Int]): List[Bits]
    Definition Classes
    BitVector
  322. def sliceBy(divisor: Int*): List[Bits]

    apart by a list of width

    apart by a list of width

    returns

    (List(A(1 downto 0), A(2 downto 4), A(9 downto 3))

    Definition Classes
    BitVector
    Example: 

    1. val res = A.sliceBy(2, 3, 5)
val res = A.sliceBy(List(2, 3, 5))
  323. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  324. def splitAt(n: Int): (Bits, Bits)

    Split at n st bits

    Split at n st bits

    returns

    (data10bits(8 downto 4), data10bits(3 downto 0))

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.splitAt(4)
  325. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression
    Definition Classes
    ExpressionContainer
  326. def subdivideIn(sliceWidth: BitCount): Vec[T]
    Definition Classes
    BitVector
  327. def subdivideIn(sliceCount: SlicesCount): Vec[T]
    Definition Classes
    BitVector
  328. def subdivideIn(sliceWidth: BitCount, strict: Boolean): Vec[T]

    Split the BitVector into slice of x bits

    Split the BitVector into slice of x bits

    sliceWidth

    the width of the slice

    strict

    allow subdivideIn to generate vectors with varying size

    returns

    a Vector of slices

    Definition Classes
    BitVector
    Example: 

    1. val res = myBits.subdivideIn(3 bits)
  329. def subdivideIn(sliceCount: SlicesCount, strict: Boolean): Vec[T]

    Split the BitVector into x slice

    Split the BitVector into x slice

    sliceCount

    the width of the slice

    strict

    allow subdivideIn to generate vectors with varying size

    returns

    a Vector of slices

    Definition Classes
    BitVector
    Example: 

    1. val res = myBits.subdivideIn(3 slices)
  330. def switchAssign[T2 <: BaseType](sel: T2)(mappings: (Any, UInt)*): Unit
    Definition Classes
    DataPrimitives
  331. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  332. def tag(q: QFormat): UInt
    Definition Classes
    UInt → Num
  333. def take(n: Int): Bits

    Take lowerst n bits

    Take lowerst n bits

    returns

    data10bits(3 downto 0)

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.take(4)
  334. def takeHigh(n: Int): Bits

    Take highest n bits

    Take highest n bits

    returns

    data10bits(9 downto 6)

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.takeHigh(4)
  335. def takeLow(n: Int): Bits
    Definition Classes
    BitVector
  336. def toIo(): UInt.this.type
    Definition Classes
    Data
  337. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  338. def toString(): String
    Definition Classes
    BitVector → BaseType → Expression → Nameable → AnyRef → Any
  339. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  340. def toStringRec(level: Int = 1): String
    Definition Classes
    Expression
  341. def trim(m: Int): UInt

    highest m bits Discard

    highest m bits Discard

    Definition Classes
    UInt → Num
  342. def trim(width: BitCount): UInt
    Definition Classes
    Num
  343. def twoComplement(enable: Bool, plusOneEnable: Bool = null): SInt

    2'Complement

    2'Complement

    enable

    enable the 2'complement

    returns

    Return the 2'Complement of the number

  344. def unary_~: UInt

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    UInt → BitwiseOp
  345. def unfreeze(): UInt.this.type
    Definition Classes
    BaseType → Data
  346. def unsetName(): UInt.this.type
    Definition Classes
    Nameable
  347. def valueRange: Range
  348. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  349. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  350. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  351. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  352. def walkExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  353. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  354. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  355. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  356. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  357. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  358. def wrap: AnyRef { ... /* 4 definitions in type refinement */ }
  359. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  360. def wrapNext(): UInt.this.type
    Definition Classes
    Data
  361. def xorMask(that: Bool): UInt.this.type
    Definition Classes
    BitVector
  362. def xorR: Bool

    Logical XOR of all bits

    Logical XOR of all bits

    Definition Classes
    BitVector
  363. def |(right: UInt): UInt

    Bitwise OR operator

    Bitwise OR operator

    Definition Classes
    UInt → BitwiseOp
  364. def |<<(that: UInt): UInt

    Logical shift left (output width == input width)

  365. def |<<(that: Int): UInt

    Logical shift left (output width == input width)

  366. def |>>(that: UInt): UInt

    Logical shift Right (output width == input width)

  367. def |>>(that: Int): UInt

    Logical shift right (output width = input width)

    Logical shift right (output width = input width)

    that

    the number of shift

    returns

    a Bits of width : w(this)

    Example: 

    1. val result = myUInt |>> 4

Deprecated Value Members

  1. def asDirectionLess(): UInt.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  3. def genIf(cond: Boolean): UInt.this.type

    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

  4. def range: Range

    Return the range

    Return the range

    Definition Classes
    BitVector
    Annotations
    @deprecated
    Deprecated

    Use bitsRange instead

Inherited from BitwiseOp[UInt]

Inherited from BaseTypePrimitives[UInt]

Inherited from DataPrimitives[UInt]

Inherited from MinMaxProvider

Inherited from Num[UInt]

Inherited from BitVector

Inherited from Widthable

Inherited from WidthProvider

Inherited from BaseType

Inherited from Expression

Inherited from StatementDoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DeclarationStatement

Inherited from LeafStatement

Inherited from Statement

Inherited from BaseNode

Inherited from ExpressionContainer

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