Clash.Backend.Verilog.Time

Utilities and definitions to deal with Verilog's time unit. These definitions are here mostly to deal with varying `timescale defintions, see:

https://www.chipverify.com/verilog/verilog-timescale

Documentation

data Unit

Verilog time units

Constructors

Fs

Ps

Ns

Us

Ms

S

Instances

Bounded Unit

Defined in Clash.Backend.Verilog.Time

Methods

minBound :: Unit

maxBound :: Unit

Enum Unit

Defined in Clash.Backend.Verilog.Time

Methods

succ :: Unit -> Unit

pred :: Unit -> Unit

toEnum :: Int -> Unit

fromEnum :: Unit -> Int

enumFrom :: Unit -> [Unit]

enumFromThen :: Unit -> Unit -> [Unit]

enumFromTo :: Unit -> Unit -> [Unit]

enumFromThenTo :: Unit -> Unit -> Unit -> [Unit]

Eq Unit

Defined in Clash.Backend.Verilog.Time

Methods

(==) :: Unit -> Unit -> Bool

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

Ord Unit

Defined in Clash.Backend.Verilog.Time

Methods

compare :: Unit -> Unit -> Ordering

(<) :: Unit -> Unit -> Bool

(<=) :: Unit -> Unit -> Bool

(>) :: Unit -> Unit -> Bool

(>=) :: Unit -> Unit -> Bool

max :: Unit -> Unit -> Unit

min :: Unit -> Unit -> Unit

Show Unit

Defined in Clash.Backend.Verilog.Time

Methods

showsPrec :: Int -> Unit -> ShowS

show :: Unit -> String

showList :: [Unit] -> ShowS

Generic Unit

Defined in Clash.Backend.Verilog.Time

Associated Types

type Rep Unit :: Type -> Type

Methods

from :: Unit -> Rep Unit x

to :: Rep Unit x -> Unit

Hashable Unit

Defined in Clash.Backend.Verilog.Time

Methods

hashWithSalt :: Int -> Unit -> Int

hash :: Unit -> Int

NFData Unit

Defined in Clash.Backend.Verilog.Time

Methods

rnf :: Unit -> ()

type Rep Unit

Defined in Clash.Backend.Verilog.Time

type Rep Unit = D1 ('MetaData "Unit" "Clash.Backend.Verilog.Time" "clash-lib-1.8.1-inplace" 'False) ((C1 ('MetaCons "Fs" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Ps" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ns" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Us" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Ms" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "S" 'PrefixI 'False) (U1 :: Type -> Type))))

type TryDomain t Unit

Defined in Clash.Backend.Verilog.Time

type TryDomain t Unit = 'NotFound

data Period

Verilog time period. A combination of a length and a unit.

Constructors

Period Word64 Unit

Instances

Eq Period

Defined in Clash.Backend.Verilog.Time

Methods

(==) :: Period -> Period -> Bool

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

Show Period

Defined in Clash.Backend.Verilog.Time

Methods

showsPrec :: Int -> Period -> ShowS

show :: Period -> String

showList :: [Period] -> ShowS

Generic Period

Defined in Clash.Backend.Verilog.Time

Associated Types

type Rep Period :: Type -> Type

Methods

from :: Period -> Rep Period x

to :: Rep Period x -> Period

Hashable Period

Defined in Clash.Backend.Verilog.Time

Methods

hashWithSalt :: Int -> Period -> Int

hash :: Period -> Int

NFData Period

Defined in Clash.Backend.Verilog.Time

Methods

rnf :: Period -> ()

type Rep Period

Defined in Clash.Backend.Verilog.Time

type Rep Period = D1 ('MetaData "Period" "Clash.Backend.Verilog.Time" "clash-lib-1.8.1-inplace" 'False) (C1 ('MetaCons "Period" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Unit)))

data Scale

Verilog timescale. Influences simulation precision.

Constructors

Scale

Fields

• step :: Period

  Time step in wait statements, e.g. `#1`.

• precision :: Period

  Simulator precision - all units will get rounded to this period.

Instances

Eq Scale

Defined in Clash.Backend.Verilog.Time

Methods

(==) :: Scale -> Scale -> Bool

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

Show Scale

Defined in Clash.Backend.Verilog.Time

Methods

showsPrec :: Int -> Scale -> ShowS

show :: Scale -> String

showList :: [Scale] -> ShowS

Generic Scale

Defined in Clash.Backend.Verilog.Time

Associated Types

type Rep Scale :: Type -> Type

Methods

from :: Scale -> Rep Scale x

to :: Rep Scale x -> Scale

Hashable Scale

Defined in Clash.Backend.Verilog.Time

Methods

hashWithSalt :: Int -> Scale -> Int

hash :: Scale -> Int

NFData Scale

Defined in Clash.Backend.Verilog.Time

Methods

rnf :: Scale -> ()

type Rep Scale

Defined in Clash.Backend.Verilog.Time

type Rep Scale = D1 ('MetaData "Scale" "Clash.Backend.Verilog.Time" "clash-lib-1.8.1-inplace" 'False) (C1 ('MetaCons "Scale" 'PrefixI 'True) (S1 ('MetaSel ('Just "step") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Period) :*: S1 ('MetaSel ('Just "precision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Period)))

scaleToString :: Scale -> String

Pretty print Scale to Verilog `timescale

>>> scaleToString (Scale (Period 100 Ps) (Period 10 Fs))
"`timescale 100ps/10fs"

periodToString :: Period -> String

Convert Unit to Verilog time unit

>>> periodToString (Period 100 Fs)
"100fs"

unitToString :: Unit -> String

Convert Unit to Verilog time unit

>>> unitToString Ms
"ms"

parseUnit :: String -> Maybe Unit

Parse string representing a Verilog time unit to Unit.

>>> parseUnit "ms"
Just Ms
>>> parseUnit "xs"
Nothing

parsePeriod :: String -> Maybe Period

Parse a Verilog

>>> parsePeriod "100ms"
Just (Period 100 Ms)
>>> parsePeriod "100xs"
Nothing
>>> parsePeriod "100"
Nothing
>>> parsePeriod "ms"
Nothing

convertUnit :: Unit -> Period -> Word64

Convert a period to a specific time unit. Will always output a minimum of 1, even if the given Period is already of the right Unit.

>>> convertUnit Ps (Period 100 Ps)
100
>>> convertUnit Fs (Period 100 Ps)
100000
>>> convertUnit Ns (Period 100 Ps)
1
>>> convertUnit Ms (Period 0 Ms)
1