src/dev/net/etherbus.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  * Device module for modelling an ethernet hub
  33  */
  34
  35 #ifndef __DEV_NET_ETHERBUS_HH__
  36 #define __DEV_NET_ETHERBUS_HH__
  37
  38 #include "dev/net/etherpkt.hh"
  39 #include "params/EtherBus.hh"
  40 #include "sim/eventq.hh"
  41 #include "sim/sim_object.hh"
  42
  43 class EtherDump;
  44 class EtherInt;
  45 class EtherBus : public SimObject
  46 {
  47   protected:
  48     typedef std::list<EtherInt *> devlist_t;
  49     devlist_t devlist;
  50     double ticksPerByte;
  51     bool loopback;
  52
  53   protected:
  54     EventFunctionWrapper event;
  55     EthPacketPtr packet;
  56     EtherInt *sender;
  57     EtherDump *dump;
  58
  59   public:
  60     typedef EtherBusParams Params;
  61     EtherBus(const Params *p);
  62     virtual ~EtherBus() {}
  63
  64     const Params *
  65     params() const
  66     {
  67         return dynamic_cast<const Params *>(_params);
  68     }
  69
  70     void txDone();
  71     void reg(EtherInt *dev);
  72     bool busy() const { return (bool)packet; }
  73     bool send(EtherInt *sender, EthPacketPtr &packet);
  74     Port &getPort(const std::string &if_name,
  75                   PortID idx=InvalidPortID) override;
  76 };
  77
  78 #endif // __DEV_NET_ETHERBUS_HH__