Checks

firrtl.stage.phases.Checks
class Checks extends Phase

Phase that strictly validates an AnnotationSeq. The checks applied are intended to be extremeley strict. Nothing is inferred or assumed to take a default value (for default value resolution see AddDefaults).

The intent of this approach is that after running this Phase, a user can be absolutely certain that other Phases or views will succeed.

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
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

Determine if annotations are sane

Determine if annotations are sane

Value parameters

annos

a sequence of Annotation

Attributes

Returns

true if all checks pass

Throws
firrtl.options.OptionsException

if any checks fail

Source
Checks.scala

Inherited methods

Attributes

Inherited from:
LazyLogging
Source
Logger.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.

Inherited from:
DependencyAPI
Source
Phase.scala

Concrete fields

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.

Source
Checks.scala
override val 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.

Source
Checks.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