Chisel
package Chisel
- Alphabetic
- By Inheritance
- Chisel
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
implicit
class
AddDirMethodToData[T <: Data] extends AnyRef
- Annotations
- @nowarn()
-
implicit
class
AddDirectionToData[T <: Data] extends AnyRef
- Annotations
- @nowarn()
-
implicit
class
BitsCompatibility extends AnyRef
- Annotations
- @nowarn()
- implicit class BitsObjectCompatibility extends AnyRef
-
implicit
class
DataCompatibility extends AnyRef
- Annotations
- @nowarn()
- implicit class MemCompatibility extends AnyRef
-
sealed
class
QueueCompatibility[T <: Data] extends chisel3.util.Queue[T]
- Annotations
- @nowarn()
- implicit class SeqMemCompatibility extends AnyRef
-
implicit
class
VecLikeCompatibility[T <: Data] extends AnyRef
- Annotations
- @nowarn()
-
implicit
class
cloneTypeable[T <: Data] extends AnyRef
- Annotations
- @nowarn()
- implicit class fromBigIntToLiteral extends chisel3.fromBigIntToLiteral
-
implicit
class
fromBitsable[T <: Data] extends AnyRef
- Annotations
- @nowarn()
- implicit class fromBooleanToLiteral extends chisel3.fromBooleanToLiteral
- implicit class fromIntToWidth extends chisel3.fromIntToWidth
- implicit class fromStringToLiteral extends chisel3.fromStringToLiteral
- implicit class fromtIntToLiteral extends fromIntToLiteral
- implicit class fromtLongToLiteral extends fromLongToLiteral
-
type
Aggregate = chisel3.Aggregate
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Arbiter[T <: Data] = chisel3.util.Arbiter[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
ArbiterIO[T <: Data] = chisel3.util.ArbiterIO[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
BackendCompilationUtilities = chisel3.BackendCompilationUtilities
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Use object firrtl.util.BackendCompilationUtilities instead
-
type
BitPat = chisel3.util.BitPat
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Bits = chisel3.Bits
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
BlackBox = LegacyBlackBox
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Bool = chisel3.Bool
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
trait
BoolFactory extends chisel3.BoolFactory
This contains literal constructor factory methods that are deprecated as of Chisel3.
This contains literal constructor factory methods that are deprecated as of Chisel3.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Bundle = chisel3.Bundle
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
ChiselException = chisel3.internal.ChiselException
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Clock = chisel3.Clock
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
CompatibilityModule = LegacyModule
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Use Chisel.Module
-
type
Counter = chisel3.util.Counter
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Data = chisel3.Data
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
DecoupledIO[+T <: Data] = chisel3.util.DecoupledIO[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
abstract
class
Direction extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Element = chisel3.Element
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
LockingArbiter[T <: Data] = chisel3.util.LockingArbiter[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
LockingArbiterLike[T <: Data] = chisel3.util.LockingArbiterLike[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
LockingRRArbiter[T <: Data] = chisel3.util.LockingRRArbiter[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Mem[T <: Data] = chisel3.Mem[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
MemBase[T <: Data] = chisel3.MemBase[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Module = LegacyModule
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Num[T <: Data] = chisel3.Num[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Pipe[T <: Data] = chisel3.util.Pipe[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Queue[T <: Data] = QueueCompatibility[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
QueueIO[T <: Data] = chisel3.util.QueueIO[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
RRArbiter[T <: Data] = chisel3.util.RRArbiter[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Record = chisel3.Record
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Reset = chisel3.Reset
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
SInt = chisel3.SInt
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
trait
SIntFactory extends chisel3.SIntFactory
This contains literal constructor factory methods that are deprecated as of Chisel3.
This contains literal constructor factory methods that are deprecated as of Chisel3.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
SeqMem[T <: Data] = SyncReadMem[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
SwitchContext[T <: Bits] = chisel3.util.SwitchContext[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
UInt = chisel3.UInt
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
trait
UIntFactory extends chisel3.UIntFactory
This contains literal constructor factory methods that are deprecated as of Chisel3.
This contains literal constructor factory methods that are deprecated as of Chisel3.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
ValidIO[+T <: Data] = Valid[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
Vec[T <: Data] = chisel3.Vec[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
VecLike[T <: Data] = chisel3.VecLike[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
type
WhenContext = chisel3.WhenContext
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
Value Members
- object Enum extends Enum
-
object
LFSR16
LFSR16 generates a 16-bit linear feedback shift register, returning the register contents.
LFSR16 generates a 16-bit linear feedback shift register, returning the register contents. This is useful for generating a pseudo-random sequence.
The example below, taken from the unit tests, creates two 4-sided dice using
LFSR16
primitives:- Annotations
- @nowarn()
val bins = Reg(Vec(8, UInt(32.W))) // Create two 4 sided dice and roll them each cycle. // Use tap points on each LFSR so values are more independent val die0 = Cat(Seq.tabulate(2) { i => LFSR16()(i) }) val die1 = Cat(Seq.tabulate(2) { i => LFSR16()(i + 2) }) val rollValue = die0 +& die1 // Note +& is critical because sum will need an extra bit. bins(rollValue) := bins(rollValue) + 1.U
Example: -
object
Reg
- Annotations
- @nowarn()
- object chiselMain
-
object
experimental
Package for experimental features, which may have their API changed, be removed, etc.
Package for experimental features, which may have their API changed, be removed, etc.
Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.
Deprecated Value Members
-
val
BitPat: chisel3.util.BitPat.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Cat: chisel3.util.Cat.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Counter: chisel3.util.Counter.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Decoupled: chisel3.util.Decoupled.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
DecoupledIO: chisel3.util.Decoupled.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Fill: chisel3.util.Fill.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
FillInterleaved: chisel3.util.FillInterleaved.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
ImplicitConversions: chisel3.util.ImplicitConversions.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Input: chisel3.Input.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
ListLookup: chisel3.util.ListLookup.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Log2: chisel3.util.Log2.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Lookup: chisel3.util.Lookup.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Mem: chisel3.Mem.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Module: chisel3.Module.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Mux: chisel3.Mux.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Mux1H: chisel3.util.Mux1H.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
MuxCase: chisel3.util.MuxCase.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
MuxLookup: chisel3.util.MuxLookup.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
OHToUInt: chisel3.util.OHToUInt.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Output: chisel3.Output.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Pipe: chisel3.util.Pipe.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
PopCount: chisel3.util.PopCount.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
PriorityEncoder: chisel3.util.PriorityEncoder.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
PriorityEncoderOH: chisel3.util.PriorityEncoderOH.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
PriorityMux: chisel3.util.PriorityMux.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Queue: chisel3.util.Queue.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
RegEnable: chisel3.util.RegEnable.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
RegInit: chisel3.RegInit.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
RegNext: chisel3.RegNext.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Reverse: chisel3.util.Reverse.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
SeqMem: SyncReadMem.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
ShiftRegister: chisel3.util.ShiftRegister.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
UIntToOH: chisel3.util.UIntToOH.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
Valid: chisel3.util.Valid.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
assert: chisel3.assert.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
implicit
val
defaultCompileOptions: CompileOptionsClass
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
is: chisel3.util.is.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
isPow2: chisel3.util.isPow2.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
log2Ceil: chisel3.util.log2Ceil.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
log2Down: chisel3.util.log2Down.type
Compute the log2 rounded down with min value of 1
Compute the log2 rounded down with min value of 1
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
log2Floor: chisel3.util.log2Floor.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
log2Up: chisel3.util.log2Up.type
Compute the log2 rounded up with min value of 1
Compute the log2 rounded up with min value of 1
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
printf: chisel3.printf.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
implicit
def
resetToBool(reset: Reset): Bool
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
stop: chisel3.stop.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
switch: chisel3.util.switch.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
val
when: chisel3.when.type
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
Bits extends UIntFactory
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
Bool extends BoolFactory
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
Clock
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
Flipped
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
INPUT extends Direction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
NODIR extends Direction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
OUTPUT extends Direction with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
SInt extends SIntFactory
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
UInt extends UIntFactory
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
Vec extends VecFactory
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
Wire extends WireFactory
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
debug
- Annotations
- @deprecated @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
testers
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
-
object
throwException
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) Chisel compatibility mode is deprecated. Use the chisel3 package instead.
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt
,SInt
,Bool
,FixedPoint
,Clock
, andReg
, the abstract typesBits
,Aggregate
, andData
, and the aggregate typesBundle
andVec
.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
util
package.The
testers
package defines the basic interface for chisel testers.