chisel
7.9.0+2-5294dafe-SNAPSHOT
API
Generated with
chisel/chisel3/chisel3.stage

chisel3.stage

package chisel3.stage

Members list

Packages

package chisel3.stage.phases

Type members

Classlikes

class ChiselCircuitAnnotation extends NoTargetAnnotation, ChiselOption, Unserializable, Product, Serializable

Stores a Chisel Circuit

Stores a Chisel Circuit

Value parameters

circuit

a Chisel Circuit

Attributes

Companion
object
Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChiselCircuitAnnotation extends AbstractFunction1[ElaboratedCircuit, ChiselCircuitAnnotation]

Attributes

Companion
class
Source
ChiselAnnotations.scala
Supertypes
class AbstractFunction1[ElaboratedCircuit, ChiselCircuitAnnotation]
class Object
trait Matchable
class Any
Self type
case class ChiselGeneratorAnnotation(gen: () => RawModule) extends NoTargetAnnotation, Unserializable

An firrtl.annotations.Annotation storing a function that returns a Chisel module

An firrtl.annotations.Annotation storing a function that returns a Chisel module

Value parameters

gen

a generator function

Attributes

Companion
object
Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChiselGeneratorAnnotation extends HasShellOptions

Attributes

Companion
class
Source
ChiselAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
sealed trait ChiselOption

Mixin that indicates that this is an firrtl.annotations.Annotation used to generate a ChiselOptions view.

Mixin that indicates that this is an firrtl.annotations.Annotation used to generate a ChiselOptions view.

Attributes

Source
ChiselAnnotations.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class RemapLayer
Show all
Self type
class ChiselOptions

Attributes

Source
ChiselOptions.scala
Supertypes
class Object
trait Matchable
class Any
object ChiselOptionsView extends OptionsView[ChiselOptions]

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
case class ChiselOutputFileAnnotation(file: String) extends NoTargetAnnotation, ChiselOption, Unserializable

Attributes

Companion
object
Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChiselOutputFileAnnotation extends HasShellOptions

Attributes

Companion
class
Source
ChiselAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
object CircuitSerializationAnnotation

Attributes

Companion
class
Source
ChiselAnnotations.scala
Supertypes
class Object
trait Matchable
class Any
Self type
class CircuitSerializationAnnotation extends NoTargetAnnotation, BufferedCustomFileEmission, WriteableCircuitAnnotation, Product, Serializable

Wraps a Circuit for serialization via CustomFileEmission

Wraps a Circuit for serialization via CustomFileEmission

Value parameters

circuit

a Chisel Circuit

filename

name of destination file (excludes file extension)

format

serialization file format (sets file extension)

Attributes

Companion
object
Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait WriteableCircuitAnnotation
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DesignAnnotation[DUT <: RawModule](design: DUT, layers: Seq[Layer] = ...) extends NoTargetAnnotation, Unserializable

Contains the top-level elaborated Chisel design.

Contains the top-level elaborated Chisel design.

By default is created during Chisel elaboration and passed to the FIRRTL compiler.

Type parameters

DUT

Type of the top-level Chisel design

Value parameters

design

top-level Chisel design

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object IncludeInlineTestsForModule extends HasShellOptions

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class IncludeInlineTestsForModuleAnnotation(glob: String) extends NoTargetAnnotation, Unserializable, ChiselOption

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object IncludeInlineTestsWithName extends HasShellOptions

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class IncludeInlineTestsWithNameAnnotation(glob: String) extends NoTargetAnnotation, Unserializable, ChiselOption

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object IncludeUtilMetadata extends NoTargetAnnotation, ChiselOption, HasShellOptions, Unserializable

Include metadata for chisel utils.

Include metadata for chisel utils.

Some built-in Chisel utilities (like chisel3.util.SRAM) can optionally be built with metadata. Adding this option will include the metadata when building relevant blocks.

Use as CLI option --include-util-metadata.

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case object PrintFullStackTraceAnnotation extends NoTargetAnnotation, ChiselOption, HasShellOptions, Unserializable

On an exception, this will cause the full stack trace to be printed as opposed to a pruned stack trace.

