Bool

sealed class Bool extends UInt with Reset

A data type for booleans, defined as a single bit indicating true or false.

Source: Bits.scala

Linear Supertypes

Reset, UInt, Num[UInt], Bits, ToBoolable, Element, Data, SourceInfoDoc, NamedComponent, HasId, InstanceId, AnyRef, Any

Type Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

Bool
Reset
UInt
Num
Bits
ToBoolable
Element
Data
SourceInfoDoc
NamedComponent
HasId
InstanceId
AnyRef
Any

Implicitly

by AsReadOnly
by DataEquality
by toConnectableDefault
by ConnectableDefault
by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Bool()

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 Bool concatenated to the most significant end of that
Definition Classes
Bits
Note
The width of the returned Bool is width of this + width of that.
final def ##: Int
Definition Classes
AnyRef → Any
final macro def %(that: UInt): UInt
Modulo operator
Modulo operator
that
a Bool
returns
the remainder of this Bool 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: Bool): Bool
Bitwise and operator
Bitwise and operator
that
a hardware Bool
returns
the bitwise and of this Bool and that
final macro def &(that: UInt): UInt
Bitwise and operator
Bitwise and operator
that
a hardware Bool
returns
the bitwise and of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
macro def &&(that: Bool): Bool
Logical and operator
Logical and operator
that
a hardware Bool
returns
the logical and of this Bool and that
Note
this is equivalent to Bool.&
final macro def *(that: SInt): SInt
Multiplication operator
Multiplication operator
that
a hardware SInt
returns
the product of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool 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
Multiplication operator
that
a Bool
returns
the product of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool 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
Addition operator
that
a Bool
returns
the sum of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).
final macro def +%(that: UInt): UInt
Addition operator (constant width)
Addition operator (constant width)
that
a hardware Bool
returns
the sum of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def +&(that: UInt): UInt
Addition operator (expanding width)
Addition operator (expanding width)
that
a hardware Bool
returns
the sum of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that) + 1.
final macro def -(that: UInt): UInt
Subtraction operator
Subtraction operator
that
a Bool
returns
the difference of this Bool less that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that) + 1.
final macro def -%(that: UInt): UInt
Subtraction operator (constant width)
Subtraction operator (constant width)
that
a hardware Bool
returns
the difference of this Bool less that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def -&(that: UInt): UInt
Subtraction operator (increasing width)
Subtraction operator (increasing width)
that
a hardware Bool
returns
the difference of this Bool less that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that) + 1.
def ->[B](y: B): (Bool, B)
Implicit
This member is added by an implicit conversion from Bool toArrowAssoc[Bool] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final macro def /(that: UInt): UInt
Division operator
Division operator
that
a Bool
returns
the quotient of this Bool 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 :#=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
producer
the right-hand-side of the connection, all members will be driving, none will be driven-to
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :#=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
producer
the right-hand-side of the connection, all members will be driving, none will be driven-to
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :#=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
producer
the right-hand-side of the connection; will always drive leaf connections, and never get driven by leaf connections ("aligned connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
producer
the right-hand-side of the connection; will always drive leaf connections, and never get driven by leaf connections ("aligned connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
producer
the right-hand-side of the connection
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
producer
the right-hand-side of the connection
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :=(that: => Data)(implicit sourceInfo: SourceInfo): Unit
The "strong connect" operator.
The "strong connect" operator.
For chisel3._, this operator is mono-directioned; all sub-elements of this will be driven by sub-elements of that.
- Equivalent to this :#= that
For Chisel._, this operator connections bi-directionally via emitting the FIRRTL.<=
- Equivalent to this :<>= that
that
the Data to connect from
Definition Classes
Data
final def :>=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
producer
the right-hand-side of the connection; will always be driven by leaf connections, and never drive leaf connections ("flipped connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :>=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
producer
the right-hand-side of the connection; will always be driven by leaf connections, and never drive leaf connections ("flipped connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :>=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final macro def <(that: UInt): Bool
Less than operator
Less than operator
that
a Bool
returns
a hardware Bool asserted if this Bool is less than that
Definition Classes
Num
final macro def <<(that: UInt): Bits
Dynamic left shift operator
Dynamic left shift operator
that
a hardware component
returns
this Bool dynamically shifted left by that many places, shifting in zeros from the right
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many zeros concatenated to its least significant end
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many zeros concatenated to its least significant end
Definition Classes
Bits
Note
The width of the returned Bool is width of this + that.
final macro def <=(that: UInt): Bool
Less than or equal to operator
Less than or equal to operator
that
a Bool
returns
a hardware Bool asserted if this Bool is less than or equal to that
Definition Classes
Num
final def <>(that: => Data)(implicit sourceInfo: SourceInfo): Unit
The "bulk connect operator", assigning elements in this Vec from elements in a Vec.
The "bulk connect operator", assigning elements in this Vec from elements in a Vec.
For chisel3._, uses the chisel3.internal.BiConnect algorithm; sub-elements of that may end up driving sub-elements of this
- Complicated semantics, hard to write quickly, will likely be deprecated in the future
For Chisel._, emits the FIRRTL.<- operator
- Equivalent to this :<>= that without the restrictions that bundle field names and vector sizes must match
that
the Data to connect from
Definition Classes
Data
final macro def =/=(that: UInt): Bool
Dynamic not equals operator
Dynamic not equals operator
that
a hardware Bool
returns
a hardware Bool asserted if this Bool is not equal to that
Definition Classes
UInt
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final macro def ===(that: UInt): Bool
Dynamic equals operator
Dynamic equals operator
that
a hardware Bool
returns
a hardware Bool asserted if this Bool is equal to that
Definition Classes
UInt
final macro def >(that: UInt): Bool
Greater than operator
Greater than operator
that
a hardware component
returns
a hardware Bool asserted if this Bool is greater than that
Definition Classes
Num
final macro def >=(that: UInt): Bool
Greater than or equal to operator
Greater than or equal to operator
that
a hardware component
returns
a hardware Bool asserted if this Bool is greather than or equal to that
Definition Classes
Num
final macro def >>(that: UInt): Bits
Dynamic right shift operator
Dynamic right shift operator
that
a hardware component
returns
this Bool 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 Bool 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 Bool with that many least significant bits truncated
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many least significant bits truncated
Definition Classes
Bits
Note
The width of the returned Bool is unchanged, i.e., the width of this.
final macro def ^(that: Bool): Bool
Bitwise exclusive or (xor) operator
Bitwise exclusive or (xor) operator
that
a hardware Bool
returns
the bitwise xor of this Bool and that
final macro def ^(that: UInt): UInt
Bitwise exclusive or (xor) operator
Bitwise exclusive or (xor) operator
that
a hardware Bool
returns
the bitwise xor of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
def _padLit(that: Int): Bool.this.type
Attributes
protected
Definition Classes
UInt → Bits
final macro def abs: UInt
Absolute value operator
Absolute value operator
returns
a Bool with a value equal to the absolute value of this Bool
Definition Classes
Num
Note
The width of the returned Bool is unchanged, i.e., the width of this.
final macro def andR: Bool
And reduction operator
And reduction operator
returns
a hardware Bool resulting from every bit of this Bool and'd together
Definition Classes
UInt
final macro def apply(x: BigInt, y: BigInt): UInt
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
x
the high bit
y
the low bit
returns
a hardware component containing the requested bits
Definition Classes
Bits
Example:
1. val myBits = "0b101".U myBits(1, 0) // "0b01".U // extracts the two least significant bits // Note that zero-width ranges are also legal myBits(-1, 0) // 0.U(0.W) // zero-width UInt
final macro def apply(x: Int, y: Int): UInt
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
x
the high bit
y
the low bit
returns
a hardware component containing the requested bits
Definition Classes
Bits
Example:
1. val myBits = "0b101".U myBits(1, 0) // "0b01".U // extracts the two least significant bits // Note that zero-width ranges are also legal myBits(-1, 0) // 0.U(0.W) // zero-width UInt
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
Definition Classes
Bits
final macro def apply(x: Int): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
final macro def apply(x: BigInt): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
def as[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Static cast to a super type
Static cast to a super type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
final macro def asAsyncReset: AsyncReset
Casts this Bool to an AsyncReset
Casts this Bool to an AsyncReset
Definition Classes
Reset
final macro def asBool: Bool
Casts this Bool to a Bool
Casts this Bool 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.
Returns the contents of this wire as a scala.collection.Seq of Bool.
Definition Classes
Bits
macro def asClock: Clock
Reinterprets this Bool as a clock
final macro def asDisable: Disable
Casts this Bool to a Disable
Casts this Bool to a Disable
Definition Classes
Reset
final def asInstanceOf[T0]: T0
Definition Classes
Any
final macro def asSInt: SInt
Reinterpret this Bool as an SInt
Reinterpret this Bool 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.
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 autoSeed(name: String): Bool.this.type
Takes the last seed suggested.
Takes the last seed suggested. Multiple calls to this function will take the last given seed, unless this HasId is a module port (see overridden method in Data.scala).
If the final computed name conflicts with the final name of another signal, the final name may get uniquified by appending a digit at the end of the name.
Is a lower priority than suggestName, in that regardless of whether autoSeed was called, suggestName will always take precedence if it was called.
returns
this object
Definition Classes
Data → HasId
val base: Bool
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def binding: Option[Binding]
Attributes
protected[chisel3]
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
Conditionally set or clear a bit
off
a dynamic offset
dat
set if true, clear if false
returns
a hrdware Bool with bit off set or cleared based on the value of dat
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., the width of this.
def circuitName: String
Definition Classes
HasId
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def cloneType: Bool.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 containsAFlipped: Boolean
Definition Classes
Element → Data
def do_##(that: Bits)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
def do_%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_&(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def do_&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_&&(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def do_*(that: SInt)(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt
def do_*(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_+(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_+%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_+&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_-(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_-%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_-&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_/(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_<(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_<<(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<<(that: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<<(that: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_=/=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_===(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_>(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_>=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_>>(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_>>(that: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_>>(that: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_^(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def do_^(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_abs(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_andR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
final def do_apply(x: BigInt, y: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final def do_apply(x: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_apply(x: Int)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_apply(x: BigInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
def do_asAsyncReset(implicit sourceInfo: SourceInfo): AsyncReset
Definition Classes
Bool → Reset
def do_asBool(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bool → Bits → ToBoolable
def do_asBools(implicit sourceInfo: SourceInfo): Seq[Bool]
Definition Classes
Bits
def do_asClock(implicit sourceInfo: SourceInfo): Clock
def do_asDisable(implicit sourceInfo: SourceInfo): Disable
Definition Classes
Reset
def do_asSInt(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt → Bits
def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo): T
Definition Classes
Data
def do_asUInt(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Data
def do_bitSet(off: UInt, dat: Bool)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
final def do_extract(x: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_extract(x: BigInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
def do_head(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
def do_max(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Num
def do_min(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Num
def do_orR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_pad(that: Int)(implicit sourceInfo: SourceInfo): Bool.this.type
Definition Classes
Bits
def do_rotateLeft(n: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateLeft(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateRight(n: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateRight(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_tail(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final def do_take(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
def do_unary_!(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_unary_-(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_unary_-%(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_unary_~(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bool → UInt → Bits
def do_xorR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_zext(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt
def do_|(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def do_|(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_||(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def ensuring(cond: (Bool) => Boolean, msg: => Any): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Bool) => Boolean): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(that: Any): Boolean
Definition Classes
HasId → AnyRef → Any
def exclude(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to exclude
Select members of base to exclude
members
functions given the base return a member to exclude
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def exclude: connectable.Connectable[Bool]
Adds base to excludes
Adds base to excludes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeAs[S <: Data](members: (Bool) => Data*)(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Select members of base to exclude and static cast to a new type
Select members of base to exclude and static cast to a new type
members
functions given the base return a member to exclude
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeEach[S <: Data](pf: PartialFunction[Data, Seq[Data]])(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Programmatically select members of base to exclude and static cast to a new type
Programmatically select members of base to exclude and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeProbes: connectable.Connectable[Bool]
Exclude probes
Exclude probes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
final macro def extract(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
Definition Classes
Bits
final macro def extract(x: BigInt): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
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 hasSeed: Boolean
returns
Whether either autoName or suggestName has been called
Definition Classes
HasId
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 Bool
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.
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 litToBoolean: Boolean
Convert to a scala.Boolean
def litToBooleanOption: Option[Boolean]
Convert to a scala.Option of scala.Boolean
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
final macro def max(that: UInt): UInt
Maximum operator
Maximum operator
that
a Bool
returns
a Bool with a value equal to the minimum value of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).
final macro def min(that: UInt): UInt
Minimum operator
Minimum operator
that
a hardware Bool
returns
a Bool with a value equal to the minimum value of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).
def name: String
Definition Classes
Element
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def notWaivedOrSqueezedOrExcluded: Boolean
True if no members are waived or squeezed or excluded
True if no members are waived or squeezed or excluded
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
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
Or reduction operator
returns
a hardware Bool resulting from every bit of this Bool or'd together
Definition Classes
UInt
final macro def pad(that: Int): Bool.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.
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 readOnly(implicit sourceInfo: SourceInfo): Bool
Returns a read-only view of this Data
Returns a read-only view of this Data
It is illegal to connect to the return value of this method. This Data this method is called on must be a hardware type.
Implicit
This member is added by an implicit conversion from Bool toAsReadOnly[Bool] performed by method AsReadOnly in chisel3.Data.
Definition Classes
AsReadOnly
final macro def rotateLeft(that: UInt): UInt
Definition Classes
UInt
final macro def rotateLeft(that: Int): UInt
Circular shift to the left
Circular shift to the left
that
number of bits to rotate
returns
UInt of same width rotated left n bits
Definition Classes
UInt
final macro def rotateRight(that: UInt): UInt
Definition Classes
UInt
final macro def rotateRight(that: Int): UInt
Circular shift to the right
Circular shift to the right
that
number of bits to rotate
returns
UInt of same width rotated right n bits
Definition Classes
UInt
def squeeze(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to squeeze
Select members of base to squeeze
members
functions given the base return a member to squeeze
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeeze: connectable.Connectable[Bool]
Adds base to squeezes
Adds base to squeezes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeAll: connectable.Connectable[Bool]
Squeeze all members of base
Squeeze all members of base
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeAllAs[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Squeeze all members of base and upcast to super type
Squeeze all members of base and upcast to super type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeEach[S <: Data](pf: PartialFunction[Data, Seq[Data]]): connectable.Connectable[Bool]
Programmatically select members of base to squeeze
Programmatically select members of base to squeeze
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def suggestName(seed: => String): Bool.this.type
Takes the first seed suggested.
Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.
Is a higher priority than autoSeed, in that regardless of whether autoSeed was called, suggestName will always take precedence.
seed
The seed for the name of this component
returns
this object
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 Bool with the n most significant bits removed.
Definition Classes
Bits
final macro def take(n: Int): UInt
Grab the bottom n bits.
Grab the bottom n bits. Return 0.U(0.W) if n==0.
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
Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph
Definition Classes
NamedComponent → InstanceId
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
final def toRelativeTarget(root: Option[BaseModule]): ReferenceTarget
Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.
Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.
If root is defined, the target is a hierarchical path starting from root.
If root is not defined, the target is a hierarchical path equivalent to toAbsoluteTarget.
Definition Classes
NamedComponent
Note
If root is defined, and has not finished elaboration, this must be called within atModuleBodyEnd.
,
The NamedComponent must be a descendant of root, if it is defined.
,
This doesn't have special handling for Views.
def toString(): String
Definition Classes
Bool → UInt → 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
def typeName: String
Give this Bool a stable typeName for Verilog name generation.
Give this Bool a stable typeName for Verilog name generation. Specifying a Bool's width in its type name isn't necessary
Definition Classes
Bool → Bits → Data
final macro def unary_!: Bool
Unary not
Unary not
returns
a hardware Bool asserted if this Bool equals zero
Definition Classes
UInt
final macro def unary_-: UInt
Unary negation (expanding width)
Unary negation (expanding width)
returns
a Bool equal to zero minus this Bool
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., width of this.
final macro def unary_-%: UInt
Unary negation (constant width)
Unary negation (constant width)
returns
a Bool equal to zero minus this Bool shifted right by one.
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., width of this.
final macro def unary_~: Bits
Bitwise inversion operator
Bitwise inversion operator
returns
this Bool with each bit inverted
Definition Classes
Bits
def unsafe: connectable.Connectable[Data]
Connect to/from all fields regardless of Scala type, squeeze if necessary, and don't error if mismatched members
Connect to/from all fields regardless of Scala type, squeeze if necessary, and don't error if mismatched members
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
final def validateShiftAmount(x: Int)(implicit sourceInfo: SourceInfo): Int
Attributes
protected
Definition Classes
Bits
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
def waive(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to waive
Select members of base to waive
members
functions given the base return a member to waive
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAll: connectable.Connectable[Bool]
Waive all members of base
Waive all members of base
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAllAs[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Waive all members of base and static cast to a new type
Waive all members of base and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAs[S <: Data](members: (Bool) => Data*)(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Select members of base to waive and static cast to a new type
Select members of base to waive and static cast to a new type
members
functions given the base return a member to waive
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveEach[S <: Data](pf: PartialFunction[Data, Seq[Data]])(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Programmatically select members of base to waive and static cast to a new type
Programmatically select members of base to waive and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
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
final macro def xorR: Bool
Exclusive or (xor) reduction operator
Exclusive or (xor) reduction operator
returns
a hardware Bool resulting from every bit of this Bool xor'd together
Definition Classes
UInt
final macro def zext: SInt
Zero extend as SInt
Zero extend as SInt
returns
an SInt equal to this Bool with an additional zero in its most significant bit
Definition Classes
UInt
Note
The width of the returned SInt is width of this + 1.
final macro def |(that: Bool): Bool
Bitwise or operator
Bitwise or operator
that
a hardware Bool
returns
the bitwise or of this Bool and that
final macro def |(that: UInt): UInt
Bitwise or operator
Bitwise or operator
that
a hardware Bool
returns
the bitwise or of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
macro def ||(that: Bool): Bool
Logical or operator
Logical or operator
that
a hardware Bool
returns
the logical or of this Bool and that
Note
this is equivalent to Bool.|)

Shadowed Implicit Value Members

def +(other: String): String
Implicit
This member is added by an implicit conversion from Bool toany2stringadd[Bool] performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bool: any2stringadd[Bool]).+(other)
Definition Classes
any2stringadd
def ===(rhs: Bool): Bool
Dynamic recursive equality operator for generic Data
Dynamic recursive equality operator for generic Data
rhs
a hardware Data to compare lhs to
returns
a hardware Bool asserted if lhs is equal to rhs
Implicit
This member is added by an implicit conversion from Bool toDataEquality[Bool] performed by method DataEquality in chisel3.Data.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bool: DataEquality[Bool]).===(rhs)
Definition Classes
DataEquality
Exceptions thrown
ChiselException when lhs and rhs are different types during elaboration time

Deprecated Value Members

def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from Bool toStringFormat[Bool] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
def →[B](y: B): (Bool, B)
Implicit
This member is added by an implicit conversion from Bool toArrowAssoc[Bool] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Reset

Value Members

final macro def asAsyncReset: AsyncReset
Casts this Bool to an AsyncReset
Casts this Bool to an AsyncReset
Definition Classes
Reset
final macro def asDisable: Disable
Casts this Bool to a Disable
Casts this Bool to a Disable
Definition Classes
Reset
def do_asDisable(implicit sourceInfo: SourceInfo): Disable
Definition Classes
Reset

Inherited from UInt

Value Members

final macro def &(that: UInt): UInt
Bitwise and operator
Bitwise and operator
that
a hardware Bool
returns
the bitwise and of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def *(that: SInt): SInt
Multiplication operator
Multiplication operator
that
a hardware SInt
returns
the product of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool 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 (constant width)
Addition operator (constant width)
that
a hardware Bool
returns
the sum of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def +&(that: UInt): UInt
Addition operator (expanding width)
Addition operator (expanding width)
that
a hardware Bool
returns
the sum of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that) + 1.
final macro def -%(that: UInt): UInt
Subtraction operator (constant width)
Subtraction operator (constant width)
that
a hardware Bool
returns
the difference of this Bool less that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def -&(that: UInt): UInt
Subtraction operator (increasing width)
Subtraction operator (increasing width)
that
a hardware Bool
returns
the difference of this Bool less that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that) + 1.
final macro def =/=(that: UInt): Bool
Dynamic not equals operator
Dynamic not equals operator
that
a hardware Bool
returns
a hardware Bool asserted if this Bool is not equal to that
Definition Classes
UInt
final macro def ===(that: UInt): Bool
Dynamic equals operator
Dynamic equals operator
that
a hardware Bool
returns
a hardware Bool asserted if this Bool is equal to that
Definition Classes
UInt
final macro def ^(that: UInt): UInt
Bitwise exclusive or (xor) operator
Bitwise exclusive or (xor) operator
that
a hardware Bool
returns
the bitwise xor of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
def _padLit(that: Int): Bool.this.type
Attributes
protected
Definition Classes
UInt → Bits
final macro def andR: Bool
And reduction operator
And reduction operator
returns
a hardware Bool resulting from every bit of this Bool and'd together
Definition Classes
UInt
final macro def bitSet(off: UInt, dat: Bool): UInt
Conditionally set or clear a bit
Conditionally set or clear a bit
off
a dynamic offset
dat
set if true, clear if false
returns
a hrdware Bool with bit off set or cleared based on the value of dat
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., the width of this.
def do_%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_*(that: SInt)(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt
def do_*(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_+(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_+%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_+&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_-(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_-%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_-&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_/(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_<(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_<<(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<<(that: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<<(that: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_=/=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_===(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_>(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_>=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_>>(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_>>(that: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_>>(that: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_^(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_abs(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_andR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_asSInt(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt → Bits
def do_bitSet(off: UInt, dat: Bool)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_orR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_rotateLeft(n: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateLeft(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateRight(n: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateRight(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_unary_!(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_unary_-(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_unary_-%(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_xorR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_zext(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt
def do_|(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
final macro def orR: Bool
Or reduction operator
Or reduction operator
returns
a hardware Bool resulting from every bit of this Bool or'd together
Definition Classes
UInt
final macro def rotateLeft(that: UInt): UInt
Definition Classes
UInt
final macro def rotateLeft(that: Int): UInt
Circular shift to the left
Circular shift to the left
that
number of bits to rotate
returns
UInt of same width rotated left n bits
Definition Classes
UInt
final macro def rotateRight(that: UInt): UInt
Definition Classes
UInt
final macro def rotateRight(that: Int): UInt
Circular shift to the right
Circular shift to the right
that
number of bits to rotate
returns
UInt of same width rotated right n bits
Definition Classes
UInt
final macro def unary_!: Bool
Unary not
Unary not
returns
a hardware Bool asserted if this Bool equals zero
Definition Classes
UInt
final macro def unary_-: UInt
Unary negation (expanding width)
Unary negation (expanding width)
returns
a Bool equal to zero minus this Bool
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., width of this.
final macro def unary_-%: UInt
Unary negation (constant width)
Unary negation (constant width)
returns
a Bool equal to zero minus this Bool shifted right by one.
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., width of this.
final macro def xorR: Bool
Exclusive or (xor) reduction operator
Exclusive or (xor) reduction operator
returns
a hardware Bool resulting from every bit of this Bool xor'd together
Definition Classes
UInt
final macro def zext: SInt
Zero extend as SInt
Zero extend as SInt
returns
an SInt equal to this Bool with an additional zero in its most significant bit
Definition Classes
UInt
Note
The width of the returned SInt is width of this + 1.
final macro def |(that: UInt): UInt
Bitwise or operator
Bitwise or operator
that
a hardware Bool
returns
the bitwise or of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).

Inherited from Num[UInt]

Value Members

final macro def %(that: UInt): UInt
Modulo operator
Modulo operator
that
a Bool
returns
the remainder of this Bool 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
Multiplication operator
Multiplication operator
that
a Bool
returns
the product of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool 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
Addition operator
that
a Bool
returns
the sum of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).
final macro def -(that: UInt): UInt
Subtraction operator
Subtraction operator
that
a Bool
returns
the difference of this Bool less that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that) + 1.
final macro def /(that: UInt): UInt
Division operator
Division operator
that
a Bool
returns
the quotient of this Bool 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 macro def <(that: UInt): Bool
Less than operator
Less than operator
that
a Bool
returns
a hardware Bool asserted if this Bool is less than that
Definition Classes
Num
final macro def <=(that: UInt): Bool
Less than or equal to operator
Less than or equal to operator
that
a Bool
returns
a hardware Bool asserted if this Bool is less than or equal to that
Definition Classes
Num
final macro def >(that: UInt): Bool
Greater than operator
Greater than operator
that
a hardware component
returns
a hardware Bool asserted if this Bool is greater than that
Definition Classes
Num
final macro def >=(that: UInt): Bool
Greater than or equal to operator
Greater than or equal to operator
that
a hardware component
returns
a hardware Bool asserted if this Bool is greather than or equal to that
Definition Classes
Num
final macro def abs: UInt
Absolute value operator
Absolute value operator
returns
a Bool with a value equal to the absolute value of this Bool
Definition Classes
Num
Note
The width of the returned Bool is unchanged, i.e., the width of this.
def do_max(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Num
def do_min(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Num
final macro def max(that: UInt): UInt
Maximum operator
Maximum operator
that
a Bool
returns
a Bool with a value equal to the minimum value of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).
final macro def min(that: UInt): UInt
Minimum operator
Minimum operator
that
a hardware Bool
returns
a Bool with a value equal to the minimum value of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).

Inherited from Bits

Value Members

final macro def ##(that: Bits): UInt
Concatenation operator
Concatenation operator
that
a hardware component
returns
this Bool concatenated to the most significant end of that
Definition Classes
Bits
Note
The width of the returned Bool is width of this + width of that.
final macro def <<(that: UInt): Bits
Dynamic left shift operator
Dynamic left shift operator
that
a hardware component
returns
this Bool dynamically shifted left by that many places, shifting in zeros from the right
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many zeros concatenated to its least significant end
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many zeros concatenated to its least significant end
Definition Classes
Bits
Note
The width of the returned Bool is width of this + that.
final macro def >>(that: UInt): Bits
Dynamic right shift operator
Dynamic right shift operator
that
a hardware component
returns
this Bool 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 Bool 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 Bool with that many least significant bits truncated
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many least significant bits truncated
Definition Classes
Bits
Note
The width of the returned Bool is unchanged, i.e., the width of this.
final macro def apply(x: BigInt, y: BigInt): UInt
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
x
the high bit
y
the low bit
returns
a hardware component containing the requested bits
Definition Classes
Bits
Example:
1. val myBits = "0b101".U myBits(1, 0) // "0b01".U // extracts the two least significant bits // Note that zero-width ranges are also legal myBits(-1, 0) // 0.U(0.W) // zero-width UInt
final macro def apply(x: Int, y: Int): UInt
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
x
the high bit
y
the low bit
returns
a hardware component containing the requested bits
Definition Classes
Bits
Example:
1. val myBits = "0b101".U myBits(1, 0) // "0b01".U // extracts the two least significant bits // Note that zero-width ranges are also legal myBits(-1, 0) // 0.U(0.W) // zero-width UInt
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
Definition Classes
Bits
final macro def apply(x: Int): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
final macro def apply(x: BigInt): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
final macro def asBools: Seq[Bool]
Returns the contents of this wire as a scala.collection.Seq of Bool.
Returns the contents of this wire as a scala.collection.Seq of Bool.
Definition Classes
Bits
final macro def asSInt: SInt
Reinterpret this Bool as an SInt
Reinterpret this Bool 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.
def cloneType: Bool.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): UInt
Definition Classes
Bits
final def do_apply(x: BigInt, y: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final def do_apply(x: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_apply(x: Int)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_apply(x: BigInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
def do_asBools(implicit sourceInfo: SourceInfo): Seq[Bool]
Definition Classes
Bits
final def do_extract(x: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_extract(x: BigInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
def do_head(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
def do_pad(that: Int)(implicit sourceInfo: SourceInfo): Bool.this.type
Definition Classes
Bits
def do_tail(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final def do_take(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final macro def extract(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
Definition Classes
Bits
final macro def extract(x: BigInt): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
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 Bool
Definition Classes
Bits
final macro def pad(that: Int): Bool.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.
Definition Classes
Bits
Note
For SInts only, this will do sign extension.
final macro def tail(n: Int): UInt
Tail operator
Tail operator
n
the number of bits to remove
returns
This Bool with the n most significant bits removed.
Definition Classes
Bits
final macro def take(n: Int): UInt
Grab the bottom n bits.
Grab the bottom n bits. Return 0.U(0.W) if n==0.
Definition Classes
Bits
final def toPrintable: Printable
Default print as Decimal
Default print as Decimal
Definition Classes
Bits → Data
final macro def unary_~: Bits
Bitwise inversion operator
Bitwise inversion operator
returns
this Bool with each bit inverted
Definition Classes
Bits
final def validateShiftAmount(x: Int)(implicit sourceInfo: SourceInfo): Int
Attributes
protected
Definition Classes
Bits

Inherited from ToBoolable

Value Members

final macro def asBool: Bool
Casts this Bool to a Bool
Casts this Bool to a Bool
Definition Classes
ToBoolable
Note
The width must be known and equal to 1

Inherited from Element

Value Members

def containsAFlipped: Boolean
Definition Classes
Element → 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 name: String
Definition Classes
Element
def widthKnown: Boolean
Definition Classes
Element

Inherited from Data

Value Members

final def :=(that: => Data)(implicit sourceInfo: SourceInfo): Unit
The "strong connect" operator.
The "strong connect" operator.
For chisel3._, this operator is mono-directioned; all sub-elements of this will be driven by sub-elements of that.
- Equivalent to this :#= that
For Chisel._, this operator connections bi-directionally via emitting the FIRRTL.<=
- Equivalent to this :<>= that
that
the Data to connect from
Definition Classes
Data
final def <>(that: => Data)(implicit sourceInfo: SourceInfo): Unit
The "bulk connect operator", assigning elements in this Vec from elements in a Vec.
The "bulk connect operator", assigning elements in this Vec from elements in a Vec.
For chisel3._, uses the chisel3.internal.BiConnect algorithm; sub-elements of that may end up driving sub-elements of this
- Complicated semantics, hard to write quickly, will likely be deprecated in the future
For Chisel._, emits the FIRRTL.<- operator
- Equivalent to this :<>= that without the restrictions that bundle field names and vector sizes must match
that
the Data to connect from
Definition Classes
Data
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 autoSeed(name: String): Bool.this.type
Takes the last seed suggested.
Takes the last seed suggested. Multiple calls to this function will take the last given seed, unless this HasId is a module port (see overridden method in Data.scala).
If the final computed name conflicts with the final name of another signal, the final name may get uniquified by appending a digit at the end of the name.
Is a lower priority than suggestName, in that regardless of whether autoSeed was called, suggestName will always take precedence if it was called.
returns
this object
Definition Classes
Data → HasId
def binding: Option[Binding]
Attributes
protected[chisel3]
Definition Classes
Data
def binding_=(target: Binding): Unit
Attributes
protected
Definition Classes
Data
def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo): T
Definition Classes
Data
def do_asUInt(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Data
final def getWidth: Int
Returns the width, in bits, if currently known.
Returns the width, in bits, if currently known.
Definition Classes
Data
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 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
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

Inherited from NamedComponent

Value Members

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 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 toRelativeTarget(root: Option[BaseModule]): ReferenceTarget
Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.
Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.
If root is defined, the target is a hierarchical path starting from root.
If root is not defined, the target is a hierarchical path equivalent to toAbsoluteTarget.
Definition Classes
NamedComponent
Note
If root is defined, and has not finished elaboration, this must be called within atModuleBodyEnd.
,
The NamedComponent must be a descendant of root, if it is defined.
,
This doesn't have special handling for Views.
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

Inherited from HasId

Value Members

def circuitName: String
Definition Classes
HasId
def equals(that: Any): Boolean
Definition Classes
HasId → AnyRef → Any
def hasSeed: Boolean
returns
Whether either autoName or suggestName has been called
Definition Classes
HasId
def hashCode(): Int
Definition Classes
HasId → AnyRef → Any
def instanceName: String
Definition Classes
HasId → InstanceId
def parentModName: String
Definition Classes
HasId → InstanceId
def parentPathName: String
Definition Classes
HasId → InstanceId
def pathName: String
Definition Classes
HasId → InstanceId
def suggestName(seed: => String): Bool.this.type
Takes the first seed suggested.
Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.
Is a higher priority than autoSeed, in that regardless of whether autoSeed was called, suggestName will always take precedence.
seed
The seed for the name of this component
returns
this object
Definition Classes
HasId

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
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 def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Inherited by implicit conversion AsReadOnly fromBool to AsReadOnly[Bool]

Value Members

def readOnly(implicit sourceInfo: SourceInfo): Bool
Returns a read-only view of this Data
Returns a read-only view of this Data
It is illegal to connect to the return value of this method. This Data this method is called on must be a hardware type.
Implicit
This member is added by an implicit conversion from Bool toAsReadOnly[Bool] performed by method AsReadOnly in chisel3.Data.
Definition Classes
AsReadOnly

Inherited by implicit conversion DataEquality fromBool to DataEquality[Bool]

Value Members

def ===(rhs: Bool): Bool
Dynamic recursive equality operator for generic Data
Dynamic recursive equality operator for generic Data
rhs
a hardware Data to compare lhs to
returns
a hardware Bool asserted if lhs is equal to rhs
Implicit
This member is added by an implicit conversion from Bool toDataEquality[Bool] performed by method DataEquality in chisel3.Data.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bool: DataEquality[Bool]).===(rhs)
Definition Classes
DataEquality
Exceptions thrown
ChiselException when lhs and rhs are different types during elaboration time

Inherited by implicit conversion toConnectableDefault fromBool to Connectable[Bool]

Value Members

def as[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Static cast to a super type
Static cast to a super type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
val base: Bool
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def exclude(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to exclude
Select members of base to exclude
members
functions given the base return a member to exclude
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def exclude: connectable.Connectable[Bool]
Adds base to excludes
Adds base to excludes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeAs[S <: Data](members: (Bool) => Data*)(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Select members of base to exclude and static cast to a new type
Select members of base to exclude and static cast to a new type
members
functions given the base return a member to exclude
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeEach[S <: Data](pf: PartialFunction[Data, Seq[Data]])(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Programmatically select members of base to exclude and static cast to a new type
Programmatically select members of base to exclude and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeProbes: connectable.Connectable[Bool]
Exclude probes
Exclude probes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def notWaivedOrSqueezedOrExcluded: Boolean
True if no members are waived or squeezed or excluded
True if no members are waived or squeezed or excluded
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeeze(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to squeeze
Select members of base to squeeze
members
functions given the base return a member to squeeze
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeeze: connectable.Connectable[Bool]
Adds base to squeezes
Adds base to squeezes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeAll: connectable.Connectable[Bool]
Squeeze all members of base
Squeeze all members of base
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeAllAs[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Squeeze all members of base and upcast to super type
Squeeze all members of base and upcast to super type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeEach[S <: Data](pf: PartialFunction[Data, Seq[Data]]): connectable.Connectable[Bool]
Programmatically select members of base to squeeze
Programmatically select members of base to squeeze
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def unsafe: connectable.Connectable[Data]
Connect to/from all fields regardless of Scala type, squeeze if necessary, and don't error if mismatched members
Connect to/from all fields regardless of Scala type, squeeze if necessary, and don't error if mismatched members
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waive(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to waive
Select members of base to waive
members
functions given the base return a member to waive
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAll: connectable.Connectable[Bool]
Waive all members of base
Waive all members of base
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAllAs[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Waive all members of base and static cast to a new type
Waive all members of base and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAs[S <: Data](members: (Bool) => Data*)(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Select members of base to waive and static cast to a new type
Select members of base to waive and static cast to a new type
members
functions given the base return a member to waive
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveEach[S <: Data](pf: PartialFunction[Data, Seq[Data]])(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Programmatically select members of base to waive and static cast to a new type
Programmatically select members of base to waive and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable

Inherited by implicit conversion ConnectableDefault fromBool to ConnectableDefault[Bool]

Value Members

final def :#=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
producer
the right-hand-side of the connection, all members will be driving, none will be driven-to
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :#=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
producer
the right-hand-side of the connection, all members will be driving, none will be driven-to
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :#=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
producer
the right-hand-side of the connection; will always drive leaf connections, and never get driven by leaf connections ("aligned connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
producer
the right-hand-side of the connection; will always drive leaf connections, and never get driven by leaf connections ("aligned connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
producer
the right-hand-side of the connection
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
producer
the right-hand-side of the connection
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :>=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
producer
the right-hand-side of the connection; will always be driven by leaf connections, and never drive leaf connections ("flipped connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :>=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
producer
the right-hand-side of the connection; will always be driven by leaf connections, and never drive leaf connections ("flipped connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :>=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension

Inherited by implicit conversion any2stringadd fromBool to any2stringadd[Bool]

Value Members

def +(other: String): String
Implicit
This member is added by an implicit conversion from Bool toany2stringadd[Bool] performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bool: any2stringadd[Bool]).+(other)
Definition Classes
any2stringadd

Inherited by implicit conversion StringFormat fromBool to StringFormat[Bool]

Value Members

def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from Bool toStringFormat[Bool] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited by implicit conversion Ensuring fromBool to Ensuring[Bool]

Value Members

def ensuring(cond: (Bool) => Boolean, msg: => Any): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Bool) => Boolean): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

Inherited by implicit conversion ArrowAssoc fromBool to ArrowAssoc[Bool]

Value Members

def ->[B](y: B): (Bool, B)
Implicit
This member is added by an implicit conversion from Bool toArrowAssoc[Bool] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def →[B](y: B): (Bool, B)
Implicit
This member is added by an implicit conversion from Bool toArrowAssoc[Bool] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Arithmetic

Arithmetic hardware operators

final macro def %(that: UInt): UInt
Modulo operator
Modulo operator
that
a Bool
returns
the remainder of this Bool 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: SInt): SInt
Multiplication operator
Multiplication operator
that
a hardware SInt
returns
the product of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool 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
Multiplication operator
that
a Bool
returns
the product of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool 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
Addition operator
that
a Bool
returns
the sum of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).
final macro def +%(that: UInt): UInt
Addition operator (constant width)
Addition operator (constant width)
that
a hardware Bool
returns
the sum of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def +&(that: UInt): UInt
Addition operator (expanding width)
Addition operator (expanding width)
that
a hardware Bool
returns
the sum of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that) + 1.
final macro def -(that: UInt): UInt
Subtraction operator
Subtraction operator
that
a Bool
returns
the difference of this Bool less that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that) + 1.
final macro def -%(that: UInt): UInt
Subtraction operator (constant width)
Subtraction operator (constant width)
that
a hardware Bool
returns
the difference of this Bool less that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def -&(that: UInt): UInt
Subtraction operator (increasing width)
Subtraction operator (increasing width)
that
a hardware Bool
returns
the difference of this Bool less that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that) + 1.
final macro def /(that: UInt): UInt
Division operator
Division operator
that
a Bool
returns
the quotient of this Bool 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 macro def abs: UInt
Absolute value operator
Absolute value operator
returns
a Bool with a value equal to the absolute value of this Bool
Definition Classes
Num
Note
The width of the returned Bool is unchanged, i.e., the width of this.
final macro def max(that: UInt): UInt
Maximum operator
Maximum operator
that
a Bool
returns
a Bool with a value equal to the minimum value of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).
final macro def min(that: UInt): UInt
Minimum operator
Minimum operator
that
a hardware Bool
returns
a Bool with a value equal to the minimum value of this Bool and that
Definition Classes
Num
Note
The width of the returned Bool is max(width of this, width of that).
final macro def unary_-: UInt
Unary negation (expanding width)
Unary negation (expanding width)
returns
a Bool equal to zero minus this Bool
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., width of this.
final macro def unary_-%: UInt
Unary negation (constant width)
Unary negation (constant width)
returns
a Bool equal to zero minus this Bool shifted right by one.
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., width of this.

Bitwise

Bitwise hardware operators

final macro def ##(that: Bits): UInt
Concatenation operator
Concatenation operator
that
a hardware component
returns
this Bool concatenated to the most significant end of that
Definition Classes
Bits
Note
The width of the returned Bool is width of this + width of that.
final macro def &(that: Bool): Bool
Bitwise and operator
Bitwise and operator
that
a hardware Bool
returns
the bitwise and of this Bool and that
final macro def &(that: UInt): UInt
Bitwise and operator
Bitwise and operator
that
a hardware Bool
returns
the bitwise and of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def <<(that: UInt): Bits
Dynamic left shift operator
Dynamic left shift operator
that
a hardware component
returns
this Bool dynamically shifted left by that many places, shifting in zeros from the right
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many zeros concatenated to its least significant end
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many zeros concatenated to its least significant end
Definition Classes
Bits
Note
The width of the returned Bool is width of this + that.
final macro def >>(that: UInt): Bits
Dynamic right shift operator
Dynamic right shift operator
that
a hardware component
returns
this Bool 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 Bool 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 Bool with that many least significant bits truncated
Definition Classes
Bits
Note
The width of the returned Bool 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 Bool with that many least significant bits truncated
Definition Classes
Bits
Note
The width of the returned Bool is unchanged, i.e., the width of this.
final macro def ^(that: Bool): Bool
Bitwise exclusive or (xor) operator
Bitwise exclusive or (xor) operator
that
a hardware Bool
returns
the bitwise xor of this Bool and that
final macro def ^(that: UInt): UInt
Bitwise exclusive or (xor) operator
Bitwise exclusive or (xor) operator
that
a hardware Bool
returns
the bitwise xor of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).
final macro def andR: Bool
And reduction operator
And reduction operator
returns
a hardware Bool resulting from every bit of this Bool and'd together
Definition Classes
UInt
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 Bool
Definition Classes
Bits
final macro def orR: Bool
Or reduction operator
Or reduction operator
returns
a hardware Bool resulting from every bit of this Bool or'd together
Definition Classes
UInt
final macro def pad(that: Int): Bool.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.
Definition Classes
Bits
Note
For SInts only, this will do sign extension.
final macro def tail(n: Int): UInt
Tail operator
Tail operator
n
the number of bits to remove
returns
This Bool with the n most significant bits removed.
Definition Classes
Bits
final macro def unary_!: Bool
Unary not
Unary not
returns
a hardware Bool asserted if this Bool equals zero
Definition Classes
UInt
final macro def unary_~: Bits
Bitwise inversion operator
Bitwise inversion operator
returns
this Bool with each bit inverted
Definition Classes
Bits
final macro def xorR: Bool
Exclusive or (xor) reduction operator
Exclusive or (xor) reduction operator
returns
a hardware Bool resulting from every bit of this Bool xor'd together
Definition Classes
UInt
final macro def |(that: Bool): Bool
Bitwise or operator
Bitwise or operator
that
a hardware Bool
returns
the bitwise or of this Bool and that
final macro def |(that: UInt): UInt
Bitwise or operator
Bitwise or operator
that
a hardware Bool
returns
the bitwise or of this Bool and that
Definition Classes
UInt
Note
The width of the returned Bool is max(width of this, width of that).

Comparison

Comparison hardware operators

final macro def <(that: UInt): Bool
Less than operator
Less than operator
that
a Bool
returns
a hardware Bool asserted if this Bool is less than that
Definition Classes
Num
final macro def <=(that: UInt): Bool
Less than or equal to operator
Less than or equal to operator
that
a Bool
returns
a hardware Bool asserted if this Bool is less than or equal to that
Definition Classes
Num
final macro def =/=(that: UInt): Bool
Dynamic not equals operator
Dynamic not equals operator
that
a hardware Bool
returns
a hardware Bool asserted if this Bool is not equal to that
Definition Classes
UInt
final macro def ===(that: UInt): Bool
Dynamic equals operator
Dynamic equals operator
that
a hardware Bool
returns
a hardware Bool asserted if this Bool is equal to that
Definition Classes
UInt
final macro def >(that: UInt): Bool
Greater than operator
Greater than operator
that
a hardware component
returns
a hardware Bool asserted if this Bool is greater than that
Definition Classes
Num
final macro def >=(that: UInt): Bool
Greater than or equal to operator
Greater than or equal to operator
that
a hardware component
returns
a hardware Bool asserted if this Bool is greather than or equal to that
Definition Classes
Num

Logical

Logical hardware operators

macro def &&(that: Bool): Bool
Logical and operator
Logical and operator
that
a hardware Bool
returns
the logical and of this Bool and that
Note
this is equivalent to Bool.&
macro def ||(that: Bool): Bool
Logical or operator
Logical or operator
that
a hardware Bool
returns
the logical or of this Bool and that
Note
this is equivalent to Bool.|)

connection

final def :#=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
producer
the right-hand-side of the connection, all members will be driving, none will be driven-to
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :#=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
producer
the right-hand-side of the connection, all members will be driving, none will be driven-to
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :#=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "mono-direction connection operator", aka the "coercion operator".
The "mono-direction connection operator", aka the "coercion operator".
For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)
Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '#' means to ignore flips, always drive from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
producer
the right-hand-side of the connection; will always drive leaf connections, and never get driven by leaf connections ("aligned connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
producer
the right-hand-side of the connection; will always drive leaf connections, and never get driven by leaf connections ("aligned connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "aligned connection operator" between a producer and consumer.
The "aligned connection operator" between a producer and consumer.
For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
producer
the right-hand-side of the connection
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
producer
the right-hand-side of the connection
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :<>=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "bi-direction connection operator", aka the "tur-duck-en operator"
The "bi-direction connection operator", aka the "tur-duck-en operator"
For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer
Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '<' means to connect from producer to consumer
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.
Additional notes:
- Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
- If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
- "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :=(that: => Data)(implicit sourceInfo: SourceInfo): Unit
The "strong connect" operator.
The "strong connect" operator.
For chisel3._, this operator is mono-directioned; all sub-elements of this will be driven by sub-elements of that.
- Equivalent to this :#= that
For Chisel._, this operator connections bi-directionally via emitting the FIRRTL.<=
- Equivalent to this :<>= that
that
the Data to connect from
Definition Classes
Data
final def :>=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
producer
the right-hand-side of the connection; will always be driven by leaf connections, and never drive leaf connections ("flipped connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :>=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
producer
the right-hand-side of the connection; will always be driven by leaf connections, and never drive leaf connections ("flipped connection")
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def :>=[S <: Data](lProducer: => S)(implicit evidence: =:=[Bool, S], sourceInfo: SourceInfo): Unit
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.
For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.
Symbol reference:
- ':' is the consumer side
- '=' is the producer side
- '>' means to connect from consumer to producer
The following restrictions apply:
- The Chisel type of consumer and producer must be the "same shape" recursively:
  - All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
  - All vector types are the same length
  - All bundle types have the same member names, but the flips of members can be different between producer and consumer
- The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.
Additional notes:
- Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
Implicit
This member is added by an implicit conversion from Bool toConnectableDefault[Bool] performed by method ConnectableDefault in chisel3.Data.
Definition Classes
ConnectableOpExtension
final def <>(that: => Data)(implicit sourceInfo: SourceInfo): Unit
The "bulk connect operator", assigning elements in this Vec from elements in a Vec.
The "bulk connect operator", assigning elements in this Vec from elements in a Vec.
For chisel3._, uses the chisel3.internal.BiConnect algorithm; sub-elements of that may end up driving sub-elements of this
- Complicated semantics, hard to write quickly, will likely be deprecated in the future
For Chisel._, emits the FIRRTL.<- operator
- Equivalent to this :<>= that without the restrictions that bundle field names and vector sizes must match
that
the Data to connect from
Definition Classes
Data

Ungrouped

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
def ->[B](y: B): (Bool, B)
Implicit
This member is added by an implicit conversion from Bool toArrowAssoc[Bool] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def _padLit(that: Int): Bool.this.type
Attributes
protected
Definition Classes
UInt → Bits
final macro def apply(x: BigInt, y: BigInt): UInt
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
x
the high bit
y
the low bit
returns
a hardware component containing the requested bits
Definition Classes
Bits
Example:
1. val myBits = "0b101".U myBits(1, 0) // "0b01".U // extracts the two least significant bits // Note that zero-width ranges are also legal myBits(-1, 0) // 0.U(0.W) // zero-width UInt
final macro def apply(x: Int, y: Int): UInt
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
Returns a subset of bits on this Bool from hi to lo (inclusive), statically addressed.
x
the high bit
y
the low bit
returns
a hardware component containing the requested bits
Definition Classes
Bits
Example:
1. val myBits = "0b101".U myBits(1, 0) // "0b01".U // extracts the two least significant bits // Note that zero-width ranges are also legal myBits(-1, 0) // 0.U(0.W) // zero-width UInt
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
Definition Classes
Bits
final macro def apply(x: Int): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
final macro def apply(x: BigInt): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
def as[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Static cast to a super type
Static cast to a super type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
final macro def asAsyncReset: AsyncReset
Casts this Bool to an AsyncReset
Casts this Bool to an AsyncReset
Definition Classes
Reset
final macro def asBool: Bool
Casts this Bool to a Bool
Casts this Bool 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.
Returns the contents of this wire as a scala.collection.Seq of Bool.
Definition Classes
Bits
macro def asClock: Clock
Reinterprets this Bool as a clock
final macro def asDisable: Disable
Casts this Bool to a Disable
Casts this Bool to a Disable
Definition Classes
Reset
final def asInstanceOf[T0]: T0
Definition Classes
Any
final macro def asSInt: SInt
Reinterpret this Bool as an SInt
Reinterpret this Bool 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.
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 autoSeed(name: String): Bool.this.type
Takes the last seed suggested.
Takes the last seed suggested. Multiple calls to this function will take the last given seed, unless this HasId is a module port (see overridden method in Data.scala).
If the final computed name conflicts with the final name of another signal, the final name may get uniquified by appending a digit at the end of the name.
Is a lower priority than suggestName, in that regardless of whether autoSeed was called, suggestName will always take precedence if it was called.
returns
this object
Definition Classes
Data → HasId
val base: Bool
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def binding: Option[Binding]
Attributes
protected[chisel3]
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
Conditionally set or clear a bit
off
a dynamic offset
dat
set if true, clear if false
returns
a hrdware Bool with bit off set or cleared based on the value of dat
Definition Classes
UInt
Note
The width of the returned Bool is unchanged, i.e., the width of this.
def circuitName: String
Definition Classes
HasId
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def cloneType: Bool.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 containsAFlipped: Boolean
Definition Classes
Element → Data
def do_rotateLeft(n: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateLeft(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateRight(n: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_rotateRight(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
final def do_take(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
def ensuring(cond: (Bool) => Boolean, msg: => Any): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Bool) => Boolean): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Bool
Implicit
This member is added by an implicit conversion from Bool toEnsuring[Bool] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(that: Any): Boolean
Definition Classes
HasId → AnyRef → Any
def exclude(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to exclude
Select members of base to exclude
members
functions given the base return a member to exclude
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def exclude: connectable.Connectable[Bool]
Adds base to excludes
Adds base to excludes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeAs[S <: Data](members: (Bool) => Data*)(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Select members of base to exclude and static cast to a new type
Select members of base to exclude and static cast to a new type
members
functions given the base return a member to exclude
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeEach[S <: Data](pf: PartialFunction[Data, Seq[Data]])(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Programmatically select members of base to exclude and static cast to a new type
Programmatically select members of base to exclude and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def excludeProbes: connectable.Connectable[Bool]
Exclude probes
Exclude probes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
final macro def extract(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
Definition Classes
Bits
final macro def extract(x: BigInt): Bool
Returns the specified bit on this Bool as a Bool, statically addressed.
Returns the specified bit on this Bool as a Bool, statically addressed.
x
an index
returns
the specified bit
Definition Classes
Bits
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
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 hasSeed: Boolean
returns
Whether either autoName or suggestName has been called
Definition Classes
HasId
def hashCode(): Int
Definition Classes
HasId → AnyRef → Any
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 litToBoolean: Boolean
Convert to a scala.Boolean
def litToBooleanOption: Option[Boolean]
Convert to a scala.Option of scala.Boolean
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
def notWaivedOrSqueezedOrExcluded: Boolean
True if no members are waived or squeezed or excluded
True if no members are waived or squeezed or excluded
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def parentModName: String
Definition Classes
HasId → InstanceId
def parentPathName: String
Definition Classes
HasId → InstanceId
def pathName: String
Definition Classes
HasId → InstanceId
def readOnly(implicit sourceInfo: SourceInfo): Bool
Returns a read-only view of this Data
Returns a read-only view of this Data
It is illegal to connect to the return value of this method. This Data this method is called on must be a hardware type.
Implicit
This member is added by an implicit conversion from Bool toAsReadOnly[Bool] performed by method AsReadOnly in chisel3.Data.
Definition Classes
AsReadOnly
final macro def rotateLeft(that: UInt): UInt
Definition Classes
UInt
final macro def rotateLeft(that: Int): UInt
Circular shift to the left
Circular shift to the left
that
number of bits to rotate
returns
UInt of same width rotated left n bits
Definition Classes
UInt
final macro def rotateRight(that: UInt): UInt
Definition Classes
UInt
final macro def rotateRight(that: Int): UInt
Circular shift to the right
Circular shift to the right
that
number of bits to rotate
returns
UInt of same width rotated right n bits
Definition Classes
UInt
def squeeze(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to squeeze
Select members of base to squeeze
members
functions given the base return a member to squeeze
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeeze: connectable.Connectable[Bool]
Adds base to squeezes
Adds base to squeezes
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeAll: connectable.Connectable[Bool]
Squeeze all members of base
Squeeze all members of base
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeAllAs[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Squeeze all members of base and upcast to super type
Squeeze all members of base and upcast to super type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def squeezeEach[S <: Data](pf: PartialFunction[Data, Seq[Data]]): connectable.Connectable[Bool]
Programmatically select members of base to squeeze
Programmatically select members of base to squeeze
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def suggestName(seed: => String): Bool.this.type
Takes the first seed suggested.
Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.
Is a higher priority than autoSeed, in that regardless of whether autoSeed was called, suggestName will always take precedence.
seed
The seed for the name of this component
returns
this object
Definition Classes
HasId
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final macro def take(n: Int): UInt
Grab the bottom n bits.
Grab the bottom n bits. Return 0.U(0.W) if n==0.
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
Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph
Definition Classes
NamedComponent → InstanceId
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
final def toRelativeTarget(root: Option[BaseModule]): ReferenceTarget
Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.
Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.
If root is defined, the target is a hierarchical path starting from root.
If root is not defined, the target is a hierarchical path equivalent to toAbsoluteTarget.
Definition Classes
NamedComponent
Note
If root is defined, and has not finished elaboration, this must be called within atModuleBodyEnd.
,
The NamedComponent must be a descendant of root, if it is defined.
,
This doesn't have special handling for Views.
def toString(): String
Definition Classes
Bool → UInt → 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
def typeName: String
Give this Bool a stable typeName for Verilog name generation.
Give this Bool a stable typeName for Verilog name generation. Specifying a Bool's width in its type name isn't necessary
Definition Classes
Bool → Bits → Data
def unsafe: connectable.Connectable[Data]
Connect to/from all fields regardless of Scala type, squeeze if necessary, and don't error if mismatched members
Connect to/from all fields regardless of Scala type, squeeze if necessary, and don't error if mismatched members
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
final def validateShiftAmount(x: Int)(implicit sourceInfo: SourceInfo): Int
Attributes
protected
Definition Classes
Bits
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
def waive(members: (Bool) => Data*): connectable.Connectable[Bool]
Select members of base to waive
Select members of base to waive
members
functions given the base return a member to waive
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAll: connectable.Connectable[Bool]
Waive all members of base
Waive all members of base
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAllAs[S <: Data](implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Waive all members of base and static cast to a new type
Waive all members of base and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveAs[S <: Data](members: (Bool) => Data*)(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Select members of base to waive and static cast to a new type
Select members of base to waive and static cast to a new type
members
functions given the base return a member to waive
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
def waiveEach[S <: Data](pf: PartialFunction[Data, Seq[Data]])(implicit ev: <:<[Bool, S]): connectable.Connectable[S]
Programmatically select members of base to waive and static cast to a new type
Programmatically select members of base to waive and static cast to a new type
Implicit
This member is added by an implicit conversion from Bool toConnectable[Bool] performed by method toConnectableDefault in chisel3.Data.
Definition Classes
Connectable
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
final macro def zext: SInt
Zero extend as SInt
Zero extend as SInt
returns
an SInt equal to this Bool with an additional zero in its most significant bit
Definition Classes
UInt
Note
The width of the returned SInt is width of this + 1.
def +(other: String): String
Implicit
This member is added by an implicit conversion from Bool toany2stringadd[Bool] performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bool: any2stringadd[Bool]).+(other)
Definition Classes
any2stringadd
def ===(rhs: Bool): Bool
Dynamic recursive equality operator for generic Data
Dynamic recursive equality operator for generic Data
rhs
a hardware Data to compare lhs to
returns
a hardware Bool asserted if lhs is equal to rhs
Implicit
This member is added by an implicit conversion from Bool toDataEquality[Bool] performed by method DataEquality in chisel3.Data.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bool: DataEquality[Bool]).===(rhs)
Definition Classes
DataEquality
Exceptions thrown
ChiselException when lhs and rhs are different types during elaboration time
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from Bool toStringFormat[Bool] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
def →[B](y: B): (Bool, B)
Implicit
This member is added by an implicit conversion from Bool toArrowAssoc[Bool] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

SourceInfoTransformMacro

These internal methods are not part of the public-facing API!

The equivalent public-facing methods do not have the do_ prefix or have the same name. Use and look at the documentation for those. If you want left shift, use <<, not do_<<. If you want conversion to a Seq of Bools look at the asBools above, not the one below. Users can safely ignore every method in this group!

🐉🐉🐉 Here be dragons... 🐉🐉🐉

These do_X methods are used to enable both implicit passing of SourceInfo while also supporting chained apply methods. In effect all "normal" methods that you, as a user, will use in your designs, are converted to their "hidden", do_*, via macro transformations. Without using macros here, only one of the above wanted behaviors is allowed (implicit passing and chained applies)---the compiler interprets a chained apply as an explicit 'implicit' argument and will throw type errors.

The "normal", public-facing methods then take no SourceInfo. However, a macro transforms this public-facing method into a call to an internal, hidden do_* that takes an explicit SourceInfo by inserting an implicitly[SourceInfo] as the explicit argument.

def do_##(that: Bits)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
def do_%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_&(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def do_&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_&&(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def do_*(that: SInt)(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt
def do_*(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_+(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_+%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_+&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_-(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_-%(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_-&(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_/(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_<(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_<<(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<<(that: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<<(that: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_<=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_=/=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_===(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_>(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_>=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt → Num
def do_>>(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_>>(that: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_>>(that: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Bits
def do_^(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def do_^(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_abs(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt → Num
def do_andR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
final def do_apply(x: BigInt, y: BigInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
final def do_apply(x: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_apply(x: Int)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_apply(x: BigInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
def do_asAsyncReset(implicit sourceInfo: SourceInfo): AsyncReset
Definition Classes
Bool → Reset
def do_asBool(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bool → Bits → ToBoolable
def do_asBools(implicit sourceInfo: SourceInfo): Seq[Bool]
Definition Classes
Bits
def do_asClock(implicit sourceInfo: SourceInfo): Clock
def do_asDisable(implicit sourceInfo: SourceInfo): Disable
Definition Classes
Reset
def do_asSInt(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt → Bits
def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo): T
Definition Classes
Data
def do_asUInt(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Data
def do_bitSet(off: UInt, dat: Bool)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
final def do_extract(x: UInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
final def do_extract(x: BigInt)(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bits
def do_head(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
def do_max(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Num
def do_min(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Num
def do_orR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_pad(that: Int)(implicit sourceInfo: SourceInfo): Bool.this.type
Definition Classes
Bits
def do_tail(n: Int)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
Bits
def do_unary_!(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_unary_-(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_unary_-%(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_unary_~(implicit sourceInfo: SourceInfo): Bool
Definition Classes
Bool → UInt → Bits
def do_xorR(implicit sourceInfo: SourceInfo): Bool
Definition Classes
UInt
def do_zext(implicit sourceInfo: SourceInfo): SInt
Definition Classes
UInt
def do_|(that: Bool)(implicit sourceInfo: SourceInfo): Bool
def do_|(that: UInt)(implicit sourceInfo: SourceInfo): UInt
Definition Classes
UInt
def do_||(that: Bool)(implicit sourceInfo: SourceInfo): Bool

Packages

Bool

sealed class Bool extends UInt with Reset

Instance Constructors

Value Members

Shadowed Implicit Value Members

Deprecated Value Members

Inherited from Reset

Value Members

Inherited from UInt

Value Members

Inherited from Num[UInt]

Value Members

Inherited from Bits

Value Members

Inherited from ToBoolable

Value Members

Inherited from Element

Value Members

Inherited from Data

Value Members

Inherited from NamedComponent

Value Members

Inherited from HasId

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion AsReadOnly fromBool to AsReadOnly[Bool]

Value Members

Inherited by implicit conversion DataEquality fromBool to DataEquality[Bool]

Value Members

Inherited by implicit conversion toConnectableDefault fromBool to Connectable[Bool]

Value Members

Inherited by implicit conversion ConnectableDefault fromBool to ConnectableDefault[Bool]

Value Members

Inherited by implicit conversion any2stringadd fromBool to any2stringadd[Bool]

Value Members

Inherited by implicit conversion StringFormat fromBool to StringFormat[Bool]

Value Members

Inherited by implicit conversion Ensuring fromBool to Ensuring[Bool]

Value Members

Inherited by implicit conversion ArrowAssoc fromBool to ArrowAssoc[Bool]

Value Members

Arithmetic

Bitwise

Comparison

Logical

connection

Ungrouped

SourceInfoTransformMacro

Bool