RetroClash.Utils

Documentation

withResetEnableGen :: KnownDomain dom => (HiddenClockResetEnable dom => r) -> Clock dom -> r

withEnableGen :: KnownDomain dom => (HiddenClockResetEnable dom => r) -> Clock dom -> Reset dom -> r

withStart :: HiddenClockResetEnable dom => a -> Signal dom a -> Signal dom a

data Polarity

Constructors

High

Low

Instances

Show Polarity

Defined in RetroClash.Utils

Methods

showsPrec :: Int -> Polarity -> ShowS

show :: Polarity -> String

showList :: [Polarity] -> ShowS

Eq Polarity

Defined in RetroClash.Utils

Methods

(==) :: Polarity -> Polarity -> Bool

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

data Active (p :: Polarity)

Instances

Generic (Active p)

Defined in RetroClash.Utils

Associated Types

type Rep (Active p) :: Type -> Type

Methods

from :: Active p -> Rep (Active p) x

to :: Rep (Active p) x -> Active p

Show (Active p)

Defined in RetroClash.Utils

Methods

showsPrec :: Int -> Active p -> ShowS

show :: Active p -> String

showList :: [Active p] -> ShowS

BitPack (Active p)

Defined in RetroClash.Utils

Associated Types

type BitSize (Active p) :: Nat

Methods

pack :: Active p -> BitVector (BitSize (Active p))

unpack :: BitVector (BitSize (Active p)) -> Active p

NFDataX (Active p)

Defined in RetroClash.Utils

Methods

deepErrorX :: String -> Active p

hasUndefined :: Active p -> Bool

ensureSpine :: Active p -> Active p

rnfX :: Active p -> ()

Eq (Active p)

Defined in RetroClash.Utils

Methods

(==) :: Active p -> Active p -> Bool

(/=) :: Active p -> Active p -> Bool

Ord (Active p)

Defined in RetroClash.Utils

Methods

compare :: Active p -> Active p -> Ordering

(<) :: Active p -> Active p -> Bool

(<=) :: Active p -> Active p -> Bool

(>) :: Active p -> Active p -> Bool

(>=) :: Active p -> Active p -> Bool

max :: Active p -> Active p -> Active p

min :: Active p -> Active p -> Active p

type Rep (Active p)

Defined in RetroClash.Utils

