2 * Copyright (c) 2011-2012 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 bus.
51 #ifndef __MEM_NONCOHERENT_BUS_HH__
52 #define __MEM_NONCOHERENT_BUS_HH__
55 #include "params/NoncoherentBus.hh"
58 * A non-coherent bus connects a number of non-snooping masters and
59 * slaves, and routes the request and response packets based on the
60 * address. The request packets issued by the master connected to a
61 * non-coherent bus could still snoop in caches attached to a coherent
62 * bus, as is the case with the I/O bus and memory bus in most system
63 * configurations. No snoops will, however, reach any master on the
64 * non-coherent bus itself.
66 * The non-coherent bus can be used as a template for modelling PCI,
67 * PCIe, and non-coherent AMBA and OCP buses, and is typically used
70 class NoncoherentBus : public BaseBus
76 * Declare the two layers of this bus, one for requests and one
79 Layer<SlavePort> reqLayer;
80 Layer<MasterPort> respLayer;
83 * Declaration of the non-coherent bus slave port type, one will
84 * be instantiated for each of the master ports connecting to the
87 class NoncoherentBusSlavePort : public SlavePort
91 /** A reference to the bus to which this port belongs. */
96 NoncoherentBusSlavePort(const std::string &_name,
97 NoncoherentBus &_bus, PortID _id)
98 : SlavePort(_name, &_bus, _id), bus(_bus)
104 * When receiving a timing request, pass it to the bus.
106 virtual bool recvTimingReq(PacketPtr pkt)
107 { return bus.recvTimingReq(pkt, id); }
110 * When receiving an atomic request, pass it to the bus.
112 virtual Tick recvAtomic(PacketPtr pkt)
113 { return bus.recvAtomic(pkt, id); }
116 * When receiving a functional request, pass it to the bus.
118 virtual void recvFunctional(PacketPtr pkt)
119 { bus.recvFunctional(pkt, id); }
122 * When receiving a retry, pass it to the bus.
124 virtual void recvRetry()
125 { panic("Bus slave ports always succeed and should never retry.\n"); }
128 * Return the union of all adress ranges seen by this bus.
130 virtual AddrRangeList getAddrRanges() const
131 { return bus.getAddrRanges(); }
134 * Get the maximum block size as seen by the bus.
136 virtual unsigned deviceBlockSize() const
137 { return bus.deviceBlockSize(); }
142 * Declaration of the bus master port type, one will be
143 * instantiated for each of the slave ports connecting to the
146 class NoncoherentBusMasterPort : public MasterPort
150 /** A reference to the bus to which this port belongs. */
155 NoncoherentBusMasterPort(const std::string &_name,
156 NoncoherentBus &_bus, PortID _id)
157 : MasterPort(_name, &_bus, _id), bus(_bus)
163 * When receiving a timing response, pass it to the bus.
165 virtual bool recvTimingResp(PacketPtr pkt)
166 { return bus.recvTimingResp(pkt, id); }
168 /** When reciving a range change from the peer port (at id),
169 pass it to the bus. */
170 virtual void recvRangeChange()
171 { bus.recvRangeChange(id); }
173 /** When reciving a retry from the peer port (at id),
174 pass it to the bus. */
175 virtual void recvRetry()
179 * Get the maximum block size as seen by the bus.
181 virtual unsigned deviceBlockSize() const
182 { return bus.deviceBlockSize(); }
186 /** Function called by the port when the bus is recieving a Timing
188 virtual bool recvTimingReq(PacketPtr pkt, PortID slave_port_id);
190 /** Function called by the port when the bus is recieving a Timing
192 virtual bool recvTimingResp(PacketPtr pkt, PortID master_port_id);
194 /** Timing function called by port when it is once again able to process
198 /** Function called by the port when the bus is recieving a Atomic
200 Tick recvAtomic(PacketPtr pkt, PortID slave_port_id);
202 /** Function called by the port when the bus is recieving a Functional
204 void recvFunctional(PacketPtr pkt, PortID slave_port_id);
208 NoncoherentBus(const NoncoherentBusParams *p);
210 unsigned int drain(DrainManager *dm);
214 #endif //__MEM_NONCOHERENT_BUS_HH__