Clash.Signal.Delayed.Internal

Delay-annotated synchronous signals

newtype DSignal (dom :: Domain) (delay :: Nat) a

A synchronized signal with samples of type a, synchronized to clock clk, that has accumulated delay amount of samples delay along its path.

DSignal has the type role

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

as it is safe to coerce the values in the signal, but not safe to coerce the synthesis domain or delay in the signal.

Constructors

DSignal

Fields

• toSignal :: Signal dom a

  Strip a DSignal of its delay information.

Instances

Lift a => Lift (DSignal dom delay a :: Type)

Defined in Clash.Signal.Delayed.Internal

Methods

lift :: DSignal dom delay a -> Q Exp

liftTyped :: DSignal dom delay a -> Q (TExp (DSignal dom delay a))

Functor (DSignal dom delay)

Defined in Clash.Signal.Delayed.Internal

Methods

fmap :: (a -> b) -> DSignal dom delay a -> DSignal dom delay b

(<$) :: a -> DSignal dom delay b -> DSignal dom delay a

Applicative (DSignal dom delay)

Defined in Clash.Signal.Delayed.Internal

Methods

pure :: a -> DSignal dom delay a

(<*>) :: DSignal dom delay (a -> b) -> DSignal dom delay a -> DSignal dom delay b

liftA2 :: (a -> b -> c) -> DSignal dom delay a -> DSignal dom delay b -> DSignal dom delay c

(*>) :: DSignal dom delay a -> DSignal dom delay b -> DSignal dom delay b

(<*) :: DSignal dom delay a -> DSignal dom delay b -> DSignal dom delay a

Foldable (DSignal dom delay)

Defined in Clash.Signal.Delayed.Internal

Methods

fold :: Monoid m => DSignal dom delay m -> m

foldMap :: Monoid m => (a -> m) -> DSignal dom delay a -> m

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

foldr :: (a -> b -> b) -> b -> DSignal dom delay a -> b

foldr' :: (a -> b -> b) -> b -> DSignal dom delay a -> b

foldl :: (b -> a -> b) -> b -> DSignal dom delay a -> b

foldl' :: (b -> a -> b) -> b -> DSignal dom delay a -> b

foldr1 :: (a -> a -> a) -> DSignal dom delay a -> a

foldl1 :: (a -> a -> a) -> DSignal dom delay a -> a

toList :: DSignal dom delay a -> [a]

null :: DSignal dom delay a -> Bool

length :: DSignal dom delay a -> Int

elem :: Eq a => a -> DSignal dom delay a -> Bool

maximum :: Ord a => DSignal dom delay a -> a

minimum :: Ord a => DSignal dom delay a -> a

sum :: Num a => DSignal dom delay a -> a

product :: Num a => DSignal dom delay a -> a

Traversable (DSignal dom delay)

Defined in Clash.Signal.Delayed.Internal

Methods

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

sequenceA :: Applicative f => DSignal dom delay (f a) -> f (DSignal dom delay a)

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

sequence :: Monad m => DSignal dom delay (m a) -> m (DSignal dom delay a)

Fractional a => Fractional (DSignal dom delay a)

Defined in Clash.Signal.Delayed.Internal

Methods

(/) :: DSignal dom delay a -> DSignal dom delay a -> DSignal dom delay a

recip :: DSignal dom delay a -> DSignal dom delay a

fromRational :: Rational -> DSignal dom delay a

Num a => Num (DSignal dom delay a)

Defined in Clash.Signal.Delayed.Internal

Methods

(+) :: DSignal dom delay a -> DSignal dom delay a -> DSignal dom delay a

(-) :: DSignal dom delay a -> DSignal dom delay a -> DSignal dom delay a

(*) :: DSignal dom delay a -> DSignal dom delay a -> DSignal dom delay a

negate :: DSignal dom delay a -> DSignal dom delay a

abs :: DSignal dom delay a -> DSignal dom delay a

signum :: DSignal dom delay a -> DSignal dom delay a

fromInteger :: Integer -> DSignal dom delay a

Show a => Show (DSignal dom delay a)

Defined in Clash.Signal.Delayed.Internal

Methods

showsPrec :: Int -> DSignal dom delay a -> ShowS

show :: DSignal dom delay a -> String

showList :: [DSignal dom delay a] -> ShowS

Arbitrary a => Arbitrary (DSignal dom delay a)

Defined in Clash.Signal.Delayed.Internal

Methods

arbitrary :: Gen (DSignal dom delay a)

shrink :: DSignal dom delay a -> [DSignal dom delay a]

CoArbitrary a => CoArbitrary (DSignal dom delay a)

Defined in Clash.Signal.Delayed.Internal

Methods

coarbitrary :: DSignal dom delay a -> Gen b -> Gen b

Default a => Default (DSignal dom delay a)

Defined in Clash.Signal.Delayed.Internal

Methods

def :: DSignal dom delay a

type HasDomain dom1 (DSignal dom2 delay a)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (DSignal dom2 delay a) = DomEq dom1 dom2

type TryDomain t (DSignal dom delay a)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (DSignal dom delay a) = 'Found dom

feedback :: (DSignal dom n a -> (DSignal dom n a, DSignal dom ((n + m) + 1) a)) -> DSignal dom n a

Feed the delayed result of a function back to its input:

mac :: Clock dom -> Reset dom -> Enable dom
    -> DSignal dom 0 Int -> DSignal dom 0 Int -> DSignal dom 0 Int
mac clk rst en x y = feedback (mac' x y)
  where
    mac' :: DSignal dom 0 Int -> DSignal dom 0 Int -> DSignal dom 0 Int
         -> (DSignal dom 0 Int, DSignal dom 1 Int)
    mac' a b acc = let acc' = a * b + acc
                   in  (acc, delayedI clk rst en 0 acc')

>>> sampleN 7 (mac systemClockGen systemResetGen enableGen (dfromList [0..]) (dfromList [0..]))
[0,0,1,5,14,30,55]

fromSignal :: Signal dom a -> DSignal dom 0 a

Signals are not delayed

sample s == dsample (fromSignal s)

List <-> DSignal conversion (not synthesizable)

dfromList :: NFDataX a => [a] -> DSignal dom 0 a

Create a DSignal from a list

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

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

NB: This function is not synthesizable

lazy versions

dfromList_lazy :: [a] -> DSignal dom 0 a

Create a DSignal from a list

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

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

NB: This function is not synthesizable

Experimental

unsafeFromSignal :: Signal dom a -> DSignal dom n a

EXPERIMENTAL

Unsafely convert a Signal to a DSignal with an arbitrary delay.

NB: Should only be used to interface with functions specified in terms of Signal.

antiDelay :: SNat d -> DSignal dom (n + d) a -> DSignal dom n a

EXPERIMENTAL

Access a delayed signal in the present.

mac :: Clock dom -> Reset dom -> Enable dom
    -> DSignal dom 0 Int -> DSignal dom 0 Int -> DSignal dom 0 Int
mac clk rst en x y = acc'
  where
    acc' = (x * y) + antiDelay d1 acc
    acc  = delayedI clk rst en 0 acc'