etherint.hh revision 2566 
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
29/* @file
30 * Class representing the actual interface between two ethernet
31 * components.
32 */
33
34#ifndef __DEV_ETHERINT_HH__
35#define __DEV_ETHERINT_HH__
36
37#include <string>
38
39#include "dev/etherpkt.hh"
40#include "sim/sim_object.hh"
41
42/*
43 * Class representing the actual interface between two ethernet
44 * components.  These components are intended to attach to another
45 * ethernet interface on one side and whatever device on the other.
46 */
47class EtherInt : public SimObject
48{
49  protected:
50    EtherInt *peer;
51
52  public:
53    EtherInt(const std::string &name) : SimObject(name), peer(NULL) {}
54    virtual ~EtherInt() {}
55
56    void setPeer(EtherInt *p);
57
58    void recvDone() { peer->sendDone(); }
59    virtual void sendDone() = 0;
60
61    bool sendPacket(EthPacketPtr packet)
62    { return peer ? peer->recvPacket(packet) : true; }
63    virtual bool recvPacket(EthPacketPtr packet) = 0;
64};
65
66#endif // __DEV_ETHERINT_HH__
67