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

• !Usage

  How the signal is assigned

• !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 Text)

  Library instance is defined in

• [Attr Text]

  Attributes 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)

• PortMap

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

CompDecl !Text [(Text, PortDirection, HWType)]

component declaration (VHDL).

See this tutorial; refer to §4.5 of IEEE 1076-1993

NetDecl'

Signal declaration

Fields

• (Maybe Comment)

  Note; will be inserted as a comment in target hdl

• !Identifier

  Name of signal

• HWType

  Type of signal

• (Maybe Expr)

  Initial value ^ Signal declaration

TickDecl CommentOrDirective

HDL tick corresponding to a Core tick

Seq [Seq]

Sequential statement

ConditionalDecl

Compilation conditional on some preprocessor symbol, note that declarations here are ignored for VHDL. See here for a discussion https://github.com/clash-lang/clash-compiler/pull/1798#discussion_r648571862

Fields

• !Text

  condition text, for example FORMAL

• [Declaration]

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 -> ()

type UsageMap = Map Text Usage

data Usage

The usage of a signal refers to how the signal is written to in netlist. This is used to determine if the signal should be a wire or reg in (System)Verilog, or a signal or variable in VHDL.

Constructors

Cont

Continuous assignment, which occurs in a concurrent context.

Proc Blocking

Procedural assignment, which occurs in a sequential context.

Instances

Eq Usage

Defined in Clash.Netlist.Types

Methods

(==) :: Usage -> Usage -> Bool

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

Show Usage

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Usage -> ShowS

show :: Usage -> String

showList :: [Usage] -> ShowS

Generic Usage

Defined in Clash.Netlist.Types

Associated Types

type Rep Usage :: Type -> Type

Methods

from :: Usage -> Rep Usage x

to :: Rep Usage x -> Usage

Semigroup Usage

Defined in Clash.Netlist.Types

Methods

(<>) :: Usage -> Usage -> Usage

sconcat :: NonEmpty Usage -> Usage

stimes :: Integral b => b -> Usage -> Usage

Hashable Usage

Defined in Clash.Netlist.Types

Methods

hashWithSalt :: Int -> Usage -> Int

hash :: Usage -> Int

FromJSON Usage

Defined in Clash.Netlist.Types

Methods

parseJSON :: Value -> Parser Usage

parseJSONList :: Value -> Parser [Usage]

omittedField :: Maybe Usage

Binary Usage

Defined in Clash.Netlist.Types

Methods

put :: Usage -> Put

get :: Get Usage

putList :: [Usage] -> Put

NFData Usage

Defined in Clash.Netlist.Types

Methods

rnf :: Usage -> ()

type Rep Usage

Defined in Clash.Netlist.Types

