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 Cli

    ChiselSim command line interface traits that can be added to Scalatest tests

    ChiselSim command line interface traits that can be added to Scalatest tests

    Definition Classes
    scalatest
  • ChiselOpts
  • EmitFsdb
  • EmitVcd
  • EmitVpd
  • FirtoolOpts
  • Scale
  • Simulator

trait Simulator extends AnyRef

Adds -Dsimulator to choose the simulator at runtime.

This trait adds an option for controlling the simulator at runtime.

If a user wants to add more simulators or simulators with different options, they should override the cliSimulatorMap with their chosen simulators.

If a user wants to change the default simulator, they should override defaultCliSimulator. Making this a None will require the user to always specify a simulator, i.e., there is no default.

Self Type
Simulator with HasCliOptions
Source
Cli.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Simulator
  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

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 Simulator toany2stringadd[Simulator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Simulator, B)
    Implicit
    This member is added by an implicit conversion from Simulator toArrowAssoc[Simulator] 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. implicit def cliSimulator: HasSimulator
  8. def cliSimulatorMap: Map[String, HasSimulator]

    A mapping of simulator names to simulators.

    A mapping of simulator names to simulators.

    Attributes
    protected
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def defaultCliSimulator: Option[HasSimulator]

    An optional default simulator to use if the user does _not_ provide a simulator.

    An optional default simulator to use if the user does _not_ provide a simulator.

    If Some then the provided default will be used. If None, then a simulator must be provided.

    Attributes
    protected
  11. def ensuring(cond: (Simulator) => Boolean, msg: => Any): Simulator
    Implicit
    This member is added by an implicit conversion from Simulator toEnsuring[Simulator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Simulator) => Boolean): Simulator
    Implicit
    This member is added by an implicit conversion from Simulator toEnsuring[Simulator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Simulator
    Implicit
    This member is added by an implicit conversion from Simulator toEnsuring[Simulator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Simulator
    Implicit
    This member is added by an implicit conversion from Simulator toEnsuring[Simulator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. 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 Simulator toStringFormat[Simulator] 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): (Simulator, B)
    Implicit
    This member is added by an implicit conversion from Simulator toArrowAssoc[Simulator] 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 fromSimulator to any2stringadd[Simulator]

Inherited by implicit conversion StringFormat fromSimulator to StringFormat[Simulator]

Inherited by implicit conversion Ensuring fromSimulator to Ensuring[Simulator]

Inherited by implicit conversion ArrowAssoc fromSimulator to ArrowAssoc[Simulator]

Ungrouped