Clash.Signal.Internal

Datatypes

data Signal (dom :: Domain) a

Clash has synchronous Signals in the form of:

Signal (dom :: Domain) a

Where a is the type of the value of the Signal, for example Int or Bool, and dom is the clock- (and reset-) domain to which the memory elements manipulating these Signals belong.

The type-parameter, dom, is of the kind Domain - a simple string. That string refers to a single synthesis domain. A synthesis domain describes the behavior of certain aspects of memory elements in it.

• NB: "Bad things"™ happen when you actually use a clock period of 0, so do not do that!
• NB: You should be judicious using a clock with period of 1 as you can never create a clock that goes any faster!
• NB: For the best compatibility make sure your period is divisible by 2, because some VHDL simulators don't support fractions of picoseconds.
• NB: Whether System has good defaults depends on your target platform. Check out IntelSystem and XilinxSystem too!

Signals have the type role

>>> :i Signal
type role Signal nominal representational
...

as it is safe to coerce the underlying value of a signal, but not safe to coerce a signal between different synthesis domains.

See the module documentation of Clash.Signal for more information about domains.

Constructors

a :- (Signal dom a) infixr 5

The constructor, (:-), is not synthesizable.

Instances

Lift a => Lift (Signal dom a :: Type)

Defined in Clash.Signal.Internal

Methods

lift :: Signal dom a -> Q Exp

liftTyped :: Signal dom a -> Q (TExp (Signal dom a))

AssertionValue dom (Signal dom Bool)

Stream of booleans, originating from a circuit

Defined in Clash.Verification.Internal

Methods

toAssertionValue :: Signal dom Bool -> Assertion dom

Functor (Signal dom)

Defined in Clash.Signal.Internal

Methods

fmap :: (a -> b) -> Signal dom a -> Signal dom b

(<$) :: a -> Signal dom b -> Signal dom a

Applicative (Signal dom)

Defined in Clash.Signal.Internal

Methods

pure :: a -> Signal dom a

(<*>) :: Signal dom (a -> b) -> Signal dom a -> Signal dom b

liftA2 :: (a -> b -> c) -> Signal dom a -> Signal dom b -> Signal dom c

(*>) :: Signal dom a -> Signal dom b -> Signal dom b

(<*) :: Signal dom a -> Signal dom b -> Signal dom a

Foldable (Signal dom)

NB: Not synthesizable

NB: In "foldr f z s":

• The function f should be lazy in its second argument.
• The z element will never be used.

Defined in Clash.Signal.Internal

Methods

fold :: Monoid m => Signal dom m -> m

foldMap :: Monoid m => (a -> m) -> Signal dom a -> m

foldMap' :: Monoid m => (a -> m) -> Signal dom a -> m

foldr :: (a -> b -> b) -> b -> Signal dom a -> b

foldr' :: (a -> b -> b) -> b -> Signal dom a -> b

foldl :: (b -> a -> b) -> b -> Signal dom a -> b

foldl' :: (b -> a -> b) -> b -> Signal dom a -> b

foldr1 :: (a -> a -> a) -> Signal dom a -> a

foldl1 :: (a -> a -> a) -> Signal dom a -> a

toList :: Signal dom a -> [a]

null :: Signal dom a -> Bool

length :: Signal dom a -> Int

elem :: Eq a => a -> Signal dom a -> Bool

maximum :: Ord a => Signal dom a -> a

minimum :: Ord a => Signal dom a -> a

sum :: Num a => Signal dom a -> a

product :: Num a => Signal dom a -> a

Traversable (Signal dom)

Defined in Clash.Signal.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Signal dom a -> f (Signal dom b)

sequenceA :: Applicative f => Signal dom (f a) -> f (Signal dom a)

mapM :: Monad m => (a -> m b) -> Signal dom a -> m (Signal dom b)

sequence :: Monad m => Signal dom (m a) -> m (Signal dom a)

Fractional a => Fractional (Signal dom a)

Defined in Clash.Signal.Internal

Methods

(/) :: Signal dom a -> Signal dom a -> Signal dom a

recip :: Signal dom a -> Signal dom a

fromRational :: Rational -> Signal dom a

Num a => Num (Signal dom a)

Defined in Clash.Signal.Internal

Methods

(+) :: Signal dom a -> Signal dom a -> Signal dom a

(-) :: Signal dom a -> Signal dom a -> Signal dom a

(*) :: Signal dom a -> Signal dom a -> Signal dom a

negate :: Signal dom a -> Signal dom a

abs :: Signal dom a -> Signal dom a

signum :: Signal dom a -> Signal dom a

fromInteger :: Integer -> Signal dom a

Show a => Show (Signal dom a)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> Signal dom a -> ShowS

show :: Signal dom a -> String

showList :: [Signal dom a] -> ShowS

Arbitrary a => Arbitrary (Signal dom a)

Defined in Clash.Signal.Internal

Methods

arbitrary :: Gen (Signal dom a)

shrink :: Signal dom a -> [Signal dom a]

CoArbitrary a => CoArbitrary (Signal dom a)

Defined in Clash.Signal.Internal

Methods

coarbitrary :: Signal dom a -> Gen b -> Gen b

Default a => Default (Signal dom a)

Defined in Clash.Signal.Internal

Methods

def :: Signal dom a

NFDataX a => NFDataX (Signal domain a)

Defined in Clash.Signal.Internal

Methods

deepErrorX :: String -> Signal domain a

hasUndefined :: Signal domain a -> Bool

ensureSpine :: Signal domain a -> Signal domain a

rnfX :: Signal domain a -> ()

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)

type HasDomain dom1 (Signal dom2 a)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Signal dom2 a) = DomEq dom1 dom2

type TryDomain t (Signal dom a)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Signal dom a) = 'Found dom

type ClocksCxt (Clock c1, Signal pllLock Bool)

Defined in Clash.Clocks

type ClocksCxt (Clock c1, Signal pllLock Bool) = (KnownDomain c1, KnownDomain pllLock)

type NumOutClocks (Clock c1, Signal pllLock Bool)

Defined in Clash.Clocks

type NumOutClocks (Clock c1, Signal pllLock Bool) = 1

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

Defined in Clash.Clocks

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

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

Defined in Clash.Clocks

type NumOutClocks (Clock c1, Clock c2, Signal pllLock Bool) = 2

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

Defined in Clash.Clocks

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

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

Defined in Clash.Clocks

type NumOutClocks (Clock c1, Clock c2, Clock c3, Signal pllLock Bool) = 3

head# :: Signal dom a -> a

tail# :: Signal dom a -> Signal dom a

Domains

type Domain = Symbol

sameDomain :: forall (domA :: Domain) (domB :: Domain). (KnownDomain domA, KnownDomain domB) => Maybe (domA :~: domB)

We either get evidence that this function was instantiated with the same domains, or Nothing.

class (KnownSymbol dom, KnownNat (DomainPeriod dom)) => KnownDomain (dom :: Domain) where

A KnownDomain constraint indicates that a circuit's behavior depends on some properties of a domain. See DomainConfiguration for more information.

Associated Types

type KnownConf dom :: DomainConfiguration

Methods

knownDomain :: SDomainConfiguration dom (KnownConf dom)

Returns SDomainConfiguration corresponding to an instance's DomainConfiguration.

Example usage:

>>> knownDomain @System
SDomainConfiguration {sName = SSymbol @"System", sPeriod = SNat @10000, sActiveEdge = SRising, sResetKind = SAsynchronous, sInitBehavior = SDefined, sResetPolarity = SActiveHigh}

Instances

KnownDomain XilinxSystem

System instance with defaults set for Xilinx FPGAs

Defined in Clash.Signal.Internal

Associated Types

type KnownConf XilinxSystem :: DomainConfiguration

Methods

knownDomain :: SDomainConfiguration XilinxSystem (KnownConf XilinxSystem)

