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
  • object ExpectationValueFormat

    Formatting options for values rendered by expect failure messages.

    Formatting options for values rendered by expect failure messages.

    Definition Classes
    simulator
  • Bin
  • Custom
  • Dec
  • Failure
  • Hex
  • Rendered
  • Type
  • Value

final case class Value(chiselType: String, signedValue: BigInt, bitWidth: Int, isSigned: Boolean, displayString: String) extends Product with Serializable

Context passed to custom formatters.

chiselType

Chisel data type string (e.g. UInt<32>)

signedValue

Numeric value as observed by the simulator for this data type

bitWidth

Bit width of the rendered value

isSigned

Whether the data type is signed

displayString

Value rendered using the decimal display for this context

Source
PeekPokeAPI.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Value
  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 Value(chiselType: String, signedValue: BigInt, bitWidth: Int, isSigned: Boolean, displayString: String)

    chiselType

    Chisel data type string (e.g. UInt<32>)

    signedValue

    Numeric value as observed by the simulator for this data type

    bitWidth

    Bit width of the rendered value

    isSigned

    Whether the data type is signed

    displayString

    Value rendered using the decimal display for this context

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 Value toany2stringadd[Value] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Value, B)
    Implicit
    This member is added by an implicit conversion from Value toArrowAssoc[Value] 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 bitWidth: Int
  8. val chiselType: String
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. val displayString: String
  11. def ensuring(cond: (Value) => Boolean, msg: => Any): Value
    Implicit
    This member is added by an implicit conversion from Value toEnsuring[Value] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Value) => Boolean): Value
    Implicit
    This member is added by an implicit conversion from Value toEnsuring[Value] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Value
    Implicit
    This member is added by an implicit conversion from Value toEnsuring[Value] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Value
    Implicit
    This member is added by an implicit conversion from Value toEnsuring[Value] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val isSigned: Boolean
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val signedValue: BigInt
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. val unsignedValue: BigInt

    Value interpreted as an unsigned integer with bitWidth bits.

  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. 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 Value toStringFormat[Value] 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): (Value, B)
    Implicit
    This member is added by an implicit conversion from Value toArrowAssoc[Value] 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 fromValue to any2stringadd[Value]

Inherited by implicit conversion StringFormat fromValue to StringFormat[Value]

Inherited by implicit conversion Ensuring fromValue to Ensuring[Value]

Inherited by implicit conversion ArrowAssoc fromValue to ArrowAssoc[Value]

Ungrouped