Data.VCD

Generating and parsing Value Change Dump (VCD) files.

VCD Generation

data VCDHandle

The VCDHandle keeps track of generation state and the output handle.

data Timescale

VCD Timescale.

Constructors

S

seconds

MS

milliseconds

US

microseconds

PS

picoseconds

Instances

Show Timescale

class Variable a where

Types that can be recorded as VCD variables.

Methods

var :: VCDHandle -> String -> a -> IO (a -> IO ())

Define a new variable.

Instances

Variable Bool

Variable Double

Variable Float

Variable Int

Variable Int8

Variable Int16

Variable Int32

Variable Int64

Variable Word8

Variable Word16

Variable Word32

Variable Word64

variable :: Eq a => String -> Int -> (a -> String) -> VCDHandle -> String -> a -> IO (a -> IO ())

Helper to create new Variable instances.

newVCD :: Handle -> Timescale -> IO VCDHandle

Create a new handle for generating a VCD file with a given timescale.

scope :: VCDHandle -> String -> IO a -> IO a

Define a hierarchical scope.

step :: VCDHandle -> Int -> IO ()

Set a time step. step will also transition a VCDHandle from the definition to the recording phase.

step' :: VCDHandle -> Int -> IO ()

Save as step, but forces a step recording even if variables have not changed. Useful for realtime simulation.

VCD Parsing

data VCD

VCD database.

Constructors

VCD Timescale [Definition] [(Int, [(String, Value)])]

Instances

Show VCD

data Definition

Variable definition.

Constructors

Scope String [Definition]

Hierarchical scope.

Var String Int String String

Variable with type, width, code, name.

Instances

Show Definition

data Value

Recorded value.

Constructors

Bool Bool

Bits [Bool]

Double Double

Instances

Show Value

parseVCD :: String -> VCD

Parse VCD data.