16657Snate@binkert.org# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
26657Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
36657Snate@binkert.org# All rights reserved.
46657Snate@binkert.org#
56657Snate@binkert.org# Redistribution and use in source and binary forms, with or without
66657Snate@binkert.org# modification, are permitted provided that the following conditions are
76657Snate@binkert.org# met: redistributions of source code must retain the above copyright
86657Snate@binkert.org# notice, this list of conditions and the following disclaimer;
96657Snate@binkert.org# redistributions in binary form must reproduce the above copyright
106657Snate@binkert.org# notice, this list of conditions and the following disclaimer in the
116657Snate@binkert.org# documentation and/or other materials provided with the distribution;
126657Snate@binkert.org# neither the name of the copyright holders nor the names of its
136657Snate@binkert.org# contributors may be used to endorse or promote products derived from
146657Snate@binkert.org# this software without specific prior written permission.
156657Snate@binkert.org#
166657Snate@binkert.org# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
176657Snate@binkert.org# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
186657Snate@binkert.org# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
196657Snate@binkert.org# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
206657Snate@binkert.org# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
216657Snate@binkert.org# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
226657Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
236657Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
246657Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
256657Snate@binkert.org# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
266657Snate@binkert.org# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
276657Snate@binkert.org
286657Snate@binkert.orgfrom slicc.ast.DeclAST import DeclAST
296657Snate@binkert.orgfrom slicc.ast.TypeAST import TypeAST
306657Snate@binkert.orgfrom slicc.symbols import Func, Type, Var
316657Snate@binkert.org
326657Snate@binkert.orgclass InPortDeclAST(DeclAST):
336657Snate@binkert.org    def __init__(self, slicc, ident, msg_type, var_expr, pairs, statements):
346657Snate@binkert.org        super(InPortDeclAST, self).__init__(slicc, pairs)
356657Snate@binkert.org
366657Snate@binkert.org        self.ident = ident
376657Snate@binkert.org        self.msg_type = msg_type
386657Snate@binkert.org        self.var_expr = var_expr
396657Snate@binkert.org        self.statements = statements
406657Snate@binkert.org        self.queue_type = TypeAST(slicc, "InPort")
416657Snate@binkert.org
426657Snate@binkert.org    def __repr__(self):
436657Snate@binkert.org        return "[InPortDecl: %s]" % self.ident
446657Snate@binkert.org
456657Snate@binkert.org    def generate(self):
466657Snate@binkert.org        symtab = self.symtab
476657Snate@binkert.org        void_type = symtab.find("void", Type)
486657Snate@binkert.org
497839Snilay@cs.wisc.edu        machine = symtab.state_machine
507839Snilay@cs.wisc.edu        if machine is None:
517839Snilay@cs.wisc.edu            self.error("InPort declaration not part of a machine.")
527839Snilay@cs.wisc.edu
536999Snate@binkert.org        code = self.slicc.codeFormatter()
546657Snate@binkert.org        queue_type = self.var_expr.generate(code)
556657Snate@binkert.org        if not queue_type.isInPort:
566657Snate@binkert.org            self.error("The inport queue's type must have the 'inport' " + \
576657Snate@binkert.org                       "attribute.  Type '%s' does not have this attribute.",
586657Snate@binkert.org                       queue_type)
596657Snate@binkert.org
606657Snate@binkert.org        type = self.queue_type.type
6111095Snilay@cs.wisc.edu        self.pairs["buffer_expr"] = self.var_expr
626657Snate@binkert.org        in_port = Var(self.symtab, self.ident, self.location, type, str(code),
6311095Snilay@cs.wisc.edu                      self.pairs, machine)
646657Snate@binkert.org        symtab.newSymbol(in_port)
656657Snate@binkert.org
666657Snate@binkert.org        symtab.pushFrame()
676657Snate@binkert.org        param_types = []
686657Snate@binkert.org
696657Snate@binkert.org        # Check for Event
706657Snate@binkert.org        type = symtab.find("Event", Type)
716657Snate@binkert.org        if type is None:
726657Snate@binkert.org            self.error("in_port decls require 'Event' enumeration defined")
736657Snate@binkert.org        param_types.append(type)
746657Snate@binkert.org
756657Snate@binkert.org        # Check for Address
7611025Snilay@cs.wisc.edu        type = symtab.find("Addr", Type)
776657Snate@binkert.org        if type is None:
7811025Snilay@cs.wisc.edu            self.error("in_port decls require 'Addr' type to be defined")
796657Snate@binkert.org
806657Snate@binkert.org        param_types.append(type)
816657Snate@binkert.org
827839Snilay@cs.wisc.edu        if machine.EntryType != None:
837839Snilay@cs.wisc.edu            param_types.append(machine.EntryType)
847839Snilay@cs.wisc.edu        if machine.TBEType != None:
857839Snilay@cs.wisc.edu            param_types.append(machine.TBEType)
867839Snilay@cs.wisc.edu
876657Snate@binkert.org        # Add the trigger method - FIXME, this is a bit dirty
886657Snate@binkert.org        pairs = { "external" : "yes" }
8910984SBrad.Beckmann@amd.com        trigger_func_name = "trigger"
9010984SBrad.Beckmann@amd.com        for param in param_types:
9110984SBrad.Beckmann@amd.com            trigger_func_name += "_" + param.ident
9210984SBrad.Beckmann@amd.com        func = Func(self.symtab, trigger_func_name, "trigger", self.location,
9311049Snilay@cs.wisc.edu                    void_type, param_types, [], "", pairs)
946657Snate@binkert.org        symtab.newSymbol(func)
956657Snate@binkert.org
9610981SBrad.Beckmann@amd.com        # Add the stallPort method - this hacks reschedules the controller
9710981SBrad.Beckmann@amd.com        # for stalled messages that don't trigger events
9810984SBrad.Beckmann@amd.com        func = Func(self.symtab, "stallPort", "stallPort", self.location,
9911049Snilay@cs.wisc.edu                    void_type, [], [], "", pairs)
10010981SBrad.Beckmann@amd.com        symtab.newSymbol(func)
10110981SBrad.Beckmann@amd.com
1026657Snate@binkert.org        param_types = []
1036657Snate@binkert.org        # Check for Event2
1046657Snate@binkert.org        type = symtab.find("Event", Type)
1056657Snate@binkert.org        if type is None:
1066657Snate@binkert.org            self.error("in_port decls require 'Event' enumeration")
1076657Snate@binkert.org
1086657Snate@binkert.org        param_types.append(type)
1096657Snate@binkert.org
1106657Snate@binkert.org        # Check for Address2
11111025Snilay@cs.wisc.edu        type = symtab.find("Addr", Type)
1126657Snate@binkert.org        if type is None:
11311025Snilay@cs.wisc.edu            self.error("in_port decls require 'Addr' type to be defined")
1146657Snate@binkert.org
1156657Snate@binkert.org        param_types.append(type)
1166657Snate@binkert.org
1176657Snate@binkert.org        if self.statements is not None:
1186999Snate@binkert.org            rcode = self.slicc.codeFormatter()
1196657Snate@binkert.org            rcode.indent()
1206657Snate@binkert.org            rcode.indent()
1216657Snate@binkert.org            self.statements.generate(rcode, None)
1226657Snate@binkert.org            in_port["c_code_in_port"] = str(rcode)
1237839Snilay@cs.wisc.edu
1246657Snate@binkert.org        symtab.popFrame()
1256657Snate@binkert.org
1266657Snate@binkert.org        # Add port to state machine
1276657Snate@binkert.org        machine.addInPort(in_port)
128