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