CLaSH.Netlist.Types

Type and instance definitions for Netlist modules

Documentation

newtype NetlistMonad a

Monad that caches generated components (StateT) and remembers hidden inputs of components that are being generated (WriterT)

Constructors

NetlistMonad

Fields

• runNetlist :: WriterT (Set (Identifier, HWType)) (StateT NetlistState (FreshMT IO)) a

Instances

Monad NetlistMonad

Methods

(>>=) :: NetlistMonad a -> (a -> NetlistMonad b) -> NetlistMonad b

(>>) :: NetlistMonad a -> NetlistMonad b -> NetlistMonad b

return :: a -> NetlistMonad a

fail :: String -> NetlistMonad a

Functor NetlistMonad

Methods

fmap :: (a -> b) -> NetlistMonad a -> NetlistMonad b

(<$) :: a -> NetlistMonad b -> NetlistMonad a

Applicative NetlistMonad

Methods

pure :: a -> NetlistMonad a

(<*>) :: NetlistMonad (a -> b) -> NetlistMonad a -> NetlistMonad b

(*>) :: NetlistMonad a -> NetlistMonad b -> NetlistMonad b

(<*) :: NetlistMonad a -> NetlistMonad b -> NetlistMonad a

MonadIO NetlistMonad

Methods

liftIO :: IO a -> NetlistMonad a

Fresh NetlistMonad

Methods

fresh :: Name a -> NetlistMonad (Name a)

MonadState NetlistState NetlistMonad

Methods

get :: NetlistMonad NetlistState

put :: NetlistState -> NetlistMonad ()

state :: (NetlistState -> (a, NetlistState)) -> NetlistMonad a

MonadWriter (Set (Identifier, HWType)) NetlistMonad

Methods

writer :: (a, Set (Identifier, HWType)) -> NetlistMonad a

tell :: Set (Identifier, HWType) -> NetlistMonad ()

listen :: NetlistMonad a -> NetlistMonad (a, Set (Identifier, HWType))

pass :: NetlistMonad (a, Set (Identifier, HWType) -> Set (Identifier, HWType)) -> NetlistMonad a

data NetlistState

State of the NetlistMonad

Constructors

NetlistState

Fields

• _bindings :: HashMap TmName (Type, SrcSpan, Term)

  Global binders

• _varEnv :: Gamma

  Type environment/context

• _varCount :: !Int

  Number of signal declarations

• _components :: HashMap TmName (SrcSpan, Component)

  Cached components

• _primitives :: PrimMap BlackBoxTemplate

  Primitive Definitions

• _typeTranslator :: HashMap TyConName TyCon -> Type -> Maybe (Either String HWType)

  Hardcoded Type -> HWType translator

• _tcCache :: HashMap TyConName TyCon

  TyCon cache

• _curCompNm :: !(Identifier, SrcSpan)
• _dataFiles :: [(String, FilePath)]
• _intWidth :: Int
• _mkBasicIdFn :: Identifier -> Identifier
• _seenIds :: [Identifier]
• _seenComps :: [Identifier]
• _componentNames :: HashMap TmName Identifier

Instances

MonadState NetlistState NetlistMonad

Methods

get :: NetlistMonad NetlistState

put :: NetlistState -> NetlistMonad ()

state :: (NetlistState -> (a, NetlistState)) -> NetlistMonad a

type Identifier = Text

Signal reference

data Component

Component: base unit of a Netlist

Constructors

Component

Fields

• componentName :: !Identifier

  Name of the component

• hiddenPorts :: [(Identifier, HWType)]

  Ports that have no correspondence the original function definition

• inputs :: [(Identifier, HWType)]

  Input ports

• outputs :: [(Identifier, HWType)]

  Output ports

• declarations :: [Declaration]

  Internal declarations

Instances

Show Component

Methods

showsPrec :: Int -> Component -> ShowS

show :: Component -> String

showList :: [Component] -> ShowS

NFData Component

Methods

rnf :: Component -> ()

type Size = Int

Size indication of a type (e.g. bit-size or number of elements)

data HWType

Representable hardware types

Constructors

Void

Empty type

String

String type

Bool

Boolean type

BitVector !Size

