src/mem/port.cc

   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) 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 /**
  63  * Master port
  64  */
  65 MasterPort::MasterPort(const std::string& name, MemObject* owner, PortID _id)
  66     : Port(name, *owner, _id), _slavePort(NULL)
  67 {
  68 }
  69
  70 MasterPort::~MasterPort()
  71 {
  72 }
  73
  74 SlavePort&
  75 MasterPort::getSlavePort() const
  76 {
  77     if(_slavePort == NULL)
  78         panic("Cannot getSlavePort on master port %s that is not connected\n",
  79               name());
  80
  81     return *_slavePort;
  82 }
  83
  84 void
  85 MasterPort::unbind()
  86 {
  87     if (_slavePort == NULL)
  88         panic("Attempting to unbind master port %s that is not connected\n",
  89               name());
  90     _slavePort->unbind();
  91     _slavePort = NULL;
  92 }
  93
  94 void
  95 MasterPort::bind(SlavePort& slave_port)
  96 {
  97     if (_slavePort != NULL)
  98         panic("Attempting to bind master port %s that is already connected\n",
  99               name());
 100
 101     // master port keeps track of the slave port
 102     _slavePort = &slave_port;
 103
 104     // slave port also keeps track of master port
 105     _slavePort->bind(*this);
 106 }
 107
 108 bool
 109 MasterPort::isConnected() const
 110 {
 111     return _slavePort != NULL;
 112 }
 113
 114 unsigned
 115 MasterPort::peerBlockSize() const
 116 {
 117     return _slavePort->deviceBlockSize();
 118 }
 119
 120 AddrRangeList
 121 MasterPort::getAddrRanges() const
 122 {
 123     return _slavePort->getAddrRanges();
 124 }
 125
 126 Tick
 127 MasterPort::sendAtomic(PacketPtr pkt)
 128 {
 129     assert(pkt->isRequest());
 130     return _slavePort->recvAtomic(pkt);
 131 }
 132
 133 void
 134 MasterPort::sendFunctional(PacketPtr pkt)
 135 {
 136     assert(pkt->isRequest());
 137     return _slavePort->recvFunctional(pkt);
 138 }
 139
 140 bool
 141 MasterPort::sendTimingReq(PacketPtr pkt)
 142 {
 143     assert(pkt->isRequest());
 144     return _slavePort->recvTimingReq(pkt);
 145 }
 146
 147 bool
 148 MasterPort::sendTimingSnoopResp(PacketPtr pkt)
 149 {
 150     assert(pkt->isResponse());
 151     return _slavePort->recvTimingSnoopResp(pkt);
 152 }
 153
 154 void
 155 MasterPort::sendRetry()
 156 {
 157     _slavePort->recvRetry();
 158 }
 159
 160 void
 161 MasterPort::printAddr(Addr a)
 162 {
 163     Request req(a, 1, 0, Request::funcMasterId);
 164     Packet pkt(&req, MemCmd::PrintReq);
 165     Packet::PrintReqState prs(std::cerr);
 166     pkt.senderState = &prs;
 167
 168     sendFunctional(&pkt);
 169 }
 170
 171 /**
 172  * Slave port
 173  */
 174 SlavePort::SlavePort(const std::string& name, MemObject* owner, PortID id)
 175     : Port(name, *owner, id), _masterPort(NULL)
 176 {
 177 }
 178
 179 SlavePort::~SlavePort()
 180 {
 181 }
 182
 183 void
 184 SlavePort::unbind()
 185 {
 186     _masterPort = NULL;
 187 }
 188
 189 void
 190 SlavePort::bind(MasterPort& master_port)
 191 {
 192     _masterPort = &master_port;
 193 }
 194
 195 MasterPort&
 196 SlavePort::getMasterPort() const
 197 {
 198     if (_masterPort == NULL)
 199         panic("Cannot getMasterPort on slave port %s that is not connected\n",
 200               name());
 201
 202     return *_masterPort;
 203 }
 204
 205 unsigned
 206 SlavePort::peerBlockSize() const
 207 {
 208     return _masterPort->deviceBlockSize();
 209 }
 210
 211 bool
 212 SlavePort::isConnected() const
 213 {
 214     return _masterPort != NULL;
 215 }
 216
 217 Tick
 218 SlavePort::sendAtomicSnoop(PacketPtr pkt)
 219 {
 220     assert(pkt->isRequest());
 221     return _masterPort->recvAtomicSnoop(pkt);
 222 }
 223
 224 void
 225 SlavePort::sendFunctionalSnoop(PacketPtr pkt)
 226 {
 227     assert(pkt->isRequest());
 228     return _masterPort->recvFunctionalSnoop(pkt);
 229 }
 230
 231 bool
 232 SlavePort::sendTimingResp(PacketPtr pkt)
 233 {
 234     assert(pkt->isResponse());
 235     return _masterPort->recvTimingResp(pkt);
 236 }
 237
 238 void
 239 SlavePort::sendTimingSnoopReq(PacketPtr pkt)
 240 {
 241     assert(pkt->isRequest());
 242     _masterPort->recvTimingSnoopReq(pkt);
 243 }
 244
 245 void
 246 SlavePort::sendRetry()
 247 {
 248     _masterPort->recvRetry();
 249 }