src/dev/etherdevice.hh

   1 /*
   2  * Copyright (c) 2007 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: Ali Saidi
  29  */
  30
  31 /**
  32  * @file
  33  * Base Ethernet Device declaration.
  34  */
  35
  36 #ifndef __DEV_ETHERDEVICE_HH__
  37 #define __DEV_ETHERDEVICE_HH__
  38
  39 #include "dev/pcidev.hh"
  40 #include "params/EtherDevice.hh"
  41 #include "sim/sim_object.hh"
  42
  43 class EtherInt;
  44
  45 /**
  46  * The base EtherObject class, allows for an accesor function to a
  47  * simobj that returns the Port.
  48  */
  49 class EtherDevice : public PciDev
  50 {
  51   public:
  52     typedef EtherDeviceParams Params;
  53     EtherDevice(const Params *params)
  54         : PciDev(params)
  55     {}
  56
  57     const Params *
  58     params() const
  59     {
  60         return dynamic_cast<const Params *>(_params);
  61     }
  62
  63   public:
  64     /** Additional function to return the Port of a memory object. */
  65     virtual EtherInt *getEthPort(const std::string &if_name, int idx = -1) = 0;
  66
  67 };
  68
  69 #endif //__DEV_ETHERDEVICE_HH__