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"
52 divideFromConf(uint32_t conf
)
54 // This figures out what division we want from the division configuration
55 // register in the local APIC. The encoding is a little odd but it can
56 // be deciphered fairly easily.
57 int shift
= ((conf
& 0x8) >> 1) | (conf
& 0x3);
58 shift
= (shift
+ 1) % 8;
66 decodeAddr(Addr paddr
)
76 regNum
= APIC_VERSION
;
79 regNum
= APIC_TASK_PRIORITY
;
82 regNum
= APIC_ARBITRATION_PRIORITY
;
85 regNum
= APIC_PROCESSOR_PRIORITY
;
91 regNum
= APIC_LOGICAL_DESTINATION
;
94 regNum
= APIC_DESTINATION_FORMAT
;
97 regNum
= APIC_SPURIOUS_INTERRUPT_VECTOR
;
115 regNum
= APIC_IN_SERVICE((paddr
- 0x100) / 0x8);
133 regNum
= APIC_TRIGGER_MODE((paddr
- 0x180) / 0x8);
151 regNum
= APIC_INTERRUPT_REQUEST((paddr
- 0x200) / 0x8);
154 regNum
= APIC_ERROR_STATUS
;
157 regNum
= APIC_INTERRUPT_COMMAND_LOW
;
160 regNum
= APIC_INTERRUPT_COMMAND_HIGH
;
163 regNum
= APIC_LVT_TIMER
;
166 regNum
= APIC_LVT_THERMAL_SENSOR
;
169 regNum
= APIC_LVT_PERFORMANCE_MONITORING_COUNTERS
;
172 regNum
= APIC_LVT_LINT0
;
175 regNum
= APIC_LVT_LINT1
;
178 regNum
= APIC_LVT_ERROR
;
181 regNum
= APIC_INITIAL_COUNT
;
184 regNum
= APIC_CURRENT_COUNT
;
187 regNum
= APIC_DIVIDE_CONFIGURATION
;
190 // A reserved register field.
191 panic("Accessed reserved register field %#x.\n", paddr
);
199 X86ISA::Interrupts::read(PacketPtr pkt
)
201 Addr offset
= pkt
->getAddr() - pioAddr
;
202 //Make sure we're at least only accessing one register.
203 if ((offset
& ~mask(3)) != ((offset
+ pkt
->getSize()) & ~mask(3)))
204 panic("Accessed more than one register at a time in the APIC!\n");
205 ApicRegIndex reg
= decodeAddr(offset
);
206 uint32_t val
= htog(readReg(reg
));
208 "Reading Local APIC register %d at offset %#x as %#x.\n",
210 pkt
->setData(((uint8_t *)&val
) + (offset
& mask(3)));
211 pkt
->makeAtomicResponse();
216 X86ISA::Interrupts::write(PacketPtr pkt
)
218 Addr offset
= pkt
->getAddr() - pioAddr
;
219 //Make sure we're at least only accessing one register.
220 if ((offset
& ~mask(3)) != ((offset
+ pkt
->getSize()) & ~mask(3)))
221 panic("Accessed more than one register at a time in the APIC!\n");
222 ApicRegIndex reg
= decodeAddr(offset
);
223 uint32_t val
= regs
[reg
];
224 pkt
->writeData(((uint8_t *)&val
) + (offset
& mask(3)));
226 "Writing Local APIC register %d at offset %#x as %#x.\n",
227 reg
, offset
, gtoh(val
));
228 setReg(reg
, gtoh(val
));
229 pkt
->makeAtomicResponse();
233 X86ISA::Interrupts::requestInterrupt(uint8_t vector
,
234 uint8_t deliveryMode
, bool level
)
237 * Fixed and lowest-priority delivery mode interrupts are handled
238 * using the IRR/ISR registers, checking against the TPR, etc.
239 * The SMI, NMI, ExtInt, INIT, etc interrupts go straight through.
241 if (deliveryMode
== DeliveryMode::Fixed
||
242 deliveryMode
== DeliveryMode::LowestPriority
) {
243 DPRINTF(LocalApic
, "Interrupt is an %s.\n",
244 DeliveryMode::names
[deliveryMode
]);
245 // Queue up the interrupt in the IRR.
248 if (!getRegArrayBit(APIC_INTERRUPT_REQUEST_BASE
, vector
)) {
249 setRegArrayBit(APIC_INTERRUPT_REQUEST_BASE
, vector
);
251 setRegArrayBit(APIC_TRIGGER_MODE_BASE
, vector
);
253 clearRegArrayBit(APIC_TRIGGER_MODE_BASE
, vector
);
256 } else if (!DeliveryMode::isReserved(deliveryMode
)) {
257 DPRINTF(LocalApic
, "Interrupt is an %s.\n",
258 DeliveryMode::names
[deliveryMode
]);
259 if (deliveryMode
== DeliveryMode::SMI
&& !pendingSmi
) {
260 pendingUnmaskableInt
= pendingSmi
= true;
262 } else if (deliveryMode
== DeliveryMode::NMI
&& !pendingNmi
) {
263 pendingUnmaskableInt
= pendingNmi
= true;
265 } else if (deliveryMode
== DeliveryMode::ExtInt
&& !pendingExtInt
) {
266 pendingExtInt
= true;
267 extIntVector
= vector
;
268 } else if (deliveryMode
== DeliveryMode::INIT
&& !pendingInit
) {
269 pendingUnmaskableInt
= pendingInit
= true;
271 } else if (deliveryMode
== DeliveryMode::SIPI
&&
272 !pendingStartup
&& !startedUp
) {
273 pendingUnmaskableInt
= pendingStartup
= true;
274 startupVector
= vector
;
282 X86ISA::Interrupts::setCPU(BaseCPU
* newCPU
)
285 if (cpu
!= NULL
&& cpu
->cpuId() != newCPU
->cpuId()) {
286 panic("Local APICs can't be moved between CPUs"
287 " with different IDs.\n");
290 initialApicId
= cpu
->cpuId();
291 regs
[APIC_ID
] = (initialApicId
<< 24);
296 X86ISA::Interrupts::init()
299 // The local apic must register its address ranges on both its pio port
300 // via the basicpiodevice(piodevice) init() function and its int port
301 // that it inherited from IntDev. Note IntDev is not a SimObject itself.
303 BasicPioDevice::init();
306 Pc
* pc
= dynamic_cast<Pc
*>(platform
);
308 pc
->southBridge
->ioApic
->registerLocalApic(initialApicId
, this);
313 X86ISA::Interrupts::recvMessage(PacketPtr pkt
)
315 Addr offset
= pkt
->getAddr() - x86InterruptAddress(initialApicId
, 0);
316 assert(pkt
->cmd
== MemCmd::MessageReq
);
321 TriggerIntMessage message
= pkt
->get
<TriggerIntMessage
>();
323 "Got Trigger Interrupt message with vector %#x.\n",
326 requestInterrupt(message
.vector
,
327 message
.deliveryMode
, message
.trigger
);
331 panic("Local apic got unknown interrupt message at offset %#x.\n",
335 pkt
->makeAtomicResponse();
341 X86ISA::Interrupts::recvResponse(PacketPtr pkt
)
343 assert(!pkt
->isError());
344 assert(pkt
->cmd
== MemCmd::MessageResp
);
345 if (--pendingIPIs
== 0) {
346 InterruptCommandRegLow low
= regs
[APIC_INTERRUPT_COMMAND_LOW
];
347 // Record that the ICR is now idle.
348 low
.deliveryStatus
= 0;
349 regs
[APIC_INTERRUPT_COMMAND_LOW
] = low
;
351 DPRINTF(LocalApic
, "ICR is now idle.\n");
357 X86ISA::Interrupts::addressRanges(AddrRangeList
&range_list
)
360 Range
<Addr
> range
= RangeEx(x86LocalAPICAddress(initialApicId
, 0),
361 x86LocalAPICAddress(initialApicId
, 0) +
363 range_list
.push_back(range
);
364 pioAddr
= range
.start
;
369 X86ISA::Interrupts::getIntAddrRange(AddrRangeList
&range_list
)
372 range_list
.push_back(RangeEx(x86InterruptAddress(initialApicId
, 0),
373 x86InterruptAddress(initialApicId
, 0) +
374 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
)
618 memset(regs
, 0, sizeof(regs
));
619 //Set the local apic DFR to the flat model.
620 regs
[APIC_DESTINATION_FORMAT
] = (uint32_t)(-1);
627 X86ISA::Interrupts::checkInterrupts(ThreadContext
*tc
) const
629 RFLAGS rflags
= tc
->readMiscRegNoEffect(MISCREG_RFLAGS
);
630 if (pendingUnmaskableInt
) {
631 DPRINTF(LocalApic
, "Reported pending unmaskable interrupt.\n");
636 DPRINTF(LocalApic
, "Reported pending external interrupt.\n");
639 if (IRRV
> ISRV
&& bits(IRRV
, 7, 4) >
640 bits(regs
[APIC_TASK_PRIORITY
], 7, 4)) {
641 DPRINTF(LocalApic
, "Reported pending regular interrupt.\n");
649 X86ISA::Interrupts::getInterrupt(ThreadContext
*tc
)
651 assert(checkInterrupts(tc
));
652 // These are all probably fairly uncommon, so we'll make them easier to
654 if (pendingUnmaskableInt
) {
656 DPRINTF(LocalApic
, "Generated SMI fault object.\n");
657 return new SystemManagementInterrupt();
658 } else if (pendingNmi
) {
659 DPRINTF(LocalApic
, "Generated NMI fault object.\n");
660 return new NonMaskableInterrupt(nmiVector
);
661 } else if (pendingInit
) {
662 DPRINTF(LocalApic
, "Generated INIT fault object.\n");
663 return new InitInterrupt(initVector
);
664 } else if (pendingStartup
) {
665 DPRINTF(LocalApic
, "Generating SIPI fault object.\n");
666 return new StartupInterrupt(startupVector
);
668 panic("pendingUnmaskableInt set, but no unmaskable "
669 "ints were pending.\n");
672 } else if (pendingExtInt
) {
673 DPRINTF(LocalApic
, "Generated external interrupt fault object.\n");
674 return new ExternalInterrupt(extIntVector
);
676 DPRINTF(LocalApic
, "Generated regular interrupt fault object.\n");
677 // The only thing left are fixed and lowest priority interrupts.
678 return new ExternalInterrupt(IRRV
);
683 X86ISA::Interrupts::updateIntrInfo(ThreadContext
*tc
)
685 assert(checkInterrupts(tc
));
686 if (pendingUnmaskableInt
) {
688 DPRINTF(LocalApic
, "SMI sent to core.\n");
690 } else if (pendingNmi
) {
691 DPRINTF(LocalApic
, "NMI sent to core.\n");
693 } else if (pendingInit
) {
694 DPRINTF(LocalApic
, "Init sent to core.\n");
697 } else if (pendingStartup
) {
698 DPRINTF(LocalApic
, "SIPI sent to core.\n");
699 pendingStartup
= false;
702 if (!(pendingSmi
|| pendingNmi
|| pendingInit
|| pendingStartup
))
703 pendingUnmaskableInt
= false;
704 } else if (pendingExtInt
) {
705 pendingExtInt
= false;
707 DPRINTF(LocalApic
, "Interrupt %d sent to core.\n", IRRV
);
708 // Mark the interrupt as "in service".
710 setRegArrayBit(APIC_IN_SERVICE_BASE
, ISRV
);
711 // Clear it out of the IRR.
712 clearRegArrayBit(APIC_INTERRUPT_REQUEST_BASE
, IRRV
);
718 X86ISA::Interrupts::serialize(std::ostream
&os
)
720 SERIALIZE_ARRAY(regs
, NUM_APIC_REGS
);
721 SERIALIZE_SCALAR(clock
);
722 SERIALIZE_SCALAR(pendingSmi
);
723 SERIALIZE_SCALAR(smiVector
);
724 SERIALIZE_SCALAR(pendingNmi
);
725 SERIALIZE_SCALAR(nmiVector
);
726 SERIALIZE_SCALAR(pendingExtInt
);
727 SERIALIZE_SCALAR(extIntVector
);
728 SERIALIZE_SCALAR(pendingInit
);
729 SERIALIZE_SCALAR(initVector
);
730 SERIALIZE_SCALAR(pendingStartup
);
731 SERIALIZE_SCALAR(startupVector
);
732 SERIALIZE_SCALAR(startedUp
);
733 SERIALIZE_SCALAR(pendingUnmaskableInt
);
734 SERIALIZE_SCALAR(pendingIPIs
);
735 SERIALIZE_SCALAR(IRRV
);
736 SERIALIZE_SCALAR(ISRV
);
737 bool apicTimerEventScheduled
= apicTimerEvent
.scheduled();
738 SERIALIZE_SCALAR(apicTimerEventScheduled
);
739 Tick apicTimerEventTick
= apicTimerEvent
.when();
740 SERIALIZE_SCALAR(apicTimerEventTick
);
744 X86ISA::Interrupts::unserialize(Checkpoint
*cp
, const std::string
§ion
)
746 UNSERIALIZE_ARRAY(regs
, NUM_APIC_REGS
);
747 UNSERIALIZE_SCALAR(clock
);
748 UNSERIALIZE_SCALAR(pendingSmi
);
749 UNSERIALIZE_SCALAR(smiVector
);
750 UNSERIALIZE_SCALAR(pendingNmi
);
751 UNSERIALIZE_SCALAR(nmiVector
);
752 UNSERIALIZE_SCALAR(pendingExtInt
);
753 UNSERIALIZE_SCALAR(extIntVector
);
754 UNSERIALIZE_SCALAR(pendingInit
);
755 UNSERIALIZE_SCALAR(initVector
);
756 UNSERIALIZE_SCALAR(pendingStartup
);
757 UNSERIALIZE_SCALAR(startupVector
);
758 UNSERIALIZE_SCALAR(startedUp
);
759 UNSERIALIZE_SCALAR(pendingUnmaskableInt
);
760 UNSERIALIZE_SCALAR(pendingIPIs
);
761 UNSERIALIZE_SCALAR(IRRV
);
762 UNSERIALIZE_SCALAR(ISRV
);
763 bool apicTimerEventScheduled
;
764 UNSERIALIZE_SCALAR(apicTimerEventScheduled
);
765 if (apicTimerEventScheduled
) {
766 Tick apicTimerEventTick
;
767 UNSERIALIZE_SCALAR(apicTimerEventTick
);
768 if (apicTimerEvent
.scheduled()) {
769 reschedule(apicTimerEvent
, apicTimerEventTick
, true);
771 schedule(apicTimerEvent
, apicTimerEventTick
);
777 X86LocalApicParams::create()
779 return new X86ISA::Interrupts(this);