KnownDomain IntelSystem

System instance with defaults set for Intel FPGAs

Defined in Clash.Signal.Internal

Associated Types

type KnownConf IntelSystem :: DomainConfiguration

Methods

knownDomain :: SDomainConfiguration IntelSystem (KnownConf IntelSystem)

KnownDomain System

A clock (and reset) dom with clocks running at 100 MHz

Defined in Clash.Signal.Internal

Associated Types

type KnownConf System :: DomainConfiguration

Methods

knownDomain :: SDomainConfiguration System (KnownConf System)

type KnownConfiguration dom conf = (KnownDomain dom, KnownConf dom ~ conf)

knownDomainByName :: forall dom. KnownDomain dom => SSymbol dom -> SDomainConfiguration dom (KnownConf dom)

Version of knownDomain that takes a SSymbol. For example:

>>> knownDomainByName (SSymbol @"System")
SDomainConfiguration {sName = SSymbol @"System", sPeriod = SNat @10000, sActiveEdge = SRising, sResetKind = SAsynchronous, sInitBehavior = SDefined, sResetPolarity = SActiveHigh}

data ActiveEdge

Determines clock edge memory elements are sensitive to. Not yet implemented.

Constructors

Rising

Elements are sensitive to the rising edge (low-to-high) of the clock.

Falling

Elements are sensitive to the falling edge (high-to-low) of the clock.

Instances

Eq ActiveEdge

Defined in Clash.Signal.Internal

Methods

(==) :: ActiveEdge -> ActiveEdge -> Bool

(/=) :: ActiveEdge -> ActiveEdge -> Bool

Data ActiveEdge

Defined in Clash.Signal.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ActiveEdge -> c ActiveEdge

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ActiveEdge

toConstr :: ActiveEdge -> Constr

dataTypeOf :: ActiveEdge -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ActiveEdge)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ActiveEdge)

gmapT :: (forall b. Data b => b -> b) -> ActiveEdge -> ActiveEdge

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ActiveEdge -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ActiveEdge -> r

gmapQ :: (forall d. Data d => d -> u) -> ActiveEdge -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ActiveEdge -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ActiveEdge -> m ActiveEdge

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ActiveEdge -> m ActiveEdge

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ActiveEdge -> m ActiveEdge

Ord ActiveEdge

Defined in Clash.Signal.Internal

Methods

compare :: ActiveEdge -> ActiveEdge -> Ordering

(<) :: ActiveEdge -> ActiveEdge -> Bool

(<=) :: ActiveEdge -> ActiveEdge -> Bool

(>) :: ActiveEdge -> ActiveEdge -> Bool

(>=) :: ActiveEdge -> ActiveEdge -> Bool

max :: ActiveEdge -> ActiveEdge -> ActiveEdge

min :: ActiveEdge -> ActiveEdge -> ActiveEdge

Read ActiveEdge

Defined in Clash.Signal.Internal

Methods

readsPrec :: Int -> ReadS ActiveEdge

readList :: ReadS [ActiveEdge]

readPrec :: ReadPrec ActiveEdge

readListPrec :: ReadPrec [ActiveEdge]

Show ActiveEdge

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> ActiveEdge -> ShowS

show :: ActiveEdge -> String

showList :: [ActiveEdge] -> ShowS

Generic ActiveEdge

Defined in Clash.Signal.Internal

Associated Types

type Rep ActiveEdge :: Type -> Type

Methods

from :: ActiveEdge -> Rep ActiveEdge x

to :: Rep ActiveEdge x -> ActiveEdge

Binary ActiveEdge

Defined in Clash.Signal.Internal

Methods

put :: ActiveEdge -> Put

get :: Get ActiveEdge

putList :: [ActiveEdge] -> Put

NFData ActiveEdge

Defined in Clash.Signal.Internal

Methods

rnf :: ActiveEdge -> ()

Hashable ActiveEdge

Defined in Clash.Signal.Internal

Methods

hashWithSalt :: Int -> ActiveEdge -> Int

hash :: ActiveEdge -> Int

type Rep ActiveEdge

Defined in Clash.Signal.Internal

type Rep ActiveEdge = D1 ('MetaData "ActiveEdge" "Clash.Signal.Internal" "clash-prelude-1.8.0-inplace" 'False) (C1 ('MetaCons "Rising" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Falling" 'PrefixI 'False) (U1 :: Type -> Type))

data SActiveEdge (edge :: ActiveEdge) where

Singleton version of ActiveEdge

Constructors

SRising :: SActiveEdge 'Rising

SFalling :: SActiveEdge 'Falling

Instances

Show (SActiveEdge edge)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> SActiveEdge edge -> ShowS

show :: SActiveEdge edge -> String

showList :: [SActiveEdge edge] -> ShowS

data InitBehavior

Constructors

Unknown

Power up value of memory elements is unknown.

Defined

If applicable, power up value of a memory element is defined. Applies to registers for example, but not to blockRam.

Instances

Eq InitBehavior

Defined in Clash.Signal.Internal

Methods

(==) :: InitBehavior -> InitBehavior -> Bool

(/=) :: InitBehavior -> InitBehavior -> Bool

Data InitBehavior

Defined in Clash.Signal.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InitBehavior -> c InitBehavior

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InitBehavior

toConstr :: InitBehavior -> Constr

dataTypeOf :: InitBehavior -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c InitBehavior)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InitBehavior)

gmapT :: (forall b. Data b => b -> b) -> InitBehavior -> InitBehavior

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InitBehavior -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InitBehavior -> r

gmapQ :: (forall d. Data d => d -> u) -> InitBehavior -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InitBehavior -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InitBehavior -> m InitBehavior

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InitBehavior -> m InitBehavior

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InitBehavior -> m InitBehavior

Ord InitBehavior

Defined in Clash.Signal.Internal

Methods

compare :: InitBehavior -> InitBehavior -> Ordering

(<) :: InitBehavior -> InitBehavior -> Bool

(<=) :: InitBehavior -> InitBehavior -> Bool

(>) :: InitBehavior -> InitBehavior -> Bool

(>=) :: InitBehavior -> InitBehavior -> Bool

max :: InitBehavior -> InitBehavior -> InitBehavior

min :: InitBehavior -> InitBehavior -> InitBehavior

Read InitBehavior

Defined in Clash.Signal.Internal

Methods

readsPrec :: Int -> ReadS InitBehavior

readList :: ReadS [InitBehavior]

readPrec :: ReadPrec InitBehavior

readListPrec :: ReadPrec [InitBehavior]

Show InitBehavior

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> InitBehavior -> ShowS

show :: InitBehavior -> String

showList :: [InitBehavior] -> ShowS

Generic InitBehavior

Defined in Clash.Signal.Internal

Associated Types

type Rep InitBehavior :: Type -> Type

Methods

from :: InitBehavior -> Rep InitBehavior x

to :: Rep InitBehavior x -> InitBehavior

Binary InitBehavior

Defined in Clash.Signal.Internal

Methods

put :: InitBehavior -> Put

get :: Get InitBehavior

putList :: [InitBehavior] -> Put

NFData InitBehavior

Defined in Clash.Signal.Internal

Methods

rnf :: InitBehavior -> ()

Hashable InitBehavior

Defined in Clash.Signal.Internal

Methods

hashWithSalt :: Int -> InitBehavior -> Int

hash :: InitBehavior -> Int

type Rep InitBehavior

Defined in Clash.Signal.Internal

