etherdevice.hh revision 5485 
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 "base/statistics.hh"
40#include "dev/pcidev.hh"
41#include "params/EtherDevice.hh"
42#include "sim/sim_object.hh"
43
44class EtherInt;
45
46/**
47 * The base EtherObject class, allows for an accesor function to a
48 * simobj that returns the Port.
49 */
50class EtherDevice : public PciDev
51{
52  public:
53    typedef EtherDeviceParams Params;
54    EtherDevice(const Params *params)
55        : PciDev(params)
56    {}
57
58    const Params *
59    params() const
60    {
61        return dynamic_cast<const Params *>(_params);
62    }
63
64  public:
65    /** Additional function to return the Port of a memory object. */
66    virtual EtherInt *getEthPort(const std::string &if_name, int idx = -1) = 0;
67
68  public:
69    void regStats();
70
71  protected:
72    Stats::Scalar<> txBytes;
73    Stats::Scalar<> rxBytes;
74    Stats::Scalar<> txPackets;
75    Stats::Scalar<> rxPackets;
76    Stats::Scalar<> txIpChecksums;
77    Stats::Scalar<> rxIpChecksums;
78    Stats::Scalar<> txTcpChecksums;
79    Stats::Scalar<> rxTcpChecksums;
80    Stats::Scalar<> txUdpChecksums;
81    Stats::Scalar<> rxUdpChecksums;
82    Stats::Scalar<> descDmaReads;
83    Stats::Scalar<> descDmaWrites;
84    Stats::Scalar<> descDmaRdBytes;
85    Stats::Scalar<> descDmaWrBytes;
86    Stats::Formula totBandwidth;
87    Stats::Formula totPackets;
88    Stats::Formula totBytes;
89    Stats::Formula totPacketRate;
90    Stats::Formula txBandwidth;
91    Stats::Formula rxBandwidth;
92    Stats::Formula txPacketRate;
93    Stats::Formula rxPacketRate;
94    Stats::Scalar<> postedSwi;
95    Stats::Formula coalescedSwi;
96    Stats::Scalar<> totalSwi;
97    Stats::Scalar<> postedRxIdle;
98    Stats::Formula coalescedRxIdle;
99    Stats::Scalar<> totalRxIdle;
100    Stats::Scalar<> postedRxOk;
101    Stats::Formula coalescedRxOk;
102    Stats::Scalar<> totalRxOk;
103    Stats::Scalar<> postedRxDesc;
104    Stats::Formula coalescedRxDesc;
105    Stats::Scalar<> totalRxDesc;
106    Stats::Scalar<> postedTxOk;
107    Stats::Formula coalescedTxOk;
108    Stats::Scalar<> totalTxOk;
109    Stats::Scalar<> postedTxIdle;
110    Stats::Formula coalescedTxIdle;
111    Stats::Scalar<> totalTxIdle;
112    Stats::Scalar<> postedTxDesc;
113    Stats::Formula coalescedTxDesc;
114    Stats::Scalar<> totalTxDesc;
115    Stats::Scalar<> postedRxOrn;
116    Stats::Formula coalescedRxOrn;
117    Stats::Scalar<> totalRxOrn;
118    Stats::Formula coalescedTotal;
119    Stats::Scalar<> postedInterrupts;
120    Stats::Scalar<> droppedPackets;
121};
122
123#endif //__DEV_ETHERDEVICE_HH__
124