etherlink.hh revision 2 
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 a fixed bandwidth full duplex ethernet link
31 */
32
33#ifndef __ETHERLINK_HH__
34#define __ETHERLINK_HH__
35
36#include "host.hh"
37#include "eventq.hh"
38#include "etherint.hh"
39#include "etherpkt.hh"
40#include "sim_object.hh"
41
42class EtherDump;
43
44/*
45 * Model for a fixed bandwidth full duplex ethernet link
46 */
47class EtherLink : public SimObject
48{
49  protected:
50    class Interface;
51
52     /*
53      * Model for a single uni-directional link
54      */
55    class Link : public Serializeable {
56      protected:
57        Interface *txint;
58        Interface *rxint;
59
60        double ticks_per_byte;
61        EtherDump *dump;
62
63      protected:
64        /*
65         * Transfer is complete
66         */
67        class DoneEvent : public Event
68        {
69          protected:
70            Link *link;
71
72          public:
73            DoneEvent(EventQueue *q, Link *l)
74                : Event(q), link(l) {}
75            virtual void process() { link->txDone(); }
76            virtual const char *description()
77                { return "ethernet link completion"; }
78        };
79
80        friend class DoneEvent;
81        DoneEvent event;
82        PacketPtr packet;
83
84        void txDone();
85
86      public:
87        Link(const std::string &name, double rate, EtherDump *dump);
88        ~Link() {}
89
90        bool busy() const { return (bool)packet; }
91        bool transmit(PacketPtr packet);
92
93        void setTxInt(Interface *i) { assert(!txint); txint = i; }
94        void setRxInt(Interface *i) { assert(!rxint); rxint = i; }
95    };
96
97    /*
98     * Interface at each end of the link
99     */
100    class Interface : public EtherInt
101    {
102      private:
103        Link *txlink;
104
105      public:
106        Interface(const std::string &name, Link *txlink, Link *rxlink);
107        bool recvPacket(PacketPtr packet) { return txlink->transmit(packet); }
108        void sendDone() { }
109    };
110
111    Link *link1;
112    Link *link2;
113
114    EtherInt *int1;
115    EtherInt *int2;
116
117  public:
118    EtherLink(const std::string &name, EtherInt *i1, EtherInt *i2,
119              Tick speed, EtherDump *dump);
120    virtual ~EtherLink();
121};
122
123#endif // __ETHERLINK_HH__
124