clash-prelude 1.4.2 → 1.4.3

raw patch · 6 files changed

+14/−6 lines, 6 filesPVP: major bump suggested

API removals or changes: PVP suggests a major version bump

API changes (from Hackage documentation)

- Clash.Prelude: asyncFIFOSynchronizer :: (HiddenClockResetEnable rdom, HiddenClockResetEnable wdom, 2 <= addrSize) => SNat addrSize -> Signal rdom Bool -> Signal wdom (Maybe a) -> (Signal rdom a, Signal rdom Bool, Signal wdom Bool)

- Clash.Prelude: convertReset :: forall domA domB. (HiddenClock domA, HiddenClock domB) => Reset domA -> Reset domB

- Clash.Prelude: dualFlipFlopSynchronizer :: (NFDataX a, HiddenClock dom1, HiddenClockResetEnable dom2) => a -> Signal dom1 a -> Signal dom2 a

- Clash.Prelude: exposeSpecificClock :: forall dom r. WithSpecificDomain dom r => (HiddenClock dom => r) -> KnownDomain dom => Clock dom -> r

- Clash.Prelude: exposeSpecificClockResetEnable :: forall dom r. WithSpecificDomain dom r => (HiddenClockResetEnable dom => r) -> KnownDomain dom => Clock dom -> Reset dom -> Enable dom -> r

- Clash.Prelude: exposeSpecificEnable :: forall dom r. WithSpecificDomain dom r => (HiddenEnable dom => r) -> KnownDomain dom => Enable dom -> r

- Clash.Prelude: exposeSpecificReset :: forall dom r. WithSpecificDomain dom r => (HiddenReset dom => r) -> KnownDomain dom => Reset dom -> r

- Clash.Prelude: unsafeSynchronizer :: forall dom1 dom2 a. (HiddenClock dom1, HiddenClock dom2) => Signal dom1 a -> Signal dom2 a

- Clash.Prelude: withSpecificClock :: forall dom r. (KnownDomain dom, WithSpecificDomain dom r) => Clock dom -> (HiddenClock dom => r) -> r

- Clash.Prelude: withSpecificClockResetEnable :: forall dom r. (KnownDomain dom, WithSpecificDomain dom r) => Clock dom -> Reset dom -> Enable dom -> (HiddenClockResetEnable dom => r) -> r

- Clash.Prelude: withSpecificEnable :: forall dom r. (KnownDomain dom, WithSpecificDomain dom r) => Enable dom -> (HiddenEnable dom => r) -> r

- Clash.Prelude: withSpecificReset :: forall dom r. (KnownDomain dom, WithSpecificDomain dom r) => Reset dom -> (HiddenReset dom => r) -> r

- Clash.Prelude.Synchronizer: asyncFIFOSynchronizer :: (HiddenClockResetEnable rdom, HiddenClockResetEnable wdom, 2 <= addrSize) => SNat addrSize -> Signal rdom Bool -> Signal wdom (Maybe a) -> (Signal rdom a, Signal rdom Bool, Signal wdom Bool)

- Clash.Prelude.Synchronizer: dualFlipFlopSynchronizer :: (NFDataX a, HiddenClock dom1, HiddenClockResetEnable dom2) => a -> Signal dom1 a -> Signal dom2 a

- Clash.Signal: convertReset :: forall domA domB. (HiddenClock domA, HiddenClock domB) => Reset domA -> Reset domB

- Clash.Signal: exposeSpecificClock :: forall dom r. WithSpecificDomain dom r => (HiddenClock dom => r) -> KnownDomain dom => Clock dom -> r

- Clash.Signal: exposeSpecificClockResetEnable :: forall dom r. WithSpecificDomain dom r => (HiddenClockResetEnable dom => r) -> KnownDomain dom => Clock dom -> Reset dom -> Enable dom -> r

- Clash.Signal: exposeSpecificEnable :: forall dom r. WithSpecificDomain dom r => (HiddenEnable dom => r) -> KnownDomain dom => Enable dom -> r

- Clash.Signal: exposeSpecificReset :: forall dom r. WithSpecificDomain dom r => (HiddenReset dom => r) -> KnownDomain dom => Reset dom -> r

- Clash.Signal: unsafeSynchronizer :: forall dom1 dom2 a. (HiddenClock dom1, HiddenClock dom2) => Signal dom1 a -> Signal dom2 a

- Clash.Signal: withSpecificClock :: forall dom r. (KnownDomain dom, WithSpecificDomain dom r) => Clock dom -> (HiddenClock dom => r) -> r

- Clash.Signal: withSpecificClockResetEnable :: forall dom r. (KnownDomain dom, WithSpecificDomain dom r) => Clock dom -> Reset dom -> Enable dom -> (HiddenClockResetEnable dom => r) -> r

- Clash.Signal: withSpecificEnable :: forall dom r. (KnownDomain dom, WithSpecificDomain dom r) => Enable dom -> (HiddenEnable dom => r) -> r

