etherbus.hh revision 56 
1/*
2 * Copyright (c) 2003 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
29/* @file
30 * Device module for modelling an ethernet hub
31 */
32
33#ifndef __ETHERBUS_H__
34#define __ETHERBUS_H__
35
36#include "sim/eventq.hh"
37#include "dev/etherpkt.hh"
38#include "sim/sim_object.hh"
39
40class EtherDump;
41class EtherInt;
42class EtherBus : public SimObject
43{
44  protected:
45    typedef std::list<EtherInt *> devlist_t;
46    devlist_t devlist;
47    double ticks_per_byte;
48    bool loopback;
49
50  protected:
51    class DoneEvent : public Event
52    {
53      protected:
54        EtherBus *bus;
55
56      public:
57        DoneEvent(EventQueue *q, EtherBus *b)
58            : Event(q), bus(b) {}
59        virtual void process() { bus->txDone(); }
60        virtual const char *description() { return "ethernet bus completion"; }
61    };
62
63    DoneEvent event;
64    PacketPtr packet;
65    EtherInt *sender;
66    EtherDump *dump;
67
68  public:
69    EtherBus(const std::string &name, double ticks_per_byte, bool loopback,
70             EtherDump *dump);
71    virtual ~EtherBus() {}
72
73    void txDone();
74    void reg(EtherInt *dev);
75    bool busy() const { return (bool)packet; }
76    bool send(EtherInt *sender, PacketPtr packet);
77};
78
79#endif // __ETHERBUS_H__
80