RubyPortProxy.hh revision 8706 
1/*
2 * Copyright (c) 2011 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Andreas Hansson
38 */
39
40/**
41 * @file
42 * RobyPortProxy for connecting system port to Ruby
43 *
44 * A trivial wrapper that allows the system port to connect to Ruby
45 * and use nothing but functional accesses.
46 */
47
48#ifndef __MEM_RUBY_SYSTEM_RUBYPORTPROXY_HH__
49#define __MEM_RUBY_SYSTEM_RUBYPORTPROXY_HH__
50
51#include "mem/ruby/system/RubyPort.hh"
52#include "params/RubyPortProxy.hh"
53
54class RubyPortProxy : public RubyPort
55{
56
57  public:
58
59    /**
60     * Create a new RubyPortProxy.
61     *
62     * @param p Parameters inherited from the RubyPort
63     */
64    RubyPortProxy(const RubyPortProxyParams* p);
65
66    /**
67     * Destruct a RubyPortProxy.
68     */
69    virtual ~RubyPortProxy();
70
71    /**
72     * Initialise a RubyPortProxy by doing nothing and avoid
73     * involving the super class.
74     */
75    void init();
76
77    /**
78     * Pure virtual member in the super class that we are forced to
79     * implement even if it is never used (since there are only
80     * functional accesses).
81     *
82     * @param pkt The packet to serve to Ruby
83     * @returns always a NULL status
84     */
85    RequestStatus makeRequest(PacketPtr pkt);
86
87    /**
88     * Pure virtual member in the super class that we are forced to
89     * implement even if it is never used (since there are only
90     * functional accesses).
91     *
92     * @returns always 0
93     */
94    int outstandingCount() const { return 0; }
95
96    /**
97     * Pure virtual member in the super class that we are forced to
98     * implement even if it is never used (since there are only
99     * functional accesses).
100     *
101     * @returns always false
102     */
103    bool isDeadlockEventScheduled() const { return false; }
104
105    /**
106     * Pure virtual member in the super class that we are forced to
107     * implement even if it is never used (since there are only
108     * functional accesses).
109     */
110    void descheduleDeadlockEvent() { }
111
112};
113
114#endif // __MEM_RUBY_SYSTEM_RUBYPORTPROXY_HH__
115