type Rep (Active p) = D1 ('MetaData "Active" "RetroClash.Utils" "retroclash-lib-0.1.2.2-8zTx05WshYzIbWBY4X0pgW" 'True) (C1 ('MetaCons "MkActive" 'PrefixI 'True) (S1 ('MetaSel ('Just "activeLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bit)))

type BitSize (Active p)

Defined in RetroClash.Utils

type BitSize (Active p) = CLog 2 (GConstructorCount (Rep (Active p))) + GFieldSize (Rep (Active p))

active :: Bit -> Active p

class IsActive p where

Methods

fromActive :: Active p -> Bool

toActive :: Bool -> Active p

Instances

IsActive 'High

Defined in RetroClash.Utils

Methods

fromActive :: Active 'High -> Bool

toActive :: Bool -> Active 'High

IsActive 'Low

Defined in RetroClash.Utils

Methods

fromActive :: Active 'Low -> Bool

toActive :: Bool -> Active 'Low

toActiveDyn :: Polarity -> Bool -> Bit

bitwise :: BitPack a => (BitVector (BitSize a) -> BitVector (BitSize a)) -> a -> a

parity :: forall a n. (BitPack a, BitSize a ~ (n + 1)) => a -> Bit

half :: Bits a => a -> a

halfIndex :: (KnownNat n, 1 <= (2 * n), CLog 2 (2 * n) ~ (CLog 2 n + 1)) => Index (2 * n) -> Index n

bvShiftL :: KnownNat n => BitVector n -> Bit -> (Bit, BitVector n)

bvShiftR :: KnownNat n => Bit -> BitVector n -> (BitVector n, Bit)

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

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

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

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

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

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

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

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

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

(.!!.) :: (KnownNat n, Enum i, Applicative f) => f (Vec n a) -> f i -> f a

(.!!) :: (KnownNat n, Enum i, Functor f) => f (Vec n a) -> i -> f a

(!!.) :: (KnownNat n, Enum i, Functor f) => Vec n a -> f i -> f a

changed :: (HiddenClockResetEnable dom, Eq a, NFDataX a) => a -> Signal dom a -> Signal dom Bool

integrate :: (Monoid a, NFDataX a, HiddenClockResetEnable dom) => Signal dom Bool -> Signal dom a -> Signal dom a

debounce :: forall ps a dom. (Eq a, NFDataX a, HiddenClockResetEnable dom, KnownNat (ClockDivider dom ps)) => SNat ps -> a -> Signal dom a -> Signal dom a

riseEveryWhen :: forall n dom. (HiddenClockResetEnable dom, KnownNat n) => SNat n -> Signal dom Bool -> Signal dom Bool

oscillateWhen :: HiddenClockResetEnable dom => Bool -> Signal dom Bool -> Signal dom Bool

oneHot :: forall n. KnownNat n => Index n -> Vec n Bool

roundRobin :: forall n dom a. (KnownNat n, HiddenClockResetEnable dom) => Signal dom Bool -> (Signal dom (Vec n Bool), Signal dom (Index n))

countFromTo :: (Eq a, Enum a, NFDataX a, HiddenClockResetEnable dom) => a -> a -> Signal dom Bool -> Signal dom a

nextIdx :: (Eq a, Enum a, Bounded a) => a -> a

prevIdx :: (Eq a, Enum a, Bounded a) => a -> a

succIdx :: (Eq a, Enum a, Bounded a) => a -> Maybe a

predIdx :: (Eq a, Enum a, Bounded a) => a -> Maybe a

moreIdx :: (Eq a, Enum a, Bounded a) => a -> a

lessIdx :: (Eq a, Enum a, Bounded a) => a -> a

mealyState :: (HiddenClockResetEnable dom, NFDataX s) => (i -> State s o) -> s -> Signal dom i -> Signal dom o

mealyStateB :: (HiddenClockResetEnable dom, NFDataX s, Bundle i, Bundle o) => (i -> State s o) -> s -> Unbundled dom i -> Unbundled dom o

mooreState :: (HiddenClockResetEnable dom, NFDataX s) => (i -> State s ()) -> (s -> o) -> s -> Signal dom i -> Signal dom o

mooreStateB :: (HiddenClockResetEnable dom, NFDataX s, Bundle i, Bundle o) => (i -> State s ()) -> (s -> o) -> s -> Unbundled dom i -> Unbundled dom o

enable :: Applicative f => f Bool -> f a -> f (Maybe a)

guardA :: (Applicative f, Alternative m) => f Bool -> f (m a) -> f (m a)

muxA :: (Foldable t, Alternative m, Applicative f) => t (f (m a)) -> f (m a)

(.<|>.) :: (Applicative f, Alternative m) => f (m a) -> f (m a) -> f (m a) infixl 3

(.|>.) :: Applicative f => f a -> f (Maybe a) -> f a infix 2

(|>.) :: Applicative f => a -> f (Maybe a) -> f a infix 2

(.<|.) :: Applicative f => f (Maybe a) -> f a -> f a infix 2

(.<|) :: Applicative f => f (Maybe a) -> a -> f a infix 2

muxMaybe :: Applicative f => f a -> f (Maybe a) -> f a

packWrite :: addr -> Maybe val -> Maybe (addr, val)

noWrite :: Applicative f => f (Maybe addr) -> f (Maybe (addr, Maybe wr))

withWrite :: Applicative f => f (Maybe addr) -> f (Maybe wr) -> f (Maybe (addr, Maybe wr))

singlePort :: Applicative f => (f addr -> f (Maybe (addr, wr)) -> r) -> f addr -> f (Maybe wr) -> r

unbraid :: (KnownNat n, KnownNat k, 1 <= n, 1 <= (n * (2 ^ k)), CLog 2 (2 ^ k) ~ k, CLog 2 (n * (2 ^ k)) ~ (CLog 2 n + k)) => Maybe (Index (n * (2 ^ k))) -> Vec (2 ^ k) (Maybe (Index n))

shifterL :: (BitPack a, HiddenClockResetEnable dom) => Signal dom (Maybe a) -> Signal dom Bool -> Signal dom Bit

shifterR :: (BitPack a, HiddenClockResetEnable dom) => Signal dom (Maybe a) -> Signal dom Bool -> Signal dom Bit