clash-multisignal (empty) → 0.1.0.0

raw patch · 5 files changed

+259/−0 lines, 5 filesdep +QuickCheckdep +basedep +clash-preludesetup-changed

Dependencies added: QuickCheck, base, clash-prelude

Files

ChangeLog.md +5/−0
LICENSE +30/−0
Setup.hs +2/−0
clash-multisignal.cabal +35/−0
src/CLaSH/Signal/MultiSignal.hs +187/−0

+ ChangeLog.md view

@@ -0,0 +1,5 @@+# Revision history for MultiSignal++## 0.1.0.0  -- 2017-01-08++* First version. Released on an unsuspecting world.

+ LICENSE view

@@ -0,0 +1,30 @@+Copyright (c) 2017, Luka Rahne++All rights reserved.++Redistribution and use in source and binary forms, with or without+modification, are permitted provided that the following conditions are met:++    * Redistributions of source code must retain the above copyright+      notice, this list of conditions and the following disclaimer.++    * Redistributions in binary form must reproduce the above+      copyright notice, this list of conditions and the following+      disclaimer in the documentation and/or other materials provided+      with the distribution.++    * Neither the name of Luka Rahne nor the names of other+      contributors may be used to endorse or promote products derived+      from this software without specific prior written permission.++THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+ Setup.hs view

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

+ clash-multisignal.cabal view

@@ -0,0 +1,35 @@+-- Initial MultiSignal.cabal generated by cabal init.  For further +-- documentation, see http://haskell.org/cabal/users-guide/++name:                clash-multisignal+version:             0.1.0.0+-- synopsis:            +description:         Clash/Fpga library for working with multiple elements arriving at same clock as stream.+license:             BSD3+license-file:        LICENSE+author:              Luka Rahne+maintainer:          luka.rahne@gmail.com+copyright:           Luka Rahne+category:            Hardware+build-type:          Simple+extra-source-files:  ChangeLog.md+cabal-version:       >=1.10+homepage:            https://github.com/ra1u/clash-multisignal++library+  exposed-modules:  CLaSH.Signal.MultiSignal+  -- other-modules:       +  -- other-extensions:   + +  -- we use Functor and Applicative from base +  build-depends:       base > 4.0 && < 5.0, +                       clash-prelude >= 0.10 && < 0.12 ,+                       QuickCheck+  hs-source-dirs:      src+  default-language:    Haskell2010+  ghc-options: -fexpose-all-unfoldings+++source-repository head+  type:     git+  location: github.com:ra1u/clash-multisignal.git

+ src/CLaSH/Signal/MultiSignal.hs view