type Rep InitBehavior = D1 ('MetaData "InitBehavior" "Clash.Signal.Internal" "clash-prelude-1.8.0-inplace" 'False) (C1 ('MetaCons "Unknown" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Defined" 'PrefixI 'False) (U1 :: Type -> Type))

data SInitBehavior (init :: InitBehavior) where

Constructors

SUnknown :: SInitBehavior 'Unknown

SDefined :: SInitBehavior 'Defined

Instances

Show (SInitBehavior init)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> SInitBehavior init -> ShowS

show :: SInitBehavior init -> String

showList :: [SInitBehavior init] -> ShowS

data ResetKind

Constructors

Asynchronous

Elements respond asynchronously to changes in their reset input. This means that they do not wait for the next active clock edge, but respond immediately instead. Common on Intel FPGA platforms.

Synchronous

Elements respond synchronously to changes in their reset input. This means that changes in their reset input won't take effect until the next active clock edge. Common on Xilinx FPGA platforms.

Instances

Eq ResetKind

Defined in Clash.Signal.Internal

Methods

(==) :: ResetKind -> ResetKind -> Bool

(/=) :: ResetKind -> ResetKind -> Bool

Data ResetKind

Defined in Clash.Signal.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResetKind -> c ResetKind

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ResetKind

toConstr :: ResetKind -> Constr

dataTypeOf :: ResetKind -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ResetKind)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ResetKind)

gmapT :: (forall b. Data b => b -> b) -> ResetKind -> ResetKind

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResetKind -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResetKind -> r

gmapQ :: (forall d. Data d => d -> u) -> ResetKind -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ResetKind -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResetKind -> m ResetKind

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResetKind -> m ResetKind

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResetKind -> m ResetKind

Ord ResetKind

Defined in Clash.Signal.Internal

Methods

compare :: ResetKind -> ResetKind -> Ordering

(<) :: ResetKind -> ResetKind -> Bool

(<=) :: ResetKind -> ResetKind -> Bool

(>) :: ResetKind -> ResetKind -> Bool

(>=) :: ResetKind -> ResetKind -> Bool

max :: ResetKind -> ResetKind -> ResetKind

min :: ResetKind -> ResetKind -> ResetKind

Read ResetKind

Defined in Clash.Signal.Internal

Methods

readsPrec :: Int -> ReadS ResetKind

readList :: ReadS [ResetKind]

readPrec :: ReadPrec ResetKind

readListPrec :: ReadPrec [ResetKind]

Show ResetKind

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> ResetKind -> ShowS

show :: ResetKind -> String

showList :: [ResetKind] -> ShowS

Generic ResetKind

Defined in Clash.Signal.Internal

Associated Types

type Rep ResetKind :: Type -> Type

Methods

from :: ResetKind -> Rep ResetKind x

to :: Rep ResetKind x -> ResetKind

Binary ResetKind

Defined in Clash.Signal.Internal

Methods

put :: ResetKind -> Put

get :: Get ResetKind

putList :: [ResetKind] -> Put

NFData ResetKind

Defined in Clash.Signal.Internal

Methods

rnf :: ResetKind -> ()

Hashable ResetKind

Defined in Clash.Signal.Internal

Methods

hashWithSalt :: Int -> ResetKind -> Int

hash :: ResetKind -> Int

type Rep ResetKind

Defined in Clash.Signal.Internal

type Rep ResetKind = D1 ('MetaData "ResetKind" "Clash.Signal.Internal" "clash-prelude-1.8.0-inplace" 'False) (C1 ('MetaCons "Asynchronous" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Synchronous" 'PrefixI 'False) (U1 :: Type -> Type))

data SResetKind (resetKind :: ResetKind) where

Singleton version of ResetKind

Constructors

SAsynchronous :: SResetKind 'Asynchronous

SSynchronous :: SResetKind 'Synchronous

Instances

Show (SResetKind reset)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> SResetKind reset -> ShowS

show :: SResetKind reset -> String

showList :: [SResetKind reset] -> ShowS

data ResetPolarity

Determines the value for which a reset line is considered "active"

Constructors

ActiveHigh

Reset is considered active if underlying signal is True.

ActiveLow

Reset is considered active if underlying signal is False.

Instances

Eq ResetPolarity

Defined in Clash.Signal.Internal

Methods

(==) :: ResetPolarity -> ResetPolarity -> Bool

(/=) :: ResetPolarity -> ResetPolarity -> Bool

Data ResetPolarity

Defined in Clash.Signal.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResetPolarity -> c ResetPolarity

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ResetPolarity

toConstr :: ResetPolarity -> Constr

dataTypeOf :: ResetPolarity -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ResetPolarity)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ResetPolarity)

gmapT :: (forall b. Data b => b -> b) -> ResetPolarity -> ResetPolarity

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResetPolarity -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResetPolarity -> r

gmapQ :: (forall d. Data d => d -> u) -> ResetPolarity -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ResetPolarity -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResetPolarity -> m ResetPolarity

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResetPolarity -> m ResetPolarity

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResetPolarity -> m ResetPolarity

Ord ResetPolarity

Defined in Clash.Signal.Internal

Methods

compare :: ResetPolarity -> ResetPolarity -> Ordering

(<) :: ResetPolarity -> ResetPolarity -> Bool

(<=) :: ResetPolarity -> ResetPolarity -> Bool

(>) :: ResetPolarity -> ResetPolarity -> Bool

(>=) :: ResetPolarity -> ResetPolarity -> Bool

max :: ResetPolarity -> ResetPolarity -> ResetPolarity

min :: ResetPolarity -> ResetPolarity -> ResetPolarity

Read ResetPolarity

Defined in Clash.Signal.Internal

Methods

readsPrec :: Int -> ReadS ResetPolarity

readList :: ReadS [ResetPolarity]

readPrec :: ReadPrec ResetPolarity

readListPrec :: ReadPrec [ResetPolarity]

Show ResetPolarity

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> ResetPolarity -> ShowS

show :: ResetPolarity -> String

showList :: [ResetPolarity] -> ShowS

Generic ResetPolarity

Defined in Clash.Signal.Internal

Associated Types

type Rep ResetPolarity :: Type -> Type

Methods

from :: ResetPolarity -> Rep ResetPolarity x

to :: Rep ResetPolarity x -> ResetPolarity

Binary ResetPolarity

Defined in Clash.Signal.Internal

Methods

put :: ResetPolarity -> Put

get :: Get ResetPolarity

putList :: [ResetPolarity] -> Put

NFData ResetPolarity

Defined in Clash.Signal.Internal

Methods

rnf :: ResetPolarity -> ()

Hashable ResetPolarity

Defined in Clash.Signal.Internal

Methods

hashWithSalt :: Int -> ResetPolarity -> Int

hash :: ResetPolarity -> Int

type Rep ResetPolarity

Defined in Clash.Signal.Internal

