port.hh revision 13845
12381SN/A/* 212342Snikos.nikoleris@arm.com * Copyright (c) 2011-2012,2015,2017 ARM Limited 38711Sandreas.hansson@arm.com * All rights reserved 48711Sandreas.hansson@arm.com * 58711Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 68711Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 78711Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 88711Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 98711Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 108711Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 118711Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 128711Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 138711Sandreas.hansson@arm.com * 142381SN/A * Copyright (c) 2002-2005 The Regents of The University of Michigan 152381SN/A * All rights reserved. 162381SN/A * 172381SN/A * Redistribution and use in source and binary forms, with or without 182381SN/A * modification, are permitted provided that the following conditions are 192381SN/A * met: redistributions of source code must retain the above copyright 202381SN/A * notice, this list of conditions and the following disclaimer; 212381SN/A * redistributions in binary form must reproduce the above copyright 222381SN/A * notice, this list of conditions and the following disclaimer in the 232381SN/A * documentation and/or other materials provided with the distribution; 242381SN/A * neither the name of the copyright holders nor the names of its 252381SN/A * contributors may be used to endorse or promote products derived from 262381SN/A * this software without specific prior written permission. 272381SN/A * 282381SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 292381SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 302381SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 312381SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 322381SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 332381SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 342381SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 352381SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 362381SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 372381SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 382381SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392665Ssaidi@eecs.umich.edu * 402665Ssaidi@eecs.umich.edu * Authors: Ron Dreslinski 418853Sandreas.hansson@arm.com * Andreas Hansson 428922Swilliam.wang@arm.com * William Wang 432381SN/A */ 442381SN/A 452381SN/A/** 462381SN/A * @file 478922Swilliam.wang@arm.com * Port Object Declaration. 482381SN/A */ 492381SN/A 502381SN/A#ifndef __MEM_PORT_HH__ 512381SN/A#define __MEM_PORT_HH__ 522381SN/A 539235Sandreas.hansson@arm.com#include "base/addr_range.hh" 5413845Sgabeblack@google.com#include "mem/backdoor.hh" 552381SN/A#include "mem/packet.hh" 5613771Sgabeblack@google.com#include "sim/port.hh" 572381SN/A 583401Sktlim@umich.educlass MemObject; 593401Sktlim@umich.edu 608922Swilliam.wang@arm.com/** Forward declaration */ 619294Sandreas.hansson@arm.comclass BaseSlavePort; 629294Sandreas.hansson@arm.com 639294Sandreas.hansson@arm.com/** 649294Sandreas.hansson@arm.com * A BaseMasterPort is a protocol-agnostic master port, responsible 659294Sandreas.hansson@arm.com * only for the structural connection to a slave port. The final 669294Sandreas.hansson@arm.com * master port that inherits from the base class must override the 679294Sandreas.hansson@arm.com * bind member function for the specific slave port class. 689294Sandreas.hansson@arm.com */ 699294Sandreas.hansson@arm.comclass BaseMasterPort : public Port 709294Sandreas.hansson@arm.com{ 719294Sandreas.hansson@arm.com 729294Sandreas.hansson@arm.com protected: 739294Sandreas.hansson@arm.com 749294Sandreas.hansson@arm.com BaseSlavePort* _baseSlavePort; 759294Sandreas.hansson@arm.com 7613769Sgabeblack@google.com BaseMasterPort(const std::string& name, PortID id=InvalidPortID); 779294Sandreas.hansson@arm.com virtual ~BaseMasterPort(); 789294Sandreas.hansson@arm.com 799294Sandreas.hansson@arm.com public: 809294Sandreas.hansson@arm.com 819294Sandreas.hansson@arm.com BaseSlavePort& getSlavePort() const; 829294Sandreas.hansson@arm.com 839294Sandreas.hansson@arm.com}; 849294Sandreas.hansson@arm.com 859294Sandreas.hansson@arm.com/** 869294Sandreas.hansson@arm.com * A BaseSlavePort is a protocol-agnostic slave port, responsible 879294Sandreas.hansson@arm.com * only for the structural connection to a master port. 889294Sandreas.hansson@arm.com */ 899294Sandreas.hansson@arm.comclass BaseSlavePort : public Port 909294Sandreas.hansson@arm.com{ 919294Sandreas.hansson@arm.com 929294Sandreas.hansson@arm.com protected: 939294Sandreas.hansson@arm.com 949294Sandreas.hansson@arm.com BaseMasterPort* _baseMasterPort; 959294Sandreas.hansson@arm.com 9613769Sgabeblack@google.com BaseSlavePort(const std::string& name, PortID id=InvalidPortID); 979294Sandreas.hansson@arm.com virtual ~BaseSlavePort(); 989294Sandreas.hansson@arm.com 999294Sandreas.hansson@arm.com public: 1009294Sandreas.hansson@arm.com 1019294Sandreas.hansson@arm.com BaseMasterPort& getMasterPort() const; 1029294Sandreas.hansson@arm.com 1039294Sandreas.hansson@arm.com}; 1049294Sandreas.hansson@arm.com 1059294Sandreas.hansson@arm.com/** Forward declaration */ 1068922Swilliam.wang@arm.comclass SlavePort; 1078922Swilliam.wang@arm.com 1088922Swilliam.wang@arm.com/** 1099294Sandreas.hansson@arm.com * A MasterPort is a specialisation of a BaseMasterPort, which 1109294Sandreas.hansson@arm.com * implements the default protocol for the three different level of 1119294Sandreas.hansson@arm.com * transport functions. In addition to the basic functionality of 1129294Sandreas.hansson@arm.com * sending packets, it also has functions to receive range changes or 1139294Sandreas.hansson@arm.com * determine if the port is snooping or not. 1148922Swilliam.wang@arm.com */ 1159294Sandreas.hansson@arm.comclass MasterPort : public BaseMasterPort 1168922Swilliam.wang@arm.com{ 1178922Swilliam.wang@arm.com 1188975Sandreas.hansson@arm.com friend class SlavePort; 1198975Sandreas.hansson@arm.com 1208922Swilliam.wang@arm.com private: 1218922Swilliam.wang@arm.com 1228922Swilliam.wang@arm.com SlavePort* _slavePort; 1238922Swilliam.wang@arm.com 12413769Sgabeblack@google.com protected: 12513769Sgabeblack@google.com 12613769Sgabeblack@google.com MemObject& owner; 12713769Sgabeblack@google.com 1288922Swilliam.wang@arm.com public: 1298922Swilliam.wang@arm.com 13013769Sgabeblack@google.com MasterPort(const std::string& name, MemObject* _owner, 13113769Sgabeblack@google.com PortID id=InvalidPortID); 1328922Swilliam.wang@arm.com virtual ~MasterPort(); 1338922Swilliam.wang@arm.com 1349178Sandreas.hansson@arm.com /** 1359178Sandreas.hansson@arm.com * Bind this master port to a slave port. This also does the 1369178Sandreas.hansson@arm.com * mirror action and binds the slave port to the master port. 1379178Sandreas.hansson@arm.com */ 13813782Sgabeblack@google.com void bind(Port &peer) override; 1399178Sandreas.hansson@arm.com 1409178Sandreas.hansson@arm.com /** 1419178Sandreas.hansson@arm.com * Unbind this master port and the associated slave port. 1429178Sandreas.hansson@arm.com */ 14313782Sgabeblack@google.com void unbind() override; 1449178Sandreas.hansson@arm.com 1458922Swilliam.wang@arm.com /** 1468948Sandreas.hansson@arm.com * Send an atomic request packet, where the data is moved and the 1478948Sandreas.hansson@arm.com * state is updated in zero time, without interleaving with other 1488948Sandreas.hansson@arm.com * memory accesses. 1498948Sandreas.hansson@arm.com * 1508948Sandreas.hansson@arm.com * @param pkt Packet to send. 1518948Sandreas.hansson@arm.com * 1528948Sandreas.hansson@arm.com * @return Estimated latency of access. 1538948Sandreas.hansson@arm.com */ 1548948Sandreas.hansson@arm.com Tick sendAtomic(PacketPtr pkt); 1558948Sandreas.hansson@arm.com 1568948Sandreas.hansson@arm.com /** 15713845Sgabeblack@google.com * Send an atomic request packet like above, but also request a backdoor 15813845Sgabeblack@google.com * to the data being accessed. 15913845Sgabeblack@google.com * 16013845Sgabeblack@google.com * @param pkt Packet to send. 16113845Sgabeblack@google.com * @param backdoor Can be set to a back door pointer by the target to let 16213845Sgabeblack@google.com * caller have direct access to the requested data. 16313845Sgabeblack@google.com * 16413845Sgabeblack@google.com * @return Estimated latency of access. 16513845Sgabeblack@google.com */ 16613845Sgabeblack@google.com Tick sendAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor); 16713845Sgabeblack@google.com 16813845Sgabeblack@google.com /** 1698948Sandreas.hansson@arm.com * Send a functional request packet, where the data is instantly 1708948Sandreas.hansson@arm.com * updated everywhere in the memory system, without affecting the 1718948Sandreas.hansson@arm.com * current state of any block or moving the block. 1728948Sandreas.hansson@arm.com * 1738948Sandreas.hansson@arm.com * @param pkt Packet to send. 1748948Sandreas.hansson@arm.com */ 1758948Sandreas.hansson@arm.com void sendFunctional(PacketPtr pkt); 1768948Sandreas.hansson@arm.com 1778948Sandreas.hansson@arm.com /** 1788975Sandreas.hansson@arm.com * Attempt to send a timing request to the slave port by calling 1798975Sandreas.hansson@arm.com * its corresponding receive function. If the send does not 1808975Sandreas.hansson@arm.com * succeed, as indicated by the return value, then the sender must 18110713Sandreas.hansson@arm.com * wait for a recvReqRetry at which point it can re-issue a 1828975Sandreas.hansson@arm.com * sendTimingReq. 1838975Sandreas.hansson@arm.com * 1848975Sandreas.hansson@arm.com * @param pkt Packet to send. 1858975Sandreas.hansson@arm.com * 1868975Sandreas.hansson@arm.com * @return If the send was succesful or not. 1878975Sandreas.hansson@arm.com */ 1888975Sandreas.hansson@arm.com bool sendTimingReq(PacketPtr pkt); 1898948Sandreas.hansson@arm.com 1908948Sandreas.hansson@arm.com /** 19112342Snikos.nikoleris@arm.com * Check if the slave can handle a timing request. 19212342Snikos.nikoleris@arm.com * 19312342Snikos.nikoleris@arm.com * If the send cannot be handled at the moment, as indicated by 19412342Snikos.nikoleris@arm.com * the return value, then the sender will receive a recvReqRetry 19512342Snikos.nikoleris@arm.com * at which point it can re-issue a sendTimingReq. 19612342Snikos.nikoleris@arm.com * 19712342Snikos.nikoleris@arm.com * @param pkt Packet to send. 19812342Snikos.nikoleris@arm.com * 19912342Snikos.nikoleris@arm.com * @return If the send was succesful or not. 20012342Snikos.nikoleris@arm.com */ 20112342Snikos.nikoleris@arm.com bool tryTiming(PacketPtr pkt) const; 20212342Snikos.nikoleris@arm.com 20312342Snikos.nikoleris@arm.com /** 2048975Sandreas.hansson@arm.com * Attempt to send a timing snoop response packet to the slave 2058975Sandreas.hansson@arm.com * port by calling its corresponding receive function. If the send 2068975Sandreas.hansson@arm.com * does not succeed, as indicated by the return value, then the 20710713Sandreas.hansson@arm.com * sender must wait for a recvRetrySnoop at which point it can 20810713Sandreas.hansson@arm.com * re-issue a sendTimingSnoopResp. 2098975Sandreas.hansson@arm.com * 2108975Sandreas.hansson@arm.com * @param pkt Packet to send. 2118948Sandreas.hansson@arm.com */ 2128975Sandreas.hansson@arm.com bool sendTimingSnoopResp(PacketPtr pkt); 2138922Swilliam.wang@arm.com 2148922Swilliam.wang@arm.com /** 2159087Sandreas.hansson@arm.com * Send a retry to the slave port that previously attempted a 21610713Sandreas.hansson@arm.com * sendTimingResp to this master port and failed. Note that this 21710713Sandreas.hansson@arm.com * is virtual so that the "fake" snoop response port in the 21810713Sandreas.hansson@arm.com * coherent crossbar can override the behaviour. 2199087Sandreas.hansson@arm.com */ 22010713Sandreas.hansson@arm.com virtual void sendRetryResp(); 2219087Sandreas.hansson@arm.com 2229087Sandreas.hansson@arm.com /** 2238922Swilliam.wang@arm.com * Determine if this master port is snooping or not. The default 2248711Sandreas.hansson@arm.com * implementation returns false and thus tells the neighbour we 2258922Swilliam.wang@arm.com * are not snooping. Any master port that wants to receive snoop 2268922Swilliam.wang@arm.com * requests (e.g. a cache connected to a bus) has to override this 2278922Swilliam.wang@arm.com * function. 2288711Sandreas.hansson@arm.com * 2298711Sandreas.hansson@arm.com * @return true if the port should be considered a snooper 2308711Sandreas.hansson@arm.com */ 2318922Swilliam.wang@arm.com virtual bool isSnooping() const { return false; } 2322381SN/A 2338711Sandreas.hansson@arm.com /** 2349089Sandreas.hansson@arm.com * Get the address ranges of the connected slave port. 2359089Sandreas.hansson@arm.com */ 2369089Sandreas.hansson@arm.com AddrRangeList getAddrRanges() const; 2379089Sandreas.hansson@arm.com 2385314Sstever@gmail.com /** Inject a PrintReq for the given address to print the state of 2395314Sstever@gmail.com * that address throughout the memory system. For debugging. 2405314Sstever@gmail.com */ 2415314Sstever@gmail.com void printAddr(Addr a); 2428975Sandreas.hansson@arm.com 2438975Sandreas.hansson@arm.com protected: 2448975Sandreas.hansson@arm.com 2458975Sandreas.hansson@arm.com /** 2468975Sandreas.hansson@arm.com * Receive an atomic snoop request packet from the slave port. 2478975Sandreas.hansson@arm.com */ 2488975Sandreas.hansson@arm.com virtual Tick recvAtomicSnoop(PacketPtr pkt) 2498975Sandreas.hansson@arm.com { 2508975Sandreas.hansson@arm.com panic("%s was not expecting an atomic snoop request\n", name()); 2518975Sandreas.hansson@arm.com return 0; 2528975Sandreas.hansson@arm.com } 2538975Sandreas.hansson@arm.com 2548975Sandreas.hansson@arm.com /** 2558975Sandreas.hansson@arm.com * Receive a functional snoop request packet from the slave port. 2568975Sandreas.hansson@arm.com */ 2578975Sandreas.hansson@arm.com virtual void recvFunctionalSnoop(PacketPtr pkt) 2588975Sandreas.hansson@arm.com { 2598975Sandreas.hansson@arm.com panic("%s was not expecting a functional snoop request\n", name()); 2608975Sandreas.hansson@arm.com } 2618975Sandreas.hansson@arm.com 2628975Sandreas.hansson@arm.com /** 2638975Sandreas.hansson@arm.com * Receive a timing response from the slave port. 2648975Sandreas.hansson@arm.com */ 2658975Sandreas.hansson@arm.com virtual bool recvTimingResp(PacketPtr pkt) = 0; 2668975Sandreas.hansson@arm.com 2678975Sandreas.hansson@arm.com /** 2688975Sandreas.hansson@arm.com * Receive a timing snoop request from the slave port. 2698975Sandreas.hansson@arm.com */ 2708975Sandreas.hansson@arm.com virtual void recvTimingSnoopReq(PacketPtr pkt) 2718975Sandreas.hansson@arm.com { 2728975Sandreas.hansson@arm.com panic("%s was not expecting a timing snoop request\n", name()); 2738975Sandreas.hansson@arm.com } 2748975Sandreas.hansson@arm.com 2758975Sandreas.hansson@arm.com /** 27610713Sandreas.hansson@arm.com * Called by the slave port if sendTimingReq was called on this 27710713Sandreas.hansson@arm.com * master port (causing recvTimingReq to be called on the slave 27810713Sandreas.hansson@arm.com * port) and was unsuccesful. 2799087Sandreas.hansson@arm.com */ 28010713Sandreas.hansson@arm.com virtual void recvReqRetry() = 0; 28110713Sandreas.hansson@arm.com 28210713Sandreas.hansson@arm.com /** 28310713Sandreas.hansson@arm.com * Called by the slave port if sendTimingSnoopResp was called on this 28410713Sandreas.hansson@arm.com * master port (causing recvTimingSnoopResp to be called on the slave 28510713Sandreas.hansson@arm.com * port) and was unsuccesful. 28610713Sandreas.hansson@arm.com */ 28710713Sandreas.hansson@arm.com virtual void recvRetrySnoopResp() 28810713Sandreas.hansson@arm.com { 28910713Sandreas.hansson@arm.com panic("%s was not expecting a snoop retry\n", name()); 29010713Sandreas.hansson@arm.com } 2919087Sandreas.hansson@arm.com 2929087Sandreas.hansson@arm.com /** 2938975Sandreas.hansson@arm.com * Called to receive an address range change from the peer slave 2949325Sandreas.hansson@arm.com * port. The default implementation ignores the change and does 2958975Sandreas.hansson@arm.com * nothing. Override this function in a derived class if the owner 2969325Sandreas.hansson@arm.com * needs to be aware of the address ranges, e.g. in an 2978975Sandreas.hansson@arm.com * interconnect component like a bus. 2988975Sandreas.hansson@arm.com */ 2998975Sandreas.hansson@arm.com virtual void recvRangeChange() { } 3002381SN/A}; 3012381SN/A 3028922Swilliam.wang@arm.com/** 3038922Swilliam.wang@arm.com * A SlavePort is a specialisation of a port. In addition to the 3048922Swilliam.wang@arm.com * basic functionality of sending packets to its master peer, it also 3058922Swilliam.wang@arm.com * has functions specific to a slave, e.g. to send range changes 3068922Swilliam.wang@arm.com * and get the address ranges that the port responds to. 3078922Swilliam.wang@arm.com */ 3089294Sandreas.hansson@arm.comclass SlavePort : public BaseSlavePort 3098922Swilliam.wang@arm.com{ 3108922Swilliam.wang@arm.com 3118975Sandreas.hansson@arm.com friend class MasterPort; 3128975Sandreas.hansson@arm.com 3138922Swilliam.wang@arm.com private: 3148922Swilliam.wang@arm.com 3158922Swilliam.wang@arm.com MasterPort* _masterPort; 31613845Sgabeblack@google.com bool defaultBackdoorWarned; 3178922Swilliam.wang@arm.com 31813769Sgabeblack@google.com protected: 31913769Sgabeblack@google.com 32013769Sgabeblack@google.com MemObject& owner; 32113769Sgabeblack@google.com 3228922Swilliam.wang@arm.com public: 3238922Swilliam.wang@arm.com 32413769Sgabeblack@google.com SlavePort(const std::string& name, MemObject* _owner, 32513769Sgabeblack@google.com PortID id=InvalidPortID); 3268922Swilliam.wang@arm.com virtual ~SlavePort(); 3278922Swilliam.wang@arm.com 3288922Swilliam.wang@arm.com /** 3298948Sandreas.hansson@arm.com * Send an atomic snoop request packet, where the data is moved 3308948Sandreas.hansson@arm.com * and the state is updated in zero time, without interleaving 3318948Sandreas.hansson@arm.com * with other memory accesses. 3328948Sandreas.hansson@arm.com * 3338948Sandreas.hansson@arm.com * @param pkt Snoop packet to send. 3348948Sandreas.hansson@arm.com * 3358948Sandreas.hansson@arm.com * @return Estimated latency of access. 3368948Sandreas.hansson@arm.com */ 3378948Sandreas.hansson@arm.com Tick sendAtomicSnoop(PacketPtr pkt); 3388948Sandreas.hansson@arm.com 3398948Sandreas.hansson@arm.com /** 3408948Sandreas.hansson@arm.com * Send a functional snoop request packet, where the data is 3418948Sandreas.hansson@arm.com * instantly updated everywhere in the memory system, without 3428948Sandreas.hansson@arm.com * affecting the current state of any block or moving the block. 3438948Sandreas.hansson@arm.com * 3448948Sandreas.hansson@arm.com * @param pkt Snoop packet to send. 3458948Sandreas.hansson@arm.com */ 3468948Sandreas.hansson@arm.com void sendFunctionalSnoop(PacketPtr pkt); 3478948Sandreas.hansson@arm.com 3488948Sandreas.hansson@arm.com /** 3498975Sandreas.hansson@arm.com * Attempt to send a timing response to the master port by calling 3508975Sandreas.hansson@arm.com * its corresponding receive function. If the send does not 3518975Sandreas.hansson@arm.com * succeed, as indicated by the return value, then the sender must 35210713Sandreas.hansson@arm.com * wait for a recvRespRetry at which point it can re-issue a 3538975Sandreas.hansson@arm.com * sendTimingResp. 3548975Sandreas.hansson@arm.com * 3558975Sandreas.hansson@arm.com * @param pkt Packet to send. 3568975Sandreas.hansson@arm.com * 3578975Sandreas.hansson@arm.com * @return If the send was succesful or not. 3588975Sandreas.hansson@arm.com */ 3598975Sandreas.hansson@arm.com bool sendTimingResp(PacketPtr pkt); 3608948Sandreas.hansson@arm.com 3618948Sandreas.hansson@arm.com /** 3628975Sandreas.hansson@arm.com * Attempt to send a timing snoop request packet to the master port 3638975Sandreas.hansson@arm.com * by calling its corresponding receive function. Snoop requests 3648975Sandreas.hansson@arm.com * always succeed and hence no return value is needed. 3658975Sandreas.hansson@arm.com * 3668975Sandreas.hansson@arm.com * @param pkt Packet to send. 3678948Sandreas.hansson@arm.com */ 3688975Sandreas.hansson@arm.com void sendTimingSnoopReq(PacketPtr pkt); 3698948Sandreas.hansson@arm.com 3708948Sandreas.hansson@arm.com /** 3719087Sandreas.hansson@arm.com * Send a retry to the master port that previously attempted a 37210713Sandreas.hansson@arm.com * sendTimingReq to this slave port and failed. 3739087Sandreas.hansson@arm.com */ 37410713Sandreas.hansson@arm.com void sendRetryReq(); 37510713Sandreas.hansson@arm.com 37610713Sandreas.hansson@arm.com /** 37710713Sandreas.hansson@arm.com * Send a retry to the master port that previously attempted a 37810713Sandreas.hansson@arm.com * sendTimingSnoopResp to this slave port and failed. 37910713Sandreas.hansson@arm.com */ 38010713Sandreas.hansson@arm.com void sendRetrySnoopResp(); 3819087Sandreas.hansson@arm.com 3829087Sandreas.hansson@arm.com /** 3839088Sandreas.hansson@arm.com * Find out if the peer master port is snooping or not. 3849088Sandreas.hansson@arm.com * 3859088Sandreas.hansson@arm.com * @return true if the peer master port is snooping 3869088Sandreas.hansson@arm.com */ 3879088Sandreas.hansson@arm.com bool isSnooping() const { return _masterPort->isSnooping(); } 3889088Sandreas.hansson@arm.com 3899088Sandreas.hansson@arm.com /** 3908922Swilliam.wang@arm.com * Called by the owner to send a range change 3918922Swilliam.wang@arm.com */ 39210413SCurtis.Dunham@arm.com void sendRangeChange() const { 39310413SCurtis.Dunham@arm.com if (!_masterPort) 39410413SCurtis.Dunham@arm.com fatal("%s cannot sendRangeChange() without master port", name()); 39510413SCurtis.Dunham@arm.com _masterPort->recvRangeChange(); 39610413SCurtis.Dunham@arm.com } 3978922Swilliam.wang@arm.com 3988922Swilliam.wang@arm.com /** 3998922Swilliam.wang@arm.com * Get a list of the non-overlapping address ranges the owner is 4008922Swilliam.wang@arm.com * responsible for. All slave ports must override this function 4018922Swilliam.wang@arm.com * and return a populated list with at least one item. 4028922Swilliam.wang@arm.com * 4038922Swilliam.wang@arm.com * @return a list of ranges responded to 4048922Swilliam.wang@arm.com */ 4059090Sandreas.hansson@arm.com virtual AddrRangeList getAddrRanges() const = 0; 4068975Sandreas.hansson@arm.com 40713782Sgabeblack@google.com /** 40813782Sgabeblack@google.com * We let the master port do the work, so these don't do anything. 40913782Sgabeblack@google.com */ 41013782Sgabeblack@google.com void unbind() override {} 41113782Sgabeblack@google.com void bind(Port &peer) override {} 41213782Sgabeblack@google.com 4138975Sandreas.hansson@arm.com protected: 4148975Sandreas.hansson@arm.com 4158975Sandreas.hansson@arm.com /** 4169178Sandreas.hansson@arm.com * Called by the master port to unbind. Should never be called 4179178Sandreas.hansson@arm.com * directly. 4189178Sandreas.hansson@arm.com */ 41913782Sgabeblack@google.com void slaveUnbind(); 4209178Sandreas.hansson@arm.com 4219178Sandreas.hansson@arm.com /** 4229178Sandreas.hansson@arm.com * Called by the master port to bind. Should never be called 4239178Sandreas.hansson@arm.com * directly. 4249178Sandreas.hansson@arm.com */ 42513782Sgabeblack@google.com void slaveBind(MasterPort& master_port); 4269178Sandreas.hansson@arm.com 4279178Sandreas.hansson@arm.com /** 4288975Sandreas.hansson@arm.com * Receive an atomic request packet from the master port. 4298975Sandreas.hansson@arm.com */ 4308975Sandreas.hansson@arm.com virtual Tick recvAtomic(PacketPtr pkt) = 0; 4318975Sandreas.hansson@arm.com 4328975Sandreas.hansson@arm.com /** 43313845Sgabeblack@google.com * Receive an atomic request packet from the master port, and optionally 43413845Sgabeblack@google.com * provide a backdoor to the data being accessed. 43513845Sgabeblack@google.com */ 43613845Sgabeblack@google.com virtual Tick recvAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor); 43713845Sgabeblack@google.com 43813845Sgabeblack@google.com /** 4398975Sandreas.hansson@arm.com * Receive a functional request packet from the master port. 4408975Sandreas.hansson@arm.com */ 4418975Sandreas.hansson@arm.com virtual void recvFunctional(PacketPtr pkt) = 0; 4428975Sandreas.hansson@arm.com 4438975Sandreas.hansson@arm.com /** 4448975Sandreas.hansson@arm.com * Receive a timing request from the master port. 4458975Sandreas.hansson@arm.com */ 4468975Sandreas.hansson@arm.com virtual bool recvTimingReq(PacketPtr pkt) = 0; 4478975Sandreas.hansson@arm.com 4488975Sandreas.hansson@arm.com /** 44912342Snikos.nikoleris@arm.com * Availability request from the master port. 45012342Snikos.nikoleris@arm.com */ 45112342Snikos.nikoleris@arm.com virtual bool tryTiming(PacketPtr pkt) { 45212342Snikos.nikoleris@arm.com panic("%s was not expecting a %s\n", name(), __func__); 45312342Snikos.nikoleris@arm.com } 45412342Snikos.nikoleris@arm.com 45512342Snikos.nikoleris@arm.com /** 4568975Sandreas.hansson@arm.com * Receive a timing snoop response from the master port. 4578975Sandreas.hansson@arm.com */ 4588975Sandreas.hansson@arm.com virtual bool recvTimingSnoopResp(PacketPtr pkt) 4598975Sandreas.hansson@arm.com { 4608975Sandreas.hansson@arm.com panic("%s was not expecting a timing snoop response\n", name()); 4618975Sandreas.hansson@arm.com } 4628975Sandreas.hansson@arm.com 4639087Sandreas.hansson@arm.com /** 4649087Sandreas.hansson@arm.com * Called by the master port if sendTimingResp was called on this 4659087Sandreas.hansson@arm.com * slave port (causing recvTimingResp to be called on the master 4669087Sandreas.hansson@arm.com * port) and was unsuccesful. 4679087Sandreas.hansson@arm.com */ 46810713Sandreas.hansson@arm.com virtual void recvRespRetry() = 0; 4699087Sandreas.hansson@arm.com 4708922Swilliam.wang@arm.com}; 4718922Swilliam.wang@arm.com 4722381SN/A#endif //__MEM_PORT_HH__ 473