intdev.hh (9557:8666e81607a6) intdev.hh (9807:63d7362bbdf2)
1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2008 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Gabe Black
41 */
42
43#ifndef __DEV_X86_INTDEV_HH__
44#define __DEV_X86_INTDEV_HH__
45
46#include <cassert>
47#include <list>
48#include <string>
49
50#include "arch/x86/intmessage.hh"
51#include "arch/x86/x86_traits.hh"
52#include "mem/mem_object.hh"
53#include "mem/mport.hh"
54#include "params/X86IntLine.hh"
55#include "params/X86IntSinkPin.hh"
56#include "params/X86IntSourcePin.hh"
57#include "sim/sim_object.hh"
58
59namespace X86ISA {
60
61typedef std::list<int> ApicList;
62
1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2008 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Gabe Black
41 */
42
43#ifndef __DEV_X86_INTDEV_HH__
44#define __DEV_X86_INTDEV_HH__
45
46#include <cassert>
47#include <list>
48#include <string>
49
50#include "arch/x86/intmessage.hh"
51#include "arch/x86/x86_traits.hh"
52#include "mem/mem_object.hh"
53#include "mem/mport.hh"
54#include "params/X86IntLine.hh"
55#include "params/X86IntSinkPin.hh"
56#include "params/X86IntSourcePin.hh"
57#include "sim/sim_object.hh"
58
59namespace X86ISA {
60
61typedef std::list<int> ApicList;
62
63class IntDev
63class IntDevice
64{
65 protected:
66 class IntSlavePort : public MessageSlavePort
67 {
64{
65 protected:
66 class IntSlavePort : public MessageSlavePort
67 {
68 IntDev * device;
68 IntDevice * device;
69
70 public:
71 IntSlavePort(const std::string& _name, MemObject* _parent,
69
70 public:
71 IntSlavePort(const std::string& _name, MemObject* _parent,
72 IntDev* dev) :
72 IntDevice* dev) :
73 MessageSlavePort(_name, _parent), device(dev)
74 {
75 }
76
77 AddrRangeList getAddrRanges() const
78 {
79 return device->getIntAddrRange();
80 }
81
82 Tick recvMessage(PacketPtr pkt)
83 {
84 // @todo someone should pay for this
85 pkt->busFirstWordDelay = pkt->busLastWordDelay = 0;
86 return device->recvMessage(pkt);
87 }
88 };
89
90 class IntMasterPort : public MessageMasterPort
91 {
73 MessageSlavePort(_name, _parent), device(dev)
74 {
75 }
76
77 AddrRangeList getAddrRanges() const
78 {
79 return device->getIntAddrRange();
80 }
81
82 Tick recvMessage(PacketPtr pkt)
83 {
84 // @todo someone should pay for this
85 pkt->busFirstWordDelay = pkt->busLastWordDelay = 0;
86 return device->recvMessage(pkt);
87 }
88 };
89
90 class IntMasterPort : public MessageMasterPort
91 {
92 IntDev* device;
92 IntDevice* device;
93 Tick latency;
94 public:
95 IntMasterPort(const std::string& _name, MemObject* _parent,
93 Tick latency;
94 public:
95 IntMasterPort(const std::string& _name, MemObject* _parent,
96 IntDev* dev, Tick _latency) :
96 IntDevice* dev, Tick _latency) :
97 MessageMasterPort(_name, _parent), device(dev), latency(_latency)
98 {
99 }
100
101 Tick recvResponse(PacketPtr pkt)
102 {
103 return device->recvResponse(pkt);
104 }
105
106 // This is x86 focused, so if this class becomes generic, this would
107 // need to be moved into a subclass.
108 void sendMessage(ApicList apics,
109 TriggerIntMessage message, bool timing);
110 };
111
112 IntMasterPort intMasterPort;
113
114 public:
97 MessageMasterPort(_name, _parent), device(dev), latency(_latency)
98 {
99 }
100
101 Tick recvResponse(PacketPtr pkt)
102 {
103 return device->recvResponse(pkt);
104 }
105
106 // This is x86 focused, so if this class becomes generic, this would
107 // need to be moved into a subclass.
108 void sendMessage(ApicList apics,
109 TriggerIntMessage message, bool timing);
110 };
111
112 IntMasterPort intMasterPort;
113
114 public:
115 IntDev(MemObject * parent, Tick latency = 0) :
115 IntDevice(MemObject * parent, Tick latency = 0) :
116 intMasterPort(parent->name() + ".int_master", parent, this, latency)
117 {
118 }
119
116 intMasterPort(parent->name() + ".int_master", parent, this, latency)
117 {
118 }
119
120 virtual ~IntDev()
120 virtual ~IntDevice()
121 {}
122
123 virtual void init();
124
125 virtual void
126 signalInterrupt(int line)
127 {
128 panic("signalInterrupt not implemented.\n");
129 }
130
131 virtual void
132 raiseInterruptPin(int number)
133 {
134 panic("raiseInterruptPin not implemented.\n");
135 }
136
137 virtual void
138 lowerInterruptPin(int number)
139 {
140 panic("lowerInterruptPin not implemented.\n");
141 }
142
143 virtual Tick
144 recvMessage(PacketPtr pkt)
145 {
146 panic("recvMessage not implemented.\n");
147 return 0;
148 }
149
150 virtual Tick
151 recvResponse(PacketPtr pkt)
152 {
153 return 0;
154 }
155
156 virtual AddrRangeList
157 getIntAddrRange() const
158 {
159 panic("intAddrRange not implemented.\n");
160 }
161};
162
163class IntSinkPin : public SimObject
164{
165 public:
121 {}
122
123 virtual void init();
124
125 virtual void
126 signalInterrupt(int line)
127 {
128 panic("signalInterrupt not implemented.\n");
129 }
130
131 virtual void
132 raiseInterruptPin(int number)
133 {
134 panic("raiseInterruptPin not implemented.\n");
135 }
136
137 virtual void
138 lowerInterruptPin(int number)
139 {
140 panic("lowerInterruptPin not implemented.\n");
141 }
142
143 virtual Tick
144 recvMessage(PacketPtr pkt)
145 {
146 panic("recvMessage not implemented.\n");
147 return 0;
148 }
149
150 virtual Tick
151 recvResponse(PacketPtr pkt)
152 {
153 return 0;
154 }
155
156 virtual AddrRangeList
157 getIntAddrRange() const
158 {
159 panic("intAddrRange not implemented.\n");
160 }
161};
162
163class IntSinkPin : public SimObject
164{
165 public:
166 IntDev * device;
166 IntDevice * device;
167 int number;
168
169 typedef X86IntSinkPinParams Params;
170
171 const Params *
172 params() const
173 {
174 return dynamic_cast<const Params *>(_params);
175 }
176
177 IntSinkPin(Params *p) : SimObject(p),
167 int number;
168
169 typedef X86IntSinkPinParams Params;
170
171 const Params *
172 params() const
173 {
174 return dynamic_cast<const Params *>(_params);
175 }
176
177 IntSinkPin(Params *p) : SimObject(p),
178 device(dynamic_cast(p->device)), number(p->number)
178 device(dynamic_cast<IntDevice *>(p->device)), number(p->number)
179 {
180 assert(device);
181 }
182};
183
184class IntSourcePin : public SimObject
185{
186 protected:
187 std::vector<IntSinkPin *> sinks;
188
189 public:
190 typedef X86IntSourcePinParams Params;
191
192 const Params *
193 params() const
194 {
195 return dynamic_cast<const Params *>(_params);
196 }
197
198 void
199 addSink(IntSinkPin *sink)
200 {
201 sinks.push_back(sink);
202 }
203
204 void
205 raise()
206 {
207 for (int i = 0; i < sinks.size(); i++) {
208 const IntSinkPin &pin = *sinks[i];
209 pin.device->raiseInterruptPin(pin.number);
210 }
211 }
212
213 void
214 lower()
215 {
216 for (int i = 0; i < sinks.size(); i++) {
217 const IntSinkPin &pin = *sinks[i];
218 pin.device->lowerInterruptPin(pin.number);
219 }
220 }
221
222 IntSourcePin(Params *p) : SimObject(p)
223 {}
224};
225
226class IntLine : public SimObject
227{
228 protected:
229 IntSourcePin *source;
230 IntSinkPin *sink;
231
232 public:
233 typedef X86IntLineParams Params;
234
235 const Params *
236 params() const
237 {
238 return dynamic_cast<const Params *>(_params);
239 }
240
241 IntLine(Params *p) : SimObject(p), source(p->source), sink(p->sink)
242 {
243 source->addSink(sink);
244 }
245};
246
247} // namespace X86ISA
248
249#endif //__DEV_X86_INTDEV_HH__
179 {
180 assert(device);
181 }
182};
183
184class IntSourcePin : public SimObject
185{
186 protected:
187 std::vector<IntSinkPin *> sinks;
188
189 public:
190 typedef X86IntSourcePinParams Params;
191
192 const Params *
193 params() const
194 {
195 return dynamic_cast<const Params *>(_params);
196 }
197
198 void
199 addSink(IntSinkPin *sink)
200 {
201 sinks.push_back(sink);
202 }
203
204 void
205 raise()
206 {
207 for (int i = 0; i < sinks.size(); i++) {
208 const IntSinkPin &pin = *sinks[i];
209 pin.device->raiseInterruptPin(pin.number);
210 }
211 }
212
213 void
214 lower()
215 {
216 for (int i = 0; i < sinks.size(); i++) {
217 const IntSinkPin &pin = *sinks[i];
218 pin.device->lowerInterruptPin(pin.number);
219 }
220 }
221
222 IntSourcePin(Params *p) : SimObject(p)
223 {}
224};
225
226class IntLine : public SimObject
227{
228 protected:
229 IntSourcePin *source;
230 IntSinkPin *sink;
231
232 public:
233 typedef X86IntLineParams Params;
234
235 const Params *
236 params() const
237 {
238 return dynamic_cast<const Params *>(_params);
239 }
240
241 IntLine(Params *p) : SimObject(p), source(p->source), sink(p->sink)
242 {
243 source->addSink(sink);
244 }
245};
246
247} // namespace X86ISA
248
249#endif //__DEV_X86_INTDEV_HH__