Merge pull request #2601 from clash-lang/random-stuff13

Various small fixes - part 13

Author: christiaanb

STYLE.rst

@@ -45,9 +45,9 @@ space. Some examples:
      where
       greeting name = "Hello, " ++ name ++ "!"
 
-    filter 
-      :: (a -> Bool) 
-      -> [a] 
+    filter
+      :: (a -> Bool)
+      -> [a]
       -> [a]
     filter _ [] = []
     filter p (x:xs)
@@ -86,11 +86,11 @@ instead. An example of a multiline tuple declaration is:
       ( a
       , b
       , c )
-      
-    goodMulti2 = 
+
+    goodMulti2 =
       ( a
       , b
-      , c 
+      , c
       )
 
 Use nested tuples as such:
@@ -114,7 +114,7 @@ multiple constructors, each constructor will get its own line. Example:
 
 .. code:: haskell
 
-    data Tree a 
+    data Tree a
       = Branch !a !(Tree a) !(Tree a)
       | Leaf
       deriving (Eq, Show)
@@ -123,12 +123,12 @@ Data types deriving lots of instances may be written like:
 
 .. code:: haskell
 
-    data Tree a 
+    data Tree a
       = Branch !a !(Tree a) !(Tree a)
       | Leaf
       deriving
         ( Eq, Show, Ord, Read, Functor, Generic, NFData
-        , Undefined, BitPack, ShowX)
+        , NFDataX, BitPack, ShowX)
 
 Data types with a single constructor may be written on a single line:
 
@@ -141,11 +141,11 @@ Format records as follows:
 .. code:: haskell
 
     data Person = Person
