io_device.cc revision 7607:e75d877c8557 
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 * Authors: Ali Saidi
29 *          Nathan Binkert
30 */
31
32#include "base/chunk_generator.hh"
33#include "base/trace.hh"
34#include "dev/io_device.hh"
35#include "sim/system.hh"
36
37
38PioPort::PioPort(PioDevice *dev, System *s, std::string pname)
39    : SimpleTimingPort(dev->name() + pname, dev), device(dev)
40{ }
41
42
43Tick
44PioPort::recvAtomic(PacketPtr pkt)
45{
46    return pkt->isRead() ? device->read(pkt) : device->write(pkt);
47}
48
49void
50PioPort::getDeviceAddressRanges(AddrRangeList &resp, bool &snoop)
51{
52    snoop = false;
53    device->addressRanges(resp);
54}
55
56
57PioDevice::PioDevice(const Params *p)
58    : MemObject(p), platform(p->platform), sys(p->system), pioPort(NULL)
59{}
60
61PioDevice::~PioDevice()
62{
63    if (pioPort)
64        delete pioPort;
65}
66
67void
68PioDevice::init()
69{
70    if (!pioPort)
71        panic("Pio port not connected to anything!");
72    pioPort->sendStatusChange(Port::RangeChange);
73}
74
75
76unsigned int
77PioDevice::drain(Event *de)
78{
79    unsigned int count;
80    count = pioPort->drain(de);
81    if (count)
82        changeState(Draining);
83    else
84        changeState(Drained);
85    return count;
86}
87
88BasicPioDevice::BasicPioDevice(const Params *p)
89    : PioDevice(p), pioAddr(p->pio_addr), pioSize(0),
90      pioDelay(p->pio_latency)
91{}
92
93void
94BasicPioDevice::addressRanges(AddrRangeList &range_list)
95{
96    assert(pioSize != 0);
97    range_list.clear();
98    range_list.push_back(RangeSize(pioAddr, pioSize));
99}
100
101
102DmaPort::DmaPort(MemObject *dev, System *s, Tick min_backoff, Tick max_backoff)
103    : Port(dev->name() + "-dmaport", dev), device(dev), sys(s),
104      pendingCount(0), actionInProgress(0), drainEvent(NULL),
105      backoffTime(0), minBackoffDelay(min_backoff),
106      maxBackoffDelay(max_backoff), inRetry(false), backoffEvent(this)
107{ }
108
109bool
110DmaPort::recvTiming(PacketPtr pkt)
111{
112    if (pkt->wasNacked()) {
113        DPRINTF(DMA, "Received nacked %s addr %#x\n",
114                pkt->cmdString(), pkt->getAddr());
115
116        if (backoffTime < minBackoffDelay)
117            backoffTime = minBackoffDelay;
118        else if (backoffTime < maxBackoffDelay)
119            backoffTime <<= 1;
120
121        reschedule(backoffEvent, curTick + backoffTime, true);
122
123        DPRINTF(DMA, "Backoff time set to %d ticks\n", backoffTime);
124
125        pkt->reinitNacked();
126        queueDma(pkt, true);
127    } else if (pkt->senderState) {
128        DmaReqState *state;
129        backoffTime >>= 2;
130
131        DPRINTF(DMA, "Received response %s addr %#x size %#x\n",
132                pkt->cmdString(), pkt->getAddr(), pkt->req->getSize());
133        state = dynamic_cast<DmaReqState*>(pkt->senderState);
134        pendingCount--;
135
136        assert(pendingCount >= 0);
137        assert(state);
138
139        state->numBytes += pkt->req->getSize();
140        assert(state->totBytes >= state->numBytes);
141        if (state->totBytes == state->numBytes) {
142            if (state->completionEvent) {
143                if (state->delay)
144                    schedule(state->completionEvent, curTick + state->delay);
145                else
146                    state->completionEvent->process();
147            }
148            delete state;
149        }
150        delete pkt->req;
151        delete pkt;
152
153        if (pendingCount == 0 && drainEvent) {
154            drainEvent->process();
155            drainEvent = NULL;
156        }
157    }  else {
158        panic("Got packet without sender state... huh?\n");
159    }
160
161    return true;
162}
163
164DmaDevice::DmaDevice(const Params *p)
165    : PioDevice(p), dmaPort(NULL)
166{ }
167
168
169unsigned int
170DmaDevice::drain(Event *de)
171{
172    unsigned int count;
173    count = pioPort->drain(de) + dmaPort->drain(de);
174    if (count)
175        changeState(Draining);
176    else
177        changeState(Drained);
178    return count;
179}
180
181unsigned int
182DmaPort::drain(Event *de)
183{
184    if (pendingCount == 0)
185        return 0;
186    drainEvent = de;
187    return 1;
188}
189
190
191void
192DmaPort::recvRetry()
193{
194    assert(transmitList.size());
195    bool result = true;
196    do {
197        PacketPtr pkt = transmitList.front();
198        DPRINTF(DMA, "Retry on %s addr %#x\n",
199                pkt->cmdString(), pkt->getAddr());
200        result = sendTiming(pkt);
201        if (result) {
202            DPRINTF(DMA, "-- Done\n");
203            transmitList.pop_front();
204            inRetry = false;
205        } else {
206            inRetry = true;
207            DPRINTF(DMA, "-- Failed, queued\n");
208        }
209    } while (!backoffTime &&  result && transmitList.size());
210
211    if (transmitList.size() && backoffTime && !inRetry) {
212        DPRINTF(DMA, "Scheduling backoff for %d\n", curTick+backoffTime);
213        if (!backoffEvent.scheduled())
214            schedule(backoffEvent, backoffTime + curTick);
215    }
216    DPRINTF(DMA, "TransmitList: %d, backoffTime: %d inRetry: %d es: %d\n",
217            transmitList.size(), backoffTime, inRetry,
218            backoffEvent.scheduled());
219}
220
221
222void
223DmaPort::dmaAction(Packet::Command cmd, Addr addr, int size, Event *event,
224                   uint8_t *data, Tick delay, Request::Flags flag)
225{
226    assert(device->getState() == SimObject::Running);
227
228    DmaReqState *reqState = new DmaReqState(event, this, size, delay);
229
230
231    DPRINTF(DMA, "Starting DMA for addr: %#x size: %d sched: %d\n", addr, size,
232            event ? event->scheduled() : -1 );
233    for (ChunkGenerator gen(addr, size, peerBlockSize());
234         !gen.done(); gen.next()) {
235            Request *req = new Request(gen.addr(), gen.size(), flag);
236            PacketPtr pkt = new Packet(req, cmd, Packet::Broadcast);
237
238            // Increment the data pointer on a write
239            if (data)
240                pkt->dataStatic(data + gen.complete());
241
242            pkt->senderState = reqState;
243
244            assert(pendingCount >= 0);
245            pendingCount++;
246            DPRINTF(DMA, "--Queuing DMA for addr: %#x size: %d\n", gen.addr(),
247                    gen.size());
248            queueDma(pkt);
249    }
250
251}
252
253void
254DmaPort::queueDma(PacketPtr pkt, bool front)
255{
256
257    if (front)
258        transmitList.push_front(pkt);
259    else
260        transmitList.push_back(pkt);
261    sendDma();
262}
263
264
265void
266DmaPort::sendDma()
267{
268    // some kind of selction between access methods
269    // more work is going to have to be done to make
270    // switching actually work
271    assert(transmitList.size());
272    PacketPtr pkt = transmitList.front();
273
274    Enums::MemoryMode state = sys->getMemoryMode();
275    if (state == Enums::timing) {
276        if (backoffEvent.scheduled() || inRetry) {
277            DPRINTF(DMA, "Can't send immediately, waiting for retry or backoff timer\n");
278            return;
279        }
280
281        DPRINTF(DMA, "Attempting to send %s addr %#x\n",
282                pkt->cmdString(), pkt->getAddr());
283
284        bool result;
285        do {
286            result = sendTiming(pkt);
287            if (result) {
288                transmitList.pop_front();
289                DPRINTF(DMA, "-- Done\n");
290            } else {
291                inRetry = true;
292                DPRINTF(DMA, "-- Failed: queued\n");
293            }
294        } while (result && !backoffTime && transmitList.size());
295
296        if (transmitList.size() && backoffTime && !inRetry &&
297                !backoffEvent.scheduled()) {
298            DPRINTF(DMA, "-- Scheduling backoff timer for %d\n",
299                    backoffTime+curTick);
300            schedule(backoffEvent, backoffTime + curTick);
301        }
302    } else if (state == Enums::atomic) {
303        transmitList.pop_front();
304
305        Tick lat;
306        DPRINTF(DMA, "--Sending  DMA for addr: %#x size: %d\n",
307                pkt->req->getPaddr(), pkt->req->getSize());
308        lat = sendAtomic(pkt);
309        assert(pkt->senderState);
310        DmaReqState *state = dynamic_cast<DmaReqState*>(pkt->senderState);
311        assert(state);
312        state->numBytes += pkt->req->getSize();
313
314        DPRINTF(DMA, "--Received response for  DMA for addr: %#x size: %d nb: %d, tot: %d sched %d\n",
315                pkt->req->getPaddr(), pkt->req->getSize(), state->numBytes,
316                state->totBytes,
317                state->completionEvent ? state->completionEvent->scheduled() : 0 );
318
319        if (state->totBytes == state->numBytes) {
320            if (state->completionEvent) {
321                assert(!state->completionEvent->scheduled());
322                schedule(state->completionEvent, curTick + lat + state->delay);
323            }
324            delete state;
325            delete pkt->req;
326        }
327        pendingCount--;
328        assert(pendingCount >= 0);
329        delete pkt;
330
331        if (pendingCount == 0 && drainEvent) {
332            drainEvent->process();
333            drainEvent = NULL;
334        }
335
336   } else
337       panic("Unknown memory command state.");
338}
339
340DmaDevice::~DmaDevice()
341{
342    if (dmaPort)
343        delete dmaPort;
344}
345