Add common layers to Chisel (#4326)

Add the common layers that all Chisel projects are expected to use. These layers will, in later commits, be used for in-tree Chisel generators to put hardware in. I.e., it is expected that asserts will not be put under their corresponding layer. Signed-off-by: Schuyler Eldridge <[email protected]>
chipsalliance · Aug 2, 2024 · 074c075 · 074c075
1 parent d80affa
commit 074c075
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/src/main/scala/chisel3/layers/Layers.scala b/src/main/scala/chisel3/layers/Layers.scala
@@ -0,0 +1,16 @@
+package chisel3.layers
+
+import chisel3.layer.{Convention, Layer}
+
+/** The root [[chisel3.layer.Layer]] for all shared verification collateral. */
+object Verification extends Layer(Convention.Bind) {
+
+  /** The [[chisel3.layer.Layer]] where all assertions will be placed. */
+  object Assert extends Layer(Convention.Bind)
+
+  /** The [[chisel3.layer.Layer]] where all assumptions will be placed. */
+  object Assume extends Layer(Convention.Bind)
+
+  /** The [[chisel3.layer.Layer]] where all covers will be placed. */
+  object Cover extends Layer(Convention.Bind)
+}
diff --git a/src/main/scala/chisel3/layers/package.scala b/src/main/scala/chisel3/layers/package.scala
@@ -0,0 +1,4 @@
+package chisel3
+
+/** This package contains common [[layer.Layer]]s used by Chisel generators. */
+package object layers