tport.hh revision 4490:f9d3db907eec 
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 */
30
31#ifndef __MEM_TPORT_HH__
32#define __MEM_TPORT_HH__
33
34/**
35 * @file
36 *
37 * Declaration of SimpleTimingPort.
38 */
39
40#include "mem/port.hh"
41#include "sim/eventq.hh"
42#include <list>
43#include <string>
44
45/**
46 * A simple port for interfacing objects that basically have only
47 * functional memory behavior (e.g. I/O devices) to the memory system.
48 * Both timing and functional accesses are implemented in terms of
49 * atomic accesses.  A derived port class thus only needs to provide
50 * recvAtomic() to support all memory access modes.
51 *
52 * The tricky part is handling recvTiming(), where the response must
53 * be scheduled separately via a later call to sendTiming().  This
54 * feature is handled by scheduling an internal event that calls
55 * sendTiming() after a delay, and optionally rescheduling the
56 * response if it is nacked.
57 */
58class SimpleTimingPort : public Port
59{
60  protected:
61    /** A deferred packet, buffered to transmit later. */
62    class DeferredPacket {
63      public:
64        Tick tick;      ///< The tick when the packet is ready to transmit
65        PacketPtr pkt;  ///< Pointer to the packet to transmit
66        DeferredPacket(Tick t, PacketPtr p)
67            : tick(t), pkt(p)
68        {}
69    };
70
71    typedef std::list<DeferredPacket> DeferredPacketList;
72    typedef std::list<DeferredPacket>::iterator DeferredPacketIterator;
73
74    /** A list of outgoing timing response packets that haven't been
75     * serviced yet. */
76    DeferredPacketList transmitList;
77
78    /** This function attempts to send deferred packets.  Scheduled to
79     * be called in the future via SendEvent. */
80    void processSendEvent();
81
82    /**
83     * This class is used to implemented sendTiming() with a delay. When
84     * a delay is requested a the event is scheduled if it isn't already.
85     * When the event time expires it attempts to send the packet.
86     * If it cannot, the packet sent when recvRetry() is called.
87     **/
88    typedef EventWrapper<SimpleTimingPort, &SimpleTimingPort::processSendEvent>
89            SendEvent;
90
91    Event *sendEvent;
92
93    /** If we need to drain, keep the drain event around until we're done
94     * here.*/
95    Event *drainEvent;
96
97    /** Check the list of buffered packets against the supplied
98     * functional request. */
99    void checkFunctional(PacketPtr funcPkt);
100
101    /** Schedule a sendTiming() event to be called in the future.
102     * @param pkt packet to send
103     * @param time increment from now (in ticks) to send packet
104     */
105    void sendTiming(PacketPtr pkt, Tick time);
106
107    /** This function is notification that the device should attempt to send a
108     * packet again. */
109    virtual void recvRetry();
110
111    /** Implemented using recvAtomic(). */
112    void recvFunctional(PacketPtr pkt);
113
114    /** Implemented using recvAtomic(). */
115    bool recvTiming(PacketPtr pkt);
116
117    /**
118     * Simple ports generally don't care about any status
119     * changes... can always override this in cases where that's not
120     * true. */
121    virtual void recvStatusChange(Status status) { }
122
123
124  public:
125
126    SimpleTimingPort(std::string pname, MemObject *_owner = NULL)
127        : Port(pname, _owner),
128          sendEvent(new SendEvent(this)),
129          drainEvent(NULL)
130    {}
131
132    ~SimpleTimingPort() { delete sendEvent; }
133
134    /** Hook for draining timing accesses from the system.  The
135     * associated SimObject's drain() functions should be implemented
136     * something like this when this class is used:
137     \code
138          PioDevice::drain(Event *de)
139          {
140              unsigned int count;
141              count = SimpleTimingPort->drain(de);
142              if (count)
143                  changeState(Draining);
144              else
145                  changeState(Drained);
146              return count;
147          }
148     \endcode
149    */
150    unsigned int drain(Event *de);
151};
152
153#endif // __MEM_TPORT_HH__
154