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 SpinalTagReady with 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, Product, Equals, SpinalTagReady, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClockDomain
  2. Serializable
  3. Product
  4. Equals
  5. SpinalTagReady
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  5. def addAttribute(name: String, value: Int): ClockDomain.this.type
    Definition Classes
    SpinalTagReady
  6. def addAttribute(name: String, value: String): ClockDomain.this.type
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String): ClockDomain.this.type
    Definition Classes
    SpinalTagReady
  8. def addAttribute(attribute: Attribute): ClockDomain.this.type
    Definition Classes
    SpinalTagReady
  9. def addTag[T <: SpinalTag](spinalTag: T): ClockDomain.this.type
    Definition Classes
    SpinalTagReady
  10. def addTags[T <: SpinalTag](tags: Iterable[T]): ClockDomain.this.type
    Definition Classes
    SpinalTagReady
  11. def apply[T](block: => T): T
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def canInit: Boolean
  14. val clock: Bool
  15. val clockEnable: Bool
  16. val clockEnableDivisionRate: DivisionRate
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  18. val config: ClockDomainConfig
  19. val dummyArg: DummyTrait
  20. def duringReset(body: => Unit): Unit
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  23. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  24. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  25. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  26. val frequency: ClockFrequency
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  29. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  30. def hasClockEnableSignal: Boolean
  31. def hasResetSignal: Boolean
  32. def hasSoftResetSignal: Boolean
  33. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  34. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  35. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  36. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  37. val instanceCounter: Int
  38. def isClockEnableActive: Bool
  39. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def isResetActive: Bool
  42. def isSoftResetActive: Bool
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def newClockDomainSlowedBy(factor: BigInt): ClockDomain

    Slow down the current clock to factor time

  45. def newSlowedClockDomain(freq: HertzNumber): ClockDomain
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. def on[T](block: => T): T
  49. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  50. def productElementNames: Iterator[String]
    Definition Classes
    Product
  51. def push(): ClockDomainStack.SetReturn
  52. def readClockEnableWire: Bool
  53. def readClockWire: Bool
  54. def readResetWire: Bool
  55. def readSoftResetWire: Bool
  56. def removeTag(spinalTag: SpinalTag): ClockDomain.this.type
    Definition Classes
    SpinalTagReady
  57. def removeTags(tags: Iterable[SpinalTag]): ClockDomain.this.type
    Definition Classes
    SpinalTagReady
  58. def renamePulledWires(clock: String = null, reset: String = null, softReset: String = null, enable: String = null): ClockDomain.this.type
  59. val reset: Bool
  60. def samplingRate: IClockDomainFrequency
  61. def setSyncWith(that: ClockDomain): ClockDomain.this.type
  62. def setSynchronousWith(that: ClockDomain): ClockDomain.this.type
  63. val softReset: Bool
  64. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  65. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  66. def toString(): String
    Definition Classes
    ClockDomain → AnyRef → Any
  67. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. def withAsyncReset(): ClockDomain
  71. def withBootReset(): ClockDomain
  72. def withRevertedClockEdge(): ClockDomain
  73. def withSyncReset(): ClockDomain
  74. def withoutReset(): 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
  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 Product

Inherited from Equals

Inherited from SpinalTagReady

Inherited from AnyRef

Inherited from Any

Ungrouped