Packages

  • package root

    This is the documentation for Chisel.

    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, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    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.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package simulator
    Definition Classes
    chisel3
  • object LayerControl

    Utilities for enabling and disabling Chisel layers

    Utilities for enabling and disabling Chisel layers

    Definition Classes
    simulator
  • Enable
  • EnableAll
  • Type

case object EnableAll extends Type with Product with Serializable

Enable all layers

Source
LayerControl.scala
Linear Supertypes
Serializable, Product, Equals, Type, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnableAll
  2. Serializable
  3. Product
  4. Equals
  5. Type
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def getLayerSubset(layers: 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.

    returns

    the layers that should be enabled

    Attributes
    protected
    Definition Classes
    EnableAllType
    Exceptions thrown

    IllegalArgumentException if the requested layers are not in allLayers

  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. 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
  16. 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
  17. def productElementName(n: Int): String
    Definition Classes
    Product
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. 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
  20. 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
  21. 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
  22. 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
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Type

Inherited from AnyRef

Inherited from Any

Ungrouped