CLaSH.Signal

Implicitly clocked synchronous signal

type Signal a = Signal' SystemClock a

Signal synchronised to the "system" clock, which has a period of 1000.

Basic circuit functions

signal :: Applicative f => a -> f a

The above type is a generalisation for:

signal :: a -> Signal a

Create a constant Signal from a combinational value

>>> sampleN 5 (signal 4 :: Signal Int)
[4,4,4,4,4]

register :: a -> Signal a -> Signal a infixr 3

register i s delays the values in Signal s for one cycle, and sets the value at time 0 to i

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

registerMaybe :: a -> Signal (Maybe a) -> Signal a infixr 3

regEn :: a -> Signal Bool -> Signal a -> Signal a

Version of register that only updates its content when its second argument is asserted. So given:

oscillate = register False (not1 <$> oscillate)
count     = regEn 0 oscillate (count + 1)

We get:

>>> sampleN 8 oscillate
[False,True,False,True,False,True,False,True]
>>> sampleN 8 count
[0,0,1,1,2,2,3,3]

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

The above type is a generalisation 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.

Boolean connectives

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

The above type is a generalisation 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 generalisation for:

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

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

not1 :: Functor f => f Bool -> f Bool

Deprecated: not1 will be removed in clash-prelude-1.0, use "fmap not" instead.

The above type is a generalisation for:

not1 :: Signal Bool -> Signal Bool

It is a version of not that operates on Signals of Bool

Product/Signal isomorphism

class Bundle a where

Isomorphism between a Signal of a product type (e.g. a tuple) and a product type of Signal's.

Instances of 'bundle must satisfy the following laws:

bundle . unbundle = id
unbundle . bundle = id

By default, bundle and unbundle, are defined as the identity, that is, writing:

data D = A | B

instance 'bundle D

is the same as:

data D = A | B

instance 'bundle D where
  type Unbundled' clk D = Signal' clk D
  bundle   _ s = s
  unbundle _ s = s

Associated Types

type Unbundled' (clk :: Clock) a = res | res -> clk

Methods

bundle :: Unbundled' clk a -> Signal' clk a

Example:

bundle :: (Signal' clk a, Signal' clk b) -> Signal' clk (a,b)

However:

bundle :: Signal' clk Bit -> Signal' clk Bit

bundle :: Signal' clk a -> Signal' clk a

Example:

bundle :: (Signal' clk a, Signal' clk b) -> Signal' clk (a,b)

However:

bundle :: Signal' clk Bit -> Signal' clk Bit

unbundle :: Signal' clk a -> Unbundled' clk a

Example:

unbundle :: Signal' clk (a,b) -> (Signal' clk a, Signal' clk b)

However:

unbundle :: Signal' clk Bit -> Signal' clk Bit

unbundle :: Signal' clk a -> Signal' clk a

Example:

unbundle :: Signal' clk (a,b) -> (Signal' clk a, Signal' clk b)

However:

unbundle :: Signal' clk Bit -> Signal' clk Bit

Instances

Bundle Bool

Associated Types

type Unbundled' (clk :: Clock) Bool = (res :: *)

Methods

bundle :: Unbundled' clk Bool -> Signal' clk Bool

unbundle :: Signal' clk Bool -> Unbundled' clk Bool

Bundle Double

Associated Types

type Unbundled' (clk :: Clock) Double = (res :: *)

Methods

bundle :: Unbundled' clk Double -> Signal' clk Double

unbundle :: Signal' clk Double -> Unbundled' clk Double

Bundle Float

Associated Types

type Unbundled' (clk :: Clock) Float = (res :: *)

Methods

bundle :: Unbundled' clk Float -> Signal' clk Float

unbundle :: Signal' clk Float -> Unbundled' clk Float

Bundle Int

Associated Types

type Unbundled' (clk :: Clock) Int = (res :: *)

Methods

bundle :: Unbundled' clk Int -> Signal' clk Int

unbundle :: Signal' clk Int -> Unbundled' clk Int

Bundle Integer

Associated Types

type Unbundled' (clk :: Clock) Integer = (res :: *)

