chisel
7.9.0+2-5294dafe-SNAPSHOT
API
Generated with
chisel/circt/circt.stage/circt.stage.phases/Checks

Checks

circt.stage.phases.Checks
class Checks extends Phase

Check properties of an firrtl.AnnotationSeq! to look for errors before running CIRCT.

Attributes

Source
Checks.scala
Graph
Supertypes
trait Phase
trait LazyLogging
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def invalidates(a: Phase): Boolean

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
Checks.scala
override def optionalPrerequisiteOf: Seq[Dependency[Phase]]

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 DependencyManager with multiple targets.

Definition Classes
Source
Checks.scala
override def prerequisites: Seq[Dependency[Phase]]

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
Checks.scala
override def transform(annotations: AnnotationSeq): AnnotationSeq

A mathematical transform on some type

A mathematical transform on some type

Value parameters

a

an input object

Attributes

Returns

an output object of the same type

Definition Classes
Source
Checks.scala

Inherited methods

def getLogger: Logger

Attributes

Inherited from:
LazyLogging
Source
Logger.scala
def optionalPrerequisites: Seq[Dependency[Phase]]

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.

Inherited from:
DependencyAPI
Source
Phase.scala

Inherited fields

protected val logger: Logger

Attributes

Inherited from:
LazyLogging
Source
Logger.scala
lazy val name: String

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
Generated with