Clash.Primitives.Types

Type and instance definitions for Primitive

Documentation

type PrimMap a = HashMap Text (Primitive a)

Primitive Definitions

data Primitive a

Externally defined primitive

Constructors

BlackBox

A primitive that has a template that can be filled out by the backend render

Fields

• name :: !Text

  Name of the primitive

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

• library :: [a]

  VHDL only: add library declarations for the given names

• imports :: [a]

  VHDL only: add use declarations for the given names

• include :: Maybe ((Text, Text), a)

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

• template :: !(Either a a)

  Either a declaration or an expression template.

Primitive

A primitive that carries additional information

Fields

• name :: !Text

  Name of the primitive

• primType :: !Text

  Additional information

Instances

Show a => Show (Primitive a)

Methods

showsPrec :: Int -> Primitive a -> ShowS

show :: Primitive a -> String

showList :: [Primitive a] -> ShowS

FromJSON (Primitive Text)

Methods

parseJSON :: Value -> Parser (Primitive Text)

parseJSONList :: Value -> Parser [Primitive Text]