Packages

o

chisel3

assert

object assert extends VerifPrintMacrosDoc

Linear Supertypes
VerifPrintMacrosDoc, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. assert
  2. VerifPrintMacrosDoc
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class Assert extends VerificationStatement

    Named class for assertions.

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. def _applyMacroWithInterpolatorCheck(c: Context)(cond: scala.reflect.macros.blackbox.Context.Tree, message: scala.reflect.macros.blackbox.Context.Tree, data: scala.reflect.macros.blackbox.Context.Tree*)(sourceInfo: scala.reflect.macros.blackbox.Context.Tree, compileOptions: scala.reflect.macros.blackbox.Context.Tree): scala.reflect.macros.blackbox.Context.Tree

  5. def _applyMacroWithNoMessage(c: Context)(cond: scala.reflect.macros.blackbox.Context.Tree)(sourceInfo: scala.reflect.macros.blackbox.Context.Tree, compileOptions: scala.reflect.macros.blackbox.Context.Tree): scala.reflect.macros.blackbox.Context.Tree

  6. def _applyMacroWithPrintableMessage(c: Context)(cond: scala.reflect.macros.blackbox.Context.Tree, message: scala.reflect.macros.blackbox.Context.Tree)(sourceInfo: scala.reflect.macros.blackbox.Context.Tree, compileOptions: scala.reflect.macros.blackbox.Context.Tree): scala.reflect.macros.blackbox.Context.Tree

  7. def _applyMacroWithStringMessage(c: Context)(cond: scala.reflect.macros.blackbox.Context.Tree, message: scala.reflect.macros.blackbox.Context.Tree, data: scala.reflect.macros.blackbox.Context.Tree*)(sourceInfo: scala.reflect.macros.blackbox.Context.Tree, compileOptions: scala.reflect.macros.blackbox.Context.Tree): scala.reflect.macros.blackbox.Context.Tree

  8. def _applyWithSourceLine(cond: Bool, line: SourceLineInfo, message: Option[String], data: Bits*)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Assert

    This will be removed in Chisel 3.6 in favor of the Printable version

  9. def _applyWithSourceLinePrintable(cond: Bool, line: SourceLineInfo, message: Option[Printable])(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Assert

  10. def apply(cond: Boolean): Unit

    An elaboration-time assertion.

    An elaboration-time assertion. Calls the built-in Scala assert function.

  11. def apply(cond: Boolean, message: ⇒ String): Unit

    An elaboration-time assertion.

    An elaboration-time assertion. Calls the built-in Scala assert function.

  12. macro def apply(cond: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Assert
  13. macro def apply(cond: Bool, message: Printable)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Assert

    Checks for a condition to be valid in the circuit at all times.

    Checks for a condition to be valid in the circuit at all times. If the condition evaluates to false, the circuit simulation stops with an error.

    Does not fire when in reset (defined as the current implicit reset, e.g. as set by the enclosing withReset or Module.reset.

    May be called outside of a Module (like defined in a function), so functions using assert make the standard Module assumptions (single clock and single reset).

    cond

    condition, assertion fires (simulation fails) on a rising clock edge when false and reset is not asserted

    message

    optional chisel Printable type message

    Note

    See printf.apply(pable:chisel3\.Printable)* for documentation on printf using Printables

    ,

    currently cannot be used in core Chisel / libraries because macro defs need to be compiled first and the SBT project is not set up to do that

  14. macro def apply(cond: Bool, message: String, data: Bits*)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Assert

    Checks for a condition to be valid in the circuit at rising clock edge when not in reset.

    Checks for a condition to be valid in the circuit at rising clock edge when not in reset. If the condition evaluates to false, the circuit simulation stops with an error.

    cond

    condition, assertion fires (simulation fails) when false

    message

    optional format string to print when the assertion fires

    data

    optional bits to print in the message formatting

    Note

    See printf for format string documentation

    ,

    currently cannot be used in core Chisel / libraries because macro defs need to be compiled first and the SBT project is not set up to do that

  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from VerifPrintMacrosDoc

Inherited from AnyRef

Inherited from Any

Ungrouped

VerifPrintMacros

These internal methods are not part of the public-facing API!