Documentation

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.

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.

Fields

• name :: !Text

  Name of the primitive

• workInfo :: WorkInfo

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

• primSort :: !Text

  Additional information