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 InstanceChoiceControl

    Utilities for controlling instance choice selections

    Utilities for controlling instance choice selections

    Definition Classes
    simulator
  • SpecializationTime
  • Type

sealed trait Type extends AnyRef

The type of all instance choice control variations

Source
InstanceChoiceControl.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Type
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def getVerilogElaborationTimeChoices: Seq[(String, String)]

    Return the (option, value) pairs for VerilogElaborationTime choices

    Return the (option, value) pairs for VerilogElaborationTime choices

    Attributes
    protected
  2. abstract def toFirtoolOptions: Seq[String]

    Convert instance choices to firtool command-line options

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Type toany2stringadd[Type] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Type, B)
    Implicit
    This member is added by an implicit conversion from Type toArrowAssoc[Type] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (Type) => Boolean, msg: => Any): Type
    Implicit
    This member is added by an implicit conversion from Type toEnsuring[Type] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Type) => Boolean): Type
    Implicit
    This member is added by an implicit conversion from Type toEnsuring[Type] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Type
    Implicit
    This member is added by an implicit conversion from Type toEnsuring[Type] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Type
    Implicit
    This member is added by an implicit conversion from Type toEnsuring[Type] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def preprocessorDefines(module: ElaboratedModule[_ <: RawModule]): Seq[VerilogPreprocessorDefine]

    Return the preprocessor defines that should be set to enable instance choices.

    Return the preprocessor defines that should be set to enable instance choices.

    Instance choices use a macro-based ABI where each option case is represented by a macro with the format targets$

    module

    an elaborated Chisel module

    returns

    preprocessor defines to control instance choice selection

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  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()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Type toStringFormat[Type] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. 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 an instance choice.

    Return a partial function that will return true if a file should be included in the build to enable an instance choice.

    module

    an elaborated Chisel module

    returns

    an empty partial function (no files are generated for instance choices)

    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 7.11.0) Instance choices no longer generate files; use preprocessorDefines instead

  3. def →[B](y: B): (Type, B)
    Implicit
    This member is added by an implicit conversion from Type toArrowAssoc[Type] 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromType to any2stringadd[Type]

Inherited by implicit conversion StringFormat fromType to StringFormat[Type]

Inherited by implicit conversion Ensuring fromType to Ensuring[Type]

Inherited by implicit conversion ArrowAssoc fromType to ArrowAssoc[Type]

Ungrouped