Verismith.Tool.Internal

Class of the simulator and the synthesize tool.

Documentation

type ResultSh = ResultT Failed Sh

Type synonym for a ResultT that will be used throughout Verismith. This has instances for MonadSh and MonadIO if the Monad it is parametrised with also has those instances.

resultSh :: ResultSh a -> Sh a

class Tool a where

Tool class.

Methods

toText :: a -> Text

Instances

Tool XST

Defined in Verismith.Tool.XST

Methods

toText :: XST -> Text

Tool Vivado

Defined in Verismith.Tool.Vivado

Methods

toText :: Vivado -> Text

Tool QuartusLight

Defined in Verismith.Tool.QuartusLight

Methods

toText :: QuartusLight -> Text

Tool Quartus

Defined in Verismith.Tool.Quartus

Methods

toText :: Quartus -> Text

Tool Identity

Defined in Verismith.Tool.Identity

Methods

toText :: Identity -> Text

Tool Yosys

Defined in Verismith.Tool.Yosys

Methods

toText :: Yosys -> Text

Tool Icarus

Defined in Verismith.Tool.Icarus

Methods

toText :: Icarus -> Text

Tool SimTool

Defined in Verismith.Report

Methods

toText :: SimTool -> Text

Tool SynthTool

Defined in Verismith.Report

Methods

toText :: SynthTool -> Text

class Tool a => Simulator a where

Simulation type class.

Methods

runSim

Arguments

:: a

Simulator instance

-> SourceInfo

Run information

-> [ByteString]

Inputs to simulate

-> ResultSh ByteString

Returns the value of the hash at the output of the testbench.

runSimWithFile :: a -> FilePath -> [ByteString] -> ResultSh ByteString

Instances

Simulator Icarus

Defined in Verismith.Tool.Icarus

Methods

runSim :: Icarus -> SourceInfo -> [ByteString] -> ResultSh ByteString

runSimWithFile :: Icarus -> FilePath -> [ByteString] -> ResultSh ByteString

Simulator SimTool

Defined in Verismith.Report

Methods

runSim :: SimTool -> SourceInfo -> [ByteString] -> ResultSh ByteString

runSimWithFile :: SimTool -> FilePath -> [ByteString] -> ResultSh ByteString

class Tool a => Synthesiser a where

Synthesiser type class.

Methods

runSynth

Arguments

:: a

Synthesiser tool instance

-> SourceInfo

Run information

-> ResultSh ()

does not return any values

synthOutput :: a -> FilePath

setSynthOutput :: a -> FilePath -> a

Instances

Synthesiser XST

Defined in Verismith.Tool.XST

Methods

runSynth :: XST -> SourceInfo -> ResultSh ()

synthOutput :: XST -> FilePath

setSynthOutput :: XST -> FilePath -> XST

Synthesiser Vivado

Defined in Verismith.Tool.Vivado

Methods

runSynth :: Vivado -> SourceInfo -> ResultSh ()

synthOutput :: Vivado -> FilePath

setSynthOutput :: Vivado -> FilePath -> Vivado

Synthesiser QuartusLight

Defined in Verismith.Tool.QuartusLight

Methods

runSynth :: QuartusLight -> SourceInfo -> ResultSh ()

synthOutput :: QuartusLight -> FilePath

setSynthOutput :: QuartusLight -> FilePath -> QuartusLight

Synthesiser Quartus

Defined in Verismith.Tool.Quartus

Methods

runSynth :: Quartus -> SourceInfo -> ResultSh ()

synthOutput :: Quartus -> FilePath

setSynthOutput :: Quartus -> FilePath -> Quartus

Synthesiser Identity

Defined in Verismith.Tool.Identity

Methods

runSynth :: Identity -> SourceInfo -> ResultSh ()

synthOutput :: Identity -> FilePath

setSynthOutput :: Identity -> FilePath -> Identity

Synthesiser Yosys

Defined in Verismith.Tool.Yosys

Methods

runSynth :: Yosys -> SourceInfo -> ResultSh ()

synthOutput :: Yosys -> FilePath

setSynthOutput :: Yosys -> FilePath -> Yosys

Synthesiser SynthTool

Defined in Verismith.Report

Methods

runSynth :: SynthTool -> SourceInfo -> ResultSh ()

synthOutput :: SynthTool -> FilePath

setSynthOutput :: SynthTool -> FilePath -> SynthTool

data Failed

Constructors

EmptyFail

EquivFail CounterEg

EquivError

SimFail ByteString

SynthFail

TimeoutError

Instances

Eq Failed

Defined in Verismith.Tool.Internal

Methods

(==) :: Failed -> Failed -> Bool

(/=) :: Failed -> Failed -> Bool

Show Failed

Defined in Verismith.Tool.Internal

Methods

showsPrec :: Int -> Failed -> ShowS

show :: Failed -> String

showList :: [Failed] -> ShowS

Semigroup Failed

Defined in Verismith.Tool.Internal

Methods

(<>) :: Failed -> Failed -> Failed

sconcat :: NonEmpty Failed -> Failed

stimes :: Integral b => b -> Failed -> Failed

Monoid Failed

Defined in Verismith.Tool.Internal

Methods

mempty :: Failed

mappend :: Failed -> Failed -> Failed

mconcat :: [Failed] -> Failed

renameSource :: Synthesiser a => a -> SourceInfo -> SourceInfo

checkPresent :: FilePath -> Text -> Sh (Maybe Text)

checkPresentModules :: FilePath -> SourceInfo -> Sh [Text]

Checks what modules are present in the synthesised output, as some modules may have been inlined. This could be improved if the parser worked properly.

replace :: FilePath -> Text -> Text -> Sh ()

Uses sed to replace a string in a text file.

replaceMods :: FilePath -> Text -> SourceInfo -> Sh ()

This is used because rename only renames the definitions of modules of course, so instead this just searches and replaces all the module names. This should find all the instantiations and definitions. This could again be made much simpler if the parser works.

rootPath :: Sh FilePath

timeout :: FilePath -> [Text] -> Sh Text

timeout_ :: FilePath -> [Text] -> Sh ()

bsToI :: ByteString -> Integer

Helper function to convert bytestrings to integers

noPrint :: Sh a -> Sh a

logger :: Text -> Sh ()

logCommand :: FilePath -> Text -> Sh a -> Sh a

logCommand_ :: FilePath -> Text -> Sh a -> Sh ()

execute :: (MonadSh m, Monad m) => Failed -> FilePath -> Text -> FilePath -> [Text] -> ResultT Failed m Text

execute_ :: (MonadSh m, Monad m) => Failed -> FilePath -> Text -> FilePath -> [Text] -> ResultT Failed m ()

(<?>) :: (Monad m, Monoid a) => ResultT a m b -> a -> ResultT a m b infix 0

annotate :: (Monad m, Monoid a) => a -> ResultT a m b -> ResultT a m b