chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package aop
  Definition Classes
    chisel3
-  package choice

  This package contains Chisel language definitions for describing configuration options and their accepted values.

  This package contains Chisel language definitions for describing configuration options and their accepted values.

  Definition Classes
    chisel3
-  package connectable
  Definition Classes
    chisel3
-  package experimental

  Package for experimental features, which may have their API changed, be removed, etc.

  Package for experimental features, which may have their API changed, be removed, etc.

  Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

  Definition Classes
    chisel3
-  package interface
  Definition Classes
    chisel3
-  package ltl
  Definition Classes
    chisel3
-  package naming
  Definition Classes
    chisel3
-  package probe
  Definition Classes
    chisel3
-  package properties

  The properties package includes functionality related to non-hardware data.

  The properties package includes functionality related to non-hardware data.

  This entire package is currently very experimental, so expect some rough edges and rapid API evolution.

  Definition Classes
    chisel3
-  package reflect
  Definition Classes
    chisel3
-  package simulator
  Definition Classes
    chisel3
-  package stage
  Definition Classes
    chisel3
-  package phases
- ChiselCircuitAnnotation
- ChiselGeneratorAnnotation
- ChiselOption
- ChiselOptions
- ChiselOptionsView
- ChiselOutputFileAnnotation
- CircuitSerializationAnnotation
- DesignAnnotation
- PrintFullStackTraceAnnotation
- SourceRootAnnotation
- ThrowOnFirstErrorAnnotation
- WarningConfigurationAnnotation
- WarningConfigurationFileAnnotation
- WarningsAsErrorsAnnotation
-  package std
  Definition Classes
    chisel3
-  package testers

  The testers package provides the basic interface for chisel testers.

  The testers package provides the basic interface for chisel testers.

  Definition Classes
    chisel3
-  package util

  The util package provides extensions to core chisel for common hardware components and utility functions

  The util package provides extensions to core chisel for common hardware components and utility functions

  Definition Classes
    chisel3

p

chisel3

# stage

#### 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.  case class ChiselCircuitAnnotation(circuit: Circuit) extends NoTargetAnnotation with ChiselOption with Unserializable with Product with Serializable

   Stores a Chisel Circuit

   Stores a Chisel Circuit

   circuit

     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.  case class CircuitSerializationAnnotation(circuit: Circuit, filename: String, format: Format) extends NoTargetAnnotation with BufferedCustomFileEmission with WriteableCircuitAnnotation with Product with Serializable

   Wraps a `Circuit` for serialization via `CustomFileEmission`

   Wraps a `Circuit` for serialization via `CustomFileEmission`

   circuit

     a Chisel Circuit

   filename

     name of destination file (excludes file extension)

   format

     serialization file format (sets file extension)

7.  case class DesignAnnotation[DUT <: RawModule](design: DUT) 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 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.

9.  case class WarningConfigurationAnnotation(value: String) extends NoTargetAnnotation with Unserializable with ChiselOption with Product with Serializable
10.  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 ChiselGeneratorAnnotation extends HasShellOptions with Serializable
3.  implicit object ChiselOptionsView extends OptionsView[ChiselOptions]
   Annotations
     @nowarn()
4.  object ChiselOutputFileAnnotation extends HasShellOptions with Serializable
5.  object CircuitSerializationAnnotation extends Serializable
6.  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.

7.  object SourceRootAnnotation extends HasShellOptions with Serializable
8.  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.

9.  object WarningConfigurationAnnotation extends HasShellOptions with Serializable
10.  object WarningConfigurationFileAnnotation extends HasShellOptions with Serializable
11.  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