- Clash.Signal: withSpecificReset :: forall dom r. (KnownDomain dom, WithSpecificDomain dom r) => Reset dom -> (HiddenReset dom => r) -> r

- Clash.Prelude: exposeClock :: forall dom r. WithSingleDomain dom r => (HiddenClock dom => r) -> KnownDomain dom => Clock dom -> r

+ Clash.Prelude: exposeClock :: forall dom r. (HiddenClock dom => r) -> KnownDomain dom => Clock dom -> r

- Clash.Prelude: exposeClockResetEnable :: forall dom r. WithSingleDomain dom r => (HiddenClockResetEnable dom => r) -> KnownDomain dom => Clock dom -> Reset dom -> Enable dom -> r

+ Clash.Prelude: exposeClockResetEnable :: forall dom r. (HiddenClockResetEnable dom => r) -> KnownDomain dom => Clock dom -> Reset dom -> Enable dom -> r

- Clash.Prelude: exposeEnable :: forall dom r. WithSingleDomain dom r => (HiddenEnable dom => r) -> KnownDomain dom => Enable dom -> r

+ Clash.Prelude: exposeEnable :: forall dom r. (HiddenEnable dom => r) -> KnownDomain dom => Enable dom -> r

- Clash.Prelude: exposeReset :: forall dom r. WithSingleDomain dom r => (HiddenReset dom => r) -> KnownDomain dom => Reset dom -> r

+ Clash.Prelude: exposeReset :: forall dom r. (HiddenReset dom => r) -> KnownDomain dom => Reset dom -> r

- Clash.Prelude: withClock :: forall dom r. WithSingleDomain dom r => KnownDomain dom => Clock dom -> (HiddenClock dom => r) -> r

+ Clash.Prelude: withClock :: forall dom r. KnownDomain dom => Clock dom -> (HiddenClock dom => r) -> r

- Clash.Prelude: withClockResetEnable :: forall dom r. KnownDomain dom => WithSingleDomain dom r => Clock dom -> Reset dom -> Enable dom -> (HiddenClockResetEnable dom => r) -> r

+ Clash.Prelude: withClockResetEnable :: forall dom r. KnownDomain dom => Clock dom -> Reset dom -> Enable dom -> (HiddenClockResetEnable dom => r) -> r

- Clash.Prelude: withEnable :: forall dom r. KnownDomain dom => WithSingleDomain dom r => Enable dom -> (HiddenEnable dom => r) -> r

+ Clash.Prelude: withEnable :: forall dom r. KnownDomain dom => Enable dom -> (HiddenEnable dom => r) -> r

- Clash.Prelude: withReset :: forall dom r. WithSingleDomain dom r => KnownDomain dom => Reset dom -> (HiddenReset dom => r) -> r

+ Clash.Prelude: withReset :: forall dom r. KnownDomain dom => Reset dom -> (HiddenReset dom => r) -> r

- Clash.Signal: exposeClock :: forall dom r. WithSingleDomain dom r => (HiddenClock dom => r) -> KnownDomain dom => Clock dom -> r

+ Clash.Signal: exposeClock :: forall dom r. (HiddenClock dom => r) -> KnownDomain dom => Clock dom -> r

- Clash.Signal: exposeClockResetEnable :: forall dom r. WithSingleDomain dom r => (HiddenClockResetEnable dom => r) -> KnownDomain dom => Clock dom -> Reset dom -> Enable dom -> r

+ Clash.Signal: exposeClockResetEnable :: forall dom r. (HiddenClockResetEnable dom => r) -> KnownDomain dom => Clock dom -> Reset dom -> Enable dom -> r

- Clash.Signal: exposeEnable :: forall dom r. WithSingleDomain dom r => (HiddenEnable dom => r) -> KnownDomain dom => Enable dom -> r

+ Clash.Signal: exposeEnable :: forall dom r. (HiddenEnable dom => r) -> KnownDomain dom => Enable dom -> r

- Clash.Signal: exposeReset :: forall dom r. WithSingleDomain dom r => (HiddenReset dom => r) -> KnownDomain dom => Reset dom -> r

+ Clash.Signal: exposeReset :: forall dom r. (HiddenReset dom => r) -> KnownDomain dom => Reset dom -> r

- Clash.Signal: type HiddenClockName dom = AppendSymbol dom "_clk"

+ Clash.Signal: type HiddenClockName (dom :: Domain) = "clock"

- Clash.Signal: type HiddenEnableName dom = AppendSymbol dom "_en"

+ Clash.Signal: type HiddenEnableName (dom :: Domain) = "enable"

- Clash.Signal: type HiddenResetName dom = AppendSymbol dom "_rst"

+ Clash.Signal: type HiddenResetName (dom :: Domain) = "reset"

- Clash.Signal: withClock :: forall dom r. WithSingleDomain dom r => KnownDomain dom => Clock dom -> (HiddenClock dom => r) -> r

