2 * Copyright (c) 2011-2014 ARM Limited
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.
14 * Copyright (c) 2002-2005 The Regents of The University of Michigan
15 * All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 * Authors: Ron Dreslinski
48 * Declaration of a non-coherent crossbar.
51 #ifndef __MEM_NONCOHERENT_XBAR_HH__
52 #define __MEM_NONCOHERENT_XBAR_HH__
54 #include "mem/xbar.hh"
55 #include "params/NoncoherentXBar.hh"
58 * A non-coherent crossbar connects a number of non-snooping masters
59 * and slaves, and routes the request and response packets based on
60 * the address. The request packets issued by the master connected to
61 * a non-coherent crossbar could still snoop in caches attached to a
62 * coherent crossbar, as is the case with the I/O bus and memory bus
63 * in most system configurations. No snoops will, however, reach any
64 * master on the non-coherent crossbar itself.
66 * The non-coherent crossbar can be used as a template for modelling
67 * PCIe, and non-coherent AMBA and OCP buses, and is typically used
70 class NoncoherentXBar : public BaseXBar
76 * Declare the layers of this crossbar, one vector for requests
77 * and one for responses.
79 typedef Layer<SlavePort,MasterPort> ReqLayer;
80 typedef Layer<MasterPort,SlavePort> RespLayer;
81 std::vector<ReqLayer*> reqLayers;
82 std::vector<RespLayer*> respLayers;
85 * Declaration of the non-coherent crossbar slave port type, one
86 * will be instantiated for each of the master ports connecting to
89 class NoncoherentXBarSlavePort : public SlavePort
93 /** A reference to the crossbar to which this port belongs. */
94 NoncoherentXBar &xbar;
98 NoncoherentXBarSlavePort(const std::string &_name,
99 NoncoherentXBar &_xbar, PortID _id)
100 : SlavePort(_name, &_xbar, _id), xbar(_xbar)
106 * When receiving a timing request, pass it to the crossbar.
108 virtual bool recvTimingReq(PacketPtr pkt)
109 { return xbar.recvTimingReq(pkt, id); }
112 * When receiving an atomic request, pass it to the crossbar.
114 virtual Tick recvAtomic(PacketPtr pkt)
115 { return xbar.recvAtomic(pkt, id); }
118 * When receiving a functional request, pass it to the crossbar.
120 virtual void recvFunctional(PacketPtr pkt)
121 { xbar.recvFunctional(pkt, id); }
124 * When receiving a retry, pass it to the crossbar.
126 virtual void recvRetry()
127 { panic("Crossbar slave ports should never retry.\n"); }
130 * Return the union of all adress ranges seen by this crossbar.
132 virtual AddrRangeList getAddrRanges() const
133 { return xbar.getAddrRanges(); }
138 * Declaration of the crossbar master port type, one will be
139 * instantiated for each of the slave ports connecting to the
142 class NoncoherentXBarMasterPort : public MasterPort
146 /** A reference to the crossbar to which this port belongs. */
147 NoncoherentXBar &xbar;
151 NoncoherentXBarMasterPort(const std::string &_name,
152 NoncoherentXBar &_xbar, PortID _id)
153 : MasterPort(_name, &_xbar, _id), xbar(_xbar)
159 * When receiving a timing response, pass it to the crossbar.
161 virtual bool recvTimingResp(PacketPtr pkt)
162 { return xbar.recvTimingResp(pkt, id); }
164 /** When reciving a range change from the peer port (at id),
165 pass it to the crossbar. */
166 virtual void recvRangeChange()
167 { xbar.recvRangeChange(id); }
169 /** When reciving a retry from the peer port (at id),
170 pass it to the crossbar. */
171 virtual void recvRetry()
172 { xbar.recvRetry(id); }
176 /** Function called by the port when the crossbar is recieving a Timing
178 virtual bool recvTimingReq(PacketPtr pkt, PortID slave_port_id);
180 /** Function called by the port when the crossbar is recieving a Timing
182 virtual bool recvTimingResp(PacketPtr pkt, PortID master_port_id);
184 /** Timing function called by port when it is once again able to process
186 void recvRetry(PortID master_port_id);
188 /** Function called by the port when the crossbar is recieving a Atomic
190 Tick recvAtomic(PacketPtr pkt, PortID slave_port_id);
192 /** Function called by the port when the crossbar is recieving a Functional
194 void recvFunctional(PacketPtr pkt, PortID slave_port_id);
198 NoncoherentXBar(const NoncoherentXBarParams *p);
200 virtual ~NoncoherentXBar();
202 unsigned int drain(DrainManager *dm);
207 virtual void regStats();
208 Stats::Scalar totPktSize;
211 #endif //__MEM_NONCOHERENT_XBAR_HH__