Type

chisel3.simulator.LayerControl.Type
sealed trait Type

The type of all layer control variations

Attributes

Source
LayerControl.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Disable
class Enable
object EnableAll

Members list

Value members

Abstract methods

protected def getLayerSubset(allLayers: Seq[Layer]): Seq[Layer]

Return the layers that should be enabled in a circuit. The layers must exist in the circuit.

Return the layers that should be enabled in a circuit. The layers must exist in the circuit.

Value parameters

allLayers

all layers that are defined in a circuit

Attributes

Returns

the layers that should be enabled

Throws
IllegalArgumentException

if the requested layers are not in allLayers

Source
LayerControl.scala

Concrete methods

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.

Value parameters

allLayers

all the layers that are allow

module

a Chisel module

Attributes

Returns

preprocessor defines to control the enabling of these layers

Source
LayerControl.scala

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.

Value parameters

module

an elaborated Chisel module

Attributes

Returns

preprocessor defines to control the enabling of these layers

Source
LayerControl.scala
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. This supplements shouldIncludeFile by allowing for the constituent modules of extract layers to be fully excluded from the build.

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.

Value parameters

allLayers

all the layers that can be enabled

buildDir

the build directory

module

a Chisel module

Attributes

Returns

a partial function to test if a directory should be included

Source
LayerControl.scala
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. This supplements shouldIncludeFile by allowing for the constituent modules of extract layers to be fully excluded from the build.

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.

Value parameters

buildDir

the build directory

module

a Chisel module

Attributes

Returns

a partial function to test if a directory should be included

Source
LayerControl.scala
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. This partial function is not defined if the file is not a layer file.

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.

Value parameters

allLayers

all the layers that can be enabled

module

a Chisel module

Attributes

Returns

a partial function to test if layer files should be included

Source
LayerControl.scala
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. This partial function is not defined if the file is not a layer file.

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.

Value parameters

module

an elaborated Chisel module

Attributes

Returns

a partial function to test if layer files should be included

Source
LayerControl.scala