port.hh revision 14191:a8e387a87a28
16145SN/A/* 28257SN/A * Copyright (c) 2011-2012,2015,2017 ARM Limited 36145SN/A * All rights reserved 46145SN/A * 56145SN/A * The license below extends only to copyright in the software and shall 66145SN/A * not be construed as granting a license to any other intellectual 76145SN/A * property including but not limited to intellectual property relating 86145SN/A * to a hardware implementation of the functionality of the software 96145SN/A * licensed hereunder. You may use the software subject to the license 106145SN/A * terms below provided that you ensure that this notice is replicated 116145SN/A * unmodified and in its entirety in all distributions of the software, 126145SN/A * modified or unmodified, in source code or in binary form. 136145SN/A * 146145SN/A * Copyright (c) 2002-2005 The Regents of The University of Michigan 156145SN/A * All rights reserved. 166145SN/A * 176145SN/A * Redistribution and use in source and binary forms, with or without 186145SN/A * modification, are permitted provided that the following conditions are 196145SN/A * met: redistributions of source code must retain the above copyright 206145SN/A * notice, this list of conditions and the following disclaimer; 216145SN/A * redistributions in binary form must reproduce the above copyright 226145SN/A * notice, this list of conditions and the following disclaimer in the 236145SN/A * documentation and/or other materials provided with the distribution; 246145SN/A * neither the name of the copyright holders nor the names of its 256145SN/A * contributors may be used to endorse or promote products derived from 266145SN/A * this software without specific prior written permission. 276145SN/A * 286145SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2912492Sodanrc@yahoo.com.br * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3012492Sodanrc@yahoo.com.br * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 316145SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 327055SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 337055SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 347454SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 357055SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 368258SBrad.Beckmann@amd.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 378258SBrad.Beckmann@amd.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 388258SBrad.Beckmann@amd.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 396145SN/A * 408258SBrad.Beckmann@amd.com * Authors: Ron Dreslinski 417054SN/A * Andreas Hansson 427054SN/A * William Wang 438258SBrad.Beckmann@amd.com */ 448258SBrad.Beckmann@amd.com 458257SN/A/** 466145SN/A * @file 478258SBrad.Beckmann@amd.com * Port Object Declaration. 488257SN/A */ 496493SN/A 508257SN/A#ifndef __SIM_PORT_HH__ 516145SN/A#define __SIM_PORT_HH__ 526145SN/A 537055SN/A#include <string> 548258SBrad.Beckmann@amd.com 556145SN/A#include "base/types.hh" 567054SN/A 577055SN/A/** 587054SN/A * Ports are used to interface objects to each other. 596145SN/A */ 606145SN/Aclass Port 618258SBrad.Beckmann@amd.com{ 628257SN/A 638257SN/A private: 648258SBrad.Beckmann@amd.com 658258SBrad.Beckmann@amd.com /** Descriptive name (for DPRINTF output) */ 668257SN/A const std::string portName; 678257SN/A 688257SN/A protected: 698258SBrad.Beckmann@amd.com 708257SN/A /** 718258SBrad.Beckmann@amd.com * A numeric identifier to distinguish ports in a vector, and set 728257SN/A * to InvalidPortID in case this port is not part of a vector. 738257SN/A */ 748258SBrad.Beckmann@amd.com const PortID id; 758258SBrad.Beckmann@amd.com 768257SN/A /** 778258SBrad.Beckmann@amd.com * A pointer to this port's peer. 788258SBrad.Beckmann@amd.com */ 798258SBrad.Beckmann@amd.com Port *_peer; 808258SBrad.Beckmann@amd.com 818257SN/A 8212492Sodanrc@yahoo.com.br /** 83 * Whether this port is currently connected to a peer port. 84 */ 85 bool _connected; 86 87 /** 88 * Abstract base class for ports 89 * 90 * @param _name Port name including the owners name 91 * @param _id A port identifier for vector ports 92 */ 93 Port(const std::string& _name, PortID _id); 94 95 /** 96 * Virtual destructor due to inheritance. 97 */ 98 virtual ~Port(); 99 100 public: 101 102 /** Return a reference to this port's peer. */ 103 Port &getPeer() { return *_peer; } 104 105 /** Return port name (for DPRINTF). */ 106 const std::string name() const { return portName; } 107 108 /** Get the port id. */ 109 PortID getId() const { return id; } 110 111 /** Attach to a peer port. */ 112 virtual void 113 bind(Port &peer) 114 { 115 _peer = &peer; 116 _connected = true; 117 } 118 119 /** Dettach from a peer port. */ 120 virtual void 121 unbind() 122 { 123 _peer = nullptr; 124 _connected = false; 125 } 126 127 /** Is this port currently connected to a peer? */ 128 bool isConnected() const { return _connected; } 129 130 /** A utility function to make it easier to swap out ports. */ 131 void 132 takeOverFrom(Port *old) 133 { 134 assert(old); 135 assert(old->isConnected()); 136 assert(!isConnected()); 137 Port &peer = old->getPeer(); 138 assert(peer.isConnected()); 139 140 // Disconnect the original binding. 141 old->unbind(); 142 peer.unbind(); 143 144 // Connect the new binding. 145 peer.bind(*this); 146 bind(peer); 147 } 148}; 149 150static inline std::ostream & 151operator << (std::ostream &os, const Port &port) 152{ 153 os << port.name(); 154 return os; 155} 156 157#endif //__SIM_PORT_HH__ 158