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

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 #
Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS #
NFData Declaration Source #
Methods rnf :: Declaration -> () #

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 #
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 #
Methods fmap :: (a -> b) -> NetlistMonad a -> NetlistMonad b # (<$) :: a -> NetlistMonad b -> NetlistMonad a #
Applicative NetlistMonad Source #
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 #
Methods liftIO :: IO a -> NetlistMonad a #
Fresh NetlistMonad Source #
Methods fresh :: Name a -> NetlistMonad (Name a) #
MonadState NetlistState NetlistMonad Source #
Methods get :: NetlistMonad NetlistState # put :: NetlistState -> NetlistMonad () # state :: (NetlistState -> (a, NetlistState)) -> NetlistMonad a #

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 #
Methods get :: NetlistMonad NetlistState # put :: NetlistState -> NetlistMonad () # state :: (NetlistState -> (a, NetlistState)) -> NetlistMonad a #

type Identifier = Text Source #

Signal reference

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 #
Methods showsPrec :: Int -> Component -> ShowS # show :: Component -> String # showList :: [Component] -> ShowS #
NFData Component Source #
Methods rnf :: Component -> () #

type Size = Int Source #

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

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 #
Methods (==) :: HWType -> HWType -> Bool # (/=) :: HWType -> HWType -> Bool #
Ord HWType Source #
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 #
Methods showsPrec :: Int -> HWType -> ShowS # show :: HWType -> String # showList :: [HWType] -> ShowS #
Generic HWType Source #
Associated Types type Rep HWType :: * -> * # Methods from :: HWType -> Rep HWType x # to :: Rep HWType x -> HWType #
Hashable HWType Source #
Methods hashWithSalt :: Int -> HWType -> Int # hash :: HWType -> Int #
NFData HWType Source #
Methods rnf :: HWType -> () #
type Rep HWType Source #
type Rep HWType = D1 * (MetaData "HWType" "Clash.Netlist.Types" "clash-lib-0.99-CApG5XjEMCZFUVyS8kIjXv" False) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "Void" PrefixI False) (S1 * (MetaSel (Nothing 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 Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (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 DecidedStrict) (Rec0 * Size)))))) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "Unsigned" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Size))) (C1 * (MetaCons "Vector" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Size)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * HWType))))) ((:+:) * (C1 * (MetaCons "RTree" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (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)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ClockKind))))) (C1 * (MetaCons "Reset" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Identifier)) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Integer)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ResetKind)))))))))

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 #
Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS #
NFData Declaration Source #
Methods rnf :: Declaration -> () #

data WireOrReg Source #

Constructors

Wire
Reg

Instances

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

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

data PortDirection Source #

Constructors

In
Out

Instances

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

data Bit Source #

Bit literal

Constructors

H	High
L	Low
U	Undefined
Z	High-impedance

Instances

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

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 #
Methods showsPrec :: Int -> BlackBoxContext -> ShowS # show :: BlackBoxContext -> String # showList :: [BlackBoxContext] -> ShowS #

emptyBBContext :: BlackBoxContext Source #

varCount :: Lens' NetlistState Int Source #

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

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

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

seenIds :: Lens' NetlistState [Identifier] Source #

seenComps :: Lens' NetlistState [Identifier] Source #

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

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

intWidth :: Lens' NetlistState Int Source #

hdlDir :: Lens' NetlistState FilePath Source #

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

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

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

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

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

bindings :: Lens' NetlistState BindingMap Source #

Orphan instances

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