Packages

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())

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply[T](block: ⇒ T): T
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val clock: Bool
  7. val clockEnable: Bool
  8. val clockEnableDivisionRate: DivisionRate
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  10. val config: ClockDomainConfig
  11. val dummyArg: DummyTrait
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val frequency: ClockFrequency
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hasClockEnableSignal: Boolean
  16. def hasResetSignal: Boolean
  17. def hasSoftResetSignal: Boolean
  18. val instanceCounter: Int
  19. def isClockEnableActive: Bool
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isResetActive: Bool
  22. def isSoftResetActive: Bool
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def newClockDomainSlowedBy(factor: BigInt): ClockDomain

    Slow down the current clock to factor time

  25. def newSlowedClockDomain(freq: HertzNumber): ClockDomain
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def on[T](block: ⇒ T): T
  29. def pop(): Unit
  30. def push(): Unit
  31. def readClockEnableWire: Bool
  32. def readClockWire: Bool
  33. def readResetWire: Bool
  34. def readSoftResetWire: Bool
  35. val reset: Bool
  36. def samplingRate: IClockDomainFrequency
  37. def setSyncWith(that: ClockDomain): ClockDomain.this.type
  38. def setSynchronousWith(that: ClockDomain): ClockDomain.this.type
  39. val softReset: Bool
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    ClockDomain → AnyRef → Any
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. def withAsyncReset(): ClockDomain
  46. def withBootReset(): ClockDomain
  47. def withRevertedClockEdge(): ClockDomain
  48. def withSyncReset(): ClockDomain

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
    Annotations
    @deprecated
    Deprecated

    (Since version 1.3.0) Use copy instead of clone

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  3. def setSyncronousWith(that: ClockDomain): ClockDomain
    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