BitVector of a specified size

Index !Integer

Unsigned integer with specified (exclusive) upper bounder

Signed !Size

Signed integer of a specified size

Unsigned !Size

Unsigned integer of a specified size

Vector !Size !HWType

Vector type

RTree !Size !HWType

RTree type

Sum !Identifier [Identifier]

Sum type: Name and Constructor names

Product !Identifier [HWType]

Product type: Name and field types

SP !Identifier [(Identifier, [HWType])]

Sum-of-Product type: Name and Constructor names + field types

Clock !Identifier !Integer

Clock type with specified name and period

Reset !Identifier !Integer

Reset type corresponding to clock with a specified name and period

Instances

Eq HWType

Methods

(==) :: HWType -> HWType -> Bool

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

Ord HWType

Methods

compare :: HWType -> HWType -> Ordering

(<) :: HWType -> HWType -> Bool

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

(>) :: HWType -> HWType -> Bool

(>=) :: HWType -> HWType -> Bool

max :: HWType -> HWType -> HWType

min :: HWType -> HWType -> HWType

Show HWType

Methods

showsPrec :: Int -> HWType -> ShowS

show :: HWType -> String

showList :: [HWType] -> ShowS

Generic HWType

Associated Types

type Rep HWType :: * -> *

Methods

from :: HWType -> Rep HWType x

to :: Rep HWType x -> HWType

Hashable HWType

Methods

hashWithSalt :: Int -> HWType -> Int

hash :: HWType -> Int

NFData HWType

Methods

rnf :: HWType -> ()

MonadWriter (Set (Identifier, HWType)) NetlistMonad

Methods

writer :: (a, Set (Identifier, HWType)) -> NetlistMonad a

tell :: Set (Identifier, HWType) -> NetlistMonad ()

listen :: NetlistMonad a -> NetlistMonad (a, Set (Identifier, HWType))

pass :: NetlistMonad (a, Set (Identifier, HWType) -> Set (Identifier, HWType)) -> NetlistMonad a

type Rep HWType

type Rep HWType = D1 (MetaData "HWType" "CLaSH.Netlist.Types" "clash-lib-0.7-83ZNOjNIImPHkX9dasXVwo" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "Void" PrefixI False) U1) ((:+:) (C1 (MetaCons "String" PrefixI False) U1) (C1 (MetaCons "Bool" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "BitVector" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Size))) (C1 (MetaCons "Index" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer)))) ((:+:) (C1 (MetaCons "Signed" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Size))) (C1 (MetaCons "Unsigned" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Size)))))) ((:+:) ((:+:) (C1 (MetaCons "Vector" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Size)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HWType)))) ((:+:) (C1 (MetaCons "RTree" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Size)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HWType)))) (C1 (MetaCons "Sum" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Identifier])))))) ((:+:) ((:+:) (C1 (MetaCons "Product" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [HWType])))) (C1 (MetaCons "SP" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Identifier, [HWType])]))))) ((:+:) (C1 (MetaCons "Clock" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer)))) (C1 (MetaCons "Reset" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer))))))))

data Declaration

Internals of a Component

Constructors

Assignment !Identifier !Expr

Signal assignment:

• Signal to assign
• Assigned expression

CondAssignment !Identifier !HWType !Expr !HWType [(Maybe Literal, Expr)]

Conditional signal assignment:

• Signal to assign
• Type of the result/alternatives
• Scrutinized expression
• Type of the scrutinee
• List of: (Maybe expression scrutinized expression is compared with,RHS of alternative)

InstDecl !Identifier !Identifier [(Identifier, PortDirection, HWType, Expr)]

Instantiation of another component

BlackBoxD !Text [Text] [Text] (Maybe (Text, BlackBoxTemplate)) !BlackBoxTemplate BlackBoxContext

Instantiation of blackbox declaration

NetDecl !Identifier !HWType

Signal declaration

Instances

Show Declaration

Methods

showsPrec :: Int -> Declaration -> ShowS

show :: Declaration -> String

showList :: [Declaration] -> ShowS

NFData Declaration

Methods

rnf :: Declaration -> ()

data PortDirection

Constructors

In

Out

Instances

Show PortDirection

Methods

