1/*
2 * Copyright (c) 2008 Princeton University
3 * Copyright (c) 2016 Georgia Institute of Technology
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Niket Agarwal
30 *          Tushar Krishna
31 */
32
33
34#ifndef __MEM_RUBY_NETWORK_GARNET2_0_GARNETLINK_HH__
35#define __MEM_RUBY_NETWORK_GARNET2_0_GARNETLINK_HH__
36
37#include <iostream>
38#include <string>
39#include <vector>
40
41#include "mem/ruby/network/BasicLink.hh"
42#include "mem/ruby/network/garnet2.0/CreditLink.hh"
43#include "mem/ruby/network/garnet2.0/NetworkLink.hh"
44#include "params/GarnetExtLink.hh"
45#include "params/GarnetIntLink.hh"
46
47class GarnetIntLink : public BasicIntLink
48{
49  public:
50    typedef GarnetIntLinkParams Params;
51    GarnetIntLink(const Params *p);
52
53    void init();
54
55    void print(std::ostream& out) const;
56
57    friend class GarnetNetwork;
58
59  protected:
60    NetworkLink* m_network_link;
61    CreditLink* m_credit_link;
62};
63
64inline std::ostream&
65operator<<(std::ostream& out, const GarnetIntLink& obj)
66{
67    obj.print(out);
68    out << std::flush;
69    return out;
70}
71
72class GarnetExtLink : public BasicExtLink
73{
74  public:
75    typedef GarnetExtLinkParams Params;
76    GarnetExtLink(const Params *p);
77
78    void init();
79
80    void print(std::ostream& out) const;
81
82    friend class GarnetNetwork;
83
84  protected:
85    NetworkLink* m_network_links[2];
86    CreditLink* m_credit_links[2];
87};
88
89inline std::ostream&
90operator<<(std::ostream& out, const GarnetExtLink& obj)
91{
92    obj.print(out);
93    out << std::flush;
94    return out;
95}
96
97#endif //__MEM_RUBY_NETWORK_GARNET2_0_GARNETLINK_HH__
98