Packages

class Bits extends BitVector with DataPrimitives[Bits] with BaseTypePrimitives[Bits] with BitwiseOp[Bits]

The Bits type corresponds to a vector of bits that does not convey any arithmetic meaning.

Example: 

  1. val myBits1 = Bits(32 bits)
val myBits2 = B(25, 8 bits)
val myBits3 = B"8'xFF"
val myBits4 = B"1001_0011
See also

Bits Documentation

Linear Supertypes
BitwiseOp[Bits], BaseTypePrimitives[Bits], DataPrimitives[Bits], 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. Bits
  2. BitwiseOp
  3. BaseTypePrimitives
  4. DataPrimitives
  5. BitVector
  6. Widthable
  7. WidthProvider
  8. BaseType
  9. Expression
  10. StatementDoubleLinkedContainer
  11. DoubleLinkedContainer
  12. DeclarationStatement
  13. LeafStatement
  14. Statement
  15. BaseNode
  16. ExpressionContainer
  17. Data
  18. InComponent
  19. OverridedEqualsHashCode
  20. SpinalTagReady
  21. Assignable
  22. NameableByComponent
  23. Nameable
  24. OwnableRef
  25. ContextUser
  26. ScalaLocated
  27. GlobalDataUser
  28. AnyRef
  29. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bits()

Type Members

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

    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
    Bits → BitVector

