package annotations
- Alphabetic
- Public
- Protected
Deprecated Type Members
- trait Annotation extends Product
Base type of auxiliary information
Base type of auxiliary information
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class AnnotationClassNotFoundException(className: String) extends FirrtlUserException with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class AnnotationException(message: String) extends Exception with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class AnnotationFileNotFoundException(file: File) extends FirrtlUserException with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- trait CompleteTarget extends Target
Concretely points to a FIRRTL target, no generic selectors IsLegal
Concretely points to a FIRRTL target, no generic selectors IsLegal
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- final case class ComponentName(name: String, module: ModuleName) extends Named with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class GenericTarget(moduleOpt: Option[String], tokens: Vector[TargetToken]) extends Target with Product with Serializable
Represents incomplete or non-standard Targets
Represents incomplete or non-standard Targets
- moduleOpt
Optional module name
- tokens
TargetTokens to represent the target in a module
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- trait HasSerializationHints extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class InstanceTarget(module: String, path: Seq[(Instance, OfModule)], instance: String, ofModule: String) extends IsModule with IsComponent with Product with Serializable
Points to an instance declaration of a module (termed an ofModule)
Points to an instance declaration of a module (termed an ofModule)
- module
Root module (e.g. the base module of this target)
- path
Path through instance/ofModules
- instance
Name of the instance
- ofModule
Name of the instance's module
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class InvalidAnnotationFileException(file: File, cause: FirrtlUserException = null) extends FirrtlUserException with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class InvalidAnnotationJSONException(msg: String) extends FirrtlUserException with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- trait IsComponent extends IsMember
A component of a FIRRTL Module (e.g.
A component of a FIRRTL Module (e.g. cannot point to a ModuleTarget)
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- trait IsMember extends CompleteTarget
A member of a FIRRTL Circuit Concrete Subclasses are: ModuleTarget, InstanceTarget, and ReferenceTarget
A member of a FIRRTL Circuit Concrete Subclasses are: ModuleTarget, InstanceTarget, and ReferenceTarget
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- trait IsModule extends IsMember
References a module-like target (e.g.
References a module-like target (e.g. a ModuleTarget or an InstanceTarget)
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class LoadMemoryAnnotation(target: ComponentName, fileName: String, hexOrBinary: MemoryLoadFileType = MemoryLoadFileType.Hex, originalMemoryNameOpt: Option[String] = None) extends SingleTargetAnnotation[Named] with Product with Serializable
Firrtl implementation for load memory
Firrtl implementation for load memory
- target
memory to load
- fileName
name of input file
- hexOrBinary
use
$readmemh
or$readmemb
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class MemoryFileInlineAnnotation(target: ReferenceTarget, filename: String, hexOrBinary: FileType = MemoryLoadFileType.Hex) extends MemoryInitAnnotation with Product with Serializable
Initialize the
target
memory with inline readmem[hb] statement.Initialize the
target
memory with inline readmem[hb] statement.- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed trait MemoryInitAnnotation extends SingleTargetAnnotation[ReferenceTarget]
Represents the initial value of the annotated memory.
Represents the initial value of the annotated memory. While not supported on normal ASIC flows, it can be useful for simulation and FPGA flows. This annotation is consumed by the verilog emitter.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed abstract class MemoryLoadFileType extends AnyRef
Representation of the two types of
readmem
statements available in Verilog.Representation of the two types of
readmem
statements available in Verilog.- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- final case class ModuleName(name: String) extends Named with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class ModuleTarget(module: String) extends IsModule with Product with Serializable
Target pointing to a FIRRTL firrtl.ir.DefModule
Target pointing to a FIRRTL firrtl.ir.DefModule
- module
Name of the module
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed trait Named extends AnyRef
Named classes associate an annotation with a component in a Firrtl circuit
Named classes associate an annotation with a component in a Firrtl circuit
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- trait NoTargetAnnotation extends Annotation
If an Annotation does not target any Named thing in the circuit, then all updates just return the Annotation itself
If an Annotation does not target any Named thing in the circuit, then all updates just return the Annotation itself
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class ReferenceTarget(module: String, path: Seq[(Instance, OfModule)], ref: String, component: Seq[TargetToken]) extends IsComponent with Product with Serializable
Target pointing to a declared named component in a firrtl.ir.DefModule This includes: firrtl.ir.Port, firrtl.ir.DefWire, firrtl.ir.DefRegister, firrtl.ir.DefMemory, firrtl.ir.DefNode
Target pointing to a declared named component in a firrtl.ir.DefModule This includes: firrtl.ir.Port, firrtl.ir.DefWire, firrtl.ir.DefRegister, firrtl.ir.DefMemory, firrtl.ir.DefNode
- module
Name of the root module of this reference
- path
Path through instance/ofModules
- ref
Name of component
- component
Subcomponent of this reference, e.g. field or index
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- trait SingleTargetAnnotation[T <: Named] extends Annotation
An Annotation that targets a single Named thing
An Annotation that targets a single Named thing
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed trait Target extends Named
Refers to something in a FIRRTL firrtl.ir.Circuit.
Refers to something in a FIRRTL firrtl.ir.Circuit. Used for Annotation targets.
Can be in various states of completion/resolved:
- Legal: TargetToken's in tokens are in an order that makes sense
- Complete: moduleOpt is non-empty, and all Instance(_) are followed by OfModule(_)
- Local: tokens does not refer to things through an instance hierarchy (no Instance(_) or OfModule(_) tokens)
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed trait TargetToken extends AnyRef
Building block to represent a Target of a FIRRTL component
Building block to represent a Target of a FIRRTL component
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class UnrecogizedAnnotationsException(msg: String) extends FirrtlUserException with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class UnrecognizedAnnotation(underlying: JValue) extends NoTargetAnnotation with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- class UnserializableAnnotationException extends FirrtlUserException
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class UnserializeableAnnotation(error: String, content: String) extends NoTargetAnnotation with Product with Serializable
Wrapper Annotation for Annotations that cannot be serialized
Wrapper Annotation for Annotations that cannot be serialized
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
Deprecated Value Members
- object Annotation
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object AnnotationUtils
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object JsonProtocol extends LazyLogging
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object MemoryLoadFileType
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object Target
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case object TargetToken extends Product with Serializable
Object containing all TargetToken subclasses
Object containing all TargetToken subclasses
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object UnserializableAnnotationException extends Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
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
,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.