src/mem/port.cc

   1 /*
   2  * Copyright (c) 2012,2015 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) 2002-2005 The Regents of The University of Michigan
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions are
  19  * met: redistributions of source code must retain the above copyright
  20  * notice, this list of conditions and the following disclaimer;
  21  * redistributions in binary form must reproduce the above copyright
  22  * notice, this list of conditions and the following disclaimer in the
  23  * documentation and/or other materials provided with the distribution;
  24  * neither the name of the copyright holders nor the names of its
  25  * contributors may be used to endorse or promote products derived from
  26  * this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  *
  40  * Authors: Steve Reinhardt
  41  *          Andreas Hansson
  42  *          William Wang
  43  */
  44
  45 /**
  46  * @file
  47  * Port object definitions.
  48  */
  49 #include "base/trace.hh"
  50 #include "mem/mem_object.hh"
  51 #include "mem/port.hh"
  52
  53 Port::Port(const std::string &_name, MemObject& _owner, PortID _id)
  54     : portName(_name), id(_id), owner(_owner)
  55 {
  56 }
  57
  58 Port::~Port()
  59 {
  60 }
  61
  62 BaseMasterPort::BaseMasterPort(const std::string& name, MemObject* owner,
  63                                PortID _id)
  64     : Port(name, *owner, _id), _baseSlavePort(NULL)
  65 {
  66 }
  67
  68 BaseMasterPort::~BaseMasterPort()
  69 {
  70 }
  71
  72 BaseSlavePort&
  73 BaseMasterPort::getSlavePort() const
  74 {
  75     if(_baseSlavePort == NULL)
  76         panic("Cannot getSlavePort on master port %s that is not connected\n",
  77               name());
  78
  79     return *_baseSlavePort;
  80 }
  81
  82 bool
  83 BaseMasterPort::isConnected() const
  84 {
  85     return _baseSlavePort != NULL;
  86 }
  87
  88 BaseSlavePort::BaseSlavePort(const std::string& name, MemObject* owner,
  89                              PortID _id)
  90     : Port(name, *owner, _id), _baseMasterPort(NULL)
  91 {
  92 }
  93
  94 BaseSlavePort::~BaseSlavePort()
  95 {
  96 }
  97
  98 BaseMasterPort&
  99 BaseSlavePort::getMasterPort() const
 100 {
 101     if(_baseMasterPort == NULL)
 102         panic("Cannot getMasterPort on slave port %s that is not connected\n",
 103               name());
 104
 105     return *_baseMasterPort;
 106 }
 107
 108 bool
 109 BaseSlavePort::isConnected() const
 110 {
 111     return _baseMasterPort != NULL;
 112 }
 113
 114 /**
 115  * Master port
 116  */
 117 MasterPort::MasterPort(const std::string& name, MemObject* owner, PortID _id)
 118     : BaseMasterPort(name, owner, _id), _slavePort(NULL)
 119 {
 120 }
 121
 122 MasterPort::~MasterPort()
 123 {
 124 }
 125
 126 void
 127 MasterPort::bind(BaseSlavePort& slave_port)
 128 {
 129     // bind on the level of the base ports
 130     _baseSlavePort = &slave_port;
 131
 132     // also attempt to base the slave to the appropriate type
 133     SlavePort* cast_slave_port = dynamic_cast<SlavePort*>(&slave_port);
 134
 135     // if this port is compatible, then proceed with the binding
 136     if (cast_slave_port != NULL) {
 137         // master port keeps track of the slave port
 138         _slavePort = cast_slave_port;
 139         // slave port also keeps track of master port
 140         _slavePort->bind(*this);
 141     } else {
 142         fatal("Master port %s cannot bind to %s\n", name(),
 143               slave_port.name());
 144     }
 145 }
 146
 147 void
 148 MasterPort::unbind()
 149 {
 150     if (_slavePort == NULL)
 151         panic("Attempting to unbind master port %s that is not connected\n",
 152               name());
 153     _slavePort->unbind();
 154     _slavePort = NULL;
 155     _baseSlavePort = NULL;
 156 }
 157
 158 AddrRangeList
 159 MasterPort::getAddrRanges() const
 160 {
 161     return _slavePort->getAddrRanges();
 162 }
 163
 164 Tick
 165 MasterPort::sendAtomic(PacketPtr pkt)
 166 {
 167     assert(pkt->isRequest());
 168     return _slavePort->recvAtomic(pkt);
 169 }
 170
 171 void
 172 MasterPort::sendFunctional(PacketPtr pkt)
 173 {
 174     assert(pkt->isRequest());
 175     return _slavePort->recvFunctional(pkt);
 176 }
 177
 178 bool
 179 MasterPort::sendTimingReq(PacketPtr pkt)
 180 {
 181     assert(pkt->isRequest());
 182     return _slavePort->recvTimingReq(pkt);
 183 }
 184
 185 bool
 186 MasterPort::sendTimingSnoopResp(PacketPtr pkt)
 187 {
 188     assert(pkt->isResponse());
 189     return _slavePort->recvTimingSnoopResp(pkt);
 190 }
 191
 192 void
 193 MasterPort::sendRetryResp()
 194 {
 195     _slavePort->recvRespRetry();
 196 }
 197
 198 void
 199 MasterPort::printAddr(Addr a)
 200 {
 201     Request req(a, 1, 0, Request::funcMasterId);
 202     Packet pkt(&req, MemCmd::PrintReq);
 203     Packet::PrintReqState prs(std::cerr);
 204     pkt.senderState = &prs;
 205
 206     sendFunctional(&pkt);
 207 }
 208
 209 /**
 210  * Slave port
 211  */
 212 SlavePort::SlavePort(const std::string& name, MemObject* owner, PortID id)
 213     : BaseSlavePort(name, owner, id), _masterPort(NULL)
 214 {
 215 }
 216
 217 SlavePort::~SlavePort()
 218 {
 219 }
 220
 221 void
 222 SlavePort::unbind()
 223 {
 224     _baseMasterPort = NULL;
 225     _masterPort = NULL;
 226 }
 227
 228 void
 229 SlavePort::bind(MasterPort& master_port)
 230 {
 231     _baseMasterPort = &master_port;
 232     _masterPort = &master_port;
 233 }
 234
 235 Tick
 236 SlavePort::sendAtomicSnoop(PacketPtr pkt)
 237 {
 238     assert(pkt->isRequest());
 239     return _masterPort->recvAtomicSnoop(pkt);
 240 }
 241
 242 void
 243 SlavePort::sendFunctionalSnoop(PacketPtr pkt)
 244 {
 245     assert(pkt->isRequest());
 246     return _masterPort->recvFunctionalSnoop(pkt);
 247 }
 248
 249 bool
 250 SlavePort::sendTimingResp(PacketPtr pkt)
 251 {
 252     assert(pkt->isResponse());
 253     return _masterPort->recvTimingResp(pkt);
 254 }
 255
 256 void
 257 SlavePort::sendTimingSnoopReq(PacketPtr pkt)
 258 {
 259     assert(pkt->isRequest());
 260     _masterPort->recvTimingSnoopReq(pkt);
 261 }
 262
 263 void
 264 SlavePort::sendRetryReq()
 265 {
 266     _masterPort->recvReqRetry();
 267 }
 268
 269 void
 270 SlavePort::sendRetrySnoopResp()
 271 {
 272     _masterPort->recvRetrySnoopResp();
 273 }