trait CompileOptions extends AnyRef
- Alphabetic
- By Inheritance
- CompileOptions
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract val checkSynthesizable: Boolean
Check that referenced Data have actually been declared.
- abstract val connectFieldsMustMatch: Boolean
Should Record connections require a strict match of fields.
Should Record 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.
- abstract val declaredTypeMustBeUnbound: Boolean
When creating an object that takes a type argument, the argument must be unbound (a pure type).
- abstract val dontAssumeDirectionality: Boolean
If connection directionality is not explicit, do not use heuristics to attempt to determine it.
- abstract val dontTryConnectionsSwapped: Boolean
If a connection operator fails, don't try the connection with the operands (source and sink) reversed.
- abstract val explicitInvalidate: Boolean
Require explicit assignment of DontCare to generate "x is invalid"
- abstract val inferModuleReset: Boolean
Should the reset type of Module be a Bool or a Reset
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from CompileOptions toany2stringadd[CompileOptions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (CompileOptions, B)
- Implicit
- This member is added by an implicit conversion from CompileOptions toArrowAssoc[CompileOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def emitStrictConnects: Boolean
Should connects emit as firrtl <= instead of <-
- def ensuring(cond: (CompileOptions) => Boolean, msg: => Any): CompileOptions
- Implicit
- This member is added by an implicit conversion from CompileOptions toEnsuring[CompileOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (CompileOptions) => Boolean): CompileOptions
- Implicit
- This member is added by an implicit conversion from CompileOptions toEnsuring[CompileOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): CompileOptions
- Implicit
- This member is added by an implicit conversion from CompileOptions toEnsuring[CompileOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): CompileOptions
- Implicit
- This member is added by an implicit conversion from CompileOptions toEnsuring[CompileOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def migrateBulkConnections: Boolean
If marked true, then any <> operation using legacy connection semantics will error and suggest using Connectable ops
- def migrateInferModuleReset: Boolean
If marked true, then any Module which consumes
inferModuleReset=false
must also mix in RequireSyncReset - def migrateMonoConnections: Boolean
If marked true, then any := operation on mixed alignment bundles will error and suggest using Connectable ops
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CompileOptions toStringFormat[CompileOptions] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (CompileOptions, B)
- Implicit
- This member is added by an implicit conversion from CompileOptions toArrowAssoc[CompileOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt
,SInt
,Bool
,FixedPoint
,Clock
, andReg
, the abstract typesBits
,Aggregate
, andData
, and the aggregate typesBundle
andVec
.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
util
package.The
testers
package defines the basic interface for chisel testers.