-      { firstName :: !String  
+      { firstName :: !String
       -- ^ First name
-      , lastName :: !String  
+      , lastName :: !String
       -- ^ Last name
-      , age :: !Int     
+      , age :: !Int
       -- ^ Age
       } deriving (Eq, Show)
 
@@ -168,7 +168,7 @@ You may put the closing bracket on a new line. Use your judgement.
     exceptions =
       [ InvalidStatusCode
       , MissingContentHeader
-      , InternalServerError 
+      , InternalServerError
       ]
 
 You may not skip the first newline.
@@ -179,7 +179,7 @@ You may not skip the first newline.
     directions = [ North
                  , East
                  , South
-                 , West 
+                 , West
                  ]
 
 *unless* it fits on a single line:
@@ -212,8 +212,8 @@ Or:
 
 .. code:: haskell
 
-    exceptions = 
-         North :> East :> South 
+    exceptions =
+         North :> East :> South
       :> West :> Middle :> Nil
 
 Language pragmas
@@ -257,13 +257,13 @@ your judgement. Some examples:
 .. code:: haskell
 
     bar :: IO ()
-    bar = 
+    bar =
       forM_ [1, 2, 3] $ \n -> do
         putStrLn "Here comes a number!"
         print n
 
     foo :: IO ()
-    foo = 
+    foo =
       alloca 10 $ \a ->
       alloca 20 $ \b ->
       cFunction a b
@@ -299,17 +299,17 @@ like you would normal expressions:
 
 .. code:: haskell
 
-    foo = 
-      if cond0 then 
+    foo =
+      if cond0 then
         ...
-      else 
+      else
         ...
 
 When used in monadic contexts, use:
 
 .. code:: haskell
 
-    foo = 
+    foo =
       if cond0 then do
         ...
       else do
@@ -337,7 +337,7 @@ the two following styles:
 
 .. code:: haskell
 
-    foobar = 
+    foobar =
       case something of
         Just j  -> foo
         Nothing -> bar
@@ -346,18 +346,18 @@ or as
 
 .. code:: haskell
 
-    foobar = 
+    foobar =
       case something of
-        Just j -> 
+        Just j ->
           foo
-        Nothing -> 
+        Nothing ->
           bar
 
 In monadic contexts, use:
 
 .. code:: haskell
 
-    foobar = 
+    foobar =
       case something of
         Just j -> do
           foo
@@ -383,7 +383,7 @@ Longer ones should be put on multiple lines:
 
 .. code:: haskell
 
-    toInt 
+    toInt
       :: Int
       -- ^ Shift char by /n/
       -> Char
@@ -394,7 +394,7 @@ Multiple constraints can be added with a "tuple":
 
 .. code:: haskell
 
-    toInt 
+    toInt
       :: (Num a, Show a)
       => a
       -- ^ Shift char by /n/
@@ -406,7 +406,7 @@ Many constraints need to be split accross multiple lines too:
 
 .. code:: haskell
 
-    toInt 
+    toInt
       :: ( Num a
          , Show a
          , Foo a
@@ -423,7 +423,7 @@ Many constraints need to be split accross multiple lines too:
 
 .. code:: haskell
 
-    toInt 
+    toInt
       :: forall a
        . (Num a , Show a)
       => a
@@ -443,13 +443,13 @@ your function would end up looking like:
            resetDomain
            resetKind
            domainGatedness
-       . ( Undefined a
+       . ( NFDataX a
          , Ord b
          , NFData c
          , Functor f )
       => f a
       -> f b
-      -> f c  
+      -> f c
 
 Imports
 -------
@@ -499,12 +499,12 @@ every exported data type. Function example:
     -- | Send a message on a socket. The socket must be in a connected
     -- state. Returns the number of bytes sent. Applications are
     -- responsible for ensuring that all data has been sent.
-    send 
+    send
       :: Socket
       -- ^ Connected socket
-      -> ByteString  
+      -> ByteString
       -- ^ Data to send
-      -> IO Int      
+      -> IO Int
       -- ^ Bytes sent
 
 For functions the documentation should give enough information apply the
@@ -516,9 +516,9 @@ Record example:
 
     -- | Bla bla bla.
     data Person = Person
-      { age  :: !Int     
+      { age  :: !Int
       -- ^ Age
-      , name :: !String  
+      , name :: !String
       -- ^ First name
       }
 
@@ -544,7 +544,7 @@ comments for data type definitions. Some examples:
 
 .. code:: haskell
 
-    data Parser = 
+    data Parser =
       Parser
         !Int         -- Current position
         !ByteString  -- Remaining input
@@ -603,8 +603,8 @@ spend thinking about evaluation order.
 
     -- Good
     data Point = Point
-      { pointX :: !Double  
-      , pointY :: !Double 
+      { pointX :: !Double
+      , pointY :: !Double
       }
 
 .. code:: haskell

clash-cores/src/Clash/Cores/Xilinx/VIO.hs

@@ -111,11 +111,12 @@ vioProbe ::
   a
 vioProbe inputNames outputNames initialOutputProbeValues clk =
   vioProbe# @dom @a @o inputNames outputNames initialOutputProbeValues clk
-{-# CLASH_OPAQUE vioProbe #-}
-
--- | Primitive for 'vioProbe'. Defining a wrapper like this makes the VIO probe
+-- Defining a NOINLINEd wrapper like this makes the 'vioProbe#'
 -- instantiation be rendered in its own module to reduce naming collision
 -- probabilities.
+{-# CLASH_OPAQUE vioProbe #-}
+
+-- | Primitive for 'vioProbe'.
 vioProbe# ::
   forall dom a o n m.
   (KnownDomain dom, VIO dom a o) =>

clash-cosim/src/Clash/CoSim/CodeGeneration.hs

@@ -116,7 +116,7 @@ coSimTypeGen clks args = do
     let domName = mkName "dom"
     let dom     = return $ VarT domName
 
-    -- Generate contraints:
+    -- Generate constraints:
     argConstraints <- sequence $ map (\name -> [t| ClashType $name |]) argTypeNames
     resConstraint  <- [t| ClashType $result |]
     kdConstraint   <- [t| KnownDomain $dom |]

clash-ghc/src-bin-881/Clash/GHCi/UI.hs

@@ -3202,9 +3202,9 @@ implemented above.
 The same filter was also implemented to fix Trac #11051 [3]. See the
 Note [What to show to users] in compiler/main/InteractiveEval.hs
 
-[1] https://ghc.haskell.org/trac/ghc/ticket/12525
-[2] https://ghc.haskell.org/trac/ghc/ticket/12525#comment:1
-[3] https://ghc.haskell.org/trac/ghc/ticket/11051
+[1] https://gitlab.haskell.org/ghc/ghc/-/issues/12525
+[2] https://gitlab.haskell.org/ghc/ghc/-/issues/12525#comment:1
+[3] https://gitlab.haskell.org/ghc/ghc/-/issues/11051
 -}
 
 

clash-lib/README.md

@@ -10,9 +10,8 @@ low-level synthesizable VHDL, Verilog, or SystemVerilog.
 
 Features of Clash:
 
-  * Strongly typed (like VHDL), yet with a very high degree of type inference,
-    enabling both safe and fast prototying using consise descriptions (like
-    Verilog).
+  * Strongly typed, but with a very high degree of type inference, enabling both
+    safe and fast prototyping using concise descriptions.
 
   * Interactive REPL: load your designs in an interpreter and easily test all
     your component without needing to setup a test bench.

clash-lib/prims/common/Clash_XException.primitives.yaml

@@ -22,8 +22,7 @@
 - BlackBox:
     name: Clash.XException.deepseqX
     kind: Expression
-    type: 'deepseqX :: Undefined
-      a => a -> b -> b'
+    type: 'deepseqX :: NFDataX a => a -> b -> b'
     template: ~ARG[2]
     workInfo: Never
 - BlackBox:

clash-lib/prims/systemverilog/Clash_Explicit_BlockRam.primitives.yaml

@@ -5,7 +5,7 @@
       blockRam#
         :: ( KnownDomain dom        ARG[0]
            , HasCallStack  --       ARG[1]
-           , Undefined a ) --       ARG[2]
+           , NFDataX a )   --       ARG[2]
         => Clock dom       -- clk,  ARG[3]
         -> Enable dom      -- en,   ARG[4]
         -> Vec n a         -- init, ARG[5]
@@ -50,7 +50,7 @@
       blockRamU#
         :: ( KnownDomain dom        ARG[0]
            , HasCallStack  --       ARG[1]
-           , Undefined a ) --       ARG[2]
+           , NFDataX a )   --       ARG[2]
         => Clock dom       -- clk,  ARG[3]
         -> Enable dom      -- en,   ARG[4]
         -> SNat n          -- len,  ARG[5]
@@ -92,7 +92,7 @@
       blockRam1#
         :: ( KnownDomain dom        ARG[0]
            , HasCallStack  --       ARG[1]
-           , Undefined a ) --       ARG[2]
+           , NFDataX a )   --       ARG[2]
         => Clock dom       -- clk,  ARG[3]
         -> Enable dom      -- en,   ARG[4]
         -> SNat n          -- len,  ARG[5]

clash-lib/prims/systemverilog/Clash_Explicit_DDR.primitives.yaml

@@ -4,7 +4,7 @@
     type: |-
       ddrIn# :: forall a slow fast n pFast gated synchronous.
                  ( HasCallStack          -- ARG[0]
-                 , Undefined a           -- ARG[1]
+                 , NFDataX a             -- ARG[1]
                  , KnownConfi~ fast domf -- ARG[2]
                  , KnownConfi~ slow doms -- ARG[3]
               => Clock slow              -- ARG[4], clk
@@ -49,8 +49,8 @@
     kind: Declaration
     outputUsage: Blocking
     type: |-
-      ddrOut# :: ( HasCallStack               -- ARG[0]
-                  , Undefined a                -- ARG[1]
+      ddrOut# :: ( HasCallStack                -- ARG[0]
+                  , NFDataX a                  -- ARG[1]
                   , KnownConfi~ fast domf      -- ARG[2]
                   , KnownConfi~ slow doms      -- ARG[3]
                => Clock slow                   -- ARG[4]

clash-lib/prims/systemverilog/Clash_Explicit_ROM.primitives.yaml

@@ -4,7 +4,7 @@
     type: |-
       rom# :: ( KnownDomain dom        ARG[0]
                , KnownNat n    --       ARG[1]
-               , Undefined a ) --       ARG[2]
+               , NFDataX a )   --       ARG[2]
             => Clock dom       -- clk,  ARG[3]
             => Enable dom      -- en,   ARG[4]
             -> Vec n a         -- init, ARG[5]

clash-lib/prims/systemverilog/Clash_Signal_Internal.primitives.yaml

@@ -5,7 +5,7 @@
     type: |-
       delay#
         :: ( KnownDomain dom        -- ARG[0]
-           , Undefined a )          -- ARG[1]
+           , NFDataX a )            -- ARG[1]
         => Clock dom                -- ARG[2]
         -> Enable dom               -- ARG[3]
         -> a                        -- ARG[4]
@@ -62,7 +62,7 @@
     type: |-
       register#
         :: ( KnownDomain dom        -- ARG[0]
-           , Undefined a )          -- ARG[1]
+           , NFDataX a )            -- ARG[1]
         => Clock dom                -- ARG[2]
         -> Reset dom                -- ARG[3]
         -> Enable dom               -- ARG[4]