Packages

t

chisel3

ImplicitClock

trait ImplicitClock extends AnyRef

Provides an implicit Clock for use _within_ the RawModule

Be careful to define the Clock value before trying to use it. Due to Scala initialization order, the actual val defining the Clock must occur before any uses of the implicit Clock.

Self Type
ImplicitClock with RawModule
Source
Module.scala
Example:

  1. class MyModule extends RawModule with ImplicitClock {
  // Define a Clock value, it need not be called "implicitClock"
  val clk = IO(Input(Clock()))
  // Implement the virtual method to tell Chisel about this Clock value
  // Note that though this is a def, the actual Clock is assigned to a val (clk above)
  override protected def implicitClock = clk
  // Now we have a Clock to use in this RawModule
  val reg = Reg(UInt(8.W))
}
Linear Supertypes
AnyRef, Any
Known Subclasses
Module, RequireAsyncReset, RequireSyncReset, BasicTester, Arbiter, LockingArbiter, LockingArbiterLike, LockingRRArbiter, Pipe, Queue, RRArbiter, FibonacciLFSR, GaloisLFSR, LFSR, MaxPeriodFibonacciLFSR, MaxPeriodGaloisLFSR, PRNG
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ImplicitClock
  2. AnyRef
  3. 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 implicitClock: Clock

    Method that should point to the user-defined Clock

    Method that should point to the user-defined Clock

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

Inherited from Any

Inherited by implicit conversion any2stringadd fromImplicitClock to any2stringadd[ImplicitClock]

Inherited by implicit conversion StringFormat fromImplicitClock to StringFormat[ImplicitClock]

Inherited by implicit conversion Ensuring fromImplicitClock to Ensuring[ImplicitClock]

Inherited by implicit conversion ArrowAssoc fromImplicitClock to ArrowAssoc[ImplicitClock]

Ungrouped