gem5  v21.1.0.2
etherlink.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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 
41 /* @file
42  * Device module for modelling a fixed bandwidth full duplex ethernet link
43  */
44 
45 #ifndef __DEV_NET_ETHERLINK_HH__
46 #define __DEV_NET_ETHERLINK_HH__
47 
48 #include <queue>
49 #include <utility>
50 
51 #include "base/types.hh"
52 #include "dev/net/etherint.hh"
53 #include "dev/net/etherpkt.hh"
54 #include "params/EtherLink.hh"
55 #include "sim/eventq.hh"
56 #include "sim/sim_object.hh"
57 
58 namespace gem5
59 {
60 
61 class EtherDump;
62 class Checkpoint;
63 /*
64  * Model for a fixed bandwidth full duplex ethernet link
65  */
66 class EtherLink : public SimObject
67 {
68  protected:
69  class Interface;
70 
71  /*
72  * Model for a single uni-directional link
73  */
74  class Link
75  {
76  protected:
77  const std::string objName;
78 
79  EtherLink *const parent;
80  const int number;
81 
84 
85  const double ticksPerByte;
86  const Tick linkDelay;
87  const Tick delayVar;
88  EtherDump *const dump;
89 
90  protected:
91  /*
92  * Transfer is complete
93  */
95  void txDone();
97 
104 
105  void processTxQueue();
107 
109 
110  public:
111  Link(const std::string &name, EtherLink *p, int num,
112  double rate, Tick delay, Tick delay_var, EtherDump *dump);
113  ~Link() {}
114 
115  const std::string name() const { return objName; }
116 
117  bool busy() const { return (bool)packet; }
119 
120  void setTxInt(Interface *i) { assert(!txint); txint = i; }
121  void setRxInt(Interface *i) { assert(!rxint); rxint = i; }
122 
123  void serialize(const std::string &base, CheckpointOut &cp) const;
124  void unserialize(const std::string &base, CheckpointIn &cp);
125  };
126 
127  /*
128  * Interface at each end of the link
129  */
130  class Interface : public EtherInt
131  {
132  private:
134 
135  public:
136  Interface(const std::string &name, Link *txlink, Link *rxlink);
137  bool recvPacket(EthPacketPtr packet) { return txlink->transmit(packet); }
138  void sendDone() { peer->sendDone(); }
139  bool isBusy() { return txlink->busy(); }
140  };
141 
142  Link *link[2];
144 
145  public:
146  using Params = EtherLinkParams;
147  EtherLink(const Params &p);
148  virtual ~EtherLink();
149 
150  Port &getPort(const std::string &if_name,
151  PortID idx=InvalidPortID) override;
152 
153  void serialize(CheckpointOut &cp) const override;
154  void unserialize(CheckpointIn &cp) override;
155 
156 };
157 
158 } // namespace gem5
159 
160 #endif // __DEV_NET_ETHERLINK_HH__
gem5::PortID
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:252
gem5::CheckpointIn
Definition: serialize.hh:68
etherint.hh
gem5::EtherInt::name
const std::string & name() const
Return port name (for DPRINTF).
Definition: etherint.hh:62
gem5::X86ISA::base
Bitfield< 51, 12 > base
Definition: pagetable.hh:141
gem5::EtherInt
Definition: etherint.hh:50
gem5::InvalidPortID
const PortID InvalidPortID
Definition: types.hh:253
gem5::ArmISA::i
Bitfield< 7 > i
Definition: misc_types.hh:66
gem5::EthPacketPtr
std::shared_ptr< EthPacketData > EthPacketPtr
Definition: etherpkt.hh:90
sim_object.hh
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::EtherDump
Definition: etherdump.hh:48
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::EtherInt::peer
EtherInt * peer
Definition: etherint.hh:54
gem5::EventFunctionWrapper
Definition: eventq.hh:1115
gem5::EtherInt::sendDone
virtual void sendDone()=0
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
types.hh
std::deque
STL deque class.
Definition: stl.hh:44
etherpkt.hh
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
eventq.hh

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