Copyright	(C) 2015-2016 University of Twente 2017 Google Inc. 2019 Myrtle Software Ltd 2021-2022 QBayLogic B.V.
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qbaylogic.com>
Safe Haskell	Trustworthy
Language	Haskell2010
Extensions	ScopedTypeVariables BangPatterns ViewPatterns DataKinds InstanceSigs StandaloneDeriving DeriveDataTypeable DeriveFunctor DeriveTraversable DeriveFoldable DeriveGeneric DefaultSignatures DeriveLift DerivingStrategies FlexibleContexts MagicHash KindSignatures TupleSections RankNTypes TypeOperators ExplicitNamespaces ExplicitForAll BinaryLiterals TypeApplications

Clash.Prelude.ROM

Contents

Description

ROMs

Synopsis

asyncRom :: (KnownNat n, Enum addr) => Vec n a -> addr -> a
asyncRomPow2 :: KnownNat n => Vec (2 ^ n) a -> Unsigned n -> a
rom :: forall dom n m a. (NFDataX a, KnownNat n, KnownNat m, HiddenClock dom, HiddenEnable dom) => Vec n a -> Signal dom (Unsigned m) -> Signal dom a
romPow2 :: forall dom n a. (KnownNat n, NFDataX a, HiddenClock dom, HiddenEnable dom) => Vec (2 ^ n) a -> Signal dom (Unsigned n) -> Signal dom a
asyncRom# :: forall n a. KnownNat n => Vec n a -> Int -> a

Asynchronous ROM

Arguments

:: (KnownNat n, Enum addr)
=> Vec n a	ROM content, also determines the size, `n`, of the ROM NB: must be a constant
-> addr	Read address `rd`
-> a	The value of the ROM at address `rd`

An asynchronous/combinational ROM with space for n elements

Additional helpful information:

See Clash.Sized.Fixed and Clash.Prelude.BlockRam for ideas on how to use ROMs and RAMs
A large Vec for the content might be too inefficient, depending on how it is constructed. See asyncRomFile and asyncRomBlob for different approaches that scale well.

Arguments

:: KnownNat n
=> Vec (2 ^ n) a	ROM content NB: must be a constant
-> Unsigned n	Read address `rd`
-> a	The value of the ROM at address `rd`

An asynchronous/combinational ROM with space for 2^n elements

Additional helpful information:

See Clash.Sized.Fixed and Clash.Prelude.BlockRam for ideas on how to use ROMs and RAMs
A large Vec for the content might be too inefficient, depending on how it is constructed. See asyncRomFilePow2 and asyncRomBlobPow2 for different approaches that scale well.

Synchronous ROM synchronized to an arbitrary clock

Arguments

:: forall dom n m a. (NFDataX a, KnownNat n, KnownNat m, HiddenClock dom, HiddenEnable dom)
=> Vec n a	ROM content, also determines the size, `n`, of the ROM NB: must be a constant
-> Signal dom (Unsigned m)	Read address `rd`
-> Signal dom a	The value of the ROM at address `rd`

A ROM with a synchronous read port, with space for n elements

Additional helpful information:

See Clash.Sized.Fixed and Clash.Prelude.BlockRam for ideas on how to use ROMs and RAMs
A large Vec for the content might be too inefficient, depending on how it is constructed. See romFile and romBlob for different approaches that scale well.

Arguments

:: forall dom n a. (KnownNat n, NFDataX a, HiddenClock dom, HiddenEnable dom)
=> Vec (2 ^ n) a	ROM content NB: must be a constant
-> Signal dom (Unsigned n)	Read address `rd`
-> Signal dom a	The value of the ROM at address `rd`

A ROM with a synchronous read port, with space for 2^n elements

Additional helpful information:

See Clash.Sized.Fixed and Clash.Prelude.BlockRam for ideas on how to use ROMs and RAMs
A large Vec for the content might be too inefficient, depending on how it is constructed. See romFilePow2 and romBlobPow2 for different approaches that scale well.

Arguments

:: forall n a. KnownNat n
=> Vec n a	ROM content, also determines the size, `n`, of the ROM NB: must be a constant
-> Int	Read address `rd`
-> a	The value of the ROM at address `rd`

asyncROM primitive