gem5  v19.0.0.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
port.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012,2015,2017 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 
49 #include "mem/port.hh"
50 
51 #include "base/trace.hh"
52 #include "sim/sim_object.hh"
53 
57 MasterPort::MasterPort(const std::string& name, SimObject* _owner, PortID _id)
58  : Port(name, _id), _slavePort(NULL), owner(*_owner)
59 {
60 }
61 
63 {
64 }
65 
66 void
68 {
69  auto *slave_port = dynamic_cast<SlavePort *>(&peer);
70  if (!slave_port) {
71  fatal("Attempt to bind port %s to non-slave port %s.",
72  name(), peer.name());
73  }
74  // master port keeps track of the slave port
75  _slavePort = slave_port;
76  Port::bind(peer);
77  // slave port also keeps track of master port
78  _slavePort->slaveBind(*this);
79 }
80 
81 void
83 {
84  if (_slavePort == NULL)
85  panic("Attempting to unbind master port %s that is not connected\n",
86  name());
88  _slavePort = nullptr;
89  Port::unbind();
90 }
91 
94 {
95  return _slavePort->getAddrRanges();
96 }
97 
98 void
100 {
101  auto req = std::make_shared<Request>(
102  a, 1, 0, Request::funcMasterId);
103 
104  Packet pkt(req, MemCmd::PrintReq);
105  Packet::PrintReqState prs(std::cerr);
106  pkt.senderState = &prs;
107 
108  sendFunctional(&pkt);
109 }
110 
114 SlavePort::SlavePort(const std::string& name, SimObject* _owner, PortID id)
115  : Port(name, id), _masterPort(NULL), defaultBackdoorWarned(false),
116  owner(*_owner)
117 {
118 }
119 
121 {
122 }
123 
124 void
126 {
127  _masterPort = NULL;
128  Port::unbind();
129 }
130 
131 void
133 {
134  _masterPort = &master_port;
135  Port::bind(master_port);
136 }
137 
138 Tick
140 {
141  if (!defaultBackdoorWarned) {
142  warn("Port %s doesn't support requesting a back door.", name());
143  defaultBackdoorWarned = true;
144  }
145  return recvAtomic(pkt);
146 }
A MasterPort is a specialisation of a BaseMasterPort, which implements the default protocol for the t...
Definition: port.hh:75
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:167
Ports are used to interface objects to each other.
Definition: port.hh:60
#define fatal(...)
This implements a cprintf based fatal() function.
Definition: logging.hh:175
const std::string & name()
Definition: trace.cc:54
Object used to maintain state of a PrintReq.
Definition: packet.hh:414
void slaveUnbind()
Called by the master port to unbind.
Definition: port.cc:125
bool defaultBackdoorWarned
Definition: port.hh:265
Bitfield< 8 > a
A SlavePort is a specialisation of a port.
Definition: port.hh:258
MasterPort * _masterPort
Definition: port.hh:264
SlavePort(const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
Slave port.
Definition: port.cc:114
MasterPort(const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
Master port.
Definition: port.cc:57
Tick recvAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor) override
Default implementations.
Definition: port.cc:139
SlavePort * _slavePort
Definition: port.hh:81
virtual ~SlavePort()
Definition: port.cc:120
virtual void unbind()
Dettach from a peer port.
Definition: port.hh:121
uint64_t Tick
Tick count type.
Definition: types.hh:63
SimObject & owner
Definition: port.hh:84
Port Object Declaration.
void bind(Port &peer) override
Bind this master port to a slave port.
Definition: port.cc:67
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:142
void printAddr(Addr a)
Inject a PrintReq for the given address to print the state of that address throughout the memory syst...
Definition: port.cc:99
A Packet is used to encapsulate a transfer between two objects in the memory system (e...
Definition: packet.hh:255
virtual Tick recvAtomic(PacketPtr pkt)=0
Receive an atomic request packet from the peer.
This master id is used for functional requests that don&#39;t come from a particular device.
Definition: request.hh:212
void slaveBind(MasterPort &master_port)
Called by the master port to bind.
Definition: port.cc:132
virtual ~MasterPort()
Definition: port.cc:62
AddrRangeList getAddrRanges() const
Get the address ranges of the connected slave port.
Definition: port.cc:93
virtual AddrRangeList getAddrRanges() const =0
Get a list of the non-overlapping address ranges the owner is responsible for.
virtual void bind(Port &peer)
Attach to a peer port.
Definition: port.hh:113
const std::string name() const
Return port name (for DPRINTF).
Definition: port.hh:106
void sendFunctional(PacketPtr pkt) const
Send a functional request packet, where the data is instantly updated everywhere in the memory system...
Definition: port.hh:439
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:237
void unbind() override
Unbind this master port and the associated slave port.
Definition: port.cc:82
#define warn(...)
Definition: logging.hh:212
Abstract superclass for simulation objects.
Definition: sim_object.hh:96

Generated on Fri Feb 28 2020 16:27:02 for gem5 by doxygen 1.8.13