On an exception, this will cause the full stack trace to be printed as opposed to a pruned stack trace.

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class RemapLayer(oldLayer: Layer, newLayer: Layer) extends NoTargetAnnotation, ChiselOption, Unserializable

This records a mapping from an old chisel3.layer.Layer to a new chisel3.layer.Layer.

This records a mapping from an old chisel3.layer.Layer to a new chisel3.layer.Layer.

This is intended to be used by a downstream Chisel project that is using an upstream Chisel project which has different layers and the user would like to align the upstream project with the downstream.

Value parameters

newLayer

the new layer that the old layer should be replaced with

oldLayer

the old layer that should be remapped

Attributes

Companion
object
Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RemapLayer extends HasShellOptions

Attributes

Companion
class
Source
ChiselAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
RemapLayer.type
case class SourceRootAnnotation(directory: File) extends NoTargetAnnotation, Unserializable, ChiselOption

A root directory for source files, used for enhanced error reporting

A root directory for source files, used for enhanced error reporting

More than one may be provided. If a source file is found in more than one source root, the first match will be used in error reporting.

Attributes

Companion
object
Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SourceRootAnnotation extends HasShellOptions

Attributes

Companion
class
Source
ChiselAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
case object SuppressSourceInfoAnnotation extends NoTargetAnnotation, ChiselOption, HasShellOptions, Unserializable

Suppress emission of source info in FIRRTL output.

Suppress emission of source info in FIRRTL output.

Use as CLI option --no-source-info.

When this option is enabled, source info (e.g., @[MyFile.scala 42:10]) will not be emitted in the generated FIRRTL output. This can be useful for reducing output size or for generating more stable output.

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case object ThrowOnFirstErrorAnnotation extends NoTargetAnnotation, ChiselOption, HasShellOptions, Unserializable

On recoverable errors, this will cause Chisel to throw an exception instead of continuing.

On recoverable errors, this will cause Chisel to throw an exception instead of continuing.

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case object UseLegacyWidthBehavior extends NoTargetAnnotation, ChiselOption, HasShellOptions, Unserializable

Use legacy Chisel width behavior.

Use legacy Chisel width behavior.

'''This should only be used for checking for unexpected semantic changes when bumping to Chisel 7.0.0.'''

Use as CLI option --use-legacy-width.

There are two width bugs fixed in Chisel 7.0 that could affect the semantics of user code. Enabling this option will restore the old, buggy behavior, described below:

  1. The width of shift-right when shift amount is >= the width of the argument

When this option is enabled, the behavior is as follows:

  • Calling .getWidth on the resulting value will report the width as 0.
  • The width of the resulting value will be treated as 1-bit for generating Verilog.
  1. The width of ChiselEnum values

When this option is enabled, the behavior is as follows:

  • Calling .getWidth on a specific ChiselEnum value will give the width needed to encode the enum. This is the minimum width needed to encode the maximum value encoded by the enum.
  • The resulting FIRRTL will have the minimum width needed to encode the literal value for just that specific enum value.

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case object UseSRAMBlackbox extends NoTargetAnnotation, ChiselOption, HasShellOptions, Unserializable

Use Blackbox implementation for SRAM

Use Blackbox implementation for SRAM

Use as CLI option --use-sram-blackbox.

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class WarningConfigurationAnnotation(value: String) extends NoTargetAnnotation, Unserializable, ChiselOption

Attributes

Companion
object
Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object WarningConfigurationAnnotation extends HasShellOptions

Attributes

Companion
class
Source
ChiselAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
case class WarningConfigurationFileAnnotation(value: File) extends NoTargetAnnotation, Unserializable, ChiselOption

Attributes

Companion
object
Source
ChiselAnnotations.scala
Supertypes
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object WarningConfigurationFileAnnotation extends HasShellOptions

Attributes

Companion
class
Source
ChiselAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
case object WarningsAsErrorsAnnotation extends NoTargetAnnotation, ChiselOption, HasShellOptions, Unserializable

When enabled, warnings will be treated as errors.

When enabled, warnings will be treated as errors.

Attributes

Source
ChiselAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait ChiselOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Value members

Concrete fields

final val pleaseSwitchToCIRCT: "this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md. Please switch to circt.stage.ChiselStage."

Attributes

Source
package.scala
Generated with