@@ -0,0 +1,187 @@+{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE TypeOperators #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE ScopedTypeVariables   #-}+{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE ConstraintKinds #-}+++module CLaSH.Signal.MultiSignal (+    MultiSignal (..) ,+    -- * Prependable+    Prependable(..) ,+    -- * Utility functions+    SignalLike(..),+    mealyP ,+    mooreP ,+    windowP +) where++import qualified Data.Foldable as F+import qualified Prelude +import CLaSH.Prelude as P+import CLaSH.Signal.Explicit as SE+import Test.QuickCheck (Arbitrary(..),CoArbitrary(..))+++-- Stream of elements where n elements arrives at same clock+data MultiSignal n a = MultiSignal {unMultiSignal :: Signal (Vec n a) } +++instance Functor (MultiSignal n) where+    fmap f s = MultiSignal ( fmap ( fmap f ) ( unMultiSignal s ) )+++instance KnownNat n => Applicative (MultiSignal n) where+   pure = MultiSignal . pure . pure +   f <*> s = MultiSignal  (fmap (<*>) fu <*> su) where+      fu = unMultiSignal f+      su = unMultiSignal s+++instance Foldable (MultiSignal n) where+    foldr f x xs = (F.foldr (.) id xs') x where +        xs' = (\ys y -> P.foldr f y ys) <$> unMultiSignal xs       +++instance (KnownNat m, m ~ (n+1)) => Traversable (MultiSignal m) where+    traverse f xs = MultiSignal <$> sequenceA (fmap (traverse f) (unMultiSignal xs))+++instance (Num a,KnownNat n) => Num (MultiSignal n a) where+    (+) = liftA2 (+)+    (*) = liftA2 (*) +    abs = fmap abs+    signum = fmap signum+    fromInteger = pure . fromInteger+    negate = fmap negate+++instance Eq (MultiSignal n a) where+   (==) = error "(==)' undefined for 'MultiSignal', use '(.==.)' instead"+   (/=) = error "(/=)' undefined for 'MultiSignal', use '(./=.)' instead"+++instance  (Bounded a,KnownNat n)  =>  Bounded (MultiSignal n a) where+    minBound = pure minBound +    maxBound = pure maxBound+++instance (Fractional a,KnownNat n) => Fractional (MultiSignal n a) where+  (/)          = liftA2 (/)+  recip        = fmap recip+  fromRational = pure . fromRational+++instance Show a => Show (MultiSignal n a) where+  show x = foldMap ( \a -> mappend (show a) " ") x+++instance (Arbitrary a,KnownNat n) => Arbitrary (MultiSignal n a) where+  arbitrary  = MultiSignal <$> arbitrary+++instance (CoArbitrary a) => CoArbitrary (MultiSignal n a) where+  coarbitrary  = coarbitrary . unMultiSignal +++instance (FiniteBits a,KnownNat n) => FiniteBits (MultiSignal n a) where+  finiteBitSize _ = finiteBitSize (undefined :: a)+++instance (Bits a,KnownNat n) => Bits (MultiSignal n a) where+  (.&.)            = liftA2 (.&.)+  (.|.)            = liftA2 (.|.)+  xor              = liftA2 xor+  complement       = fmap complement+  shift a i        = fmap (`shift` i) a+  rotate a i       = fmap (`rotate` i) a+  zeroBits         = pure zeroBits+  bit              = pure . bit+  setBit a i       = fmap (`setBit` i) a+  clearBit a i     = fmap (`clearBit` i) a+  testBit          = error "'testBit' undefined for 'Signal'', use 'testbit1'"+  bitSizeMaybe _   = bitSizeMaybe (undefined :: a)+  bitSize _        = maybe 0 id (bitSizeMaybe (undefined :: a))+  isSigned _       = isSigned (undefined :: a)+  shiftL a i       = fmap (`shiftL` i) a+  unsafeShiftL a i = fmap (`unsafeShiftL` i) a+  shiftR a i       = fmap (`shiftR` i) a+  unsafeShiftR a i = fmap (`unsafeShiftR` i) a+  rotateL a i      = fmap (`rotateL` i) a+  rotateR a i      = fmap (`rotateR` i) a+  popCount         = error "'popCount' undefined for 'Signal'', use 'popCount1'"+++instance (Default a,KnownNat n, n ~ (m+1)) => Default (MultiSignal n a) where+  def = pure def+++instance (SaturatingNum a,KnownNat n, n ~ (m+1)) => SaturatingNum (MultiSignal n a) where+  satPlus = liftA2 . satPlus+  satMin = liftA2 . satMin+  satMult = liftA2 . satMult+++instance (ExtendingNum a b,KnownNat n, n ~ (m+1)) => ExtendingNum (MultiSignal n a) (MultiSignal n b) where+  type AResult (MultiSignal n a) (MultiSignal n b) = MultiSignal n (AResult a b)+  plus  = liftA2 plus+  minus = liftA2 minus+  type MResult (MultiSignal n  a) (MultiSignal n b) = MultiSignal n (MResult a b)+  times = liftA2 times++-- | Constraints synonym+type SignalLike f = (Prependable f, Applicative f) ++mealyP :: (SignalLike f) +       => (s -> i -> (s,o)) -- ^ Transfer function in mealy machine form:+                           -- @state -> input -> (newstate,output)@+      -> s                 -- ^ Initial state+      -> (f i -> f o)+      -- ^ Synchronous sequential function with input and output matching that+      -- of the mealy machine+mealyP f d i = o where+   r = f <$> prepend d s <*> i+   s = fst <$> r+   o = snd <$> r+++mooreP :: (SignalLike f) +       => (s -> i -> s) -- ^ Transfer function in moore machine form:+                       -- @state -> input -> newstate@+      -> (s -> o)      -- ^ Output function in moore machine form:+                       -- @state -> output@+      -> s             -- ^ Initial state+      -> (f i -> f o)  -- ^ Synchronous sequential function with input and output matching that+                       -- of the moore machine+mooreP fs fo s i = fmap fo r where+     r = fs <$> prepend s r <*> i +++windowP :: (KnownNat n, Default a, SignalLike f)+       => f a               -- ^ 'SignalLike' to create a window over+       -> Vec n (f a)       -- ^ Vector of signals+windowP  x = iterateI (prepend def) x++-- Prependable++-- |+-- class that can be prepended+--+-- [/rule/]+--+--      @ toList ('prepend' a ax) == a : toList ax @+--+class Prependable f where+   prepend :: a -> f a -> f a++instance Prependable ZipList where+   prepend x xs = ZipList (x : getZipList xs)++instance (KnownNat n, n ~ (m+1)) => Prependable (MultiSignal n) where+    prepend x (MultiSignal s) = +         MultiSignal $ liftA2 (+>>) (register x (fmap last s)) s++instance Prependable (Signal' SE.SystemClock) where+   prepend = P.register