firrtl.annotations

Base type of auxiliary information

Attributes

Companion: object
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Annotation.scala
Supertypes: trait Product

trait Equals

class Object

trait Matchable

class Any
Known subtypes: trait NoTargetAnnotation

class ClassLogLevelAnnotation

object LogClassNamesAnnotation

class LogFileAnnotation

class LogLevelAnnotation

class UnrecognizedAnnotation

class UnserializeableAnnotation

class InputAnnotationFileAnnotation

class OutputAnnotationFileAnnotation

class ProgramArgsAnnotation

class TargetDirAnnotation

class ReplSeqMemAnnotation

object AllowUnrecognizedAnnotations

class FirrtlCircuitAnnotation

class InfoModeAnnotation

class OutputFileAnnotation

class BlackBoxTargetDirAnno

trait EmittedAnnotation[T]

trait EmittedCircuitAnnotation[T]

class EmittedBtor2CircuitAnnotation

class EmittedFirrtlCircuitAnnotation

class EmittedVerilogCircuitAnnotation

class CIRCTTargetAnnotation

class EmittedMLIR

class FirtoolBinaryPath

class FirtoolOption

class PreserveAggregate

class ImportDefinitionAnnotation[T]

class ChiselCircuitAnnotation

class ChiselGeneratorAnnotation

class ChiselOutputFileAnnotation

class CircuitSerializationAnnotation

class DesignAnnotation[DUT]

class IncludeInlineTestsForModuleAnnotation

class IncludeInlineTestsWithNameAnnotation

object IncludeUtilMetadata

object PrintFullStackTraceAnnotation

class RemapLayer

class SourceRootAnnotation

object SuppressSourceInfoAnnotation

object ThrowOnFirstErrorAnnotation

object UseLegacyWidthBehavior

object UseSRAMBlackbox

class WarningConfigurationAnnotation

class WarningConfigurationFileAnnotation

object WarningsAsErrorsAnnotation

trait SingleTargetAnnotation[T]

class LoadMemoryAnnotation

trait MemoryInitAnnotation

class MemoryFileInlineAnnotation

class SinkAnnotation

class SourceAnnotation

class InlineAnnotation

class BlackBoxInlineAnno

class BlackBoxPathAnno

class DedupGroupAnnotation

class DontTouchAnnotation

class FlattenAnnotation

class NoDedupAnnotation

class AttributeAnnotation

class ConventionAnnotation

class OutputDirAnnotation

class DecodeTableAnnotation

class ForceNameAnnotation

trait BlackBoxHelperAnno

class MustDeduplicateAnnotation
Show all

Attributes

Companion: trait
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Annotation.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Annotation.type

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: AnnotationUtils.scala
Supertypes: trait Product

trait Equals

class FirrtlUserException

trait NoStackTrace

class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Annotation.scala
Supertypes: trait Product

trait Equals

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: AnnotationUtils.scala
Supertypes: trait Product

trait Equals

class FirrtlUserException

trait NoStackTrace

class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: AnnotationUtils.scala
Supertypes: class Object

trait Matchable

class Any
Self type: AnnotationUtils.type

Concretely points to a FIRRTL target, no generic selectors IsLegal

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait Target

trait Named

class Object

trait Matchable

class Any
Known subtypes: trait IsMember

trait IsComponent

class InstanceTarget

class ReferenceTarget

trait IsModule

class ModuleTarget
Show all

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait Named

class Object

trait Matchable

class Any
Show all

Represents incomplete or non-standard Targets

Value parameters

moduleOpt: Optional module name
tokens: TargetTokens to represent the target in a module

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait Target

trait Named

class Object

trait Matchable

class Any
Show all

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: JsonProtocol.scala
Supertypes: class Object

trait Matchable

class Any

Similar to HasSerializationHints but for types whose serialization classes need to be overridden

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: JsonProtocol.scala
Supertypes: class Object

trait Matchable

class Any

Points to an instance declaration of a module (termed an ofModule)

Value parameters

instance: Name of the instance
module: Root module (e.g. the base module of this target)
ofModule: Name of the instance's module
path: Path through instance/ofModules

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait IsComponent

trait IsModule

trait IsMember

trait CompleteTarget

trait Target

trait Named

class Object

trait Matchable

class Any
Show all

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: AnnotationUtils.scala
Supertypes: trait Product

trait Equals

class FirrtlUserException

trait NoStackTrace

class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: AnnotationUtils.scala
Supertypes: trait Product

trait Equals

class FirrtlUserException

trait NoStackTrace

class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

A component of a FIRRTL Module (e.g. cannot point to a ModuleTarget)

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait IsMember

trait CompleteTarget

trait Target

trait Named

class Object

trait Matchable

class Any
Show all
Known subtypes: class InstanceTarget

class ReferenceTarget

A member of a FIRRTL Circuit Concrete Subclasses are: ModuleTarget, InstanceTarget, and ReferenceTarget

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait CompleteTarget

trait Target

trait Named

class Object

trait Matchable

class Any
Show all
Known subtypes: trait IsComponent

class InstanceTarget

class ReferenceTarget

trait IsModule

class ModuleTarget

References a module-like target (e.g. a ModuleTarget or an InstanceTarget)

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait IsMember

trait CompleteTarget

trait Target

trait Named

class Object

trait Matchable

class Any
Show all
Known subtypes: class InstanceTarget

class ModuleTarget

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: JsonProtocol.scala
Supertypes: trait LazyLogging

class Object

trait Matchable

class Any
Self type: JsonProtocol.type

Firrtl implementation for load memory

Value parameters

fileName: name of input file
hexOrBinary: use $readmemh or $readmemb
target: memory to load

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: LoadMemoryAnnotation.scala
Supertypes: trait Serializable

