Packages

trait ResetProcedure[A] extends Type[A]

Stimulus that will apply a standard reset procedure to a Chisel circuit.

The reset procedure is as follows:

time 0: bring everything up using simulator settings time 1: bring reset out of x and deassert it. time 2: assert reset time 3: first clock edge time 4 + n: deassert reset (where n == additionalResetCycles)

This intentionally structured to guarantee the following properties:

  1. There is guaranteed to be a time when FIRRTL/Verilog-based randomization can happen at _either_ time 0 or time 1.) 2. If time 1 is used for FIRRTL/Verilog-based randomization, then time 0 can be used for simulator-based initialization, e.g., +vcs+initreg+random. Simulator initialization will race with FIRRTL/Verilog-based randomization and it is critical that they do not happen at the same time. 3. Both FIRRTL/Verilog-based randomization and simulator-based randomization should not occur on a clock edge, e.g., an edge when reset is asserted. This can be yet-another race condition that has to be avoided. 4. Reset always sees a posedge. This avoids problems with asynchronous reset logic behavior where they may (correctly in Verilog) _not_ fire if you bring the design with reset asserted. Note: it would be fine to do an x -> 1 transition to show an edge, however, it looks cleaner to bring reset to 0.
Source
ResetProcedure.scala
Linear Supertypes
(A) => Unit, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResetProcedure
  2. Function1
  3. AnyRef
  4. 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

Abstract Value Members

  1. abstract def _additionalResetCycles: Int

    The number of additional reset cycles to hold the reset for.

    The number of additional reset cycles to hold the reset for.

    Attributes
    protected
  2. abstract def _getClock: (A) => Clock

    A function to clock to use.

    A function to clock to use.

    Attributes
    protected
  3. abstract def _getReset: (A) => Reset

    A function that returns the reset to use.

    A function that returns the reset to use.

    Attributes
    protected

Concrete 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 ResetProcedure[A] toany2stringadd[ResetProcedure[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ResetProcedure[A], B)
    Implicit
    This member is added by an implicit conversion from ResetProcedure[A] toArrowAssoc[ResetProcedure[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def andThen[A](g: (Unit) => A): (A) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  7. final def apply(dut: A): Unit

    Apply reset procedure stimulus.

    Apply reset procedure stimulus.

    Definition Classes
    ResetProcedure → Function1
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def compose[A](g: (A) => A): (A) => Unit
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  11. def ensuring(cond: (ResetProcedure[A]) => Boolean, msg: => Any): ResetProcedure[A]
    Implicit
    This member is added by an implicit conversion from ResetProcedure[A] toEnsuring[ResetProcedure[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ResetProcedure[A]) => Boolean): ResetProcedure[A]
    Implicit
    This member is added by an implicit conversion from ResetProcedure[A] toEnsuring[ResetProcedure[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): ResetProcedure[A]
    Implicit
    This member is added by an implicit conversion from ResetProcedure[A] toEnsuring[ResetProcedure[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ResetProcedure[A]
    Implicit
    This member is added by an implicit conversion from ResetProcedure[A] toEnsuring[ResetProcedure[A]] 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
    Function1 → 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 ResetProcedure[A] toStringFormat[ResetProcedure[A]] 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): (ResetProcedure[A], B)
    Implicit
    This member is added by an implicit conversion from ResetProcedure[A] toArrowAssoc[ResetProcedure[A]] 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 (A) => Unit

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromResetProcedure[A] to any2stringadd[ResetProcedure[A]]

Inherited by implicit conversion StringFormat fromResetProcedure[A] to StringFormat[ResetProcedure[A]]

Inherited by implicit conversion Ensuring fromResetProcedure[A] to Ensuring[ResetProcedure[A]]

Inherited by implicit conversion ArrowAssoc fromResetProcedure[A] to ArrowAssoc[ResetProcedure[A]]

Ungrouped