c644308b665a998a5b36363339905fd585bc080e
[gem5.git] / src / dev / io_device.cc
1 /*
2 * Copyright (c) 2006 The Regents of The University of Michigan
3 * All rights reserved.
4 *
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.
15 *
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.
27 */
28
29 #include "base/trace.hh"
30 #include "dev/io_device.hh"
31 #include "sim/builder.hh"
32
33
34 PioPort::PioPort(PioDevice *dev, Platform *p)
35 : Port(dev->name() + "-pioport"), device(dev), platform(p)
36 { }
37
38
39 Tick
40 PioPort::recvAtomic(Packet *pkt)
41 {
42 return device->recvAtomic(pkt);
43 }
44
45 void
46 PioPort::recvFunctional(Packet *pkt)
47 {
48 device->recvAtomic(pkt);
49 }
50
51 void
52 PioPort::getDeviceAddressRanges(AddrRangeList &resp, AddrRangeList &snoop)
53 {
54 snoop.clear();
55 device->addressRanges(resp);
56 }
57
58
59 void
60 PioPort::recvRetry()
61 {
62 Packet* pkt = transmitList.front();
63 if (Port::sendTiming(pkt)) {
64 transmitList.pop_front();
65 }
66 }
67
68
69 void
70 PioPort::SendEvent::process()
71 {
72 if (port->Port::sendTiming(packet))
73 return;
74
75 port->transmitList.push_back(packet);
76 }
77
78
79
80 bool
81 PioPort::recvTiming(Packet *pkt)
82 {
83 Tick latency = device->recvAtomic(pkt);
84 // turn packet around to go back to requester
85 pkt->makeTimingResponse();
86 sendTiming(pkt, latency);
87 return true;
88 }
89
90 PioDevice::~PioDevice()
91 {
92 if (pioPort)
93 delete pioPort;
94 }
95
96 void
97 PioDevice::init()
98 {
99 if (!pioPort)
100 panic("Pio port not connected to anything!");
101 pioPort->sendStatusChange(Port::RangeChange);
102 }
103
104 void
105 BasicPioDevice::addressRanges(AddrRangeList &range_list)
106 {
107 assert(pioSize != 0);
108 range_list.clear();
109 range_list.push_back(RangeSize(pioAddr, pioSize));
110 }
111
112
113 DmaPort::DmaPort(DmaDevice *dev, Platform *p)
114 : Port(dev->name() + "-dmaport"), device(dev), platform(p), pendingCount(0)
115 { }
116
117 bool
118 DmaPort::recvTiming(Packet *pkt)
119 {
120 if (pkt->senderState) {
121 DmaReqState *state;
122 DPRINTF(DMA, "Received response Packet %#x with senderState: %#x\n",
123 pkt, pkt->senderState);
124 state = dynamic_cast<DmaReqState*>(pkt->senderState);
125 assert(state);
126 state->completionEvent->process();
127 delete pkt->req;
128 delete pkt;
129 } else {
130 DPRINTF(DMA, "Received response Packet %#x with no senderState\n", pkt);
131 delete pkt->req;
132 delete pkt;
133 }
134
135 return true;
136 }
137
138 DmaDevice::DmaDevice(Params *p)
139 : PioDevice(p), dmaPort(NULL)
140 { }
141
142 void
143 DmaPort::recvRetry()
144 {
145 Packet* pkt = transmitList.front();
146 DPRINTF(DMA, "Retry on Packet %#x with senderState: %#x\n",
147 pkt, pkt->senderState);
148 if (sendTiming(pkt)) {
149 DPRINTF(DMA, "-- Done\n");
150 transmitList.pop_front();
151 pendingCount--;
152 assert(pendingCount >= 0);
153 } else {
154 DPRINTF(DMA, "-- Failed, queued\n");
155 }
156 }
157
158
159 void
160 DmaPort::dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
161 uint8_t *data)
162 {
163 assert(event);
164
165 int prevSize = 0;
166
167 for (ChunkGenerator gen(addr, size, peerBlockSize());
168 !gen.done(); gen.next()) {
169 Request *req = new Request(gen.addr(), gen.size(), 0);
170 Packet *pkt = new Packet(req, cmd, Packet::Broadcast);
171
172 // Increment the data pointer on a write
173 if (data)
174 pkt->dataStatic(data + prevSize);
175
176 prevSize += gen.size();
177
178 // Set the last bit of the dma as the final packet for this dma
179 // and set it's completion event.
180 if (prevSize == size) {
181 pkt->senderState = new DmaReqState(event, true);
182 }
183 assert(pendingCount >= 0);
184 pendingCount++;
185 sendDma(pkt);
186 }
187 }
188
189
190 void
191 DmaPort::sendDma(Packet *pkt)
192 {
193 // some kind of selction between access methods
194 // more work is going to have to be done to make
195 // switching actually work
196 /* MemState state = device->platform->system->memState;
197
198 if (state == Timing) { */
199 DPRINTF(DMA, "Attempting to send Packet %#x with senderState: %#x\n",
200 pkt, pkt->senderState);
201 if (!sendTiming(pkt)) {
202 transmitList.push_back(pkt);
203 DPRINTF(DMA, "-- Failed: queued\n");
204 } else {
205 DPRINTF(DMA, "-- Done\n");
206 pendingCount--;
207 assert(pendingCount >= 0);
208 }
209 /* } else if (state == Atomic) {
210 sendAtomic(pkt);
211 if (pkt->senderState) {
212 DmaReqState *state = dynamic_cast<DmaReqState*>(pkt->senderState);
213 assert(state);
214 state->completionEvent->schedule(curTick + (pkt->time - pkt->req->getTime()) +1);
215 }
216 pendingCount--;
217 assert(pendingCount >= 0);
218 delete pkt->req;
219 delete pkt;
220
221 } else if (state == Functional) {
222 sendFunctional(pkt);
223 // Is this correct???
224 completionEvent->schedule(pkt->req->responseTime - pkt->req->requestTime);
225 completionEvent == NULL;
226 } else
227 panic("Unknown memory command state.");
228 */
229 }
230
231 DmaDevice::~DmaDevice()
232 {
233 if (dmaPort)
234 delete dmaPort;
235 }
236
237