chisel3
package chisel3
The chisel3 package contains the chisel3 API. It maps core components into the public chisel3 namespace.
- Alphabetic
- By Inheritance
- chisel3
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- implicit class AddDirectionToData[T <: Data] extends AnyRef
- type Aggregate = chisel3.core.Aggregate
- trait BackendCompilationUtilities extends firrtl.util.BackendCompilationUtilities
- type Binary = chisel3.core.Binary
- type Bits = chisel3.core.Bits
- type BlackBox = chisel3.core.BlackBox
- type Bool = chisel3.core.Bool
-
trait
BoolFactory extends chisel3.core.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. These will be removed very soon. It's recommended you move your code soon.
- type Bundle = chisel3.core.Bundle
- type Character = chisel3.core.Character
- type ChiselException = chisel3.internal.ChiselException
-
case class
ChiselExecutionFailure(message: String) extends ChiselExecutionResult with Product with Serializable
Getting one of these indicates failure of some sort.
Getting one of these indicates failure of some sort.
- message
A clue might be provided here.
-
case class
ChiselExecutionOptions(runFirrtlCompiler: Boolean = true) extends ComposableOptions with Product with Serializable
Options that are specific to chisel.
Options that are specific to chisel.
- runFirrtlCompiler
when true just run chisel, when false run chisel then compile its output with firrtl
- Note
this extends FirrtlExecutionOptions which extends CommonOptions providing easy access to down chain options
-
trait
ChiselExecutionResult extends AnyRef
This family provides return values from the chisel3 and possibly firrtl compile steps
-
case class
ChiselExecutionSuccess(circuitOption: Option[Circuit], emitted: String, firrtlResultOption: Option[FirrtlExecutionResult]) extends ChiselExecutionResult with Product with Serializable
- circuitOption
Optional circuit, has information like circuit name
- emitted
The emitted Chirrrl text
- firrtlResultOption
Optional Firrtl result, @see freechipsproject/firrtl for details
- type Clock = chisel3.core.Clock
- type Data = chisel3.core.Data
- type Decimal = chisel3.core.Decimal
- type Element = chisel3.core.Element
- type FirrtlFormat = chisel3.core.FirrtlFormat
- type FullName = chisel3.core.FullName
- trait HasChiselExecutionOptions extends AnyRef
- type Hexadecimal = chisel3.core.Hexadecimal
- type IgnoreSeqInBundle = chisel3.core.IgnoreSeqInBundle
- type InstanceId = chisel3.internal.InstanceId
- type Mem[T <: Data] = chisel3.core.Mem[T]
- type MemBase[T <: Data] = chisel3.core.MemBase[T]
- type Module = LegacyModule
- type Name = chisel3.core.Name
- type Num[T <: Data] = chisel3.core.Num[T]
- type PString = chisel3.core.PString
- type Printable = chisel3.core.Printable
-
implicit final
class
PrintableHelper extends AnyVal
Implicit for custom Printable string interpolator
- type Printables = chisel3.core.Printables
- type Record = chisel3.core.Record
- type SInt = chisel3.core.SInt
-
trait
SIntFactory extends chisel3.core.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. These will be removed very soon. It's recommended you move your code soon.
- type SyncReadMem[T <: Data] = chisel3.core.SyncReadMem[T]
- type UInt = chisel3.core.UInt
-
trait
UIntFactory extends chisel3.core.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. These will be removed very soon. It's recommended you port your code ASAP.
- type Vec[T <: Data] = chisel3.core.Vec[T]
- type VecLike[T <: Data] = chisel3.core.VecLike[T]
- type WhenContext = chisel3.core.WhenContext
- implicit class cloneTypeable[T <: Data] extends AnyRef
- implicit class fromBigIntToLiteral extends chisel3.core.fromBigIntToLiteral
- implicit class fromBitsable[T <: Data] extends AnyRef
- implicit class fromBooleanToLiteral extends chisel3.core.fromBooleanToLiteral
- implicit class fromDoubleToLiteral extends chisel3.core.fromDoubleToLiteral
- implicit class fromIntToBinaryPoint extends chisel3.core.fromIntToBinaryPoint
- implicit class fromIntToWidth extends chisel3.core.fromIntToWidth
- implicit class fromStringToLiteral extends chisel3.core.fromStringToLiteral
- implicit class fromUIntToBitPatComparable extends AnyRef
- implicit class fromtIntToLiteral extends fromIntToLiteral
- implicit class fromtLongToLiteral extends fromLongToLiteral
-
type
SeqMem[T <: Data] = chisel3.core.SyncReadMem[T]
- Annotations
- @deprecated
- Deprecated
(Since version chisel3) Use 'SyncReadMem'
Value Members
- val Binary: chisel3.core.Binary.type
- val Character: chisel3.core.Character.type
- val Clock: chisel3.core.Clock.type
- val Decimal: chisel3.core.Decimal.type
- val DontCare: chisel3.core.DontCare.type
- val FirrtlFormat: chisel3.core.FirrtlFormat.type
- val Flipped: chisel3.core.Flipped.type
- val FullName: chisel3.core.FullName.type
- val Hexadecimal: chisel3.core.Hexadecimal.type
- val Input: chisel3.core.Input.type
- val Mem: chisel3.core.Mem.type
- val Module: chisel3.core.Module.type
- val Mux: chisel3.core.Mux.type
- val Name: chisel3.core.Name.type
- val Output: chisel3.core.Output.type
- val PString: chisel3.core.PString.type
- val Percent: chisel3.core.Percent.type
- val Printable: chisel3.core.Printable.type
- val Printables: chisel3.core.Printables.type
- val RegInit: chisel3.core.RegInit.type
- val RegNext: chisel3.core.RegNext.type
- val SyncReadMem: chisel3.core.SyncReadMem.type
- val VecInit: chisel3.core.VecInit.type
- val WireInit: chisel3.core.WireInit.type
- val assert: chisel3.core.assert.type
- val chiselTypeOf: chisel3.core.chiselTypeOf.type
- def getDataElements(a: Aggregate): Seq[Element]
- def getModulePorts(m: Module): Seq[Port]
- val printf: chisel3.core.printf.type
- implicit def string2Printable(str: String): Printable
- val when: chisel3.core.when.type
- object Bits extends UIntFactory
- object Bool extends BoolFactory
-
object
BuildInfo extends Product with Serializable
This object was generated by sbt-buildinfo.
- object Driver extends BackendCompilationUtilities
- object Reg
- object SInt extends SIntFactory
- object UInt extends UIntFactory
- object Vec extends VecFactory
- object Wire extends WireFactory
-
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
SeqMem: chisel3.core.SyncReadMem.type
- Annotations
- @deprecated
- Deprecated
(Since version chisel3) Use 'SyncReadMem'
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.