BasicLink.py revision 11664:2365e9e396f7 
1# Copyright (c) 2011 Advanced Micro Devices, Inc.
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met: redistributions of source code must retain the above copyright
7# notice, this list of conditions and the following disclaimer;
8# redistributions in binary form must reproduce the above copyright
9# notice, this list of conditions and the following disclaimer in the
10# documentation and/or other materials provided with the distribution;
11# neither the name of the copyright holders nor the names of its
12# contributors may be used to endorse or promote products derived from
13# this software without specific prior written permission.
14#
15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26#
27# Authors: Steve Reinhardt
28#          Brad Beckmann
29
30from m5.params import *
31from m5.SimObject import SimObject
32
33class BasicLink(SimObject):
34    type = 'BasicLink'
35    cxx_header = "mem/ruby/network/BasicLink.hh"
36    link_id = Param.Int("ID in relation to other links")
37    latency = Param.Cycles(1, "latency")
38    # Width of the link in bytes
39    # Only used by simple network.
40    # Garnet models this by flit size
41    bandwidth_factor = Param.Int("generic bandwidth factor, usually in bytes")
42    weight = Param.Int(1, "used to restrict routing in shortest path analysis")
43
44class BasicExtLink(BasicLink):
45    type = 'BasicExtLink'
46    cxx_header = "mem/ruby/network/BasicLink.hh"
47    ext_node = Param.RubyController("External node")
48    int_node = Param.BasicRouter("ID of internal node")
49    bandwidth_factor = 16 # only used by simple network
50
51class BasicIntLink(BasicLink):
52    type = 'BasicIntLink'
53    cxx_header = "mem/ruby/network/BasicLink.hh"
54    src_node = Param.BasicRouter("Router on src end")
55    dst_node = Param.BasicRouter("Router on dst end")
56
57    # only used by Garnet.
58    src_outport = Param.String("", "Outport direction at src router")
59    dst_inport = Param.String("", "Inport direction at dst router")
60
61    # only used by simple network
62    bandwidth_factor = 16
63