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

Functor NetlistMonad

Applicative NetlistMonad

MonadIO NetlistMonad

Fresh NetlistMonad

MonadState NetlistState NetlistMonad

MonadWriter (Set (Identifier, HWType)) NetlistMonad

data NetlistState

State of the NetlistMonad

Constructors

NetlistState

Fields

_bindings :: HashMap TmName (Type, Term)

Global binders

_varEnv :: Gamma

Type environment/context

_varCount :: !Int

Number of signal declarations

_cmpCount :: !Int

Number of create components

_components :: HashMap TmName Component

Cached components

_primitives :: PrimMap

Primitive Definitions

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

Hardcoded Type -> HWType translator

_tcCache :: HashMap TyConName TyCon

TyCon cache

_modNm :: !String

Name of the module containing the topEntity

_curCompNm :: !Identifier

_dataFiles :: [(String, FilePath)]

Instances

MonadState NetlistState NetlistMonad

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

NFData 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

Bool

Boolean type

Integer

Integer type

BitVector !Size

BitVector of a specified size

Index !Size

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

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 !Int

Clock type with specified name and period

Reset !Identifier !Int

Reset type corresponding to clock with a specified name and period

Instances

Eq HWType

Ord HWType

Show HWType

Generic HWType

NFData HWType

Hashable HWType

MonadWriter (Set (Identifier, HWType)) NetlistMonad

type Rep HWType

data Declaration

Internals of a Component

Constructors

Assignment !Identifier !Expr

Signal assignment:

• Signal to assign
• Assigned expression

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

Conditional signal assignment:

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

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

Instantiation of another component

BlackBoxD !Text !BlackBoxTemplate BlackBoxContext

Instantiation of blackbox declaration

NetDecl !Identifier !HWType

Signal declaration

Instances

Show Declaration

NFData Declaration

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

Instances

Show Modifier

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 !BlackBoxTemplate !BlackBoxContext !Bool

Instantiation of a BlackBox expression

Instances

Show Expr

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

Show Literal

data Bit

Bit literal

Constructors

H

High

L

Low

U

Undefined

Z

High-impedance

Instances

Show Bit

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)

Instances

Show BlackBoxContext

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, Int))

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)

primitives :: Lens' NetlistState PrimMap

modNm :: Lens' NetlistState String

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

curCompNm :: Lens' NetlistState Identifier

components :: Lens' NetlistState (HashMap TmName Component)

cmpCount :: Lens' NetlistState Int

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