# Copyright (c) 2008 Princeton University
# Copyright (c) 2009 Advanced Micro Devices, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Authors: Steve Reinhardt
#          Brad Beckmann

from m5.params import *
from m5.proxy import *
from ClockedObject import ClockedObject
from BasicLink import BasicIntLink, BasicExtLink

class NetworkLink_d(ClockedObject):
    type = 'NetworkLink_d'
    cxx_header = "mem/ruby/network/garnet/fixed-pipeline/NetworkLink_d.hh"
    link_id = Param.Int(Parent.link_id, "link id")
    link_latency = Param.Cycles(Parent.latency, "link latency")
    vcs_per_vnet = Param.Int(Parent.vcs_per_vnet,
                              "virtual channels per virtual network")
    virt_nets = Param.Int(Parent.number_of_virtual_networks,
                          "number of virtual networks")

class CreditLink_d(NetworkLink_d):
    type = 'CreditLink_d'
    cxx_header = "mem/ruby/network/garnet/fixed-pipeline/CreditLink_d.hh"

# Interior fixed pipeline links between routers
class GarnetIntLink_d(BasicIntLink):
    type = 'GarnetIntLink_d'
    cxx_header = "mem/ruby/network/garnet/fixed-pipeline/GarnetLink_d.hh"
    # The detailed fixed pipeline bi-directional link include two main
    # forward links and two backward flow-control links, one per direction
    _nls = []
    # In uni-directional link
    _nls.append(NetworkLink_d());
    # Out uni-directional link
    _nls.append(NetworkLink_d());
    network_links = VectorParam.NetworkLink_d(_nls, "forward links")

    _cls = []
    # In uni-directional link
    _cls.append(CreditLink_d());
    # Out uni-directional link
    _cls.append(CreditLink_d());
    credit_links = VectorParam.CreditLink_d(_cls,
                                            "backward flow-control links")

# Exterior fixed pipeline links between a router and a controller
class GarnetExtLink_d(BasicExtLink):
    type = 'GarnetExtLink_d'
    cxx_header = "mem/ruby/network/garnet/fixed-pipeline/GarnetLink_d.hh"
    # The detailed fixed pipeline bi-directional link include two main
    # forward links and two backward flow-control links, one per direction
    _nls = []
    # In uni-directional link
    _nls.append(NetworkLink_d());
    # Out uni-directional link
    _nls.append(NetworkLink_d());
    network_links = VectorParam.NetworkLink_d(_nls, "forward links")

    _cls = []
    # In uni-directional link
    _cls.append(CreditLink_d());
    # Out uni-directional link
    _cls.append(CreditLink_d());
    credit_links = VectorParam.CreditLink_d(_cls,
                                            "backward flow-control links")