type Rep ResetPolarity = D1 ('MetaData "ResetPolarity" "Clash.Signal.Internal" "clash-prelude-1.8.0-inplace" 'False) (C1 ('MetaCons "ActiveHigh" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ActiveLow" 'PrefixI 'False) (U1 :: Type -> Type))

data SResetPolarity (polarity :: ResetPolarity) where

Singleton version of ResetPolarity

Constructors

SActiveHigh :: SResetPolarity 'ActiveHigh

SActiveLow :: SResetPolarity 'ActiveLow

Instances

Show (SResetPolarity polarity)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> SResetPolarity polarity -> ShowS

show :: SResetPolarity polarity -> String

showList :: [SResetPolarity polarity] -> ShowS

data DomainConfiguration

A domain with a name (Domain). Configures the behavior of various aspects of a circuits. See the documentation of this record's field types for more information on the options.

See module documentation of Clash.Explicit.Signal for more information on how to create custom synthesis domains.

Constructors

DomainConfiguration

Fields

• _name :: Domain

  Domain name

• _period :: Nat

  Period of clock in ps

• _activeEdge :: ActiveEdge

  Active edge of the clock

• _resetKind :: ResetKind

  Whether resets are synchronous (edge-sensitive) or asynchronous (level-sensitive)

• _initBehavior :: InitBehavior

  Whether the initial (or "power up") value of memory elements is unknown/undefined, or configurable to a specific value

• _resetPolarity :: ResetPolarity

  Whether resets are active high or active low

data SDomainConfiguration (dom :: Domain) (conf :: DomainConfiguration) where

Singleton version of DomainConfiguration

Constructors

SDomainConfiguration

Fields

• :: { sName :: SSymbol dom

  Domain name

•    , sPeriod :: SNat period

  Period of clock in ps

•    , sActiveEdge :: SActiveEdge edge

  Active edge of the clock (not yet implemented)

•    , sResetKind :: SResetKind reset

  Whether resets are synchronous (edge-sensitive) or asynchronous (level-sensitive)

•    , sInitBehavior :: SInitBehavior init

  Whether the initial (or "power up") value of memory elements is unknown/undefined, or configurable to a specific value

•    , sResetPolarity :: SResetPolarity polarity

  Whether resets are active high or active low

•    } -> SDomainConfiguration dom ('DomainConfiguration dom period edge reset init polarity)

Instances

Show (SDomainConfiguration dom conf)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> SDomainConfiguration dom conf -> ShowS

show :: SDomainConfiguration dom conf -> String

showList :: [SDomainConfiguration dom conf] -> ShowS

Configuration type families

type DomainPeriod (dom :: Domain) = DomainConfigurationPeriod (KnownConf dom)

Convenience type to help to extract a period from a domain. Example usage:

myFunc :: (KnownDomain dom, DomainPeriod dom ~ 6000) => ...

type DomainActiveEdge (dom :: Domain) = DomainConfigurationActiveEdge (KnownConf dom)

Convenience type to help to extract the active edge from a domain. Example usage:

myFunc :: (KnownDomain dom, DomainActiveEdge dom ~ 'Rising) => ...

type DomainResetKind (dom :: Domain) = DomainConfigurationResetKind (KnownConf dom)

Convenience type to help to extract the reset synchronicity from a domain. Example usage:

myFunc :: (KnownDomain dom, DomainResetKind dom ~ 'Synchronous) => ...

type DomainInitBehavior (dom :: Domain) = DomainConfigurationInitBehavior (KnownConf dom)

Convenience type to help to extract the initial value behavior from a domain. Example usage:

myFunc :: (KnownDomain dom, DomainInitBehavior dom ~ 'Defined) => ...

type DomainResetPolarity (dom :: Domain) = DomainConfigurationResetPolarity (KnownConf dom)

Convenience type to help to extract the reset polarity from a domain. Example usage:

myFunc :: (KnownDomain dom, DomainResetPolarity dom ~ 'ActiveHigh) => ...

type family DomainConfigurationPeriod (config :: DomainConfiguration) :: Nat where ...

Helper type family for DomainPeriod

Equations

DomainConfigurationPeriod ('DomainConfiguration name period edge reset init polarity) = period

type family DomainConfigurationActiveEdge (config :: DomainConfiguration) :: ActiveEdge where ...

Helper type family for DomainActiveEdge

Equations

DomainConfigurationActiveEdge ('DomainConfiguration name period edge reset init polarity) = edge

type family DomainConfigurationResetKind (config :: DomainConfiguration) :: ResetKind where ...

Helper type family for DomainResetKind

Equations

DomainConfigurationResetKind ('DomainConfiguration name period edge reset init polarity) = reset

type family DomainConfigurationInitBehavior (config :: DomainConfiguration) :: InitBehavior where ...

Helper type family for DomainInitBehavior

Equations

DomainConfigurationInitBehavior ('DomainConfiguration name period edge reset init polarity) = init

type family DomainConfigurationResetPolarity (config :: DomainConfiguration) :: ResetPolarity where ...

Helper type family for DomainResetPolarity

Equations

DomainConfigurationResetPolarity ('DomainConfiguration name period edge reset init polarity) = polarity

Convenience types

type HasSynchronousReset (dom :: Domain) = (KnownDomain dom, DomainResetKind dom ~ 'Synchronous)

Convenience type to constrain a domain to have synchronous resets. Example usage:

myFunc :: HasSynchronousReset dom => ...

Using this type implies KnownDomain.

Click here for usage hints

type HasAsynchronousReset (dom :: Domain) = (KnownDomain dom, DomainResetKind dom ~ 'Asynchronous)

Convenience type to constrain a domain to have asynchronous resets. Example usage:

myFunc :: HasAsynchronousReset dom => ...

Using this type implies KnownDomain.

Click here for usage hints

type HasDefinedInitialValues (dom :: Domain) = (KnownDomain dom, DomainInitBehavior dom ~ 'Defined)

Convenience type to constrain a domain to have initial values. Example usage:

myFunc :: HasDefinedInitialValues dom => ...

Using this type implies KnownDomain.

Note that there is no UnknownInitialValues dom as a component that works without initial values will also work if it does have them.

Click here for usage hints

Default domains

type System = "System" :: Domain

A clock (and reset) dom with clocks running at 100 MHz. Memory elements respond to the rising edge of the clock, and asynchronously to changes in reset signals. It has defined initial values, and active-high resets.

See module documentation of Clash.Explicit.Signal for more information on how to create custom synthesis domains.

type XilinxSystem = "XilinxSystem" :: Domain

A clock (and reset) dom with clocks running at 100 MHz. Memory elements respond to the rising edge of the clock, and synchronously to changes in reset signals. It has defined initial values, and active-high resets.

See module documentation of Clash.Explicit.Signal for more information on how to create custom synthesis domains.

type IntelSystem = "IntelSystem" :: Domain

A clock (and reset) dom with clocks running at 100 MHz. Memory elements respond to the rising edge of the clock, and asynchronously to changes in reset signals. It has defined initial values, and active-high resets.

See module documentation of Clash.Explicit.Signal for more information on how to create custom synthesis domains.

vSystem :: VDomainConfiguration

Convenience value to allow easy "subclassing" of System domain. Should be used in combination with createDomain. For example, if you just want to change the period but leave all other settings intact use:

createDomain vSystem{vName="System10", vPeriod=10}

vIntelSystem :: VDomainConfiguration

Convenience value to allow easy "subclassing" of IntelSystem domain. Should be used in combination with createDomain. For example, if you just want to change the period but leave all other settings intact use:

createDomain vIntelSystem{vName="Intel10", vPeriod=10}

vXilinxSystem :: VDomainConfiguration

Convenience value to allow easy "subclassing" of XilinxSystem domain. Should be used in combination with createDomain. For example, if you just want to change the period but leave all other settings intact use:

createDomain vXilinxSystem{vName="Xilinx10", vPeriod=10}

Domain utilities

data VDomainConfiguration

Same as SDomainConfiguration but allows for easy updates through record update syntax. Should be used in combination with vDomain and createDomain. Example:

createDomain (knownVDomain @System){vName="System10", vPeriod=10}

This duplicates the settings in the System domain, replaces the name and period, and creates an instance for it. As most users often want to update the system domain, a shortcut is available in the form:

createDomain vSystem{vName="System10", vPeriod=10}

Constructors

VDomainConfiguration

Fields

• vName :: String

  Corresponds to _name on DomainConfiguration

• vPeriod :: Natural

  Corresponds to _period on DomainConfiguration

• vActiveEdge :: ActiveEdge

  Corresponds to _activeEdge on DomainConfiguration

• vResetKind :: ResetKind

  Corresponds to _resetKind on DomainConfiguration

• vInitBehavior :: InitBehavior

  Corresponds to _initBehavior on DomainConfiguration

• vResetPolarity :: ResetPolarity

  Corresponds to _resetPolarity on DomainConfiguration

Instances

Eq VDomainConfiguration

Defined in Clash.Signal.Internal

Methods

(==) :: VDomainConfiguration -> VDomainConfiguration -> Bool

(/=) :: VDomainConfiguration -> VDomainConfiguration -> Bool

Read VDomainConfiguration

Defined in Clash.Signal.Internal

Methods

readsPrec :: Int -> ReadS VDomainConfiguration

readList :: ReadS [VDomainConfiguration]

readPrec :: ReadPrec VDomainConfiguration

readListPrec :: ReadPrec [VDomainConfiguration]

Show VDomainConfiguration

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> VDomainConfiguration -> ShowS

show :: VDomainConfiguration -> String

showList :: [VDomainConfiguration] -> ShowS

Generic VDomainConfiguration

Defined in Clash.Signal.Internal

Associated Types

type Rep VDomainConfiguration :: Type -> Type

Methods

from :: VDomainConfiguration -> Rep VDomainConfiguration x

to :: Rep VDomainConfiguration x -> VDomainConfiguration

Binary VDomainConfiguration

Defined in Clash.Signal.Internal

Methods

put :: VDomainConfiguration -> Put

get :: Get VDomainConfiguration

putList :: [VDomainConfiguration] -> Put

NFData VDomainConfiguration

Defined in Clash.Signal.Internal

Methods

rnf :: VDomainConfiguration -> ()

type Rep VDomainConfiguration

Defined in Clash.Signal.Internal

type Rep VDomainConfiguration = D1 ('MetaData "VDomainConfiguration" "Clash.Signal.Internal" "clash-prelude-1.8.0-inplace" 'False) (C1 ('MetaCons "VDomainConfiguration" 'PrefixI 'True) ((S1 ('MetaSel ('Just "vName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "vPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "vActiveEdge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ActiveEdge))) :*: (S1 ('MetaSel ('Just "vResetKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ResetKind) :*: (S1 ('MetaSel ('Just "vInitBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InitBehavior) :*: S1 ('MetaSel ('Just "vResetPolarity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ResetPolarity)))))

vDomain :: SDomainConfiguration dom conf -> VDomainConfiguration

Convert SDomainConfiguration to VDomainConfiguration. Should be used in combination with createDomain only.

createDomain :: VDomainConfiguration -> Q [Dec]

Convenience method to express new domains in terms of others.

createDomain (knownVDomain @System){vName="System10", vPeriod=10}

This duplicates the settings in the System domain, replaces the name and period, and creates an instance for it. As most users often want to update the system domain, a shortcut is available in the form:

createDomain vSystem{vName="System10", vPeriod=10}

The function will create two extra identifiers. The first:

type System10 = ..

You can use that as the dom to Clocks/Resets/Enables/Signals. For example: Signal System10 Int. Additionally, it will create a VDomainConfiguration that you can use in later calls to createDomain:

vSystem10 = knownVDomain @System10

It will also make System10 an instance of KnownDomain.

If either identifier is already in scope it will not be generated a second time. Note: This can be useful for example when documenting a new domain:

-- | Here is some documentation for CustomDomain
type CustomDomain = ("CustomDomain" :: Domain)

-- | Here is some documentation for vCustomDomain
createDomain vSystem{vName="CustomDomain"}

Clocks

data Clock (dom :: Domain)

A clock signal belonging to a domain named dom.

Constructors

Clock

Fields

• clockTag :: SSymbol dom

  Domain associated with the clock

• clockPeriods :: Maybe (Signal dom Femtoseconds)

  Periods of the clock. This is an experimental feature used to simulate clock frequency correction mechanisms. Currently, all ways to contruct such a clock are hidden from the public API.

Instances

Show (Clock dom)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> Clock dom -> ShowS

show :: Clock dom -> String

showList :: [Clock dom] -> ShowS

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)

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)

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)

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)

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 HasDomain dom1 (Clock dom2)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Clock dom2) = DomEq dom1 dom2

type TryDomain t (Clock dom)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Clock dom) = 'Found dom

type ClocksResetSynchronizerCxt (Clock c1, Reset c1)

Defined in Clash.Clocks

type ClocksResetSynchronizerCxt (Clock c1, Reset c1) = KnownDomain c1

type ClocksCxt (Clock c1, Signal pllLock Bool)

Defined in Clash.Clocks

type ClocksCxt (Clock c1, Signal pllLock Bool) = (KnownDomain c1, KnownDomain pllLock)

type NumOutClocks (Clock c1, Signal pllLock Bool)

Defined in Clash.Clocks

type NumOutClocks (Clock c1, Signal pllLock Bool) = 1

type ClocksSyncClocksInst (Clock c1, Reset c1) domIn

Defined in Clash.Clocks

type ClocksSyncClocksInst (Clock c1, Reset c1) domIn = (Clock c1, Signal domIn Bool)

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

Defined in Clash.Clocks

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

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

Defined in Clash.Clocks

type NumOutClocks (Clock c1, Clock c2, Signal pllLock Bool) = 2

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

Defined in Clash.Clocks

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

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

Defined in Clash.Clocks

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

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

Defined in Clash.Clocks

type NumOutClocks (Clock c1, Clock c2, Clock c3, Signal pllLock Bool) = 3

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

Defined in Clash.Clocks

type ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2) domIn = (Clock c1, Clock c2, Signal domIn Bool)

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

Defined in Clash.Clocks

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

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

Defined in Clash.Clocks

type ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3) domIn = (Clock c1, Clock c2, Clock c3, Signal domIn Bool)

newtype ClockN (dom :: Domain)

The negative or inverted phase of a differential clock signal. HDL generation will treat it the same as Clock, except that no create_clock command is issued in the SDC file for ClockN. Used in DiffClock.

Constructors

ClockN

Fields

• clockNTag :: SSymbol dom

Instances

Show (ClockN dom)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> ClockN dom -> ShowS

show :: ClockN dom -> String

showList :: [ClockN dom] -> ShowS

data DiffClock (dom :: Domain)

A differential clock signal belonging to a domain named dom. The clock input of a design with such an input has two ports which are in antiphase. The first input is the positive phase, the second the negative phase. When using makeTopEntity, the names of the inputs will end in _p and _n respectively.

To create a differential clock in a test bench, you can use clockToDiffClock.

Constructors

DiffClock ("p" ::: Clock dom) ("n" ::: ClockN dom)

Instances

Show (DiffClock dom)

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> DiffClock dom -> ShowS

show :: DiffClock dom -> String

showList :: [DiffClock dom] -> ShowS

hzToPeriod :: (HasCallStack, Integral a) => Ratio Natural -> a

Calculate the period in ps, given a frequency in Hz

I.e., to calculate the clock period for a circuit to run at 240 MHz we get

>>> hzToPeriod 240e6
4166

If the value hzToPeriod is applied to is not of the type Ratio Natural, you can use hzToPeriod (realToFrac f). Note that if f is negative, realToFrac will give an Underflow :: ArithException without a call stack, making debugging cumbersome.

Before Clash 1.8, this function always returned a Natural. To get the old behavior of this function, use a type application:

>>> hzToPeriod @Natural 240e6
4166

• NB: This function is not synthesizable
• NB: This function is lossy. I.e., periodToHz . hzToPeriod /= id.

periodToHz :: (HasCallStack, Fractional a) => Natural -> a

Calculate the frequency in Hz, given the period in ps

I.e., to calculate the clock frequency of a clock with a period of 5000 ps:

>>> periodToHz 5000
2.0e8

Note that if p in periodToHz (fromIntegral p) is negative, fromIntegral will give an Underflow :: ArithException without a call stack, making debugging cumbersome.

Before Clash 1.8, this function always returned a Ratio Natural. To get the old behavior of this function, use a type application:

>>> periodToHz @(Ratio Natural) 5000
200000000 % 1

NB: This function is not synthesizable

data ClockAB

Constructors

ClockA

Clock edge A produced

ClockB

Clock edge B produced

ClockAB

Clock edges coincided

Instances

Eq ClockAB

Defined in Clash.Signal.Internal

Methods

(==) :: ClockAB -> ClockAB -> Bool

(/=) :: ClockAB -> ClockAB -> Bool

Show ClockAB

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> ClockAB -> ShowS

show :: ClockAB -> String

showList :: [ClockAB] -> ShowS

Generic ClockAB

Defined in Clash.Signal.Internal

Associated Types

type Rep ClockAB :: Type -> Type

Methods

from :: ClockAB -> Rep ClockAB x

to :: Rep ClockAB x -> ClockAB

NFData ClockAB

Defined in Clash.Signal.Internal

Methods

rnf :: ClockAB -> ()

NFDataX ClockAB

Defined in Clash.Signal.Internal

Methods

deepErrorX :: String -> ClockAB

hasUndefined :: ClockAB -> Bool

ensureSpine :: ClockAB -> ClockAB

rnfX :: ClockAB -> ()

type Rep ClockAB

Defined in Clash.Signal.Internal

type Rep ClockAB = D1 ('MetaData "ClockAB" "Clash.Signal.Internal" "clash-prelude-1.8.0-inplace" 'False) (C1 ('MetaCons "ClockA" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ClockB" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ClockAB" 'PrefixI 'False) (U1 :: Type -> Type)))

clockTicks :: (KnownDomain domA, KnownDomain domB) => Clock domA -> Clock domB -> [ClockAB]

Given two clocks, produce a list of clock ticks indicating which clock (or both) ticked. Can be used in components handling multiple clocks, such as unsafeSynchronizer or dual clock FIFOs.

If your primitive does not care about coincided clock edges, it should - by convention - replace it by ClockB:ClockA:.

clockTicksEither :: Either Int64 (Signal domA Int64) -> Either Int64 (Signal domB Int64) -> [ClockAB]

Given two clock periods, produce a list of clock ticks indicating which clock (or both) ticked. Can be used in components handling multiple clocks, such as unsafeSynchronizer or dual clock FIFOs.

If your primitive does not care about coincided clock edges, it should - by convention - replace it by ClockB:ClockA:.

Enabling

data Enable dom

A signal of booleans, indicating whether a component is enabled. No special meaning is implied, it's up to the component itself to decide how to respond to its enable line. It is used throughout Clash as a global enable signal.

Constructors

Enable (Signal dom Bool)

Instances

type HasDomain dom1 (Enable dom2)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Enable dom2) = DomEq dom1 dom2

type TryDomain t (Enable dom)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Enable dom) = 'Found dom

toEnable :: Signal dom Bool -> Enable dom

Convert a signal of bools to an Enable construct

fromEnable :: Enable dom -> Signal dom Bool

Convert Enable construct to its underlying representation: a signal of bools.

enableGen :: Enable dom

Enable generator for some domain. Is simply always True.

Resets

data Reset (dom :: Domain)

A reset signal belonging to a domain called dom.

The underlying representation of resets is Bool.

Constructors

Reset (Signal dom Bool)

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 HasDomain dom1 (Reset dom2)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Reset dom2) = DomEq dom1 dom2

type TryDomain t (Reset dom)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Reset dom) = 'Found dom

type ClocksResetSynchronizerCxt (Clock c1, Reset c1)

Defined in Clash.Clocks

type ClocksResetSynchronizerCxt (Clock c1, Reset c1) = KnownDomain c1

type ClocksSyncClocksInst (Clock c1, Reset c1) domIn

Defined in Clash.Clocks

type ClocksSyncClocksInst (Clock c1, Reset c1) domIn = (Clock c1, Signal domIn Bool)

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

Defined in Clash.Clocks

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

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

Defined in Clash.Clocks

type ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2) domIn = (Clock c1, Clock c2, Signal domIn Bool)

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

Defined in Clash.Clocks

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

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

Defined in Clash.Clocks

type ClocksSyncClocksInst (Clock c1, Reset c1, Clock c2, Reset c2, Clock c3, Reset c3) domIn = (Clock c1, Clock c2, Clock c3, Signal domIn Bool)

unsafeToReset :: KnownDomain dom => Signal dom Bool -> Reset dom

unsafeToReset is unsafe. For asynchronous resets it is unsafe because it can introduce combinatorial loops. In case of synchronous resets it can lead to meta-stability issues in the presence of asynchronous resets.

NB: You probably want to use unsafeFromActiveLow or unsafeFromActiveHigh.

unsafeFromReset :: Reset dom -> Signal dom Bool

unsafeFromReset is unsafe because it can introduce:

• meta-stability

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.

NB: You probably want to use unsafeToActiveLow or unsafeToActiveHigh.

unsafeToActiveHigh :: forall dom. KnownDomain dom => Reset dom -> Signal dom Bool

Convert a reset to an active high reset. Has no effect if reset is already an active high reset. Is unsafe because it can introduce:

• meta-stability

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.

unsafeToActiveLow :: forall dom. KnownDomain dom => Reset dom -> Signal dom Bool

Convert a reset to an active low reset. Has no effect if reset is already an active low reset. It is unsafe because it can introduce:

• meta-stability

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.

unsafeFromActiveHigh

Arguments

:: forall dom. KnownDomain dom

=> Signal dom Bool

Reset signal that's True when active, and False when inactive.

-> Reset dom

Interpret a signal of bools as an active high reset and convert it to a reset signal corresponding to the domain's setting.

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.

unsafeFromActiveLow

Arguments

:: forall dom. KnownDomain dom

=> Signal dom Bool

Reset signal that's False when active, and True when inactive.

-> Reset dom

Interpret a signal of bools as an active low reset and convert it to a reset signal corresponding to the domain's setting.

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.

invertReset :: KnownDomain dom => Reset dom -> Reset dom

Invert reset signal

Basic circuits

delay# :: forall dom a. (KnownDomain dom, NFDataX a) => Clock dom -> Enable dom -> a -> Signal dom a -> Signal dom a

register#

Arguments

:: forall dom a. (KnownDomain dom, NFDataX a)

=> Clock dom

-> Reset dom

-> Enable dom

-> a

Power up value

-> a

Reset value

-> Signal dom a

-> Signal dom a

A register with a power up and reset value. Power up values are not supported on all platforms, please consult the manual of your target platform and check the notes below.

Xilinx: power up values and reset values MUST be the same. If they are not, the Xilinx tooling will ignore the reset value and use the power up value instead. Source: MIA

Intel: power up values and reset values MUST be the same. If they are not, the Intel tooling will ignore the power up value and use the reset value instead. Source: https://www.intel.com/content/www/us/en/programmable/support/support-resources/knowledge-base/solutions/rd01072011_91.html

asyncRegister#

Arguments

:: forall dom a. (KnownDomain dom, NFDataX a)

=> Clock dom

Clock signal

-> Reset dom

Reset signal

-> Enable dom

Enable signal

-> a

Power up value

-> a

Reset value

-> Signal dom a

-> Signal dom a

Version of register# that simulates a register on an asynchronous domain. Is synthesizable.

syncRegister#

Arguments

:: forall dom a. (KnownDomain dom, NFDataX a)

=> Clock dom

Clock signal

-> Reset dom

Reset signal

-> Enable dom

Enable signal

-> a

Power up value

-> a

Reset value

-> Signal dom a

-> Signal dom a

Version of register# that simulates a register on a synchronous domain. Not synthesizable.

registerPowerup# :: forall dom a. (KnownDomain dom, NFDataX a, HasCallStack) => Clock dom -> a -> a

Acts like id if given domain allows powerup values, but returns a value constructed with deepErrorX otherwise.

mux :: Applicative f => f Bool -> f a -> f a -> f a

The above type is a generalization for:

mux :: Signal Bool -> Signal a -> Signal a -> Signal a

A multiplexer. Given "mux b t f", output t when b is True, and f when b is False.

Simulation and testbench functions

clockGen :: KnownDomain dom => Clock dom

Clock generator for simulations. Do not use this clock generator for the testBench function, use tbClockGen instead.

To be used like:

clkSystem = clockGen @System

See DomainConfiguration for more information on how to use synthesis domains.

tbClockGen :: KnownDomain testDom => Signal testDom Bool -> Clock testDom

Clock generator to be used in the testBench function.

To be used like:

clkSystem en = tbClockGen @System en

Example

module Example where

import Clash.Explicit.Prelude
import Clash.Explicit.Testbench

-- Fast domain: twice as fast as "Slow"
createDomain vSystem{vName="Fast", vPeriod=10}

-- Slow domain: twice as slow as "Fast"
createDomain vSystem{vName="Slow", vPeriod=20}

topEntity
  :: Clock "Fast"
  -> Reset "Fast"
  -> Enable "Fast"
  -> Clock "Slow"
  -> Signal "Fast" (Unsigned 8)
  -> Signal "Slow" (Unsigned 8, Unsigned 8)
topEntity clk1 rst1 en1 clk2 i =
  let h = register clk1 rst1 en1 0 (register clk1 rst1 en1 0 i)
      l = register clk1 rst1 en1 0 i
  in  unsafeSynchronizer clk1 clk2 (bundle (h, l))

testBench
  :: Signal "Slow" Bool
testBench = done
  where
    testInput      = stimuliGenerator clkA1 rstA1 $(listToVecTH [1::Unsigned 8,2,3,4,5,6,7,8])
    expectedOutput = outputVerifier   clkB2 rstB2 $(listToVecTH [(0,0) :: (Unsigned 8, Unsigned 8),(1,2),(3,4),(5,6),(7,8)])
    done           = expectedOutput (topEntity clkA1 rstA1 enableGen clkB2 testInput)
    notDone        = not <$> done
    clkA1          = tbClockGen @"Fast" (unsafeSynchronizer clkB2 clkA1 notDone)
    clkB2          = tbClockGen @"Slow" notDone
    rstA1          = resetGen @"Fast"
    rstB2          = resetGen @"Slow"

newtype Femtoseconds

Femtoseconds expressed as an Int64. Is a newtype to prevent accidental mixups with picoseconds - the unit used in DomainConfiguration.

Constructors

Femtoseconds Int64

Instances

Eq Femtoseconds

Defined in Clash.Signal.Internal

Methods

(==) :: Femtoseconds -> Femtoseconds -> Bool

(/=) :: Femtoseconds -> Femtoseconds -> Bool

Ord Femtoseconds

Defined in Clash.Signal.Internal

Methods

compare :: Femtoseconds -> Femtoseconds -> Ordering

(<) :: Femtoseconds -> Femtoseconds -> Bool

(<=) :: Femtoseconds -> Femtoseconds -> Bool

(>) :: Femtoseconds -> Femtoseconds -> Bool

(>=) :: Femtoseconds -> Femtoseconds -> Bool

max :: Femtoseconds -> Femtoseconds -> Femtoseconds

min :: Femtoseconds -> Femtoseconds -> Femtoseconds

Show Femtoseconds

Defined in Clash.Signal.Internal

Methods

showsPrec :: Int -> Femtoseconds -> ShowS

show :: Femtoseconds -> String

showList :: [Femtoseconds] -> ShowS

Generic Femtoseconds

Defined in Clash.Signal.Internal

Associated Types

type Rep Femtoseconds :: Type -> Type

Methods

from :: Femtoseconds -> Rep Femtoseconds x

to :: Rep Femtoseconds x -> Femtoseconds

NFData Femtoseconds

Defined in Clash.Signal.Internal

Methods

rnf :: Femtoseconds -> ()

NFDataX Femtoseconds

Defined in Clash.Signal.Internal

Methods

deepErrorX :: String -> Femtoseconds

hasUndefined :: Femtoseconds -> Bool

ensureSpine :: Femtoseconds -> Femtoseconds

rnfX :: Femtoseconds -> ()

Lift Femtoseconds

Defined in Clash.Signal.Internal

Methods

lift :: Femtoseconds -> Q Exp

liftTyped :: Femtoseconds -> Q (TExp Femtoseconds)

type Rep Femtoseconds

Defined in Clash.Signal.Internal

type Rep Femtoseconds = D1 ('MetaData "Femtoseconds" "Clash.Signal.Internal" "clash-prelude-1.8.0-inplace" 'True) (C1 ('MetaCons "Femtoseconds" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

fsToHz :: (HasCallStack, Fractional a) => Femtoseconds -> a

Calculate the frequency in Hz, given the period in fs

I.e., to calculate the clock frequency of a clock with a period of 5000 fs:

>>> fsToHz (Femtoseconds 5000)
2.0e11

NB: This function is not synthesizable

hzToFs :: HasCallStack => Ratio Natural -> Femtoseconds

Calculate the period in fs, given a frequency in Hz

I.e., to calculate the clock period for a circuit to run at 240 MHz we get

>>> hzToFs 240e6
Femtoseconds 4166666

If the value hzToFs is applied to is not of the type Ratio Natural, you can use hzToFs (realToFrac f). Note that if f is negative, realToFrac will give an Underflow :: ArithException without a call stack, making debugging cumbersome.

• NB: This function is not synthesizable
• NB: This function is lossy. I.e., fsToHz . hzToFs /= id.

unFemtoseconds :: Femtoseconds -> Int64

Strip newtype wrapper Femtoseconds

mapFemtoseconds :: (Int64 -> Int64) -> Femtoseconds -> Femtoseconds

Map Int64 fields in Femtoseconds

tbDynamicClockGen

Arguments

:: KnownDomain dom

=> Signal dom Femtoseconds

Clock period in femtoseconds.

• NB: Beware that the periods are given in femtoseconds; this differs from the usual unit Clash uses to represent period length, picoseconds.
• NB: Beware that not all simulators support femtoseconds. For example, Vivado's XSIM will round down to nearest picoseconds.
• NB: Beware that, by default, Clash will define `timescale 100fs/100fs in its generated Verilog. The latter will make simulators round time to 100fs. If you rely on more precision you should pass -fclash-timescale-precision 1fs to Clash.

-> Signal dom Bool

-> Clock dom

Clock generator with dynamic clock periods for simulations. This is an experimental feature and hence not part of the public API. Like tbClockGen

To be used like:

clkSystem = dynamicClockGen @System

See DomainConfiguration for more information on how to use synthesis domains.

dynamicClockGen

Arguments

:: KnownDomain dom

=> Signal dom Femtoseconds

Clock period in femtoseconds.

• NB: Beware that the periods are given in femtoseconds; this differs from the usual unit Clash uses to represent period length, picoseconds.
• NB: Beware that not all simulators support femtoseconds. For example, Vivado's XSIM will round down to nearest picoseconds.
• NB: Beware that, by default, Clash will define `timescale 100fs/100fs in its generated Verilog. The latter will make simulators round time to 100fs. If you rely on more precision you should pass -fclash-timescale-precision 1fs to Clash.

-> Clock dom

Clock generator with dynamic clock periods for simulations. This is an experimental feature and hence not part of the public API.

To be used like:

clkSystem = dynamicClockGen @System

See DomainConfiguration for more information on how to use synthesis domains.

resetGen :: forall dom. KnownDomain dom => Reset dom

Reset generator for simulation purposes. Asserts the reset for a single cycle.

To be used like:

rstSystem = resetGen @System

See tbClockGen for example usage.

NB: While this can be used in the testBench function, it cannot be synthesized to hardware.

resetGenN

Arguments

:: forall dom n. (KnownDomain dom, 1 <= n)

=> SNat n

Number of initial cycles to hold reset high

-> Reset dom

Reset generator for simulation purposes. Asserts the reset for the first n cycles.

To be used like:

rstSystem5 = resetGen @System d5

Example usage:

>>> sampleN 7 (unsafeToActiveHigh (resetGenN @System d3))
[True,True,True,False,False,False,False]

NB: While this can be used in the testBench function, it cannot be synthesized to hardware.

Boolean connectives

(.&&.) :: Applicative f => f Bool -> f Bool -> f Bool infixr 3

The above type is a generalization for:

(.&&.) :: Signal Bool -> Signal Bool -> Signal Bool

It is a version of (&&) that returns a Signal of Bool

(.||.) :: Applicative f => f Bool -> f Bool -> f Bool infixr 2

The above type is a generalization for:

(.||.) :: Signal Bool -> Signal Bool -> Signal Bool

It is a version of (||) that returns a Signal of Bool

Simulation functions (not synthesizable)

simulate :: (NFDataX a, NFDataX b) => (Signal dom1 a -> Signal dom2 b) -> [a] -> [b]

Simulate a (Signal a -> Signal b) function given a list of samples of type a

>>> simulate (register systemClockGen resetGen enableGen 8) [1, 1, 2, 3]
[8,8,1,2,3...
...

NB: This function is not synthesizable

lazy version

simulate_lazy :: (Signal dom1 a -> Signal dom2 b) -> [a] -> [b]

Simulate a (Signal a -> Signal b) function given a list of samples of type a

>>> simulate (register systemClockGen resetGen enableGen 8) [1, 1, 2, 3]
[8,8,1,2,3...
...

NB: This function is not synthesizable

Automaton

signalAutomaton :: forall dom a b. (Signal dom a -> Signal dom b) -> Automaton (->) a b

Build an Automaton from a function over Signals.

NB: Consumption of continuation of the Automaton must be affine; that is, you can only apply the continuation associated with a particular element at most once.

List <-> Signal conversion (not synthesizable)

sample :: (Foldable f, NFDataX a) => f a -> [a]

The above type is a generalization for:

sample :: Signal a -> [a]

Get an infinite list of samples from a Signal

The elements in the list correspond to the values of the Signal at consecutive clock cycles

sample s == [s0, s1, s2, s3, ...

NB: This function is not synthesizable

sampleN :: (Foldable f, NFDataX a) => Int -> f a -> [a]

The above type is a generalization for:

sampleN :: Int -> Signal a -> [a]

Get a list of n samples from a Signal

The elements in the list correspond to the values of the Signal at consecutive clock cycles

sampleN 3 s == [s0, s1, s2]

NB: This function is not synthesizable

fromList :: NFDataX a => [a] -> Signal dom a

Create a Signal from a list

Every element in the list will correspond to a value of the signal for one clock cycle.

>>> sampleN 2 (fromList [1,2,3,4,5])
[1,2]

NB: This function is not synthesizable

lazy versions

sample_lazy :: Foldable f => f a -> [a]

The above type is a generalization for:

sample :: Signal a -> [a]

Get an infinite list of samples from a Signal

The elements in the list correspond to the values of the Signal at consecutive clock cycles

sample s == [s0, s1, s2, s3, ...

NB: This function is not synthesizable

sampleN_lazy :: Foldable f => Int -> f a -> [a]

The above type is a generalization for:

sampleN :: Int -> Signal a -> [a]

Get a list of n samples from a Signal

The elements in the list correspond to the values of the Signal at consecutive clock cycles

sampleN 3 s == [s0, s1, s2]

NB: This function is not synthesizable

fromList_lazy :: [a] -> Signal dom a

Create a Signal from a list

Every element in the list will correspond to a value of the signal for one clock cycle.

>>> sampleN 2 (fromList [1,2,3,4,5] :: Signal System Int)
[1,2]

NB: This function is not synthesizable

QuickCheck combinators

testFor :: Foldable f => Int -> f Bool -> Property

The above type is a generalization for:

testFor :: Int -> Signal Bool -> Property

testFor n s tests the signal s for n cycles.

NB: This function is not synthesizable

Type classes

Eq-like

(.==.) :: (Eq a, Applicative f) => f a -> f a -> f Bool infix 4

The above type is a generalization for:

(.==.) :: Eq a => Signal a -> Signal a -> Signal Bool

It is a version of (==) that returns a Signal of Bool

(./=.) :: (Eq a, Applicative f) => f a -> f a -> f Bool infix 4

The above type is a generalization for:

(./=.) :: Eq a => Signal a -> Signal a -> Signal Bool

It is a version of (/=) that returns a Signal of Bool

Ord-like

(.<.) :: (Ord a, Applicative f) => f a -> f a -> f Bool infix 4

The above type is a generalization for:

(.<.) :: Ord a => Signal a -> Signal a -> Signal Bool

It is a version of (<) that returns a Signal of Bool

(.<=.) :: (Ord a, Applicative f) => f a -> f a -> f Bool infix 4

The above type is a generalization for:

(.<=.) :: Ord a => Signal a -> Signal a -> Signal Bool

It is a version of (<=) that returns a Signal of Bool

(.>=.) :: (Ord a, Applicative f) => f a -> f a -> f Bool infix 4

The above type is a generalization for:

(.>=.) :: Ord a => Signal a -> Signal a -> Signal Bool

It is a version of (>=) that returns a Signal of Bool

(.>.) :: (Ord a, Applicative f) => f a -> f a -> f Bool infix 4

The above type is a generalization for:

(.>.) :: Ord a => Signal a -> Signal a -> Signal Bool

It is a version of (>) that returns a Signal of Bool

Functor

mapSignal# :: forall a b dom. (a -> b) -> Signal dom a -> Signal dom b

Applicative

signal# :: a -> Signal dom a

appSignal# :: Signal dom (a -> b) -> Signal dom a -> Signal dom b

Foldable

foldr# :: (a -> b -> b) -> b -> Signal dom a -> b

NB: Not synthesizable

NB: In "foldr# f z s":

• The function f should be lazy in its second argument.
• The z element will never be used.

Traversable

traverse# :: Applicative f => (a -> f b) -> Signal dom a -> f (Signal dom b)

EXTREMELY EXPERIMENTAL

joinSignal# :: Signal dom (Signal dom a) -> Signal dom a

WARNING: EXTREMELY EXPERIMENTAL

The circuit semantics of this operation are unclear and/or non-existent. There is a good reason there is no Monad instance for Signal.

Is currently treated as id by the Clash compiler.

Deprecated

unsafeFromHighPolarity

Arguments

:: forall dom. KnownDomain dom

=> Signal dom Bool

Reset signal that's True when active, and False when inactive.

-> Reset dom

Deprecated: Use unsafeFromActiveHigh instead. This function will be removed in Clash 1.12.

Interpret a signal of bools as an active high reset and convert it to a reset signal corresponding to the domain's setting.

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.

unsafeFromLowPolarity

Arguments

:: forall dom. KnownDomain dom

=> Signal dom Bool

Reset signal that's False when active, and True when inactive.

-> Reset dom

Deprecated: Use unsafeFromActiveLow instead. This function will be removed in Clash 1.12.

Interpret a signal of bools as an active low reset and convert it to a reset signal corresponding to the domain's setting.

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.

unsafeToHighPolarity :: forall dom. KnownDomain dom => Reset dom -> Signal dom Bool

Deprecated: Use unsafeToActiveHigh instead. This function will be removed in Clash 1.12.

Convert a reset to an active high reset. Has no effect if reset is already an active high reset. Is unsafe because it can introduce:

• meta-stability

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.

unsafeToLowPolarity :: forall dom. KnownDomain dom => Reset dom -> Signal dom Bool

Deprecated: Use unsafeToActiveLow instead. This function will be removed in Clash 1.12.

Convert a reset to an active low reset. Has no effect if reset is already an active low reset. It is unsafe because it can introduce:

• meta-stability

For asynchronous resets it is unsafe because it can cause combinatorial loops. In case of synchronous resets it can lead to meta-stability in the presence of asynchronous resets.