firrtl
package firrtl
- Alphabetic
- By Inheritance
- firrtl
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Package Members
- package annotations
- package graph
- package ir
- package options
- package passes
- package renamemap
- package stage
The stage package provides Stage/Phase infrastructure for FIRRTL compilers:
The stage package provides Stage/Phase infrastructure for FIRRTL compilers:
- A number of support Phases
- FirrtlOptions, a class representing options common to FIRRTL compilers
- FirrtlOptionsView, a utility that constructs an OptionsView of FirrtlOptions from an AnnotationSeq
- package transforms
Deprecated Type Members
- class AnnotationSeq extends AnyRef
Container of all annotations for a Firrtl compiler
Container of all annotations for a Firrtl compiler
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class AttributeAnnotation(target: Named, description: String) extends SingleTargetAnnotation[Named] with Product with Serializable
Firrtl implementation for verilog attributes
Firrtl implementation for verilog attributes
- target
target component to tag with attribute
- description
Attribute string to add to target
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class CDefMPort(info: Info, name: String, tpe: Type, mem: String, exps: Seq[Expression], direction: MPortDir) extends Statement with HasInfo with UseSerializer with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class CDefMemory(info: Info, name: String, tpe: Type, size: BigInt, seq: Boolean, readUnderWrite: ir.ReadUnderWrite.Value = ReadUnderWrite.Undefined) extends Statement with HasInfo with UseSerializer with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- trait EmittedAnnotation[T <: EmittedComponent] extends NoTargetAnnotation with CustomFileEmission
Traits for Annotations containing emitted components
Traits for Annotations containing emitted components
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- final case class EmittedBtor2Circuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class EmittedBtor2CircuitAnnotation(value: EmittedBtor2Circuit) extends EmittedCircuitAnnotation[EmittedBtor2Circuit] with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed abstract class EmittedCircuit extends EmittedComponent
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed trait EmittedCircuitAnnotation[T <: EmittedCircuit] extends EmittedAnnotation[T]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed abstract class EmittedComponent extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- final case class EmittedFirrtlCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class EmittedFirrtlCircuitAnnotation(value: EmittedFirrtlCircuit) extends EmittedCircuitAnnotation[EmittedFirrtlCircuit] with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- final case class EmittedVerilogCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case class EmittedVerilogCircuitAnnotation(value: EmittedVerilogCircuit) extends EmittedCircuitAnnotation[EmittedVerilogCircuit] with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- class FirrtlUserException extends RuntimeException with NoStackTrace
Exception indicating user error
Exception indicating user error
These exceptions indicate a problem due to bad input and thus do not include a stack trace. This can be extended by custom transform writers.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- abstract class MPortDir extends FirrtlNode
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- sealed trait RenameMap extends AnyRef
Map old names to new names
Map old names to new names
These are mutable datastructures for convenience
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
Deprecated Value Members
- implicit def annoSeqToSeq(as: AnnotationSeq): Seq[Annotation]
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- implicit def seqToAnnoSeq(xs: Seq[Annotation]): AnnotationSeq
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object AnnotationSeq
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case object MInfer extends MPortDir with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case object MRead extends MPortDir with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case object MReadWrite extends MPortDir with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- case object MWrite extends MPortDir with Product with Serializable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object Parser
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object PrimOps extends LazyLogging
Definitions and Utility functions for ir.PrimOps
Definitions and Utility functions for ir.PrimOps
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- object Utils extends LazyLogging
- 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 typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.