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 data

    Concatenation between two data

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

    Logical AND operator

    Logical 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): 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): 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 \(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
  21. def ^(right: Bits): Bits

    Logical XOR operator

    Logical XOR operator

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

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  33. def allowPartialyAssigned: Bits.this.type
    Definition Classes
    Data
  34. def allowPruning(): Bits.this.type
    Definition Classes
    Data
  35. def allowSimplifyIt(): Bits.this.type
    Definition Classes
    BaseType → Data
  36. def allowUnsetRegToAvoidLatch: Bits.this.type
    Definition Classes
    Data
  37. def andMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  38. def andR: Bool

    Logical AND of all bits

    Logical AND of all bits

    Definition Classes
    BitVector
  39. 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)
  40. 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)
  41. 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)
  42. 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)
  43. 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)
  44. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  45. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

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

    set a data as inout

    set a data as inout

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

    Set a data as input

    Set a data as input

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

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  53. 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
  54. 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
  55. def assignDontCare(): Bits.this.type
    Definition Classes
    Bits → Data
  56. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    Bits → Data
  57. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  58. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    Bits → Data
  59. def assignFromBits(bits: Bits): Unit
    Definition Classes
    Bits → Data
  60. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  61. def bitsRange: Range
    Definition Classes
    BitVector
  62. def cldCount: Int
    Definition Classes
    DoubleLinkedContainer
  63. def clearAll(): Bits.this.type

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector
  64. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  65. def clone(): Bits.this.type
    Definition Classes
    BitVector → BaseType → Data → AnyRef
  66. def component: Component
    Definition Classes
    ContextUser
  67. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
    Definition Classes
    Assignable
  68. val compositeAssign: Assignable
    Definition Classes
    Assignable
  69. def copyDirectionOf(that: Bits): Unit
    Definition Classes
    DataPrimitives
  70. def copyDirectionOfImpl(that: Data): Bits.this.type
    Definition Classes
    BaseType → Data
  71. def default(that: => Bits): Bits

    Set a default value to a data

    Set a default value to a data

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

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  93. def foreachClockDomain(func: (ClockDomain) => Unit): Unit
    Definition Classes
    BaseType → Statement
  94. def foreachDrivingExpression(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  95. def foreachExpression(func: (Expression) => Unit): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  96. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  97. def foreachStatements(func: (AssignmentStatement) => Unit): Unit
    Definition Classes
    StatementDoubleLinkedContainer
  98. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  99. def freeze(): Bits.this.type
    Definition Classes
    BaseType → Data
  100. def genIf(cond: Boolean): Bits.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  101. def getAheadValue(): Bits.this.type
    Definition Classes
    BaseType → Data
  102. def getAllTrue: Bits.this.type
    Definition Classes
    Bits → BitVector
  103. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

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

    Get current component with all parents

    Get current component with all parents

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

    Return the width

    Return the width

    Definition Classes
    BitVector
  130. def getWidthStringNoInferation: String
    Definition Classes
    BitVector
  131. def getZero: Bits.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    Bits → Data
  132. def getZeroUnconstrained: Bits.this.type
    Definition Classes
    Bits → BitVector
  133. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  134. def hasAssignement: Boolean
    Definition Classes
    BaseType
  135. def hasDataAssignment: Boolean
    Definition Classes
    BaseType
  136. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  137. def hasOnlyOneStatement: Boolean
    Definition Classes
    StatementDoubleLinkedContainer
  138. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  139. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  140. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  141. def head: AssignmentStatement
    Definition Classes
    StatementDoubleLinkedContainer
  142. def high: Int

    Return the upper bound

    Return the upper bound

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

    Set initial value to a data

    Set initial value to a data

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

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  166. def isUnnamed: Boolean
    Definition Classes
    Nameable
  167. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  168. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  169. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  170. val lastScopeStatement: Statement
    Definition Classes
    Statement
  171. def lsb: Bool

    Return the least significant bit

    Return the least significant bit

    Definition Classes
    BitVector
  172. def msb: Bool

    Return the most significant bit

    Return the most significant bit

    Definition Classes
    BitVector
  173. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  174. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  175. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  176. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  177. val name: String
    Definition Classes
    Nameable
  178. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  179. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  180. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating): Bits.this.type

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

    Definition Classes
    BitVector
  181. 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
  182. def newExtract(bitId: UInt, extract: BitVectorBitAccessFloating): Bool

    Extract a bit of the BitVector

    Extract a bit of the BitVector

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

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  184. val nextScopeStatement: Statement
    Definition Classes
    Statement
  185. def noBackendCombMerge: Bits.this.type
    Definition Classes
    Data
  186. def noCombLoopCheck: Bits.this.type
    Definition Classes
    Data
  187. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  188. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  189. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  190. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  191. def opName: String
    Definition Classes
    Bits → Expression
  192. def orMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  193. def orR: Bool

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  194. def overrideLocalName(name: String): Bits.this.type
    Definition Classes
    Nameable
  195. val parent: Data
    Definition Classes
    Data
  196. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  197. def pull(propagateName: Boolean): Bits.this.type
    Definition Classes
    Data
  198. 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
  199. def purify(): Bits.this.type
    Definition Classes
    Data
  200. 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
  201. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  202. def reflectNames(): Unit
    Definition Classes
    Nameable
  203. def remapDrivingExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  204. def remapExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  205. def removeAssignments(): Bits.this.type

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseType → Data
  206. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  207. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  208. def removeTag(spinalTag: SpinalTag): Bits.this.type
    Definition Classes
    SpinalTagReady
  209. def removeTags(tags: Iterable[SpinalTag]): Bits.this.type
    Definition Classes
    SpinalTagReady
  210. def resize(width: BitCount): Bits
    Definition Classes
    Bits → BitVector
  211. 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)
  212. def resizeFactory: Resize
    Definition Classes
    Bits → BitVector
  213. 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

  214. def resized: Bits.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  215. def reversed: Bits
  216. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  217. def rotateLeft(that: Int): Bits

    Left rotation of that bits

    Left rotation of that bits

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

    Left rotation of that Bits

    Left rotation of that Bits

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

    Right rotation of that bits

    Right rotation of that bits

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

    Right rotation of that Bits

    Right rotation of that Bits

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

    Set all bits

    Set all bits

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

    Set all bits to value

    Set all bits to value

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

    Set all bits to value

    Set all bits to value

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

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType → Data
  227. 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
  228. def setAsReg(): Bits.this.type

    Set baseType to reg

    Set baseType to reg

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

    Set baseType to Node

    Set baseType to Node

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

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  231. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  232. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  233. def setCompositeName(nameable: Nameable, postfix: String): Bits.this.type
    Definition Classes
    Nameable
  234. def setCompositeName(nameable: Nameable, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  235. def setCompositeName(nameable: Nameable, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  236. def setCompositeName(nameable: Nameable): Bits.this.type
    Definition Classes
    Nameable
  237. def setName(name: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  238. def setName(name: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  239. def setName(name: String): Bits.this.type
    Definition Classes
    Nameable
  240. def setNameAsWeak(): Bits.this.type
    Definition Classes
    Nameable
  241. def setPartialName(name: String, namePriority: Byte, owner: Any): Bits.this.type
    Definition Classes
    Nameable
  242. def setPartialName(name: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  243. def setPartialName(name: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  244. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Bits.this.type
    Definition Classes
    Nameable
  245. def setPartialName(owner: Nameable, name: String, weak: Boolean): Bits.this.type
    Definition Classes
    Nameable
  246. def setPartialName(name: String): Bits.this.type
    Definition Classes
    Nameable
  247. def setPartialName(owner: Nameable, name: String): Bits.this.type
    Definition Classes
    Nameable
  248. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  249. def setScalaLocated(source: ScalaLocated): Bits.this.type
    Definition Classes
    ScalaLocated
  250. def setWeakName(name: String): Bits.this.type
    Definition Classes
    Nameable
  251. 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
  252. def simplifyNode: Expression
    Definition Classes
    Expression
  253. def sliceBy(divisor: List[Int]): List[Bits]
    Definition Classes
    BitVector
  254. 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))
  255. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  256. 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)
  257. def stabilized(func: (Expression) => Expression, seed: Expression): Expression
    Definition Classes
    ExpressionContainer
  258. def subdivideIn(sliceWidth: BitCount): Vec[T]
    Definition Classes
    BitVector
  259. def subdivideIn(sliceCount: SlicesCount): Vec[T]
    Definition Classes
    BitVector
  260. def subdivideIn(sliceWidth: BitCount, strict: Boolean): Vec[T]

    Split the BitVector into slice of x bits * @example

    Split the BitVector into slice of x bits * @example 

    val res = myBits.subdiviedIn(3 bits)
    sliceWidth

    the width of the slice

    returns

    a Vector of slices

    Definition Classes
    BitVector
  261. 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

    returns

    a Vector of slices

    Definition Classes
    BitVector
    Example:

    1. val res = myBits.subdiviedIn(3 slices)
  262. def switchAssign[T2 <: BaseType](sel: T2)(mappings: (Any, Bits)*): Unit
    Definition Classes
    DataPrimitives
  263. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  264. 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)
  265. 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)
  266. def takeLow(n: Int): Bits
    Definition Classes
    BitVector
  267. 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)
  268. def toIo(): Bits.this.type
    Definition Classes
    Data
  269. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  270. def toString(): String
    Definition Classes
    BitVector → BaseType → Expression → Nameable → AnyRef → Any
  271. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  272. def toStringRec(level: Int = 1): String
    Definition Classes
    Expression
  273. def unary_~: Bits

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    Bits → BitwiseOp
  274. def unfreeze(): Bits.this.type
    Definition Classes
    BaseType → Data
  275. def unsetName(): Bits.this.type
    Definition Classes
    Nameable
  276. def valueRange: Range
  277. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  278. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  279. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  280. def walkDrivingExpressions(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  281. def walkExpression(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  282. def walkExpressionPostorder(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  283. def walkParentTreeStatements(func: (TreeStatement) => Unit): Unit
    Definition Classes
    Statement
  284. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) => Unit): Unit
    Definition Classes
    Statement
  285. def walkRemapDrivingExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  286. def walkRemapExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  287. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  288. def wrapNext(): Bits.this.type
    Definition Classes
    Data
  289. def xorMask(that: Bool): Bits.this.type
    Definition Classes
    BitVector
  290. def xorR: Bool

    Logical XOR of all bits

    Logical XOR of all bits

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

    Logical OR operator

    Logical OR operator

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

    Logical shift left (output width == input width)

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

    Logical shift left (output width == input width)

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

    Logical shift Right (output width == input width)

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