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 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, Serializable, Product, Equals, SpinalTagReady, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClockDomain
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SpinalTagReady
  7. AnyRef
  8. 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. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  5. def addAttribute(name: String, value: Int): ClockDomain.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  6. def addAttribute(name: String, value: String): ClockDomain.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  7. def addAttribute(name: String): ClockDomain.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  8. def addAttribute(attribute: Attribute): ClockDomain.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  9. def addTag[T <: SpinalTag](spinalTag: T): ClockDomain.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  10. def addTags[T <: SpinalTag](tags: Iterable[T]): ClockDomain.this.type

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink

  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  13. def canInit: Boolean

    Permalink

  14. val clock: Bool

    Permalink

  15. val clockEnable: Bool

    Permalink

  16. val clockEnableDivisionRate: DivisionRate

    Permalink

  17. def clone(): AnyRef

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

  18. val config: ClockDomainConfig

    Permalink

  19. val dummyArg: DummyTrait

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  22. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  23. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  24. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  25. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady

  26. val frequency: ClockFrequency

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  28. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady

  29. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  30. def hasClockEnableSignal: Boolean

    Permalink

  31. def hasResetSignal: Boolean

    Permalink

  32. def hasSoftResetSignal: Boolean

    Permalink

  33. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  34. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  35. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  36. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  37. val instanceCounter: Int

    Permalink

  38. def isClockEnableActive: Bool

    Permalink

  39. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  40. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  41. def isResetActive: Bool

    Permalink

  42. def isSoftResetActive: Bool

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  44. def newClockDomainSlowedBy(factor: BigInt): ClockDomain

    Permalink

    Slow down the current clock to factor time

  45. def newSlowedClockDomain(freq: HertzNumber): ClockDomain

    Permalink

  46. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  47. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink

  49. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady

  50. def push(): ClockDomainStack.SetReturn

    Permalink

  51. def readClockEnableWire: Bool

    Permalink

  52. def readClockWire: Bool

    Permalink

  53. def readResetWire: Bool

    Permalink

  54. def readSoftResetWire: Bool

    Permalink

  55. def removeTag(spinalTag: SpinalTag): ClockDomain.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  56. def removeTags(tags: Iterable[SpinalTag]): ClockDomain.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  57. def renamePulledWires(clock: String = null, reset: String = null, softReset: String = null, enable: String = null): ClockDomain.this.type

    Permalink

  58. val reset: Bool

    Permalink

  59. def samplingRate: IClockDomainFrequency

    Permalink

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

    Permalink

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

    Permalink

  62. val softReset: Bool

    Permalink

  63. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    AnyRef

  65. def toString(): String

    Permalink
    Definition Classes
    ClockDomain → AnyRef → Any

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

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

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

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

  68. final def wait(): Unit

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

  69. def withAsyncReset(): ClockDomain

    Permalink

  70. def withBootReset(): ClockDomain

    Permalink

  71. def withRevertedClockEdge(): ClockDomain

    Permalink

  72. def withSyncReset(): ClockDomain

    Permalink

  73. 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 SpinalTagReady

Inherited from AnyRef

Inherited from Any

Ungrouped