Methods

bundle :: Unbundled' clk Integer -> Signal' clk Integer

unbundle :: Signal' clk Integer -> Unbundled' clk Integer

Bundle ()

Note that:

bundle   :: () -> Signal' clk ()
unbundle :: Signal' clk () -> ()

Associated Types

type Unbundled' (clk :: Clock) () = (res :: *)

Methods

bundle :: Unbundled' clk () -> Signal' clk ()

unbundle :: Signal' clk () -> Unbundled' clk ()

Bundle (Maybe a)

Associated Types

type Unbundled' (clk :: Clock) (Maybe a) = (res :: *)

Methods

bundle :: Unbundled' clk (Maybe a) -> Signal' clk (Maybe a)

unbundle :: Signal' clk (Maybe a) -> Unbundled' clk (Maybe a)

Bundle (Index n)

Associated Types

type Unbundled' (clk :: Clock) (Index n) = (res :: *)

Methods

bundle :: Unbundled' clk (Index n) -> Signal' clk (Index n)

unbundle :: Signal' clk (Index n) -> Unbundled' clk (Index n)

Bundle (BitVector n)

Associated Types

type Unbundled' (clk :: Clock) (BitVector n) = (res :: *)

Methods

bundle :: Unbundled' clk (BitVector n) -> Signal' clk (BitVector n)

unbundle :: Signal' clk (BitVector n) -> Unbundled' clk (BitVector n)

Bundle (Signed n)

Associated Types

type Unbundled' (clk :: Clock) (Signed n) = (res :: *)

Methods

bundle :: Unbundled' clk (Signed n) -> Signal' clk (Signed n)

unbundle :: Signal' clk (Signed n) -> Unbundled' clk (Signed n)

Bundle (Unsigned n)

Associated Types

type Unbundled' (clk :: Clock) (Unsigned n) = (res :: *)

Methods

bundle :: Unbundled' clk (Unsigned n) -> Signal' clk (Unsigned n)

unbundle :: Signal' clk (Unsigned n) -> Unbundled' clk (Unsigned n)

Bundle (Either a b)

Associated Types

type Unbundled' (clk :: Clock) (Either a b) = (res :: *)

Methods

bundle :: Unbundled' clk (Either a b) -> Signal' clk (Either a b)

unbundle :: Signal' clk (Either a b) -> Unbundled' clk (Either a b)

Bundle (a, b)

Associated Types

type Unbundled' (clk :: Clock) (a, b) = (res :: *)

Methods

bundle :: Unbundled' clk (a, b) -> Signal' clk (a, b)

unbundle :: Signal' clk (a, b) -> Unbundled' clk (a, b)

KnownNat n => Bundle (Vec n a)

Associated Types

type Unbundled' (clk :: Clock) (Vec n a) = (res :: *)

Methods

bundle :: Unbundled' clk (Vec n a) -> Signal' clk (Vec n a)

unbundle :: Signal' clk (Vec n a) -> Unbundled' clk (Vec n a)

KnownNat d => Bundle (RTree d a)

Associated Types

type Unbundled' (clk :: Clock) (RTree d a) = (res :: *)

Methods

bundle :: Unbundled' clk (RTree d a) -> Signal' clk (RTree d a)

unbundle :: Signal' clk (RTree d a) -> Unbundled' clk (RTree d a)

Bundle (a, b, c)

Associated Types

type Unbundled' (clk :: Clock) (a, b, c) = (res :: *)

Methods

bundle :: Unbundled' clk (a, b, c) -> Signal' clk (a, b, c)

unbundle :: Signal' clk (a, b, c) -> Unbundled' clk (a, b, c)

Bundle (Fixed rep int frac)

Associated Types

type Unbundled' (clk :: Clock) (Fixed rep int frac) = (res :: *)

Methods

bundle :: Unbundled' clk (Fixed rep int frac) -> Signal' clk (Fixed rep int frac)

unbundle :: Signal' clk (Fixed rep int frac) -> Unbundled' clk (Fixed rep int frac)

Bundle (a, b, c, d)

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d) = (res :: *)

Methods

bundle :: Unbundled' clk (a, b, c, d) -> Signal' clk (a, b, c, d)

unbundle :: Signal' clk (a, b, c, d) -> Unbundled' clk (a, b, c, d)

Bundle (a, b, c, d, e)

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d, e) = (res :: *)

Methods

bundle :: Unbundled' clk (a, b, c, d, e) -> Signal' clk (a, b, c, d, e)

unbundle :: Signal' clk (a, b, c, d, e) -> Unbundled' clk (a, b, c, d, e)

Bundle (a, b, c, d, e, f)

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d, e, f) = (res :: *)

Methods

bundle :: Unbundled' clk (a, b, c, d, e, f) -> Signal' clk (a, b, c, d, e, f)

unbundle :: Signal' clk (a, b, c, d, e, f) -> Unbundled' clk (a, b, c, d, e, f)

Bundle (a, b, c, d, e, f, g)

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d, e, f, g) = (res :: *)

Methods

bundle :: Unbundled' clk (a, b, c, d, e, f, g) -> Signal' clk (a, b, c, d, e, f, g)

unbundle :: Signal' clk (a, b, c, d, e, f, g) -> Unbundled' clk (a, b, c, d, e, f, g)

Bundle (a, b, c, d, e, f, g, h)

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d, e, f, g, h) = (res :: *)

Methods

bundle :: Unbundled' clk (a, b, c, d, e, f, g, h) -> Signal' clk (a, b, c, d, e, f, g, h)

unbundle :: Signal' clk (a, b, c, d, e, f, g, h) -> Unbundled' clk (a, b, c, d, e, f, g, h)

type Unbundled a = Unbundled' SystemClock a

Isomorphism between a Signal of a product type (e.g. a tuple) and a product type of Signals.

Simulation functions (not synthesisable)

simulate :: (NFData a, NFData b) => (Signal' clk1 a -> Signal' clk2 b) -> [a] -> [b]

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

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

NB: This function is not synthesisable

simulateB :: (Bundle a, Bundle b, NFData a, NFData b) => (Unbundled' clk1 a -> Unbundled' clk2 b) -> [a] -> [b]

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

