2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Authors: Ron Dreslinski
33 * Port Object Declaration. Ports are used to interface memory objects to
34 * each other. They will always come in pairs, and we refer to the other
35 * port object as the peer. These are used to make the design more
36 * modular so that a specific interface between every type of objcet doesn't
40 #ifndef __MEM_PORT_HH__
41 #define __MEM_PORT_HH__
45 #include "base/misc.hh"
46 #include "base/range.hh"
47 #include "base/types.hh"
48 #include "mem/packet.hh"
49 #include "mem/request.hh"
50 #include "sim/eventq.hh"
52 /** This typedef is used to clean up the parameter list of
53 * getDeviceAddressRanges() and getPeerAddressRanges(). It's declared
54 * outside the Port object since it's also used by some mem objects.
55 * Eventually we should move this typedef to wherever Addr is
59 typedef std::list<Range<Addr> > AddrRangeList;
60 typedef std::list<Range<Addr> >::iterator AddrRangeIter;
66 * Ports are used to interface memory objects to
67 * each other. They will always come in pairs, and we refer to the other
68 * port object as the peer. These are used to make the design more
69 * modular so that a specific interface between every type of objcet doesn't
72 * Recv accesor functions are being called from the peer interface.
73 * Send accessor functions are being called from the device the port is
74 * associated with, and it will call the peer recv. accessor function.
76 class Port : public EventManager
79 /** Descriptive name (for DPRINTF output) */
80 mutable std::string portName;
82 /** A pointer to the peer port. Ports always come in pairs, that way they
83 can use a standardized interface to communicate between different
87 /** A pointer to the MemObject that owns this port. This may not be set. */
94 * @param _name Port name for DPRINTF output. Should include name
95 * of memory system object to which the port belongs.
96 * @param _owner Pointer to the MemObject that owns this port.
97 * Will not necessarily be set.
99 Port(const std::string &_name, MemObject *_owner);
101 /** Return port name (for DPRINTF). */
102 const std::string &name() const { return portName; }
106 // mey be better to use subclasses & RTTI?
107 /** Holds the ports status. Currently just that a range recomputation needs
113 void setName(const std::string &name)
116 /** Function to set the pointer for the peer port. */
117 virtual void setPeer(Port *port);
119 /** Function to get the pointer to the peer port. */
120 Port *getPeer() { return peer; }
122 /** Function to set the owner of this port. */
123 void setOwner(MemObject *_owner);
125 /** Function to return the owner of this port. */
126 MemObject *getOwner() { return owner; }
128 /** Inform the peer port to delete itself and notify it's owner about it's
132 virtual bool isDefaultPort() const { return false; }
134 bool isConnected() { return peer && !peer->isDefaultPort(); }
138 /** These functions are protected because they should only be
139 * called by a peer port, never directly by any outside object. */
141 /** Called to recive a timing call from the peer port. */
142 virtual bool recvTiming(PacketPtr pkt) = 0;
144 /** Called to recive a atomic call from the peer port. */
145 virtual Tick recvAtomic(PacketPtr pkt) = 0;
147 /** Called to recive a functional call from the peer port. */
148 virtual void recvFunctional(PacketPtr pkt) = 0;
150 /** Called to recieve a status change from the peer port. */
151 virtual void recvStatusChange(Status status) = 0;
153 /** Called by a peer port if the send was unsuccesful, and had to
154 wait. This shouldn't be valid for response paths (IO Devices).
155 so it is set to panic if it isn't already defined.
157 virtual void recvRetry() { panic("??"); }
159 /** Called by a peer port in order to determine the block size of the
160 device connected to this port. It sometimes doesn't make sense for
161 this function to be called, so it just returns 0. Anytthing that is
162 concerned with the size should just ignore that.
164 virtual unsigned deviceBlockSize() const { return 0; }
166 /** The peer port is requesting us to reply with a list of the ranges we
168 @param resp is a list of ranges responded to
169 @param snoop is a list of ranges snooped
171 virtual void getDeviceAddressRanges(AddrRangeList &resp,
177 /** Function called by associated memory device (cache, memory, iodevice)
178 in order to send a timing request to the port. Simply calls the peer
179 port receive function.
180 @return This function returns if the send was succesful in it's
181 recieve. If it was a failure, then the port will wait for a recvRetry
182 at which point it can possibly issue a successful sendTiming. This is used in
183 case a cache has a higher priority request come in while waiting for
184 the bus to arbitrate.
186 bool sendTiming(PacketPtr pkt) { return peer->recvTiming(pkt); }
188 /** Function called by the associated device to send an atomic
189 * access, an access in which the data is moved and the state is
190 * updated in one cycle, without interleaving with other memory
191 * accesses. Returns estimated latency of access.
193 Tick sendAtomic(PacketPtr pkt)
194 { return peer->recvAtomic(pkt); }
196 /** Function called by the associated device to send a functional access,
197 an access in which the data is instantly updated everywhere in the
198 memory system, without affecting the current state of any block or
201 void sendFunctional(PacketPtr pkt)
202 { return peer->recvFunctional(pkt); }
204 /** Called by the associated device to send a status change to the device
205 connected to the peer interface.
207 void sendStatusChange(Status status) {peer->recvStatusChange(status); }
209 /** When a timing access doesn't return a success, some time later the
212 void sendRetry() { return peer->recvRetry(); }
214 /** Called by the associated device if it wishes to find out the blocksize
215 of the device on attached to the peer port.
217 unsigned peerBlockSize() const { return peer->deviceBlockSize(); }
219 /** Called by the associated device if it wishes to find out the address
220 ranges connected to the peer ports devices.
222 void getPeerAddressRanges(AddrRangeList &resp, bool &snoop)
223 { peer->getDeviceAddressRanges(resp, snoop); }
225 /** This function is a wrapper around sendFunctional()
226 that breaks a larger, arbitrarily aligned access into
227 appropriate chunks. The default implementation can use
228 getBlockSize() to determine the block size and go from there.
230 virtual void readBlob(Addr addr, uint8_t *p, int size);
232 /** This function is a wrapper around sendFunctional()
233 that breaks a larger, arbitrarily aligned access into
234 appropriate chunks. The default implementation can use
235 getBlockSize() to determine the block size and go from there.
237 virtual void writeBlob(Addr addr, uint8_t *p, int size);
239 /** Fill size bytes starting at addr with byte value val. This
240 should not need to be virtual, since it can be implemented in
241 terms of writeBlob(). However, it shouldn't be
242 performance-critical either, so it could be if we wanted to.
244 virtual void memsetBlob(Addr addr, uint8_t val, int size);
246 /** Inject a PrintReq for the given address to print the state of
247 * that address throughout the memory system. For debugging.
249 void printAddr(Addr a);
253 /** Internal helper function for read/writeBlob().
255 void blobHelper(Addr addr, uint8_t *p, int size, MemCmd cmd);
258 /** A simple functional port that is only meant for one way communication to
259 * physical memory. It is only meant to be used to load data into memory before
260 * the simulation begins.
263 class FunctionalPort : public Port
266 FunctionalPort(const std::string &_name, MemObject *_owner = NULL)
267 : Port(_name, _owner)
271 virtual bool recvTiming(PacketPtr pkt) { panic("FuncPort is UniDir");
273 virtual Tick recvAtomic(PacketPtr pkt) { panic("FuncPort is UniDir");
275 virtual void recvFunctional(PacketPtr pkt) { panic("FuncPort is UniDir"); }
276 virtual void recvStatusChange(Status status) {}
279 /** a write function that also does an endian conversion. */
280 template <typename T>
281 inline void writeHtoG(Addr addr, T d);
283 /** a read function that also does an endian conversion. */
284 template <typename T>
285 inline T readGtoH(Addr addr);
287 template <typename T>
288 inline void write(Addr addr, T d)
290 writeBlob(addr, (uint8_t*)&d, sizeof(T));
293 template <typename T>
294 inline T read(Addr addr)
297 readBlob(addr, (uint8_t*)&d, sizeof(T));
302 #endif //__MEM_PORT_HH__