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, FixedPoint, 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
  • object ExplicitCompileOptions
    Definition Classes
    chisel3
  • CompileOptionsClass

case class CompileOptionsClass(connectFieldsMustMatch: Boolean, declaredTypeMustBeUnbound: Boolean, dontTryConnectionsSwapped: Boolean, dontAssumeDirectionality: Boolean, checkSynthesizable: Boolean, explicitInvalidate: Boolean, inferModuleReset: Boolean) extends CompileOptions with Product with Serializable

Source
CompileOptions.scala
Linear Supertypes
Serializable, Product, Equals, CompileOptions, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CompileOptionsClass
  2. Serializable
  3. Product
  4. Equals
  5. CompileOptions
  6. AnyRef
  7. 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 CompileOptionsClass(connectFieldsMustMatch: Boolean, declaredTypeMustBeUnbound: Boolean, dontTryConnectionsSwapped: Boolean, dontAssumeDirectionality: Boolean, checkSynthesizable: Boolean, explicitInvalidate: Boolean, inferModuleReset: Boolean)

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 CompileOptionsClass toany2stringadd[CompileOptionsClass] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CompileOptionsClass, B)
    Implicit
    This member is added by an implicit conversion from CompileOptionsClass toArrowAssoc[CompileOptionsClass] 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. val checkSynthesizable: Boolean

    Check that referenced Data have actually been declared.

    Check that referenced Data have actually been declared.

    Definition Classes
    CompileOptionsClass → CompileOptions
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val connectFieldsMustMatch: Boolean

    Should Record connections require a strict match of fields.

    Should Record connections require a strict match of fields.

    If true and the same fields aren't present in both source and sink, a MissingFieldException, MissingLeftFieldException, or MissingRightFieldException will be thrown.

    Definition Classes
    CompileOptionsClass → CompileOptions
  10. val declaredTypeMustBeUnbound: Boolean

    When creating an object that takes a type argument, the argument must be unbound (a pure type).

    When creating an object that takes a type argument, the argument must be unbound (a pure type).

    Definition Classes
    CompileOptionsClass → CompileOptions
  11. val dontAssumeDirectionality: Boolean

    If connection directionality is not explicit, do not use heuristics to attempt to determine it.

    If connection directionality is not explicit, do not use heuristics to attempt to determine it.

    Definition Classes
    CompileOptionsClass → CompileOptions
  12. val dontTryConnectionsSwapped: Boolean

    If a connection operator fails, don't try the connection with the operands (source and sink) reversed.

    If a connection operator fails, don't try the connection with the operands (source and sink) reversed.

    Definition Classes
    CompileOptionsClass → CompileOptions
  13. def emitStrictConnects: Boolean

    Should connects emit as firrtl <= instead of <-

    Should connects emit as firrtl <= instead of <-

    Definition Classes
    CompileOptions
  14. def ensuring(cond: (CompileOptionsClass) => Boolean, msg: => Any): CompileOptionsClass
    Implicit
    This member is added by an implicit conversion from CompileOptionsClass toEnsuring[CompileOptionsClass] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (CompileOptionsClass) => Boolean): CompileOptionsClass
    Implicit
    This member is added by an implicit conversion from CompileOptionsClass toEnsuring[CompileOptionsClass] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): CompileOptionsClass
    Implicit
    This member is added by an implicit conversion from CompileOptionsClass toEnsuring[CompileOptionsClass] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): CompileOptionsClass
    Implicit
    This member is added by an implicit conversion from CompileOptionsClass toEnsuring[CompileOptionsClass] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val explicitInvalidate: Boolean

    Require explicit assignment of DontCare to generate "x is invalid"

    Require explicit assignment of DontCare to generate "x is invalid"

    Definition Classes
    CompileOptionsClass → CompileOptions
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. val inferModuleReset: Boolean

    Should the reset type of Module be a Bool or a Reset

    Should the reset type of Module be a Bool or a Reset

    Definition Classes
    CompileOptionsClass → CompileOptions
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def migrateBulkConnections: Boolean

    If marked true, then any <> operation using legacy connection semantics will error and suggest using Connectable ops

    If marked true, then any <> operation using legacy connection semantics will error and suggest using Connectable ops

    Definition Classes
    CompileOptions
  24. def migrateInferModuleReset: Boolean

    If marked true, then any Module which consumes inferModuleReset=false must also mix in RequireSyncReset

    If marked true, then any Module which consumes inferModuleReset=false must also mix in RequireSyncReset

    Definition Classes
    CompileOptions
  25. def migrateMonoConnections: Boolean

    If marked true, then any := operation on mixed alignment bundles will error and suggest using Connectable ops

    If marked true, then any := operation on mixed alignment bundles will error and suggest using Connectable ops

    Definition Classes
    CompileOptions
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def productElementNames: Iterator[String]
    Definition Classes
    Product
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from CompileOptionsClass toStringFormat[CompileOptionsClass] 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.

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromCompileOptionsClass to any2stringadd[CompileOptionsClass]

Inherited by implicit conversion StringFormat fromCompileOptionsClass to StringFormat[CompileOptionsClass]

Inherited by implicit conversion Ensuring fromCompileOptionsClass to Ensuring[CompileOptionsClass]

Inherited by implicit conversion ArrowAssoc fromCompileOptionsClass to ArrowAssoc[CompileOptionsClass]

Ungrouped