object assert
- Alphabetic
- By Inheritance
- assert
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
class
Assert extends VerificationStatement
Named class for assertions.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def _applyMacroWithMessage(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
- 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
-
def
_applyWithSourceLine(cond: Bool, line: SourceLineInfo, message: Option[String], data: Bits*)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Assert
Used by our macros.
Used by our macros. Do not call directly!
-
def
apply(cond: Boolean): Unit
An elaboration-time assertion.
An elaboration-time assertion. Calls the built-in Scala assert function.
-
def
apply(cond: Boolean, message: ⇒ String): Unit
An elaboration-time assertion.
An elaboration-time assertion. Calls the built-in Scala assert function.
- macro def apply(cond: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Assert
-
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 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 encapsulating Module's reset). If your definition of reset is not the encapsulating Module's reset, you will need to gate this externally.
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) 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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
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
, andReg
, the abstract typesBits
,Aggregate
, andData
, and the aggregate typesBundle
andVec
.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.