Class/Object

spinal.core

ClockDomain

Related Docs: object ClockDomain | package core

Permalink

case class ClockDomain(clock: Bool, reset: Bool = null, dummyArg: DummyTrait = null, softReset: Bool = null, clockEnable: Bool = null, config: ClockDomainConfig = GlobalData.get.commonClockConfig, frequency: ClockFrequency = UnknownFrequency(), clockEnableDivisionRate: DivisionRate = ClockDomain.UnknownDivisionRate()) extends Product with Serializable

clock and reset signals can be combined to create a clock domain. Clock domains could be applied to some area of the design and then all synchronous elements instantiated into this area will then implicitly use this clock domain. Clock domain application work like a stack, which mean, if you are in a given clock domain, you can still apply another clock domain locally

See also

ClockDomain Documentation

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClockDomain
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClockDomain(clock: Bool, reset: Bool = null, dummyArg: DummyTrait = null, softReset: Bool = null, clockEnable: Bool = null, config: ClockDomainConfig = GlobalData.get.commonClockConfig, frequency: ClockFrequency = UnknownFrequency(), clockEnableDivisionRate: DivisionRate = ClockDomain.UnknownDivisionRate())

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def apply[T](block: ⇒ T): T

    Permalink

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. val clock: Bool

    Permalink

  7. val clockEnable: Bool

    Permalink

  8. val clockEnableDivisionRate: DivisionRate

    Permalink

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  10. val config: ClockDomainConfig

    Permalink

  11. val dummyArg: DummyTrait

    Permalink

  12. def duringReset(body: ⇒ Unit): Unit

    Permalink

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. val frequency: ClockFrequency

    Permalink

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  16. def hasClockEnableSignal: Boolean

    Permalink

  17. def hasResetSignal: Boolean

    Permalink

  18. def hasSoftResetSignal: Boolean

    Permalink

  19. val instanceCounter: Int

    Permalink

  20. def isClockEnableActive: Bool

    Permalink

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. def isResetActive: Bool

    Permalink

  23. def isSoftResetActive: Bool

    Permalink

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  25. def newClockDomainSlowedBy(factor: BigInt): ClockDomain

    Permalink

    Slow down the current clock to factor time

  26. def newSlowedClockDomain(freq: HertzNumber): ClockDomain

    Permalink

  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  29. def on[T](block: ⇒ T): T

    Permalink

  30. def pop(): Unit

    Permalink

  31. def push(): Unit

    Permalink

  32. def readClockEnableWire: Bool

    Permalink

  33. def readClockWire: Bool

    Permalink

  34. def readResetWire: Bool

    Permalink

  35. def readSoftResetWire: Bool

    Permalink

  36. val reset: Bool

    Permalink

  37. def samplingRate: IClockDomainFrequency

    Permalink

  38. def setSyncWith(that: ClockDomain): ClockDomain.this.type

    Permalink

  39. def setSynchronousWith(that: ClockDomain): ClockDomain.this.type

    Permalink

  40. val softReset: Bool

    Permalink

  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  42. def toString(): String

    Permalink
    Definition Classes
    ClockDomain → AnyRef → Any

  43. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  44. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  46. def withAsyncReset(): ClockDomain

    Permalink

  47. def withBootReset(): ClockDomain

    Permalink

  48. def withRevertedClockEdge(): ClockDomain

    Permalink

  49. def withSyncReset(): ClockDomain

    Permalink

  50. def withoutReset(): ClockDomain

    Permalink

Deprecated Value Members

  1. def clone(config: ClockDomainConfig = config, clock: Bool = clock, reset: Bool = reset, dummyArg: DummyTrait = null, softReset: Bool = softReset, clockEnable: Bool = clockEnable): ClockDomain

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 1.3.0) Use copy instead of clone

  2. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  3. def setSyncronousWith(that: ClockDomain): ClockDomain

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version SpinalHDL 1.2.3) misspelled method will be removed

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped