Copyright	(C) 2012-2016 University of Twente 2017 Myrtle Software Ltd Google Inc.
License	BSD2 (see the file LICENSE)
Maintainer	Christiaan Baaij <christiaan.baaij@gmail.com>
Safe Haskell	None
Language	Haskell2010

Clash.Netlist.Types

Contents

Orphan instances

Description

Type and instance definitions for Netlist modules

Synopsis

data Declaration where
- Assignment !Identifier !Expr
- CondAssignment !Identifier !HWType !Expr !HWType [(Maybe Literal, Expr)]
- InstDecl (Maybe Identifier) !Identifier !Identifier [(Expr, PortDirection, HWType, Expr)]
- BlackBoxD !Text [BlackBoxTemplate] [BlackBoxTemplate] (Maybe ((Text, Text), BlackBoxTemplate)) !BlackBoxTemplate BlackBoxContext
- NetDecl' (Maybe Identifier) WireOrReg !Identifier (Either Identifier HWType)
- pattern NetDecl :: Maybe Identifier -> Identifier -> HWType -> Declaration
data BlackBoxContext = Context {
- bbResult :: (Expr, HWType)
- bbInputs :: [(Expr, HWType, Bool)]
- bbFunctions :: IntMap (Either BlackBoxTemplate (Identifier, [Declaration]), WireOrReg, [BlackBoxTemplate], [BlackBoxTemplate], Maybe ((Text, Text), BlackBoxTemplate), BlackBoxContext)
- bbQsysIncName :: Maybe Identifier
}
data Bit
- = H
- | L
- | U
- | Z
data Literal
- = NumLit !Integer
- | BitLit !Bit
- | BoolLit !Bool
- | VecLit [Literal]
- | StringLit !String
data Expr
- = Literal !(Maybe (HWType, Size)) !Literal
- | DataCon !HWType !Modifier [Expr]
- | Identifier !Identifier !(Maybe Modifier)
- | DataTag !HWType !(Either Identifier Identifier)
- | BlackBoxE !Text [BlackBoxTemplate] [BlackBoxTemplate] (Maybe ((Text, Text), BlackBoxTemplate)) !BlackBoxTemplate !BlackBoxContext !Bool
- | ConvBV (Maybe Identifier) HWType Bool Expr
data Modifier
- = Indexed (HWType, Int, Int)
- | DC (HWType, Int)
- | VecAppend
- | RTreeAppend
- | Nested Modifier Modifier
data PortDirection
- = In
- | Out
data WireOrReg
- = Wire
- | Reg
data Declaration
- = Assignment !Identifier !Expr
- | CondAssignment !Identifier !HWType !Expr !HWType [(Maybe Literal, Expr)]
- | InstDecl (Maybe Identifier) !Identifier !Identifier [(Expr, PortDirection, HWType, Expr)]
- | BlackBoxD !Text [BlackBoxTemplate] [BlackBoxTemplate] (Maybe ((Text, Text), BlackBoxTemplate)) !BlackBoxTemplate BlackBoxContext
- | NetDecl' (Maybe Identifier) WireOrReg !Identifier (Either Identifier HWType)
data HWType
- = Void (Maybe HWType)
- | String
- | Bool
- | Bit
- | BitVector !Size
- | Index !Integer
- | Signed !Size
- | Unsigned !Size
- | Vector !Size !HWType
- | RTree !Size !HWType
- | Sum !Identifier [Identifier]
- | Product !Identifier [HWType]
- | SP !Identifier [(Identifier, [HWType])]
- | Clock !Identifier !Integer !ClockKind
- | Reset !Identifier !Integer !ResetKind
type Size = Int
data Component = Component {
- componentName :: !Identifier
- inputs :: [(Identifier, HWType)]
- outputs :: [(WireOrReg, (Identifier, HWType))]
- declarations :: [Declaration]
}
type Identifier = Text
data NetlistState = NetlistState {
- _bindings :: BindingMap
- _varCount :: !Int
- _components :: HashMap TmOccName (SrcSpan, Component)
- _primitives :: PrimMap BlackBoxTemplate
- _typeTranslator :: HashMap TyConOccName TyCon -> Bool -> Type -> Maybe (Either String HWType)
- _tcCache :: HashMap TyConOccName TyCon
- _curCompNm :: !(Identifier, SrcSpan)
- _dataFiles :: [(String, FilePath)]
- _intWidth :: Int
- _mkIdentifierFn :: IdType -> Identifier -> Identifier
- _extendIdentifierFn :: IdType -> Identifier -> Identifier -> Identifier
- _seenIds :: [Identifier]
- _seenComps :: [Identifier]
- _componentNames :: HashMap TmOccName Identifier
- _topEntityAnns :: HashMap TmOccName (Type, Maybe TopEntity)
- _hdlDir :: FilePath
}
newtype NetlistMonad a = NetlistMonad {
- runNetlist :: StateT NetlistState (FreshMT IO) a
}
pattern NetDecl :: Maybe Identifier -> Identifier -> HWType -> Declaration
emptyBBContext :: BlackBoxContext
bindings :: Lens' NetlistState BindingMap
componentNames :: Lens' NetlistState (HashMap TmOccName Identifier)
components :: Lens' NetlistState (HashMap TmOccName (SrcSpan, Component))
curCompNm :: Lens' NetlistState (Identifier, SrcSpan)
dataFiles :: Lens' NetlistState [(String, FilePath)]
extendIdentifierFn :: Lens' NetlistState (IdType -> Identifier -> Identifier -> Identifier)
hdlDir :: Lens' NetlistState FilePath
intWidth :: Lens' NetlistState Int
mkIdentifierFn :: Lens' NetlistState (IdType -> Identifier -> Identifier)
primitives :: Lens' NetlistState (PrimMap BlackBoxTemplate)
seenComps :: Lens' NetlistState [Identifier]
seenIds :: Lens' NetlistState [Identifier]
tcCache :: Lens' NetlistState (HashMap TyConOccName TyCon)
topEntityAnns :: Lens' NetlistState (HashMap TmOccName (Type, Maybe TopEntity))
typeTranslator :: Lens' NetlistState (HashMap TyConOccName TyCon -> Bool -> Type -> Maybe (Either String HWType))
varCount :: Lens' NetlistState Int

Documentation

data Declaration Source #

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 (Maybe Identifier) !Identifier !Identifier [(Expr, PortDirection, HWType, Expr)]	Instantiation of another component
BlackBoxD !Text [BlackBoxTemplate] [BlackBoxTemplate] (Maybe ((Text, Text), BlackBoxTemplate)) !BlackBoxTemplate BlackBoxContext	Instantiation of blackbox declaration
NetDecl' (Maybe Identifier) WireOrReg !Identifier (Either Identifier HWType)	Signal declaration

Bundled Patterns

pattern NetDecl :: Maybe Identifier -> Identifier -> HWType -> Declaration

Instances

Show Declaration Source #
Instance details Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS #
NFData Declaration Source #
Instance details Methods rnf :: Declaration -> () #

data BlackBoxContext Source #

Context used to fill in the holes of a BlackBox template

Constructors

Context

Fields

bbResult :: (Expr, HWType)
Result name and type
bbInputs :: [(Expr, HWType, Bool)]
Argument names, types, and whether it is a literal
bbFunctions :: IntMap (Either BlackBoxTemplate (Identifier, [Declaration]), WireOrReg, [BlackBoxTemplate], [BlackBoxTemplate], Maybe ((Text, Text), BlackBoxTemplate), BlackBoxContext)
Function arguments (subset of inputs):
- ( Blackbox Template , Whether the result should be reg or a wire (Verilog only) , Partial Blackbox Context )
bbQsysIncName :: Maybe Identifier

Instances

Show BlackBoxContext Source #
Instance details Methods showsPrec :: Int -> BlackBoxContext -> ShowS # show :: BlackBoxContext -> String # showList :: [BlackBoxContext] -> ShowS #

data Bit Source #

Bit literal

Constructors

H	High
L	Low
U	Undefined
Z	High-impedance

Instances

Eq Bit Source #
Instance details Methods (==) :: Bit -> Bit -> Bool # (/=) :: Bit -> Bit -> Bool #
Show Bit Source #
Instance details Methods showsPrec :: Int -> Bit -> ShowS # show :: Bit -> String # showList :: [Bit] -> ShowS #

data Literal Source #

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 Source #
Instance details Methods (==) :: Literal -> Literal -> Bool # (/=) :: Literal -> Literal -> Bool #
Show Literal Source #
Instance details Methods showsPrec :: Int -> Literal -> ShowS # show :: Literal -> String # showList :: [Literal] -> ShowS #

data Expr Source #

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] [BlackBoxTemplate] (Maybe ((Text, Text), BlackBoxTemplate)) !BlackBoxTemplate !BlackBoxContext !Bool	Instantiation of a BlackBox expression
ConvBV (Maybe Identifier) HWType Bool Expr

Instances

Show Expr Source #
Instance details Methods showsPrec :: Int -> Expr -> ShowS # show :: Expr -> String # showList :: [Expr] -> ShowS #

data Modifier Source #

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
Nested Modifier Modifier

Instances

Show Modifier Source #
Instance details Methods showsPrec :: Int -> Modifier -> ShowS # show :: Modifier -> String # showList :: [Modifier] -> ShowS #

data PortDirection Source #

Constructors

In
Out

Instances

Show PortDirection Source #
Instance details Methods showsPrec :: Int -> PortDirection -> ShowS # show :: PortDirection -> String # showList :: [PortDirection] -> ShowS #

data WireOrReg Source #

Constructors

Wire
Reg

Instances

Show WireOrReg Source #
Instance details Methods showsPrec :: Int -> WireOrReg -> ShowS # show :: WireOrReg -> String # showList :: [WireOrReg] -> ShowS #
Generic WireOrReg Source #
Instance details Associated Types type Rep WireOrReg :: * -> * # Methods from :: WireOrReg -> Rep WireOrReg x # to :: Rep WireOrReg x -> WireOrReg #
NFData WireOrReg Source #
Instance details Methods rnf :: WireOrReg -> () #
type Rep WireOrReg Source #
Instance details type Rep WireOrReg = D1 (MetaData "WireOrReg" "Clash.Netlist.Types" "clash-lib-0.99.1-inplace" False) (C1 (MetaCons "Wire" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "Reg" PrefixI False) (U1 :: -> *))

data Declaration Source #

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 (Maybe Identifier) !Identifier !Identifier [(Expr, PortDirection, HWType, Expr)]	Instantiation of another component
BlackBoxD !Text [BlackBoxTemplate] [BlackBoxTemplate] (Maybe ((Text, Text), BlackBoxTemplate)) !BlackBoxTemplate BlackBoxContext	Instantiation of blackbox declaration
NetDecl' (Maybe Identifier) WireOrReg !Identifier (Either Identifier HWType)	Signal declaration

Instances

Show Declaration Source #
Instance details Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS #
NFData Declaration Source #
Instance details Methods rnf :: Declaration -> () #

data HWType Source #

Representable hardware types

Constructors

Void (Maybe HWType)	Empty type. `Just Size` for "empty" Vectors so we can still have primitives that can traverse e.g. Vectors of unit and know the lenght of that vector.
String	String type
Bool	Boolean type
Bit	Bit 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 !ClockKind	Clock type with specified name and period
Reset !Identifier !Integer !ResetKind	Reset type corresponding to clock with a specified name and period

Instances

Eq HWType Source #
Instance details Methods (==) :: HWType -> HWType -> Bool # (/=) :: HWType -> HWType -> Bool #
Ord HWType Source #
Instance details 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 Source #
Instance details Methods showsPrec :: Int -> HWType -> ShowS # show :: HWType -> String # showList :: [HWType] -> ShowS #
Generic HWType Source #
Instance details Associated Types type Rep HWType :: * -> * # Methods from :: HWType -> Rep HWType x # to :: Rep HWType x -> HWType #
NFData HWType Source #
Instance details Methods rnf :: HWType -> () #
Hashable HWType Source #
Instance details Methods hashWithSalt :: Int -> HWType -> Int hash :: HWType -> Int
type Rep HWType Source #
Instance details type Rep HWType = D1 (MetaData "HWType" "Clash.Netlist.Types" "clash-lib-0.99.1-inplace" False) (((C1 (MetaCons "Void" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe HWType))) :+: (C1 (MetaCons "String" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "Bool" PrefixI False) (U1 :: -> ))) :+: ((C1 (MetaCons "Bit" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "BitVector" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Size))) :+: (C1 (MetaCons "Index" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer)) :+: C1 (MetaCons "Signed" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Size))))) :+: (((C1 (MetaCons "Unsigned" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Size)) :+: C1 (MetaCons "Vector" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Size) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HWType))) :+: (C1 (MetaCons "RTree" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Size) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HWType)) :+: C1 (MetaCons "Sum" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Identifier])))) :+: ((C1 (MetaCons "Product" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [HWType])) :+: C1 (MetaCons "SP" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Identifier, [HWType])]))) :+: (C1 (MetaCons "Clock" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier) :: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ClockKind))) :+: C1 (MetaCons "Reset" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier) :: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResetKind)))))))

type Size = Int Source #

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

data Component Source #

Component: base unit of a Netlist

Constructors

Component
Fields componentName :: !Identifier Name of the component inputs :: [(Identifier, HWType)] Input ports outputs :: [(WireOrReg, (Identifier, HWType))] Output ports declarations :: [Declaration] Internal declarations

Instances

Show Component Source #
Instance details Methods showsPrec :: Int -> Component -> ShowS # show :: Component -> String # showList :: [Component] -> ShowS #
NFData Component Source #
Instance details Methods rnf :: Component -> () #

type Identifier = Text Source #

Signal reference

data NetlistState Source #

State of the NetlistMonad

Constructors

NetlistState

Fields

_bindings :: BindingMap
Global binders
_varCount :: !Int
Number of signal declarations
_components :: HashMap TmOccName (SrcSpan, Component)
Cached components
_primitives :: PrimMap BlackBoxTemplate
Primitive Definitions
_typeTranslator :: HashMap TyConOccName TyCon -> Bool -> Type -> Maybe (Either String HWType)
Hardcoded Type -> HWType translator
_tcCache :: HashMap TyConOccName TyCon
TyCon cache
_curCompNm :: !(Identifier, SrcSpan)
_dataFiles :: [(String, FilePath)]
_intWidth :: Int
_mkIdentifierFn :: IdType -> Identifier -> Identifier
_extendIdentifierFn :: IdType -> Identifier -> Identifier -> Identifier
_seenIds :: [Identifier]
_seenComps :: [Identifier]
_componentNames :: HashMap TmOccName Identifier
_topEntityAnns :: HashMap TmOccName (Type, Maybe TopEntity)
_hdlDir :: FilePath

Instances

MonadState NetlistState NetlistMonad Source #
Instance details Methods get :: NetlistMonad NetlistState # put :: NetlistState -> NetlistMonad () # state :: (NetlistState -> (a, NetlistState)) -> NetlistMonad a #

newtype NetlistMonad a Source #

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

Constructors

NetlistMonad
Fields runNetlist :: StateT NetlistState (FreshMT IO) a

Instances

Monad NetlistMonad Source #
Instance details Methods (>>=) :: NetlistMonad a -> (a -> NetlistMonad b) -> NetlistMonad b # (>>) :: NetlistMonad a -> NetlistMonad b -> NetlistMonad b # return :: a -> NetlistMonad a # fail :: String -> NetlistMonad a #
Functor NetlistMonad Source #
Instance details Methods fmap :: (a -> b) -> NetlistMonad a -> NetlistMonad b # (<$) :: a -> NetlistMonad b -> NetlistMonad a #
Applicative NetlistMonad Source #
Instance details Methods pure :: a -> NetlistMonad a # (<>) :: NetlistMonad (a -> b) -> NetlistMonad a -> NetlistMonad b # liftA2 :: (a -> b -> c) -> NetlistMonad a -> NetlistMonad b -> NetlistMonad c # (>) :: NetlistMonad a -> NetlistMonad b -> NetlistMonad b # (<*) :: NetlistMonad a -> NetlistMonad b -> NetlistMonad a #
MonadIO NetlistMonad Source #
Instance details Methods liftIO :: IO a -> NetlistMonad a #
Fresh NetlistMonad Source #
Instance details Methods fresh :: Name a -> NetlistMonad (Name a)
MonadState NetlistState NetlistMonad Source #
Instance details Methods get :: NetlistMonad NetlistState # put :: NetlistState -> NetlistMonad () # state :: (NetlistState -> (a, NetlistState)) -> NetlistMonad a #

pattern NetDecl :: Maybe Identifier -> Identifier -> HWType -> Declaration Source #

emptyBBContext :: BlackBoxContext Source #

bindings :: Lens' NetlistState BindingMap Source #

componentNames :: Lens' NetlistState (HashMap TmOccName Identifier) Source #

components :: Lens' NetlistState (HashMap TmOccName (SrcSpan, Component)) Source #

curCompNm :: Lens' NetlistState (Identifier, SrcSpan) Source #

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

extendIdentifierFn :: Lens' NetlistState (IdType -> Identifier -> Identifier -> Identifier) Source #

hdlDir :: Lens' NetlistState FilePath Source #

intWidth :: Lens' NetlistState Int Source #

mkIdentifierFn :: Lens' NetlistState (IdType -> Identifier -> Identifier) Source #

primitives :: Lens' NetlistState (PrimMap BlackBoxTemplate) Source #

seenComps :: Lens' NetlistState [Identifier] Source #

seenIds :: Lens' NetlistState [Identifier] Source #

tcCache :: Lens' NetlistState (HashMap TyConOccName TyCon) Source #

topEntityAnns :: Lens' NetlistState (HashMap TmOccName (Type, Maybe TopEntity)) Source #

typeTranslator :: Lens' NetlistState (HashMap TyConOccName TyCon -> Bool -> Type -> Maybe (Either String HWType)) Source #

varCount :: Lens' NetlistState Int Source #

Orphan instances

Hashable ClockKind Source #
Instance details Methods hashWithSalt :: Int -> ClockKind -> Int hash :: ClockKind -> Int
Hashable ResetKind Source #
Instance details Methods hashWithSalt :: Int -> ResetKind -> Int hash :: ResetKind -> Int