Copyright	(c) 2019 Yann Herklotz Grave
License	GPL-3
Maintainer	yann [at] yannherklotz [dot] com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Verismith.Tool

Contents

Simulators
- Icarus
Synthesisers
Equivalence
Simulation
Synthesis

Description

Simulator implementations.

Synopsis

data Icarus = Icarus {
- icarusPath :: FilePath
- vvpPath :: FilePath
}
defaultIcarus :: Icarus
data Yosys = Yosys {
- yosysBin :: !(Maybe FilePath)
- yosysDesc :: !Text
- yosysOutput :: !FilePath
}
defaultYosys :: Yosys
data Vivado = Vivado {
- vivadoBin :: !(Maybe FilePath)
- vivadoDesc :: !Text
- vivadoOutput :: !FilePath
}
defaultVivado :: Vivado
data XST = XST {
- xstBin :: !(Maybe FilePath)
- xstDesc :: !Text
- xstOutput :: !FilePath
}
defaultXST :: XST
data Quartus = Quartus {
- quartusBin :: !(Maybe FilePath)
- quartusDesc :: !Text
- quartusOutput :: !FilePath
}
defaultQuartus :: Quartus
data QuartusLight = QuartusLight {
- quartusLightBin :: !(Maybe FilePath)
- quartusLightDesc :: !Text
- quartusLightOutput :: !FilePath
}
defaultQuartusLight :: QuartusLight
data Identity = Identity {
- identityDesc :: !Text
- identityOutput :: !FilePath
}
defaultIdentity :: Identity
runEquiv :: (Synthesiser a, Synthesiser b, Show ann) => Maybe Text -> FilePath -> a -> b -> SourceInfo ann -> ResultSh ()
runSim :: (Simulator a, Show ann) => a -> SourceInfo ann -> [ByteString] -> ResultSh ByteString
runSynth :: (Synthesiser a, Show ann) => a -> SourceInfo ann -> ResultSh ()
logger :: Text -> Sh ()

Simulators

Icarus

data Icarus Source #

Constructors

Icarus
Fields icarusPath :: FilePath vvpPath :: FilePath

Instances

Instances details

Show Icarus Source #
Instance details Defined in Verismith.Tool.Icarus Methods showsPrec :: Int -> Icarus -> ShowS # show :: Icarus -> String # showList :: [Icarus] -> ShowS #
NFData Icarus Source #
Instance details Defined in Verismith.Tool.Icarus Methods rnf :: Icarus -> () #
Eq Icarus Source #
Instance details Defined in Verismith.Tool.Icarus Methods (==) :: Icarus -> Icarus -> Bool # (/=) :: Icarus -> Icarus -> Bool #
Simulator Icarus Source #
Instance details Defined in Verismith.Tool.Icarus Methods runSim :: Show ann => Icarus -> SourceInfo ann -> [ByteString] -> ResultSh ByteString Source # runSimWithFile :: Icarus -> FilePath -> [ByteString] -> ResultSh ByteString Source #
Tool Icarus Source #
Instance details Defined in Verismith.Tool.Icarus Methods toText :: Icarus -> Text Source #

defaultIcarus :: Icarus Source #

Synthesisers

Yosys

data Yosys Source #

Constructors

Yosys
Fields yosysBin :: !(Maybe FilePath) yosysDesc :: !Text yosysOutput :: !FilePath

Instances

Instances details

Show Yosys Source #
Instance details Defined in Verismith.Tool.Yosys Methods showsPrec :: Int -> Yosys -> ShowS # show :: Yosys -> String # showList :: [Yosys] -> ShowS #
NFData Yosys Source #
Instance details Defined in Verismith.Tool.Yosys Methods rnf :: Yosys -> () #
Eq Yosys Source #
Instance details Defined in Verismith.Tool.Yosys Methods (==) :: Yosys -> Yosys -> Bool # (/=) :: Yosys -> Yosys -> Bool #
Synthesiser Yosys Source #
Instance details Defined in Verismith.Tool.Yosys Methods runSynth :: Show ann => Yosys -> SourceInfo ann -> ResultSh () Source # synthOutput :: Yosys -> FilePath Source # setSynthOutput :: Yosys -> FilePath -> Yosys Source #
Tool Yosys Source #
Instance details Defined in Verismith.Tool.Yosys Methods toText :: Yosys -> Text Source #

defaultYosys :: Yosys Source #

Vivado

data Vivado Source #

Constructors

Vivado
Fields vivadoBin :: !(Maybe FilePath) vivadoDesc :: !Text vivadoOutput :: !FilePath

Instances

Instances details

Show Vivado Source #
Instance details Defined in Verismith.Tool.Vivado Methods showsPrec :: Int -> Vivado -> ShowS # show :: Vivado -> String # showList :: [Vivado] -> ShowS #
NFData Vivado Source #
Instance details Defined in Verismith.Tool.Vivado Methods rnf :: Vivado -> () #
Eq Vivado Source #
Instance details Defined in Verismith.Tool.Vivado Methods (==) :: Vivado -> Vivado -> Bool # (/=) :: Vivado -> Vivado -> Bool #
Synthesiser Vivado Source #
Instance details Defined in Verismith.Tool.Vivado Methods runSynth :: Show ann => Vivado -> SourceInfo ann -> ResultSh () Source # synthOutput :: Vivado -> FilePath Source # setSynthOutput :: Vivado -> FilePath -> Vivado Source #
Tool Vivado Source #
Instance details Defined in Verismith.Tool.Vivado Methods toText :: Vivado -> Text Source #

