Bits

sealed abstract class Bits extends Element with ToBoolable

A data type for values represented by a single bitvector. This provides basic bitwise operations.

Linear Supertypes

ToBoolable, Element, Data, SourceInfoDoc, NamedComponent, HasId, internal.InstanceId, AnyRef, Any

Known Subclasses

Bool, SInt, UInt, FixedPoint, Interval

Ordering

Alphabetic
By Inheritance

Inherited

Bits
ToBoolable
Element
Data
SourceInfoDoc
NamedComponent
HasId
InstanceId
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def do_<<(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits
abstract def do_<<(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits
abstract def do_<<(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits
abstract def do_>>(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits
abstract def do_>>(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits
abstract def do_>>(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits
abstract def do_asSInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
abstract def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes
Data
abstract def do_unary_~(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final macro def ##(that: Bits): UInt
Concatenation operator
Concatenation operator
that
a hardware component
returns
this Bits concatenated to the most significant end of that

Note
The width of the returned Bits is width of this + width of that.
final def ##(): Int

Definition Classes
AnyRef → Any
final def :=(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
Connect this data to that data mono-directionally and element-wise.
Connect this data to that data mono-directionally and element-wise.
This uses the MonoConnect algorithm.
that
the data to connect to

Definition Classes
Data
final macro def <<(that: UInt): Bits
Dynamic left shift operator
Dynamic left shift operator
that
a hardware component
returns
this Bits dynamically shifted left by that many places, shifting in zeros from the right

Note
The width of the returned Bits is width of this + pow(2, width of that) - 1.
final macro def <<(that: Int): Bits
Static left shift operator
Static left shift operator
that
an amount to shift by
returns
this Bits with that many zeros concatenated to its least significant end

Note
The width of the returned Bits is width of this + that.
final macro def <<(that: BigInt): Bits
Static left shift operator
Static left shift operator
that
an amount to shift by
returns
this Bits with that many zeros concatenated to its least significant end

Note
The width of the returned Bits is width of this + that.
final def <>(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
Connect this data to that data bi-directionally and element-wise.
Connect this data to that data bi-directionally and element-wise.
This uses the BiConnect algorithm.
that
the data to connect to

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

Definition Classes
AnyRef → Any
final macro def >>(that: UInt): Bits
Dynamic right shift operator
Dynamic right shift operator
that
a hardware component
returns
this Bits dynamically shifted right by the value of that component, inserting zeros into the most significant bits.

Note
The width of the returned Bits is unchanged, i.e., the width of this.
final macro def >>(that: Int): Bits
Static right shift operator
Static right shift operator
that
an amount to shift by
returns
this Bits with that many least significant bits truncated

Note
The width of the returned Bits is unchanged, i.e., the width of this.
final macro def >>(that: BigInt): Bits
Static right shift operator
Static right shift operator
that
an amount to shift by
returns
this Bits with that many least significant bits truncated

Note
The width of the returned Bits is unchanged, i.e., the width of this.
final macro def apply(x: BigInt, y: BigInt): UInt
Returns a subset of bits on this Bits from hi to lo (inclusive), statically addressed.
Returns a subset of bits on this Bits from hi to lo (inclusive), statically addressed.
x
the high bit
y
the low bit
returns
a hardware component contain the requested bits
Example:
1. myBits = 0x5 = 0b101 myBits(1,0) => 0b01 // extracts the two least significant bits
final macro def apply(x: Int, y: Int): UInt
Returns a subset of bits on this Bits from hi to lo (inclusive), statically addressed.
Returns a subset of bits on this Bits from hi to lo (inclusive), statically addressed.
x
the high bit
y
the low bit
returns
a hardware component contain the requested bits
Example:
1. myBits = 0x5 = 0b101 myBits(1,0) => 0b01 // extracts the two least significant bits
final macro def apply(x: UInt): Bool
Returns the specified bit on this wire as a Bool, dynamically addressed.
Returns the specified bit on this wire as a Bool, dynamically addressed.
x
a hardware component whose value will be used for dynamic addressing
returns
the specified bit
final macro def apply(x: Int): Bool
Returns the specified bit on this Bits as a Bool, statically addressed.
Returns the specified bit on this Bits as a Bool, statically addressed.
x
an index
returns
the specified bit

Note
convenience method allowing direct use of scala.Int without implicits
final macro def apply(x: BigInt): Bool
Returns the specified bit on this Bits as a Bool, statically addressed.
Returns the specified bit on this Bits as a Bool, statically addressed.
x
an index
returns
the specified bit
final macro def asBool(): Bool
Casts this Bits to a Bool
Casts this Bits to a Bool

Definition Classes
ToBoolable
Note
The width must be known and equal to 1
final macro def asBools(): Seq[Bool]
Returns the contents of this wire as a scala.collection.Seq of Bool.
final macro def asFixedPoint(that: BinaryPoint): FixedPoint
Reinterpret this Bits as a FixedPoint.
Reinterpret this Bits as a FixedPoint.

Note
The value is not guaranteed to be preserved. For example, a UInt of width 3 and value 7 (0b111) would become a FixedPoint with value -1. The interpretation of the number is also affected by the specified binary point. Caution is advised!
final def asInstanceOf[T0]: T0

Definition Classes
Any
final macro def asInterval(that: IntervalRange): Interval
Reinterpret cast as a Interval.
Reinterpret cast as a Interval.

Note
value not guaranteed to be preserved: for example, an UInt of width 3 and value 7 (0b111) would become a FixedInt with value -1, the interpretation of the number is also affected by the specified binary point. Caution advised
final macro def asSInt(): SInt
Reinterpret this Bits as an SInt
Reinterpret this Bits as an SInt

Note
The arithmetic value is not preserved if the most-significant bit is set. For example, a UInt of width 3 and value 7 (0b111) would become an SInt of width 3 and value -1.
macro def asTypeOf[T <: Data](that: T): T
Does a reinterpret cast of the bits in this node into the format that provides.
Does a reinterpret cast of the bits in this node into the format that provides. Returns a new Wire of that type. Does not modify existing nodes.
x.asTypeOf(that) performs the inverse operation of x := that.toBits.

Definition Classes
Data
Note
bit widths are NOT checked, may pad or drop bits from input
,
that should have known widths
final macro def asUInt(): UInt
Reinterpret cast to UInt.
Reinterpret cast to UInt.

Definition Classes
Data
Note
value not guaranteed to be preserved: for example, a SInt of width 3 and value -1 (0b111) would become an UInt with value 7
,
Aggregates are recursively packed with the first element appearing in the least-significant bits of the result.
def binding: Option[Binding]

Attributes
protected[chisel3]
Definition Classes
Data
def bindingToString: String

Attributes
protected
Definition Classes
Data
def binding_=(target: Binding): Unit

Attributes
protected
Definition Classes
Data
def circuitName: String

Attributes
protected
Definition Classes
HasId
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def cloneType: Bits.this.type
Internal API; Chisel users should look at chisel3.chiselTypeOf(...).
Internal API; Chisel users should look at chisel3.chiselTypeOf(...).
cloneType must be defined for any Chisel object extending Data. It is responsible for constructing a basic copy of the object being cloned.
returns
a copy of the object.

Definition Classes
Bits → Data
def do_##(that: Bits)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
final def do_apply(x: BigInt, y: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
final def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
final def do_apply(x: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
final def do_apply(x: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
final def do_apply(x: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
final def do_asBool(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes
Bits → ToBoolable
def do_asBools(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Seq[Bool]
def do_asFixedPoint(that: BinaryPoint)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): FixedPoint
def do_asInterval(that: IntervalRange)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

Definition Classes
Data
def do_head(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
def do_pad(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits.this.type
def do_tail(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
HasId → AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
final def getWidth: Int
Returns the width, in bits, if currently known.
Returns the width, in bits, if currently known.

Definition Classes
Data
def hashCode(): Int

Definition Classes
HasId → AnyRef → Any
final macro def head(n: Int): UInt
Head operator
Head operator
n
the number of bits to take
returns
The n most significant bits of this Bits
def instanceName: String

Definition Classes
HasId → InstanceId
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isLit(): Boolean

Definition Classes
Data
final def isWidthKnown: Boolean
Returns whether the width is currently known.
Returns whether the width is currently known.

Definition Classes
Data
def litOption(): Option[BigInt]
If this is a literal that is representable as bits, returns the value as a BigInt.
If this is a literal that is representable as bits, returns the value as a BigInt. If not a literal, or not representable as bits (for example, is or contains Analog), returns None.

Definition Classes
Element → Data
def litValue(): BigInt
Returns the literal value if this is a literal that is representable as bits, otherwise crashes.
Returns the literal value if this is a literal that is representable as bits, otherwise crashes.

Definition Classes
Data
def name: String

Definition Classes
Element
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final macro def pad(that: Int): Bits.this.type
Pad operator
Pad operator
that
the width to pad to
returns
this @coll zero padded up to width that. If that is less than the width of the original component, this method returns the original component.

Note
For SInts only, this will do sign extension.
def parentModName: String

Definition Classes
HasId → InstanceId
def parentPathName: String

Definition Classes
HasId → InstanceId
def pathName: String

Definition Classes
HasId → InstanceId
def suggestName(name: ⇒ String): Bits.this.type

Definition Classes
HasId
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final macro def tail(n: Int): UInt
Tail operator
Tail operator
n
the number of bits to remove
returns
This Bits with the n most significant bits removed.
final def toAbsoluteTarget: ReferenceTarget
Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph
Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

Definition Classes
NamedComponent → InstanceId
final macro def toBool(): Bool
Casts this Bits to a Bool
Casts this Bits to a Bool

Definition Classes
ToBoolable
Note
The width must be known and equal to 1
final macro def toBools(): Seq[Bool]
Returns the contents of this wire as a scala.collection.Seq of Bool.
final def toNamed: ComponentName
Returns a FIRRTL ComponentName that references this object
Returns a FIRRTL ComponentName that references this object

Definition Classes
NamedComponent → InstanceId
Note
Should not be called until circuit elaboration is complete
final def toPrintable: Printable
Default print as Decimal
Default print as Decimal

Definition Classes
Bits → Data
def toString(): String

Definition Classes
AnyRef → Any
final def toTarget: ReferenceTarget
Returns a FIRRTL ReferenceTarget that references this object
Returns a FIRRTL ReferenceTarget that references this object

Definition Classes
NamedComponent → InstanceId
Note
Should not be called until circuit elaboration is complete
final macro def unary_~(): Bits
Bitwise inversion operator
Bitwise inversion operator
returns
this Bits with each bit inverted
final def validateShiftAmount(x: Int): Int

Attributes
protected
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def widthKnown: Boolean

Definition Classes
Element
final def widthOption: Option[Int]
Returns Some(width) if the width is known, else None.
Returns Some(width) if the width is known, else None.

Definition Classes
Data

Deprecated Value Members

final def do_toBool(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes
Bits → ToBoolable
Annotations
@deprecated
Deprecated
(Since version 3.2) Use asBool instead
def do_toBools(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Seq[Bool]

Annotations
@deprecated
Deprecated
(Since version 3.2) Use asBools instead
def litArg(): Option[LitArg]

Definition Classes
Data
Annotations
@deprecated
Deprecated
(Since version 3.2) litArg is deprecated, use litOption or litTo*Option

Packages

Bits

sealed abstract class Bits extends Element with ToBoolable

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ToBoolable

Inherited from Element

Inherited from Data

Inherited from SourceInfoDoc

Inherited from NamedComponent

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Bitwise

Connect

SourceInfoTransformMacro

Ungrouped

Packages

Bits 

sealed abstract class Bits extends Element with ToBoolable

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ToBoolable

Inherited from Element

Inherited from Data

Inherited from SourceInfoDoc

Inherited from NamedComponent

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Bitwise

Connect

SourceInfoTransformMacro

Ungrouped

Bits