port.hh revision 9325
12381SN/A/* 28853Sandreas.hansson@arm.com * Copyright (c) 2011-2012 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 532381SN/A#include <list> 542381SN/A 559235Sandreas.hansson@arm.com#include "base/addr_range.hh" 562381SN/A#include "mem/packet.hh" 572381SN/A 588922Swilliam.wang@arm.com/** 598922Swilliam.wang@arm.com * This typedef is used to clean up getAddrRanges(). It's declared 602407SN/A * outside the Port object since it's also used by some mem objects. 612407SN/A * Eventually we should move this typedef to wherever Addr is 622407SN/A * defined. 632407SN/A */ 642407SN/A 659235Sandreas.hansson@arm.comtypedef std::list<AddrRange> AddrRangeList; 669235Sandreas.hansson@arm.comtypedef std::list<AddrRange>::iterator AddrRangeIter; 679235Sandreas.hansson@arm.comtypedef std::list<AddrRange>::const_iterator AddrRangeConstIter; 682407SN/A 693401Sktlim@umich.educlass MemObject; 703401Sktlim@umich.edu 712381SN/A/** 728922Swilliam.wang@arm.com * Ports are used to interface memory objects to each other. A port is 738922Swilliam.wang@arm.com * either a master or a slave and the connected peer is always of the 749087Sandreas.hansson@arm.com * opposite role. Each port has a name, an owner, and an identifier. 752381SN/A */ 768708Sandreas.hansson@arm.comclass Port 772381SN/A{ 788922Swilliam.wang@arm.com 798922Swilliam.wang@arm.com private: 808922Swilliam.wang@arm.com 818922Swilliam.wang@arm.com /** Descriptive name (for DPRINTF output) */ 828922Swilliam.wang@arm.com std::string portName; 838922Swilliam.wang@arm.com 845476Snate@binkert.org protected: 852640Sstever@eecs.umich.edu 868965Sandreas.hansson@arm.com /** 878965Sandreas.hansson@arm.com * A numeric identifier to distinguish ports in a vector, and set 889031Sandreas.hansson@arm.com * to InvalidPortID in case this port is not part of a vector. 898965Sandreas.hansson@arm.com */ 909031Sandreas.hansson@arm.com const PortID id; 918965Sandreas.hansson@arm.com 928922Swilliam.wang@arm.com /** A reference to the MemObject that owns this port. */ 938922Swilliam.wang@arm.com MemObject& owner; 948922Swilliam.wang@arm.com 958922Swilliam.wang@arm.com /** 968922Swilliam.wang@arm.com * Abstract base class for ports 978922Swilliam.wang@arm.com * 988922Swilliam.wang@arm.com * @param _name Port name including the owners name 998922Swilliam.wang@arm.com * @param _owner The MemObject that is the structural owner of this port 1008965Sandreas.hansson@arm.com * @param _id A port identifier for vector ports 1018922Swilliam.wang@arm.com */ 1029031Sandreas.hansson@arm.com Port(const std::string& _name, MemObject& _owner, PortID _id); 1038922Swilliam.wang@arm.com 1048922Swilliam.wang@arm.com /** 1058922Swilliam.wang@arm.com * Virtual destructor due to inheritance. 1068922Swilliam.wang@arm.com */ 1078922Swilliam.wang@arm.com virtual ~Port(); 1083401Sktlim@umich.edu 1092381SN/A public: 1102640Sstever@eecs.umich.edu 1112640Sstever@eecs.umich.edu /** Return port name (for DPRINTF). */ 1128922Swilliam.wang@arm.com const std::string name() const { return portName; } 1134190Ssaidi@eecs.umich.edu 1148965Sandreas.hansson@arm.com /** Get the port id. */ 1159031Sandreas.hansson@arm.com PortID getId() const { return id; } 1168965Sandreas.hansson@arm.com 1178922Swilliam.wang@arm.com}; 1188922Swilliam.wang@arm.com 1198922Swilliam.wang@arm.com/** Forward declaration */ 1209294Sandreas.hansson@arm.comclass BaseSlavePort; 1219294Sandreas.hansson@arm.com 1229294Sandreas.hansson@arm.com/** 1239294Sandreas.hansson@arm.com * A BaseMasterPort is a protocol-agnostic master port, responsible 1249294Sandreas.hansson@arm.com * only for the structural connection to a slave port. The final 1259294Sandreas.hansson@arm.com * master port that inherits from the base class must override the 1269294Sandreas.hansson@arm.com * bind member function for the specific slave port class. 1279294Sandreas.hansson@arm.com */ 1289294Sandreas.hansson@arm.comclass BaseMasterPort : public Port 1299294Sandreas.hansson@arm.com{ 1309294Sandreas.hansson@arm.com 1319294Sandreas.hansson@arm.com protected: 1329294Sandreas.hansson@arm.com 1339294Sandreas.hansson@arm.com BaseSlavePort* _baseSlavePort; 1349294Sandreas.hansson@arm.com 1359294Sandreas.hansson@arm.com BaseMasterPort(const std::string& name, MemObject* owner, 1369294Sandreas.hansson@arm.com PortID id = InvalidPortID); 1379294Sandreas.hansson@arm.com virtual ~BaseMasterPort(); 1389294Sandreas.hansson@arm.com 1399294Sandreas.hansson@arm.com public: 1409294Sandreas.hansson@arm.com 1419294Sandreas.hansson@arm.com virtual void bind(BaseSlavePort& slave_port) = 0; 1429294Sandreas.hansson@arm.com virtual void unbind() = 0; 1439294Sandreas.hansson@arm.com BaseSlavePort& getSlavePort() const; 1449294Sandreas.hansson@arm.com bool isConnected() const; 1459294Sandreas.hansson@arm.com 1469294Sandreas.hansson@arm.com}; 1479294Sandreas.hansson@arm.com 1489294Sandreas.hansson@arm.com/** 1499294Sandreas.hansson@arm.com * A BaseSlavePort is a protocol-agnostic slave port, responsible 1509294Sandreas.hansson@arm.com * only for the structural connection to a master port. 1519294Sandreas.hansson@arm.com */ 1529294Sandreas.hansson@arm.comclass BaseSlavePort : public Port 1539294Sandreas.hansson@arm.com{ 1549294Sandreas.hansson@arm.com 1559294Sandreas.hansson@arm.com protected: 1569294Sandreas.hansson@arm.com 1579294Sandreas.hansson@arm.com BaseMasterPort* _baseMasterPort; 1589294Sandreas.hansson@arm.com 1599294Sandreas.hansson@arm.com BaseSlavePort(const std::string& name, MemObject* owner, 1609294Sandreas.hansson@arm.com PortID id = InvalidPortID); 1619294Sandreas.hansson@arm.com virtual ~BaseSlavePort(); 1629294Sandreas.hansson@arm.com 1639294Sandreas.hansson@arm.com public: 1649294Sandreas.hansson@arm.com 1659294Sandreas.hansson@arm.com BaseMasterPort& getMasterPort() const; 1669294Sandreas.hansson@arm.com bool isConnected() const; 1679294Sandreas.hansson@arm.com 1689294Sandreas.hansson@arm.com}; 1699294Sandreas.hansson@arm.com 1709294Sandreas.hansson@arm.com/** Forward declaration */ 1718922Swilliam.wang@arm.comclass SlavePort; 1728922Swilliam.wang@arm.com 1738922Swilliam.wang@arm.com/** 1749294Sandreas.hansson@arm.com * A MasterPort is a specialisation of a BaseMasterPort, which 1759294Sandreas.hansson@arm.com * implements the default protocol for the three different level of 1769294Sandreas.hansson@arm.com * transport functions. In addition to the basic functionality of 1779294Sandreas.hansson@arm.com * sending packets, it also has functions to receive range changes or 1789294Sandreas.hansson@arm.com * determine if the port is snooping or not. 1798922Swilliam.wang@arm.com */ 1809294Sandreas.hansson@arm.comclass MasterPort : public BaseMasterPort 1818922Swilliam.wang@arm.com{ 1828922Swilliam.wang@arm.com 1838975Sandreas.hansson@arm.com friend class SlavePort; 1848975Sandreas.hansson@arm.com 1858922Swilliam.wang@arm.com private: 1868922Swilliam.wang@arm.com 1878922Swilliam.wang@arm.com SlavePort* _slavePort; 1888922Swilliam.wang@arm.com 1898922Swilliam.wang@arm.com public: 1908922Swilliam.wang@arm.com 1918965Sandreas.hansson@arm.com MasterPort(const std::string& name, MemObject* owner, 1929031Sandreas.hansson@arm.com PortID id = InvalidPortID); 1938922Swilliam.wang@arm.com virtual ~MasterPort(); 1948922Swilliam.wang@arm.com 1959178Sandreas.hansson@arm.com /** 1969178Sandreas.hansson@arm.com * Bind this master port to a slave port. This also does the 1979178Sandreas.hansson@arm.com * mirror action and binds the slave port to the master port. 1989178Sandreas.hansson@arm.com */ 1999294Sandreas.hansson@arm.com void bind(BaseSlavePort& slave_port); 2009178Sandreas.hansson@arm.com 2019178Sandreas.hansson@arm.com /** 2029178Sandreas.hansson@arm.com * Unbind this master port and the associated slave port. 2039178Sandreas.hansson@arm.com */ 2049178Sandreas.hansson@arm.com void unbind(); 2059178Sandreas.hansson@arm.com 2068922Swilliam.wang@arm.com /** 2078948Sandreas.hansson@arm.com * Send an atomic request packet, where the data is moved and the 2088948Sandreas.hansson@arm.com * state is updated in zero time, without interleaving with other 2098948Sandreas.hansson@arm.com * memory accesses. 2108948Sandreas.hansson@arm.com * 2118948Sandreas.hansson@arm.com * @param pkt Packet to send. 2128948Sandreas.hansson@arm.com * 2138948Sandreas.hansson@arm.com * @return Estimated latency of access. 2148948Sandreas.hansson@arm.com */ 2158948Sandreas.hansson@arm.com Tick sendAtomic(PacketPtr pkt); 2168948Sandreas.hansson@arm.com 2178948Sandreas.hansson@arm.com /** 2188948Sandreas.hansson@arm.com * Send a functional request packet, where the data is instantly 2198948Sandreas.hansson@arm.com * updated everywhere in the memory system, without affecting the 2208948Sandreas.hansson@arm.com * current state of any block or moving the block. 2218948Sandreas.hansson@arm.com * 2228948Sandreas.hansson@arm.com * @param pkt Packet to send. 2238948Sandreas.hansson@arm.com */ 2248948Sandreas.hansson@arm.com void sendFunctional(PacketPtr pkt); 2258948Sandreas.hansson@arm.com 2268948Sandreas.hansson@arm.com /** 2278975Sandreas.hansson@arm.com * Attempt to send a timing request to the slave port by calling 2288975Sandreas.hansson@arm.com * its corresponding receive function. If the send does not 2298975Sandreas.hansson@arm.com * succeed, as indicated by the return value, then the sender must 2308975Sandreas.hansson@arm.com * wait for a recvRetry at which point it can re-issue a 2318975Sandreas.hansson@arm.com * sendTimingReq. 2328975Sandreas.hansson@arm.com * 2338975Sandreas.hansson@arm.com * @param pkt Packet to send. 2348975Sandreas.hansson@arm.com * 2358975Sandreas.hansson@arm.com * @return If the send was succesful or not. 2368975Sandreas.hansson@arm.com */ 2378975Sandreas.hansson@arm.com bool sendTimingReq(PacketPtr pkt); 2388948Sandreas.hansson@arm.com 2398948Sandreas.hansson@arm.com /** 2408975Sandreas.hansson@arm.com * Attempt to send a timing snoop response packet to the slave 2418975Sandreas.hansson@arm.com * port by calling its corresponding receive function. If the send 2428975Sandreas.hansson@arm.com * does not succeed, as indicated by the return value, then the 2438975Sandreas.hansson@arm.com * sender must wait for a recvRetry at which point it can re-issue 2448975Sandreas.hansson@arm.com * a sendTimingSnoopResp. 2458975Sandreas.hansson@arm.com * 2468975Sandreas.hansson@arm.com * @param pkt Packet to send. 2478948Sandreas.hansson@arm.com */ 2488975Sandreas.hansson@arm.com bool sendTimingSnoopResp(PacketPtr pkt); 2498922Swilliam.wang@arm.com 2508922Swilliam.wang@arm.com /** 2519087Sandreas.hansson@arm.com * Send a retry to the slave port that previously attempted a 2529087Sandreas.hansson@arm.com * sendTimingResp to this master port and failed. 2539087Sandreas.hansson@arm.com */ 2549087Sandreas.hansson@arm.com void sendRetry(); 2559087Sandreas.hansson@arm.com 2569087Sandreas.hansson@arm.com /** 2578922Swilliam.wang@arm.com * Determine if this master port is snooping or not. The default 2588711Sandreas.hansson@arm.com * implementation returns false and thus tells the neighbour we 2598922Swilliam.wang@arm.com * are not snooping. Any master port that wants to receive snoop 2608922Swilliam.wang@arm.com * requests (e.g. a cache connected to a bus) has to override this 2618922Swilliam.wang@arm.com * function. 2628711Sandreas.hansson@arm.com * 2638711Sandreas.hansson@arm.com * @return true if the port should be considered a snooper 2648711Sandreas.hansson@arm.com */ 2658922Swilliam.wang@arm.com virtual bool isSnooping() const { return false; } 2662381SN/A 2678711Sandreas.hansson@arm.com /** 2688922Swilliam.wang@arm.com * Called by a peer port in order to determine the block size of 2698922Swilliam.wang@arm.com * the owner of this port. 2708711Sandreas.hansson@arm.com */ 2718922Swilliam.wang@arm.com virtual unsigned deviceBlockSize() const { return 0; } 2722381SN/A 2732381SN/A /** Called by the associated device if it wishes to find out the blocksize 2742381SN/A of the device on attached to the peer port. 2752381SN/A */ 2768922Swilliam.wang@arm.com unsigned peerBlockSize() const; 2772381SN/A 2789089Sandreas.hansson@arm.com /** 2799089Sandreas.hansson@arm.com * Get the address ranges of the connected slave port. 2809089Sandreas.hansson@arm.com */ 2819089Sandreas.hansson@arm.com AddrRangeList getAddrRanges() const; 2829089Sandreas.hansson@arm.com 2835314Sstever@gmail.com /** Inject a PrintReq for the given address to print the state of 2845314Sstever@gmail.com * that address throughout the memory system. For debugging. 2855314Sstever@gmail.com */ 2865314Sstever@gmail.com void printAddr(Addr a); 2878975Sandreas.hansson@arm.com 2888975Sandreas.hansson@arm.com protected: 2898975Sandreas.hansson@arm.com 2908975Sandreas.hansson@arm.com /** 2918975Sandreas.hansson@arm.com * Receive an atomic snoop request packet from the slave port. 2928975Sandreas.hansson@arm.com */ 2938975Sandreas.hansson@arm.com virtual Tick recvAtomicSnoop(PacketPtr pkt) 2948975Sandreas.hansson@arm.com { 2958975Sandreas.hansson@arm.com panic("%s was not expecting an atomic snoop request\n", name()); 2968975Sandreas.hansson@arm.com return 0; 2978975Sandreas.hansson@arm.com } 2988975Sandreas.hansson@arm.com 2998975Sandreas.hansson@arm.com /** 3008975Sandreas.hansson@arm.com * Receive a functional snoop request packet from the slave port. 3018975Sandreas.hansson@arm.com */ 3028975Sandreas.hansson@arm.com virtual void recvFunctionalSnoop(PacketPtr pkt) 3038975Sandreas.hansson@arm.com { 3048975Sandreas.hansson@arm.com panic("%s was not expecting a functional snoop request\n", name()); 3058975Sandreas.hansson@arm.com } 3068975Sandreas.hansson@arm.com 3078975Sandreas.hansson@arm.com /** 3088975Sandreas.hansson@arm.com * Receive a timing response from the slave port. 3098975Sandreas.hansson@arm.com */ 3108975Sandreas.hansson@arm.com virtual bool recvTimingResp(PacketPtr pkt) = 0; 3118975Sandreas.hansson@arm.com 3128975Sandreas.hansson@arm.com /** 3138975Sandreas.hansson@arm.com * Receive a timing snoop request from the slave port. 3148975Sandreas.hansson@arm.com */ 3158975Sandreas.hansson@arm.com virtual void recvTimingSnoopReq(PacketPtr pkt) 3168975Sandreas.hansson@arm.com { 3178975Sandreas.hansson@arm.com panic("%s was not expecting a timing snoop request\n", name()); 3188975Sandreas.hansson@arm.com } 3198975Sandreas.hansson@arm.com 3208975Sandreas.hansson@arm.com /** 3219087Sandreas.hansson@arm.com * Called by the slave port if sendTimingReq or 3229087Sandreas.hansson@arm.com * sendTimingSnoopResp was called on this master port (causing 3239087Sandreas.hansson@arm.com * recvTimingReq and recvTimingSnoopResp to be called on the 3249087Sandreas.hansson@arm.com * slave port) and was unsuccesful. 3259087Sandreas.hansson@arm.com */ 3269087Sandreas.hansson@arm.com virtual void recvRetry() = 0; 3279087Sandreas.hansson@arm.com 3289087Sandreas.hansson@arm.com /** 3298975Sandreas.hansson@arm.com * Called to receive an address range change from the peer slave 3309325Sandreas.hansson@arm.com * port. The default implementation ignores the change and does 3318975Sandreas.hansson@arm.com * nothing. Override this function in a derived class if the owner 3329325Sandreas.hansson@arm.com * needs to be aware of the address ranges, e.g. in an 3338975Sandreas.hansson@arm.com * interconnect component like a bus. 3348975Sandreas.hansson@arm.com */ 3358975Sandreas.hansson@arm.com virtual void recvRangeChange() { } 3362381SN/A}; 3372381SN/A 3388922Swilliam.wang@arm.com/** 3398922Swilliam.wang@arm.com * A SlavePort is a specialisation of a port. In addition to the 3408922Swilliam.wang@arm.com * basic functionality of sending packets to its master peer, it also 3418922Swilliam.wang@arm.com * has functions specific to a slave, e.g. to send range changes 3428922Swilliam.wang@arm.com * and get the address ranges that the port responds to. 3438922Swilliam.wang@arm.com */ 3449294Sandreas.hansson@arm.comclass SlavePort : public BaseSlavePort 3458922Swilliam.wang@arm.com{ 3468922Swilliam.wang@arm.com 3478975Sandreas.hansson@arm.com friend class MasterPort; 3488975Sandreas.hansson@arm.com 3498922Swilliam.wang@arm.com private: 3508922Swilliam.wang@arm.com 3518922Swilliam.wang@arm.com MasterPort* _masterPort; 3528922Swilliam.wang@arm.com 3538922Swilliam.wang@arm.com public: 3548922Swilliam.wang@arm.com 3558965Sandreas.hansson@arm.com SlavePort(const std::string& name, MemObject* owner, 3569031Sandreas.hansson@arm.com PortID id = InvalidPortID); 3578922Swilliam.wang@arm.com virtual ~SlavePort(); 3588922Swilliam.wang@arm.com 3598922Swilliam.wang@arm.com /** 3608948Sandreas.hansson@arm.com * Send an atomic snoop request packet, where the data is moved 3618948Sandreas.hansson@arm.com * and the state is updated in zero time, without interleaving 3628948Sandreas.hansson@arm.com * with other memory accesses. 3638948Sandreas.hansson@arm.com * 3648948Sandreas.hansson@arm.com * @param pkt Snoop packet to send. 3658948Sandreas.hansson@arm.com * 3668948Sandreas.hansson@arm.com * @return Estimated latency of access. 3678948Sandreas.hansson@arm.com */ 3688948Sandreas.hansson@arm.com Tick sendAtomicSnoop(PacketPtr pkt); 3698948Sandreas.hansson@arm.com 3708948Sandreas.hansson@arm.com /** 3718948Sandreas.hansson@arm.com * Send a functional snoop request packet, where the data is 3728948Sandreas.hansson@arm.com * instantly updated everywhere in the memory system, without 3738948Sandreas.hansson@arm.com * affecting the current state of any block or moving the block. 3748948Sandreas.hansson@arm.com * 3758948Sandreas.hansson@arm.com * @param pkt Snoop packet to send. 3768948Sandreas.hansson@arm.com */ 3778948Sandreas.hansson@arm.com void sendFunctionalSnoop(PacketPtr pkt); 3788948Sandreas.hansson@arm.com 3798948Sandreas.hansson@arm.com /** 3808975Sandreas.hansson@arm.com * Attempt to send a timing response to the master port by calling 3818975Sandreas.hansson@arm.com * its corresponding receive function. If the send does not 3828975Sandreas.hansson@arm.com * succeed, as indicated by the return value, then the sender must 3838975Sandreas.hansson@arm.com * wait for a recvRetry at which point it can re-issue a 3848975Sandreas.hansson@arm.com * sendTimingResp. 3858975Sandreas.hansson@arm.com * 3868975Sandreas.hansson@arm.com * @param pkt Packet to send. 3878975Sandreas.hansson@arm.com * 3888975Sandreas.hansson@arm.com * @return If the send was succesful or not. 3898975Sandreas.hansson@arm.com */ 3908975Sandreas.hansson@arm.com bool sendTimingResp(PacketPtr pkt); 3918948Sandreas.hansson@arm.com 3928948Sandreas.hansson@arm.com /** 3938975Sandreas.hansson@arm.com * Attempt to send a timing snoop request packet to the master port 3948975Sandreas.hansson@arm.com * by calling its corresponding receive function. Snoop requests 3958975Sandreas.hansson@arm.com * always succeed and hence no return value is needed. 3968975Sandreas.hansson@arm.com * 3978975Sandreas.hansson@arm.com * @param pkt Packet to send. 3988948Sandreas.hansson@arm.com */ 3998975Sandreas.hansson@arm.com void sendTimingSnoopReq(PacketPtr pkt); 4008948Sandreas.hansson@arm.com 4018948Sandreas.hansson@arm.com /** 4029087Sandreas.hansson@arm.com * Send a retry to the master port that previously attempted a 4039087Sandreas.hansson@arm.com * sendTimingReq or sendTimingSnoopResp to this slave port and 4049087Sandreas.hansson@arm.com * failed. 4059087Sandreas.hansson@arm.com */ 4069087Sandreas.hansson@arm.com void sendRetry(); 4079087Sandreas.hansson@arm.com 4089087Sandreas.hansson@arm.com /** 4098922Swilliam.wang@arm.com * Called by a peer port in order to determine the block size of 4108922Swilliam.wang@arm.com * the owner of this port. 4118922Swilliam.wang@arm.com */ 4128922Swilliam.wang@arm.com virtual unsigned deviceBlockSize() const { return 0; } 4138922Swilliam.wang@arm.com 4148922Swilliam.wang@arm.com /** Called by the associated device if it wishes to find out the blocksize 4158922Swilliam.wang@arm.com of the device on attached to the peer port. 4168922Swilliam.wang@arm.com */ 4178922Swilliam.wang@arm.com unsigned peerBlockSize() const; 4188922Swilliam.wang@arm.com 4198922Swilliam.wang@arm.com /** 4209088Sandreas.hansson@arm.com * Find out if the peer master port is snooping or not. 4219088Sandreas.hansson@arm.com * 4229088Sandreas.hansson@arm.com * @return true if the peer master port is snooping 4239088Sandreas.hansson@arm.com */ 4249088Sandreas.hansson@arm.com bool isSnooping() const { return _masterPort->isSnooping(); } 4259088Sandreas.hansson@arm.com 4269088Sandreas.hansson@arm.com /** 4278922Swilliam.wang@arm.com * Called by the owner to send a range change 4288922Swilliam.wang@arm.com */ 4298922Swilliam.wang@arm.com void sendRangeChange() const { _masterPort->recvRangeChange(); } 4308922Swilliam.wang@arm.com 4318922Swilliam.wang@arm.com /** 4328922Swilliam.wang@arm.com * Get a list of the non-overlapping address ranges the owner is 4338922Swilliam.wang@arm.com * responsible for. All slave ports must override this function 4348922Swilliam.wang@arm.com * and return a populated list with at least one item. 4358922Swilliam.wang@arm.com * 4368922Swilliam.wang@arm.com * @return a list of ranges responded to 4378922Swilliam.wang@arm.com */ 4389090Sandreas.hansson@arm.com virtual AddrRangeList getAddrRanges() const = 0; 4398975Sandreas.hansson@arm.com 4408975Sandreas.hansson@arm.com protected: 4418975Sandreas.hansson@arm.com 4428975Sandreas.hansson@arm.com /** 4439178Sandreas.hansson@arm.com * Called by the master port to unbind. Should never be called 4449178Sandreas.hansson@arm.com * directly. 4459178Sandreas.hansson@arm.com */ 4469178Sandreas.hansson@arm.com void unbind(); 4479178Sandreas.hansson@arm.com 4489178Sandreas.hansson@arm.com /** 4499178Sandreas.hansson@arm.com * Called by the master port to bind. Should never be called 4509178Sandreas.hansson@arm.com * directly. 4519178Sandreas.hansson@arm.com */ 4529178Sandreas.hansson@arm.com void bind(MasterPort& master_port); 4539178Sandreas.hansson@arm.com 4549178Sandreas.hansson@arm.com /** 4558975Sandreas.hansson@arm.com * Receive an atomic request packet from the master port. 4568975Sandreas.hansson@arm.com */ 4578975Sandreas.hansson@arm.com virtual Tick recvAtomic(PacketPtr pkt) = 0; 4588975Sandreas.hansson@arm.com 4598975Sandreas.hansson@arm.com /** 4608975Sandreas.hansson@arm.com * Receive a functional request packet from the master port. 4618975Sandreas.hansson@arm.com */ 4628975Sandreas.hansson@arm.com virtual void recvFunctional(PacketPtr pkt) = 0; 4638975Sandreas.hansson@arm.com 4648975Sandreas.hansson@arm.com /** 4658975Sandreas.hansson@arm.com * Receive a timing request from the master port. 4668975Sandreas.hansson@arm.com */ 4678975Sandreas.hansson@arm.com virtual bool recvTimingReq(PacketPtr pkt) = 0; 4688975Sandreas.hansson@arm.com 4698975Sandreas.hansson@arm.com /** 4708975Sandreas.hansson@arm.com * Receive a timing snoop response from the master port. 4718975Sandreas.hansson@arm.com */ 4728975Sandreas.hansson@arm.com virtual bool recvTimingSnoopResp(PacketPtr pkt) 4738975Sandreas.hansson@arm.com { 4748975Sandreas.hansson@arm.com panic("%s was not expecting a timing snoop response\n", name()); 4758975Sandreas.hansson@arm.com } 4768975Sandreas.hansson@arm.com 4779087Sandreas.hansson@arm.com /** 4789087Sandreas.hansson@arm.com * Called by the master port if sendTimingResp was called on this 4799087Sandreas.hansson@arm.com * slave port (causing recvTimingResp to be called on the master 4809087Sandreas.hansson@arm.com * port) and was unsuccesful. 4819087Sandreas.hansson@arm.com */ 4829087Sandreas.hansson@arm.com virtual void recvRetry() = 0; 4839087Sandreas.hansson@arm.com 4848922Swilliam.wang@arm.com}; 4858922Swilliam.wang@arm.com 4862381SN/A#endif //__MEM_PORT_HH__ 487