Class/Object

Chisel

Bits

Related Docs: object Bits | package Chisel

Permalink

abstract class Bits extends Data with proc

Base class for built-in Chisel types Bits and SInt.

Source
Bits.scala
Linear Supertypes
proc, Data, Node, Nameable, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bits
  2. proc
  3. Data
  4. Node
  5. Nameable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bits()

    Permalink

Abstract Value Members

  1. abstract def fromInt(x: Int): Bits.this.type

    Permalink

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##[T <: Data](right: T): Bits.this.type

    Permalink

    Cat bits together to into a single data object with the width of both combined

    Cat bits together to into a single data object with the width of both combined

    Definition Classes
    BitsData
  3. def ##(b: Node): Node

    Permalink

    The cat operator to combine two values

    The cat operator to combine two values

    0x5 ## 0x3 => 0x53
    b

    Node to cat after

    returns

    a new node as the combination of both this node and b

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

    Permalink
    Definition Classes
    AnyRef → Any
  5. def %(b: Bits): Bits

    Permalink
  6. def &(b: Bits): Bits.this.type

    Permalink

    Bitwise and

  7. def *(b: Bits): Bits

    Permalink
  8. def +(b: Bits): Bits

    Permalink
  9. def -(b: Bits): Bits

    Permalink
  10. def /(b: Bits): Bits

    Permalink
  11. def :=(that: Data): Unit

    Permalink
    Definition Classes
    Data
  12. def <<(b: UInt): Bits.this.type

    Permalink

    Shift left operation

  13. def <>(src: Node): Unit

    Permalink

    Connect I/O of modules with the same name

    Connect I/O of modules with the same name

    src

    Node to attempt to connect to this instantiation

    Definition Classes
    BitsNode
  14. def =/=(that: BitPat): Bool

    Permalink
  15. def =/=(b: Bits): Bool

    Permalink

    not equal to

  16. def =/=[T <: Data](right: T): Bool

    Permalink
    Definition Classes
    Data
  17. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def ===(that: BitPat): Bool

    Permalink
  19. def ===[T <: Data](right: T): Bool

    Permalink
    Definition Classes
    BitsData
  20. def W0Wtransform(): Unit

    Permalink

    Eliminate any zero-width wires attached to this node

    Eliminate any zero-width wires attached to this node

    returns

    if the node was modified

    Definition Classes
    Node
  21. def ^(b: Bits): Bits.this.type

    Permalink

    Bitwise xor

  22. def ^^(src: Node): Unit

    Permalink
    Definition Classes
    Node
  23. val _id: Int

    Permalink

    The unique id of this node

    The unique id of this node

    Definition Classes
    Node
  24. def _isComplementOf(x: Node): Boolean

    Permalink
    Definition Classes
    Node
  25. def andR(): Bool

    Permalink

    reduction and, and all bits together

  26. final def apply(range: (Int, Int)): UInt

    Permalink

    Extract a range of bits, inclusive from hi to lo

  27. final def apply(hi: UInt, lo: UInt): UInt

    Permalink

    Extract a range of bits, inclusive from hi to lo

  28. final def apply(hi: Int, lo: Int): UInt

    Permalink

    Extract a range of bits, inclusive from hi to lo

    Extract a range of bits, inclusive from hi to lo

    myBits = 0x5, myBits(1,0) => 0x3
  29. final def apply(bit: UInt): Bool

    Permalink

    Extract a single bit at position 'bit' as a Bool

  30. final def apply(bit: Int): Bool

    Permalink

    Extract a single Bool at index *bit*.

  31. def apply(name: String): Data

    Permalink
    Definition Classes
    BitsData
  32. def asDirectionless(): Bits.this.type

    Permalink

    Set this Bits instantiation to be neither of INPUT or OUTPUT

    Set this Bits instantiation to be neither of INPUT or OUTPUT

    Definition Classes
    BitsData
  33. def asInput(): Bits.this.type

    Permalink

    Set this Bits instatiation to be an INPUT

    Set this Bits instatiation to be an INPUT

    Definition Classes
    BitsData
  34. final def asInstanceOf[T0]: T0

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

    Permalink

    Set this Bits instatiation to be an OUTPUT

    Set this Bits instatiation to be an OUTPUT

    returns

    this instance with its exact type.

    Definition Classes
    BitsData
  36. final def asSInt(): SInt

    Permalink
    Definition Classes
    Node
  37. final def asTypeFor(node: Node): Bits.this.type

    Permalink

    assigns this instance as the data type for *node*.

    assigns this instance as the data type for *node*.

    Attributes
    protected[Chisel]
  38. final def asUInt(): UInt

    Permalink
    Definition Classes
    Node
  39. def assign(src: Node): Unit

    Permalink
    Definition Classes
    BitsNode
  40. def bitSet(off: UInt, dat: UInt): Bits.this.type

    Permalink

    Set bit 'off' in data dat

    Set bit 'off' in data dat

    off

    which bit to set

    dat

    A UInt in which to set the bit

  41. def canCSE: Boolean

    Permalink
    Definition Classes
    Node
  42. lazy val chiselName: String

    Permalink
    Definition Classes
    Node
  43. var clock: Option[Clock]

    Permalink

    The clock for this node

    The clock for this node

    Definition Classes
    Node
  44. def clone(): Bits.this.type

    Permalink
    Definition Classes
    Data → AnyRef
  45. def cloneType(): Bits.this.type

    Permalink

    Copy this instantiation of the Chisel Data type with all parameters such as width and I/O direction the same

    Copy this instantiation of the Chisel Data type with all parameters such as width and I/O direction the same

    Definition Classes
    BitsData
  46. def colonEquals(that: Bits): Unit

    Permalink

    Assignment operator

    Assignment operator

    Attributes
    protected
    Definition Classes
    BitsData
  47. def colonEquals[T <: Data](that: Seq[T]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  48. def colonEquals(that: Bundle): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  49. var comp: Option[proc]

    Permalink
    Definition Classes
    Data
  50. def componentOf: Module

    Permalink

    Get the module that this node is a part of or the top module if not assigned yet

    Get the module that this node is a part of or the top module if not assigned yet

    returns

    The module that this node is a part of

    Definition Classes
    Node
  51. val consumers: LinkedHashSet[Node]

    Permalink

    nodes that consume one of my outputs

    nodes that consume one of my outputs

    Definition Classes
    Node
  52. def create(dir: IODirection, width: Int): Unit

    Permalink
  53. def dblLitValue: Double

    Permalink

    Convert the node literal to a Double

    Convert the node literal to a Double

    Definition Classes
    Node
  54. def default: proc

    Permalink
    Attributes
    protected
    Definition Classes
    proc
  55. def defaultMissing: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    proc
  56. def defaultRequired: Boolean

    Permalink
    Definition Classes
    Bitsproc
  57. var dir: IODirection

    Permalink
  58. def doProcAssign(src: Node, cond: Bool): Unit

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    proc
  59. var driveRand: Boolean

    Permalink
    Definition Classes
    Node
  60. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  61. def equals(that: Any): Boolean

    Permalink

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

    Definition Classes
    Node → AnyRef → Any
  62. def equalsForCSE(x: Node): Boolean

    Permalink
    Definition Classes
    Node
  63. def error(b: Bits): Bits

    Permalink

    Error shown when operation is not defined

    Error shown when operation is not defined

    Exceptions thrown

    ChiselException if the operation is not defined

  64. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  65. def flatten: Array[(String, Bits)]

    Permalink
    Definition Classes
    BitsData
  66. def flip(): Bits.this.type

    Permalink

    Change INPUT to OUTPUT and OUTPUT to INPUT

    Change INPUT to OUTPUT and OUTPUT to INPUT

    Definition Classes
    BitsData
  67. def floLitValue: Float

    Permalink

    Convert the node literal to a Float

    Convert the node literal to a Float

    Definition Classes
    Node
  68. def forceMatchingWidths: Unit

    Permalink

    Force the width of this nodes input to have the same width this if known if input node width is known force width of this node

    Force the width of this nodes input to have the same width this if known if input node width is known force width of this node

    Definition Classes
    BitsNode
  69. def fromBits(b: Bits): Bits.this.type

    Permalink
    Definition Classes
    Data
  70. def fromNode(n: Node): Bits.this.type

    Permalink

    Factory method to create and assign a leaf-type instance out of a subclass of *Node* instance which we have lost the concrete type.

    Factory method to create and assign a leaf-type instance out of a subclass of *Node* instance which we have lost the concrete type.

    Definition Classes
    Data
  71. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  72. def getNode: Node

    Permalink

    returns

    The root node input

    Definition Classes
    BitsNode
  73. def getWidth(): Int

    Permalink

    returns

    the width or number of bits used by this node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if the width of the node is unknown

  74. def hashCode(): Int

    Permalink

    returns

    the unique hashCode for this node

    Definition Classes
    Node → AnyRef → Any
  75. def hashCodeForCSE: Int

    Permalink
    Definition Classes
    Node
  76. def illegalAssignment(that: Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  77. def infer: Boolean

    Permalink

    Called while we're walking the graph inferring the width of nodes.

    Called while we're walking the graph inferring the width of nodes. We return true if we should continue to walk the graph, either because there's a node whose width we don't know, or because we updated a node's width.

    Definition Classes
    Node
  78. def init(n: String, w: Int, ins: Node*): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    w

    the bit width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  79. def init(n: String, widthFunc: (⇒ Node) ⇒ Width, ins: Node*): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    widthFunc

    the function to use to calculate the width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  80. def initOf(n: String, widthfunc: (⇒ Node) ⇒ Width, ins: Seq[Node]): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    widthfunc

    the function to use to calculate the width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  81. val inputs: ArrayBuffer[Node]

    Permalink

    The inputs that this node depends on

    The inputs that this node depends on

    Definition Classes
    Node
  82. def isDirectionless: Boolean

    Permalink

    returns

    this instantiation is neither of INPUT or OUTPUT

    Definition Classes
    BitsData
  83. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  84. def isIo: Boolean

    Permalink

    returns

    this node is an I/O Node for a module

    Definition Classes
    Node
  85. def isIo_=(isIo: Boolean): Unit

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    Node
  86. final def isLit: Boolean

    Permalink

    This function determines if a node is a literal, a fixed value

    This function determines if a node is a literal, a fixed value

    Definition Classes
    Node
  87. def isTopLevelIO: Boolean

    Permalink

    returns

    is this node I/O for the top level module

    Definition Classes
    Node
  88. var isTypeNode: Boolean

    Permalink
    Definition Classes
    Node
  89. def isTypeOnly: Boolean

    Permalink

    Chisel3 - type-only nodes (no data - no initialization or assignment) This is used to determine which nodes must be Wire() wrapped, and whether Wire() wrapping of the node is legal or not.

    Chisel3 - type-only nodes (no data - no initialization or assignment) This is used to determine which nodes must be Wire() wrapped, and whether Wire() wrapping of the node is legal or not.

    Definition Classes
    DataNode
  90. def isUsedByClockHi: Boolean

    Permalink

    returns

    this node is a Register

    Definition Classes
    Node
  91. def isWired: Boolean

    Permalink
    Definition Classes
    Data
  92. def isZeroWidth: Boolean

    Permalink

    returns

    this node has zero-width

    Definition Classes
    Node
  93. val line: StackTraceElement

    Permalink

    The trace information for chisel for this node

    The trace information for chisel for this node

    Definition Classes
    Node
  94. def litOf: Literal

    Permalink

    returns

    the literal value of a node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if there is no literal value available

  95. def litValue(default: BigInt = BigInt(-1)): BigInt

    Permalink

    returns

    the literal value of the node as a BigInt

    Bool(true).litValue() => BigInt(1)
    Definition Classes
    Node
  96. def matchWidth(w: Width): Node

    Permalink
    Definition Classes
    BitsNode
  97. def maybeFlatten: Seq[Node]

    Permalink

    Deprecated: Do not use

    Deprecated: Do not use

    Definition Classes
    Node
  98. var modified: Boolean

    Permalink
    Definition Classes
    Node
  99. def muxes: Seq[Mux]

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    proc
  100. var name: String

    Permalink

    Name of the instance.

    Name of the instance.

    Definition Classes
    Nameable
  101. def nameIt(path: String, isNamingIo: Boolean): Unit

    Permalink

    name this node

    name this node

    Definition Classes
    DataNode
    Note

    use setName in Node rather than this directly

  102. var named: Boolean

    Permalink

    named is used to indicate that name was set explicitly and should not be overriden

    named is used to indicate that name was set explicitly and should not be overriden

    Definition Classes
    Nameable
  103. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  104. def needWidth(): Int

    Permalink

    returns

    the bitWidth of the node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if the width is not yet defined

  105. final def newBinaryOp(right: Bits, opName: String): Bits.this.type

    Permalink
    Attributes
    protected
  106. final def newLogicalOp(right: Bits, opName: String): Bool

    Permalink
    Attributes
    protected
  107. final def newReductionOp(opName: String): Bool

    Permalink
    Attributes
    protected
  108. final def newUnaryOp(opName: String): Bits.this.type

    Permalink
    Attributes
    protected
  109. def next: Node

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    proc
  110. def nextOpt: Option[Node]

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    proc
  111. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  112. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  113. def orR(): Bool

    Permalink

    reduction or, or all bits together

  114. def params: Parameters

    Permalink
    Definition Classes
    Data
  115. def printTree(writer: PrintStream, depth: Int = 4, indent: String = ""): Unit

    Permalink

    Prints all members of a node and recursively its inputs up to a certain depth level This method is purely used for debugging

    Prints all members of a node and recursively its inputs up to a certain depth level This method is purely used for debugging

    Definition Classes
    Node
  116. def procAssign(src: Node): Unit

    Permalink
    Definition Classes
    Bitsproc
  117. var procAssigned: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    proc
  118. var prune: Boolean

    Permalink
    Definition Classes
    Node
  119. def replaceTree(newNode: Node): Unit

    Permalink

    Replace the subtree starting from this node with the indicated replacement

    Replace the subtree starting from this node with the indicated replacement

    newNode

    The node to start tree from

    Definition Classes
    Node
  120. def review(): Unit

    Permalink

    Review a node for optimization possibilities if its children have been updated

    Review a node for optimization possibilities if its children have been updated

    Definition Classes
    Node
  121. def setDefault(src: Node): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    proc
  122. def setIsTypeNode: Unit

    Permalink

    make this node a type node

    make this node a type node

    Definition Classes
    Data
  123. def setIsWired(value: Boolean): Unit

    Permalink
    Definition Classes
    Data
  124. def setName(n: String): Unit

    Permalink

    Set the name of this module to the string 'n'

    Set the name of this module to the string 'n'

    Definition Classes
    Nameable
    Example:
    1. my.io.node.setName("MY_IO_NODE")
  125. def setWidth(w: Int): Unit

    Permalink

    Force the bit width of a node

    Force the bit width of a node

    w

    the bit width to force

    Definition Classes
    Node
  126. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  127. def toBits(): UInt

    Permalink

    returns

    This node as a UInt

    Definition Classes
    Node
  128. def toBool(): Bool

    Permalink

    Try to convert this data to a Bool

    Try to convert this data to a Bool

    Definition Classes
    Data
    Exceptions thrown

    ChiselException if the width is not 1

  129. def toBools: Vec[Bool]

    Permalink

    Split up this bits instantiation to a Vec of Bools

  130. lazy val toNode: Node

    Permalink

    returns

    This node

    Definition Classes
    DataNode
  131. def toSInt(): SInt

    Permalink
    Definition Classes
    Node
  132. def toString(): String

    Permalink
    Definition Classes
    Bits → AnyRef → Any
  133. def toUInt(): UInt

    Permalink
    Definition Classes
    Node
  134. def unary_~(): Bits.this.type

    Permalink

    invert all bits with ~

  135. def usesInClockHi(i: Node): Boolean

    Permalink
    Definition Classes
    Node
  136. def verifyMuxes: Unit

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    proc
  137. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  138. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  140. def xorR(): Bool

    Permalink

    reduction xor, xor all bits together

  141. def |(b: Bits): Bits.this.type

    Permalink

    Bitwise or

Deprecated Value Members

  1. def !=(that: BitPat): Bool

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3) Use =/= rather than != for chisel comparison

  2. def !=(b: Bits): Bool

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3) Use =/= rather than != for chisel comparison

Inherited from proc

Inherited from Data

Inherited from Node

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped