summaryrefslogtreecommitdiff
path: root/chiselFrontend/src/main/scala/chisel3/CompileOptions.scala
diff options
context:
space:
mode:
Diffstat (limited to 'chiselFrontend/src/main/scala/chisel3/CompileOptions.scala')
-rw-r--r--chiselFrontend/src/main/scala/chisel3/CompileOptions.scala53
1 files changed, 53 insertions, 0 deletions
diff --git a/chiselFrontend/src/main/scala/chisel3/CompileOptions.scala b/chiselFrontend/src/main/scala/chisel3/CompileOptions.scala
new file mode 100644
index 00000000..2e5c64aa
--- /dev/null
+++ b/chiselFrontend/src/main/scala/chisel3/CompileOptions.scala
@@ -0,0 +1,53 @@
+// See LICENSE for license details.
+
+package chisel3
+
+import scala.language.experimental.macros
+
+trait CompileOptions {
+ // Should Bundle connections require a strict match of fields.
+ // If true and the same fields aren't present in both source and sink, a MissingFieldException,
+ // MissingLeftFieldException, or MissingRightFieldException will be thrown.
+ val connectFieldsMustMatch: Boolean
+ // When creating an object that takes a type argument, the argument must be unbound (a pure type).
+ val declaredTypeMustBeUnbound: Boolean
+ // Module IOs should be wrapped in an IO() to define their bindings before the reset of the module is defined.
+ val requireIOWrap: Boolean
+ // If a connection operator fails, don't try the connection with the operands (source and sink) reversed.
+ val dontTryConnectionsSwapped: Boolean
+ // If connection directionality is not explicit, do not use heuristics to attempt to determine it.
+ val dontAssumeDirectionality: Boolean
+}
+
+trait ImplicitCompileOptions extends CompileOptions
+
+object ImplicitCompileOptions {
+ // Provides a low priority Strict default. Can be overridden by importing the NotStrict option.
+ implicit def materialize: ImplicitCompileOptions = chisel3.ExplicitCompileOptions.Strict
+}
+
+// Define a more-specific trait which should be perferred if both are available.
+trait ExplicitImplicitCompileOptions extends ImplicitCompileOptions
+
+object ExplicitCompileOptions {
+ // Collection of "not strict" connection compile options.
+ // These provide compatibility with existing code.
+ // import chisel3.ExplicitCompileOptions.NotStrict
+ implicit object NotStrict extends ExplicitImplicitCompileOptions {
+ val connectFieldsMustMatch = false
+ val declaredTypeMustBeUnbound = false
+ val requireIOWrap = false
+ val dontTryConnectionsSwapped = false
+ val dontAssumeDirectionality = false
+ }
+
+ // Collection of "strict" connection compile options, preferred for new code.
+ // import chisel3.ExplicitCompileOptions.Strict
+ implicit object Strict extends ExplicitImplicitCompileOptions {
+ val connectFieldsMustMatch = true
+ val declaredTypeMustBeUnbound = true
+ val requireIOWrap = true
+ val dontTryConnectionsSwapped = true
+ val dontAssumeDirectionality = true
+ }
+}