Class

spinal.core

Bits

Related Doc: package core

Permalink

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

Instance Constructors

  1. new Bits()

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  2. type T = Bits

    Permalink

    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
    BitsBitVector

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##(right: Bits): Bits

    Permalink

    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

    Permalink

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  4. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  5. def &(right: Bits): Bits

    Permalink

    Logical AND operator

    Logical AND operator

    Definition Classes
    BitsBitwiseOp
  6. def :=(value: String): Unit

    Permalink
  7. def :=(rangesValue: (Any, Any), _rangesValues: (Any, Any)*): Unit

    Permalink

    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)
  8. def :=(that: Bits): Unit

    Permalink

    Assign a data to this

    Assign a data to this

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

    Permalink

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

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

    Permalink

    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
  11. def <>(that: Bits): Unit

    Permalink

    Auto connection between two data

    Auto connection between two data

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

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

    Permalink

    BitVector is not equal to MaskedLiteral

    BitVector is not equal to MaskedLiteral

    Definition Classes
    BitVector
  14. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def ===(that: Bits): Bool

    Permalink

    Comparison between two data

    Comparison between two data

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

    Permalink

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

    Permalink

    Logical shift right (output width == input width)

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

    Permalink

    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
  19. def \(that: Bits): Bits

    Permalink

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

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

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

    Permalink

    Logical XOR operator

    Logical XOR operator

    Definition Classes
    BitsBitwiseOp
  21. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  22. def addAttribute(attribute: Attribute): Bits.this.type

    Permalink
    Definition Classes
    BaseTypeDataSpinalTagReady
  23. def addAttribute(name: String, value: String): Bits.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  24. def addAttribute(name: String): Bits.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  26. def addTags[T <: SpinalTag](tags: Iterable[T]): Bits.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  27. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  28. var algoInt: Int

    Permalink
    Definition Classes
    BaseNode
  29. def allowDirectionLessIo: Bits.this.type

    Permalink
    Definition Classes
    Data
  30. def allowOverride: Bits.this.type

    Permalink

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  31. def allowPartialyAssigned: Bits.this.type

    Permalink
    Definition Classes
    Data
  32. def allowPruning(): Bits.this.type

    Permalink
    Definition Classes
    Data
  33. def allowSimplifyIt(): Bits.this.type

    Permalink
    Definition Classes
    BaseTypeData
  34. def allowUnsetRegToAvoidLatch: Bits.this.type

    Permalink
    Definition Classes
    Data
  35. def andR: Bool

    Permalink

    Logical AND of all bits

    Logical AND of all bits

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

    Permalink

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Definition Classes
    BitsBitVector
    Example:
    1. val myBool = myBits(myUInt, 2 bits)
  37. def apply(offset: Int, bitCount: BitCount): Bits.this.type

    Permalink

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Definition Classes
    BitsBitVector
    Example:
    1. val myBool = myBits(3, 2 bits)
  38. def apply(bitId: UInt): Bool

    Permalink

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    BitsBitVector
    Example:
    1. val myBool = myBits(myUInt)
  39. def apply(bitId: Int): Bool

    Permalink

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    BitsBitVector
    Example:
    1. val myBool = myBits(3)
  40. def apply(range: Range): Bits.this.type

    Permalink

    Return a range of bits

    Return a range of bits

    Definition Classes
    BitVector
    Example:
    1. val myBool = myBits(3 downto 1)
  41. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  42. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    BitsData
  43. def asBool: Bool

    Permalink
    Definition Classes
    BitVector
  44. def asBools: Vec[Bool]

    Permalink

    Cast the BitVector into a Vector of Bool

    Cast the BitVector into a Vector of Bool

    returns

    a vector of Bool

    Definition Classes
    BitVector
  45. def asData: Data

    Permalink
    Definition Classes
    Data
  46. def asInOut(): Bits.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    BaseTypeData
  47. def asInput(): Bits.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    BaseTypeData
  48. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  49. def asOutput(): Bits.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  50. def asSInt: SInt

    Permalink

    Cast a Bits to a SInt

    Cast a Bits to a SInt

    returns

    a SInt data

    Example:
    1. val mySInt = myBits.asSInt
  51. def asUInt: UInt

    Permalink

    Cast a Bits to an UInt

    Cast a Bits to an UInt

    returns

    an UInt data

    Example:
    1. val myUInt = myBits.asUInt
  52. def assignDontCare(): Bits.this.type

    Permalink
    Definition Classes
    BitsData
  53. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

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

    Permalink
    Definition Classes
    BitsData
  55. def assignFromBits(bits: Bits): Unit

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

    Permalink
    Definition Classes
    Data
  57. def clearAll(): Bits.this.type

    Permalink

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector
  58. var clockDomain: ClockDomain

    Permalink
    Definition Classes
    BaseType
  59. def clone(): Bits.this.type

    Permalink
    Definition Classes
    BitVectorBaseTypeData → AnyRef
  60. def component: Component

    Permalink
    Definition Classes
    ContextUser
  61. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Permalink
    Definition Classes
    Assignable
  62. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable
  63. def copyDirectionOf(that: Bits): Unit

    Permalink
    Definition Classes
    DataPrimitives
  64. def copyDirectionOfImpl(that: Data): Bits.this.type

    Permalink
    Definition Classes
    BaseTypeData
  65. def default(that: ⇒ Bits): Bits

    Permalink

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  66. def dirString(): String

    Permalink
    Definition Classes
    Data
  67. def dlcAppend(that: AssignmentStatement): Bits.this.type

    Permalink
    Definition Classes
    DoubleLinkedContainer
  68. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit

    Permalink
    Definition Classes
    DoubleLinkedContainer
  69. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  70. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  71. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  72. var dlcLast: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  73. def dlcPrepend(that: AssignmentStatement): Bits.this.type

    Permalink
    Definition Classes
    DoubleLinkedContainer
  74. def dontSimplifyIt(): Bits.this.type

    Permalink
    Definition Classes
    BaseTypeData
  75. def drop(n: Int): Bits

    Permalink

    Drop lowerst n bits

    Drop lowerst n bits

    returns

    data10bits(9 downto 4)

    Definition Classes
    BitVector
    Example:
    1. val res = data10bits.drop(4)
  76. def dropHigh(n: Int): Bits

    Permalink

    Drop highest n bits

    Drop highest n bits

    returns

    data10bits(5 downto 0)

    Definition Classes
    BitVector
    Example:
    1. val res = data10bits.dropHigh(4)
  77. def dropLow(n: Int): Bits

    Permalink
    Definition Classes
    BitVector
  78. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    BaseTypeData
  84. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseTypeData
  85. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    BaseTypeData
  86. def flip(): Bits.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  87. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  88. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  89. def foreachExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
  90. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  91. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit

    Permalink
  92. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  93. def genIf(cond: Boolean): Bits.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  94. def getAllTrue: Bits.this.type

    Permalink
    Definition Classes
    BitsBitVector
  95. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

    Definition Classes
    BitVectorData
  96. final def getClass(): Class[_]

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  99. def getDirection: IODirection

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

    Permalink
    Definition Classes
    Nameable
  101. def getDrivingReg: Bits.this.type

    Permalink
    Definition Classes
    BaseType
  102. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  103. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  104. def getName(default: String): String

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

    Permalink
    Definition Classes
    Nameable
  106. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  107. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  108. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  110. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  111. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  112. def getScalaLocationShort: String

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

    Permalink
    Definition Classes
    ScalaLocated
  114. def getSingleDriver: Option[Bits.this.type]

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  117. def getTypeObject: TypeBits.type

    Permalink
    Definition Classes
    BitsExpression
  118. def getWidth: Int

    Permalink
    Definition Classes
    WidthableWidthProvider
  119. def getWidthNoInferation: Int

    Permalink

    Return the width

    Return the width

    Definition Classes
    BitVector
  120. def getWidthStringNoInferation: String

    Permalink
    Definition Classes
    BitVector
  121. def getZero: Bits.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    BitsData
  122. def getZeroUnconstrained: Bits.this.type

    Permalink
    Definition Classes
    BitsBitVector
  123. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  124. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  125. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  126. def hasOnlyOneStatement: Boolean

    Permalink
  127. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

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

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

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  130. def head: AssignmentStatement

    Permalink
  131. def high: Int

    Permalink

    Return the upper bound

    Return the upper bound

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

    Permalink

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  133. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  134. def insertNext(s: Statement): Unit

    Permalink
    Definition Classes
    Statement
  135. def instanceAttributes(language: Language): Iterable[Attribute]

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

    Permalink
    Definition Classes
    SpinalTagReady
  137. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  138. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  139. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  140. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  141. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  142. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  143. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  145. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  146. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  147. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  149. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  150. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  151. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  152. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  153. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  154. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  155. def keep(): Bits.this.type

    Permalink
    Definition Classes
    Data
  156. var lastScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  157. def lsb: Bool

    Permalink

    Return the least significant bit

    Return the least significant bit

    Definition Classes
    BitVector
  158. def msb: Bool

    Permalink

    Return the most significant bit

    Return the most significant bit

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

    Permalink
    Definition Classes
    BaseType
  160. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  161. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  162. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  163. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  164. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  166. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating): Bits.this.type

    Permalink

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

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

    Permalink

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

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

    Permalink

    Extract a bit of the BitVector

    Extract a bit of the BitVector

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

    Permalink

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  170. var nextScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  171. def noBackendCombMerge: Bits.this.type

    Permalink
    Definition Classes
    Data
  172. def noCombLoopCheck: Bits.this.type

    Permalink
    Definition Classes
    Data
  173. def normalizeInputs: Unit

    Permalink
    Definition Classes
    BaseTypeExpressionContainer
  174. final def notify(): Unit

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  177. def opName: String

    Permalink
    Definition Classes
    BitsExpression
  178. def orR: Bool

    Permalink

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  179. def overrideLocalName(name: String): Bits.this.type

    Permalink
    Definition Classes
    Nameable
  180. var parent: Data

    Permalink
    Definition Classes
    Data
  181. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  182. def pull(): Bits.this.type

    Permalink

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

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

    Definition Classes
    Data
  183. def purify(): Bits.this.type

    Permalink
    Definition Classes
    Data
  184. def randBoot(): Bits.this.type

    Permalink

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Definition Classes
    Data
  185. def range: Range

    Permalink

    Return the range

    Return the range

    Definition Classes
    BitVector
  186. var refOwner: RefOwnerType

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

    Permalink
    Definition Classes
    Nameable
  188. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  189. def remapExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
  190. def removeAssignments(): Bits.this.type

    Permalink

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseTypeData
  191. def removeStatement(): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  192. def removeStatementFromScope(): Unit

    Permalink
    Definition Classes
    Statement
  193. def removeTag(spinalTag: SpinalTag): Bits.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  195. def resize(width: BitCount): Bits

    Permalink
    Definition Classes
    BitsBitVector
  196. def resize(width: Int): Bits

    Permalink

    Resize the bitVector to width

    Resize the bitVector to width

    returns

    a resized bitVector

    Definition Classes
    BitsBitVector
    Example:
    1. val res = myBits.resize(10)
  197. def resizeFactory: Resize

    Permalink
    Definition Classes
    BitsBitVector
  198. def resizeLeft(width: Int): Bits

    Permalink

    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

  199. def resized: Bits.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  200. def reversed: Bits

    Permalink
  201. def rootScopeStatement: ScopeStatement

    Permalink
    Definition Classes
    BaseTypeStatement
  202. def rotateLeft(that: Int): Bits

    Permalink

    Left rotation of that bits

    Left rotation of that bits

    Definition Classes
    BitsBitVector
  203. def rotateLeft(that: UInt): T

    Permalink

    Left rotation of that Bits

    Left rotation of that Bits

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

    Permalink

    Right rotation of that bits

    Right rotation of that bits

    Definition Classes
    BitsBitVector
  205. def rotateRight(that: UInt): T

    Permalink

    Right rotation of that Bits

    Right rotation of that Bits

    Definition Classes
    BitVector
  206. def setAll(): Bits.this.type

    Permalink

    Set all bits

    Set all bits

    Definition Classes
    BitsBitVector
  207. def setAllTo(value: Bool): Bits.this.type

    Permalink

    Set all bits to value

    Set all bits to value

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

    Permalink

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  209. def setAsAnalog(): Bits.this.type

    Permalink
    Definition Classes
    BaseTypeData
  210. def setAsComb(): Bits.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseTypeData
  211. def setAsDirectionLess(): Bits.this.type

    Permalink

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

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

    Definition Classes
    BaseTypeData
  212. def setAsReg(): Bits.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseTypeData
  213. def setAsTypeNode(): Bits.this.type

    Permalink

    Set baseType to Node

    Set baseType to Node

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

    Permalink

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  215. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Bits.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  220. def setCompositeName(nameable: Nameable): Bits.this.type

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

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

    Permalink
    Definition Classes
    Nameable
  223. def setName(name: String): Bits.this.type

    Permalink
    Definition Classes
    Nameable
  224. def setNameAsWeak(): Bits.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  229. def setPartialName(name: String): Bits.this.type

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

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

    Permalink
    Definition Classes
    OwnableRef
  232. def setScalaLocated(source: ScalaLocated): Bits.this.type

    Permalink
    Definition Classes
    ScalaLocated
  233. def setWeakName(name: String): Bits.this.type

    Permalink
    Definition Classes
    Nameable
  234. def setWidth(width: Int): Bits.this.type

    Permalink

    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
  235. def simplifyNode: Expression

    Permalink
    Definition Classes
    Expression
  236. def sliceBy(divisor: List[Int]): List[Bits]

    Permalink
    Definition Classes
    BitVector
  237. def sliceBy(divisor: Int*): List[Bits]

    Permalink

    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))
  238. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  239. def splitAt(n: Int): (Bits, Bits)

    Permalink

    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)
  240. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression

    Permalink
    Definition Classes
    ExpressionContainer
  241. def subdivideIn(sliceWidth: BitCount): Vec[T]

    Permalink

    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
  242. def subdivideIn(sliceCount: SlicesCount): Vec[T]

    Permalink

    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)
  243. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  244. def take(n: Int): Bits

    Permalink

    Take lowerst n bits

    Take lowerst n bits

    returns

    data10bits(3 downto 0)

    Definition Classes
    BitVector
    Example:
    1. val res = data10bits.take(4)
  245. def takeHigh(n: Int): Bits

    Permalink

    Take highest n bits

    Take highest n bits

    returns

    data10bits(9 downto 6)

    Definition Classes
    BitVector
    Example:
    1. val res = data10bits.takeHigh(4)
  246. def takeLow(n: Int): Bits

    Permalink
    Definition Classes
    BitVector
  247. def toDataType[T <: Data](dataType: T): T

    Permalink

    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)
  248. def toString(): String

    Permalink
    Definition Classes
    BitVectorBaseTypeExpressionNameable → AnyRef → Any
  249. def toStringMultiLine(): String

    Permalink
    Definition Classes
    BaseNode
  250. def unary_~: Bits

    Permalink

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    BitsBitwiseOp
  251. def unsetName(): Bits.this.type

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  255. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  256. def walkExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  257. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  258. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Statement
  259. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Statement
  260. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  261. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  262. def wrapCast[T <: BaseType](result: T, node: Cast): T

    Permalink
    Definition Classes
    BaseType
  263. def xorR: Bool

    Permalink

    Logical XOR of all bits

    Logical XOR of all bits

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

    Permalink

    Logical OR operator

    Logical OR operator

    Definition Classes
    BitsBitwiseOp
  265. def |<<(that: UInt): Bits

    Permalink

    Logical shift left (output width == input width)

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

    Permalink

    Logical shift left (output width == input width)

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

    Permalink

    Logical shift Right (output width == input width)

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

    Permalink

    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

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from BitwiseOp[Bits]

Inherited from DataPrimitives[Bits]

Inherited from BitVector

Inherited from Widthable

Inherited from WidthProvider

Inherited from BaseType

Inherited from Expression

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