etherlink.hh revision 6216 
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 a fixed bandwidth full duplex ethernet link
33 */
34
35#ifndef __DEV_ETHERLINK_HH__
36#define __DEV_ETHERLINK_HH__
37
38#include "base/types.hh"
39#include "dev/etherint.hh"
40#include "dev/etherobject.hh"
41#include "dev/etherpkt.hh"
42#include "params/EtherLink.hh"
43#include "params/EtherLink.hh"
44#include "sim/eventq.hh"
45#include "sim/sim_object.hh"
46
47class EtherDump;
48class Checkpoint;
49/*
50 * Model for a fixed bandwidth full duplex ethernet link
51 */
52class EtherLink : public EtherObject
53{
54  protected:
55    class Interface;
56
57    friend class LinkDelayEvent;
58     /*
59      * Model for a single uni-directional link
60      */
61    class Link
62    {
63      protected:
64        std::string objName;
65
66        EtherLink *parent;
67        int number;
68
69        Interface *txint;
70        Interface *rxint;
71
72        double ticksPerByte;
73        Tick linkDelay;
74        Tick delayVar;
75        EtherDump *dump;
76
77      protected:
78        /*
79         * Transfer is complete
80         */
81        EthPacketPtr packet;
82        void txDone();
83        typedef EventWrapper<Link, &Link::txDone> DoneEvent;
84        friend void DoneEvent::process();
85        DoneEvent doneEvent;
86
87        friend class LinkDelayEvent;
88        void txComplete(EthPacketPtr packet);
89
90      public:
91        Link(const std::string &name, EtherLink *p, int num,
92             double rate, Tick delay, Tick delay_var, EtherDump *dump);
93        ~Link() {}
94
95        const std::string name() const { return objName; }
96
97        bool busy() const { return (bool)packet; }
98        bool transmit(EthPacketPtr packet);
99
100        void setTxInt(Interface *i) { assert(!txint); txint = i; }
101        void setRxInt(Interface *i) { assert(!rxint); rxint = i; }
102
103        void serialize(const std::string &base, std::ostream &os);
104        void unserialize(const std::string &base, Checkpoint *cp,
105                                 const std::string &section);
106    };
107
108    /*
109     * Interface at each end of the link
110     */
111    class Interface : public EtherInt
112    {
113      private:
114        Link *txlink;
115
116      public:
117        Interface(const std::string &name, Link *txlink, Link *rxlink);
118        bool recvPacket(EthPacketPtr packet) { return txlink->transmit(packet); }
119        void sendDone() { peer->sendDone(); }
120        bool isBusy() { return txlink->busy(); }
121    };
122
123    Link *link[2];
124    Interface *interface[2];
125
126  public:
127    typedef EtherLinkParams Params;
128    EtherLink(const Params *p);
129    virtual ~EtherLink();
130
131    const Params *
132    params() const
133    {
134        return dynamic_cast<const Params *>(_params);
135    }
136
137    virtual EtherInt *getEthPort(const std::string &if_name, int idx);
138
139    virtual void serialize(std::ostream &os);
140    virtual void unserialize(Checkpoint *cp, const std::string &section);
141
142};
143
144#endif // __ETHERLINK_HH__
145