Concatenation operator

Modulo operator

Bitwise and operator

Multiplication operator

Multiplication operator

Addition operator

Addition operator (constant width)

Addition operator (expanding width)

Subtraction operator

Subtraction operator (constant width)

Subtraction operator (increasing width)

Division 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.:=

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.:=

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.:=

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

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

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

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

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

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

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

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

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

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

Less than operator

Dynamic left shift operator

Static left shift operator

Static left shift operator

Less than or equal to operator

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

Dynamic not equals operator

Dynamic equals operator

Greater than operator

Greater than or equal to operator

Dynamic right shift operator

Static right shift operator

Static right shift operator

Bitwise exclusive or (xor) operator

Absolute value operator

And reduction operator

Returns a subset of bits on this UInt from hi to lo (inclusive), statically addressed.

Returns a subset of bits on this UInt from hi to lo (inclusive), statically addressed.

Returns the specified bit on this wire as a Bool, dynamically addressed.

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

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

Casts this UInt to a Bool

Returns the contents of this wire as a scala.collection.Seq of Bool.

Reinterpret this UInt as an SInt

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.

Reinterpret cast to UInt.

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.

Conditionally set or clear a bit

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 the specified bit on this wire as a Bool, dynamically addressed.

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

Returns the width, in bits, if currently known.

Head operator

Returns whether the width is currently known.

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.

Returns the literal value if this is a literal that is representable as bits, otherwise crashes.

Maximum operator

Minimum operator

True if no members are waived or squeezed

Or reduction operator

Pad operator

Circular shift to the left

Circular shift to the right

Select members of base to squeeze

Adds base to squeezes

Squeeze all members of base

Programmatically select members of base to squeeze

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.

Tail operator

Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

Returns a FIRRTL ComponentName that references this object

Default print as Decimal

Returns a FIRRTL ReferenceTarget that references this object

Unary not

Unary negation (expanding width)

Unary negation (constant width)

Bitwise inversion operator

Select members of base to waive

Waive all members of base

Waive all members of base and static cast to a new type

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

Returns Some(width) if the width is known, else None.

Exclusive or (xor) reduction operator

Zero extend as SInt

Bitwise or operator

Dynamic recursive equality operator for generic Data

Reinterpret this UInt as a FixedPoint.

Reinterpret cast as a Interval.