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

Clash.Primitives.Types

Description

Type and instance definitions for Primitive

Synopsis

data TemplateSource
- = TFile FilePath
- | TInline Text
data TemplateKind
- = TDecl
- | TExpr
data TemplateFormat
- = TTemplate
- | THaskell
data BlackBoxFunctionName = BlackBoxFunctionName [String] String
data Primitive a b c d
- = BlackBox {
  - name :: !Text
  - workInfo :: WorkInfo
  - kind :: TemplateKind
  - warning :: c
  - outputReg :: Bool
  - libraries :: [a]
  - imports :: [a]
  - includes :: [((Text, Text), b)]
  - template :: b
  }
- | BlackBoxHaskell {
  - name :: !Text
  - workInfo :: WorkInfo
  - functionName :: BlackBoxFunctionName
  - function :: d
  }
- | Primitive {
  - name :: !Text
  - workInfo :: WorkInfo
  - primSort :: !Text
  }
type GuardedCompiledPrimitive = PrimitiveGuard CompiledPrimitive
type GuardedResolvedPrimitive = PrimitiveGuard ResolvedPrimitive
type PrimMap a = HashMap Text a
type UnresolvedPrimitive = Primitive Text ((TemplateFormat, BlackBoxFunctionName), Maybe TemplateSource) (Maybe Text) (Maybe TemplateSource)
type ResolvedPrimitive = Primitive Text ((TemplateFormat, BlackBoxFunctionName), Maybe Text) () (Maybe Text)
type ResolvedPrimMap = PrimMap GuardedResolvedPrimitive
type CompiledPrimitive = Primitive BlackBoxTemplate BlackBox () (Int, BlackBoxFunction)
type CompiledPrimMap = PrimMap GuardedCompiledPrimitive

Documentation

data TemplateSource Source #

Constructors

TFile FilePath	Template source stored in file on filesystem
TInline Text	Template stored inline

Instances

Instances details

