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
  • package scalatest
    Definition Classes
    simulator
  • object HasCliOptions
    Definition Classes
    scalatest
  • CliOption

case class CliOption[A](name: String, help: String, convert: (String) => A, updateChiselOptions: (A, Array[String]) => Array[String], updateFirtoolOptions: (A, Array[String]) => Array[String], updateCommonSettings: (A, CommonCompilationSettings) => CommonCompilationSettings, updateBackendSettings: (A, svsim.Backend.Settings) => svsim.Backend.Settings) extends Product with Serializable

A ScalaTest command line option of the form -D<name>=<value>.

name

the name of the option

convert

conver the <value> to the internal type A

updateCommonSettings

a function to update the common compilation settings

updateBackendSettings

a function to update the backend-specific compilation settings

Source
HasCliOptions.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CliOption
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. 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

Instance Constructors

  1. new CliOption(name: String, help: String, convert: (String) => A, updateChiselOptions: (A, Array[String]) => Array[String], updateFirtoolOptions: (A, Array[String]) => Array[String], updateCommonSettings: (A, CommonCompilationSettings) => CommonCompilationSettings, updateBackendSettings: (A, svsim.Backend.Settings) => svsim.Backend.Settings)

    name

    the name of the option

    convert

    conver the <value> to the internal type A

    updateCommonSettings

    a function to update the common compilation settings

    updateBackendSettings

    a function to update the backend-specific compilation settings

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 CliOption[A] toany2stringadd[CliOption[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CliOption[A], B)
    Implicit
    This member is added by an implicit conversion from CliOption[A] toArrowAssoc[CliOption[A]] 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. val convert: (String) => A
  9. def ensuring(cond: (CliOption[A]) => Boolean, msg: => Any): CliOption[A]
    Implicit
    This member is added by an implicit conversion from CliOption[A] toEnsuring[CliOption[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (CliOption[A]) => Boolean): CliOption[A]
    Implicit
    This member is added by an implicit conversion from CliOption[A] toEnsuring[CliOption[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): CliOption[A]
    Implicit
    This member is added by an implicit conversion from CliOption[A] toEnsuring[CliOption[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): CliOption[A]
    Implicit
    This member is added by an implicit conversion from CliOption[A] toEnsuring[CliOption[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  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. val help: String
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val name: String
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. val updateBackendSettings: (A, svsim.Backend.Settings) => svsim.Backend.Settings
  25. val updateChiselOptions: (A, Array[String]) => Array[String]
  26. val updateCommonSettings: (A, CommonCompilationSettings) => CommonCompilationSettings
  27. val updateFirtoolOptions: (A, Array[String]) => Array[String]
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. 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 CliOption[A] toStringFormat[CliOption[A]] 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. def →[B](y: B): (CliOption[A], B)
    Implicit
    This member is added by an implicit conversion from CliOption[A] toArrowAssoc[CliOption[A]] 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromCliOption[A] to any2stringadd[CliOption[A]]

Inherited by implicit conversion StringFormat fromCliOption[A] to StringFormat[CliOption[A]]

Inherited by implicit conversion Ensuring fromCliOption[A] to Ensuring[CliOption[A]]

Inherited by implicit conversion ArrowAssoc fromCliOption[A] to ArrowAssoc[CliOption[A]]

Ungrouped