{-
  SockeyeASTInstantiator.hs: AST with instantiated module templates for Sockeye

  Part of Sockeye

  Copyright (c) 2017, ETH Zurich.

  All rights reserved.

  This file is distributed under the terms in the attached LICENSE file.
  If you do not find this file, copies can be found by writing to:
  ETH Zurich D-INFK, CAB F.78, Universitaetstrasse 6, CH-8092 Zurich,
  Attn: Systems Group.
-}

module SockeyeASTInstantiator
    ( module SockeyeASTInstantiator
    , module SockeyeASTDecodingNet
    ) where

import Data.Map (Map)

import SockeyeASTDecodingNet
    ( NodeType(Core, Device, Memory, Other)
    , BlockSpec(BlockSpec)
    , base, limit, props
    , PropSpec(PropSpec)
    , identifiers
    , Address
    )

data SockeyeSpec = SockeyeSpec
    { root :: ModuleInst
    , modules :: Map Identifier Module
    } deriving (Show)

data Module = Module
    { inputPorts   :: [Port]
    , outputPorts  :: [Port]
    , moduleInsts  :: [ModuleInst]
    , nodeDecls    :: [NodeDecl]
    } deriving (Show)

data Port
    = InputPort
        { portId    :: Identifier
        , portWidth :: !Integer
        }
    | OutputPort
        { portId    :: Identifier
        , portWidth :: !Integer
        }
    deriving (Show)

data ModuleInst
    = ModuleInst
        { namespace  :: Maybe Identifier
        , moduleName :: Identifier
        , inPortMap  :: PortMap
        , outPortMap :: PortMap
        } deriving (Show)

type PortMap = Map Identifier Identifier

data NodeDecl
    = NodeDecl
        { nodeId   :: Identifier
        , nodeSpec :: NodeSpec
        } deriving (Show)

type Identifier = String

data NodeSpec = NodeSpec
    { nodeType  :: NodeType
    , accept    :: [BlockSpec]
    , translate :: [MapSpec]
    , reserved  :: [BlockSpec]
    , overlay   :: Maybe OverlaySpec
    } deriving (Show)

data MapSpec
    = MapSpec
        { srcBlock :: BlockSpec
        , destNode :: !Identifier
        , destBase :: !Address
        , destProps :: PropSpec
        } deriving (Show)

data OverlaySpec
    = OverlaySpec
        { over  :: !Identifier
        , width :: !Integer
        } deriving (Show)