CLaSH.Driver.TopWrapper

Documentation

mkTopWrapper

Arguments

:: PrimMap

-> Maybe TopEntity

TopEntity specifications

-> String

Name of the module containing the topEntity

-> Component

Entity to wrap

-> Component

Create a wrapper around a component, potentially initiating clock sources

extraIn :: Maybe TopEntity -> [(Identifier, HWType)]

Create extra input ports for the wrapper

extraOut :: Maybe TopEntity -> [(Identifier, HWType)]

Create extra output ports for the wrapper

mkInput :: [Identifier] -> (Identifier, HWType) -> Int -> ([Identifier], ([(Identifier, HWType)], ([Declaration], Identifier)))

Generate input port mappings

mkVectorChain :: Int -> HWType -> [Identifier] -> Expr

Create a Vector chain for a list of Identifiers

mkOutput :: [Identifier] -> (Identifier, HWType) -> Int -> ([Identifier], ([(Identifier, HWType)], ([Declaration], Identifier)))

Generate output port mappings

mkClocks :: PrimMap -> [(Identifier, HWType)] -> Maybe TopEntity -> [Declaration]

Create clock generators

stringToVar :: String -> Expr

mkClock :: ClockSource -> ([Declaration], (Identifier, [String], Bool))

Create a single clock generator

mkClockDecl :: String -> Declaration

clockPorts :: Maybe (String, String) -> [(String, String)] -> ([(Identifier, Expr)], [String])

Create a single clock path

mkResets :: PrimMap -> [(Identifier, HWType)] -> [(Identifier, [String], Bool)] -> [Declaration]

Generate resets

genSyncReset :: PrimMap -> Identifier -> Identifier -> Text -> Int -> NetlistMonad [Declaration]

Generate a reset synchroniser that synchronously de-asserts an asynchronous reset signal

unsafeRunNetlist :: NetlistMonad a -> a

The NetListMonad is an transformer stack with IO at the bottom. So we must use unsafePerformIO.