1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
3 * All rights reserved.
4 *
5 * Redistribution and use of this software in source and binary forms,
6 * with or without modification, are permitted provided that the
7 * following conditions are met:
8 *
9 * The software must be used only for Non-Commercial Use which means any
10 * use which is NOT directed to receiving any direct monetary
11 * compensation for, or commercial advantage from such use. Illustrative
12 * examples of non-commercial use are academic research, personal study,
13 * teaching, education and corporate research & development.
14 * Illustrative examples of commercial use are distributing products for
15 * commercial advantage and providing services using the software for
16 * commercial advantage.
17 *
18 * If you wish to use this software or functionality therein that may be
19 * covered by patents for commercial use, please contact:
20 * Director of Intellectual Property Licensing
21 * Office of Strategy and Technology
22 * Hewlett-Packard Company
23 * 1501 Page Mill Road
24 * Palo Alto, California 94304
25 *
26 * Redistributions of source code must retain the above copyright notice,
27 * this list of conditions and the following disclaimer. Redistributions
28 * in binary form must reproduce the above copyright notice, this list of
29 * conditions and the following disclaimer in the documentation and/or
30 * other materials provided with the distribution. Neither the name of
31 * the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
32 * contributors may be used to endorse or promote products derived from
33 * this software without specific prior written permission. No right of
34 * sublicense is granted herewith. Derivatives of the software and
35 * output created using the software may be prepared, but only for
36 * Non-Commercial Uses. Derivatives of the software may be shared with
37 * others provided: (i) the others agree to abide by the list of
38 * conditions herein which includes the Non-Commercial Use restrictions;
39 * and (ii) such Derivatives of the software include the above copyright
40 * notice to acknowledge the contribution from this software where
41 * applicable, this list of conditions and the disclaimer below.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 *
55 * Authors: Gabe Black
56 */
57
58#ifndef __ARCH_X86_INTERRUPTS_HH__
59#define __ARCH_X86_INTERRUPTS_HH__
60
61#include "arch/x86/apicregs.hh"
62#include "arch/x86/faults.hh"
63#include "arch/x86/intmessage.hh"
64#include "base/bitfield.hh"
65#include "cpu/thread_context.hh"
66#include "dev/io_device.hh"
67#include "dev/x86/intdev.hh"
68#include "params/X86LocalApic.hh"
69#include "sim/eventq.hh"
70
71class ThreadContext;
72class BaseCPU;
73
74namespace X86ISA {
75
76class Interrupts : public BasicPioDevice, IntDev
77{
78 protected:
79 // Storage for the APIC registers
80 uint32_t regs[NUM_APIC_REGS];
81
82 BitUnion32(LVTEntry)
83 Bitfield<7, 0> vector;
84 Bitfield<10, 8> deliveryMode;
85 Bitfield<12> status;
86 Bitfield<13> polarity;
87 Bitfield<14> remoteIRR;
88 Bitfield<15> trigger;
89 Bitfield<16> masked;
90 Bitfield<17> periodic;
91 EndBitUnion(LVTEntry)
92
93 /*
94 * Timing related stuff.
95 */
96 Tick latency;
97 Tick clock;
98
99 class ApicTimerEvent : public Event
100 {
101 private:
102 Interrupts *localApic;
103 public:
104 ApicTimerEvent(Interrupts *_localApic) :
105 Event(), localApic(_localApic)
106 {}
107
108 void process()
109 {
110 assert(localApic);
111 if (localApic->triggerTimerInterrupt()) {
112 localApic->setReg(APIC_INITIAL_COUNT,
113 localApic->readReg(APIC_INITIAL_COUNT));
114 }
115 }
116 };
117
118 ApicTimerEvent apicTimerEvent;
119
120 /*
121 * A set of variables to keep track of interrupts that don't go through
122 * the IRR.
123 */
124 bool pendingSmi;
125 uint8_t smiVector;
126 bool pendingNmi;
127 uint8_t nmiVector;
128 bool pendingExtInt;
129 uint8_t extIntVector;
130 bool pendingInit;
131 uint8_t initVector;
132 bool pendingStartup;
133 uint8_t startupVector;
| 1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
3 * All rights reserved.
4 *
5 * Redistribution and use of this software in source and binary forms,
6 * with or without modification, are permitted provided that the
7 * following conditions are met:
8 *
9 * The software must be used only for Non-Commercial Use which means any
10 * use which is NOT directed to receiving any direct monetary
11 * compensation for, or commercial advantage from such use. Illustrative
12 * examples of non-commercial use are academic research, personal study,
13 * teaching, education and corporate research & development.
14 * Illustrative examples of commercial use are distributing products for
15 * commercial advantage and providing services using the software for
16 * commercial advantage.
17 *
18 * If you wish to use this software or functionality therein that may be
19 * covered by patents for commercial use, please contact:
20 * Director of Intellectual Property Licensing
21 * Office of Strategy and Technology
22 * Hewlett-Packard Company
23 * 1501 Page Mill Road
24 * Palo Alto, California 94304
25 *
26 * Redistributions of source code must retain the above copyright notice,
27 * this list of conditions and the following disclaimer. Redistributions
28 * in binary form must reproduce the above copyright notice, this list of
29 * conditions and the following disclaimer in the documentation and/or
30 * other materials provided with the distribution. Neither the name of
31 * the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
32 * contributors may be used to endorse or promote products derived from
33 * this software without specific prior written permission. No right of
34 * sublicense is granted herewith. Derivatives of the software and
35 * output created using the software may be prepared, but only for
36 * Non-Commercial Uses. Derivatives of the software may be shared with
37 * others provided: (i) the others agree to abide by the list of
38 * conditions herein which includes the Non-Commercial Use restrictions;
39 * and (ii) such Derivatives of the software include the above copyright
40 * notice to acknowledge the contribution from this software where
41 * applicable, this list of conditions and the disclaimer below.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 *
55 * Authors: Gabe Black
56 */
57
58#ifndef __ARCH_X86_INTERRUPTS_HH__
59#define __ARCH_X86_INTERRUPTS_HH__
60
61#include "arch/x86/apicregs.hh"
62#include "arch/x86/faults.hh"
63#include "arch/x86/intmessage.hh"
64#include "base/bitfield.hh"
65#include "cpu/thread_context.hh"
66#include "dev/io_device.hh"
67#include "dev/x86/intdev.hh"
68#include "params/X86LocalApic.hh"
69#include "sim/eventq.hh"
70
71class ThreadContext;
72class BaseCPU;
73
74namespace X86ISA {
75
76class Interrupts : public BasicPioDevice, IntDev
77{
78 protected:
79 // Storage for the APIC registers
80 uint32_t regs[NUM_APIC_REGS];
81
82 BitUnion32(LVTEntry)
83 Bitfield<7, 0> vector;
84 Bitfield<10, 8> deliveryMode;
85 Bitfield<12> status;
86 Bitfield<13> polarity;
87 Bitfield<14> remoteIRR;
88 Bitfield<15> trigger;
89 Bitfield<16> masked;
90 Bitfield<17> periodic;
91 EndBitUnion(LVTEntry)
92
93 /*
94 * Timing related stuff.
95 */
96 Tick latency;
97 Tick clock;
98
99 class ApicTimerEvent : public Event
100 {
101 private:
102 Interrupts *localApic;
103 public:
104 ApicTimerEvent(Interrupts *_localApic) :
105 Event(), localApic(_localApic)
106 {}
107
108 void process()
109 {
110 assert(localApic);
111 if (localApic->triggerTimerInterrupt()) {
112 localApic->setReg(APIC_INITIAL_COUNT,
113 localApic->readReg(APIC_INITIAL_COUNT));
114 }
115 }
116 };
117
118 ApicTimerEvent apicTimerEvent;
119
120 /*
121 * A set of variables to keep track of interrupts that don't go through
122 * the IRR.
123 */
124 bool pendingSmi;
125 uint8_t smiVector;
126 bool pendingNmi;
127 uint8_t nmiVector;
128 bool pendingExtInt;
129 uint8_t extIntVector;
130 bool pendingInit;
131 uint8_t initVector;
132 bool pendingStartup;
133 uint8_t startupVector;
|
134
135 // This is a quick check whether any of the above (except ExtInt) are set.
136 bool pendingUnmaskableInt;
137
138 /*
139 * IRR and ISR maintenance.
140 */
141 uint8_t IRRV;
142 uint8_t ISRV;
143
144 int
145 findRegArrayMSB(ApicRegIndex base)
146 {
147 int offset = 7;
148 do {
149 if (regs[base + offset] != 0) {
150 return offset * 32 + findMsbSet(regs[base + offset]);
151 }
152 } while (offset--);
153 return 0;
154 }
155
156 void
157 updateIRRV()
158 {
159 IRRV = findRegArrayMSB(APIC_INTERRUPT_REQUEST_BASE);
160 }
161
162 void
163 updateISRV()
164 {
165 ISRV = findRegArrayMSB(APIC_IN_SERVICE_BASE);
166 }
167
168 void
169 setRegArrayBit(ApicRegIndex base, uint8_t vector)
170 {
171 regs[base + (vector % 32)] |= (1 << (vector >> 5));
172 }
173
174 void
175 clearRegArrayBit(ApicRegIndex base, uint8_t vector)
176 {
177 regs[base + (vector % 32)] &= ~(1 << (vector >> 5));
178 }
179
180 bool
181 getRegArrayBit(ApicRegIndex base, uint8_t vector)
182 {
183 return bits(regs[base + (vector % 32)], vector >> 5);
184 }
185
186 void requestInterrupt(uint8_t vector, uint8_t deliveryMode, bool level);
187
188 BaseCPU *cpu;
189
190 public:
191 /*
192 * Params stuff.
193 */
194 typedef X86LocalApicParams Params;
195
196 void setCPU(BaseCPU * newCPU);
197
198 void
199 setClock(Tick newClock)
200 {
201 clock = newClock;
202 }
203
204 const Params *
205 params() const
206 {
207 return dynamic_cast<const Params *>(_params);
208 }
209
210 /*
211 * Functions to interact with the interrupt port from IntDev.
212 */
213 Tick read(PacketPtr pkt);
214 Tick write(PacketPtr pkt);
215 Tick recvMessage(PacketPtr pkt);
216 Tick recvResponse(PacketPtr pkt);
217
218 bool
219 triggerTimerInterrupt()
220 {
221 LVTEntry entry = regs[APIC_LVT_TIMER];
222 if (!entry.masked)
223 requestInterrupt(entry.vector, entry.deliveryMode, entry.trigger);
224 return entry.periodic;
225 }
226
227 void addressRanges(AddrRangeList &range_list);
228 void getIntAddrRange(AddrRangeList &range_list);
229
230 Port *getPort(const std::string &if_name, int idx = -1)
231 {
232 if (if_name == "int_port")
233 return intPort;
234 return BasicPioDevice::getPort(if_name, idx);
235 }
236
237 /*
238 * Functions to access and manipulate the APIC's registers.
239 */
240
241 uint32_t readReg(ApicRegIndex miscReg);
242 void setReg(ApicRegIndex reg, uint32_t val);
243 void
244 setRegNoEffect(ApicRegIndex reg, uint32_t val)
245 {
246 regs[reg] = val;
247 }
248
249 /*
250 * Constructor.
251 */
252
253 Interrupts(Params * p);
254
255 /*
256 * Functions for retrieving interrupts for the CPU to handle.
257 */
258
259 bool checkInterrupts(ThreadContext *tc) const;
260 Fault getInterrupt(ThreadContext *tc);
261 void updateIntrInfo(ThreadContext *tc);
262
263 /*
264 * Serialization.
265 */
266
267 void
268 serialize(std::ostream &os)
269 {
270 panic("Interrupts::serialize unimplemented!\n");
271 }
272
273 void
274 unserialize(Checkpoint *cp, const std::string §ion)
275 {
276 panic("Interrupts::unserialize unimplemented!\n");
277 }
278
279 /*
280 * Old functions needed for compatability but which will be phased out
281 * eventually.
282 */
283 void
284 post(int int_num, int index)
285 {
286 panic("Interrupts::post unimplemented!\n");
287 }
288
289 void
290 clear(int int_num, int index)
291 {
292 panic("Interrupts::clear unimplemented!\n");
293 }
294
295 void
296 clearAll()
297 {
298 panic("Interrupts::clearAll unimplemented!\n");
299 }
300};
301
302} // namespace X86ISA
303
304#endif // __ARCH_X86_INTERRUPTS_HH__
| 135
136 // This is a quick check whether any of the above (except ExtInt) are set.
137 bool pendingUnmaskableInt;
138
139 /*
140 * IRR and ISR maintenance.
141 */
142 uint8_t IRRV;
143 uint8_t ISRV;
144
145 int
146 findRegArrayMSB(ApicRegIndex base)
147 {
148 int offset = 7;
149 do {
150 if (regs[base + offset] != 0) {
151 return offset * 32 + findMsbSet(regs[base + offset]);
152 }
153 } while (offset--);
154 return 0;
155 }
156
157 void
158 updateIRRV()
159 {
160 IRRV = findRegArrayMSB(APIC_INTERRUPT_REQUEST_BASE);
161 }
162
163 void
164 updateISRV()
165 {
166 ISRV = findRegArrayMSB(APIC_IN_SERVICE_BASE);
167 }
168
169 void
170 setRegArrayBit(ApicRegIndex base, uint8_t vector)
171 {
172 regs[base + (vector % 32)] |= (1 << (vector >> 5));
173 }
174
175 void
176 clearRegArrayBit(ApicRegIndex base, uint8_t vector)
177 {
178 regs[base + (vector % 32)] &= ~(1 << (vector >> 5));
179 }
180
181 bool
182 getRegArrayBit(ApicRegIndex base, uint8_t vector)
183 {
184 return bits(regs[base + (vector % 32)], vector >> 5);
185 }
186
187 void requestInterrupt(uint8_t vector, uint8_t deliveryMode, bool level);
188
189 BaseCPU *cpu;
190
191 public:
192 /*
193 * Params stuff.
194 */
195 typedef X86LocalApicParams Params;
196
197 void setCPU(BaseCPU * newCPU);
198
199 void
200 setClock(Tick newClock)
201 {
202 clock = newClock;
203 }
204
205 const Params *
206 params() const
207 {
208 return dynamic_cast<const Params *>(_params);
209 }
210
211 /*
212 * Functions to interact with the interrupt port from IntDev.
213 */
214 Tick read(PacketPtr pkt);
215 Tick write(PacketPtr pkt);
216 Tick recvMessage(PacketPtr pkt);
217 Tick recvResponse(PacketPtr pkt);
218
219 bool
220 triggerTimerInterrupt()
221 {
222 LVTEntry entry = regs[APIC_LVT_TIMER];
223 if (!entry.masked)
224 requestInterrupt(entry.vector, entry.deliveryMode, entry.trigger);
225 return entry.periodic;
226 }
227
228 void addressRanges(AddrRangeList &range_list);
229 void getIntAddrRange(AddrRangeList &range_list);
230
231 Port *getPort(const std::string &if_name, int idx = -1)
232 {
233 if (if_name == "int_port")
234 return intPort;
235 return BasicPioDevice::getPort(if_name, idx);
236 }
237
238 /*
239 * Functions to access and manipulate the APIC's registers.
240 */
241
242 uint32_t readReg(ApicRegIndex miscReg);
243 void setReg(ApicRegIndex reg, uint32_t val);
244 void
245 setRegNoEffect(ApicRegIndex reg, uint32_t val)
246 {
247 regs[reg] = val;
248 }
249
250 /*
251 * Constructor.
252 */
253
254 Interrupts(Params * p);
255
256 /*
257 * Functions for retrieving interrupts for the CPU to handle.
258 */
259
260 bool checkInterrupts(ThreadContext *tc) const;
261 Fault getInterrupt(ThreadContext *tc);
262 void updateIntrInfo(ThreadContext *tc);
263
264 /*
265 * Serialization.
266 */
267
268 void
269 serialize(std::ostream &os)
270 {
271 panic("Interrupts::serialize unimplemented!\n");
272 }
273
274 void
275 unserialize(Checkpoint *cp, const std::string §ion)
276 {
277 panic("Interrupts::unserialize unimplemented!\n");
278 }
279
280 /*
281 * Old functions needed for compatability but which will be phased out
282 * eventually.
283 */
284 void
285 post(int int_num, int index)
286 {
287 panic("Interrupts::post unimplemented!\n");
288 }
289
290 void
291 clear(int int_num, int index)
292 {
293 panic("Interrupts::clear unimplemented!\n");
294 }
295
296 void
297 clearAll()
298 {
299 panic("Interrupts::clearAll unimplemented!\n");
300 }
301};
302
303} // namespace X86ISA
304
305#endif // __ARCH_X86_INTERRUPTS_HH__
|