intdev.hh revision 7913:70b56a9ac1b2 
1/*
2 * Copyright (c) 2008 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: Gabe Black
29 */
30
31#ifndef __DEV_X86_INTDEV_HH__
32#define __DEV_X86_INTDEV_HH__
33
34#include <cassert>
35#include <string>
36
37#include "arch/x86/x86_traits.hh"
38#include "arch/x86/intmessage.hh"
39#include "mem/mem_object.hh"
40#include "mem/mport.hh"
41#include "sim/sim_object.hh"
42#include "params/X86IntSourcePin.hh"
43#include "params/X86IntSinkPin.hh"
44#include "params/X86IntLine.hh"
45
46#include <list>
47
48namespace X86ISA {
49
50typedef std::list<int> ApicList;
51
52class IntDev
53{
54  protected:
55    class IntPort : public MessagePort
56    {
57        IntDev * device;
58        Tick latency;
59        Addr intAddr;
60      public:
61        IntPort(const std::string &_name, MemObject * _parent,
62                IntDev *dev, Tick _latency) :
63            MessagePort(_name, _parent), device(dev), latency(_latency)
64        {
65        }
66
67        void getDeviceAddressRanges(AddrRangeList &resp, bool &snoop)
68        {
69            snoop = false;
70            device->getIntAddrRange(resp);
71        }
72
73        Tick recvMessage(PacketPtr pkt)
74        {
75            return device->recvMessage(pkt);
76        }
77
78        Tick recvResponse(PacketPtr pkt)
79        {
80            return device->recvResponse(pkt);
81        }
82
83        // This is x86 focused, so if this class becomes generic, this would
84        // need to be moved into a subclass.
85        void sendMessage(ApicList apics,
86                TriggerIntMessage message, bool timing);
87    };
88
89    IntPort * intPort;
90
91  public:
92    IntDev(MemObject * parent, Tick latency = 0)
93    {
94        if (parent != NULL) {
95            intPort = new IntPort(parent->name() + ".int_port",
96                    parent, this, latency);
97        } else {
98            intPort = NULL;
99        }
100    }
101
102    virtual ~IntDev()
103    {}
104
105    virtual void init();
106
107    virtual void
108    signalInterrupt(int line)
109    {
110        panic("signalInterrupt not implemented.\n");
111    }
112
113    virtual void
114    raiseInterruptPin(int number)
115    {
116        panic("raiseInterruptPin not implemented.\n");
117    }
118
119    virtual void
120    lowerInterruptPin(int number)
121    {
122        panic("lowerInterruptPin not implemented.\n");
123    }
124
125    virtual Tick
126    recvMessage(PacketPtr pkt)
127    {
128        panic("recvMessage not implemented.\n");
129        return 0;
130    }
131
132    virtual Tick
133    recvResponse(PacketPtr pkt)
134    {
135        return 0;
136    }
137
138    virtual void
139    getIntAddrRange(AddrRangeList &range_list)
140    {
141        panic("intAddrRange not implemented.\n");
142    }
143};
144
145class IntSinkPin : public SimObject
146{
147  public:
148    IntDev * device;
149    int number;
150
151    typedef X86IntSinkPinParams Params;
152
153    const Params *
154    params() const
155    {
156        return dynamic_cast<const Params *>(_params);
157    }
158
159    IntSinkPin(Params *p) : SimObject(p),
160            device(dynamic_cast<IntDev *>(p->device)), number(p->number)
161    {
162        assert(device);
163    }
164};
165
166class IntSourcePin : public SimObject
167{
168  protected:
169    std::vector<IntSinkPin *> sinks;
170
171  public:
172    typedef X86IntSourcePinParams Params;
173
174    const Params *
175    params() const
176    {
177        return dynamic_cast<const Params *>(_params);
178    }
179
180    void
181    addSink(IntSinkPin *sink)
182    {
183        sinks.push_back(sink);
184    }
185
186    void
187    raise()
188    {
189        for (int i = 0; i < sinks.size(); i++) {
190            const IntSinkPin &pin = *sinks[i];
191            pin.device->raiseInterruptPin(pin.number);
192        }
193    }
194
195    void
196    lower()
197    {
198        for (int i = 0; i < sinks.size(); i++) {
199            const IntSinkPin &pin = *sinks[i];
200            pin.device->lowerInterruptPin(pin.number);
201        }
202    }
203
204    IntSourcePin(Params *p) : SimObject(p)
205    {}
206};
207
208class IntLine : public SimObject
209{
210  protected:
211    IntSourcePin *source;
212    IntSinkPin *sink;
213
214  public:
215    typedef X86IntLineParams Params;
216
217    const Params *
218    params() const
219    {
220        return dynamic_cast<const Params *>(_params);
221    }
222
223    IntLine(Params *p) : SimObject(p), source(p->source), sink(p->sink)
224    {
225        source->addSink(sink);
226    }
227};
228
229} // namespace X86ISA
230
231#endif //__DEV_X86_INTDEV_HH__
232