interrupts.hh (13784:1941dc118243) interrupts.hh (14293:e8bb3f77458a)
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) 2007 The Hewlett-Packard Development Company
15 * All rights reserved.
16 *
17 * The license below extends only to copyright in the software and shall
18 * not be construed as granting a license to any other intellectual
19 * property including but not limited to intellectual property relating
20 * to a hardware implementation of the functionality of the software
21 * licensed hereunder. You may use the software subject to the license
22 * terms below provided that you ensure that this notice is replicated
23 * unmodified and in its entirety in all distributions of the software,
24 * modified or unmodified, in source code or in binary form.
25 *
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions are
28 * met: redistributions of source code must retain the above copyright
29 * notice, this list of conditions and the following disclaimer;
30 * redistributions in binary form must reproduce the above copyright
31 * notice, this list of conditions and the following disclaimer in the
32 * documentation and/or other materials provided with the distribution;
33 * neither the name of the copyright holders nor the names of its
34 * contributors may be used to endorse or promote products derived from
35 * this software without specific prior written permission.
36 *
37 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
38 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
39 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
40 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
41 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
44 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
45 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
46 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
47 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48 *
49 * Authors: Gabe Black
50 * Andreas Hansson
51 */
52
53#ifndef __ARCH_X86_INTERRUPTS_HH__
54#define __ARCH_X86_INTERRUPTS_HH__
55
56#include "arch/x86/regs/apic.hh"
57#include "arch/x86/faults.hh"
58#include "arch/x86/intmessage.hh"
59#include "base/bitfield.hh"
60#include "cpu/thread_context.hh"
61#include "dev/x86/intdev.hh"
62#include "dev/io_device.hh"
63#include "params/X86LocalApic.hh"
64#include "sim/eventq.hh"
65
66class ThreadContext;
67class BaseCPU;
68
69int divideFromConf(uint32_t conf);
70
71namespace X86ISA {
72
73ApicRegIndex decodeAddr(Addr paddr);
74
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) 2007 The Hewlett-Packard Development Company
15 * All rights reserved.
16 *
17 * The license below extends only to copyright in the software and shall
18 * not be construed as granting a license to any other intellectual
19 * property including but not limited to intellectual property relating
20 * to a hardware implementation of the functionality of the software
21 * licensed hereunder. You may use the software subject to the license
22 * terms below provided that you ensure that this notice is replicated
23 * unmodified and in its entirety in all distributions of the software,
24 * modified or unmodified, in source code or in binary form.
25 *
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions are
28 * met: redistributions of source code must retain the above copyright
29 * notice, this list of conditions and the following disclaimer;
30 * redistributions in binary form must reproduce the above copyright
31 * notice, this list of conditions and the following disclaimer in the
32 * documentation and/or other materials provided with the distribution;
33 * neither the name of the copyright holders nor the names of its
34 * contributors may be used to endorse or promote products derived from
35 * this software without specific prior written permission.
36 *
37 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
38 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
39 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
40 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
41 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
44 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
45 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
46 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
47 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48 *
49 * Authors: Gabe Black
50 * Andreas Hansson
51 */
52
53#ifndef __ARCH_X86_INTERRUPTS_HH__
54#define __ARCH_X86_INTERRUPTS_HH__
55
56#include "arch/x86/regs/apic.hh"
57#include "arch/x86/faults.hh"
58#include "arch/x86/intmessage.hh"
59#include "base/bitfield.hh"
60#include "cpu/thread_context.hh"
61#include "dev/x86/intdev.hh"
62#include "dev/io_device.hh"
63#include "params/X86LocalApic.hh"
64#include "sim/eventq.hh"
65
66class ThreadContext;
67class BaseCPU;
68
69int divideFromConf(uint32_t conf);
70
71namespace X86ISA {
72
73ApicRegIndex decodeAddr(Addr paddr);
74
75class Interrupts : public BasicPioDevice, IntDevice
75class Interrupts : public PioDevice, IntDevice
76{
77 protected:
78 // Storage for the APIC registers
79 uint32_t regs[NUM_APIC_REGS];
80
81 BitUnion32(LVTEntry)
82 Bitfield<7, 0> vector;
83 Bitfield<10, 8> deliveryMode;
84 Bitfield<12> status;
85 Bitfield<13> polarity;
86 Bitfield<14> remoteIRR;
87 Bitfield<15> trigger;
88 Bitfield<16> masked;
89 Bitfield<17> periodic;
90 EndBitUnion(LVTEntry)
91
92 /*
93 * Timing related stuff.
94 */
95 EventFunctionWrapper apicTimerEvent;
96 void processApicTimerEvent();
97
98 /*
99 * A set of variables to keep track of interrupts that don't go through
100 * the IRR.
101 */
102 bool pendingSmi;
103 uint8_t smiVector;
104 bool pendingNmi;
105 uint8_t nmiVector;
106 bool pendingExtInt;
107 uint8_t extIntVector;
108 bool pendingInit;
109 uint8_t initVector;
110 bool pendingStartup;
111 uint8_t startupVector;
112 bool startedUp;
113
114 // This is a quick check whether any of the above (except ExtInt) are set.
115 bool pendingUnmaskableInt;
116
117 // A count of how many IPIs are in flight.
118 int pendingIPIs;
119
120 /*
121 * IRR and ISR maintenance.
122 */
123 uint8_t IRRV;
124 uint8_t ISRV;
125
126 int
127 findRegArrayMSB(ApicRegIndex base)
128 {
129 int offset = 7;
130 do {
131 if (regs[base + offset] != 0) {
132 return offset * 32 + findMsbSet(regs[base + offset]);
133 }
134 } while (offset--);
135 return 0;
136 }
137
138 void
139 updateIRRV()
140 {
141 IRRV = findRegArrayMSB(APIC_INTERRUPT_REQUEST_BASE);
142 }
143
144 void
145 updateISRV()
146 {
147 ISRV = findRegArrayMSB(APIC_IN_SERVICE_BASE);
148 }
149
150 void
151 setRegArrayBit(ApicRegIndex base, uint8_t vector)
152 {
153 regs[base + (vector / 32)] |= (1 << (vector % 32));
154 }
155
156 void
157 clearRegArrayBit(ApicRegIndex base, uint8_t vector)
158 {
159 regs[base + (vector / 32)] &= ~(1 << (vector % 32));
160 }
161
162 bool
163 getRegArrayBit(ApicRegIndex base, uint8_t vector)
164 {
165 return bits(regs[base + (vector / 32)], vector % 32);
166 }
167
168 void requestInterrupt(uint8_t vector, uint8_t deliveryMode, bool level);
169
170 BaseCPU *cpu;
171
172 int initialApicId;
173
174 // Port for receiving interrupts
175 IntSlavePort intSlavePort;
176
76{
77 protected:
78 // Storage for the APIC registers
79 uint32_t regs[NUM_APIC_REGS];
80
81 BitUnion32(LVTEntry)
82 Bitfield<7, 0> vector;
83 Bitfield<10, 8> deliveryMode;
84 Bitfield<12> status;
85 Bitfield<13> polarity;
86 Bitfield<14> remoteIRR;
87 Bitfield<15> trigger;
88 Bitfield<16> masked;
89 Bitfield<17> periodic;
90 EndBitUnion(LVTEntry)
91
92 /*
93 * Timing related stuff.
94 */
95 EventFunctionWrapper apicTimerEvent;
96 void processApicTimerEvent();
97
98 /*
99 * A set of variables to keep track of interrupts that don't go through
100 * the IRR.
101 */
102 bool pendingSmi;
103 uint8_t smiVector;
104 bool pendingNmi;
105 uint8_t nmiVector;
106 bool pendingExtInt;
107 uint8_t extIntVector;
108 bool pendingInit;
109 uint8_t initVector;
110 bool pendingStartup;
111 uint8_t startupVector;
112 bool startedUp;
113
114 // This is a quick check whether any of the above (except ExtInt) are set.
115 bool pendingUnmaskableInt;
116
117 // A count of how many IPIs are in flight.
118 int pendingIPIs;
119
120 /*
121 * IRR and ISR maintenance.
122 */
123 uint8_t IRRV;
124 uint8_t ISRV;
125
126 int
127 findRegArrayMSB(ApicRegIndex base)
128 {
129 int offset = 7;
130 do {
131 if (regs[base + offset] != 0) {
132 return offset * 32 + findMsbSet(regs[base + offset]);
133 }
134 } while (offset--);
135 return 0;
136 }
137
138 void
139 updateIRRV()
140 {
141 IRRV = findRegArrayMSB(APIC_INTERRUPT_REQUEST_BASE);
142 }
143
144 void
145 updateISRV()
146 {
147 ISRV = findRegArrayMSB(APIC_IN_SERVICE_BASE);
148 }
149
150 void
151 setRegArrayBit(ApicRegIndex base, uint8_t vector)
152 {
153 regs[base + (vector / 32)] |= (1 << (vector % 32));
154 }
155
156 void
157 clearRegArrayBit(ApicRegIndex base, uint8_t vector)
158 {
159 regs[base + (vector / 32)] &= ~(1 << (vector % 32));
160 }
161
162 bool
163 getRegArrayBit(ApicRegIndex base, uint8_t vector)
164 {
165 return bits(regs[base + (vector / 32)], vector % 32);
166 }
167
168 void requestInterrupt(uint8_t vector, uint8_t deliveryMode, bool level);
169
170 BaseCPU *cpu;
171
172 int initialApicId;
173
174 // Port for receiving interrupts
175 IntSlavePort intSlavePort;
176
177 Tick pioDelay;
178 Addr pioAddr = MaxAddr;
179
177 public:
178
179 int getInitialApicId() { return initialApicId; }
180
181 /*
182 * Params stuff.
183 */
184 typedef X86LocalApicParams Params;
185
186 void setCPU(BaseCPU * newCPU);
187
188 const Params *
189 params() const
190 {
191 return dynamic_cast<const Params *>(_params);
192 }
193
194 /*
195 * Initialize this object by registering it with the IO APIC.
196 */
197 void init() override;
198
199 /*
200 * Functions to interact with the interrupt port from IntDevice.
201 */
202 Tick read(PacketPtr pkt) override;
203 Tick write(PacketPtr pkt) override;
204 Tick recvMessage(PacketPtr pkt) override;
205 Tick recvResponse(PacketPtr pkt) override;
206
207 bool
208 triggerTimerInterrupt()
209 {
210 LVTEntry entry = regs[APIC_LVT_TIMER];
211 if (!entry.masked)
212 requestInterrupt(entry.vector, entry.deliveryMode, entry.trigger);
213 return entry.periodic;
214 }
215
180 public:
181
182 int getInitialApicId() { return initialApicId; }
183
184 /*
185 * Params stuff.
186 */
187 typedef X86LocalApicParams Params;
188
189 void setCPU(BaseCPU * newCPU);
190
191 const Params *
192 params() const
193 {
194 return dynamic_cast<const Params *>(_params);
195 }
196
197 /*
198 * Initialize this object by registering it with the IO APIC.
199 */
200 void init() override;
201
202 /*
203 * Functions to interact with the interrupt port from IntDevice.
204 */
205 Tick read(PacketPtr pkt) override;
206 Tick write(PacketPtr pkt) override;
207 Tick recvMessage(PacketPtr pkt) override;
208 Tick recvResponse(PacketPtr pkt) override;
209
210 bool
211 triggerTimerInterrupt()
212 {
213 LVTEntry entry = regs[APIC_LVT_TIMER];
214 if (!entry.masked)
215 requestInterrupt(entry.vector, entry.deliveryMode, entry.trigger);
216 return entry.periodic;
217 }
218
219 AddrRangeList getAddrRanges() const override;
216 AddrRangeList getIntAddrRange() const override;
217
218 Port &getPort(const std::string &if_name,
219 PortID idx=InvalidPortID) override
220 {
221 if (if_name == "int_master") {
222 return intMasterPort;
223 } else if (if_name == "int_slave") {
224 return intSlavePort;
225 }
220 AddrRangeList getIntAddrRange() const override;
221
222 Port &getPort(const std::string &if_name,
223 PortID idx=InvalidPortID) override
224 {
225 if (if_name == "int_master") {
226 return intMasterPort;
227 } else if (if_name == "int_slave") {
228 return intSlavePort;
229 }
226 return BasicPioDevice::getPort(if_name, idx);
230 return PioDevice::getPort(if_name, idx);
227 }
228
229 /*
230 * Functions to access and manipulate the APIC's registers.
231 */
232
233 uint32_t readReg(ApicRegIndex miscReg);
234 void setReg(ApicRegIndex reg, uint32_t val);
235 void
236 setRegNoEffect(ApicRegIndex reg, uint32_t val)
237 {
238 regs[reg] = val;
239 }
240
241 /*
242 * Constructor.
243 */
244
245 Interrupts(Params * p);
246
247 /*
248 * Functions for retrieving interrupts for the CPU to handle.
249 */
250
251 bool checkInterrupts(ThreadContext *tc) const;
252 /**
253 * Check if there are pending interrupts without ignoring the
254 * interrupts disabled flag.
255 *
256 * @return true if there are interrupts pending.
257 */
258 bool checkInterruptsRaw() const;
259 /**
260 * Check if there are pending unmaskable interrupts.
261 *
262 * @return true there are unmaskable interrupts pending.
263 */
264 bool hasPendingUnmaskable() const { return pendingUnmaskableInt; }
265 Fault getInterrupt(ThreadContext *tc);
266 void updateIntrInfo(ThreadContext *tc);
267
268 /*
269 * Serialization.
270 */
271 void serialize(CheckpointOut &cp) const override;
272 void unserialize(CheckpointIn &cp) override;
273
274 /*
275 * Old functions needed for compatability but which will be phased out
276 * eventually.
277 */
278 void
279 post(int int_num, int index)
280 {
281 panic("Interrupts::post unimplemented!\n");
282 }
283
284 void
285 clear(int int_num, int index)
286 {
287 panic("Interrupts::clear unimplemented!\n");
288 }
289
290 void
291 clearAll()
292 {
293 panic("Interrupts::clearAll unimplemented!\n");
294 }
295};
296
297} // namespace X86ISA
298
299#endif // __ARCH_X86_INTERRUPTS_HH__
231 }
232
233 /*
234 * Functions to access and manipulate the APIC's registers.
235 */
236
237 uint32_t readReg(ApicRegIndex miscReg);
238 void setReg(ApicRegIndex reg, uint32_t val);
239 void
240 setRegNoEffect(ApicRegIndex reg, uint32_t val)
241 {
242 regs[reg] = val;
243 }
244
245 /*
246 * Constructor.
247 */
248
249 Interrupts(Params * p);
250
251 /*
252 * Functions for retrieving interrupts for the CPU to handle.
253 */
254
255 bool checkInterrupts(ThreadContext *tc) const;
256 /**
257 * Check if there are pending interrupts without ignoring the
258 * interrupts disabled flag.
259 *
260 * @return true if there are interrupts pending.
261 */
262 bool checkInterruptsRaw() const;
263 /**
264 * Check if there are pending unmaskable interrupts.
265 *
266 * @return true there are unmaskable interrupts pending.
267 */
268 bool hasPendingUnmaskable() const { return pendingUnmaskableInt; }
269 Fault getInterrupt(ThreadContext *tc);
270 void updateIntrInfo(ThreadContext *tc);
271
272 /*
273 * Serialization.
274 */
275 void serialize(CheckpointOut &cp) const override;
276 void unserialize(CheckpointIn &cp) override;
277
278 /*
279 * Old functions needed for compatability but which will be phased out
280 * eventually.
281 */
282 void
283 post(int int_num, int index)
284 {
285 panic("Interrupts::post unimplemented!\n");
286 }
287
288 void
289 clear(int int_num, int index)
290 {
291 panic("Interrupts::clear unimplemented!\n");
292 }
293
294 void
295 clearAll()
296 {
297 panic("Interrupts::clearAll unimplemented!\n");
298 }
299};
300
301} // namespace X86ISA
302
303#endif // __ARCH_X86_INTERRUPTS_HH__