Clash.Netlist.Types

Type and instance definitions for Netlist modules

Documentation

data Declaration

Internals of a Component

Constructors

Assignment

Signal assignment

Fields

• !Identifier

  Signal to assign

• !Expr

  Assigned expression

CondAssignment

Conditional signal assignment:

Fields

• !Identifier

  Signal to assign

• !HWType

  Type of the result/alternatives

• !Expr

  Scrutinized expression

• !HWType

  Type of the scrutinee

• [(Maybe Literal, Expr)]

  List of: (Maybe expression scrutinized expression is compared with,RHS of alternative)

InstDecl

Instantiation of another component:

Fields

• EntityOrComponent

  Whether it's an entity or a component

• (Maybe Comment)

  Comment to add to the generated code

• !Identifier

  The component's (or entity's) name

• !Identifier

  Instance label

• [(Expr, HWType, Expr)]

  List of parameters for this component (param name, param type, param value)

• [(Expr, PortDirection, HWType, Expr)]

  Ports (port name, port direction, type, assignment)

BlackBoxD

Instantiation of blackbox declaration

Fields

• !Text

  Primitive name

• [BlackBoxTemplate]

  VHDL only: add library declarations

• [BlackBoxTemplate]

  VHDL only: add use declarations

• [((Text, Text), BlackBox)]

  Intel Quartus only: create a .qsys file from given template

• !BlackBox

  Template tokens

• BlackBoxContext

  Context in which tokens should be rendered

NetDecl'

Signal declaration

Fields

• (Maybe Comment)

  Note; will be inserted as a comment in target hdl

• WireOrReg

  Wire or register

• !Identifier

  Name of signal

• (Either Identifier HWType)

  Pointer to type of signal or type of signal

• (Maybe Expr)

  Initial value ^ Signal declaration

TickDecl Comment

HDL tick corresponding to a Core tick | Sequential statement

Seq [Seq]

Bundled Patterns

pattern NetDecl

Fields

• :: Maybe Comment

  Note; will be inserted as a comment in target hdl

• -> Identifier

  Name of signal

• -> HWType

  Type of signal

• -> Declaration

Instances

Show Declaration

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Declaration -> ShowS

show :: Declaration -> String

showList :: [Declaration] -> ShowS

NFData Declaration

Defined in Clash.Netlist.Types

Methods

rnf :: Declaration -> ()

newtype NetlistMonad a

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

Constructors

NetlistMonad

Fields

• runNetlist :: StateT NetlistState (ReaderT NetlistEnv IO) a

Instances

Monad NetlistMonad

Defined in Clash.Netlist.Types

Methods

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

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

return :: a -> NetlistMonad a

fail :: String -> NetlistMonad a

Functor NetlistMonad

Defined in Clash.Netlist.Types

Methods

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

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

MonadFail NetlistMonad

Defined in Clash.Netlist.Types

Methods

fail :: String -> NetlistMonad a

Applicative NetlistMonad

Defined in Clash.Netlist.Types

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

Defined in Clash.Netlist.Types

Methods

liftIO :: IO a -> NetlistMonad a

MonadReader NetlistEnv NetlistMonad

Defined in Clash.Netlist.Types

Methods

ask :: NetlistMonad NetlistEnv

local :: (NetlistEnv -> NetlistEnv) -> NetlistMonad a -> NetlistMonad a

reader :: (NetlistEnv -> a) -> NetlistMonad a

MonadState NetlistState NetlistMonad

Defined in Clash.Netlist.Types

Methods

get :: NetlistMonad NetlistState

put :: NetlistState -> NetlistMonad ()

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

data BlackBox

Constructors

BBTemplate BlackBoxTemplate

BBFunction BBName BBHash TemplateFunction

Instances

Show BlackBox

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> BlackBox -> ShowS

show :: BlackBox -> String

showList :: [BlackBox] -> ShowS

Generic BlackBox

Defined in Clash.Netlist.Types

Associated Types

type Rep BlackBox :: Type -> Type

Methods

from :: BlackBox -> Rep BlackBox x

to :: Rep BlackBox x -> BlackBox

Binary BlackBox

Defined in Clash.Netlist.Types

Methods

put :: BlackBox -> Put

get :: Get BlackBox

putList :: [BlackBox] -> Put

NFData BlackBox

Defined in Clash.Netlist.Types

Methods

rnf :: BlackBox -> ()

type Rep BlackBox

Defined in Clash.Netlist.Types

type Rep BlackBox = D1 (MetaData "BlackBox" "Clash.Netlist.Types" "clash-lib-1.2.0-inplace" False) (C1 (MetaCons "BBTemplate" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BlackBoxTemplate)) :+: C1 (MetaCons "BBFunction" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BBName) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BBHash) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TemplateFunction))))

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#, Right e: dataToTag#

BlackBoxE

Instantiation of a BlackBox expression

Fields

• !Text

  Primitive name

• [BlackBoxTemplate]

  VHDL only: add library declarations

• [BlackBoxTemplate]

  VHDL only: add use declarations:

• [((Text, Text), BlackBox)]

  Intel/Quartus only: create a .qsys file from given template.

• !BlackBox

  Template tokens

• !BlackBoxContext

  Context in which tokens should be rendered

• !Bool

  Wrap in paretheses?

ConvBV (Maybe Identifier) HWType Bool Expr

IfThenElse Expr Expr Expr

Noop

Do nothing

Instances

Show Expr

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Expr -> ShowS

show :: Expr -> String

showList :: [Expr] -> ShowS

NFData Expr

Defined in Clash.Netlist.Types

Methods

rnf :: Expr -> ()

data Component

Component: base unit of a Netlist

Constructors

Component

Fields

• componentName :: !Identifier

  Name of the component

• inputs :: [(Identifier, HWType)]

  Input ports

• outputs :: [(WireOrReg, (Identifier, HWType), Maybe Expr)]

  Output ports

• declarations :: [Declaration]

  Internal declarations

Instances

Show Component

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Component -> ShowS

show :: Component -> String

showList :: [Component] -> ShowS

NFData Component

Defined in Clash.Netlist.Types

Methods

rnf :: Component -> ()

data Declaration

Internals of a Component

Constructors

Assignment

Signal assignment

Fields

• !Identifier

  Signal to assign

• !Expr

  Assigned expression

CondAssignment

Conditional signal assignment:

Fields

• !Identifier

  Signal to assign

• !HWType

  Type of the result/alternatives

• !Expr

  Scrutinized expression

• !HWType

  Type of the scrutinee

• [(Maybe Literal, Expr)]

  List of: (Maybe expression scrutinized expression is compared with,RHS of alternative)

InstDecl

Instantiation of another component:

Fields

• EntityOrComponent

  Whether it's an entity or a component

• (Maybe Comment)

  Comment to add to the generated code

• !Identifier

  The component's (or entity's) name

• !Identifier

  Instance label

• [(Expr, HWType, Expr)]

  List of parameters for this component (param name, param type, param value)

• [(Expr, PortDirection, HWType, Expr)]

  Ports (port name, port direction, type, assignment)

BlackBoxD

Instantiation of blackbox declaration

Fields

• !Text

  Primitive name

• [BlackBoxTemplate]

  VHDL only: add library declarations

• [BlackBoxTemplate]

  VHDL only: add use declarations

• [((Text, Text), BlackBox)]

  Intel Quartus only: create a .qsys file from given template

• !BlackBox

  Template tokens

• BlackBoxContext

  Context in which tokens should be rendered

NetDecl'

Signal declaration

Fields

• (Maybe Comment)

  Note; will be inserted as a comment in target hdl

• WireOrReg

  Wire or register

• !Identifier

  Name of signal

• (Either Identifier HWType)

  Pointer to type of signal or type of signal

• (Maybe Expr)

  Initial value ^ Signal declaration

TickDecl Comment

HDL tick corresponding to a Core tick | Sequential statement

Seq [Seq]

Instances

Show Declaration

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Declaration -> ShowS

show :: Declaration -> String

showList :: [Declaration] -> ShowS

NFData Declaration

Defined in Clash.Netlist.Types

Methods

rnf :: Declaration -> ()

data HWType

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 length of that vector.

String

String type

Integer

Integer type (for parameters only)

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 (Maybe [Text]) [HWType]

Product type: Name, field names, and field types. Field names will be populated when using records.

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

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

Clock !Identifier

Clock type corresponding to domain Identifier

Reset !Identifier

Reset type corresponding to domain Identifier

BiDirectional !PortDirection !HWType

Tagging type indicating a bidirectional (inout) port

CustomSP !Identifier !DataRepr' !Size [(ConstrRepr', Identifier, [HWType])]

Same as Sum-Of-Product, but with a user specified bit representation. For more info, see: Clash.Annotations.BitRepresentations.

CustomSum !Identifier !DataRepr' !Size [(ConstrRepr', Identifier)]

Same as Sum, but with a user specified bit representation. For more info, see: Clash.Annotations.BitRepresentations.

CustomProduct !Identifier !DataRepr' !Size (Maybe [Text]) [(FieldAnn, HWType)]

Same as Product, but with a user specified bit representation. For more info, see: Clash.Annotations.BitRepresentations.

Annotated [Attr'] !HWType

Annotated with HDL attributes

KnownDomain !Identifier !Integer !ActiveEdge !ResetKind !InitBehavior !ResetPolarity

Domain name, period, active edge, reset kind, initial value behavior

FileType

File type for simulation-level I/O

Instances

Eq HWType

Defined in Clash.Netlist.Types

Methods

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

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

Ord HWType

Defined in Clash.Netlist.Types

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

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> HWType -> ShowS

show :: HWType -> String

showList :: [HWType] -> ShowS

Generic HWType

Defined in Clash.Netlist.Types

Associated Types

type Rep HWType :: Type -> Type

Methods

from :: HWType -> Rep HWType x

to :: Rep HWType x -> HWType

Hashable HWType

Defined in Clash.Netlist.Types

Methods

hashWithSalt :: Int -> HWType -> Int

hash :: HWType -> Int

NFData HWType

Defined in Clash.Netlist.Types

Methods

rnf :: HWType -> ()

type Rep HWType

Defined in Clash.Netlist.Types

type Rep HWType = D1 (MetaData "HWType" "Clash.Netlist.Types" "clash-lib-1.2.0-inplace" False) ((((C1 (MetaCons "Void" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe HWType))) :+: C1 (MetaCons "String" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Integer" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Bool" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Bit" PrefixI False) (U1 :: Type -> Type)))) :+: ((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 (Maybe [Text])) :*: 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)) :+: (C1 (MetaCons "Reset" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier)) :+: C1 (MetaCons "BiDirectional" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PortDirection) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HWType))))) :+: ((C1 (MetaCons "CustomSP" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DataRepr')) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Size) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ConstrRepr', Identifier, [HWType])]))) :+: (C1 (MetaCons "CustomSum" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DataRepr')) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Size) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ConstrRepr', Identifier)]))) :+: C1 (MetaCons "CustomProduct" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Identifier) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DataRepr')) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Size) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(FieldAnn, HWType)])))))) :+: (C1 (MetaCons "Annotated" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Attr']) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HWType)) :+: (C1 (MetaCons "KnownDomain" 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 ActiveEdge))) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResetKind) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 InitBehavior) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResetPolarity)))) :+: C1 (MetaCons "FileType" PrefixI False) (U1 :: Type -> Type))))))

type Identifier = Text

Signal reference

data DeclarationType

Type of declaration, concurrent or sequential

Constructors

Concurrent

Sequential

data NetlistId

Netlist-level identifier

Constructors

NetlistId Identifier Type

Identifier generated in the NetlistMonad, always derived from another NetlistId

CoreId Id

An original Core identifier

MultiId [Id]

A split identifier (into several sub-identifiers), needed to assign expressions of types that have to be split apart (e.g. tuples of Files)

Instances

Show NetlistId

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> NetlistId -> ShowS

show :: NetlistId -> String

showList :: [NetlistId] -> ShowS

data TemplateFunction where

Constructors

TemplateFunction :: [Int] -> (BlackBoxContext -> Bool) -> (forall s. Backend s => BlackBoxContext -> State s Doc) -> TemplateFunction

Instances

Binary TemplateFunction

NB: serialisation doesn't preserve the embedded function

Defined in Clash.Netlist.Types

Methods

put :: TemplateFunction -> Put

get :: Get TemplateFunction

putList :: [TemplateFunction] -> Put

NFData TemplateFunction

Defined in Clash.Netlist.Types

Methods

rnf :: TemplateFunction -> ()

type BBHash = Int

type BBName = String

data BlackBoxContext

Context used to fill in the holes of a BlackBox template

Constructors

Context

Fields

• bbName :: Text

  Blackbox function name (for error reporting)

• bbResult :: (Expr, HWType)

  Result name and type

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

  Argument names, types, and whether it is a literal

• bbFunctions :: IntMap [(Either BlackBox (Identifier, [Declaration]), WireOrReg, [BlackBoxTemplate], [BlackBoxTemplate], [((Text, Text), BlackBox)], BlackBoxContext)]

  Function arguments (subset of inputs):

  • ( Blackbox Template , Whether the result should be reg or a wire (Verilog only) , Partial Blackbox Context )
• bbQsysIncName :: [Identifier]
• bbLevel :: Int

  The scoping level this context is associated with, ensures that ~ARGN[k][n] holes are only filled with values from this context if k is equal to the scoping level of this context.

• bbCompName :: Identifier

  The component the BlackBox is instantiated in

• bbCtxName :: Maybe Identifier

  The "context name", name set by setName, defaults to the name of the closest binder

Instances

Show BlackBoxContext

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> BlackBoxContext -> ShowS

show :: BlackBoxContext -> String

showList :: [BlackBoxContext] -> ShowS

data Bit

Bit literal

Constructors

H

High

L

Low

U

Undefined

Z

High-impedance

Instances

Eq Bit

Defined in Clash.Netlist.Types

Methods

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

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

Show Bit

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Bit -> ShowS

show :: Bit -> String

showList :: [Bit] -> ShowS

Lift Bit

Defined in Clash.Netlist.Types

Methods

lift :: Bit -> Q Exp

data Literal

Literals used in an expression

Constructors

NumLit !Integer

Number literal

BitLit !Bit

Bit literal

BitVecLit !Integer !Integer

BitVector literal

BoolLit !Bool

Boolean literal

VecLit [Literal]

Vector literal

StringLit !String

String literal

Instances

Eq Literal

Defined in Clash.Netlist.Types

Methods

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

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

Show Literal

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Literal -> ShowS

show :: Literal -> String

showList :: [Literal] -> 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

Sliced (HWType, Int, Int)

Slice the identifier of the given type from start to end

Nested Modifier Modifier

Instances

Show Modifier

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Modifier -> ShowS

show :: Modifier -> String

showList :: [Modifier] -> ShowS

data PortDirection

Constructors

In

Out

Instances

Eq PortDirection

Defined in Clash.Netlist.Types

Methods

(==) :: PortDirection -> PortDirection -> Bool

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

Ord PortDirection

Defined in Clash.Netlist.Types

Methods

compare :: PortDirection -> PortDirection -> Ordering

(<) :: PortDirection -> PortDirection -> Bool

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

(>) :: PortDirection -> PortDirection -> Bool

(>=) :: PortDirection -> PortDirection -> Bool

max :: PortDirection -> PortDirection -> PortDirection

min :: PortDirection -> PortDirection -> PortDirection

Show PortDirection

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> PortDirection -> ShowS

show :: PortDirection -> String

showList :: [PortDirection] -> ShowS

Generic PortDirection

Defined in Clash.Netlist.Types

Associated Types

type Rep PortDirection :: Type -> Type

Methods

from :: PortDirection -> Rep PortDirection x

to :: Rep PortDirection x -> PortDirection

Hashable PortDirection

Defined in Clash.Netlist.Types

Methods

hashWithSalt :: Int -> PortDirection -> Int

hash :: PortDirection -> Int

NFData PortDirection

Defined in Clash.Netlist.Types

Methods

rnf :: PortDirection -> ()

type Rep PortDirection

Defined in Clash.Netlist.Types

type Rep PortDirection = D1 (MetaData "PortDirection" "Clash.Netlist.Types" "clash-lib-1.2.0-inplace" False) (C1 (MetaCons "In" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Out" PrefixI False) (U1 :: Type -> Type))

data WireOrReg

Constructors

Wire

Reg

Instances

Show WireOrReg

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> WireOrReg -> ShowS

show :: WireOrReg -> String

showList :: [WireOrReg] -> ShowS

Generic WireOrReg

Defined in Clash.Netlist.Types

Associated Types

type Rep WireOrReg :: Type -> Type

Methods

from :: WireOrReg -> Rep WireOrReg x

to :: Rep WireOrReg x -> WireOrReg

NFData WireOrReg

Defined in Clash.Netlist.Types

Methods

rnf :: WireOrReg -> ()

type Rep WireOrReg

Defined in Clash.Netlist.Types

type Rep WireOrReg = D1 (MetaData "WireOrReg" "Clash.Netlist.Types" "clash-lib-1.2.0-inplace" False) (C1 (MetaCons "Wire" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Reg" PrefixI False) (U1 :: Type -> Type))

data EntityOrComponent

Constructors

Entity

Comp

Empty

Instances

Show EntityOrComponent

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> EntityOrComponent -> ShowS

show :: EntityOrComponent -> String

showList :: [EntityOrComponent] -> ShowS

data Seq

Sequential statements

Constructors

AlwaysClocked

Clocked sequential statements

Fields

• ActiveEdge

  Edge of the clock the statement should be executed

• Expr

  Clock expression

• [Seq]

  Statements to be executed on the active clock edge | Statements running at simulator start

Initial [Seq]

Statements to run at simulator start | Statements to run always

AlwaysComb [Seq]

Statements to run always | Declaration in sequential form

SeqDecl Declaration

The declaration | Branching statement

Branch

Fields

• !Expr

  Scrutinized expresson

• !HWType

  Type of the scrutinized expression

• [(Maybe Literal, [Seq])]

  List of: (Maybe match, RHS of Alternative)

Instances

Show Seq

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Seq -> ShowS

show :: Seq -> String

showList :: [Seq] -> ShowS

data FilteredHWType

Tree structure indicating which constructor fields were filtered from a type due to them being void. We need this information to generate stable and/or user-defined port mappings.

Constructors

FilteredHWType HWType [[(IsVoid, FilteredHWType)]]

Instances

Eq FilteredHWType

Defined in Clash.Netlist.Types

Methods

(==) :: FilteredHWType -> FilteredHWType -> Bool

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

Show FilteredHWType

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> FilteredHWType -> ShowS

show :: FilteredHWType -> String

showList :: [FilteredHWType] -> ShowS

type IsVoid = Bool

type Size = Int

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

type Comment = Text

data SomeBackend where

Existentially quantified backend

Constructors

SomeBackend :: Backend backend => backend -> SomeBackend

data ComponentPrefix

Constructors

ComponentPrefix

Fields

• componentPrefixTop :: Maybe Identifier

  Prefix for top-level components

• componentPrefixOther :: Maybe Identifier

  Prefix for all other components

Instances

Show ComponentPrefix

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> ComponentPrefix -> ShowS

show :: ComponentPrefix -> String

showList :: [ComponentPrefix] -> ShowS

data NetlistState

State of the NetlistMonad

Constructors

NetlistState

Fields

• _bindings :: BindingMap

  Global binders

• _varCount :: !Int

  Number of signal declarations

• _components :: VarEnv ([Bool], SrcSpan, HashMap Identifier Word, Component)

  Cached components

• _primitives :: CompiledPrimMap

  Primitive Definitions

• _typeTranslator :: CustomReprs -> TyConMap -> Type -> State HWMap (Maybe (Either String FilteredHWType))

  Hardcoded Type -> HWType translator

• _tcCache :: TyConMap

  TyCon cache

• _curCompNm :: !(Identifier, SrcSpan)
• _intWidth :: Int
• _mkIdentifierFn :: IdType -> Identifier -> Identifier
• _extendIdentifierFn :: IdType -> Identifier -> Identifier -> Identifier
• _seenIds :: HashMap Identifier Word
• _seenComps :: HashMap Identifier Word
• _seenPrimitives :: Set Text

  Keeps track of invocations of ´mkPrimitive´. It is currently used to filter duplicate warning invocations for dubious blackbox instantiations, see GitHub pull request #286.

• _componentNames :: VarEnv Identifier
• _topEntityAnns :: VarEnv TopEntityT
• _hdlDir :: FilePath
• _curBBlvl :: Int

  The current scoping level assigned to black box contexts

• _componentPrefix :: ComponentPrefix
• _customReprs :: CustomReprs
• _clashOpts :: ClashOpts

  Settings Clash was called with

• _isTestBench :: Bool

  Whether we're compiling a testbench (suppresses some warnings)

• _backEndITE :: Bool

  Whether the backend supports ifThenElse expressions

• _backend :: SomeBackend

  The current HDL backend

• _htyCache :: HWMap

Instances

MonadState NetlistState NetlistMonad

Defined in Clash.Netlist.Types

Methods

get :: NetlistMonad NetlistState

put :: NetlistState -> NetlistMonad ()

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

data NetlistEnv

Environment of the NetlistMonad

Constructors

NetlistEnv

Fields

• _prefixName :: Identifier

  Prefix for instance/register names

• _suffixName :: Identifier

  Postfix for instance/register names

• _setName :: Maybe Identifier

  (Maybe) user given instance/register name

Instances

MonadReader NetlistEnv NetlistMonad

Defined in Clash.Netlist.Types

Methods

ask :: NetlistMonad NetlistEnv

local :: (NetlistEnv -> NetlistEnv) -> NetlistMonad a -> NetlistMonad a

reader :: (NetlistEnv -> a) -> NetlistMonad a

type HWMap = HashMap Type (Either String FilteredHWType)

data TopEntityT

Structure describing a top entity: it's id, its port annotations, and associated testbench.

Constructors

TopEntityT

Fields

• topId :: Id

  Id of top entity

• topAnnotation :: Maybe TopEntity

  (Maybe) a topentity annotation

• associatedTestbench :: Maybe Id

  (Maybe) a test bench associated with the topentity

Instances

Generic TopEntityT

Defined in Clash.Netlist.Types

Associated Types

type Rep TopEntityT :: Type -> Type

Methods

from :: TopEntityT -> Rep TopEntityT x

to :: Rep TopEntityT x -> TopEntityT

Hashable TopEntityT

Defined in Clash.Annotations.TopEntity.Extra

Methods

hashWithSalt :: Int -> TopEntityT -> Int

hash :: TopEntityT -> Int

Binary TopEntityT

Defined in Clash.Annotations.TopEntity.Extra

Methods

put :: TopEntityT -> Put

get :: Get TopEntityT

putList :: [TopEntityT] -> Put

NFData TopEntityT

Defined in Clash.Annotations.TopEntity.Extra

Methods

rnf :: TopEntityT -> ()

type Rep TopEntityT

Defined in Clash.Netlist.Types

type Rep TopEntityT = D1 (MetaData "TopEntityT" "Clash.Netlist.Types" "clash-lib-1.2.0-inplace" False) (C1 (MetaCons "TopEntityT" PrefixI True) (S1 (MetaSel (Just "topId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Id) :*: (S1 (MetaSel (Just "topAnnotation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe TopEntity)) :*: S1 (MetaSel (Just "associatedTestbench") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Id)))))

pattern NetDecl

Arguments

:: Maybe Comment

Note; will be inserted as a comment in target hdl

-> Identifier

Name of signal

-> HWType

Type of signal

-> Declaration

hwTypeAttrs :: HWType -> [Attr']

Extract hardware attributes from Annotated. Returns an empty list if non-Annotated given or if Annotated has an empty list of attributes.

toBit

Arguments

:: Integer

mask

-> Integer

value

-> Bit

netlistId

Arguments

:: (Identifier -> r)

Eliminator for Identifiers generated in the NetlistMonad

-> (Id -> r)

Eliminator for original Core Identifiers

-> NetlistId

-> [r]

Eliminator for NetlistId

netlistId1

Arguments

:: HasCallStack

=> (Identifier -> r)

Eliminator for Identifiers generated in the NetlistMonad

-> (Id -> r)

Eliminator for original Core Identifiers

-> NetlistId

-> r

Eliminator for NetlistId, fails on MultiId

netlistTypes :: NetlistId -> [Type]

Return the type(s) of a NetListId, returns multiple types when given a MultiId

netlistTypes1 :: HasCallStack => NetlistId -> Type

Return the type of a NetlistId, fails on MultiId

emptyBBContext :: Text -> BlackBoxContext

prefixName :: Lens' NetlistEnv Identifier

setName :: Lens' NetlistEnv (Maybe Identifier)

suffixName :: Lens' NetlistEnv Identifier

backEndITE :: Lens' NetlistState Bool

backend :: Lens' NetlistState SomeBackend

bindings :: Lens' NetlistState BindingMap

clashOpts :: Lens' NetlistState ClashOpts

componentNames :: Lens' NetlistState (VarEnv Identifier)

componentPrefix :: Lens' NetlistState ComponentPrefix

components :: Lens' NetlistState (VarEnv ([Bool], SrcSpan, HashMap Identifier Word, Component))

curBBlvl :: Lens' NetlistState Int

curCompNm :: Lens' NetlistState (Identifier, SrcSpan)

customReprs :: Lens' NetlistState CustomReprs

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

hdlDir :: Lens' NetlistState FilePath

htyCache :: Lens' NetlistState HWMap

intWidth :: Lens' NetlistState Int

isTestBench :: Lens' NetlistState Bool

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

primitives :: Lens' NetlistState CompiledPrimMap

seenComps :: Lens' NetlistState (HashMap Identifier Word)

seenIds :: Lens' NetlistState (HashMap Identifier Word)

seenPrimitives :: Lens' NetlistState (Set Text)

tcCache :: Lens' NetlistState TyConMap

topEntityAnns :: Lens' NetlistState (VarEnv TopEntityT)

typeTranslator :: Lens' NetlistState (CustomReprs -> TyConMap -> Type -> State HWMap (Maybe (Either String FilteredHWType)))

varCount :: Lens' NetlistState Int