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. Protected

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 signals

    Concatenation between two signals

    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

    Standard hardware assignment, equivalent to <= in VHDL/Verilog

    Standard hardware assignment, equivalent to <= in VHDL/Verilog

    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

    Automatic connection between two hardware signals or two bundles of the same type.

    Automatic connection between two hardware signals or two bundles of the same type.

    Direction is inferred by using signal direction (in/out). (Similar behavior to :=)

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

    isNotEqualTo comparison between two SpinalHDL data

    isNotEqualTo comparison between two SpinalHDL data

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

    BitVector is not equal to MaskedLiteral

    BitVector is not equal to MaskedLiteral

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

    isEqualTo comparison between two SpinalHDL data

    isEqualTo comparison between two SpinalHDL data

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

    Logical shift right (output width == input width)

  20. 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
  21. def IFparent: Data
    Definition Classes
    Data
  22. 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
  23. def ^(right: Bits): Bits

    Bitwise XOR operator

    Bitwise XOR operator

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

  35. def allowDirectionLessIo(): Bits.this.type

    Allow a signal of an io Bundle to be directionless.

    Allow a signal of an io Bundle to be directionless.

    Definition Classes
    Data
    See also

    IO Bundle Error Documentation

  36. def allowOverride(): Bits.this.type

    Allow a signal to be overridden.

    Allow a signal to be overridden.

    Definition Classes
    Data
    See also

    Assignment overlap Error Documentation

  37. def allowPartialyAssigned(): Bits.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  38. def allowPruning(): Bits.this.type
    Definition Classes
    Data
  39. def allowSimplifyIt(): Bits.this.type
    Definition Classes
    BaseType → Data
  40. 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)

    Definition Classes
    Data
    See also

    "Register with only init" Error Documentation

  41. def andMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  42. def andR: Bool

    Hardware logical AND of all bits

    Hardware logical AND of all bits

    Equivalent to this.asBits === ((BigInt(1) << getWidth) - 1).

    Definition Classes
    BitVector
  43. 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)
  44. 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)
  45. 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)
  46. 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)
  47. 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)
  48. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  49. def asBits: Bits

    Cast signal to Bits

    Cast signal to Bits

    Definition Classes
    Bits → Data
  50. def asBool: Bool

    Return this.lsb

    Return this.lsb

    Definition Classes
    BitVector
  51. def asBools: Vec[Bool]

    Cast the BitVector into a vector of Bool

    Cast the BitVector into a vector of Bool

    Definition Classes
    BitVector
  52. def asData: Data
    Definition Classes
    Data
  53. def asInOut(): Bits.this.type

    Set a signal as inout

    Set a signal as inout

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

    Set a data as input

    Set a data as input

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

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  57. 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
  58. 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
  59. def assignDontCare(): Bits.this.type
    Definition Classes
    Bits → Data
  60. def assignDontCareToUnasigned(): Bits.this.type
    Definition Classes
    Data
  61. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    Bits → Data
  62. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  63. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    Bits → Data
  64. def assignFromBits(bits: Bits): Unit
    Definition Classes
    Bits → Data
  65. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  66. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    BaseType → Assignable
  67. def bitsRange: Range
    Definition Classes
    BitVector
  68. def cldCount: Int
    Definition Classes
    DoubleLinkedContainer
  69. def clearAll(): Bits.this.type

    Clear all bits

    Clear all bits

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

    Set a default value to a signal.

    Set a default value to a signal.

    Definition Classes
    DataPrimitives
    See also

    example of usage for Bits

  78. def dirString(): String
    Definition Classes
    Data
  79. def dlcAppend(that: AssignmentStatement): Bits.this.type
    Definition Classes
    DoubleLinkedContainer
  80. def dlcForeach[T >: AssignmentStatement](func: (T) => Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  81. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  82. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  83. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  84. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  85. def dlcPrepend(that: AssignmentStatement): Bits.this.type
    Definition Classes
    DoubleLinkedContainer
  86. def dontSimplifyIt(): Bits.this.type
    Definition Classes
    BaseType → Data
  87. def drop(n: Int): Bits

    Drop lowest n bits

    Drop lowest n bits

    returns

    data10bits(9 downto 4)

    Definition Classes
    BitVector
    Example:

    1. val res = data10bits.drop(4)
  88. 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)
  89. def dropLow(n: Int): Bits
    Definition Classes
    BitVector
  90. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  91. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  92. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  93. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  94. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  95. def flatten: Seq[BaseType]
    Definition Classes
    BaseType → Data
  96. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    BaseType → Data
  97. def flattenLocalName: Seq[String]
    Definition Classes
    BaseType → Data
  98. def flip(): Bits.this.type

    Flip the direction of the signal.

    Flip the direction of the signal.

    in and out are swapped, inout stay the same.

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

    Return the width of the data

    Return the width of the data

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

    Get current component with all parents

    Get current component with all parents

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

    Return the width

    Return the width

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

    Create a signal set to 0

    Create a signal set to 0

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

    Does the base type have initial value

    Does the base type have initial value

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

    Return the upper bound

    Return the upper bound

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

    Set initial value of the signal

    Set initial value of the signal

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

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  175. def isUnknown: Bool
    Definition Classes
    BitVector
  176. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  177. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  178. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  179. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  180. val lastScopeStatement: Statement
    Definition Classes
    Statement
  181. def lsb: Bool

    Return the least significant bit

    Return the least significant bit

    Definition Classes
    BitVector
  182. def msb: Bool

    Return the most significant bit

    Return the most significant bit

    Definition Classes
    BitVector
  183. def mux[T2 <: Data](mappings: (Any, T2)*): T2

    Use a SpinalHDL data as a selector for a mux.

    Use a SpinalHDL data as a selector for a mux.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  184. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2

    Version of SpinalHDL mux that allows Don't Care.

    Version of SpinalHDL mux that allows Don't Care.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  185. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  186. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  187. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Version of SpinalHDL muxList that allows Don't Care.

    Version of SpinalHDL muxList that allows Don't Care.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  188. val name: String
    Definition Classes
    Nameable
  189. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  190. def nandR: Bool

    Hardware logical NAND of all bits

    Hardware logical NAND of all bits

    Definition Classes
    BitVector
  191. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  192. 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
  193. 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
  194. def newExtract(bitId: UInt, extract: BitVectorBitAccessFloating): Bool

    Extract a bit of the BitVector

    Extract a bit of the BitVector

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

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  196. val nextScopeStatement: Statement
    Definition Classes
    Statement
  197. 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
  198. def noCombLoopCheck(): Bits.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    Definition Classes
    Data
    See also

    Combinatorial loop Error Documentation

  199. def norR: Bool

    Hardware logical NOR of all bits

    Hardware logical NOR of all bits

    Definition Classes
    BitVector
  200. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  201. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  202. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  203. def nxorR: Bool

    Hardware logical NXOR of all bits

    Hardware logical NXOR of all bits

    Definition Classes
    BitVector
  204. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  205. def opName: String
    Definition Classes
    Bits → Expression
  206. def orMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  207. def orR: Bool

    Hardware logical OR of all bits

    Hardware logical OR of all bits

    Equivalent to this.asBits =/= 0.

    Definition Classes
    BitVector
  208. def overrideLocalName(name: String): Bits.this.type
    Definition Classes
    Nameable
  209. val parent: Data
    Definition Classes
    Data
  210. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  211. def pull(propagateName: Boolean): Bits.this.type
    Definition Classes
    Data
  212. 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
  213. def purify(): Bits.this.type
    Definition Classes
    Data
  214. 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
  215. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  216. def reflectNames(): Unit
    Definition Classes
    Nameable
  217. def remapClockDomain(func: (ClockDomain) => ClockDomain): Unit
    Definition Classes
    BaseType → Statement
  218. def remapDrivingExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  219. def remapExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  220. 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
  221. def removeDataAssignments(): Bits.this.type
    Definition Classes
    Data
  222. def removeInitAssignments(): Bits.this.type
    Definition Classes
    Data
  223. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  224. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  225. def removeTag(spinalTag: SpinalTag): Bits.this.type
    Definition Classes
    SpinalTagReady
  226. def removeTags(tags: Iterable[SpinalTag]): Bits.this.type
    Definition Classes
    SpinalTagReady
  227. def resize(width: BitCount): Bits

    Return a resized representation of x.

    Return a resized representation of x.

    If enlarged, it is extended with zero padding at MSB as necessary.

    Definition Classes
    Bits → BitVector
  228. def resize(width: Int): Bits

    Return a resized representation of x.

    Return a resized representation of x.

    If enlarged, it is extended with zero padding at MSB as necessary.

    returns

    a resized bitVector

    Definition Classes
    Bits → BitVector
  229. def resizeFactory: Resize
    Definition Classes
    Bits → BitVector
  230. 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

  231. def resized: Bits.this.type

    Return a version of the signal which is allowed to be automatically resized where needed.

    Return a version of the signal which is allowed to be automatically resized where needed.

    The resize operation is deferred until the point of assignment later. The resize may widen or truncate, retaining the LSB.

    Definition Classes
    Data
    See also

    Width checking Documentation

  232. def reversed: Bits.this.type
    Definition Classes
    Bits → BitVector
  233. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  234. def rootIFList(): List[Interface]
    Definition Classes
    Data
  235. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  236. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  237. def rotateLeft(that: Int): Bits

    Left rotation of that bits

    Left rotation of that bits

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

    Left rotation of that Bits

    Left rotation of that Bits

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

    Right rotation of that bits

    Right rotation of that bits

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

    Right rotation of that Bits

    Right rotation of that Bits

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

    Set all bits

    Set all bits

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

    Set all bits to value

    Set all bits to value

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

    Set all bits to value

    Set all bits to value

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

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

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

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

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

    Set baseType to reg

    Set baseType to reg

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

    Set baseType to Node

    Set baseType to Node

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

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  251. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  252. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  253. def setCompositeName(nameable: Nameable, postfix: String): Bits.this.type
    Definition Classes
    Nameable
  254. def setCompositeName(nameable: Nameable, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  255. def setCompositeName(nameable: Nameable, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  256. def setCompositeName(nameable: Nameable): Bits.this.type
    Definition Classes
    Nameable
  257. def setLambdaName(isNameBody: => Boolean)(nameGen: => String): Bits.this.type
    Definition Classes
    Nameable
  258. def setName(name: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  259. def setName(name: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  260. def setName(name: String): Bits.this.type
    Definition Classes
    Nameable
  261. def setNameAsWeak(): Bits.this.type
    Definition Classes
    Nameable
  262. def setOutputAsReg(): Bits.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

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

    Take lowest n bits

    Take lowest n bits

    returns

    data10bits(3 downto 0)

    Definition Classes
    BitVector
    Example:

    1. val res = data10bits.take(4)
  288. 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)
  289. def takeLow(n: Int): Bits
    Definition Classes
    BitVector
  290. 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)
  291. def toIo(): Bits.this.type
    Definition Classes
    Data
  292. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  293. def toString(): String
    Definition Classes
    BitVector → BaseType → Expression → Nameable → AnyRef → Any
  294. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  295. def toStringRec(level: Int = 1): String
    Definition Classes
    Expression
  296. def unary_~: Bits

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    Bits → BitwiseOp
  297. def unfreeze(): Bits.this.type
    Definition Classes
    BaseType → Data
  298. def unsetName(): Bits.this.type
    Definition Classes
    Nameable
  299. def valueRange: Range
  300. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  301. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  302. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  303. def walkDrivingExpressions(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  304. def walkExpression(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  305. def walkExpressionPostorder(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  306. def walkParentTreeStatements(func: (TreeStatement) => Unit): Unit
    Definition Classes
    Statement
  307. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) => Unit): Unit
    Definition Classes
    Statement
  308. def walkRemapDrivingExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  309. def walkRemapExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  310. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  311. def wrapNext(): Bits.this.type
    Definition Classes
    Data
  312. def xorMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  313. def xorR: Bool

    Hardware logical XOR of all bits

    Hardware logical XOR of all bits

    Equivalent to this.asBools.reduce(_ ^ _).

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

    Bitwise OR operator

    Bitwise OR operator

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

    Logical shift left (output width == input width)

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

    Logical shift left (output width == input width)

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

    Logical shift Right (output width == input width)

  318. 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

    (Since version 9)

  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