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