GarnetLink.py revision 11666:10d59d546ea2 
1# Copyright (c) 2008 Princeton University
2# Copyright (c) 2009 Advanced Micro Devices, Inc.
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions are
7# met: redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer;
9# redistributions in binary form must reproduce the above copyright
10# notice, this list of conditions and the following disclaimer in the
11# documentation and/or other materials provided with the distribution;
12# neither the name of the copyright holders nor the names of its
13# contributors may be used to endorse or promote products derived from
14# this software without specific prior written permission.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27#
28# Authors: Steve Reinhardt
29#          Brad Beckmann
30
31from m5.params import *
32from m5.proxy import *
33from ClockedObject import ClockedObject
34from BasicLink import BasicIntLink, BasicExtLink
35
36class NetworkLink(ClockedObject):
37    type = 'NetworkLink'
38    cxx_header = "mem/ruby/network/garnet2.0/NetworkLink.hh"
39    link_id = Param.Int(Parent.link_id, "link id")
40    link_latency = Param.Cycles(Parent.latency, "link latency")
41    vcs_per_vnet = Param.Int(Parent.vcs_per_vnet,
42                              "virtual channels per virtual network")
43    virt_nets = Param.Int(Parent.number_of_virtual_networks,
44                          "number of virtual networks")
45
46class CreditLink(NetworkLink):
47    type = 'CreditLink'
48    cxx_header = "mem/ruby/network/garnet2.0/CreditLink.hh"
49
50# Interior fixed pipeline links between routers
51class GarnetIntLink(BasicIntLink):
52    type = 'GarnetIntLink'
53    cxx_header = "mem/ruby/network/garnet2.0/GarnetLink.hh"
54    # The internal link includes one forward link (for flit)
55    # and one backward flow-control link (for credit)
56    network_link = Param.NetworkLink(NetworkLink(), "forward link")
57    credit_link  = Param.CreditLink(CreditLink(), "backward flow-control link")
58
59# Exterior fixed pipeline links between a router and a controller
60class GarnetExtLink(BasicExtLink):
61    type = 'GarnetExtLink'
62    cxx_header = "mem/ruby/network/garnet2.0/GarnetLink.hh"
63    # The external link is bi-directional.
64    # It includes two forward links (for flits)
65    # and two backward flow-control links (for credits),
66    # one per direction
67    _nls = []
68    # In uni-directional link
69    _nls.append(NetworkLink());
70    # Out uni-directional link
71    _nls.append(NetworkLink());
72    network_links = VectorParam.NetworkLink(_nls, "forward links")
73
74    _cls = []
75    # In uni-directional link
76    _cls.append(CreditLink());
77    # Out uni-directional link
78    _cls.append(CreditLink());
79    credit_links = VectorParam.CreditLink(_cls, "backward flow-control links")
80