dev/etherlink.hh

   1 /*
   2  * Copyright (c) 2002-2004 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  * Device module for modelling a fixed bandwidth full duplex ethernet link
  31  */
  32
  33 #ifndef __ETHERLINK_HH__
  34 #define __ETHERLINK_HH__
  35
  36 #include "sim/host.hh"
  37 #include "sim/eventq.hh"
  38 #include "dev/etherint.hh"
  39 #include "dev/etherpkt.hh"
  40 #include "sim/sim_object.hh"
  41
  42 class EtherDump;
  43
  44 /*
  45  * Model for a fixed bandwidth full duplex ethernet link
  46  */
  47 class EtherLink : public SimObject
  48 {
  49   protected:
  50     class Interface;
  51
  52     friend class LinkDelayEvent;
  53      /*
  54       * Model for a single uni-directional link
  55       */
  56     class Link : public Serializable {
  57       protected:
  58         std::string objName;
  59
  60         Interface *txint;
  61         Interface *rxint;
  62
  63         double ticksPerByte;
  64         Tick linkDelay;
  65         EtherDump *dump;
  66
  67       protected:
  68         /*
  69          * Transfer is complete
  70          */
  71         PacketPtr packet;
  72         void txDone();
  73         typedef EventWrapper<Link, &Link::txDone> DoneEvent;
  74         friend class DoneEvent;
  75         DoneEvent doneEvent;
  76
  77         friend class LinkDelayEvent;
  78         void txComplete(PacketPtr packet);
  79
  80       public:
  81         Link(const std::string &name, double rate, Tick delay,
  82              EtherDump *dump);
  83         ~Link() {}
  84
  85         virtual const std::string name() const { return objName; }
  86
  87         bool busy() const { return (bool)packet; }
  88         bool transmit(PacketPtr packet);
  89
  90         void setTxInt(Interface *i) { assert(!txint); txint = i; }
  91         void setRxInt(Interface *i) { assert(!rxint); rxint = i; }
  92
  93         virtual void serialize(std::ostream &os);
  94         virtual void unserialize(Checkpoint *cp, const std::string &section);
  95     };
  96
  97     /*
  98      * Interface at each end of the link
  99      */
 100     class Interface : public EtherInt
 101     {
 102       private:
 103         Link *txlink;
 104
 105       public:
 106         Interface(const std::string &name, Link *txlink, Link *rxlink);
 107         bool recvPacket(PacketPtr packet) { return txlink->transmit(packet); }
 108         void sendDone() { peer->sendDone(); }
 109     };
 110
 111     Link *link1;
 112     Link *link2;
 113
 114     EtherInt *int1;
 115     EtherInt *int2;
 116
 117   public:
 118     EtherLink(const std::string &name, EtherInt *i1, EtherInt *i2,
 119               Tick speed, Tick delay, EtherDump *dump);
 120     virtual ~EtherLink();
 121
 122     virtual void serialize(std::ostream &os);
 123     virtual void unserialize(Checkpoint *cp, const std::string &section);
 124
 125 };
 126
 127 #endif // __ETHERLINK_HH__