Clash.Primitives.Types

Type and instance definitions for Primitive

Documentation

data TemplateSource

Constructors

TFile FilePath

Template source stored in file on filesystem

TInline Text

Template stored inline

Instances

Eq TemplateSource

Defined in Clash.Primitives.Types

Methods

(==) :: TemplateSource -> TemplateSource -> Bool

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

Show TemplateSource

Defined in Clash.Primitives.Types

Methods

showsPrec :: Int -> TemplateSource -> ShowS

show :: TemplateSource -> String

showList :: [TemplateSource] -> ShowS

Generic TemplateSource

Defined in Clash.Primitives.Types

Associated Types

type Rep TemplateSource :: Type -> Type

Methods

from :: TemplateSource -> Rep TemplateSource x

to :: Rep TemplateSource x -> TemplateSource

Hashable TemplateSource

Defined in Clash.Primitives.Types

Methods

hashWithSalt :: Int -> TemplateSource -> Int

hash :: TemplateSource -> Int

FromJSON UnresolvedPrimitive

Defined in Clash.Primitives.Types

Methods

parseJSON :: Value -> Parser UnresolvedPrimitive

parseJSONList :: Value -> Parser [UnresolvedPrimitive]

omittedField :: Maybe UnresolvedPrimitive

NFData TemplateSource

Defined in Clash.Primitives.Types

Methods

rnf :: TemplateSource -> ()

type Rep TemplateSource

Defined in Clash.Primitives.Types