Value Members

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

    Concatenation between two Bits

    Concatenation between two Bits

    right

    a Bits to append

    returns

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

    Example: 

    1. val myBits2 = bits1 ## bits2
  3. def ##(right: Data): Bits

    Concatenation between two data

    Concatenation between two data

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

    Bitwise AND operator

    Bitwise AND operator

    Definition Classes
    Bits → BitwiseOp
  7. def :=(value: String): Unit
  8. def :=(rangesValue: (Any, Any), _rangesValues: (Any, Any)*): Unit

    Assign a range value to a Bits

    Assign a range value to a Bits

    rangesValue

    The first range value

    _rangesValues

    Others range values

    Example: 

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

    Assign a data to this

    Assign a data to this

    Definition Classes
    DataPrimitives
  10. def <<(that: UInt): Bits

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

  11. def <<(that: Int): Bits

    Logical shift left (output width will increase)

    Logical shift left (output width will increase)

    that

    the number of shift

    returns

    a Bits of width : w(this) + that bits

    Example: 

    1. val result = myBits << 4
  12. def <>(that: Bits)(implicit loc: Location): Unit

    Auto connection between two data

    Auto connection between two data

    Definition Classes
    DataPrimitives
  13. def =/=(that: Bits): Bool
    Definition Classes
    DataPrimitives
  14. def =/=(that: MaskedLiteral): Bool

    BitVector is not equal to MaskedLiteral

    BitVector is not equal to MaskedLiteral

    Definition Classes
    BitVector
  15. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def ===(that: Bits): Bool

    Comparison between two data

    Comparison between two data

    Definition Classes
    DataPrimitives
  17. 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"
  18. def >>(that: UInt): Bits

    Logical shift right (output width == input width)

  19. def >>(that: Int): Bits

    Logical shift right (output width will decrease)

    Logical shift right (output width will decrease)

    that

    the number of shift

    returns

    a Bits of width : w(this) - that bits

    Example: 

    1. val result = myBits >> 4
  20. def IFparent: Data
    Definition Classes
    Data
  21. def \(that: Bits): Bits

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

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

    Definition Classes
    DataPrimitives
  22. def ^(right: Bits): Bits

    Bitwise XOR operator

    Bitwise XOR operator

    Definition Classes
    Bits → BitwiseOp
  23. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  24. def addAttribute(attribute: Attribute): Bits.this.type
    Definition Classes
    BaseType → Data → SpinalTagReady
  25. def addAttribute(name: String, value: Int): Bits.this.type
    Definition Classes
    SpinalTagReady
  26. def addAttribute(name: String, value: String): Bits.this.type
    Definition Classes
    SpinalTagReady
  27. def addAttribute(name: String): Bits.this.type
    Definition Classes
    SpinalTagReady
  28. def addTag[T <: SpinalTag](spinalTag: T): Bits.this.type
    Definition Classes
    SpinalTagReady
  29. def addTags(h: SpinalTag, tail: SpinalTag*): Bits.this.type
    Definition Classes
    SpinalTagReady
  30. def addTags[T <: SpinalTag](tags: Iterable[T]): Bits.this.type
    Definition Classes
    SpinalTagReady
  31. val algoIncrementale: Int
    Definition Classes
    BaseNode
  32. val algoInt: Int
    Definition Classes
    BaseNode
  33. def aliasAs[T <: Data](t: HardType[T]): T

    Return a instance of the paramter which alias this.Bits in both read and assignments accesses.

    Return a instance of the paramter which alias this.Bits in both read and assignments accesses. Usefull for union like data structures.

    t

    The type in which the alias will be

    returns

    The alias

  34. def allowDirectionLessIo(): Bits.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
  35. def allowOverride(): Bits.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
  36. def allowPartialyAssigned(): Bits.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  37. def allowPruning(): Bits.this.type
    Definition Classes
    Data
  38. def allowSimplifyIt(): Bits.this.type
    Definition Classes
    BaseType → Data
  39. def allowUnsetRegToAvoidLatch(): Bits.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
  40. def andMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  41. def andR: Bool

    Logical AND of all bits

    Logical AND of all bits

    Definition Classes
    BitVector
  42. def apply(offset: UInt, bitCount: BitCount): Bits.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
    Bits → BitVector
    Example: 

    1. val myBool = myBits(myUInt, 2 bits)
  43. def apply(offset: Int, bitCount: BitCount): Bits.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
    Bits → BitVector
    Example: 

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

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    Bits → BitVector
    Example: 

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

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    Bits → BitVector
    Example: 

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

    Return a range of bits

    Return a range of bits

    Definition Classes
    BitVector
    Example: 

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

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    Bits → Data
  49. def asBool: Bool
    Definition Classes
    BitVector
  50. 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
  51. def asData: Data
    Definition Classes
    Data
  52. def asInOut(): Bits.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    BaseType → Data
  53. def asInput(): Bits.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    BaseType → Data
  54. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  55. def asOutput(): Bits.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  56. def asSInt: SInt

    Cast a Bits to a SInt

    Cast a Bits to a SInt

    returns

    a SInt data

    Example: 

    1. val mySInt = myBits.asSInt
  57. def asUInt: UInt

    Cast a Bits to an UInt

    Cast a Bits to an UInt

    returns

    an UInt data

    Example: 

    1. val myUInt = myBits.asUInt
  58. def assignDontCare(): Bits.this.type
    Definition Classes
    Bits → Data
  59. def assignDontCareToUnasigned(): Bits.this.type
    Definition Classes
    Data
  60. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    Bits → Data
  61. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  62. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    Bits → Data
  63. def assignFromBits(bits: Bits): Unit
    Definition Classes
    Bits → Data
  64. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  65. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    BaseType → Assignable
  66. def bitsRange: Range
    Definition Classes
    BitVector
  67. def cldCount: Int
    Definition Classes
    DoubleLinkedContainer
  68. def clearAll(): Bits.this.type

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector → Data
  69. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  70. def clone(): Bits.this.type
    Definition Classes
    BitVector → BaseType → Data → AnyRef
  71. def component: Component
    Definition Classes
    ContextUser
  72. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  73. val compositeAssign: Assignable
    Definition Classes
    Assignable
  74. def copyDirectionOf(that: Bits): Unit
    Definition Classes
    DataPrimitives
  75. def copyDirectionOfImpl(that: Data): Bits.this.type
    Definition Classes
    BaseType → Data
  76. def default(that: ⇒ Bits): Bits

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  77. def dirString(): String
    Definition Classes
    Data
  78. def dlcAppend(that: AssignmentStatement): Bits.this.type
    Definition Classes
    DoubleLinkedContainer
  79. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  80. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  81. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  82. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  83. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  84. def dlcPrepend(that: AssignmentStatement): Bits.this.type
    Definition Classes
    DoubleLinkedContainer
  85. def dontSimplifyIt(): Bits.this.type
    Definition Classes
    BaseType → Data
  86. 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)
  87. 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)
  88. def dropLow(n: Int): Bits
    Definition Classes
    BitVector
  89. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  90. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  91. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  92. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  93. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  94. def flatten: Seq[BaseType]
    Definition Classes
    BaseType → Data
  95. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    BaseType → Data
  96. def flattenLocalName: Seq[String]
    Definition Classes
    BaseType → Data
  97. def flip(): Bits.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  98. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit
    Definition Classes
    BaseType → Statement
  99. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  100. def foreachExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  101. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  102. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit
    Definition Classes
    StatementDoubleLinkedContainer
  103. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  104. def freeze(): Bits.this.type
    Definition Classes
    BaseType → Data
  105. def getAheadValue(): Bits.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
  106. def getAllTrue: Bits.this.type
    Definition Classes
    Bits → BitVector
  107. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

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

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  111. def getDirection: IODirection
    Definition Classes
    Data
  112. def getDisplayName(): String
    Definition Classes
    Nameable
  113. def getDrivingReg(reportError: Boolean = true): Bits.this.type
    Definition Classes
    BaseType
  114. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  115. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  116. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    BitVector → Data
  117. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  118. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  119. def getPartialName(): String
    Definition Classes
    Nameable
  120. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  121. def getRealSource: Any
    Definition Classes
    Assignable
  122. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  123. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  124. def getRootParent: Data
    Definition Classes
    Data
  125. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  126. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  127. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  128. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  129. def getSingleDriver: Option[Bits.this.type]
    Definition Classes
    BaseType
  130. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  131. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  132. def getTypeObject: TypeBits.type
    Definition Classes
    Bits → Expression
  133. def getWidth: Int
    Definition Classes
    Widthable → WidthProvider
  134. def getWidthNoInferation: Int

    Return the width

    Return the width

    Definition Classes
    BitVector
  135. def getWidthStringNoInferation: String
    Definition Classes
    BitVector
  136. def getZero: Bits.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    Bits → Data
  137. def getZeroUnconstrained: Bits.this.type
    Definition Classes
    Bits → BitVector
  138. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  139. def hasAssignement: Boolean
    Definition Classes
    BaseType
  140. def hasDataAssignment: Boolean
    Definition Classes
    BaseType
  141. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  142. def hasOnlyOneStatement: Boolean
    Definition Classes
    StatementDoubleLinkedContainer
  143. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  144. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  145. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  146. def head: AssignmentStatement
    Definition Classes
    StatementDoubleLinkedContainer
  147. def high: Int

    Return the upper bound

    Return the upper bound

    Definition Classes
    BitVector
  148. def init(that: Bits): Bits

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  149. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  150. def initial(that: Bits): Bits
    Definition Classes
    BaseTypePrimitives
  151. def initialFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    BaseType
  152. def insertNext(s: Statement): Unit
    Definition Classes
    Statement
  153. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  154. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  155. def isAnalog: Boolean
    Definition Classes
    BaseType → Data
  156. def isComb: Boolean
    Definition Classes
    BaseType → Data
  157. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  158. def isDirectionLess: Boolean
    Definition Classes
    Data
  159. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  160. def isFrozen(): Boolean
    Definition Classes
    BaseType
  161. def isInOut: Boolean
    Definition Classes
    Data
  162. def isInput: Boolean
    Definition Classes
    Data
  163. def isInputOrInOut: Boolean
    Definition Classes
    Data
  164. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  165. final def isNamed: Boolean
    Definition Classes
    Nameable
  166. def isOutput: Boolean
    Definition Classes
    Data
  167. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  168. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  169. def isReg: Boolean
    Definition Classes
    BaseType → Data
  170. def isRegOnAssign: Boolean
    Definition Classes
    BitVector → Data
  171. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  172. def isUnknown: Bool
    Definition Classes
    BitVector
  173. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  174. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  175. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  176. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  177. val lastScopeStatement: Statement
    Definition Classes
    Statement
  178. def lsb: Bool

    Return the least significant bit

    Return the least significant bit

    Definition Classes
    BitVector
  179. def msb: Bool

    Return the most significant bit

    Return the most significant bit

    Definition Classes
    BitVector
  180. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  181. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  182. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  183. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  184. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  185. val name: String
    Definition Classes
    Nameable
  186. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  187. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  188. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating)(implicit loc: Location): Bits.this.type

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

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

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

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

    Extract a bit of the BitVector

    Extract a bit of the BitVector

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

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  192. val nextScopeStatement: Statement
    Definition Classes
    Statement
  193. def noBackendCombMerge(): Bits.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
  194. def noCombLoopCheck(): Bits.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
  195. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  196. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  197. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  198. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  199. def opName: String
    Definition Classes
    Bits → Expression
  200. def orMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  201. def orR: Bool

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  202. def overrideLocalName(name: String): Bits.this.type
    Definition Classes
    Nameable
  203. val parent: Data
    Definition Classes
    Data
  204. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  205. def pull(propagateName: Boolean): Bits.this.type
    Definition Classes
    Data
  206. def pull(): Bits.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
  207. def purify(): Bits.this.type
    Definition Classes
    Data
  208. def randBoot(u: Unit): Bits.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
  209. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  210. def reflectNames(): Unit
    Definition Classes
    Nameable
  211. def remapClockDomain(func: (ClockDomain) ⇒ ClockDomain): Unit
    Definition Classes
    BaseType → Statement
  212. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  213. def remapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  214. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Bits.this.type

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseType → Data
  215. def removeDataAssignments(): Bits.this.type
    Definition Classes
    Data
  216. def removeInitAssignments(): Bits.this.type
    Definition Classes
    Data
  217. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  218. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  219. def removeTag(spinalTag: SpinalTag): Bits.this.type
    Definition Classes
    SpinalTagReady
  220. def removeTags(tags: Iterable[SpinalTag]): Bits.this.type
    Definition Classes
    SpinalTagReady
  221. def resize(width: BitCount): Bits
    Definition Classes
    Bits → BitVector
  222. def resize(width: Int): Bits

    Resize the bitVector to width

    Resize the bitVector to width

    returns

    a resized bitVector

    Definition Classes
    Bits → BitVector
    Example: 

    1. val res = myBits.resize(10)
  223. def resizeFactory: Resize
    Definition Classes
    Bits → BitVector
  224. def resizeLeft(width: Int): Bits

    Resize by keeping MSB at the same place If the final size is bigger than the original size, the leftmost bits are filled with zeroes if the final size is smaller, only width MSB are kept

    Resize by keeping MSB at the same place If the final size is bigger than the original size, the leftmost bits are filled with zeroes if the final size is smaller, only width MSB are kept

    width

    Final width

    returns

    Resized bits vector

  225. def resized: Bits.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  226. def reversed: Bits.this.type
    Definition Classes
    Bits → BitVector
  227. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  228. def rootIFList(): List[Interface]
    Definition Classes
    Data
  229. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  230. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  231. def rotateLeft(that: Int): Bits

    Left rotation of that bits

    Left rotation of that bits

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

    Left rotation of that Bits

    Left rotation of that Bits

    Definition Classes
    BitVector
  233. def rotateRight(that: Int): Bits

    Right rotation of that bits

    Right rotation of that bits

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

    Right rotation of that Bits

    Right rotation of that Bits

    Definition Classes
    BitVector
  235. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  236. def setAll(): Bits.this.type

    Set all bits

    Set all bits

    Definition Classes
    Bits → BitVector → Data
  237. def setAllTo(value: Bool): Bits.this.type

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  238. def setAllTo(value: Boolean): Bits.this.type

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  239. def setAsAnalog(): Bits.this.type
    Definition Classes
    BaseType → Data
  240. def setAsComb(): Bits.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType → Data
  241. def setAsDirectionLess(): Bits.this.type

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

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

    Definition Classes
    BaseType → Data
  242. def setAsReg(): Bits.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType → Data
  243. def setAsTypeNode(): Bits.this.type

    Set baseType to Node

    Set baseType to Node

    Definition Classes
    BaseType
  244. def setAsVital(): Bits.this.type

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  245. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  246. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  247. def setCompositeName(nameable: Nameable, postfix: String): Bits.this.type
    Definition Classes
    Nameable
  248. def setCompositeName(nameable: Nameable, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  249. def setCompositeName(nameable: Nameable, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  250. def setCompositeName(nameable: Nameable): Bits.this.type
    Definition Classes
    Nameable
  251. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Bits.this.type
    Definition Classes
    Nameable
  252. def setName(name: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  253. def setName(name: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  254. def setName(name: String): Bits.this.type
    Definition Classes
    Nameable
  255. def setNameAsWeak(): Bits.this.type
    Definition Classes
    Nameable
  256. def setOutputAsReg(): Bits.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  257. def setPartialName(name: String, namePriority: Byte, owner: Any): Bits.this.type
    Definition Classes
    Nameable
  258. def setPartialName(name: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  259. def setPartialName(name: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  260. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  261. def setPartialName(owner: Nameable, name: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  262. def setPartialName(name: String): Bits.this.type
    Definition Classes
    Nameable
  263. def setPartialName(owner: Nameable, name: String): Bits.this.type
    Definition Classes
    Nameable
  264. def setPartialName(owner: Nameable): Bits.this.type
    Definition Classes
    Nameable
  265. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  266. def setScalaLocated(source: ScalaLocated): Bits.this.type
    Definition Classes
    ScalaLocated
  267. def setWeakName(name: String): Bits.this.type
    Definition Classes
    Nameable
  268. def setWidth(width: Int): Bits.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
  269. def simplifyNode: Expression
    Definition Classes
    Expression
  270. def sliceBy(divisor: List[Int]): List[Bits]
    Definition Classes
    BitVector
  271. 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))
  272. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  273. 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)
  274. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression
    Definition Classes
    ExpressionContainer
  275. def subdivideIn(sliceWidth: BitCount): Vec[T]
    Definition Classes
    BitVector
  276. def subdivideIn(sliceCount: SlicesCount): Vec[T]
    Definition Classes
    BitVector
  277. 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)
  278. 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)
  279. def switchAssign[T2 <: BaseType](sel: T2)(mappings: (Any, Bits)*): Unit
    Definition Classes
    DataPrimitives
  280. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  281. 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)
  282. 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)
  283. def takeLow(n: Int): Bits
    Definition Classes
    BitVector
  284. def toDataType[T <: Data](dataType: T): T

    Cast a Bits to a given data type

    Cast a Bits to a given data type

    dataType

    the wanted data type

    returns

    a new data type assign with the value of Bits

    Example: 

    1. val myUInt = myBits.toDataType(UInt)
  285. def toIo(): Bits.this.type
    Definition Classes
    Data
  286. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  287. def toString(): String
    Definition Classes
    BitVector → BaseType → Expression → Nameable → AnyRef → Any
  288. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  289. def toStringRec(level: Int = 1): String
    Definition Classes
    Expression
  290. def unary_~: Bits

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    Bits → BitwiseOp
  291. def unfreeze(): Bits.this.type
    Definition Classes
    BaseType → Data
  292. def unsetName(): Bits.this.type
    Definition Classes
    Nameable
  293. def valueRange: Range
  294. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  295. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  296. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  297. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  298. def walkExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  299. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  300. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  301. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  302. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  303. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  304. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  305. def wrapNext(): Bits.this.type
    Definition Classes
    Data
  306. def xorMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  307. def xorR: Bool

    Logical XOR of all bits

    Logical XOR of all bits

    Definition Classes
    BitVector
  308. def |(right: Bits): Bits

    Bitwise OR operator

    Bitwise OR operator

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

    Logical shift left (output width == input width)

  310. def |<<(that: Int): Bits

    Logical shift left (output width == input width)

  311. def |>>(that: UInt): Bits

    Logical shift Right (output width == input width)

  312. def |>>(that: Int): Bits

    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 = myBits |>> 4

Deprecated Value Members

  1. def asDirectionLess(): Bits.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): Bits.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[Bits]

Inherited from BaseTypePrimitives[Bits]

Inherited from DataPrimitives[Bits]

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