trait SingleTargetAnnotation[Named]

trait Annotation

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Initialize the target memory with inline readmem[hb] statement.

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: MemoryInitAnnotation.scala
Supertypes: trait Serializable

trait MemoryInitAnnotation

trait SingleTargetAnnotation[ReferenceTarget]

trait Annotation

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

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.

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: MemoryInitAnnotation.scala
Supertypes: trait SingleTargetAnnotation[ReferenceTarget]

trait Annotation

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class MemoryFileInlineAnnotation

Representation of the two types of readmem statements available in Verilog.

Attributes

Companion: object
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: LoadMemoryAnnotation.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Binary

object Hex

Attributes

Companion: class
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: LoadMemoryAnnotation.scala
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: MemoryLoadFileType.type

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait Named

class Object

trait Matchable

class Any
Show all

Target pointing to a FIRRTL firrtl.ir.DefModule

Value parameters

module: Name of the module

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait IsModule

trait IsMember

trait CompleteTarget

trait Target

trait Named

class Object

trait Matchable

class Any
Show all

Named classes associate an annotation with a component in a Firrtl circuit

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ComponentName

class ModuleName

trait Target

trait CompleteTarget

trait IsMember

trait IsComponent

class InstanceTarget

class ReferenceTarget

trait IsModule

class ModuleTarget

class GenericTarget
Show all

If an Annotation does not target any Named thing in the circuit, then all updates just return the Annotation itself

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Annotation.scala
Supertypes: trait Annotation

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class ClassLogLevelAnnotation

object LogClassNamesAnnotation

class LogFileAnnotation

class LogLevelAnnotation

class UnrecognizedAnnotation

class UnserializeableAnnotation

class InputAnnotationFileAnnotation

class OutputAnnotationFileAnnotation

class ProgramArgsAnnotation

class TargetDirAnnotation

class ReplSeqMemAnnotation

object AllowUnrecognizedAnnotations

class FirrtlCircuitAnnotation

class InfoModeAnnotation

class OutputFileAnnotation

class BlackBoxTargetDirAnno

trait EmittedAnnotation[T]

trait EmittedCircuitAnnotation[T]

class EmittedBtor2CircuitAnnotation

class EmittedFirrtlCircuitAnnotation

class EmittedVerilogCircuitAnnotation

class CIRCTTargetAnnotation

class EmittedMLIR

class FirtoolBinaryPath

class FirtoolOption

class PreserveAggregate

class ImportDefinitionAnnotation[T]

class ChiselCircuitAnnotation

class ChiselGeneratorAnnotation

class ChiselOutputFileAnnotation

class CircuitSerializationAnnotation

class DesignAnnotation[DUT]

class IncludeInlineTestsForModuleAnnotation

class IncludeInlineTestsWithNameAnnotation

object IncludeUtilMetadata

object PrintFullStackTraceAnnotation

class RemapLayer

class SourceRootAnnotation

object SuppressSourceInfoAnnotation

object ThrowOnFirstErrorAnnotation

object UseLegacyWidthBehavior

object UseSRAMBlackbox

class WarningConfigurationAnnotation

class WarningConfigurationFileAnnotation

object WarningsAsErrorsAnnotation
Show all

Mix this in to override what class name is used for serialization

Note that this breaks automatic deserialization.

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: JsonProtocol.scala
Supertypes: class Object

trait Matchable

class Any

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

Value parameters

component: Subcomponent of this reference, e.g. field or index
module: Name of the root module of this reference
path: Path through instance/ofModules
ref: Name of component

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait IsComponent

trait IsMember

trait CompleteTarget

trait Target

trait Named

class Object

trait Matchable

class Any
Show all

An Annotation that targets a single Named thing

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Annotation.scala
Supertypes: trait Annotation

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class LoadMemoryAnnotation

trait MemoryInitAnnotation

class MemoryFileInlineAnnotation

class SinkAnnotation

class SourceAnnotation

class InlineAnnotation

class BlackBoxInlineAnno

class BlackBoxPathAnno

class DedupGroupAnnotation

class DontTouchAnnotation

class FlattenAnnotation

class NoDedupAnnotation

class AttributeAnnotation

class ConventionAnnotation

class OutputDirAnnotation

class DecodeTableAnnotation

class ForceNameAnnotation
Show all

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)

Attributes

Companion: object
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: trait Named

class Object

trait Matchable

class Any
Known subtypes: trait CompleteTarget

trait IsMember

trait IsComponent

class InstanceTarget

class ReferenceTarget

trait IsModule

class ModuleTarget

class GenericTarget
Show all

Attributes

Companion: trait
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Target.type

Building block to represent a Target of a FIRRTL component

Attributes

Companion: object
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: TargetToken.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class Field

class Index

class Instance

class OfModule

class Ref

Object containing all TargetToken subclasses

Attributes

Companion: trait
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: TargetToken.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: TargetToken.type

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: AnnotationUtils.scala
Supertypes: trait Product

trait Equals

class FirrtlUserException

trait NoStackTrace

class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Annotation.scala
Supertypes: trait Serializable

trait NoTargetAnnotation

trait Annotation

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: AnnotationUtils.scala
Supertypes: class FirrtlUserException

trait NoStackTrace

class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: AnnotationUtils.scala
Supertypes: class Object

trait Matchable

class Any
Self type: UnserializableAnnotationException.type

Wrapper Annotation for Annotations that cannot be serialized

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: JsonProtocol.scala
Supertypes: trait Serializable

trait NoTargetAnnotation

trait Annotation

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

firrtl.annotations

Members list

Type members

Deprecated classlikes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes