diff options
Diffstat (limited to 'src/main/scala/firrtl/options/Phase.scala')
| -rw-r--r-- | src/main/scala/firrtl/options/Phase.scala | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/main/scala/firrtl/options/Phase.scala b/src/main/scala/firrtl/options/Phase.scala new file mode 100644 index 00000000..22715bc2 --- /dev/null +++ b/src/main/scala/firrtl/options/Phase.scala @@ -0,0 +1,20 @@ +// See LICENSE for license details. + +package firrtl.options + +import firrtl.AnnotationSeq + +/** A transformation of an [[AnnotationSeq]] + * + * A [[Phase]] forms one block in the Chisel/FIRRTL Hardware Compiler Framework (HCF). Note that a [[Phase]] may + * consist of multiple phases internally. + */ +abstract class Phase { + + /** A transformation of an [[AnnotationSeq]] + * @param annotations some annotations + * @return transformed annotations + */ + def transform(annotations: AnnotationSeq): AnnotationSeq + +} |
