final def !=(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final macro def ##(that: Bits): UInt

Concatenation operator

that: a hardware component
returns: this Bits concatenated to the most significant end of that

Definition Classes: Bits
Note: The width of the returned Bits is width of this + width of that.

final def ##(): Int

Definition Classes: AnyRef → Any

final macro def %(that: UInt): UInt

Modulo operator

that: a hardware type
returns: the remainder of this numeric-like type divided by that

Definition Classes: Num
Note: This method generates a fully combinational divider which can result in significant cycle time and area costs.

final macro def &(that: UInt): UInt

Bitwise and operator

that: a hardware UInt
returns: the bitwise and of this UInt and that

Note: The width of the returned UInt is max(width of this, width of that).

final macro def *(that: SInt): SInt

Multiplication operator

that: a hardware SInt
returns: the product of this UInt and that

Note: The width of the returned UInt is width of this + width of that.
,
This method generates a fully combinational multiplier which can result in significant cycle time and area costs.

final macro def *(that: UInt): UInt

Multiplication operator

that: a hardware type
returns: the product of this numeric-like type and that

Definition Classes: Num
Note: The width of the returned hardware type is width of this + width of that.
,
This method generates a fully combinational multiplier which can result in significant cycle time and area costs.

final macro def +(that: UInt): UInt

Addition operator

that: a hardware type
returns: the sum of this numeric-like type and that

Definition Classes: Num
Note: The width of the returned hardware type is max(width of this, width of that).

final macro def +%(that: UInt): UInt

Addition operator (constant width)

that: a hardware UInt
returns: the sum of this UInt and that

Note: The width of the returned UInt is max(width of this, width of that).

final macro def +&(that: UInt): UInt

Addition operator (expanding width)

that: a hardware UInt
returns: the sum of this UInt and that

Note: The width of the returned UInt is max(width of this, width of that) + 1.

final macro def -(that: UInt): UInt

Subtraction operator

that: a hardware type
returns: the difference of this numeric-like type less that

Definition Classes: Num
Note: The width of the returned hardware type is max(width of this, width of that) + 1.

final macro def -%(that: UInt): UInt

Subtraction operator (constant width)

that: a hardware UInt
returns: the difference of this UInt less that

Note: The width of the returned UInt is max(width of this, width of that).

final macro def -&(that: UInt): UInt

Subtraction operator (increasing width)

that: a hardware UInt
returns: the difference of this UInt less that

Note: The width of the returned UInt is max(width of this, width of that) + 1.

final macro def /(that: UInt): UInt

Division operator

that: a hardware type
returns: the quotient of this numeric-like type divided by that

Definition Classes: Num
To do: full rules
Note: This method generates a fully combinational divider which can result in significant cycle time and area costs.

final def :=(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

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): Bool

Less than operator

that: a hardware type
returns: a hardware Bool asserted if this numeric-like type is less than that

Definition Classes: Num

final macro def <<(that: UInt): Bits

Dynamic left shift operator

that: a hardware component
returns: this Bits dynamically shifted left by that many places, shifting in zeros from the right

Definition Classes: Bits
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

that: an amount to shift by
returns: this Bits with that many zeros concatenated to its least significant end

Definition Classes: Bits
Note: The width of the returned Bits is width of this + that.

final macro def <<(that: BigInt): Bits

Static left shift operator

that: an amount to shift by
returns: this Bits with that many zeros concatenated to its least significant end

Definition Classes: Bits
Note: The width of the returned Bits is width of this + that.

final macro def <=(that: UInt): Bool

Less than or equal to operator

that: a hardware type
returns: a hardware Bool asserted if this numeric-like type is less than or equal to that

Definition Classes: Num

final def <>(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

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 macro def =/=(that: UInt): Bool

Dynamic not equals operator

that: a hardware UInt
returns: a hardware Bool asserted if this UInt is not equal to that

final def ==(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final macro def ===(that: UInt): Bool

Dynamic equals operator

that: a hardware UInt
returns: a hardware Bool asserted if this UInt is equal to that

final macro def >(that: UInt): Bool

Greater than operator

that: a hardware component
returns: a hardware Bool asserted if this numeric-like type is greater than that

Definition Classes: Num

final macro def >=(that: UInt): Bool

Greater than or equal to operator

that: a hardware component
returns: a hardware Bool asserted if this numeric-like type is greather than or equal to that

Definition Classes: Num

final macro def >>(that: UInt): Bits

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.

Definition Classes: 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

that: an amount to shift by
returns: this Bits with that many least significant bits truncated

Definition Classes: Bits
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

that: an amount to shift by
returns: this Bits with that many least significant bits truncated

Definition Classes: Bits
Note: The width of the returned Bits is unchanged, i.e., the width of this.

final macro def ^(that: UInt): UInt

Bitwise exclusive or (xor) operator

that: a hardware UInt
returns: the bitwise xor of this UInt and that

Note: The width of the returned UInt is max(width of this, width of that).

final macro def abs(): UInt

Absolute value operator

returns: a hardware type with a value equal to the absolute value of this numeric-like type

Definition Classes: Num
Note: The width of the returned hardware type is unchanged, i.e., the width of this.

final macro def andR(): Bool

And reduction operator

returns: a hardware Bool resulting from every bit of this UInt and'd together

final macro def apply(x: BigInt, y: BigInt): UInt

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

Definition Classes: 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.

x: the high bit
y: the low bit
returns: a hardware component contain the requested bits

Definition Classes: Bits

final macro def apply(x: UInt): Bool

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

Definition Classes: Bits

final macro def apply(x: Int): Bool

Returns the specified bit on this Bits as a Bool, statically addressed.

x: an index
returns: the specified bit

Definition Classes: Bits
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.

x: an index
returns: the specified bit

Definition Classes: Bits

final macro def asBool(): Bool

Casts this UInt 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.

Definition Classes: Bits

final macro def asFixedPoint(that: BinaryPoint): FixedPoint

Reinterpret this Bits as a FixedPoint.

Definition Classes: Bits
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.

Definition Classes: Bits
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

Definition Classes: Bits
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.

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

final macro def bitSet(off: UInt, dat: Bool): UInt

Conditionally set or clear a bit

off: a dynamic offset
dat: set if true, clear if false
returns: a hrdware UInt with bit off set or cleared based on the value of dat

Note: The width of the returned UInt is unchanged, i.e., the width of this.

def circuitName: String

Attributes: protected
Definition Classes: HasId

def clone(): AnyRef

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( ... ) @native()

def cloneType: UInt.this.type

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

Definition Classes: Bits

def do_%(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Num

def do_&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_*(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt

def do_*(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Num

def do_+(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Num

def do_+%(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_+&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_-(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Num

def do_-%(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_-&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_/(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Num

def do_<(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes: UInt → Num

def do_<<(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Bits

def do_<<(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Bits

def do_<<(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Bits

def do_<=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes: UInt → Num

def do_=/=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

def do_===(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

def do_>(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes: UInt → Num

def do_>=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes: UInt → Num

def do_>>(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Bits

def do_>>(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Bits

def do_>>(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Bits

def do_^(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_abs(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Num

def do_andR(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

final def do_apply(x: BigInt, y: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: Bits

final def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: Bits

final def do_apply(x: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes: Bits

final def do_apply(x: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes: Bits

final def do_apply(x: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

Definition Classes: Bits

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

Definition Classes: Bits → ToBoolable

def do_asBools(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Seq[Bool]

Definition Classes: Bits

def do_asFixedPoint(binaryPoint: BinaryPoint)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): FixedPoint

Definition Classes: UInt → Bits

def do_asInterval(range: IntervalRange = IntervalRange.Unknown)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval

Definition Classes: UInt → Bits

def do_asSInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt

Definition Classes: UInt → Bits

def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

Definition Classes: Data

def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Data

def do_bitSet(off: UInt, dat: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_head(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: Bits

def do_max(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: Num

def do_min(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: Num

def do_orR(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

def do_pad(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt.this.type

Definition Classes: Bits

def do_tail(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: Bits

def do_unary_!(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

def do_unary_-(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_unary_-%(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

def do_unary_~(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

Definition Classes: UInt → Bits

def do_xorR(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

def do_zext(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt

def do_|(that: UInt)(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.

Definition Classes: Data

def hashCode(): Int

Definition Classes: HasId → AnyRef → Any

final macro def head(n: Int): UInt

Head operator

n: the number of bits to take
returns: The n most significant bits of this Bits

Definition Classes: 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.

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.

Definition Classes: Data

final macro def max(that: UInt): UInt

Maximum operator

that: a hardware type
returns: a hardware type with a value equal to the mimimum value of this numeric-like type and that

Definition Classes: Num
Note: The width of the returned hardware type is max(width of this, width of that).

final macro def min(that: UInt): UInt

Minimum operator

that: a hardware numeric-like type
returns: a hardware type with a value equal to the mimimum value of this numeric-like type and that

Definition Classes: Num
Note: The width of the returned hardware type is max(width of this, width of that).

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 orR(): Bool

Or reduction operator

returns: a hardware Bool resulting from every bit of this UInt or'd together

final macro def pad(that: Int): UInt.this.type

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.

Definition Classes: Bits
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): UInt.this.type

Definition Classes: HasId

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes: AnyRef

final macro def tail(n: Int): UInt

Tail operator

n: the number of bits to remove
returns: This Bits with the n most significant bits removed.

Definition Classes: Bits

final def toAbsoluteTarget: ReferenceTarget

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

Definition Classes: Bits

final def toNamed: ComponentName

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

Definition Classes: Bits → Data

def toString(): String

Definition Classes: UInt → AnyRef → Any

final def toTarget: ReferenceTarget

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_!(): Bool

Unary not

returns: a hardware Bool asserted if this UInt equals zero

final macro def unary_-(): UInt

Unary negation (expanding width)

returns: a UInt equal to zero minus this UInt

Note: The width of the returned UInt is unchanged, i.e., width of this.

final macro def unary_-%(): UInt

Unary negation (constant width)

returns: a UInt equal to zero minus this UInt shifted right by one.

Note: The width of the returned UInt is unchanged, i.e., width of this.

final macro def unary_~(): Bits

Bitwise inversion operator

returns: this Bits with each bit inverted

Definition Classes: Bits

final def validateShiftAmount(x: Int): Int

Attributes: protected
Definition Classes: Bits

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.

Definition Classes: Data

final macro def xorR(): Bool

Exclusive or (xor) reduction operator

returns: a hardware Bool resulting from every bit of this UInt xor'd together

final macro def zext(): SInt

Zero extend as SInt

returns: an SInt equal to this UInt with an additional zero in its most significant bit

Note: The width of the returned SInt is width of this + 1.

final macro def |(that: UInt): UInt

Bitwise or operator

that: a hardware UInt
returns: the bitwise or of this UInt and that

Note: The width of the returned UInt is max(width of this, width of that).

Packages

UInt

sealed class UInt extends Bits with Num[UInt]

Value Members

Deprecated Value Members

Inherited from Num[UInt]

Inherited from Bits

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

Arithmetic

Bitwise

Comparison

Connect

SourceInfoTransformMacro

Ungrouped