Entry point for running Chisel with the CIRCT compiler.
Attributes
- Note
-
The companion object, ChiselStage$, has a cleaner API for compiling and returning a string.
- Companion
- object
- Source
- ChiselStage.scala
- Graph
-
- Supertypes
-
class Stagetrait Phasetrait DependencyAPI[Phase]trait TransformLike[AnnotationSeq]trait LazyLoggingclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
A function that, given another transform (parameter a) will return true if this transform invalidates/undos the effects of the other transform (parameter a).
A function that, given another transform (parameter a) will return true if this transform invalidates/undos the effects of the other transform (parameter a).
Value parameters
- a
-
transform
Attributes
- Definition Classes
- Source
- ChiselStage.scala
A sequence of transforms to add this transform as an optionalPrerequisite. The use of optionalPrerequisiteOf enables the transform declaring them to always run before some other transforms. However, declaring optionalPrerequisiteOf will not result in the sequence of transforms executing.
A sequence of transforms to add this transform as an optionalPrerequisite. The use of optionalPrerequisiteOf enables the transform declaring them to always run before some other transforms. However, declaring optionalPrerequisiteOf will not result in the sequence of transforms executing.
This is useful for providing an ordering constraint to guarantee that other transforms (e.g., emitters) will not be scheduled before you.
Attributes
- Note
-
This method will not result in the listed transforms running. If you want to add multiple transforms at once, you should use a
DependencyManagerwith multiple targets. - Definition Classes
- Source
- ChiselStage.scala
All transforms that, if a prerequisite of another transform, will run before this transform.
All transforms that, if a prerequisite of another transform, will run before this transform.
Attributes
- Note
-
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
- Definition Classes
- Source
- ChiselStage.scala
All transform that must run before this transform
All transform that must run before this transform
Attributes
- Note
-
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
- Definition Classes
- Source
- ChiselStage.scala
Run this stage on some input annotations
Run this stage on some input annotations
Value parameters
- annotations
-
input annotations
Attributes
- Returns
-
output annotations
- Definition Classes
- Source
- ChiselStage.scala
Inherited methods
Run this stage on on a mix of arguments and annotations
Run this stage on on a mix of arguments and annotations
Value parameters
- args
-
command line arguments
- initialAnnotations
-
annotation
Attributes
- Returns
-
output annotations
- Throws
-
firrtl.options.OptionsException
if command line or annotation validation fails
- Inherited from:
- Stage
- Source
- Stage.scala
Attributes
- Inherited from:
- LazyLogging
- Source
- Logger.scala
Execute this stage on some input annotations. Annotations will be read from any input annotation files.
Execute this stage on some input annotations. Annotations will be read from any input annotation files.
Value parameters
- annotations
-
input annotations
Attributes
- Returns
-
output annotations
- Throws
-
firrtl.options.OptionsException
if command line or annotation validation fails
- Inherited from:
- Stage
- Source
- Stage.scala
Deprecated and Inherited methods
Run this stage on on a mix of arguments and annotations
Run this stage on on a mix of arguments and annotations
Value parameters
- args
-
command line arguments
- initialAnnotations
-
annotation
Attributes
- Returns
-
output annotations
- Throws
-
firrtl.options.OptionsException
if command line or annotation validation fails
- Deprecated
-
[Since version Chisel 7.1.0]Use the form that taks Seq[Annotation] - Inherited from:
- Stage
- Source
- Stage.scala
Execute this stage on some input annotations. Annotations will be read from any input annotation files.
Execute this stage on some input annotations. Annotations will be read from any input annotation files.
Value parameters
- annotations
-
input annotations
Attributes
- Returns
-
output annotations
- Throws
-
firrtl.options.OptionsException
if command line or annotation validation fails
- Deprecated
-
[Since version Chisel 7.1.0]Use the form that taks Seq[Annotation] - Inherited from:
- Stage
- Source
- Stage.scala
Concrete fields
A utility that helps convert command line options to annotations
A utility that helps convert command line options to annotations
Attributes
- Source
- ChiselStage.scala
Inherited fields
Attributes
- Inherited from:
- LazyLogging
- Source
- Logger.scala
The name of this Phase. This will be used to generate debug/error messages or when deleting annotations. This will default to the simpleName of the class.
The name of this Phase. This will be used to generate debug/error messages or when deleting annotations. This will default to the simpleName of the class.
Attributes
- Returns
-
this phase's name
- Note
-
Override this with your own implementation for different naming behavior.
- Inherited from:
- Phase
- Source
- Phase.scala