final case class Enable(layers: Layer*) extends Type with Product with Serializable
Enable only the specified layers
Nested layers should use a . as a delimiter.
- layers
a variadic list of layer names
- Source
- LayerControl.scala
- Alphabetic
- By Inheritance
- Enable
- Serializable
- Product
- Equals
- Type
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Enable, B)
- 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()
- def ensuring(cond: (Enable) => Boolean, msg: => Any): Enable
- def ensuring(cond: (Enable) => Boolean): Enable
- def ensuring(cond: Boolean, msg: => Any): Enable
- def ensuring(cond: Boolean): Enable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getLayerSubset(allLayers: Seq[Layer]): Seq[Layer]
Return the layers that should be enabled in a circuit.
Return the layers that should be enabled in a circuit. The layers must exist in the circuit.
- allLayers
all layers that are defined in a circuit
- returns
the layers that should be enabled
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val layers: Layer*
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def preprocessorDefines(module: ElaboratedModule[_ <: RawModule]): Seq[VerilogPreprocessorDefine]
Return the preprocessor defines that should be set to enable the layers of this
LayerControl.Type.Return the preprocessor defines that should be set to enable the layers of this
LayerControl.Type.This requires passing an elaborated module in order to know what layers exist in the design.
- module
an elaborated Chisel module
- returns
preprocessor defines to control the enabling of these layers
- Definition Classes
- Type
- final def preprocessorDefines(module: RawModule, allLayers: Seq[Layer]): Seq[VerilogPreprocessorDefine]
Return the preprocessor defines that should be set to enable the layers of this
LayerControl.Type.Return the preprocessor defines that should be set to enable the layers of this
LayerControl.Type.- module
a Chisel module
- allLayers
all the layers that are allow
- returns
preprocessor defines to control the enabling of these layers
- Definition Classes
- Type
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def shouldIncludeDirectory(module: ElaboratedModule[_ <: RawModule], buildDir: String): PartialFunction[File, Boolean]
Return a partial function that will return true if a directory should be visited when determining files to include in the build based on if a layer is enabled.
Return a partial function that will return true if a directory should be visited when determining files to include in the build based on if a layer is enabled. This supplements shouldIncludeFile by allowing for the constituent modules of extract layers to be fully excluded from the build.
- module
a Chisel module
- buildDir
the build directory
- returns
a partial function to test if a directory should be included
- Definition Classes
- Type
- final def shouldIncludeDirectory(module: RawModule, allLayers: Seq[Layer], buildDir: String): PartialFunction[File, Boolean]
Return a partial function that will return true if a directory should be visited when determining files to include in the build based on if a layer is enabled.
Return a partial function that will return true if a directory should be visited when determining files to include in the build based on if a layer is enabled. This supplements shouldIncludeFile by allowing for the constituent modules of extract layers to be fully excluded from the build.
- module
a Chisel module
- allLayers
all the layers that can be enabled
- buildDir
the build directory
- returns
a partial function to test if a directory should be included
- Definition Classes
- Type
- final def shouldIncludeFile(module: ElaboratedModule[_ <: RawModule]): PartialFunction[File, Boolean]
Return a partial function that will return true if a file should be included in the build to enable a layer.
Return a partial function that will return true if a file should be included in the build to enable a layer. This partial function is not defined if the file is not a layer file.
- module
an elaborated Chisel module
- returns
a partial function to test if layer files should be included
- Definition Classes
- Type
- final def shouldIncludeFile(module: RawModule, allLayers: Seq[Layer]): PartialFunction[File, Boolean]
Return a partial function that will return true if a file should be included in the build to enable a layer.
Return a partial function that will return true if a file should be included in the build to enable a layer. This partial function is not defined if the file is not a layer file.
- module
a Chisel module
- allLayers
all the layers that can be enabled
- returns
a partial function to test if layer files should be included
- Definition Classes
- Type
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Enable toStringFormat[Enable] 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,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Enable, B)
- Implicit
- This member is added by an implicit conversion from Enable toArrowAssoc[Enable] 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,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.