showsPrec :: Int -> PortDirection -> ShowS

show :: PortDirection -> String

showList :: [PortDirection] -> ShowS

data Modifier

Expression Modifier

Constructors

Indexed (HWType, Int, Int)

Index the expression: (Type of expression,DataCon tag,Field Tag)

DC (HWType, Int)

See expression in a DataCon context: (Type of the expression, DataCon tag)

VecAppend

See the expression in the context of a Vector append operation

RTreeAppend

See the expression in the context of a Tree append operation

Instances

Show Modifier

Methods

showsPrec :: Int -> Modifier -> ShowS

show :: Modifier -> String

showList :: [Modifier] -> ShowS

data Expr

Expression used in RHS of a declaration

Constructors

Literal !(Maybe (HWType, Size)) !Literal

Literal expression

DataCon !HWType !Modifier [Expr]

DataCon application

Identifier !Identifier !(Maybe Modifier)

Signal reference

DataTag !HWType !(Either Identifier Identifier)

Left e: tagToEnum

BlackBoxE !Text [Text] [Text] (Maybe (Text, BlackBoxTemplate)) !BlackBoxTemplate !BlackBoxContext !Bool

Instantiation of a BlackBox expression

Instances

Show Expr

Methods

showsPrec :: Int -> Expr -> ShowS

show :: Expr -> String

showList :: [Expr] -> ShowS

data Literal

Literals used in an expression

Constructors

NumLit !Integer

Number literal

BitLit !Bit

Bit literal

BoolLit !Bool

Boolean literal

VecLit [Literal]

Vector literal

StringLit !String

String literal

Instances

Eq Literal

Methods

(==) :: Literal -> Literal -> Bool

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

Show Literal

Methods

showsPrec :: Int -> Literal -> ShowS

show :: Literal -> String

showList :: [Literal] -> ShowS

data Bit

Bit literal

Constructors

H

High

L

Low

U

Undefined

Z

High-impedance

Instances

Eq Bit

Methods

(==) :: Bit -> Bit -> Bool

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

Show Bit

Methods

showsPrec :: Int -> Bit -> ShowS

show :: Bit -> String

showList :: [Bit] -> ShowS

data BlackBoxContext

Context used to fill in the holes of a BlackBox template

Constructors

Context

Fields

• bbResult :: (SyncExpr, HWType)

  Result name and type

• bbInputs :: [(SyncExpr, HWType, Bool)]

  Argument names, types, and whether it is a literal

• bbFunctions :: IntMap (Either BlackBoxTemplate Declaration, BlackBoxContext)

  Function arguments (subset of inputs):

  • (Blackbox Template,Partial Blackbox Concext)
• bbQsysIncName :: Maybe Identifier

Instances

Show BlackBoxContext

Methods

showsPrec :: Int -> BlackBoxContext -> ShowS

show :: BlackBoxContext -> String

showList :: [BlackBoxContext] -> ShowS

emptyBBContext :: BlackBoxContext

type SyncIdentifier = Either Identifier (Identifier, (Identifier, Int))

Either the name of the identifier, or a tuple of the identifier and the corresponding clock

type SyncExpr = Either Expr (Expr, (Identifier, Integer))

varEnv :: Lens' NetlistState Gamma

varCount :: Lens' NetlistState Int

typeTranslator :: Lens' NetlistState (HashMap TyConName TyCon -> Type -> Maybe (Either String HWType))

tcCache :: Lens' NetlistState (HashMap TyConName TyCon)

seenIds :: Lens' NetlistState [Identifier]

seenComps :: Lens' NetlistState [Identifier]

primitives :: Lens' NetlistState (PrimMap BlackBoxTemplate)

mkBasicIdFn :: Lens' NetlistState (Identifier -> Identifier)

intWidth :: Lens' NetlistState Int

dataFiles :: Lens' NetlistState [(String, FilePath)]

curCompNm :: Lens' NetlistState (Identifier, SrcSpan)

components :: Lens' NetlistState (HashMap TmName (SrcSpan, Component))

componentNames :: Lens' NetlistState (HashMap TmName Identifier)

bindings :: Lens' NetlistState (HashMap TmName (Type, SrcSpan, Term))