CLaSH.Driver.TopWrapper

Documentation

data TopEntity

TopEntity specifications, fields are self-explanatory

Constructors

TopEntity

Fields

t_name :: Text

t_inputs :: [Text]

t_outputs :: [Text]

t_extraIn :: [(Text, Int)]

t_extraOut :: [(Text, Int)]

t_clocks :: [ClockSource]

Instances

Show TopEntity

FromJSON TopEntity

data ClockSource

A clock source

Constructors

ClockSource

Fields

c_name :: Text

Component name

c_paths :: [ClockPath]

Number of clock paths

c_reset :: Maybe (Text, Text)

optional: Asynchronous reset input

c_lock :: Text

Port name that indicates clock is stable

c_sync :: Bool

optional: devices connected this clock source should be pulled out of reset in-sync

Instances

Show ClockSource

FromJSON ClockSource

data ClockPath

A clock path

Constructors

ClockPath

Fields

cp_inp :: Maybe (Text, Text)

cp_outp :: [(Text, Clock)]

Instances

Show ClockPath

FromJSON ClockPath

data Clock

A clock

Constructors

Clk

Fields

clk_name :: Text

clk_rate :: Int

Instances

Eq Clock

Show Clock

FromJSON Clock

generateTopEnt :: String -> IO (Maybe TopEntity)

Create a TopEntity data type from the JSON encoded .topentity file.

mkTopWrapper

Arguments

:: PrimMap

-> Maybe TopEntity

TopEntity specifications

-> 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

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

Create a single clock generator

clockPorts :: ClockPath -> ([(Identifier, Expr)], [Clock])

Create a single clock path

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

Generate resets

genSyncReset :: PrimMap -> Identifier -> Identifier -> Clock -> 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.