etherbus.hh revision 4981 
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 __ETHERBUS_H__
36#define __ETHERBUS_H__
37
38#include "sim/eventq.hh"
39#include "dev/etherpkt.hh"
40#include "dev/etherobject.hh"
41#include "params/EtherBus.hh"
42#include "sim/sim_object.hh"
43
44class EtherDump;
45class EtherInt;
46class EtherBus : public EtherObject
47{
48  protected:
49    typedef std::list<EtherInt *> devlist_t;
50    devlist_t devlist;
51    double ticksPerByte;
52    bool loopback;
53
54  protected:
55    class DoneEvent : public Event
56    {
57      protected:
58        EtherBus *bus;
59
60      public:
61        DoneEvent(EventQueue *q, EtherBus *b)
62            : Event(q), bus(b) {}
63        virtual void process() { bus->txDone(); }
64        virtual const char *description() { return "ethernet bus completion"; }
65    };
66
67    DoneEvent event;
68    EthPacketPtr packet;
69    EtherInt *sender;
70    EtherDump *dump;
71
72  public:
73    typedef EtherBusParams Params;
74    EtherBus(const Params *p);
75    virtual ~EtherBus() {}
76
77    const Params *
78    params() const
79    {
80        return dynamic_cast<const Params *>(_params);
81    }
82
83    void txDone();
84    void reg(EtherInt *dev);
85    bool busy() const { return (bool)packet; }
86    bool send(EtherInt *sender, EthPacketPtr &packet);
87    virtual EtherInt *getEthPort(const std::string &if_name, int idx);
88};
89
90#endif // __ETHERBUS_H__
91