defaultVivado :: Vivado Source #

XST

data XST Source #

Constructors

XST
Fields xstBin :: !(Maybe FilePath) xstDesc :: !Text xstOutput :: !FilePath

Instances

Instances details

Show XST Source #
Instance details Defined in Verismith.Tool.XST Methods showsPrec :: Int -> XST -> ShowS # show :: XST -> String # showList :: [XST] -> ShowS #
NFData XST Source #
Instance details Defined in Verismith.Tool.XST Methods rnf :: XST -> () #
Eq XST Source #
Instance details Defined in Verismith.Tool.XST Methods (==) :: XST -> XST -> Bool # (/=) :: XST -> XST -> Bool #
Synthesiser XST Source #
Instance details Defined in Verismith.Tool.XST Methods runSynth :: Show ann => XST -> SourceInfo ann -> ResultSh () Source # synthOutput :: XST -> FilePath Source # setSynthOutput :: XST -> FilePath -> XST Source #
Tool XST Source #
Instance details Defined in Verismith.Tool.XST Methods toText :: XST -> Text Source #

defaultXST :: XST Source #

Quartus

data Quartus Source #

Constructors

Quartus
Fields quartusBin :: !(Maybe FilePath) quartusDesc :: !Text quartusOutput :: !FilePath

Instances

Instances details

Show Quartus Source #
Instance details Defined in Verismith.Tool.Quartus Methods showsPrec :: Int -> Quartus -> ShowS # show :: Quartus -> String # showList :: [Quartus] -> ShowS #
NFData Quartus Source #
Instance details Defined in Verismith.Tool.Quartus Methods rnf :: Quartus -> () #
Eq Quartus Source #
Instance details Defined in Verismith.Tool.Quartus Methods (==) :: Quartus -> Quartus -> Bool # (/=) :: Quartus -> Quartus -> Bool #
Synthesiser Quartus Source #
Instance details Defined in Verismith.Tool.Quartus Methods runSynth :: Show ann => Quartus -> SourceInfo ann -> ResultSh () Source # synthOutput :: Quartus -> FilePath Source # setSynthOutput :: Quartus -> FilePath -> Quartus Source #
Tool Quartus Source #
Instance details Defined in Verismith.Tool.Quartus Methods toText :: Quartus -> Text Source #

defaultQuartus :: Quartus Source #

Quartus Light

data QuartusLight Source #

Constructors

QuartusLight
Fields quartusLightBin :: !(Maybe FilePath) quartusLightDesc :: !Text quartusLightOutput :: !FilePath

Instances

Instances details

Show QuartusLight Source #
Instance details Defined in Verismith.Tool.QuartusLight Methods showsPrec :: Int -> QuartusLight -> ShowS # show :: QuartusLight -> String # showList :: [QuartusLight] -> ShowS #
NFData QuartusLight Source #
Instance details Defined in Verismith.Tool.QuartusLight Methods rnf :: QuartusLight -> () #
Eq QuartusLight Source #
Instance details Defined in Verismith.Tool.QuartusLight Methods (==) :: QuartusLight -> QuartusLight -> Bool # (/=) :: QuartusLight -> QuartusLight -> Bool #
Synthesiser QuartusLight Source #
Instance details Defined in Verismith.Tool.QuartusLight Methods runSynth :: Show ann => QuartusLight -> SourceInfo ann -> ResultSh () Source # synthOutput :: QuartusLight -> FilePath Source # setSynthOutput :: QuartusLight -> FilePath -> QuartusLight Source #
Tool QuartusLight Source #
Instance details Defined in Verismith.Tool.QuartusLight Methods toText :: QuartusLight -> Text Source #

defaultQuartusLight :: QuartusLight Source #

Identity

data Identity Source #

Constructors

Identity
Fields identityDesc :: !Text identityOutput :: !FilePath

Instances

Instances details

Show Identity Source #
Instance details Defined in Verismith.Tool.Identity Methods showsPrec :: Int -> Identity -> ShowS # show :: Identity -> String # showList :: [Identity] -> ShowS #
NFData Identity Source #
Instance details Defined in Verismith.Tool.Identity Methods rnf :: Identity -> () #
Eq Identity Source #
Instance details Defined in Verismith.Tool.Identity Methods (==) :: Identity -> Identity -> Bool # (/=) :: Identity -> Identity -> Bool #
Synthesiser Identity Source #
Instance details Defined in Verismith.Tool.Identity Methods runSynth :: Show ann => Identity -> SourceInfo ann -> ResultSh () Source # synthOutput :: Identity -> FilePath Source # setSynthOutput :: Identity -> FilePath -> Identity Source #
Tool Identity Source #
Instance details Defined in Verismith.Tool.Identity Methods toText :: Identity -> Text Source #

defaultIdentity :: Identity Source #

Equivalence

runEquiv :: (Synthesiser a, Synthesiser b, Show ann) => Maybe Text -> FilePath -> a -> b -> SourceInfo ann -> ResultSh () Source #

Simulation

runSim Source #

Arguments

:: (Simulator a, Show ann)
=> a	Simulator instance
-> SourceInfo ann	Run information
-> [ByteString]	Inputs to simulate
-> ResultSh ByteString	Returns the value of the hash at the output of the testbench.

Synthesis

runSynth Source #

Arguments

:: (Synthesiser a, Show ann)
=> a	Synthesiser tool instance
-> SourceInfo ann	Run information
-> ResultSh ()	does not return any values

logger :: Text -> Sh () Source #