Eq TemplateSource Source #
Instance details Defined in Clash.Primitives.Types Methods (==) :: TemplateSource -> TemplateSource -> Bool # (/=) :: TemplateSource -> TemplateSource -> Bool #
Show TemplateSource Source #
Instance details Defined in Clash.Primitives.Types Methods showsPrec :: Int -> TemplateSource -> ShowS # show :: TemplateSource -> String # showList :: [TemplateSource] -> ShowS #
Generic TemplateSource Source #
Instance details Defined in Clash.Primitives.Types Associated Types type Rep TemplateSource :: Type -> Type # Methods from :: TemplateSource -> Rep TemplateSource x # to :: Rep TemplateSource x -> TemplateSource #
FromJSON UnresolvedPrimitive Source #
Instance details Defined in Clash.Primitives.Types Methods parseJSON :: Value -> Parser UnresolvedPrimitive # parseJSONList :: Value -> Parser [UnresolvedPrimitive] #
NFData TemplateSource Source #
Instance details Defined in Clash.Primitives.Types Methods rnf :: TemplateSource -> () #
type Rep TemplateSource Source #
Instance details Defined in Clash.Primitives.Types type Rep TemplateSource = D1 ('MetaData "TemplateSource" "Clash.Primitives.Types" "clash-lib-0.9999-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 Source #

Constructors

TDecl
TExpr

Instances

Instances details

Eq TemplateKind Source #
Instance details Defined in Clash.Netlist.BlackBox.Types Methods (==) :: TemplateKind -> TemplateKind -> Bool # (/=) :: TemplateKind -> TemplateKind -> Bool #
Show TemplateKind Source #
Instance details Defined in Clash.Netlist.BlackBox.Types Methods showsPrec :: Int -> TemplateKind -> ShowS # show :: TemplateKind -> String # showList :: [TemplateKind] -> ShowS #
Generic TemplateKind Source #
Instance details 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 Source #
Instance details Defined in Clash.Netlist.BlackBox.Types Methods hashWithSalt :: Int -> TemplateKind -> Int # hash :: TemplateKind -> Int #
Binary TemplateKind Source #
Instance details Defined in Clash.Netlist.BlackBox.Types Methods put :: TemplateKind -> Put # get :: Get TemplateKind # putList :: [TemplateKind] -> Put #
NFData TemplateKind Source #
Instance details Defined in Clash.Netlist.BlackBox.Types Methods rnf :: TemplateKind -> () #
type Rep TemplateKind Source #
Instance details Defined in Clash.Netlist.BlackBox.Types type Rep TemplateKind = D1 ('MetaData "TemplateKind" "Clash.Netlist.BlackBox.Types" "clash-lib-0.9999-inplace" 'False) (C1 ('MetaCons "TDecl" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TExpr" 'PrefixI 'False) (U1 :: Type -> Type))

data TemplateFormat Source #

Constructors

TTemplate
THaskell

Instances

Instances details

Show TemplateFormat Source #
Instance details Defined in Clash.Primitives.Types Methods showsPrec :: Int -> TemplateFormat -> ShowS # show :: TemplateFormat -> String # showList :: [TemplateFormat] -> ShowS #
Generic TemplateFormat Source #
Instance details 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 Source #
Instance details Defined in Clash.Primitives.Types Methods hashWithSalt :: Int -> TemplateFormat -> Int # hash :: TemplateFormat -> Int #
FromJSON UnresolvedPrimitive Source #
Instance details Defined in Clash.Primitives.Types Methods parseJSON :: Value -> Parser UnresolvedPrimitive # parseJSONList :: Value -> Parser [UnresolvedPrimitive] #
NFData TemplateFormat Source #
Instance details Defined in Clash.Primitives.Types Methods rnf :: TemplateFormat -> () #
type Rep TemplateFormat Source #
Instance details Defined in Clash.Primitives.Types type Rep TemplateFormat = D1 ('MetaData "TemplateFormat" "Clash.Primitives.Types" "clash-lib-0.9999-inplace" 'False) (C1 ('MetaCons "TTemplate" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "THaskell" 'PrefixI 'False) (U1 :: Type -> Type))

data BlackBoxFunctionName Source #

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

Instances details

Eq BlackBoxFunctionName Source #
Instance details Defined in Clash.Primitives.Types Methods (==) :: BlackBoxFunctionName -> BlackBoxFunctionName -> Bool # (/=) :: BlackBoxFunctionName -> BlackBoxFunctionName -> Bool #
Show BlackBoxFunctionName Source #
Instance details Defined in Clash.Primitives.Types Methods showsPrec :: Int -> BlackBoxFunctionName -> ShowS # show :: BlackBoxFunctionName -> String # showList :: [BlackBoxFunctionName] -> ShowS #
Generic BlackBoxFunctionName Source #
Instance details 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 Source #
Instance details Defined in Clash.Primitives.Types Methods hashWithSalt :: Int -> BlackBoxFunctionName -> Int # hash :: BlackBoxFunctionName -> Int #
FromJSON UnresolvedPrimitive Source #
Instance details Defined in Clash.Primitives.Types Methods parseJSON :: Value -> Parser UnresolvedPrimitive # parseJSONList :: Value -> Parser [UnresolvedPrimitive] #
Binary BlackBoxFunctionName Source #
Instance details Defined in Clash.Primitives.Types Methods put :: BlackBoxFunctionName -> Put # get :: Get BlackBoxFunctionName # putList :: [BlackBoxFunctionName] -> Put #
NFData BlackBoxFunctionName Source #
Instance details Defined in Clash.Primitives.Types Methods rnf :: BlackBoxFunctionName -> () #
type Rep BlackBoxFunctionName Source #
Instance details Defined in Clash.Primitives.Types type Rep BlackBoxFunctionName = D1 ('MetaData "BlackBoxFunctionName" "Clash.Primitives.Types" "clash-lib-0.9999-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 Source #

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 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. outputReg :: Bool Verilog only: whether the result should be a reg(`True`) or wire (`False`); when not specified in the .json file, the value will default to `False` (i.e. wire). libraries :: [a] VHDL only: add library declarations for the given names imports :: [a] VHDL only: add use declarations for the given names 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 .json file 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 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

Instances details

FromJSON UnresolvedPrimitive Source #
Instance details Defined in Clash.Primitives.Types Methods parseJSON :: Value -> Parser UnresolvedPrimitive # parseJSONList :: Value -> Parser [UnresolvedPrimitive] #
Functor (Primitive a b c) Source #
Instance details 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 #
(Show c, Show a, Show b, Show d) => Show (Primitive a b c d) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Clash.Primitives.Types Methods rnf :: Primitive a b c d -> () #
type Rep (Primitive a b c d) Source #
Instance details Defined in Clash.Primitives.Types type Rep (Primitive a b c d) = D1 ('MetaData "Primitive" "Clash.Primitives.Types" "clash-lib-0.9999-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 "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TemplateKind) :: S1 ('MetaSel ('Just "warning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 c))) :: ((S1 ('MetaSel ('Just "outputReg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "libraries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])) :: (S1 ('MetaSel ('Just "imports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :: (S1 ('MetaSel ('Just "includes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [((Text, Text), 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 "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)))))

type GuardedCompiledPrimitive = PrimitiveGuard CompiledPrimitive Source #

type GuardedResolvedPrimitive = PrimitiveGuard ResolvedPrimitive Source #

type PrimMap a = HashMap Text a Source #

A PrimMap maps primitive names to a Primitive

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

An unresolved primitive still contains pointers to files.

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

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

type ResolvedPrimMap = PrimMap GuardedResolvedPrimitive Source #

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

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 Source #