+ Clash.Signal: withClock :: forall dom r. KnownDomain dom => Clock dom -> (HiddenClock dom => r) -> r

- Clash.Signal: withClockResetEnable :: forall dom r. KnownDomain dom => WithSingleDomain dom r => Clock dom -> Reset dom -> Enable dom -> (HiddenClockResetEnable dom => r) -> r

+ Clash.Signal: withClockResetEnable :: forall dom r. KnownDomain dom => Clock dom -> Reset dom -> Enable dom -> (HiddenClockResetEnable dom => r) -> r

- Clash.Signal: withEnable :: forall dom r. KnownDomain dom => WithSingleDomain dom r => Enable dom -> (HiddenEnable dom => r) -> r

+ Clash.Signal: withEnable :: forall dom r. KnownDomain dom => Enable dom -> (HiddenEnable dom => r) -> r

- Clash.Signal: withReset :: forall dom r. WithSingleDomain dom r => KnownDomain dom => Reset dom -> (HiddenReset dom => r) -> r

+ Clash.Signal: withReset :: forall dom r. KnownDomain dom => Reset dom -> (HiddenReset dom => r) -> r

Files

CHANGELOG.md +6/−0
clash-prelude.cabal +1/−1
src/Clash/Explicit/Prelude/Safe.hs +1/−1
src/Clash/Prelude/Safe.hs +1/−1
src/Clash/Sized/Internal/BitVector.hs +2/−0
src/Clash/Tutorial.hs +3/−3

CHANGELOG.md view

@@ -1,5 +1,11 @@ # Changelog for the Clash project +## 1.4.3 *Aug 8th 2021*+Fixed:++ * Clash no longer generates calls to `{shift,rotate}_{left,right}` in VHDL where the count is a negative number [#1810](https://github.com/clash-lang/clash-compiler/issues/1810).+ * Clash no longer incurs unnecessary compile-time complexity while compiling Vector indexing operator [#1557](https://github.com/clash-lang/clash-compiler/issues/1557)+ ## 1.4.2 *May 18th 2021* Fixed:

clash-prelude.cabal view

@@ -1,6 +1,6 @@ Cabal-version:        2.2 Name:                 clash-prelude-Version:              1.4.2+Version:              1.4.3 Synopsis:             Clash: a functional hardware description language - Prelude library Description:   Clash is a functional hardware description language that borrows both its

src/Clash/Explicit/Prelude/Safe.hs view

@@ -5,7 +5,7 @@ License    :  BSD2 (see the file LICENSE) Maintainer :  Christiaan Baaij <christiaan.baaij@gmail.com> -__This is the <https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/safe_haskell.html Safe> API only of "Clash.Explicit.Prelude"__+__This is the <https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/exts/safe_haskell.html Safe> API only of "Clash.Explicit.Prelude"__  This module defines the explicitly clocked counterparts of the functions defined in "Clash.Prelude".

src/Clash/Prelude/Safe.hs view

@@ -5,7 +5,7 @@   License     :  BSD2 (see the file LICENSE)   Maintainer  :  Christiaan Baaij <christiaan.baaij@gmail.com> -  __This is the <https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/safe_haskell.html Safe> API only of "Clash.Prelude"__+  __This is the <https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/exts/safe_haskell.html Safe> API only of "Clash.Prelude"__    Clash is a functional hardware description language that borrows both its   syntax and semantics from the functional programming language Haskell. The

src/Clash/Sized/Internal/BitVector.hs view

@@ -352,8 +352,10 @@   bitSizeMaybe _    = Just 1   bitSize _         = 1   isSigned _        = False+  shift b i         = if i == 0 then b else low   shiftL b i        = if i == 0 then b else low   shiftR b i        = if i == 0 then b else low+  rotate b _        = b   rotateL b _       = b   rotateR b _       = b   popCount b        = if eq## b low then 0 else 1

src/Clash/Tutorial.hs view

@@ -1656,10 +1656,10 @@   'Clash.Explicit.Signal.register' clk2 rst2 en2 0 . 'Clash.Explicit.Signal.register' clk2 rst2 en2 0 . 'Clash.Explicit.Signal.unsafeSynchronizer' clk1 clk2 @ -It uses the 'unsafeSynchronizer' primitive, which is needed to go from one clock+It uses the 'Clash.Explicit.Signal.unsafeSynchronizer' primitive, which is needed to go from one clock domain to the other. All synchronizers are specified in terms of-'unsafeSynchronizer' (see for example the <src/Clash-Prelude-RAM.html#line-103 source of asyncRam>).-The 'unsafeSynchronizer' primitive is turned into a (bundle of) wire(s) by the+'Clash.Explicit.Signal.unsafeSynchronizer' (see for example the <src/Clash-Prelude-RAM.html#line-103 source of asyncRam>).+The 'Clash.Explicit.Signal.unsafeSynchronizer' primitive is turned into a (bundle of) wire(s) by the Clash compiler, so developers must ensure that it is only used as part of a proper synchronizer.