type Rep TemplateSource = D1 ('MetaData "TemplateSource" "Clash.Primitives.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "TFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "TInline" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data TemplateKind

Constructors

TDecl

TExpr

Instances

Eq TemplateKind

Defined in Clash.Netlist.BlackBox.Types

Methods

(==) :: TemplateKind -> TemplateKind -> Bool

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

Show TemplateKind

Defined in Clash.Netlist.BlackBox.Types

Methods

showsPrec :: Int -> TemplateKind -> ShowS

show :: TemplateKind -> String

showList :: [TemplateKind] -> ShowS

Generic TemplateKind

Defined in Clash.Netlist.BlackBox.Types

Associated Types

type Rep TemplateKind :: Type -> Type

Methods

from :: TemplateKind -> Rep TemplateKind x

to :: Rep TemplateKind x -> TemplateKind

Hashable TemplateKind

Defined in Clash.Netlist.BlackBox.Types

Methods

hashWithSalt :: Int -> TemplateKind -> Int

hash :: TemplateKind -> Int

Binary TemplateKind

Defined in Clash.Netlist.BlackBox.Types

Methods

put :: TemplateKind -> Put

get :: Get TemplateKind

putList :: [TemplateKind] -> Put

NFData TemplateKind

Defined in Clash.Netlist.BlackBox.Types

Methods

rnf :: TemplateKind -> ()

type Rep TemplateKind

Defined in Clash.Netlist.BlackBox.Types

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

data TemplateFormat

Constructors

TTemplate

THaskell

Instances

Eq TemplateFormat

Defined in Clash.Primitives.Types

Methods

(==) :: TemplateFormat -> TemplateFormat -> Bool

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

Show TemplateFormat

Defined in Clash.Primitives.Types

Methods

showsPrec :: Int -> TemplateFormat -> ShowS

show :: TemplateFormat -> String

showList :: [TemplateFormat] -> ShowS

Generic TemplateFormat

Defined in Clash.Primitives.Types

Associated Types

type Rep TemplateFormat :: Type -> Type

Methods

from :: TemplateFormat -> Rep TemplateFormat x

to :: Rep TemplateFormat x -> TemplateFormat

Hashable TemplateFormat

Defined in Clash.Primitives.Types

Methods

hashWithSalt :: Int -> TemplateFormat -> Int

hash :: TemplateFormat -> Int

FromJSON UnresolvedPrimitive

Defined in Clash.Primitives.Types

Methods

parseJSON :: Value -> Parser UnresolvedPrimitive

parseJSONList :: Value -> Parser [UnresolvedPrimitive]

omittedField :: Maybe UnresolvedPrimitive

NFData TemplateFormat

Defined in Clash.Primitives.Types

Methods

rnf :: TemplateFormat -> ()

type Rep TemplateFormat

Defined in Clash.Primitives.Types

type Rep TemplateFormat = D1 ('MetaData "TemplateFormat" "Clash.Primitives.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "TTemplate" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "THaskell" 'PrefixI 'False) (U1 :: Type -> Type))

data BlackBoxFunctionName

A BBFN is a parsed version of a fully qualified function name. It is guaranteed to have at least one module name which is not Main.

Constructors

BlackBoxFunctionName [String] String

Instances

Eq BlackBoxFunctionName

Defined in Clash.Primitives.Types

Methods

(==) :: BlackBoxFunctionName -> BlackBoxFunctionName -> Bool

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

Show BlackBoxFunctionName

Defined in Clash.Primitives.Types

Methods

showsPrec :: Int -> BlackBoxFunctionName -> ShowS

show :: BlackBoxFunctionName -> String

showList :: [BlackBoxFunctionName] -> ShowS

Generic BlackBoxFunctionName

Defined in Clash.Primitives.Types

Associated Types

type Rep BlackBoxFunctionName :: Type -> Type

Methods

from :: BlackBoxFunctionName -> Rep BlackBoxFunctionName x

to :: Rep BlackBoxFunctionName x -> BlackBoxFunctionName

Hashable BlackBoxFunctionName

Defined in Clash.Primitives.Types

Methods

hashWithSalt :: Int -> BlackBoxFunctionName -> Int

hash :: BlackBoxFunctionName -> Int

FromJSON UnresolvedPrimitive

Defined in Clash.Primitives.Types

Methods

parseJSON :: Value -> Parser UnresolvedPrimitive

parseJSONList :: Value -> Parser [UnresolvedPrimitive]

omittedField :: Maybe UnresolvedPrimitive

Binary BlackBoxFunctionName

Defined in Clash.Primitives.Types

Methods

put :: BlackBoxFunctionName -> Put

get :: Get BlackBoxFunctionName

putList :: [BlackBoxFunctionName] -> Put

NFData BlackBoxFunctionName

Defined in Clash.Primitives.Types

Methods

rnf :: BlackBoxFunctionName -> ()

type Rep BlackBoxFunctionName

Defined in Clash.Primitives.Types

type Rep BlackBoxFunctionName = D1 ('MetaData "BlackBoxFunctionName" "Clash.Primitives.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "BlackBoxFunctionName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

data Primitive a b c d

Externally defined primitive

Constructors

BlackBox

Primitive template written in a Clash specific templating language

Fields

• name :: !Text

  Name of the primitive

• workInfo :: WorkInfo

  Whether the primitive does any work, i.e. takes chip area

• renderVoid :: RenderVoid

  Whether this primitive should be rendered when its result type is void. Defaults to NoRenderVoid.

• multiResult :: Bool

  Wether this blackbox assigns its results to multiple variables. See setupMultiResultPrim

• kind :: TemplateKind

  Whether this results in an expression or a declaration

• warning :: c

  A warning to be outputted when the primitive is instantiated. This is intended to be used as a warning for primitives that are not synthesizable, but may also be used for other purposes.

• outputUsage :: Usage

  How the result is assigned in HDL. This is used to determine the type of declaration used to render the result (wire/reg or signal/variable). The default usage is continuous assignment.

• libraries :: [a]

  VHDL only: add library declarations for the given names

• imports :: [a]

  VHDL only: add use declarations for the given names

• functionPlurality :: [(Int, Int)]

  Indicates how often a function will be instantiated in a blackbox. For example, consider the following higher-order function that creates a tree structure:

  fold :: (a -> a -> a) -> Vec n a -> a

  In order to generate HDL for an instance of fold we need log2(n) calls to the first argument, `a -> a -> a` (plus a few more if n is not a power of two). Note that this only targets multiple textual instances of the function. If you can generate the HDL using a for-loop and only need to call ~INST once, you don't have to worry about this option. See the blackbox for map for an example of this.

  Right now, option can only be generated by BlackBoxHaskell. It cannot be used within JSON primitives. To see how to use this, see the Haskell blackbox for fold.

• includes :: [((Text, Text), b)]

  Create files to be included with the generated primitive. The fields are ((name, extension), content), where content is a template of the file Defaults to [] when not specified in the .primitives file

• resultNames :: [b]

  (Maybe) Control the generated name of the result

• resultInits :: [b]

  (Maybe) Control the initial/power-up value of the result

• template :: b

  Used to indiciate type of template (declaration or expression). Will be filled with Template or an Either decl expr.

BlackBoxHaskell

Primitive template rendered by a Haskell function (given as raw source code)

Fields

• name :: !Text

  Name of the primitive

• workInfo :: WorkInfo

  Whether the primitive does any work, i.e. takes chip area

• usedArguments :: UsedArguments

  Arguments used by blackbox. Used to remove arguments during normalization.

• multiResult :: Bool

  Wether this blackbox assigns its results to multiple variables. See setupMultiResultPrim

• functionName :: BlackBoxFunctionName
• function :: d

  Holds blackbox function and its hash, (Int, BlackBoxFunction), in a CompiledPrimitive.

Primitive

A primitive that carries additional information. These are "real" primitives, hardcoded in the compiler. For example: mapSignal in GHC2Core.coreToTerm.

Fields

• name :: !Text

  Name of the primitive

• workInfo :: WorkInfo

  Whether the primitive does any work, i.e. takes chip area

• primSort :: !Text

  Additional information

Instances

FromJSON UnresolvedPrimitive

Defined in Clash.Primitives.Types

Methods

parseJSON :: Value -> Parser UnresolvedPrimitive

parseJSONList :: Value -> Parser [UnresolvedPrimitive]

omittedField :: Maybe UnresolvedPrimitive

Functor (Primitive a b c)

Defined in Clash.Primitives.Types

Methods

fmap :: (a0 -> b0) -> Primitive a b c a0 -> Primitive a b c b0

(<$) :: a0 -> Primitive a b c b0 -> Primitive a b c a0

(Eq c, Eq a, Eq b, Eq d) => Eq (Primitive a b c d)

Defined in Clash.Primitives.Types

Methods

(==) :: Primitive a b c d -> Primitive a b c d -> Bool

(/=) :: Primitive a b c d -> Primitive a b c d -> Bool

(Show c, Show a, Show b, Show d) => Show (Primitive a b c d)

Defined in Clash.Primitives.Types

Methods

showsPrec :: Int -> Primitive a b c d -> ShowS

show :: Primitive a b c d -> String

showList :: [Primitive a b c d] -> ShowS

Generic (Primitive a b c d)

Defined in Clash.Primitives.Types

Associated Types

type Rep (Primitive a b c d) :: Type -> Type

Methods

from :: Primitive a b c d -> Rep (Primitive a b c d) x

to :: Rep (Primitive a b c d) x -> Primitive a b c d

(Hashable c, Hashable a, Hashable b, Hashable d) => Hashable (Primitive a b c d)

Defined in Clash.Primitives.Types

Methods

hashWithSalt :: Int -> Primitive a b c d -> Int

hash :: Primitive a b c d -> Int

(Binary c, Binary a, Binary b, Binary d) => Binary (Primitive a b c d)

Defined in Clash.Primitives.Types

Methods

put :: Primitive a b c d -> Put

get :: Get (Primitive a b c d)

putList :: [Primitive a b c d] -> Put

(NFData c, NFData a, NFData b, NFData d) => NFData (Primitive a b c d)

Defined in Clash.Primitives.Types

Methods

rnf :: Primitive a b c d -> ()

type Rep (Primitive a b c d)

Defined in Clash.Primitives.Types

type Rep (Primitive a b c d) = D1 ('MetaData "Primitive" "Clash.Primitives.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "BlackBox" 'PrefixI 'True) (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "workInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WorkInfo) :*: S1 ('MetaSel ('Just "renderVoid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RenderVoid))) :*: ((S1 ('MetaSel ('Just "multiResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TemplateKind)) :*: (S1 ('MetaSel ('Just "warning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 c) :*: S1 ('MetaSel ('Just "outputUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage)))) :*: ((S1 ('MetaSel ('Just "libraries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :*: (S1 ('MetaSel ('Just "imports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :*: S1 ('MetaSel ('Just "functionPlurality") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Int, Int)]))) :*: ((S1 ('MetaSel ('Just "includes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [((Text, Text), b)]) :*: S1 ('MetaSel ('Just "resultNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [b])) :*: (S1 ('MetaSel ('Just "resultInits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [b]) :*: S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 b))))) :+: (C1 ('MetaCons "BlackBoxHaskell" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "workInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WorkInfo) :*: S1 ('MetaSel ('Just "usedArguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UsedArguments))) :*: (S1 ('MetaSel ('Just "multiResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "functionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlackBoxFunctionName) :*: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 d)))) :+: C1 ('MetaCons "Primitive" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "workInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WorkInfo) :*: S1 ('MetaSel ('Just "primSort") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))))

data UsedArguments

Data type to indicate what arguments are in use by a BlackBox

Constructors

UsedArguments [Int]

Only these are used

IgnoredArguments [Int]

All but these are used

Instances

Eq UsedArguments

Defined in Clash.Primitives.Types

Methods

(==) :: UsedArguments -> UsedArguments -> Bool

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

Show UsedArguments

Defined in Clash.Primitives.Types

Methods

showsPrec :: Int -> UsedArguments -> ShowS

show :: UsedArguments -> String

showList :: [UsedArguments] -> ShowS

Generic UsedArguments

Defined in Clash.Primitives.Types

Associated Types

type Rep UsedArguments :: Type -> Type

Methods

from :: UsedArguments -> Rep UsedArguments x

to :: Rep UsedArguments x -> UsedArguments

Hashable UsedArguments

Defined in Clash.Primitives.Types

Methods

hashWithSalt :: Int -> UsedArguments -> Int

hash :: UsedArguments -> Int

Binary UsedArguments

Defined in Clash.Primitives.Types

Methods

put :: UsedArguments -> Put

get :: Get UsedArguments

putList :: [UsedArguments] -> Put

NFData UsedArguments

Defined in Clash.Primitives.Types

Methods

rnf :: UsedArguments -> ()

type Rep UsedArguments

Defined in Clash.Primitives.Types

type Rep UsedArguments = D1 ('MetaData "UsedArguments" "Clash.Primitives.Types" "clash-lib-1.9.0-inplace" 'False) (C1 ('MetaCons "UsedArguments" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int])) :+: C1 ('MetaCons "IgnoredArguments" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int])))

type GuardedCompiledPrimitive = PrimitiveGuard CompiledPrimitive

type GuardedResolvedPrimitive = PrimitiveGuard ResolvedPrimitive

type PrimMap a = HashMap Text a

A PrimMap maps primitive names to a Primitive

type UnresolvedPrimitive = Primitive Text ((TemplateFormat, BlackBoxFunctionName), Maybe TemplateSource) (Maybe Text) (Maybe TemplateSource)

An unresolved primitive still contains pointers to files.

type ResolvedPrimitive = Primitive Text ((TemplateFormat, BlackBoxFunctionName), Maybe Text) () (Maybe Text)

A parsed primitive does not contain pointers to filesystem files anymore, but holds uncompiled BlackBoxTemplates and BlackBoxFunctions.

type ResolvedPrimMap = PrimMap GuardedResolvedPrimitive

type CompiledPrimitive = Primitive BlackBoxTemplate BlackBox () (Int, BlackBoxFunction)

A compiled primitive has compiled all templates and functions from its ResolvedPrimitive counterpart. The Int in the tuple is a hash of the (uncompiled) BlackBoxFunction.

type CompiledPrimMap = PrimMap GuardedCompiledPrimitive