2 * Copyright (c) 2004-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.
32 #ifndef __DEV_IO_DEVICE_HH__
33 #define __DEV_IO_DEVICE_HH__
35 #include "base/fast_alloc.hh"
36 #include "mem/mem_object.hh"
37 #include "mem/packet.hh"
38 #include "mem/tport.hh"
39 #include "params/BasicPioDevice.hh"
40 #include "params/DmaDevice.hh"
41 #include "params/PioDevice.hh"
42 #include "sim/sim_object.hh"
51 * The PioPort class is a programmed i/o port that all devices that are
52 * sensitive to an address range use. The port takes all the memory
53 * access types and roles them into one read() and write() call that the device
54 * must respond to. The device must also provide the addressRanges() function
55 * with which it returns the address ranges it is interested in.
57 class PioPort : public SimpleTimingPort
60 /** The device that this port serves. */
63 virtual Tick recvAtomic(PacketPtr pkt);
65 virtual void getDeviceAddressRanges(AddrRangeList &resp,
70 PioPort(PioDevice *dev, System *s, std::string pname = "-pioport");
74 class DmaPort : public Port
77 struct DmaReqState : public Packet::SenderState, public FastAlloc
79 /** Event to call on the device when this transaction (all packets)
81 Event *completionEvent;
83 /** Where we came from for some sanity checking. */
86 /** Total number of bytes that this transaction involves. */
89 /** Number of bytes that have been acked for this transaction. */
92 /** Amount to delay completion of dma by */
95 DmaReqState(Event *ce, Port *p, Addr tb, Tick _delay)
96 : completionEvent(ce), outPort(p), totBytes(tb), numBytes(0),
102 std::list<PacketPtr> transmitList;
104 /** The system that device/port are in. This is used to select which mode
105 * we are currently operating in. */
108 /** Number of outstanding packets the dma port has. */
111 /** If a dmaAction is in progress. */
112 int actionInProgress;
114 /** If we need to drain, keep the drain event around until we're done
118 /** time to wait between sending another packet, increases as NACKs are
119 * recived, decreases as responses are recived. */
122 /** If the port is currently waiting for a retry before it can send whatever
123 * it is that it's sending. */
126 virtual bool recvTiming(PacketPtr pkt);
127 virtual Tick recvAtomic(PacketPtr pkt)
128 { panic("dma port shouldn't be used for pio access."); M5_DUMMY_RETURN }
129 virtual void recvFunctional(PacketPtr pkt)
130 { panic("dma port shouldn't be used for pio access."); }
132 virtual void recvStatusChange(Status status)
135 virtual void recvRetry() ;
137 virtual void getDeviceAddressRanges(AddrRangeList &resp,
139 { resp.clear(); snoop = false; }
141 void queueDma(PacketPtr pkt, bool front = false);
144 /** event to give us a kick every time we backoff time is reached. */
145 EventWrapper<DmaPort, &DmaPort::sendDma> backoffEvent;
148 DmaPort(DmaDevice *dev, System *s);
150 void dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
151 uint8_t *data, Tick delay);
153 bool dmaPending() { return pendingCount > 0; }
155 unsigned cacheBlockSize() const { return peerBlockSize(); }
156 unsigned int drain(Event *de);
160 * This device is the base class which all devices senstive to an address range
161 * inherit from. There are three pure virtual functions which all devices must
162 * implement addressRanges(), read(), and write(). The magic do choose which
163 * mode we are in, etc is handled by the PioPort so the device doesn't have to
166 class PioDevice : public MemObject
170 /** The platform we are in. This is used to decide what type of memory
171 * transaction we should perform. */
176 /** The pioPort that handles the requests for us and provides us requests
180 virtual void addressRanges(AddrRangeList &range_list) = 0;
182 /** Pure virtual function that the device must implement. Called
183 * when a read command is recieved by the port.
184 * @param pkt Packet describing this request
185 * @return number of ticks it took to complete
187 virtual Tick read(PacketPtr pkt) = 0;
189 /** Pure virtual function that the device must implement. Called when a
190 * write command is recieved by the port.
191 * @param pkt Packet describing this request
192 * @return number of ticks it took to complete
194 virtual Tick write(PacketPtr pkt) = 0;
197 typedef PioDeviceParams Params;
198 PioDevice(const Params *p);
199 virtual ~PioDevice();
204 return dynamic_cast<const Params *>(_params);
209 virtual unsigned int drain(Event *de);
211 virtual Port *getPort(const std::string &if_name, int idx = -1)
213 if (if_name == "pio") {
215 fatal("%s: pio port already connected to %s",
216 name(), pioPort->getPeer()->name());
217 pioPort = new PioPort(this, sys);
222 friend class PioPort;
226 class BasicPioDevice : public PioDevice
229 /** Address that the device listens to. */
232 /** Size that the device's address range. */
235 /** Delay that the device experinces on an access. */
239 typedef BasicPioDeviceParams Params;
240 BasicPioDevice(const Params *p);
245 return dynamic_cast<const Params *>(_params);
248 /** return the address ranges that this device responds to.
249 * @param range_list range list to populate with ranges
251 void addressRanges(AddrRangeList &range_list);
255 class DmaDevice : public PioDevice
259 Tick minBackoffDelay;
260 Tick maxBackoffDelay;
263 typedef DmaDeviceParams Params;
264 DmaDevice(const Params *p);
265 virtual ~DmaDevice();
270 return dynamic_cast<const Params *>(_params);
273 void dmaWrite(Addr addr, int size, Event *event, uint8_t *data, Tick delay = 0)
275 dmaPort->dmaAction(MemCmd::WriteReq, addr, size, event, data, delay);
278 void dmaRead(Addr addr, int size, Event *event, uint8_t *data, Tick delay = 0)
280 dmaPort->dmaAction(MemCmd::ReadReq, addr, size, event, data, delay);
283 bool dmaPending() { return dmaPort->dmaPending(); }
285 virtual unsigned int drain(Event *de);
287 unsigned cacheBlockSize() const { return dmaPort->cacheBlockSize(); }
289 virtual Port *getPort(const std::string &if_name, int idx = -1)
291 if (if_name == "pio") {
293 fatal("%s: pio port already connected to %s",
294 name(), pioPort->getPeer()->name());
295 pioPort = new PioPort(this, sys);
297 } else if (if_name == "dma") {
299 fatal("%s: dma port already connected to %s",
300 name(), dmaPort->getPeer()->name());
301 dmaPort = new DmaPort(this, sys);
307 friend class DmaPort;
311 #endif // __DEV_IO_DEVICE_HH__