Chisel

Bits

Related Docs: object Bits | package Chisel

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
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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bits()

Abstract Value Members

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

Concrete Value Members

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

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

    not equal to

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

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

    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
  5. def ##(b: Node): Node

    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
  6. final def ##(): Int

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

  8. def &(b: Bits): Bits.this.type

    Bitwise and

  9. def *(b: Bits): Bits

  10. def +(b: Bits): Bits

  11. def -(b: Bits): Bits

  12. def /(b: Bits): Bits

  13. def :=(that: Data): Unit

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

    Shift left operation

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

    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
  16. final def ==(arg0: Any): Boolean

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

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

    Definition Classes
    BitsData
  19. def W0Wtransform(): Unit

    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
  20. def ^(b: Bits): Bits.this.type

    Bitwise xor

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

    Definition Classes
    Node
  22. val _id: Int

    The unique id of this node

    The unique id of this node

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

    Definition Classes
    Node
  24. def andR(): Bool

    reduction and, and all bits together

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

    Extract a range of bits, inclusive from hi to lo

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

    Extract a range of bits, inclusive from hi to lo

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

    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
  28. final def apply(bit: UInt): Bool

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

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

    Extract a single Bool at index *bit*.

  30. def apply(name: String): Data

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

    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
  32. def asInput(): Bits.this.type

    Set this Bits instatiation to be an INPUT

    Set this Bits instatiation to be an INPUT

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

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

    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
  35. final def asTypeFor(node: Node): Bits.this.type

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

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

    Attributes
    protected[Chisel]
  36. def assign(src: Node): Unit

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

    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

  38. def canCSE: Boolean

    Definition Classes
    Node
  39. lazy val chiselName: String

    Definition Classes
    Node
  40. var clock: Option[Clock]

    The clock for this node

    The clock for this node

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

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

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

    Assignment operator

    Assignment operator

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

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

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

    Definition Classes
    Data
  47. def component: Module

    Use the function componentOf instead

    Use the function componentOf instead

    Definition Classes
    Node
  48. def componentOf: Module

    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
  49. val consumers: LinkedHashSet[Node]

    nodes that consume one of my outputs

    nodes that consume one of my outputs

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

  51. def dblLitValue: Double

    Convert the node literal to a Double

    Convert the node literal to a Double

    Definition Classes
    Node
  52. def default: proc

    Attributes
    protected
    Definition Classes
    proc
  53. def defaultMissing: Boolean

    Attributes
    protected
    Definition Classes
    proc
  54. def defaultRequired: Boolean

    Definition Classes
    Bitsproc
  55. var dir: IODirection

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

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

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

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

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

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

    Definition Classes
    Node
  61. def error(b: Bits): Bits

    Error shown when operation is not defined

    Error shown when operation is not defined

    Exceptions thrown

    ChiselException if the operation is not defined

  62. def finalize(): Unit

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

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

    Change INPUT to OUTPUT and OUTPUT to INPUT

    Change INPUT to OUTPUT and OUTPUT to INPUT

    Definition Classes
    BitsData
  65. def floLitValue: Float

    Convert the node literal to a Float

    Convert the node literal to a Float

    Definition Classes
    Node
  66. def forceMatchingWidths: Unit

    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
  67. def fromBits(b: Bits): Bits.this.type

    Definition Classes
    Data
  68. def fromNode(n: Node): Bits.this.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.

    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
  69. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  70. def getNode: Node

    returns

    The root node input

    Definition Classes
    BitsNode
  71. def getWidth(): Int

    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

  72. def hashCode(): Int

    returns

    the unique hashCode for this node

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

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

    Attributes
    protected
    Definition Classes
    Data
  75. def infer: Boolean

    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
  76. def init(n: String, w: Int, ins: Node*): Node

    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
  77. def init(n: String, widthFunc: (⇒ Node) ⇒ Width, ins: Node*): Node

    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
  78. def initOf(n: String, widthfunc: (⇒ Node) ⇒ Width, ins: Iterable[Node]): Node

    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
  79. val inputs: ArrayBuffer[Node]

    The inputs that this node depends on

    The inputs that this node depends on

    Definition Classes
    Node
  80. def isDirectionless: Boolean

    returns

    this instantiation is neither of INPUT or OUTPUT

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

    Definition Classes
    Any
  82. def isIo: Boolean

    returns

    this node is an I/O Node for a module

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

    Definition Classes
    Node
  84. final def isLit: Boolean

    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
  85. def isReg: Boolean

    returns

    this node is a Register

    Definition Classes
    Node
  86. def isTopLevelIO: Boolean

    returns

    is this node I/O for the top level module

    Definition Classes
    Node
  87. var isTypeNode: Boolean

    Definition Classes
    Node
  88. def isTypeOnly: Boolean

    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
  89. def isUsedByClockHi: Boolean

    Definition Classes
    Node
  90. def isWired: Boolean

    Definition Classes
    Data
  91. def isZeroWidth: Boolean

    returns

    this node has zero-width

    Definition Classes
    Node
  92. val line: StackTraceElement

    The trace information for chisel for this node

    The trace information for chisel for this node

    Definition Classes
    Node
  93. def litOf: Literal

    returns

    the literal value of a node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if there is no literal value available

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

    returns

    the literal value of the node as a BigInt

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

    Definition Classes
    BitsNode
  96. def maybeFlatten: Seq[Node]

    Deprecated: Do not use

    Deprecated: Do not use

    Definition Classes
    Node
  97. var modified: Boolean

    Definition Classes
    Node
  98. def muxes: Seq[Mux]

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

    Definition Classes
    nameable
  100. def nameIt(path: String, isNamingIo: Boolean): Unit

    name this node

    name this node

    Definition Classes
    DataNode
    Note

    use setName in Node rather than this directly

  101. var named: Boolean

    _named_ is used to indicates name was set explicitely and should not be overriden by a _nameIt_ generator.

    _named_ is used to indicates name was set explicitely and should not be overriden by a _nameIt_ generator.

    Definition Classes
    nameable
  102. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  103. def needWidth(): Int

    returns

    the bitWidth of the node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if the width is not yet defined

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

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

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

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

    Attributes
    protected
  108. def next: Node

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

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

    Definition Classes
    AnyRef
  111. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  112. def orR(): Bool

    reduction or, or all bits together

  113. def params: Parameters

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

    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
  115. def procAssign(src: Node): Unit

    Definition Classes
    Bitsproc
  116. var procAssigned: Boolean

    Attributes
    protected
    Definition Classes
    proc
  117. var prune: Boolean

    Definition Classes
    Node
  118. def replaceTree(newNode: Node): Unit

    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
  119. def review(): Unit

    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
  120. def setDefault(src: Node): Unit

    Attributes
    protected
    Definition Classes
    proc
  121. def setIsTypeNode: Unit

    make this node a type node

    make this node a type node

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

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

    Set the name of a node when elaborated

    Set the name of a node when elaborated

    my.io.node.setName("MY_IO_NODE")
    n

    The name to set the node to

    Definition Classes
    Node
  124. def setWidth(w: Int): Unit

    Force the bit width of a node

    Force the bit width of a node

    w

    the bit width to force

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

    Definition Classes
    AnyRef
  126. def toBits(): UInt

    returns

    This node as a UInt

    Definition Classes
    Node
  127. def toBool(): Bool

    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

  128. def toBools: Vec[Bool]

    Split up this bits instantiation to a Vec of Bools

  129. lazy val toNode: Node

    returns

    This node

    Definition Classes
    DataNode
  130. def toSInt(): SInt

  131. def toString(): String

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

  133. def unary_~(): Bits.this.type

    invert all bits with ~

  134. def usesInClockHi(i: Node): Boolean

    Definition Classes
    Node
  135. def verifyMuxes: Unit

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

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

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

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

    reduction xor, xor all bits together

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

    Bitwise or

Inherited from proc

Inherited from Data

Inherited from Node

Inherited from nameable

Inherited from AnyRef

Inherited from Any

Ungrouped