2 * Copyright (c) 2008 The Hewlett-Packard Development Company
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.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include "arch/x86/regs/apic.hh"
41 #include "arch/x86/interrupts.hh"
42 #include "arch/x86/intmessage.hh"
43 #include "cpu/base.hh"
44 #include "debug/LocalApic.hh"
45 #include "dev/x86/i82094aa.hh"
46 #include "dev/x86/pc.hh"
47 #include "dev/x86/south_bridge.hh"
48 #include "mem/packet_access.hh"
49 #include "sim/system.hh"
50 #include "sim/full_system.hh"
53 divideFromConf(uint32_t conf
)
55 // This figures out what division we want from the division configuration
56 // register in the local APIC. The encoding is a little odd but it can
57 // be deciphered fairly easily.
58 int shift
= ((conf
& 0x8) >> 1) | (conf
& 0x3);
59 shift
= (shift
+ 1) % 8;
67 decodeAddr(Addr paddr
)
77 regNum
= APIC_VERSION
;
80 regNum
= APIC_TASK_PRIORITY
;
83 regNum
= APIC_ARBITRATION_PRIORITY
;
86 regNum
= APIC_PROCESSOR_PRIORITY
;
92 regNum
= APIC_LOGICAL_DESTINATION
;
95 regNum
= APIC_DESTINATION_FORMAT
;
98 regNum
= APIC_SPURIOUS_INTERRUPT_VECTOR
;
116 regNum
= APIC_IN_SERVICE((paddr
- 0x100) / 0x8);
134 regNum
= APIC_TRIGGER_MODE((paddr
- 0x180) / 0x8);
152 regNum
= APIC_INTERRUPT_REQUEST((paddr
- 0x200) / 0x8);
155 regNum
= APIC_ERROR_STATUS
;
158 regNum
= APIC_INTERRUPT_COMMAND_LOW
;
161 regNum
= APIC_INTERRUPT_COMMAND_HIGH
;
164 regNum
= APIC_LVT_TIMER
;
167 regNum
= APIC_LVT_THERMAL_SENSOR
;
170 regNum
= APIC_LVT_PERFORMANCE_MONITORING_COUNTERS
;
173 regNum
= APIC_LVT_LINT0
;
176 regNum
= APIC_LVT_LINT1
;
179 regNum
= APIC_LVT_ERROR
;
182 regNum
= APIC_INITIAL_COUNT
;
185 regNum
= APIC_CURRENT_COUNT
;
188 regNum
= APIC_DIVIDE_CONFIGURATION
;
191 // A reserved register field.
192 panic("Accessed reserved register field %#x.\n", paddr
);
200 X86ISA::Interrupts::read(PacketPtr pkt
)
202 Addr offset
= pkt
->getAddr() - pioAddr
;
203 //Make sure we're at least only accessing one register.
204 if ((offset
& ~mask(3)) != ((offset
+ pkt
->getSize()) & ~mask(3)))
205 panic("Accessed more than one register at a time in the APIC!\n");
206 ApicRegIndex reg
= decodeAddr(offset
);
207 uint32_t val
= htog(readReg(reg
));
209 "Reading Local APIC register %d at offset %#x as %#x.\n",
211 pkt
->setData(((uint8_t *)&val
) + (offset
& mask(3)));
212 pkt
->makeAtomicResponse();
217 X86ISA::Interrupts::write(PacketPtr pkt
)
219 Addr offset
= pkt
->getAddr() - pioAddr
;
220 //Make sure we're at least only accessing one register.
221 if ((offset
& ~mask(3)) != ((offset
+ pkt
->getSize()) & ~mask(3)))
222 panic("Accessed more than one register at a time in the APIC!\n");
223 ApicRegIndex reg
= decodeAddr(offset
);
224 uint32_t val
= regs
[reg
];
225 pkt
->writeData(((uint8_t *)&val
) + (offset
& mask(3)));
227 "Writing Local APIC register %d at offset %#x as %#x.\n",
228 reg
, offset
, gtoh(val
));
229 setReg(reg
, gtoh(val
));
230 pkt
->makeAtomicResponse();
234 X86ISA::Interrupts::requestInterrupt(uint8_t vector
,
235 uint8_t deliveryMode
, bool level
)
238 * Fixed and lowest-priority delivery mode interrupts are handled
239 * using the IRR/ISR registers, checking against the TPR, etc.
240 * The SMI, NMI, ExtInt, INIT, etc interrupts go straight through.
242 if (deliveryMode
== DeliveryMode::Fixed
||
243 deliveryMode
== DeliveryMode::LowestPriority
) {
244 DPRINTF(LocalApic
, "Interrupt is an %s.\n",
245 DeliveryMode::names
[deliveryMode
]);
246 // Queue up the interrupt in the IRR.
249 if (!getRegArrayBit(APIC_INTERRUPT_REQUEST_BASE
, vector
)) {
250 setRegArrayBit(APIC_INTERRUPT_REQUEST_BASE
, vector
);
252 setRegArrayBit(APIC_TRIGGER_MODE_BASE
, vector
);
254 clearRegArrayBit(APIC_TRIGGER_MODE_BASE
, vector
);
257 } else if (!DeliveryMode::isReserved(deliveryMode
)) {
258 DPRINTF(LocalApic
, "Interrupt is an %s.\n",
259 DeliveryMode::names
[deliveryMode
]);
260 if (deliveryMode
== DeliveryMode::SMI
&& !pendingSmi
) {
261 pendingUnmaskableInt
= pendingSmi
= true;
263 } else if (deliveryMode
== DeliveryMode::NMI
&& !pendingNmi
) {
264 pendingUnmaskableInt
= pendingNmi
= true;
266 } else if (deliveryMode
== DeliveryMode::ExtInt
&& !pendingExtInt
) {
267 pendingExtInt
= true;
268 extIntVector
= vector
;
269 } else if (deliveryMode
== DeliveryMode::INIT
&& !pendingInit
) {
270 pendingUnmaskableInt
= pendingInit
= true;
272 } else if (deliveryMode
== DeliveryMode::SIPI
&&
273 !pendingStartup
&& !startedUp
) {
274 pendingUnmaskableInt
= pendingStartup
= true;
275 startupVector
= vector
;
284 X86ISA::Interrupts::setCPU(BaseCPU
* newCPU
)
287 if (cpu
!= NULL
&& cpu
->cpuId() != newCPU
->cpuId()) {
288 panic("Local APICs can't be moved between CPUs"
289 " with different IDs.\n");
292 initialApicId
= cpu
->cpuId();
293 regs
[APIC_ID
] = (initialApicId
<< 24);
298 X86ISA::Interrupts::init()
301 // The local apic must register its address ranges on both its pio port
302 // via the basicpiodevice(piodevice) init() function and its int port
303 // that it inherited from IntDev. Note IntDev is not a SimObject itself.
305 BasicPioDevice::init();
311 X86ISA::Interrupts::recvMessage(PacketPtr pkt
)
313 Addr offset
= pkt
->getAddr() - x86InterruptAddress(initialApicId
, 0);
314 assert(pkt
->cmd
== MemCmd::MessageReq
);
319 TriggerIntMessage message
= pkt
->get
<TriggerIntMessage
>();
321 "Got Trigger Interrupt message with vector %#x.\n",
324 requestInterrupt(message
.vector
,
325 message
.deliveryMode
, message
.trigger
);
329 panic("Local apic got unknown interrupt message at offset %#x.\n",
333 pkt
->makeAtomicResponse();
339 X86ISA::Interrupts::recvResponse(PacketPtr pkt
)
341 assert(!pkt
->isError());
342 assert(pkt
->cmd
== MemCmd::MessageResp
);
343 if (--pendingIPIs
== 0) {
344 InterruptCommandRegLow low
= regs
[APIC_INTERRUPT_COMMAND_LOW
];
345 // Record that the ICR is now idle.
346 low
.deliveryStatus
= 0;
347 regs
[APIC_INTERRUPT_COMMAND_LOW
] = low
;
349 DPRINTF(LocalApic
, "ICR is now idle.\n");
355 X86ISA::Interrupts::getAddrRanges()
357 AddrRangeList ranges
;
358 Range
<Addr
> range
= RangeEx(x86LocalAPICAddress(initialApicId
, 0),
359 x86LocalAPICAddress(initialApicId
, 0) +
361 ranges
.push_back(range
);
362 pioAddr
= range
.start
;
368 X86ISA::Interrupts::getIntAddrRange()
370 AddrRangeList ranges
;
371 ranges
.push_back(RangeEx(x86InterruptAddress(initialApicId
, 0),
372 x86InterruptAddress(initialApicId
, 0) +
373 PhysAddrAPICRangeSize
));
379 X86ISA::Interrupts::readReg(ApicRegIndex reg
)
381 if (reg
>= APIC_TRIGGER_MODE(0) &&
382 reg
<= APIC_TRIGGER_MODE(15)) {
383 panic("Local APIC Trigger Mode registers are unimplemented.\n");
386 case APIC_ARBITRATION_PRIORITY
:
387 panic("Local APIC Arbitration Priority register unimplemented.\n");
389 case APIC_PROCESSOR_PRIORITY
:
390 panic("Local APIC Processor Priority register unimplemented.\n");
392 case APIC_ERROR_STATUS
:
393 regs
[APIC_INTERNAL_STATE
] &= ~ULL(0x1);
395 case APIC_CURRENT_COUNT
:
397 if (apicTimerEvent
.scheduled()) {
399 // Compute how many m5 ticks happen per count.
400 uint64_t ticksPerCount
= clock
*
401 divideFromConf(regs
[APIC_DIVIDE_CONFIGURATION
]);
402 // Compute how many m5 ticks are left.
403 uint64_t val
= apicTimerEvent
.when() - curTick();
404 // Turn that into a count.
405 val
= (val
+ ticksPerCount
- 1) / ticksPerCount
;
418 X86ISA::Interrupts::setReg(ApicRegIndex reg
, uint32_t val
)
420 uint32_t newVal
= val
;
421 if (reg
>= APIC_IN_SERVICE(0) &&
422 reg
<= APIC_IN_SERVICE(15)) {
423 panic("Local APIC In-Service registers are unimplemented.\n");
425 if (reg
>= APIC_TRIGGER_MODE(0) &&
426 reg
<= APIC_TRIGGER_MODE(15)) {
427 panic("Local APIC Trigger Mode registers are unimplemented.\n");
429 if (reg
>= APIC_INTERRUPT_REQUEST(0) &&
430 reg
<= APIC_INTERRUPT_REQUEST(15)) {
431 panic("Local APIC Interrupt Request registers "
432 "are unimplemented.\n");
439 // The Local APIC Version register is read only.
441 case APIC_TASK_PRIORITY
:
444 case APIC_ARBITRATION_PRIORITY
:
445 panic("Local APIC Arbitration Priority register unimplemented.\n");
447 case APIC_PROCESSOR_PRIORITY
:
448 panic("Local APIC Processor Priority register unimplemented.\n");
451 // Remove the interrupt that just completed from the local apic state.
452 clearRegArrayBit(APIC_IN_SERVICE_BASE
, ISRV
);
455 case APIC_LOGICAL_DESTINATION
:
456 newVal
= val
& 0xFF000000;
458 case APIC_DESTINATION_FORMAT
:
459 newVal
= val
| 0x0FFFFFFF;
461 case APIC_SPURIOUS_INTERRUPT_VECTOR
:
462 regs
[APIC_INTERNAL_STATE
] &= ~ULL(1 << 1);
463 regs
[APIC_INTERNAL_STATE
] |= val
& (1 << 8);
465 warn("Focus processor checking not implemented.\n");
467 case APIC_ERROR_STATUS
:
469 if (regs
[APIC_INTERNAL_STATE
] & 0x1) {
470 regs
[APIC_INTERNAL_STATE
] &= ~ULL(0x1);
473 regs
[APIC_INTERNAL_STATE
] |= ULL(0x1);
479 case APIC_INTERRUPT_COMMAND_LOW
:
481 InterruptCommandRegLow low
= regs
[APIC_INTERRUPT_COMMAND_LOW
];
482 // Check if we're already sending an IPI.
483 if (low
.deliveryStatus
) {
488 InterruptCommandRegHigh high
= regs
[APIC_INTERRUPT_COMMAND_HIGH
];
489 // Record that an IPI is being sent.
490 low
.deliveryStatus
= 1;
491 TriggerIntMessage message
= 0;
492 message
.destination
= high
.destination
;
493 message
.vector
= low
.vector
;
494 message
.deliveryMode
= low
.deliveryMode
;
495 message
.destMode
= low
.destMode
;
496 message
.level
= low
.level
;
497 message
.trigger
= low
.trigger
;
498 bool timing
= sys
->getMemoryMode() == Enums::timing
;
499 // Be careful no updates of the delivery status bit get lost.
500 regs
[APIC_INTERRUPT_COMMAND_LOW
] = low
;
502 int numContexts
= sys
->numContexts();
503 switch (low
.destShorthand
) {
505 if (message
.deliveryMode
== DeliveryMode::LowestPriority
) {
506 panic("Lowest priority delivery mode "
507 "IPIs aren't implemented.\n");
509 if (message
.destMode
== 1) {
510 int dest
= message
.destination
;
511 hack_once("Assuming logical destinations are 1 << id.\n");
512 for (int i
= 0; i
< numContexts
; i
++) {
518 if (message
.destination
== 0xFF) {
519 for (int i
= 0; i
< numContexts
; i
++) {
520 if (i
== initialApicId
) {
521 requestInterrupt(message
.vector
,
522 message
.deliveryMode
, message
.trigger
);
528 if (message
.destination
== initialApicId
) {
529 requestInterrupt(message
.vector
,
530 message
.deliveryMode
, message
.trigger
);
532 apics
.push_back(message
.destination
);
539 requestInterrupt(message
.vector
,
540 message
.deliveryMode
, message
.trigger
);
543 requestInterrupt(message
.vector
,
544 message
.deliveryMode
, message
.trigger
);
548 for (int i
= 0; i
< numContexts
; i
++) {
549 if (i
!= initialApicId
) {
556 pendingIPIs
+= apics
.size();
557 intPort
.sendMessage(apics
, message
, timing
);
558 newVal
= regs
[APIC_INTERRUPT_COMMAND_LOW
];
562 case APIC_LVT_THERMAL_SENSOR
:
563 case APIC_LVT_PERFORMANCE_MONITORING_COUNTERS
:
568 uint64_t readOnlyMask
= (1 << 12) | (1 << 14);
569 newVal
= (val
& ~readOnlyMask
) |
570 (regs
[reg
] & readOnlyMask
);
573 case APIC_INITIAL_COUNT
:
576 newVal
= bits(val
, 31, 0);
577 // Compute how many timer ticks we're being programmed for.
578 uint64_t newCount
= newVal
*
579 (divideFromConf(regs
[APIC_DIVIDE_CONFIGURATION
]));
580 // Schedule on the edge of the next tick plus the new count.
581 Tick offset
= curTick() % clock
;
583 reschedule(apicTimerEvent
,
584 curTick() + (newCount
+ 1) * clock
- offset
, true);
586 reschedule(apicTimerEvent
,
587 curTick() + newCount
* clock
, true);
591 case APIC_CURRENT_COUNT
:
592 //Local APIC Current Count register is read only.
594 case APIC_DIVIDE_CONFIGURATION
:
605 X86ISA::Interrupts::Interrupts(Params
* p
) :
606 BasicPioDevice(p
), IntDev(this, p
->int_latency
), latency(p
->pio_latency
),
608 apicTimerEvent(this),
609 pendingSmi(false), smiVector(0),
610 pendingNmi(false), nmiVector(0),
611 pendingExtInt(false), extIntVector(0),
612 pendingInit(false), initVector(0),
613 pendingStartup(false), startupVector(0),
614 startedUp(false), pendingUnmaskableInt(false),
615 pendingIPIs(0), cpu(NULL
),
616 intSlavePort(name() + ".int_slave", this, this, latency
)
619 memset(regs
, 0, sizeof(regs
));
620 //Set the local apic DFR to the flat model.
621 regs
[APIC_DESTINATION_FORMAT
] = (uint32_t)(-1);
628 X86ISA::Interrupts::checkInterrupts(ThreadContext
*tc
) const
630 RFLAGS rflags
= tc
->readMiscRegNoEffect(MISCREG_RFLAGS
);
631 if (pendingUnmaskableInt
) {
632 DPRINTF(LocalApic
, "Reported pending unmaskable interrupt.\n");
637 DPRINTF(LocalApic
, "Reported pending external interrupt.\n");
640 if (IRRV
> ISRV
&& bits(IRRV
, 7, 4) >
641 bits(regs
[APIC_TASK_PRIORITY
], 7, 4)) {
642 DPRINTF(LocalApic
, "Reported pending regular interrupt.\n");
650 X86ISA::Interrupts::getInterrupt(ThreadContext
*tc
)
652 assert(checkInterrupts(tc
));
653 // These are all probably fairly uncommon, so we'll make them easier to
655 if (pendingUnmaskableInt
) {
657 DPRINTF(LocalApic
, "Generated SMI fault object.\n");
658 return new SystemManagementInterrupt();
659 } else if (pendingNmi
) {
660 DPRINTF(LocalApic
, "Generated NMI fault object.\n");
661 return new NonMaskableInterrupt(nmiVector
);
662 } else if (pendingInit
) {
663 DPRINTF(LocalApic
, "Generated INIT fault object.\n");
664 return new InitInterrupt(initVector
);
665 } else if (pendingStartup
) {
666 DPRINTF(LocalApic
, "Generating SIPI fault object.\n");
667 return new StartupInterrupt(startupVector
);
669 panic("pendingUnmaskableInt set, but no unmaskable "
670 "ints were pending.\n");
673 } else if (pendingExtInt
) {
674 DPRINTF(LocalApic
, "Generated external interrupt fault object.\n");
675 return new ExternalInterrupt(extIntVector
);
677 DPRINTF(LocalApic
, "Generated regular interrupt fault object.\n");
678 // The only thing left are fixed and lowest priority interrupts.
679 return new ExternalInterrupt(IRRV
);
684 X86ISA::Interrupts::updateIntrInfo(ThreadContext
*tc
)
686 assert(checkInterrupts(tc
));
687 if (pendingUnmaskableInt
) {
689 DPRINTF(LocalApic
, "SMI sent to core.\n");
691 } else if (pendingNmi
) {
692 DPRINTF(LocalApic
, "NMI sent to core.\n");
694 } else if (pendingInit
) {
695 DPRINTF(LocalApic
, "Init sent to core.\n");
698 } else if (pendingStartup
) {
699 DPRINTF(LocalApic
, "SIPI sent to core.\n");
700 pendingStartup
= false;
703 if (!(pendingSmi
|| pendingNmi
|| pendingInit
|| pendingStartup
))
704 pendingUnmaskableInt
= false;
705 } else if (pendingExtInt
) {
706 pendingExtInt
= false;
708 DPRINTF(LocalApic
, "Interrupt %d sent to core.\n", IRRV
);
709 // Mark the interrupt as "in service".
711 setRegArrayBit(APIC_IN_SERVICE_BASE
, ISRV
);
712 // Clear it out of the IRR.
713 clearRegArrayBit(APIC_INTERRUPT_REQUEST_BASE
, IRRV
);
719 X86ISA::Interrupts::serialize(std::ostream
&os
)
721 SERIALIZE_ARRAY(regs
, NUM_APIC_REGS
);
722 SERIALIZE_SCALAR(clock
);
723 SERIALIZE_SCALAR(pendingSmi
);
724 SERIALIZE_SCALAR(smiVector
);
725 SERIALIZE_SCALAR(pendingNmi
);
726 SERIALIZE_SCALAR(nmiVector
);
727 SERIALIZE_SCALAR(pendingExtInt
);
728 SERIALIZE_SCALAR(extIntVector
);
729 SERIALIZE_SCALAR(pendingInit
);
730 SERIALIZE_SCALAR(initVector
);
731 SERIALIZE_SCALAR(pendingStartup
);
732 SERIALIZE_SCALAR(startupVector
);
733 SERIALIZE_SCALAR(startedUp
);
734 SERIALIZE_SCALAR(pendingUnmaskableInt
);
735 SERIALIZE_SCALAR(pendingIPIs
);
736 SERIALIZE_SCALAR(IRRV
);
737 SERIALIZE_SCALAR(ISRV
);
738 bool apicTimerEventScheduled
= apicTimerEvent
.scheduled();
739 SERIALIZE_SCALAR(apicTimerEventScheduled
);
740 Tick apicTimerEventTick
= apicTimerEvent
.when();
741 SERIALIZE_SCALAR(apicTimerEventTick
);
745 X86ISA::Interrupts::unserialize(Checkpoint
*cp
, const std::string
§ion
)
747 UNSERIALIZE_ARRAY(regs
, NUM_APIC_REGS
);
748 UNSERIALIZE_SCALAR(clock
);
749 UNSERIALIZE_SCALAR(pendingSmi
);
750 UNSERIALIZE_SCALAR(smiVector
);
751 UNSERIALIZE_SCALAR(pendingNmi
);
752 UNSERIALIZE_SCALAR(nmiVector
);
753 UNSERIALIZE_SCALAR(pendingExtInt
);
754 UNSERIALIZE_SCALAR(extIntVector
);
755 UNSERIALIZE_SCALAR(pendingInit
);
756 UNSERIALIZE_SCALAR(initVector
);
757 UNSERIALIZE_SCALAR(pendingStartup
);
758 UNSERIALIZE_SCALAR(startupVector
);
759 UNSERIALIZE_SCALAR(startedUp
);
760 UNSERIALIZE_SCALAR(pendingUnmaskableInt
);
761 UNSERIALIZE_SCALAR(pendingIPIs
);
762 UNSERIALIZE_SCALAR(IRRV
);
763 UNSERIALIZE_SCALAR(ISRV
);
764 bool apicTimerEventScheduled
;
765 UNSERIALIZE_SCALAR(apicTimerEventScheduled
);
766 if (apicTimerEventScheduled
) {
767 Tick apicTimerEventTick
;
768 UNSERIALIZE_SCALAR(apicTimerEventTick
);
769 if (apicTimerEvent
.scheduled()) {
770 reschedule(apicTimerEvent
, apicTimerEventTick
, true);
772 schedule(apicTimerEvent
, apicTimerEventTick
);
778 X86LocalApicParams::create()
780 return new X86ISA::Interrupts(this);