type Rep Usage = D1 ('MetaData "Usage" "Clash.Netlist.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "Cont" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Proc" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Blocking)))

data Blocking

Procedural assignment in HDL can be blocking or non-blocking. This determines when the assignment takes place in simulation. The name refers to whether evaluation of the remaining statements in a process is blocked until the assignment is performed or not.

See Also:

IEEE 1364-2001, sections 9.2.1 and 9.2.2 IEEE 1076-1993, sections 8.4 and 8.5

Constructors

NonBlocking

A non-blocking assignment means the new value is not observed until the next time step in simulation. Using the signal later in the process will continue to return the old value.

Blocking

A blocking assignment means the new value is observed immediately. Using the signal later in the process will return the new value.

Instances

Eq Blocking

Defined in Clash.Netlist.Types

Methods

(==) :: Blocking -> Blocking -> Bool

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

Show Blocking

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Blocking -> ShowS

show :: Blocking -> String

showList :: [Blocking] -> ShowS

Generic Blocking

Defined in Clash.Netlist.Types

Associated Types

type Rep Blocking :: Type -> Type

Methods

from :: Blocking -> Rep Blocking x

to :: Rep Blocking x -> Blocking

Semigroup Blocking

Defined in Clash.Netlist.Types

Methods

(<>) :: Blocking -> Blocking -> Blocking

sconcat :: NonEmpty Blocking -> Blocking

stimes :: Integral b => b -> Blocking -> Blocking

Hashable Blocking

Defined in Clash.Netlist.Types

Methods

hashWithSalt :: Int -> Blocking -> Int

hash :: Blocking -> Int

Binary Blocking

Defined in Clash.Netlist.Types

Methods

put :: Blocking -> Put

get :: Get Blocking

putList :: [Blocking] -> Put

NFData Blocking

Defined in Clash.Netlist.Types

Methods

rnf :: Blocking -> ()

type Rep Blocking

Defined in Clash.Netlist.Types

type Rep Blocking = D1 ('MetaData "Blocking" "Clash.Netlist.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "NonBlocking" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Blocking" 'PrefixI 'False) (U1 :: Type -> Type))

data PreserveCase

Whether to preserve casing in ids or converted everything to lowercase. Influenced by '-fclash-lower-case-basic-identifiers'

Constructors

PreserveCase

ToLower

Instances

Eq PreserveCase

Defined in Clash.Netlist.Types

Methods

(==) :: PreserveCase -> PreserveCase -> Bool

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

Show PreserveCase

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> PreserveCase -> ShowS

show :: PreserveCase -> String

showList :: [PreserveCase] -> ShowS

Generic PreserveCase

Defined in Clash.Netlist.Types

Associated Types

type Rep PreserveCase :: Type -> Type

Methods

from :: PreserveCase -> Rep PreserveCase x

to :: Rep PreserveCase x -> PreserveCase

Hashable PreserveCase

Defined in Clash.Netlist.Types

Methods

hashWithSalt :: Int -> PreserveCase -> Int

hash :: PreserveCase -> Int

Binary PreserveCase

Defined in Clash.Netlist.Types

Methods

put :: PreserveCase -> Put

get :: Get PreserveCase

putList :: [PreserveCase] -> Put

NFData PreserveCase

Defined in Clash.Netlist.Types

Methods

rnf :: PreserveCase -> ()

type Rep PreserveCase

Defined in Clash.Netlist.Types

type Rep PreserveCase = D1 ('MetaData "PreserveCase" "Clash.Netlist.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "PreserveCase" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ToLower" 'PrefixI 'False) (U1 :: Type -> Type))

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

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

IdentifierSetMonad NetlistMonad

Defined in Clash.Netlist.Types

Methods

identifierSetM :: (IdentifierSet -> IdentifierSet) -> NetlistMonad IdentifierSet

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

class HasIdentifierSet s where

Structures that hold an IdentifierSet

Methods

identifierSet :: Lens' s IdentifierSet

Instances

HasIdentifierSet IdentifierSet

Defined in Clash.Netlist.Types

Methods

identifierSet :: Lens' IdentifierSet IdentifierSet

HasIdentifierSet VerilogState

Defined in Clash.Backend.Verilog

Methods

identifierSet :: Lens' VerilogState IdentifierSet

HasIdentifierSet VHDLState

Defined in Clash.Backend.VHDL

Methods

identifierSet :: Lens' VHDLState IdentifierSet

HasIdentifierSet SystemVerilogState

Defined in Clash.Backend.SystemVerilog

Methods

identifierSet :: Lens' SystemVerilogState IdentifierSet

Backend backend => HasIdentifierSet (BlockState backend)

Defined in Clash.Primitives.DSL

Methods

identifierSet :: Lens' (BlockState backend) IdentifierSet

HasIdentifierSet s => HasIdentifierSet (s, a)

Defined in Clash.Netlist.Types

Methods

identifierSet :: Lens' (s, a) IdentifierSet

class Monad m => IdentifierSetMonad m where

An IdentifierSetMonad supports unique name generation for Clash Netlist

Methods

identifierSetM :: (IdentifierSet -> IdentifierSet) -> m IdentifierSet

Instances

IdentifierSetMonad NetlistMonad

Defined in Clash.Netlist.Types

Methods

identifierSetM :: (IdentifierSet -> IdentifierSet) -> NetlistMonad IdentifierSet

HasIdentifierSet s => IdentifierSetMonad (State s)

Defined in Clash.Netlist.Types

Methods

identifierSetM :: (IdentifierSet -> IdentifierSet) -> State s IdentifierSet

HasIdentifierSet s => IdentifierSetMonad (State s)

Defined in Clash.Netlist.Types

Methods

identifierSetM :: (IdentifierSet -> IdentifierSet) -> State s IdentifierSet

IdentifierSetMonad m => IdentifierSetMonad (Ap m)

Defined in Clash.Netlist.Types

Methods

identifierSetM :: (IdentifierSet -> IdentifierSet) -> Ap m IdentifierSet

data TopEntityT

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

Constructors

TopEntityT

Fields

• topId :: Id

  Id of top entity

• topAnnotation :: Maybe TopEntity

  (Maybe) a topentity annotation

• topIsTestBench :: Bool

  Whether this entity is a test bench

Instances

Eq TopEntityT

Defined in Clash.Netlist.Types

Methods

(==) :: TopEntityT -> TopEntityT -> Bool

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

Show TopEntityT

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> TopEntityT -> ShowS

show :: TopEntityT -> String

showList :: [TopEntityT] -> ShowS

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.9.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 "topIsTestBench") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

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.9.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 parentheses?

ToBv

Convert some type to a BitVector.

Fields

• (Maybe Identifier)

  Type prefix

• HWType

  Type to convert _from_

• Expr

  Expression to convert to BitVector

FromBv

Convert BitVector to some type.

Fields

• (Maybe Identifier)

  Type prefix

• HWType

  Type to convert _to_

• Expr

  BitVector to convert

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 :: [(Usage, (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

Generic Component

Defined in Clash.Netlist.Types

Associated Types

type Rep Component :: Type -> Type

Methods

from :: Component -> Rep Component x

to :: Rep Component x -> Component

NFData Component

Defined in Clash.Netlist.Types

Methods

rnf :: Component -> ()

type Rep Component

Defined in Clash.Netlist.Types

type Rep Component = D1 ('MetaData "Component" "Clash.Netlist.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "Component" 'PrefixI 'True) ((S1 ('MetaSel ('Just "componentName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Identifier) :*: S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Identifier, HWType)])) :*: (S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Usage, (Identifier, HWType), Maybe Expr)]) :*: S1 ('MetaSel ('Just "declarations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Declaration]))))

data Declaration

Internals of a Component

Constructors

Assignment

Signal assignment

Fields

• !Identifier

  Signal to assign

• !Usage

  How the signal is assigned

• !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 Text)

  Library instance is defined in

• [Attr Text]

  Attributes 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)

• PortMap

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

CompDecl !Text [(Text, PortDirection, HWType)]

component declaration (VHDL).

See this tutorial; refer to §4.5 of IEEE 1076-1993

NetDecl'

Signal declaration

Fields

• (Maybe Comment)

  Note; will be inserted as a comment in target hdl

• !Identifier

  Name of signal

• HWType

  Type of signal

• (Maybe Expr)

  Initial value ^ Signal declaration

TickDecl CommentOrDirective

HDL tick corresponding to a Core tick

Seq [Seq]

Sequential statement

ConditionalDecl

Compilation conditional on some preprocessor symbol, note that declarations here are ignored for VHDL. See here for a discussion https://github.com/clash-lang/clash-compiler/pull/1798#discussion_r648571862

Fields

• !Text

  condition text, for example FORMAL

• [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 -> ()

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

MemBlob !Size !Size

MemBlob type

RTree !Size !HWType

RTree type

Sum !Text [Text]

Sum type: Name and Constructor names

Product !Text (Maybe [Text]) [HWType]

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

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

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

Clock !DomainName

Clock type corresponding to domain DomainName

ClockN !DomainName

ClockN type corresponding to domain DomainName

Reset !DomainName

Reset type corresponding to domain DomainName

Enable !DomainName

Enable type corresponding to domain DomainName

BiDirectional !PortDirection !HWType

Tagging type indicating a bidirectional (inout) port

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

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

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

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

CustomProduct !Text !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 Text] !HWType

Annotated with HDL attributes

KnownDomain !DomainName !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.9.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 "MemBlob" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Size) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Size))) :+: (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 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))))) :+: (((C1 ('MetaCons "Product" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (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 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, [HWType])])) :+: C1 ('MetaCons "Clock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DomainName)))) :+: (C1 ('MetaCons "ClockN" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DomainName)) :+: (C1 ('MetaCons "Reset" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DomainName)) :+: C1 ('MetaCons "Enable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DomainName))))) :+: ((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 Text) :*: 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', Text, [HWType])]))) :+: C1 ('MetaCons "CustomSum" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: 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', Text)]))))) :+: ((C1 ('MetaCons "CustomProduct" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: 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 Text]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HWType))) :+: (C1 ('MetaCons "KnownDomain" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DomainName) :*: (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))))))

data IdentifierSet

A collection of unique identifiers. Allows for fast fresh identifier generation.

NB: use the functions in Clash.Netlist.Id. Don't use the constructor directly.

Constructors

IdentifierSet

Fields

• is_allowEscaped :: !Bool

  Allow escaped ids? If set to False, "make" will always behave like "makeBasic".

• is_lowerCaseBasicIds :: !PreserveCase

  Force all generated basic identifiers to lowercase.

• is_hdl :: !HDL

  HDL to generate fresh identifiers for

• is_freshCache :: !FreshCache

  Maps an i_baseNameCaseFold to a map mapping the number of extensions (in i_extensionsRev) to the maximum word at that basename/level. For example, if a set would contain the identifiers:

  foo, foo_1, foo_2, bar_5, bar_7_8

  the map would look like:

  (foo, [(0, 0), (1, 2)

  ), (bar, [(1, 5), (2, 8)])]

  This mapping makes sure we can quickly generate fresh identifiers. For example, generating a new id for "foo_1" would be a matter of looking up the base name in this map, concluding that the maximum identifier with this basename and this number of extensions is "foo_2", subsequently generating "foo_3".

  Note that an identifier with no extensions is also stored in this map for practical purposes, but the maximum ext is invalid.

• is_store :: !(HashSet Identifier)

  Identifier store

Instances

Show IdentifierSet

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> IdentifierSet -> ShowS

show :: IdentifierSet -> String

showList :: [IdentifierSet] -> ShowS

Generic IdentifierSet

Defined in Clash.Netlist.Types

Associated Types

type Rep IdentifierSet :: Type -> Type

Methods

from :: IdentifierSet -> Rep IdentifierSet x

to :: Rep IdentifierSet x -> IdentifierSet

NFData IdentifierSet

Defined in Clash.Netlist.Types

Methods

rnf :: IdentifierSet -> ()

HasIdentifierSet IdentifierSet

Defined in Clash.Netlist.Types

Methods

identifierSet :: Lens' IdentifierSet IdentifierSet

type Rep IdentifierSet

Defined in Clash.Netlist.Types

type Rep IdentifierSet = D1 ('MetaData "IdentifierSet" "Clash.Netlist.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "IdentifierSet" 'PrefixI 'True) ((S1 ('MetaSel ('Just "is_allowEscaped") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "is_lowerCaseBasicIds") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PreserveCase)) :*: (S1 ('MetaSel ('Just "is_hdl") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HDL) :*: (S1 ('MetaSel ('Just "is_freshCache") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FreshCache) :*: S1 ('MetaSel ('Just "is_store") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashSet Identifier))))))

data Identifier

HDL identifier. Consists of a base name and a number of extensions. An identifier with a base name of "foo" and a list of extensions [1, 2] will be rendered as "foo_1_2".

Note: The Eq instance of Identifier is case insensitive! E.g., two identifiers with base names fooBar and FoObAR are considered the same. However, identifiers are stored case preserving. This means Clash won't generate two identifiers with differing case, but it will try to keep capitalization.

The goal of this data structure is to greatly simplify how Clash deals with identifiers internally. Any Identifier should be trivially printable to any HDL.

NB: use the functions in Clash.Netlist.Id. Don't use these constructors directly.

Constructors

RawIdentifier

Unparsed identifier. Used for things such as port names, which should appear in the HDL exactly as the user specified.

Fields

• !Text

  An identifier exactly as given by the user

• (Maybe Identifier)

  Parsed version of raw identifier. Will not be populated if this identifier was created with an unsafe function.

• !CallStack

  Stores where this identifier was generated. Tracking is only enabled is debugIsOn, otherwise this field will be populated by an empty callstack.

UniqueIdentifier

Parsed and sanitized identifier. See various fields for more information on its invariants.

Fields

• i_baseName :: !Text

  Base name of identifier. make makes sure this field:

  • does not end in _num where num is a digit.
  • is solely made up of printable ASCII characters
  • has no leading or trailing whitespace
• i_baseNameCaseFold :: !Text

  Same as i_baseName, but can be used for equality testing that doesn't depend on capitalization.

• i_extensionsRev :: [Word]

  Extensions applied to base identifier. E.g., an identifier with a base name of foo and an extension of [6, 5] would render as foo_5_6. Note that extensions are stored in reverse order for easier manipulation.

• i_idType :: !IdentifierType

  See IdentifierType.

• i_hdl :: !HDL

  HDL this identifier is generated for.

• i_provenance :: !CallStack

  Stores where this identifier was generated. Tracking is only enabled is debugIsOn, otherwise this field will be populated by an empty callstack.

Instances

Eq Identifier

Defined in Clash.Netlist.Types

Methods

(==) :: Identifier -> Identifier -> Bool

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

Ord Identifier

Defined in Clash.Netlist.Types

Methods

compare :: Identifier -> Identifier -> Ordering

(<) :: Identifier -> Identifier -> Bool

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

(>) :: Identifier -> Identifier -> Bool

(>=) :: Identifier -> Identifier -> Bool

max :: Identifier -> Identifier -> Identifier

min :: Identifier -> Identifier -> Identifier

Show Identifier

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> Identifier -> ShowS

show :: Identifier -> String

showList :: [Identifier] -> ShowS

Generic Identifier

Defined in Clash.Netlist.Types

Associated Types

type Rep Identifier :: Type -> Type

Methods

from :: Identifier -> Rep Identifier x

to :: Rep Identifier x -> Identifier

Hashable Identifier

Defined in Clash.Netlist.Types

Methods

hashWithSalt :: Int -> Identifier -> Int

hash :: Identifier -> Int

NFData Identifier

Defined in Clash.Netlist.Types

Methods

rnf :: Identifier -> ()

Pretty Identifier

Defined in Clash.Netlist.Id.Internal

Methods

pretty :: Identifier -> Doc ann

prettyList :: [Identifier] -> Doc ann

type Rep Identifier

Defined in Clash.Netlist.Types

type Rep Identifier = D1 ('MetaData "Identifier" "Clash.Netlist.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "RawIdentifier" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Identifier)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CallStack))) :+: C1 ('MetaCons "UniqueIdentifier" 'PrefixI 'True) ((S1 ('MetaSel ('Just "i_baseName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "i_baseNameCaseFold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "i_extensionsRev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Word]))) :*: (S1 ('MetaSel ('Just "i_idType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IdentifierType) :*: (S1 ('MetaSel ('Just "i_hdl") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HDL) :*: S1 ('MetaSel ('Just "i_provenance") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CallStack)))))

data IdentifierType

Constructors

Basic

A basic identifier: does not have to be escaped in order to be a valid identifier in HDL.

Extended

An extended identifier: has to be escaped, wrapped, or otherwise postprocessed before writhing it to HDL.

Instances

Eq IdentifierType

Defined in Clash.Netlist.Types

Methods

(==) :: IdentifierType -> IdentifierType -> Bool

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

Show IdentifierType

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> IdentifierType -> ShowS

show :: IdentifierType -> String

showList :: [IdentifierType] -> ShowS

Generic IdentifierType

Defined in Clash.Netlist.Types

Associated Types

type Rep IdentifierType :: Type -> Type

Methods

from :: IdentifierType -> Rep IdentifierType x

to :: Rep IdentifierType x -> IdentifierType

NFData IdentifierType

Defined in Clash.Netlist.Types

Methods

rnf :: IdentifierType -> ()

type Rep IdentifierType

Defined in Clash.Netlist.Types

type Rep IdentifierType = D1 ('MetaData "IdentifierType" "Clash.Netlist.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "Basic" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Extended" 'PrefixI 'False) (U1 :: Type -> Type))

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

Eq NetlistId

Defined in Clash.Netlist.Types

Methods

(==) :: NetlistId -> NetlistId -> Bool

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

Show NetlistId

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> NetlistId -> ShowS

show :: NetlistId -> String

showList :: [NetlistId] -> ShowS

data TemplateFunction where

Constructors

TemplateFunction

Fields

• :: [Int]

  Used arguments

• -> (BlackBoxContext -> Bool)

  Validation function. Should return False if function can't render given a certain context.

• -> (forall s. Backend s => BlackBoxContext -> State s Doc)

  Render function

• -> 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)

• bbResults :: [(Expr, HWType)]

  Result names and types. Will typically be a list with a single item. Multiple result targets will be used for "multi result primitives". See setupMultiResultPrim.

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

  Argument names, types, and whether it is a literal

• bbFunctions :: IntMap [(Either BlackBox (Identifier, [Declaration]), Usage, [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 :: [IdentifierText]
• 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 IdentifierText

  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

liftTyped :: Bit -> Q (TExp Bit)

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). Note that the type of the expression is the type we are slicing from, not the type returned by the index operation.

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.9.0-inplace" 'False) (C1 ('MetaCons "In" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Out" '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 PortMap

Specifies how to wire up a component instance

Constructors

IndexedPortMap [(PortDirection, HWType, Expr)]

Port map based on port positions (port direction, type, assignment)

HDL Example:

bytemaster bytemaster_ds ( clk_1 , rst_1 , bitCtrl_0 );

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

Port map based on port names (port name, port direction, type, assignment)

HDL Example:

bytemaster bytemaster_ds ( .clk (clk_1) , .rst (rst_1) , .bitCtrl (bitCtrl_0) );

Instances

Show PortMap

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> PortMap -> ShowS

show :: PortMap -> String

showList :: [PortMap] -> ShowS

type DomainName = Text

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)

data CommentOrDirective

Constructors

Comment Comment

Directive Directive

Instances

Show CommentOrDirective

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> CommentOrDirective -> ShowS

show :: CommentOrDirective -> String

showList :: [CommentOrDirective] -> ShowS

type Directive = Text

type Comment = Text

data SomeBackend where

Existentially quantified backend

Constructors

SomeBackend :: Backend backend => backend -> SomeBackend

data ComponentPrefix

Constructors

ComponentPrefix

Fields

• componentPrefixTop :: Maybe Text

  Prefix for top-level components

• componentPrefixOther :: Maybe Text

  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

• _components :: ComponentMap

  Cached components. Is an insertion ordered map to preserve a topologically sorted component list for the manifest file.

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

  Hardcoded Type -> HWType translator

• _curCompNm :: !(Identifier, SrcSpan)
• _seenIds :: IdentifierSet

  All names currently in scope.

• _seenComps :: IdentifierSet

  Components (to be) generated during this netlist run. This is always a subset of seenIds. Reason d'etre: we currently generate components in a top down manner. E.g. given:

  • A
  • - B
  • - C

  we would generate component A first. Before trying to generate B and C. A might introduce a number of signal declarations. The names of these signals can't clash with the name of component B, hence we need to pick a name for B unique w.r.t. all these signal names. If we would postpone generating a unqiue name for B til _after_ generating all the signal names, the signal names would get all the "nice" names. E.g., a signal would be called "foo", thereby forcing the component B to be called "foo_1". Ideally, we'd use the "nice" names for components, and the "ugly" names for signals. To achieve this, we generate all the component names up front and subsequently store them in _seenComps.

• _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

  Names of components (to be) generated during this netlist run. Includes top entity names.

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

  The current scoping level assigned to black box contexts

• _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
• _usages :: UsageMap

  The current way signals are assigned in netlist. This is used to determine how signals are rendered in HDL (i.e. wire/reg in Verilog, or signal/variable in VHDL).

Instances

HasUsageMap NetlistState

Defined in Clash.Netlist.Types

Methods

usageMap :: Lens' NetlistState UsageMap

MonadState NetlistState NetlistMonad

Defined in Clash.Netlist.Types

Methods

get :: NetlistMonad NetlistState

put :: NetlistState -> NetlistMonad ()

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

type ComponentMap = OMap Unique (ComponentMeta, Component)

data ComponentMeta

Constructors

ComponentMeta

Fields

• cmWereVoids :: [Bool]
• cmLoc :: SrcSpan
• cmScope :: IdentifierSet
• cmUsage :: UsageMap

Instances

Show ComponentMeta

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> ComponentMeta -> ShowS

show :: ComponentMeta -> String

showList :: [ComponentMeta] -> ShowS

Generic ComponentMeta

Defined in Clash.Netlist.Types

Associated Types

type Rep ComponentMeta :: Type -> Type

Methods

from :: ComponentMeta -> Rep ComponentMeta x

to :: Rep ComponentMeta x -> ComponentMeta

NFData ComponentMeta

Defined in Clash.Netlist.Types

Methods

rnf :: ComponentMeta -> ()

type Rep ComponentMeta

Defined in Clash.Netlist.Types

type Rep ComponentMeta = D1 ('MetaData "ComponentMeta" "Clash.Netlist.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "ComponentMeta" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cmWereVoids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Bool]) :*: S1 ('MetaSel ('Just "cmLoc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SrcSpan)) :*: (S1 ('MetaSel ('Just "cmScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IdentifierSet) :*: S1 ('MetaSel ('Just "cmUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UsageMap))))

data NetlistEnv

Environment of the NetlistMonad

Constructors

NetlistEnv

Fields

• _clashEnv :: ClashEnv
• _prefixName :: Text

  Prefix for instance/register names

• _suffixName :: Text

  Postfix for instance/register names

• _setName :: Maybe Text

  (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 IdentifierText = Text

type FreshCache = HashMap Text (IntMap Word)

See is_freshCache

type HWMap = Map Type (Either String FilteredHWType)

data ExpandedPortName a

See ExpandedTopEntity

Constructors

ExpandedPortName HWType a

Same as PortName, but fully expanded

ExpandedPortProduct

Same as PortProduct, but fully expanded

Fields

• Text

  Name hint. Can be used to create intermediate signal names.

• HWType

  Type of product

• [ExpandedPortName a]

  Product fields

Instances

Functor ExpandedPortName

Defined in Clash.Netlist.Types

Methods

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

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

Foldable ExpandedPortName

Defined in Clash.Netlist.Types

Methods

fold :: Monoid m => ExpandedPortName m -> m

foldMap :: Monoid m => (a -> m) -> ExpandedPortName a -> m

foldMap' :: Monoid m => (a -> m) -> ExpandedPortName a -> m

foldr :: (a -> b -> b) -> b -> ExpandedPortName a -> b

foldr' :: (a -> b -> b) -> b -> ExpandedPortName a -> b

foldl :: (b -> a -> b) -> b -> ExpandedPortName a -> b

foldl' :: (b -> a -> b) -> b -> ExpandedPortName a -> b

foldr1 :: (a -> a -> a) -> ExpandedPortName a -> a

foldl1 :: (a -> a -> a) -> ExpandedPortName a -> a

toList :: ExpandedPortName a -> [a]

null :: ExpandedPortName a -> Bool

length :: ExpandedPortName a -> Int

elem :: Eq a => a -> ExpandedPortName a -> Bool

maximum :: Ord a => ExpandedPortName a -> a

minimum :: Ord a => ExpandedPortName a -> a

sum :: Num a => ExpandedPortName a -> a

product :: Num a => ExpandedPortName a -> a

Traversable ExpandedPortName

Defined in Clash.Netlist.Types

Methods

traverse :: Applicative f => (a -> f b) -> ExpandedPortName a -> f (ExpandedPortName b)

sequenceA :: Applicative f => ExpandedPortName (f a) -> f (ExpandedPortName a)

mapM :: Monad m => (a -> m b) -> ExpandedPortName a -> m (ExpandedPortName b)

sequence :: Monad m => ExpandedPortName (m a) -> m (ExpandedPortName a)

Show a => Show (ExpandedPortName a)

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> ExpandedPortName a -> ShowS

show :: ExpandedPortName a -> String

showList :: [ExpandedPortName a] -> ShowS

data ExpandedTopEntity a

Same as TopEntity, but with all port names that end up in HDL specified

Constructors

ExpandedTopEntity

Fields

• et_inputs :: [Maybe (ExpandedPortName a)]

  Inputs with fully expanded port names. Nothing if port is void.

• et_output :: Maybe (ExpandedPortName a)

  Output with fully expanded port names. Nothing if port is void or BiDirectionalOut.

Instances

Functor ExpandedTopEntity

Defined in Clash.Netlist.Types

Methods

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

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

Foldable ExpandedTopEntity

Defined in Clash.Netlist.Types

Methods

fold :: Monoid m => ExpandedTopEntity m -> m

foldMap :: Monoid m => (a -> m) -> ExpandedTopEntity a -> m

foldMap' :: Monoid m => (a -> m) -> ExpandedTopEntity a -> m

foldr :: (a -> b -> b) -> b -> ExpandedTopEntity a -> b

foldr' :: (a -> b -> b) -> b -> ExpandedTopEntity a -> b

foldl :: (b -> a -> b) -> b -> ExpandedTopEntity a -> b

foldl' :: (b -> a -> b) -> b -> ExpandedTopEntity a -> b

foldr1 :: (a -> a -> a) -> ExpandedTopEntity a -> a

foldl1 :: (a -> a -> a) -> ExpandedTopEntity a -> a

toList :: ExpandedTopEntity a -> [a]

null :: ExpandedTopEntity a -> Bool

length :: ExpandedTopEntity a -> Int

elem :: Eq a => a -> ExpandedTopEntity a -> Bool

maximum :: Ord a => ExpandedTopEntity a -> a

minimum :: Ord a => ExpandedTopEntity a -> a

sum :: Num a => ExpandedTopEntity a -> a

product :: Num a => ExpandedTopEntity a -> a

Traversable ExpandedTopEntity

Defined in Clash.Netlist.Types

Methods

traverse :: Applicative f => (a -> f b) -> ExpandedTopEntity a -> f (ExpandedTopEntity b)

sequenceA :: Applicative f => ExpandedTopEntity (f a) -> f (ExpandedTopEntity a)

mapM :: Monad m => (a -> m b) -> ExpandedTopEntity a -> m (ExpandedTopEntity b)

sequence :: Monad m => ExpandedTopEntity (m a) -> m (ExpandedTopEntity a)

Show a => Show (ExpandedTopEntity a)

Defined in Clash.Netlist.Types

Methods

showsPrec :: Int -> ExpandedTopEntity a -> ShowS

show :: ExpandedTopEntity a -> String

showList :: [ExpandedTopEntity a] -> ShowS

pattern NetDecl

Arguments

:: Maybe Comment

Note; will be inserted as a comment in target hdl

-> Identifier

Name of signal

-> HWType

Type of signal

-> Declaration

identifierKey# :: Identifier -> ((Text, Bool), [Word])

onSomeBackend :: (forall b. Backend b => b -> a) -> SomeBackend -> a

fromSomeBackend :: (forall b. Backend b => b -> a) -> Getter SomeBackend a

isBiDirectional :: (Identifier, HWType) -> Bool

Check if an input port is really an inout port.

findClocks :: Component -> [(Text, Text)]

Find the name and domain name of each clock argument of a component.

This will not consider ClockN to be a clock argument, which means only the positive phase of a differential pair will be added to sdcClock.

annotated :: [Attr Text] -> HWType -> HWType

Smart constructor for Annotated. Wraps the given type in an Annotated if the attribute list is non-empty. If it is empty, it will return the given HWType unchanged.

hwTypeDomain :: HWType -> Maybe DomainName

hwTypeAttrs :: HWType -> [Attr Text]

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

lookupUsage :: Identifier -> UsageMap -> Maybe Usage

isConstExpr :: Expr -> Bool

toBit

Arguments

:: Integer

mask

-> Integer

value

-> Bit

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

clashEnv :: Lens' NetlistEnv ClashEnv

prefixName :: Lens' NetlistEnv Text

setName :: Lens' NetlistEnv (Maybe Text)

suffixName :: Lens' NetlistEnv Text

backEndITE :: Lens' NetlistState Bool

backend :: Lens' NetlistState SomeBackend

bindings :: Lens' NetlistState BindingMap

componentNames :: Lens' NetlistState (VarEnv Identifier)

components :: Lens' NetlistState ComponentMap

curBBlvl :: Lens' NetlistState Int

curCompNm :: Lens' NetlistState (Identifier, SrcSpan)

hdlDir :: Lens' NetlistState FilePath

htyCache :: Lens' NetlistState HWMap

isTestBench :: Lens' NetlistState Bool

seenComps :: Lens' NetlistState IdentifierSet

seenIds :: Lens' NetlistState IdentifierSet

seenPrimitives :: Lens' NetlistState (Set Text)

topEntityAnns :: Lens' NetlistState (VarEnv TopEntityT)

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

usages :: Lens' NetlistState UsageMap

intWidth :: Getter NetlistEnv Int

customReprs :: Getter NetlistEnv CustomReprs

tcCache :: Getter NetlistEnv TyConMap

primitives :: Getter NetlistEnv CompiledPrimMap

clashOpts :: Getter NetlistEnv ClashOpts