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 Decleration. 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__
46 #include "base/misc.hh"
47 #include "base/range.hh"
48 #include "mem/packet.hh"
49 #include "mem/request.hh"
51 /** This typedef is used to clean up the parameter list of
52 * getDeviceAddressRanges() and getPeerAddressRanges(). It's declared
53 * outside the Port object since it's also used by some mem objects.
54 * Eventually we should move this typedef to wherever Addr is
58 typedef std::list<Range<Addr> > AddrRangeList;
59 typedef std::list<Range<Addr> >::iterator AddrRangeIter;
62 * Ports are used to interface memory objects to
63 * each other. They will always come in pairs, and we refer to the other
64 * port object as the peer. These are used to make the design more
65 * modular so that a specific interface between every type of objcet doesn't
68 * Recv accesor functions are being called from the peer interface.
69 * Send accessor functions are being called from the device the port is
70 * associated with, and it will call the peer recv. accessor function.
76 /** Descriptive name (for DPRINTF output) */
77 const std::string portName;
79 /** A pointer to the peer port. Ports always come in pairs, that way they
80 can use a standardized interface to communicate between different
89 * @param _name Port name for DPRINTF output. Should include name
90 * of memory system object to which the port belongs.
92 Port(const std::string &_name)
93 : portName(_name), peer(NULL)
96 /** Return port name (for DPRINTF). */
97 const std::string &name() const { return portName; }
101 // mey be better to use subclasses & RTTI?
102 /** Holds the ports status. Currently just that a range recomputation needs
108 /** Function to set the pointer for the peer port.
109 @todo should be called by the configuration stuff (python).
111 void setPeer(Port *port);
113 /** Function to set the pointer for the peer port.
114 @todo should be called by the configuration stuff (python).
116 Port *getPeer() { return peer; }
120 /** These functions are protected because they should only be
121 * called by a peer port, never directly by any outside object. */
123 /** Called to recive a timing call from the peer port. */
124 virtual bool recvTiming(Packet *pkt) = 0;
126 /** Called to recive a atomic call from the peer port. */
127 virtual Tick recvAtomic(Packet *pkt) = 0;
129 /** Called to recive a functional call from the peer port. */
130 virtual void recvFunctional(Packet *pkt) = 0;
132 /** Called to recieve a status change from the peer port. */
133 virtual void recvStatusChange(Status status) = 0;
135 /** Called by a peer port if the send was unsuccesful, and had to
136 wait. This shouldn't be valid for response paths (IO Devices).
137 so it is set to panic if it isn't already defined.
139 virtual void recvRetry() { panic("??"); }
141 /** Called by a peer port in order to determine the block size of the
142 device connected to this port. It sometimes doesn't make sense for
143 this function to be called, a DMA interface doesn't really have a
144 block size, so it is defaulted to a panic.
146 virtual int deviceBlockSize() { panic("??"); }
148 /** The peer port is requesting us to reply with a list of the ranges we
150 @param resp is a list of ranges responded to
151 @param snoop is a list of ranges snooped
153 virtual void getDeviceAddressRanges(AddrRangeList &resp,
154 AddrRangeList &snoop)
159 /** Function called by associated memory device (cache, memory, iodevice)
160 in order to send a timing request to the port. Simply calls the peer
161 port receive function.
162 @return This function returns if the send was succesful in it's
163 recieve. If it was a failure, then the port will wait for a recvRetry
164 at which point it can possibly issue a successful sendTiming. This is used in
165 case a cache has a higher priority request come in while waiting for
166 the bus to arbitrate.
168 bool sendTiming(Packet *pkt) { return peer->recvTiming(pkt); }
170 /** Function called by the associated device to send an atomic
171 * access, an access in which the data is moved and the state is
172 * updated in one cycle, without interleaving with other memory
173 * accesses. Returns estimated latency of access.
175 Tick sendAtomic(Packet *pkt)
176 { return peer->recvAtomic(pkt); }
178 /** Function called by the associated device to send a functional access,
179 an access in which the data is instantly updated everywhere in the
180 memory system, without affecting the current state of any block or
183 void sendFunctional(Packet *pkt)
184 { return peer->recvFunctional(pkt); }
186 /** Called by the associated device to send a status change to the device
187 connected to the peer interface.
189 void sendStatusChange(Status status) {peer->recvStatusChange(status); }
191 /** When a timing access doesn't return a success, some time later the
194 void sendRetry() { return peer->recvRetry(); }
196 /** Called by the associated device if it wishes to find out the blocksize
197 of the device on attached to the peer port.
199 int peerBlockSize() { return peer->deviceBlockSize(); }
201 /** Called by the associated device if it wishes to find out the address
202 ranges connected to the peer ports devices.
204 void getPeerAddressRanges(AddrRangeList &resp, AddrRangeList &snoop)
205 { peer->getDeviceAddressRanges(resp, snoop); }
207 /** This function is a wrapper around sendFunctional()
208 that breaks a larger, arbitrarily aligned access into
209 appropriate chunks. The default implementation can use
210 getBlockSize() to determine the block size and go from there.
212 virtual void readBlob(Addr addr, uint8_t *p, int size);
214 /** This function is a wrapper around sendFunctional()
215 that breaks a larger, arbitrarily aligned access into
216 appropriate chunks. The default implementation can use
217 getBlockSize() to determine the block size and go from there.
219 virtual void writeBlob(Addr addr, uint8_t *p, int size);
221 /** Fill size bytes starting at addr with byte value val. This
222 should not need to be virtual, since it can be implemented in
223 terms of writeBlob(). However, it shouldn't be
224 performance-critical either, so it could be if we wanted to.
226 virtual void memsetBlob(Addr addr, uint8_t val, int size);
230 /** Internal helper function for read/writeBlob().
232 void blobHelper(Addr addr, uint8_t *p, int size, Packet::Command cmd);
235 /** A simple functional port that is only meant for one way communication to
236 * physical memory. It is only meant to be used to load data into memory before
237 * the simulation begins.
240 class FunctionalPort : public Port
243 FunctionalPort(const std::string &_name)
247 virtual bool recvTiming(Packet *pkt) { panic("FuncPort is UniDir"); }
248 virtual Tick recvAtomic(Packet *pkt) { panic("FuncPort is UniDir"); }
249 virtual void recvFunctional(Packet *pkt) { panic("FuncPort is UniDir"); }
250 virtual void recvStatusChange(Status status) {}
252 /** a write function that also does an endian conversion. */
253 template <typename T>
254 inline void writeHtoG(Addr addr, T d);
256 /** a read function that also does an endian conversion. */
257 template <typename T>
258 inline T readGtoH(Addr addr);
260 template <typename T>
261 inline void write(Addr addr, T d)
263 writeBlob(addr, (uint8_t*)&d, sizeof(T));
266 template <typename T>
267 inline T read(Addr addr)
270 readBlob(addr, (uint8_t*)&d, sizeof(T));
275 #endif //__MEM_PORT_HH__