VHDLTypes.hs

   1 --
   2 -- Some types used by the VHDL module.
   3 --
   4 {-# LANGUAGE TemplateHaskell #-}
   5 module VHDLTypes where
   6
   7 -- Standard imports
   8 import qualified Control.Monad.Trans.State as State
   9 import qualified Data.Map as Map
  10 import Data.Accessor
  11 import qualified Data.Accessor.Template
  12
  13 -- GHC API imports
  14 import qualified Type
  15 import qualified CoreSyn
  16
  17 -- ForSyDe imports
  18 import qualified ForSyDe.Backend.VHDL.AST as AST
  19
  20 -- Local imports
  21
  22 -- A description of a port of an entity
  23 type Port = (AST.VHDLId, AST.TypeMark)
  24
  25 -- A description of a VHDL entity. Contains both the entity itself as well as
  26 -- info on how to map a haskell value (argument / result) on to the entity's
  27 -- ports.
  28 data Entity = Entity {
  29   ent_id     :: AST.VHDLId,           -- The id of the entity
  30   ent_args   :: [Port],      -- A mapping of each function argument to port names
  31   ent_res    :: Port         -- A mapping of the function result to port names
  32 } deriving (Show);
  33
  34 -- A orderable equivalent of CoreSyn's Type for use as a map key
  35 newtype OrdType = OrdType { getType :: Type.Type }
  36 instance Eq OrdType where
  37   (OrdType a) == (OrdType b) = Type.tcEqType a b
  38 instance Ord OrdType where
  39   compare (OrdType a) (OrdType b) = Type.tcCmpType a b
  40
  41 -- A map of a Core type to the corresponding type name
  42 type TypeMap = Map.Map OrdType (AST.VHDLId, Either AST.TypeDef AST.SubtypeIn)
  43
  44 -- A map of a vector Core element type and function name to the coressponding
  45 -- VHDLId of the function and the function body.
  46 type TypeFunMap = Map.Map (OrdType, String) (AST.VHDLId, AST.SubProgBody)
  47
  48 -- A map of a Haskell function to a hardware signature
  49 type SignatureMap = Map.Map CoreSyn.CoreBndr Entity
  50
  51 data VHDLState = VHDLState {
  52   -- | A map of Core type -> VHDL Type
  53   vsTypes_      :: TypeMap,
  54   -- | A map of vector Core type -> VHDL type function
  55   vsTypeFuns_   :: TypeFunMap,
  56   -- | A map of HsFunction -> hardware signature (entity name, port names,
  57   --   etc.)
  58   vsSignatures_ :: SignatureMap
  59 }
  60
  61 -- Derive accessors
  62 $( Data.Accessor.Template.deriveAccessors ''VHDLState )
  63
  64 -- | The state containing a VHDL Session
  65 type VHDLSession = State.State VHDLState
  66
  67 -- | A substate containing just the types
  68 type TypeState = State.State TypeMap
  69
  70 -- A function that generates VHDL for a builtin function
  71 type BuiltinBuilder =
  72   (Either CoreSyn.CoreBndr AST.VHDLName) -- ^ The destination signal and it's original type
  73   -> CoreSyn.CoreBndr -- ^ The function called
  74   -> [Either CoreSyn.CoreExpr AST.Expr] -- ^ The value arguments passed (excluding type and
  75                     --   dictionary arguments).
  76   -> VHDLSession [AST.ConcSm] -- ^ The resulting concurrent statements.
  77
  78 -- A map of a builtin function to VHDL function builder
  79 type NameTable = Map.Map String (Int, BuiltinBuilder )
  80
  81 -- vim: set ts=8 sw=2 sts=2 expandtab: