2 * Copyright (c) 2007 The Hewlett-Packard Development Company
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:
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.
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
24 * Palo Alto, California 94304
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.
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.
58 #ifndef __ARCH_X86_INTERRUPTS_HH__
59 #define __ARCH_X86_INTERRUPTS_HH__
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"
76 class Interrupts : public BasicPioDevice, IntDev
79 // Storage for the APIC registers
80 uint32_t regs[NUM_APIC_REGS];
83 Bitfield<7, 0> vector;
84 Bitfield<10, 8> deliveryMode;
86 Bitfield<13> polarity;
87 Bitfield<14> remoteIRR;
90 Bitfield<17> periodic;
94 * Timing related stuff.
99 class ApicTimerEvent : public Event
102 Interrupts *localApic;
104 ApicTimerEvent(Interrupts *_localApic) :
105 Event(), localApic(_localApic)
111 if (localApic->triggerTimerInterrupt()) {
112 localApic->setReg(APIC_INITIAL_COUNT,
113 localApic->readReg(APIC_INITIAL_COUNT));
118 ApicTimerEvent apicTimerEvent;
121 * A set of variables to keep track of interrupts that don't go through
129 uint8_t extIntVector;
133 uint8_t startupVector;
136 // This is a quick check whether any of the above (except ExtInt) are set.
137 bool pendingUnmaskableInt;
139 // A count of how many IPIs are in flight.
143 * IRR and ISR maintenance.
149 findRegArrayMSB(ApicRegIndex base)
153 if (regs[base + offset] != 0) {
154 return offset * 32 + findMsbSet(regs[base + offset]);
163 IRRV = findRegArrayMSB(APIC_INTERRUPT_REQUEST_BASE);
169 ISRV = findRegArrayMSB(APIC_IN_SERVICE_BASE);
173 setRegArrayBit(ApicRegIndex base, uint8_t vector)
175 regs[base + (vector % 32)] |= (1 << (vector >> 5));
179 clearRegArrayBit(ApicRegIndex base, uint8_t vector)
181 regs[base + (vector % 32)] &= ~(1 << (vector >> 5));
185 getRegArrayBit(ApicRegIndex base, uint8_t vector)
187 return bits(regs[base + (vector % 32)], vector >> 5);
190 void requestInterrupt(uint8_t vector, uint8_t deliveryMode, bool level);
198 typedef X86LocalApicParams Params;
200 void setCPU(BaseCPU * newCPU);
203 setClock(Tick newClock)
211 return dynamic_cast<const Params *>(_params);
215 * Functions to interact with the interrupt port from IntDev.
217 Tick read(PacketPtr pkt);
218 Tick write(PacketPtr pkt);
219 Tick recvMessage(PacketPtr pkt);
220 Tick recvResponse(PacketPtr pkt);
223 triggerTimerInterrupt()
225 LVTEntry entry = regs[APIC_LVT_TIMER];
227 requestInterrupt(entry.vector, entry.deliveryMode, entry.trigger);
228 return entry.periodic;
231 void addressRanges(AddrRangeList &range_list);
232 void getIntAddrRange(AddrRangeList &range_list);
234 Port *getPort(const std::string &if_name, int idx = -1)
236 if (if_name == "int_port")
238 return BasicPioDevice::getPort(if_name, idx);
242 * Functions to access and manipulate the APIC's registers.
245 uint32_t readReg(ApicRegIndex miscReg);
246 void setReg(ApicRegIndex reg, uint32_t val);
248 setRegNoEffect(ApicRegIndex reg, uint32_t val)
257 Interrupts(Params * p);
260 * Functions for retrieving interrupts for the CPU to handle.
263 bool checkInterrupts(ThreadContext *tc) const;
264 Fault getInterrupt(ThreadContext *tc);
265 void updateIntrInfo(ThreadContext *tc);
272 serialize(std::ostream &os)
274 panic("Interrupts::serialize unimplemented!\n");
278 unserialize(Checkpoint *cp, const std::string §ion)
280 panic("Interrupts::unserialize unimplemented!\n");
284 * Old functions needed for compatability but which will be phased out
288 post(int int_num, int index)
290 panic("Interrupts::post unimplemented!\n");
294 clear(int int_num, int index)
296 panic("Interrupts::clear unimplemented!\n");
302 panic("Interrupts::clearAll unimplemented!\n");
306 } // namespace X86ISA
308 #endif // __ARCH_X86_INTERRUPTS_HH__