>>> simulateB (unbundle . register (8,8) . bundle) [(1,1), (2,2), (3,3)] :: [(Int,Int)]
[(8,8),(1,1),(2,2),(3,3)...
...

NB: This function is not synthesisable

lazy versions

simulate_lazy :: (Signal' clk1 a -> Signal' clk2 b) -> [a] -> [b]

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

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

NB: This function is not synthesisable

simulateB_lazy :: (Bundle a, Bundle b) => (Unbundled' clk1 a -> Unbundled' clk2 b) -> [a] -> [b]

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

>>> simulateB (unbundle . register (8,8) . bundle) [(1,1), (2,2), (3,3)] :: [(Int,Int)]
[(8,8),(1,1),(2,2),(3,3)...
...

NB: This function is not synthesisable

List <-> Signal conversion (not synthesisable)

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

The above type is a generalisation 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 synthesisable

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

The above type is a generalisation 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 synthesisable

fromList :: NFData a => [a] -> Signal' clk 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 synthesisable

lazy versions

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

The above type is a generalisation 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 synthesisable

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

The above type is a generalisation 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 synthesisable

fromList_lazy :: [a] -> Signal' clk 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 synthesisable

QuickCheck combinators

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

The above type is a generalisation for:

testFor :: Int -> Signal Bool -> Property

testFor n s tests the signal s for n cycles.

Type classes

Eq-like

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

The above type is a generalisation 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 generalisation for:

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

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

Ord-like

compare1 :: (Ord a, Applicative f) => f a -> f a -> f Ordering

Deprecated: compare1 will be removed in clash-prelude-1.0, use "liftA2 compare" instead.

The above type is a generalisation for:

compare1 :: Ord a => Signal a -> Signal a -> Signal Ordering

It is a version of compare that returns a Signal of Ordering

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

The above type is a generalisation 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 generalisation 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 generalisation 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 generalisation for:

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

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

Enum-like

fromEnum1 :: (Enum a, Functor f) => f a -> f Int

Deprecated: fromEnum1 will be removed in clash-prelude-1.0, use "fmap fromEnum" instead.

The above type is a generalisation for:

fromEnum1 :: Enum a => Signal a -> Signal Int

It is a version of fromEnum that returns a CLaSH.Signal.Signal' of Int

Rational-like

toRational1 :: (Real a, Functor f) => f a -> f Rational

Deprecated: toRational1 will be removed in clash-prelude-1.0, use "fmap toRational" instead.

The above type is a generalisation for:

toRational1 :: Real a => Signal a -> Signal Rational

It is a version of toRational that returns a Signal of Rational

Integral-like

toInteger1 :: (Integral a, Functor f) => f a -> f Integer

Deprecated: toInteger1 will be removed in clash-prelude-1.0, use "fmap toInteger" instead.

The above type is a generalisation for:

toInteger1 :: Integral a => Signal a -> Signal Integer

It is a version of toRational that returns a Signal of Integer

Bits-like

testBit1 :: (Bits a, Applicative f) => f a -> f Int -> f Bool

Deprecated: testBit1 will be removed in clash-prelude-1.0, use "liftA2 testBit" instead.

The above type is a generalisation for:

testBit1 :: Bits a => Signal a -> Signal Int -> Signal Bool

It is a version of testBit that has a Signal of Int as indexing argument, and a result of Signal of Bool

popCount1 :: (Bits a, Functor f) => f a -> f Int

Deprecated: popCount1 will be removed in clash-prelude-1.0, use "fmap popCount" instead.

The above type is a generalisation for:

popCount1 :: Bits a => Signal a -> Signal Int

It is a version of popCount that returns a Signal of Int

shift1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: shift1 will be removed in clash-prelude-1.0, use "liftA2 shift" instead.

The above type is a generalisation for:

shift1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of shift that has a Signal of Int as indexing argument

rotate1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: rotate1 will be removed in clash-prelude-1.0, use "liftA2 rotate" instead.

The above type is a generalisation for:

rotate1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of rotate that has a Signal of Int as indexing argument

setBit1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: setBit1 will be removed in clash-prelude-1.0, use "liftA2 setBit" instead.

The above type is a generalisation for:

setBit1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of setBit that has a Signal of Int as indexing argument

clearBit1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: clearBit1 will be removed in clash-prelude-1.0, use "liftA2 clearBit" instead.

The above type is a generalisation for:

clearBit1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of clearBit that has a Signal of Int as indexing argument

shiftL1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: shiftL1 will be removed in clash-prelude-1.0, use "liftA2 shiftL" instead.

The above type is a generalisation for:

shiftL1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of shiftL that has a Signal of Int as indexing argument

unsafeShiftL1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: unsafeShiftL1 will be removed in clash-prelude-1.0, use "liftA2 unsafeShiftL" instead.

The above type is a generalisation for:

unsafeShiftL1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of unsafeShiftL that has a Signal of Int as indexing argument

shiftR1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: shiftR1 will be removed in clash-prelude-1.0, use "liftA2 shiftR" instead.

The above type is a generalisation for:

shiftR1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of shiftR that has a Signal of Int as indexing argument

unsafeShiftR1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: unsafeShiftR1 will be removed in clash-prelude-1.0, use "liftA2 unsafeShiftR" instead.

The above type is a generalisation for:

unsafeShiftR1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of unsafeShiftR that has a Signal of Int as indexing argument

rotateL1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: rotateL1 will be removed in clash-prelude-1.0, use "liftA2 rotateL" instead.

The above type is a generalisation for:

rotateL1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of rotateL that has a Signal of Int as indexing argument

rotateR1 :: (Bits a, Applicative f) => f a -> f Int -> f a

Deprecated: rotateR1 will be removed in clash-prelude-1.0, use "liftA2 rotateR" instead.

The above type is a generalisation for:

rotateR1 :: Bits a => Signal a -> Signal Int -> Signal a

It is a version of rotateR that has a Signal of Int as indexing argument