gem5  v21.1.0.2
etherint.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2002-2005 The Regents of The University of Michigan
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met: redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer;
9  * redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution;
12  * neither the name of the copyright holders nor the names of its
13  * contributors may be used to endorse or promote products derived from
14  * this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /* @file
30  * Class representing the actual interface between two ethernet
31  * components.
32  */
33 
34 #ifndef __DEV_NET_ETHERINT_HH__
35 #define __DEV_NET_ETHERINT_HH__
36 
37 #include <string>
38 
39 #include "dev/net/etherpkt.hh"
40 #include "mem/port.hh"
41 
42 namespace gem5
43 {
44 
45 /*
46  * Class representing the actual interface between two ethernet
47  * components. These components are intended to attach to another
48  * ethernet interface on one side and whatever device on the other.
49  */
50 class EtherInt : public Port
51 {
52  protected:
53  mutable std::string portName;
55 
56  public:
57  EtherInt(const std::string &name, int idx=InvalidPortID)
58  : Port(name, idx), portName(name), peer(NULL) {}
59  virtual ~EtherInt() {}
60 
62  const std::string &name() const { return portName; }
63 
64  void bind(Port &peer) override;
65  void unbind() override;
66 
67  void setPeer(EtherInt *p);
68  EtherInt* getPeer() { return peer; }
69 
70  void recvDone() { peer->sendDone(); }
71  virtual void sendDone() = 0;
72 
73  bool sendPacket(EthPacketPtr packet)
74  { return peer ? peer->recvPacket(packet) : true; }
75  virtual bool recvPacket(EthPacketPtr packet) = 0;
76 
77  bool askBusy() {return peer->isBusy(); }
78  virtual bool isBusy() { return false; }
79 };
80 
81 } // namespace gem5
82 
83 #endif // __DEV_NET_ETHERINT_HH__
gem5::EtherInt::askBusy
bool askBusy()
Definition: etherint.hh:77
gem5::EtherInt::setPeer
void setPeer(EtherInt *p)
Definition: etherint.cc:57
gem5::EtherInt::name
const std::string & name() const
Return port name (for DPRINTF).
Definition: etherint.hh:62
gem5::EtherInt::sendPacket
bool sendPacket(EthPacketPtr packet)
Definition: etherint.hh:73
gem5::EtherInt::bind
void bind(Port &peer) override
Attach to a peer port.
Definition: etherint.cc:38
gem5::EtherInt
Definition: etherint.hh:50
gem5::InvalidPortID
const PortID InvalidPortID
Definition: types.hh:253
gem5::EtherInt::~EtherInt
virtual ~EtherInt()
Definition: etherint.hh:59
gem5::EtherInt::recvDone
void recvDone()
Definition: etherint.hh:70
gem5::EthPacketPtr
std::shared_ptr< EthPacketData > EthPacketPtr
Definition: etherpkt.hh:90
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
port.hh
gem5::EtherInt::portName
std::string portName
Definition: etherint.hh:53
gem5::EtherInt::recvPacket
virtual bool recvPacket(EthPacketPtr packet)=0
gem5::EtherInt::peer
EtherInt * peer
Definition: etherint.hh:54
gem5::EtherInt::getPeer
EtherInt * getPeer()
Definition: etherint.hh:68
gem5::EtherInt::sendDone
virtual void sendDone()=0
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
etherpkt.hh
gem5::EtherInt::unbind
void unbind() override
Dettach from a peer port.
Definition: etherint.cc:50
gem5::EtherInt::isBusy
virtual bool isBusy()
Definition: etherint.hh:78
gem5::EtherInt::EtherInt
EtherInt(const std::string &name, int idx=InvalidPortID)
Definition: etherint.hh:57
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40

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