4 * Copyright (c) 2004-2005 Fabrice Bellard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>
19 #include "qemu/osdep.h"
21 #include "qemu/thread.h"
22 #include "hw/i386/apic_internal.h"
23 #include "hw/i386/apic.h"
24 #include "hw/i386/ioapic.h"
25 #include "hw/intc/i8259.h"
26 #include "hw/pci/msi.h"
27 #include "qemu/host-utils.h"
29 #include "hw/i386/apic-msidef.h"
30 #include "qapi/error.h"
33 #define MAX_APIC_WORDS 8
35 #define SYNC_FROM_VAPIC 0x1
36 #define SYNC_TO_VAPIC 0x2
37 #define SYNC_ISR_IRR_TO_VAPIC 0x4
39 static APICCommonState
*local_apics
[MAX_APICS
+ 1];
41 #define TYPE_APIC "apic"
43 OBJECT_CHECK(APICCommonState, (obj), TYPE_APIC)
45 static void apic_set_irq(APICCommonState
*s
, int vector_num
, int trigger_mode
);
46 static void apic_update_irq(APICCommonState
*s
);
47 static void apic_get_delivery_bitmask(uint32_t *deliver_bitmask
,
48 uint8_t dest
, uint8_t dest_mode
);
50 /* Find first bit starting from msb */
51 static int apic_fls_bit(uint32_t value
)
53 return 31 - clz32(value
);
56 /* Find first bit starting from lsb */
57 static int apic_ffs_bit(uint32_t value
)
62 static inline void apic_reset_bit(uint32_t *tab
, int index
)
66 mask
= 1 << (index
& 0x1f);
70 /* return -1 if no bit is set */
71 static int get_highest_priority_int(uint32_t *tab
)
74 for (i
= 7; i
>= 0; i
--) {
76 return i
* 32 + apic_fls_bit(tab
[i
]);
82 static void apic_sync_vapic(APICCommonState
*s
, int sync_type
)
84 VAPICState vapic_state
;
89 if (!s
->vapic_paddr
) {
92 if (sync_type
& SYNC_FROM_VAPIC
) {
93 cpu_physical_memory_read(s
->vapic_paddr
, &vapic_state
,
95 s
->tpr
= vapic_state
.tpr
;
97 if (sync_type
& (SYNC_TO_VAPIC
| SYNC_ISR_IRR_TO_VAPIC
)) {
98 start
= offsetof(VAPICState
, isr
);
99 length
= offsetof(VAPICState
, enabled
) - offsetof(VAPICState
, isr
);
101 if (sync_type
& SYNC_TO_VAPIC
) {
102 assert(qemu_cpu_is_self(CPU(s
->cpu
)));
104 vapic_state
.tpr
= s
->tpr
;
105 vapic_state
.enabled
= 1;
107 length
= sizeof(VAPICState
);
110 vector
= get_highest_priority_int(s
->isr
);
114 vapic_state
.isr
= vector
& 0xf0;
116 vapic_state
.zero
= 0;
118 vector
= get_highest_priority_int(s
->irr
);
122 vapic_state
.irr
= vector
& 0xff;
124 address_space_write_rom(&address_space_memory
,
125 s
->vapic_paddr
+ start
,
126 MEMTXATTRS_UNSPECIFIED
,
127 ((void *)&vapic_state
) + start
, length
);
131 static void apic_vapic_base_update(APICCommonState
*s
)
133 apic_sync_vapic(s
, SYNC_TO_VAPIC
);
136 static void apic_local_deliver(APICCommonState
*s
, int vector
)
138 uint32_t lvt
= s
->lvt
[vector
];
141 trace_apic_local_deliver(vector
, (lvt
>> 8) & 7);
143 if (lvt
& APIC_LVT_MASKED
)
146 switch ((lvt
>> 8) & 7) {
148 cpu_interrupt(CPU(s
->cpu
), CPU_INTERRUPT_SMI
);
152 cpu_interrupt(CPU(s
->cpu
), CPU_INTERRUPT_NMI
);
156 cpu_interrupt(CPU(s
->cpu
), CPU_INTERRUPT_HARD
);
160 trigger_mode
= APIC_TRIGGER_EDGE
;
161 if ((vector
== APIC_LVT_LINT0
|| vector
== APIC_LVT_LINT1
) &&
162 (lvt
& APIC_LVT_LEVEL_TRIGGER
))
163 trigger_mode
= APIC_TRIGGER_LEVEL
;
164 apic_set_irq(s
, lvt
& 0xff, trigger_mode
);
168 void apic_deliver_pic_intr(DeviceState
*dev
, int level
)
170 APICCommonState
*s
= APIC(dev
);
173 apic_local_deliver(s
, APIC_LVT_LINT0
);
175 uint32_t lvt
= s
->lvt
[APIC_LVT_LINT0
];
177 switch ((lvt
>> 8) & 7) {
179 if (!(lvt
& APIC_LVT_LEVEL_TRIGGER
))
181 apic_reset_bit(s
->irr
, lvt
& 0xff);
190 static void apic_external_nmi(APICCommonState
*s
)
192 apic_local_deliver(s
, APIC_LVT_LINT1
);
195 #define foreach_apic(apic, deliver_bitmask, code) \
198 for(__i = 0; __i < MAX_APIC_WORDS; __i++) {\
199 uint32_t __mask = deliver_bitmask[__i];\
201 for(__j = 0; __j < 32; __j++) {\
202 if (__mask & (1U << __j)) {\
203 apic = local_apics[__i * 32 + __j];\
213 static void apic_bus_deliver(const uint32_t *deliver_bitmask
,
214 uint8_t delivery_mode
, uint8_t vector_num
,
215 uint8_t trigger_mode
)
217 APICCommonState
*apic_iter
;
219 switch (delivery_mode
) {
221 /* XXX: search for focus processor, arbitration */
225 for(i
= 0; i
< MAX_APIC_WORDS
; i
++) {
226 if (deliver_bitmask
[i
]) {
227 d
= i
* 32 + apic_ffs_bit(deliver_bitmask
[i
]);
232 apic_iter
= local_apics
[d
];
234 apic_set_irq(apic_iter
, vector_num
, trigger_mode
);
244 foreach_apic(apic_iter
, deliver_bitmask
,
245 cpu_interrupt(CPU(apic_iter
->cpu
), CPU_INTERRUPT_SMI
)
250 foreach_apic(apic_iter
, deliver_bitmask
,
251 cpu_interrupt(CPU(apic_iter
->cpu
), CPU_INTERRUPT_NMI
)
256 /* normal INIT IPI sent to processors */
257 foreach_apic(apic_iter
, deliver_bitmask
,
258 cpu_interrupt(CPU(apic_iter
->cpu
),
264 /* handled in I/O APIC code */
271 foreach_apic(apic_iter
, deliver_bitmask
,
272 apic_set_irq(apic_iter
, vector_num
, trigger_mode
) );
275 void apic_deliver_irq(uint8_t dest
, uint8_t dest_mode
, uint8_t delivery_mode
,
276 uint8_t vector_num
, uint8_t trigger_mode
)
278 uint32_t deliver_bitmask
[MAX_APIC_WORDS
];
280 trace_apic_deliver_irq(dest
, dest_mode
, delivery_mode
, vector_num
,
283 apic_get_delivery_bitmask(deliver_bitmask
, dest
, dest_mode
);
284 apic_bus_deliver(deliver_bitmask
, delivery_mode
, vector_num
, trigger_mode
);
287 static void apic_set_base(APICCommonState
*s
, uint64_t val
)
289 s
->apicbase
= (val
& 0xfffff000) |
290 (s
->apicbase
& (MSR_IA32_APICBASE_BSP
| MSR_IA32_APICBASE_ENABLE
));
291 /* if disabled, cannot be enabled again */
292 if (!(val
& MSR_IA32_APICBASE_ENABLE
)) {
293 s
->apicbase
&= ~MSR_IA32_APICBASE_ENABLE
;
294 cpu_clear_apic_feature(&s
->cpu
->env
);
295 s
->spurious_vec
&= ~APIC_SV_ENABLE
;
299 static void apic_set_tpr(APICCommonState
*s
, uint8_t val
)
301 /* Updates from cr8 are ignored while the VAPIC is active */
302 if (!s
->vapic_paddr
) {
308 int apic_get_highest_priority_irr(DeviceState
*dev
)
316 s
= APIC_COMMON(dev
);
317 return get_highest_priority_int(s
->irr
);
320 static uint8_t apic_get_tpr(APICCommonState
*s
)
322 apic_sync_vapic(s
, SYNC_FROM_VAPIC
);
326 int apic_get_ppr(APICCommonState
*s
)
331 isrv
= get_highest_priority_int(s
->isr
);
342 static int apic_get_arb_pri(APICCommonState
*s
)
344 /* XXX: arbitration */
350 * <0 - low prio interrupt,
352 * >0 - interrupt number
354 static int apic_irq_pending(APICCommonState
*s
)
358 if (!(s
->spurious_vec
& APIC_SV_ENABLE
)) {
362 irrv
= get_highest_priority_int(s
->irr
);
366 ppr
= apic_get_ppr(s
);
367 if (ppr
&& (irrv
& 0xf0) <= (ppr
& 0xf0)) {
374 /* signal the CPU if an irq is pending */
375 static void apic_update_irq(APICCommonState
*s
)
378 DeviceState
*dev
= (DeviceState
*)s
;
381 if (!qemu_cpu_is_self(cpu
)) {
382 cpu_interrupt(cpu
, CPU_INTERRUPT_POLL
);
383 } else if (apic_irq_pending(s
) > 0) {
384 cpu_interrupt(cpu
, CPU_INTERRUPT_HARD
);
385 } else if (!apic_accept_pic_intr(dev
) || !pic_get_output(isa_pic
)) {
386 cpu_reset_interrupt(cpu
, CPU_INTERRUPT_HARD
);
390 void apic_poll_irq(DeviceState
*dev
)
392 APICCommonState
*s
= APIC(dev
);
394 apic_sync_vapic(s
, SYNC_FROM_VAPIC
);
398 static void apic_set_irq(APICCommonState
*s
, int vector_num
, int trigger_mode
)
400 apic_report_irq_delivered(!apic_get_bit(s
->irr
, vector_num
));
402 apic_set_bit(s
->irr
, vector_num
);
404 apic_set_bit(s
->tmr
, vector_num
);
406 apic_reset_bit(s
->tmr
, vector_num
);
407 if (s
->vapic_paddr
) {
408 apic_sync_vapic(s
, SYNC_ISR_IRR_TO_VAPIC
);
410 * The vcpu thread needs to see the new IRR before we pull its current
411 * TPR value. That way, if we miss a lowering of the TRP, the guest
412 * has the chance to notice the new IRR and poll for IRQs on its own.
415 apic_sync_vapic(s
, SYNC_FROM_VAPIC
);
420 static void apic_eoi(APICCommonState
*s
)
423 isrv
= get_highest_priority_int(s
->isr
);
426 apic_reset_bit(s
->isr
, isrv
);
427 if (!(s
->spurious_vec
& APIC_SV_DIRECTED_IO
) && apic_get_bit(s
->tmr
, isrv
)) {
428 ioapic_eoi_broadcast(isrv
);
430 apic_sync_vapic(s
, SYNC_FROM_VAPIC
| SYNC_TO_VAPIC
);
434 static int apic_find_dest(uint8_t dest
)
436 APICCommonState
*apic
= local_apics
[dest
];
439 if (apic
&& apic
->id
== dest
)
440 return dest
; /* shortcut in case apic->id == local_apics[dest]->id */
442 for (i
= 0; i
< MAX_APICS
; i
++) {
443 apic
= local_apics
[i
];
444 if (apic
&& apic
->id
== dest
)
453 static void apic_get_delivery_bitmask(uint32_t *deliver_bitmask
,
454 uint8_t dest
, uint8_t dest_mode
)
456 APICCommonState
*apic_iter
;
459 if (dest_mode
== 0) {
461 memset(deliver_bitmask
, 0xff, MAX_APIC_WORDS
* sizeof(uint32_t));
463 int idx
= apic_find_dest(dest
);
464 memset(deliver_bitmask
, 0x00, MAX_APIC_WORDS
* sizeof(uint32_t));
466 apic_set_bit(deliver_bitmask
, idx
);
469 /* XXX: cluster mode */
470 memset(deliver_bitmask
, 0x00, MAX_APIC_WORDS
* sizeof(uint32_t));
471 for(i
= 0; i
< MAX_APICS
; i
++) {
472 apic_iter
= local_apics
[i
];
474 if (apic_iter
->dest_mode
== 0xf) {
475 if (dest
& apic_iter
->log_dest
)
476 apic_set_bit(deliver_bitmask
, i
);
477 } else if (apic_iter
->dest_mode
== 0x0) {
478 if ((dest
& 0xf0) == (apic_iter
->log_dest
& 0xf0) &&
479 (dest
& apic_iter
->log_dest
& 0x0f)) {
480 apic_set_bit(deliver_bitmask
, i
);
490 static void apic_startup(APICCommonState
*s
, int vector_num
)
492 s
->sipi_vector
= vector_num
;
493 cpu_interrupt(CPU(s
->cpu
), CPU_INTERRUPT_SIPI
);
496 void apic_sipi(DeviceState
*dev
)
498 APICCommonState
*s
= APIC(dev
);
500 cpu_reset_interrupt(CPU(s
->cpu
), CPU_INTERRUPT_SIPI
);
502 if (!s
->wait_for_sipi
)
504 cpu_x86_load_seg_cache_sipi(s
->cpu
, s
->sipi_vector
);
505 s
->wait_for_sipi
= 0;
508 static void apic_deliver(DeviceState
*dev
, uint8_t dest
, uint8_t dest_mode
,
509 uint8_t delivery_mode
, uint8_t vector_num
,
510 uint8_t trigger_mode
)
512 APICCommonState
*s
= APIC(dev
);
513 uint32_t deliver_bitmask
[MAX_APIC_WORDS
];
514 int dest_shorthand
= (s
->icr
[0] >> 18) & 3;
515 APICCommonState
*apic_iter
;
517 switch (dest_shorthand
) {
519 apic_get_delivery_bitmask(deliver_bitmask
, dest
, dest_mode
);
522 memset(deliver_bitmask
, 0x00, sizeof(deliver_bitmask
));
523 apic_set_bit(deliver_bitmask
, s
->id
);
526 memset(deliver_bitmask
, 0xff, sizeof(deliver_bitmask
));
529 memset(deliver_bitmask
, 0xff, sizeof(deliver_bitmask
));
530 apic_reset_bit(deliver_bitmask
, s
->id
);
534 switch (delivery_mode
) {
537 int trig_mode
= (s
->icr
[0] >> 15) & 1;
538 int level
= (s
->icr
[0] >> 14) & 1;
539 if (level
== 0 && trig_mode
== 1) {
540 foreach_apic(apic_iter
, deliver_bitmask
,
541 apic_iter
->arb_id
= apic_iter
->id
);
548 foreach_apic(apic_iter
, deliver_bitmask
,
549 apic_startup(apic_iter
, vector_num
) );
553 apic_bus_deliver(deliver_bitmask
, delivery_mode
, vector_num
, trigger_mode
);
556 static bool apic_check_pic(APICCommonState
*s
)
558 DeviceState
*dev
= (DeviceState
*)s
;
560 if (!apic_accept_pic_intr(dev
) || !pic_get_output(isa_pic
)) {
563 apic_deliver_pic_intr(dev
, 1);
567 int apic_get_interrupt(DeviceState
*dev
)
569 APICCommonState
*s
= APIC(dev
);
572 /* if the APIC is installed or enabled, we let the 8259 handle the
576 if (!(s
->spurious_vec
& APIC_SV_ENABLE
))
579 apic_sync_vapic(s
, SYNC_FROM_VAPIC
);
580 intno
= apic_irq_pending(s
);
582 /* if there is an interrupt from the 8259, let the caller handle
583 * that first since ExtINT interrupts ignore the priority.
585 if (intno
== 0 || apic_check_pic(s
)) {
586 apic_sync_vapic(s
, SYNC_TO_VAPIC
);
588 } else if (intno
< 0) {
589 apic_sync_vapic(s
, SYNC_TO_VAPIC
);
590 return s
->spurious_vec
& 0xff;
592 apic_reset_bit(s
->irr
, intno
);
593 apic_set_bit(s
->isr
, intno
);
594 apic_sync_vapic(s
, SYNC_TO_VAPIC
);
601 int apic_accept_pic_intr(DeviceState
*dev
)
603 APICCommonState
*s
= APIC(dev
);
609 lvt0
= s
->lvt
[APIC_LVT_LINT0
];
611 if ((s
->apicbase
& MSR_IA32_APICBASE_ENABLE
) == 0 ||
612 (lvt0
& APIC_LVT_MASKED
) == 0)
613 return isa_pic
!= NULL
;
618 static void apic_timer_update(APICCommonState
*s
, int64_t current_time
)
620 if (apic_next_timer(s
, current_time
)) {
621 timer_mod(s
->timer
, s
->next_time
);
627 static void apic_timer(void *opaque
)
629 APICCommonState
*s
= opaque
;
631 apic_local_deliver(s
, APIC_LVT_TIMER
);
632 apic_timer_update(s
, s
->next_time
);
635 static uint64_t apic_mem_read(void *opaque
, hwaddr addr
, unsigned size
)
646 dev
= cpu_get_current_apic();
652 index
= (addr
>> 4) & 0xff;
657 case 0x03: /* version */
658 val
= s
->version
| ((APIC_LVT_NB
- 1) << 16);
661 apic_sync_vapic(s
, SYNC_FROM_VAPIC
);
662 if (apic_report_tpr_access
) {
663 cpu_report_tpr_access(&s
->cpu
->env
, TPR_ACCESS_READ
);
668 val
= apic_get_arb_pri(s
);
672 val
= apic_get_ppr(s
);
678 val
= s
->log_dest
<< 24;
681 val
= (s
->dest_mode
<< 28) | 0xfffffff;
684 val
= s
->spurious_vec
;
687 val
= s
->isr
[index
& 7];
690 val
= s
->tmr
[index
& 7];
693 val
= s
->irr
[index
& 7];
700 val
= s
->icr
[index
& 1];
703 val
= s
->lvt
[index
- 0x32];
706 val
= s
->initial_count
;
709 val
= apic_get_current_count(s
);
712 val
= s
->divide_conf
;
715 s
->esr
|= APIC_ESR_ILLEGAL_ADDRESS
;
719 trace_apic_mem_readl(addr
, val
);
723 static void apic_send_msi(MSIMessage
*msi
)
725 uint64_t addr
= msi
->address
;
726 uint32_t data
= msi
->data
;
727 uint8_t dest
= (addr
& MSI_ADDR_DEST_ID_MASK
) >> MSI_ADDR_DEST_ID_SHIFT
;
728 uint8_t vector
= (data
& MSI_DATA_VECTOR_MASK
) >> MSI_DATA_VECTOR_SHIFT
;
729 uint8_t dest_mode
= (addr
>> MSI_ADDR_DEST_MODE_SHIFT
) & 0x1;
730 uint8_t trigger_mode
= (data
>> MSI_DATA_TRIGGER_SHIFT
) & 0x1;
731 uint8_t delivery
= (data
>> MSI_DATA_DELIVERY_MODE_SHIFT
) & 0x7;
732 /* XXX: Ignore redirection hint. */
733 apic_deliver_irq(dest
, dest_mode
, delivery
, vector
, trigger_mode
);
736 static void apic_mem_write(void *opaque
, hwaddr addr
, uint64_t val
,
741 int index
= (addr
>> 4) & 0xff;
747 if (addr
> 0xfff || !index
) {
748 /* MSI and MMIO APIC are at the same memory location,
749 * but actually not on the global bus: MSI is on PCI bus
750 * APIC is connected directly to the CPU.
751 * Mapping them on the global bus happens to work because
752 * MSI registers are reserved in APIC MMIO and vice versa. */
753 MSIMessage msi
= { .address
= addr
, .data
= val
};
758 dev
= cpu_get_current_apic();
764 trace_apic_mem_writel(addr
, val
);
773 if (apic_report_tpr_access
) {
774 cpu_report_tpr_access(&s
->cpu
->env
, TPR_ACCESS_WRITE
);
777 apic_sync_vapic(s
, SYNC_TO_VAPIC
);
787 s
->log_dest
= val
>> 24;
790 s
->dest_mode
= val
>> 28;
793 s
->spurious_vec
= val
& 0x1ff;
803 apic_deliver(dev
, (s
->icr
[1] >> 24) & 0xff, (s
->icr
[0] >> 11) & 1,
804 (s
->icr
[0] >> 8) & 7, (s
->icr
[0] & 0xff),
805 (s
->icr
[0] >> 15) & 1);
812 int n
= index
- 0x32;
814 if (n
== APIC_LVT_TIMER
) {
815 apic_timer_update(s
, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
));
816 } else if (n
== APIC_LVT_LINT0
&& apic_check_pic(s
)) {
822 s
->initial_count
= val
;
823 s
->initial_count_load_time
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
824 apic_timer_update(s
, s
->initial_count_load_time
);
831 s
->divide_conf
= val
& 0xb;
832 v
= (s
->divide_conf
& 3) | ((s
->divide_conf
>> 1) & 4);
833 s
->count_shift
= (v
+ 1) & 7;
837 s
->esr
|= APIC_ESR_ILLEGAL_ADDRESS
;
842 static void apic_pre_save(APICCommonState
*s
)
844 apic_sync_vapic(s
, SYNC_FROM_VAPIC
);
847 static void apic_post_load(APICCommonState
*s
)
849 if (s
->timer_expiry
!= -1) {
850 timer_mod(s
->timer
, s
->timer_expiry
);
856 static const MemoryRegionOps apic_io_ops
= {
857 .read
= apic_mem_read
,
858 .write
= apic_mem_write
,
859 .impl
.min_access_size
= 1,
860 .impl
.max_access_size
= 4,
861 .valid
.min_access_size
= 1,
862 .valid
.max_access_size
= 4,
863 .endianness
= DEVICE_NATIVE_ENDIAN
,
866 static void apic_realize(DeviceState
*dev
, Error
**errp
)
868 APICCommonState
*s
= APIC(dev
);
870 if (s
->id
>= MAX_APICS
) {
871 error_setg(errp
, "%s initialization failed. APIC ID %d is invalid",
872 object_get_typename(OBJECT(dev
)), s
->id
);
876 memory_region_init_io(&s
->io_memory
, OBJECT(s
), &apic_io_ops
, s
, "apic-msi",
879 s
->timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
, apic_timer
, s
);
880 local_apics
[s
->id
] = s
;
882 msi_nonbroken
= true;
885 static void apic_unrealize(DeviceState
*dev
)
887 APICCommonState
*s
= APIC(dev
);
890 timer_free(s
->timer
);
891 local_apics
[s
->id
] = NULL
;
894 static void apic_class_init(ObjectClass
*klass
, void *data
)
896 APICCommonClass
*k
= APIC_COMMON_CLASS(klass
);
898 k
->realize
= apic_realize
;
899 k
->unrealize
= apic_unrealize
;
900 k
->set_base
= apic_set_base
;
901 k
->set_tpr
= apic_set_tpr
;
902 k
->get_tpr
= apic_get_tpr
;
903 k
->vapic_base_update
= apic_vapic_base_update
;
904 k
->external_nmi
= apic_external_nmi
;
905 k
->pre_save
= apic_pre_save
;
906 k
->post_load
= apic_post_load
;
907 k
->send_msi
= apic_send_msi
;
910 static const TypeInfo apic_info
= {
912 .instance_size
= sizeof(APICCommonState
),
913 .parent
= TYPE_APIC_COMMON
,
914 .class_init
= apic_class_init
,
917 static void apic_register_types(void)
919 type_register_static(&apic_info
);
922 type_init(apic_register_types
)