Packages

package stage

Source
package.scala
Linear Supertypes
AnyRef, Any
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. stage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package phases

Type Members

  1. class ChiselCircuitAnnotation extends NoTargetAnnotation with ChiselOption with Unserializable with Product with Serializable

    Stores a Chisel Circuit

  2. case class ChiselGeneratorAnnotation(gen: () => RawModule) extends NoTargetAnnotation with Unserializable with Product with Serializable

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

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

    gen

    a generator function

  3. sealed trait ChiselOption extends AnyRef

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

  4. class ChiselOptions extends AnyRef
  5. case class ChiselOutputFileAnnotation(file: String) extends NoTargetAnnotation with ChiselOption with Unserializable with Product with Serializable
  6. class CircuitSerializationAnnotation extends NoTargetAnnotation with BufferedCustomFileEmission with WriteableCircuitAnnotation with Product with Serializable

    Wraps a Circuit for serialization via CustomFileEmission

  7. case class DesignAnnotation[DUT <: RawModule](design: DUT, layers: Seq[Layer] = Seq.empty) extends NoTargetAnnotation with Unserializable with Product with Serializable

    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.

    DUT

    Type of the top-level Chisel design

    design

    top-level Chisel design

  8. case class IncludeInlineTestsForModuleAnnotation(glob: String) extends NoTargetAnnotation with Unserializable with ChiselOption with Product with Serializable
  9. case class IncludeInlineTestsWithNameAnnotation(glob: String) extends NoTargetAnnotation with Unserializable with ChiselOption with Product with Serializable
  10. case class RemapLayer(oldLayer: Layer, newLayer: Layer) extends NoTargetAnnotation with ChiselOption with Unserializable with Product with Serializable

    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.

    oldLayer

    the old layer that should be remapped

    newLayer

    the new layer that the old layer should be replaced with

  11. case class SourceRootAnnotation(directory: File) extends NoTargetAnnotation with Unserializable with ChiselOption with Product with Serializable

    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.

  12. case class WarningConfigurationAnnotation(value: String) extends NoTargetAnnotation with Unserializable with ChiselOption with Product with Serializable
  13. case class WarningConfigurationFileAnnotation(value: File) extends NoTargetAnnotation with Unserializable with ChiselOption with Product with Serializable

Value Members

  1. final val pleaseSwitchToCIRCT: String("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.")
  2. object ChiselCircuitAnnotation extends AbstractFunction1[ElaboratedCircuit, ChiselCircuitAnnotation] with Serializable
  3. object ChiselGeneratorAnnotation extends HasShellOptions with Serializable
  4. implicit object ChiselOptionsView extends OptionsView[ChiselOptions]
    Annotations
    @nowarn()
  5. object ChiselOutputFileAnnotation extends HasShellOptions with Serializable
  6. object CircuitSerializationAnnotation extends Serializable
  7. case object IncludeInlineTestsForModule extends HasShellOptions with Product with Serializable
  8. case object IncludeInlineTestsWithName extends HasShellOptions with Product with Serializable
  9. case object IncludeUtilMetadata extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable

    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.

  10. case object PrintFullStackTraceAnnotation extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable

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

  11. object RemapLayer extends HasShellOptions with Serializable
  12. object SourceRootAnnotation extends HasShellOptions with Serializable
  13. case object ThrowOnFirstErrorAnnotation extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable

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

  14. case object UseLegacyWidthBehavior extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable

    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.

    2. 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.
  15. case object UseSRAMBlackbox extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable

    Use Blackbox implementation for SRAM

    Use Blackbox implementation for SRAM

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

  16. object WarningConfigurationAnnotation extends HasShellOptions with Serializable
  17. object WarningConfigurationFileAnnotation extends HasShellOptions with Serializable
  18. case object WarningsAsErrorsAnnotation extends NoTargetAnnotation with ChiselOption with HasShellOptions with Unserializable with Product with Serializable

    When enabled, warnings will be treated as errors.

Inherited from AnyRef

Inherited from Any

Ungrouped