tport.hh revision 4666
12914Ssaidi@eecs.umich.edu/* 22914Ssaidi@eecs.umich.edu * Copyright (c) 2006 The Regents of The University of Michigan 32914Ssaidi@eecs.umich.edu * All rights reserved. 42914Ssaidi@eecs.umich.edu * 52914Ssaidi@eecs.umich.edu * Redistribution and use in source and binary forms, with or without 62914Ssaidi@eecs.umich.edu * modification, are permitted provided that the following conditions are 72914Ssaidi@eecs.umich.edu * met: redistributions of source code must retain the above copyright 82914Ssaidi@eecs.umich.edu * notice, this list of conditions and the following disclaimer; 92914Ssaidi@eecs.umich.edu * redistributions in binary form must reproduce the above copyright 102914Ssaidi@eecs.umich.edu * notice, this list of conditions and the following disclaimer in the 112914Ssaidi@eecs.umich.edu * documentation and/or other materials provided with the distribution; 122914Ssaidi@eecs.umich.edu * neither the name of the copyright holders nor the names of its 132914Ssaidi@eecs.umich.edu * contributors may be used to endorse or promote products derived from 142914Ssaidi@eecs.umich.edu * this software without specific prior written permission. 152914Ssaidi@eecs.umich.edu * 162914Ssaidi@eecs.umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172914Ssaidi@eecs.umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182914Ssaidi@eecs.umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192914Ssaidi@eecs.umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202914Ssaidi@eecs.umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212914Ssaidi@eecs.umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222914Ssaidi@eecs.umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232914Ssaidi@eecs.umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242914Ssaidi@eecs.umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252914Ssaidi@eecs.umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262914Ssaidi@eecs.umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272914Ssaidi@eecs.umich.edu * 282914Ssaidi@eecs.umich.edu * Authors: Ali Saidi 292914Ssaidi@eecs.umich.edu */ 302914Ssaidi@eecs.umich.edu 313091Sstever@eecs.umich.edu#ifndef __MEM_TPORT_HH__ 323091Sstever@eecs.umich.edu#define __MEM_TPORT_HH__ 333091Sstever@eecs.umich.edu 342914Ssaidi@eecs.umich.edu/** 352914Ssaidi@eecs.umich.edu * @file 363091Sstever@eecs.umich.edu * 373091Sstever@eecs.umich.edu * Declaration of SimpleTimingPort. 382914Ssaidi@eecs.umich.edu */ 392914Ssaidi@eecs.umich.edu 402914Ssaidi@eecs.umich.edu#include "mem/port.hh" 412914Ssaidi@eecs.umich.edu#include "sim/eventq.hh" 422914Ssaidi@eecs.umich.edu#include <list> 432914Ssaidi@eecs.umich.edu#include <string> 442914Ssaidi@eecs.umich.edu 453091Sstever@eecs.umich.edu/** 463091Sstever@eecs.umich.edu * A simple port for interfacing objects that basically have only 473091Sstever@eecs.umich.edu * functional memory behavior (e.g. I/O devices) to the memory system. 483091Sstever@eecs.umich.edu * Both timing and functional accesses are implemented in terms of 493091Sstever@eecs.umich.edu * atomic accesses. A derived port class thus only needs to provide 503091Sstever@eecs.umich.edu * recvAtomic() to support all memory access modes. 513091Sstever@eecs.umich.edu * 523091Sstever@eecs.umich.edu * The tricky part is handling recvTiming(), where the response must 533091Sstever@eecs.umich.edu * be scheduled separately via a later call to sendTiming(). This 543091Sstever@eecs.umich.edu * feature is handled by scheduling an internal event that calls 553091Sstever@eecs.umich.edu * sendTiming() after a delay, and optionally rescheduling the 563091Sstever@eecs.umich.edu * response if it is nacked. 573091Sstever@eecs.umich.edu */ 582914Ssaidi@eecs.umich.educlass SimpleTimingPort : public Port 592914Ssaidi@eecs.umich.edu{ 602914Ssaidi@eecs.umich.edu protected: 614490Sstever@eecs.umich.edu /** A deferred packet, buffered to transmit later. */ 624490Sstever@eecs.umich.edu class DeferredPacket { 634490Sstever@eecs.umich.edu public: 644490Sstever@eecs.umich.edu Tick tick; ///< The tick when the packet is ready to transmit 654490Sstever@eecs.umich.edu PacketPtr pkt; ///< Pointer to the packet to transmit 664490Sstever@eecs.umich.edu DeferredPacket(Tick t, PacketPtr p) 674490Sstever@eecs.umich.edu : tick(t), pkt(p) 684490Sstever@eecs.umich.edu {} 694490Sstever@eecs.umich.edu }; 704490Sstever@eecs.umich.edu 714490Sstever@eecs.umich.edu typedef std::list<DeferredPacket> DeferredPacketList; 724490Sstever@eecs.umich.edu typedef std::list<DeferredPacket>::iterator DeferredPacketIterator; 734490Sstever@eecs.umich.edu 743090Sstever@eecs.umich.edu /** A list of outgoing timing response packets that haven't been 753090Sstever@eecs.umich.edu * serviced yet. */ 764490Sstever@eecs.umich.edu DeferredPacketList transmitList; 774490Sstever@eecs.umich.edu 784490Sstever@eecs.umich.edu /** This function attempts to send deferred packets. Scheduled to 794490Sstever@eecs.umich.edu * be called in the future via SendEvent. */ 804490Sstever@eecs.umich.edu void processSendEvent(); 813091Sstever@eecs.umich.edu 822914Ssaidi@eecs.umich.edu /** 833090Sstever@eecs.umich.edu * This class is used to implemented sendTiming() with a delay. When 843403Ssaidi@eecs.umich.edu * a delay is requested a the event is scheduled if it isn't already. 853403Ssaidi@eecs.umich.edu * When the event time expires it attempts to send the packet. 863403Ssaidi@eecs.umich.edu * If it cannot, the packet sent when recvRetry() is called. 873403Ssaidi@eecs.umich.edu **/ 884490Sstever@eecs.umich.edu typedef EventWrapper<SimpleTimingPort, &SimpleTimingPort::processSendEvent> 894490Sstever@eecs.umich.edu SendEvent; 902914Ssaidi@eecs.umich.edu 914490Sstever@eecs.umich.edu Event *sendEvent; 922914Ssaidi@eecs.umich.edu 932914Ssaidi@eecs.umich.edu /** If we need to drain, keep the drain event around until we're done 942914Ssaidi@eecs.umich.edu * here.*/ 952914Ssaidi@eecs.umich.edu Event *drainEvent; 962914Ssaidi@eecs.umich.edu 974492Sstever@eecs.umich.edu /** Remember whether we're awaiting a retry from the bus. */ 984492Sstever@eecs.umich.edu bool waitingOnRetry; 994492Sstever@eecs.umich.edu 1004490Sstever@eecs.umich.edu /** Check the list of buffered packets against the supplied 1014490Sstever@eecs.umich.edu * functional request. */ 1024490Sstever@eecs.umich.edu void checkFunctional(PacketPtr funcPkt); 1034490Sstever@eecs.umich.edu 1044492Sstever@eecs.umich.edu /** Check whether we have a packet ready to go on the transmit list. */ 1054492Sstever@eecs.umich.edu bool deferredPacketReady() 1064492Sstever@eecs.umich.edu { return !transmitList.empty() && transmitList.front().tick <= curTick; } 1074492Sstever@eecs.umich.edu 1084666Sstever@eecs.umich.edu Tick deferredPacketReadyTick() 1094666Sstever@eecs.umich.edu { return transmitList.empty() ? MaxTick : transmitList.front().tick; } 1104666Sstever@eecs.umich.edu 1114666Sstever@eecs.umich.edu void schedSendEvent(Tick when) 1124666Sstever@eecs.umich.edu { 1134666Sstever@eecs.umich.edu if (waitingOnRetry) { 1144666Sstever@eecs.umich.edu assert(!sendEvent->scheduled()); 1154666Sstever@eecs.umich.edu return; 1164666Sstever@eecs.umich.edu } 1174666Sstever@eecs.umich.edu 1184666Sstever@eecs.umich.edu if (!sendEvent->scheduled()) { 1194666Sstever@eecs.umich.edu sendEvent->schedule(when); 1204666Sstever@eecs.umich.edu } else if (sendEvent->when() > when) { 1214666Sstever@eecs.umich.edu sendEvent->reschedule(when); 1224666Sstever@eecs.umich.edu } 1234666Sstever@eecs.umich.edu } 1244666Sstever@eecs.umich.edu 1254666Sstever@eecs.umich.edu 1263403Ssaidi@eecs.umich.edu /** Schedule a sendTiming() event to be called in the future. 1273403Ssaidi@eecs.umich.edu * @param pkt packet to send 1284492Sstever@eecs.umich.edu * @param absolute time (in ticks) to send packet 1293403Ssaidi@eecs.umich.edu */ 1304492Sstever@eecs.umich.edu void schedSendTiming(PacketPtr pkt, Tick when); 1314492Sstever@eecs.umich.edu 1324492Sstever@eecs.umich.edu /** Attempt to send the packet at the head of the deferred packet 1334492Sstever@eecs.umich.edu * list. Caller must guarantee that the deferred packet list is 1344492Sstever@eecs.umich.edu * non-empty and that the head packet is scheduled for curTick (or 1354492Sstever@eecs.umich.edu * earlier). 1364492Sstever@eecs.umich.edu */ 1374492Sstever@eecs.umich.edu void sendDeferredPacket(); 1382914Ssaidi@eecs.umich.edu 1392914Ssaidi@eecs.umich.edu /** This function is notification that the device should attempt to send a 1402914Ssaidi@eecs.umich.edu * packet again. */ 1412914Ssaidi@eecs.umich.edu virtual void recvRetry(); 1422914Ssaidi@eecs.umich.edu 1433091Sstever@eecs.umich.edu /** Implemented using recvAtomic(). */ 1443349Sbinkertn@umich.edu void recvFunctional(PacketPtr pkt); 1453091Sstever@eecs.umich.edu 1463091Sstever@eecs.umich.edu /** Implemented using recvAtomic(). */ 1473349Sbinkertn@umich.edu bool recvTiming(PacketPtr pkt); 1483091Sstever@eecs.umich.edu 1493091Sstever@eecs.umich.edu /** 1503091Sstever@eecs.umich.edu * Simple ports generally don't care about any status 1513091Sstever@eecs.umich.edu * changes... can always override this in cases where that's not 1523091Sstever@eecs.umich.edu * true. */ 1533091Sstever@eecs.umich.edu virtual void recvStatusChange(Status status) { } 1543091Sstever@eecs.umich.edu 1553091Sstever@eecs.umich.edu 1562914Ssaidi@eecs.umich.edu public: 1572914Ssaidi@eecs.umich.edu 1583401Sktlim@umich.edu SimpleTimingPort(std::string pname, MemObject *_owner = NULL) 1594490Sstever@eecs.umich.edu : Port(pname, _owner), 1604490Sstever@eecs.umich.edu sendEvent(new SendEvent(this)), 1614492Sstever@eecs.umich.edu drainEvent(NULL), 1624492Sstever@eecs.umich.edu waitingOnRetry(false) 1632914Ssaidi@eecs.umich.edu {} 1642914Ssaidi@eecs.umich.edu 1654490Sstever@eecs.umich.edu ~SimpleTimingPort() { delete sendEvent; } 1664490Sstever@eecs.umich.edu 1673091Sstever@eecs.umich.edu /** Hook for draining timing accesses from the system. The 1683091Sstever@eecs.umich.edu * associated SimObject's drain() functions should be implemented 1693091Sstever@eecs.umich.edu * something like this when this class is used: 1703091Sstever@eecs.umich.edu \code 1713091Sstever@eecs.umich.edu PioDevice::drain(Event *de) 1723091Sstever@eecs.umich.edu { 1733091Sstever@eecs.umich.edu unsigned int count; 1743091Sstever@eecs.umich.edu count = SimpleTimingPort->drain(de); 1753091Sstever@eecs.umich.edu if (count) 1763091Sstever@eecs.umich.edu changeState(Draining); 1773091Sstever@eecs.umich.edu else 1783091Sstever@eecs.umich.edu changeState(Drained); 1793091Sstever@eecs.umich.edu return count; 1803091Sstever@eecs.umich.edu } 1813091Sstever@eecs.umich.edu \endcode 1823091Sstever@eecs.umich.edu */ 1832914Ssaidi@eecs.umich.edu unsigned int drain(Event *de); 1842914Ssaidi@eecs.umich.edu}; 1852914Ssaidi@eecs.umich.edu 1862914Ssaidi@eecs.umich.edu#endif // __MEM_TPORT_HH__ 187