Clash.Clocks

Generic clock related utilities.

Documentation

class Clocks t where

NB: The documentation only shows instances up to 3 output clocks. By default, instances up to and including 18 clocks will exist.

Associated Types

type ClocksCxt t :: Constraint

type NumOutClocks t :: Nat

Methods

clocks :: (KnownDomain domIn, ClocksCxt t) => Clock domIn -> Reset domIn -> t

Instances

Clocks (Clock c1, Signal pllLock Bool)

Defined in Clash.Clocks

Associated Types

type ClocksCxt (Clock c1, Signal pllLock Bool)

type NumOutClocks (Clock c1, Signal pllLock Bool) :: Nat

Methods

clocks :: forall (domIn :: Domain). (KnownDomain domIn, ClocksCxt (Clock c1, Signal pllLock Bool)) => Clock domIn -> Reset domIn -> (Clock c1, Signal pllLock Bool)

Clocks (Clock c1, Clock c2, Signal pllLock Bool)

Defined in Clash.Clocks

Associated Types

type ClocksCxt (Clock c1, Clock c2, Signal pllLock Bool)

type NumOutClocks (Clock c1, Clock c2, Signal pllLock Bool) :: Nat

Methods

clocks :: forall (domIn :: Domain). (KnownDomain domIn, ClocksCxt (Clock c1, Clock c2, Signal pllLock Bool)) => Clock domIn -> Reset domIn -> (Clock c1, Clock c2, Signal pllLock Bool)

Clocks (Clock c1, Clock c2, Clock c3, Signal pllLock Bool)

Defined in Clash.Clocks

Associated Types

type ClocksCxt (Clock c1, Clock c2, Clock c3, Signal pllLock Bool)

type NumOutClocks (Clock c1, Clock c2, Clock c3, Signal pllLock Bool) :: Nat

Methods

clocks :: forall (domIn :: Domain). (KnownDomain domIn, ClocksCxt (Clock c1, Clock c2, Clock c3, Signal pllLock Bool)) => Clock domIn -> Reset domIn -> (Clock c1, Clock c2, Clock c3, Signal pllLock Bool)

class ClocksSync t where

NB: The documentation only shows instances up to 3 output clocks. By default, instances up to and including 18 clocks will exist.

Associated Types

type ClocksSyncClocksInst t (domIn :: Domain) :: Type

type ClocksResetSynchronizerCxt t :: Constraint

Methods

clocksResetSynchronizer :: (KnownDomain domIn, ClocksResetSynchronizerCxt t) => ClocksSyncClocksInst t domIn -> Clock domIn -> t

Instances

ClocksSync (Clock c1, Reset c1)

Defined in Clash.Clocks

Associated Types

type ClocksSyncClocksInst (Clock c1, Reset c1) domIn

type ClocksResetSynchronizerCxt (Clock c1, Reset c1)

Methods

clocksResetSynchronizer :: forall (domIn :: Domain). (KnownDomain domIn, ClocksResetSynchronizerCxt (Clock c1, Reset c1)) => ClocksSyncClocksInst (Clock c1, Reset c1) domIn -> Clock domIn -> (Clock c1, Reset c1)

ClocksSync (Clock c1, Reset c1, Clock c2, Reset c2)

Defined in Clash.Clocks

Associated Types

type ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2) domIn

type ClocksResetSynchronizerCxt (Clock c1, Reset c1, Clock c2, Reset c2)

Methods

clocksResetSynchronizer :: forall (domIn :: Domain). (KnownDomain domIn, ClocksResetSynchronizerCxt (Clock c1, Reset c1, Clock c2, Reset c2)) => ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2) domIn -> Clock domIn -> (Clock c1, Reset c1, Clock c2, Reset c2)

ClocksSync (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3)

Defined in Clash.Clocks

Associated Types

type ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3) domIn

type ClocksResetSynchronizerCxt (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3)

Methods

clocksResetSynchronizer :: forall (domIn :: Domain). (KnownDomain domIn, ClocksResetSynchronizerCxt (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3)) => ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3) domIn -> Clock domIn -> (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3)

type ClocksSyncCxt t (domIn :: Domain) = (KnownDomain domIn, ClocksSync t, ClocksResetSynchronizerCxt t, Clocks (ClocksSyncClocksInst t domIn), ClocksCxt (ClocksSyncClocksInst t domIn))

type NumOutClocksSync t (domIn :: Domain) = NumOutClocks (ClocksSyncClocksInst t domIn)

Orphan instances

ClocksSync (Clock c1, Reset c1)

Associated Types

type ClocksSyncClocksInst (Clock c1, Reset c1) domIn

type ClocksResetSynchronizerCxt (Clock c1, Reset c1)

Methods

clocksResetSynchronizer :: forall (domIn :: Domain). (KnownDomain domIn, ClocksResetSynchronizerCxt (Clock c1, Reset c1)) => ClocksSyncClocksInst (Clock c1, Reset c1) domIn -> Clock domIn -> (Clock c1, Reset c1)

Clocks (Clock c1, Signal pllLock Bool)

Associated Types

type ClocksCxt (Clock c1, Signal pllLock Bool)

type NumOutClocks (Clock c1, Signal pllLock Bool) :: Nat

Methods

clocks :: forall (domIn :: Domain). (KnownDomain domIn, ClocksCxt (Clock c1, Signal pllLock Bool)) => Clock domIn -> Reset domIn -> (Clock c1, Signal pllLock Bool)

Clocks (Clock c1, Clock c2, Signal pllLock Bool)

Associated Types

type ClocksCxt (Clock c1, Clock c2, Signal pllLock Bool)

type NumOutClocks (Clock c1, Clock c2, Signal pllLock Bool) :: Nat

Methods

clocks :: forall (domIn :: Domain). (KnownDomain domIn, ClocksCxt (Clock c1, Clock c2, Signal pllLock Bool)) => Clock domIn -> Reset domIn -> (Clock c1, Clock c2, Signal pllLock Bool)

ClocksSync (Clock c1, Reset c1, Clock c2, Reset c2)

Associated Types

type ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2) domIn

type ClocksResetSynchronizerCxt (Clock c1, Reset c1, Clock c2, Reset c2)

Methods

clocksResetSynchronizer :: forall (domIn :: Domain). (KnownDomain domIn, ClocksResetSynchronizerCxt (Clock c1, Reset c1, Clock c2, Reset c2)) => ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2) domIn -> Clock domIn -> (Clock c1, Reset c1, Clock c2, Reset c2)

Clocks (Clock c1, Clock c2, Clock c3, Signal pllLock Bool)

Associated Types

type ClocksCxt (Clock c1, Clock c2, Clock c3, Signal pllLock Bool)

type NumOutClocks (Clock c1, Clock c2, Clock c3, Signal pllLock Bool) :: Nat

Methods

clocks :: forall (domIn :: Domain). (KnownDomain domIn, ClocksCxt (Clock c1, Clock c2, Clock c3, Signal pllLock Bool)) => Clock domIn -> Reset domIn -> (Clock c1, Clock c2, Clock c3, Signal pllLock Bool)

ClocksSync (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3)

Associated Types

type ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3) domIn

type ClocksResetSynchronizerCxt (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3)

Methods

clocksResetSynchronizer :: forall (domIn :: Domain). (KnownDomain domIn, ClocksResetSynchronizerCxt (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3)) => ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3) domIn -> Clock domIn -> (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3)