src/dev/etherint.hh

   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  * Authors: Nathan Binkert
  29  */
  30
  31 /* @file
  32  * Class representing the actual interface between two ethernet
  33  * components.
  34  */
  35
  36 #ifndef __DEV_ETHERINT_HH__
  37 #define __DEV_ETHERINT_HH__
  38
  39 #include <string>
  40
  41 #include "dev/etherpkt.hh"
  42
  43 /*
  44  * Class representing the actual interface between two ethernet
  45  * components.  These components are intended to attach to another
  46  * ethernet interface on one side and whatever device on the other.
  47  */
  48 class EtherInt
  49 {
  50   protected:
  51     mutable std::string portName;
  52     EtherInt *peer;
  53
  54   public:
  55     EtherInt(const std::string &name)
  56         : portName(name), peer(NULL) {}
  57     virtual ~EtherInt() {}
  58
  59     /** Return port name (for DPRINTF). */
  60     const std::string &name() const { return portName; }
  61
  62     void setPeer(EtherInt *p);
  63     EtherInt* getPeer() { return peer; }
  64
  65     void recvDone() { peer->sendDone(); }
  66     virtual void sendDone() = 0;
  67
  68     bool sendPacket(EthPacketPtr packet)
  69     { return peer ? peer->recvPacket(packet) : true; }
  70     virtual bool recvPacket(EthPacketPtr packet) = 0;
  71
  72     bool askBusy() {return peer->isBusy(); }
  73     virtual bool isBusy() { return false; }
  74 };
  75
  76 #endif // __DEV_ETHERINT_HH__