1/*
2 * Copyright (c) 2008 Mark D. Hill and David A. Wood
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#ifndef __MEM_RUBY_SYSTEM_DMASEQUENCER_HH__
30#define __MEM_RUBY_SYSTEM_DMASEQUENCER_HH__
31
32#include <ostream>
33#include <memory>
34
35#include "mem/protocol/DMASequencerRequestType.hh"
36#include "mem/ruby/common/DataBlock.hh"
37#include "mem/ruby/system/RubyPort.hh"
38#include "params/DMASequencer.hh"
39
40struct DMARequest
41{
42 uint64_t start_paddr;
43 int len;
44 bool write;
45 int bytes_completed;
46 int bytes_issued;
47 uint8_t *data;
48 PacketPtr pkt;
49};
50
51class DMASequencer : public RubyPort
52{
53 public:
54 typedef DMASequencerParams Params;
55 DMASequencer(const Params *);
56 void init();
57 /* external interface */
58 RequestStatus makeRequest(PacketPtr pkt);
59 bool busy() { return m_is_busy;}
60 int outstandingCount() const { return (m_is_busy ? 1 : 0); }
61 bool isDeadlockEventScheduled() const { return false; }
62 void descheduleDeadlockEvent() {}
63
64 /* SLICC callback */
65 void dataCallback(const DataBlock & dblk);
66 void ackCallback();
67
68 void recordRequestType(DMASequencerRequestType requestType);
69
70 private:
71 void issueNext();
72
73 private:
74 bool m_is_busy;
75 uint64_t m_data_block_mask;
76 DMARequest active_request;
77};
78
79#endif // __MEM_RUBY_SYSTEM_DMASEQUENCER_HH__