root/hiersort/sim/InterfaceTypes.hs

-- | InterfaceTypes.hs
--
-- Module that contains types for other parts to manipulate.
--
-- Copytight (C) 2007, 2008 Serguey Zefirov
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 3, or (at your option)
-- any later version.
-- See file COPYING or visit http://www.gnu.org/licenses for details.


module InterfaceTypes where

-------------------------------------------------------------------------------
-- Types for processor execution and "assembler" commands.

-- Processor thread window execution policies.
data ProcShedulingPolicy =
                SheduleAllWorkBack
        |       SheduleSheduledBack
        |       SheduleWindow
        deriving (Read,Show,Enum,Eq,Ord)

-- Processor execution unit resources.
data ProcResource =
                IAdder
        |       ILogic
        |       IMultiplier
        |       FAdder
        |       FMultiplier
        |       FDivider
        deriving (Ord,Eq,Show)

-- All processor resources - execution and communication.
data ProcExtResource =
                MessageChannel  MsgChannel
        |       OtherResource   ProcResource
        deriving (Ord,Eq,Show)

-- Message channels resources (there was two message channels once upon a time).
data MsgChannel =
        MsgChannelMatch
        deriving (Ord,Eq,Show)

-- And what kind of commands processor can "execute."
data ProcessorCommand m =
                ProcNop
        |       ProcMessage     m
        |       ProcResource    ProcResource
        deriving Show

-------------------------------------------------------------------------------
-- Types for messages, matchers and sorters.

-- Message type.
data Message o t =
        Msg {
                 msgOrder       :: o
                ,msgArity       :: Arity
                ,msgToken       :: t
                ,msgModuleAddr  :: TokenModuleAddr
        }
        deriving Show

-- The arity type. Consists of HeadArity1, Arity1 and Arity2.
-- Tokens with HeadArity1 and Arity1 match with themselves, Arity2 tokens
-- need another token to be paired.
data Arity =
                HdA1    -- For those who should be least in the queue.
        |       A1
        |       A2
        deriving Show

-- A pair token.
data Pair i =
                P1      i
        |       P2      i       i
        deriving Show

-- Destination descriptor.
data TokenModuleAddr =
                -- Token is a result token.
                HostTok
                -- Token is an execution token. And it should be
                -- delivered into specified processor module (modulo
                -- number of processors).
        |       ModTok  Int
        deriving (Show,Eq)

tokenToMod n = ModTok n

-- Token order parts.
data Order group node =
                OrdI    group   [Int]
        |       OrdN    node
        deriving (Eq,Ord,Show)

oIndexes g l = [OrdI g l]
oNode      n = [OrdN n]


-------------------------------------------------------------------------------
-- An extra type to control widths of buses.

data Width = Width { fromWidth :: Int } deriving (Show,Eq,Ord)
mkWidth pos n
        | n < 1 = error $ unwords ["improper width",show n,"pos",pos]
        | otherwise = Width n