RubyPort.hh revision 10012:ec5a5bfb941d
1/* 2 * Copyright (c) 2012 ARM Limited 3 * All rights reserved. 4 * 5 * The license below extends only to copyright in the software and shall 6 * not be construed as granting a license to any other intellectual 7 * property including but not limited to intellectual property relating 8 * to a hardware implementation of the functionality of the software 9 * licensed hereunder. You may use the software subject to the license 10 * terms below provided that you ensure that this notice is replicated 11 * unmodified and in its entirety in all distributions of the software, 12 * modified or unmodified, in source code or in binary form. 13 * 14 * Copyright (c) 2009 Advanced Micro Devices, Inc. 15 * Copyright (c) 2011 Mark D. Hill and David A. Wood 16 * All rights reserved. 17 * 18 * Redistribution and use in source and binary forms, with or without 19 * modification, are permitted provided that the following conditions are 20 * met: redistributions of source code must retain the above copyright 21 * notice, this list of conditions and the following disclaimer; 22 * redistributions in binary form must reproduce the above copyright 23 * notice, this list of conditions and the following disclaimer in the 24 * documentation and/or other materials provided with the distribution; 25 * neither the name of the copyright holders nor the names of its 26 * contributors may be used to endorse or promote products derived from 27 * this software without specific prior written permission. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 40 */ 41 42#ifndef __MEM_RUBY_SYSTEM_RUBYPORT_HH__ 43#define __MEM_RUBY_SYSTEM_RUBYPORT_HH__ 44 45#include <cassert> 46#include <string> 47 48#include "mem/protocol/RequestStatus.hh" 49#include "mem/ruby/buffers/MessageBuffer.hh" 50#include "mem/ruby/system/System.hh" 51#include "mem/mem_object.hh" 52#include "mem/physical.hh" 53#include "mem/tport.hh" 54#include "params/RubyPort.hh" 55 56class AbstractController; 57 58class RubyPort : public MemObject 59{ 60 public: 61 class M5Port : public QueuedSlavePort 62 { 63 private: 64 65 SlavePacketQueue queue; 66 RubyPort *ruby_port; 67 RubySystem* ruby_system; 68 bool _onRetryList; 69 bool access_phys_mem; 70 71 public: 72 M5Port(const std::string &_name, RubyPort *_port, 73 RubySystem*_system, bool _access_phys_mem); 74 void hitCallback(PacketPtr pkt); 75 void evictionCallback(const Address& address); 76 77 bool onRetryList() 78 { return _onRetryList; } 79 80 void onRetryList(bool newVal) 81 { _onRetryList = newVal; } 82 83 protected: 84 virtual bool recvTimingReq(PacketPtr pkt); 85 virtual Tick recvAtomic(PacketPtr pkt); 86 virtual void recvFunctional(PacketPtr pkt); 87 virtual AddrRangeList getAddrRanges() const; 88 89 private: 90 bool isPhysMemAddress(Addr addr); 91 }; 92 93 friend class M5Port; 94 95 class PioPort : public QueuedMasterPort 96 { 97 private: 98 99 MasterPacketQueue queue; 100 101 public: 102 PioPort(const std::string &_name, RubyPort *_port); 103 104 protected: 105 virtual bool recvTimingResp(PacketPtr pkt); 106 }; 107 108 friend class PioPort; 109 110 struct SenderState : public Packet::SenderState 111 { 112 M5Port* port; 113 114 SenderState(M5Port* _port) : port(_port) 115 {} 116 }; 117 118 typedef RubyPortParams Params; 119 RubyPort(const Params *p); 120 virtual ~RubyPort() {} 121 122 void init(); 123 124 BaseMasterPort &getMasterPort(const std::string &if_name, 125 PortID idx = InvalidPortID); 126 BaseSlavePort &getSlavePort(const std::string &if_name, 127 PortID idx = InvalidPortID); 128 129 virtual RequestStatus makeRequest(PacketPtr pkt) = 0; 130 virtual int outstandingCount() const = 0; 131 virtual bool isDeadlockEventScheduled() const = 0; 132 virtual void descheduleDeadlockEvent() = 0; 133 134 // 135 // Called by the controller to give the sequencer a pointer. 136 // A pointer to the controller is needed for atomic support. 137 // 138 void setController(AbstractController* _cntrl) { m_controller = _cntrl; } 139 uint32_t getId() { return m_version; } 140 unsigned int drain(DrainManager *dm); 141 142 protected: 143 const std::string m_name; 144 void ruby_hit_callback(PacketPtr pkt); 145 void testDrainComplete(); 146 void ruby_eviction_callback(const Address& address); 147 148 uint32_t m_version; 149 AbstractController* m_controller; 150 MessageBuffer* m_mandatory_q_ptr; 151 PioPort pio_port; 152 bool m_usingRubyTester; 153 154 private: 155 void addToRetryList(M5Port * port) 156 { 157 if (!port->onRetryList()) { 158 port->onRetryList(true); 159 retryList.push_back(port); 160 waitingOnSequencer = true; 161 } 162 } 163 164 unsigned int getChildDrainCount(DrainManager *dm); 165 166 uint16_t m_port_id; 167 uint64_t m_request_cnt; 168 169 /** Vector of M5 Ports attached to this Ruby port. */ 170 typedef std::vector<M5Port*>::iterator CpuPortIter; 171 std::vector<M5Port*> slave_ports; 172 std::vector<PioPort*> master_ports; 173 174 DrainManager *drainManager; 175 176 RubySystem* ruby_system; 177 System* system; 178 179 // 180 // Based on similar code in the M5 bus. Stores pointers to those ports 181 // that should be called when the Sequencer becomes available after a stall. 182 // 183 std::list<M5Port*> retryList; 184 185 bool waitingOnSequencer; 186 bool access_phys_mem; 187}; 188 189#endif // __MEM_RUBY_SYSTEM_RUBYPORT_HH__ 190