gem5  v21.1.0.2
port.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-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 
46 #ifndef __SIM_PORT_HH__
47 #define __SIM_PORT_HH__
48 
49 #include <cassert>
50 #include <ostream>
51 #include <string>
52 
53 #include "base/types.hh"
54 
55 namespace gem5
56 {
57 
61 class Port
62 {
63 
64  private:
65 
67  const std::string portName;
68 
69  protected:
70 
72 
73  [[noreturn]] void reportUnbound() const;
74 
79  const PortID id;
80 
85 
86 
90  bool _connected;
91 
98  Port(const std::string& _name, PortID _id);
99 
100  public:
101 
105  virtual ~Port();
106 
108  Port &getPeer() { return *_peer; }
109 
111  const std::string name() const { return portName; }
112 
114  PortID getId() const { return id; }
115 
117  virtual void
118  bind(Port &peer)
119  {
120  _peer = &peer;
121  _connected = true;
122  }
123 
125  virtual void
127  {
128  _peer = nullptr;
129  _connected = false;
130  }
131 
133  bool isConnected() const { return _connected; }
134 
136  void
138  {
139  assert(old);
140  assert(old->isConnected());
141  assert(!isConnected());
142  Port &peer = old->getPeer();
143  assert(peer.isConnected());
144 
145  // Disconnect the original binding.
146  old->unbind();
147  peer.unbind();
148 
149  // Connect the new binding.
150  peer.bind(*this);
151  bind(peer);
152  }
153 };
154 
155 static inline std::ostream &
156 operator << (std::ostream &os, const Port &port)
157 {
158  os << port.name();
159  return os;
160 }
161 
162 } // namespace gem5
163 
164 #endif //__SIM_PORT_HH__
gem5::operator<<
std::ostream & operator<<(std::ostream &os, const ArmSemihosting::InPlaceArg &ipa)
Definition: semihosting.cc:1045
gem5::PortID
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:252
gem5::Port::getPeer
Port & getPeer()
Return a reference to this port's peer.
Definition: port.hh:108
gem5::Port::portName
const std::string portName
Descriptive name (for DPRINTF output)
Definition: port.hh:67
gem5::Port::getId
PortID getId() const
Get the port id.
Definition: port.hh:114
gem5::Port::name
const std::string name() const
Return port name (for DPRINTF).
Definition: port.hh:111
gem5::Port::reportUnbound
void reportUnbound() const
Definition: port.cc:60
gem5::Port::~Port
virtual ~Port()
Virtual destructor due to inheritance.
Definition: port.cc:56
gem5::Port::id
const PortID id
A numeric identifier to distinguish ports in a vector, and set to InvalidPortID in case this port is ...
Definition: port.hh:79
gem5::Port::takeOverFrom
void takeOverFrom(Port *old)
A utility function to make it easier to swap out ports.
Definition: port.hh:137
gem5::Port::bind
virtual void bind(Port &peer)
Attach to a peer port.
Definition: port.hh:118
gem5::Port::_peer
Port * _peer
A pointer to this port's peer.
Definition: port.hh:84
gem5::Port::isConnected
bool isConnected() const
Is this port currently connected to a peer?
Definition: port.hh:133
gem5::Port::unbind
virtual void unbind()
Dettach from a peer port.
Definition: port.hh:126
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
types.hh
gem5::X86ISA::os
Bitfield< 17 > os
Definition: misc.hh:809
gem5::Port::UnboundPortException
Definition: port.hh:71
gem5::Port::_connected
bool _connected
Whether this port is currently connected to a peer port.
Definition: port.hh:90
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::Port::Port
Port(const std::string &_name, PortID _id)
Abstract base class for ports.
Definition: port.cc:53

Generated on Tue Sep 21 2021 12:25:34 for gem5 by doxygen 1.8.17