2 * ARM Generic Interrupt Controller using KVM in-kernel support
4 * Copyright (c) 2012 Linaro Limited
5 * Written by Peter Maydell
6 * Save/Restore logic added by Christoffer Dall.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, see <http://www.gnu.org/licenses/>.
22 #include "hw/sysbus.h"
23 #include "sysemu/kvm.h"
25 #include "gic_internal.h"
27 //#define DEBUG_GIC_KVM
30 static const int debug_gic_kvm
= 1;
32 static const int debug_gic_kvm
= 0;
35 #define DPRINTF(fmt, ...) do { \
36 if (debug_gic_kvm) { \
37 printf("arm_gic: " fmt , ## __VA_ARGS__); \
41 #define TYPE_KVM_ARM_GIC "kvm-arm-gic"
42 #define KVM_ARM_GIC(obj) \
43 OBJECT_CHECK(GICState, (obj), TYPE_KVM_ARM_GIC)
44 #define KVM_ARM_GIC_CLASS(klass) \
45 OBJECT_CLASS_CHECK(KVMARMGICClass, (klass), TYPE_KVM_ARM_GIC)
46 #define KVM_ARM_GIC_GET_CLASS(obj) \
47 OBJECT_GET_CLASS(KVMARMGICClass, (obj), TYPE_KVM_ARM_GIC)
49 typedef struct KVMARMGICClass
{
50 ARMGICCommonClass parent_class
;
51 DeviceRealize parent_realize
;
52 void (*parent_reset
)(DeviceState
*dev
);
55 static void kvm_arm_gic_set_irq(void *opaque
, int irq
, int level
)
57 /* Meaning of the 'irq' parameter:
58 * [0..N-1] : external interrupts
59 * [N..N+31] : PPI (internal) interrupts for CPU 0
60 * [N+32..N+63] : PPI (internal interrupts for CPU 1
62 * Convert this to the kernel's desired encoding, which
63 * has separate fields in the irq number for type,
64 * CPU number and interrupt number.
66 GICState
*s
= (GICState
*)opaque
;
67 int kvm_irq
, irqtype
, cpu
;
69 if (irq
< (s
->num_irq
- GIC_INTERNAL
)) {
70 /* External interrupt. The kernel numbers these like the GIC
71 * hardware, with external interrupt IDs starting after the
74 irqtype
= KVM_ARM_IRQ_TYPE_SPI
;
78 /* Internal interrupt: decode into (cpu, interrupt id) */
79 irqtype
= KVM_ARM_IRQ_TYPE_PPI
;
80 irq
-= (s
->num_irq
- GIC_INTERNAL
);
81 cpu
= irq
/ GIC_INTERNAL
;
84 kvm_irq
= (irqtype
<< KVM_ARM_IRQ_TYPE_SHIFT
)
85 | (cpu
<< KVM_ARM_IRQ_VCPU_SHIFT
) | irq
;
87 kvm_set_irq(kvm_state
, kvm_irq
, !!level
);
90 static bool kvm_arm_gic_can_save_restore(GICState
*s
)
92 return s
->dev_fd
>= 0;
95 static bool kvm_gic_supports_attr(GICState
*s
, int group
, int attrnum
)
97 struct kvm_device_attr attr
= {
103 if (s
->dev_fd
== -1) {
107 return kvm_device_ioctl(s
->dev_fd
, KVM_HAS_DEVICE_ATTR
, &attr
) == 0;
110 static void kvm_gic_access(GICState
*s
, int group
, int offset
,
111 int cpu
, uint32_t *val
, bool write
)
113 struct kvm_device_attr attr
;
121 attr
.attr
= (((uint64_t)cpu
<< KVM_DEV_ARM_VGIC_CPUID_SHIFT
) &
122 KVM_DEV_ARM_VGIC_CPUID_MASK
) |
123 (((uint64_t)offset
<< KVM_DEV_ARM_VGIC_OFFSET_SHIFT
) &
124 KVM_DEV_ARM_VGIC_OFFSET_MASK
);
125 attr
.addr
= (uintptr_t)val
;
128 type
= KVM_SET_DEVICE_ATTR
;
130 type
= KVM_GET_DEVICE_ATTR
;
133 err
= kvm_device_ioctl(s
->dev_fd
, type
, &attr
);
135 fprintf(stderr
, "KVM_{SET/GET}_DEVICE_ATTR failed: %s\n",
141 static void kvm_gicd_access(GICState
*s
, int offset
, int cpu
,
142 uint32_t *val
, bool write
)
144 kvm_gic_access(s
, KVM_DEV_ARM_VGIC_GRP_DIST_REGS
,
145 offset
, cpu
, val
, write
);
148 static void kvm_gicc_access(GICState
*s
, int offset
, int cpu
,
149 uint32_t *val
, bool write
)
151 kvm_gic_access(s
, KVM_DEV_ARM_VGIC_GRP_CPU_REGS
,
152 offset
, cpu
, val
, write
);
155 #define for_each_irq_reg(_ctr, _max_irq, _field_width) \
156 for (_ctr = 0; _ctr < ((_max_irq) / (32 / (_field_width))); _ctr++)
159 * Translate from the in-kernel field for an IRQ value to/from the qemu
162 typedef void (*vgic_translate_fn
)(GICState
*s
, int irq
, int cpu
,
163 uint32_t *field
, bool to_kernel
);
165 /* synthetic translate function used for clear/set registers to completely
166 * clear a setting using a clear-register before setting the remaining bits
167 * using a set-register */
168 static void translate_clear(GICState
*s
, int irq
, int cpu
,
169 uint32_t *field
, bool to_kernel
)
174 /* does not make sense: qemu model doesn't use set/clear regs */
179 static void translate_enabled(GICState
*s
, int irq
, int cpu
,
180 uint32_t *field
, bool to_kernel
)
182 int cm
= (irq
< GIC_INTERNAL
) ? (1 << cpu
) : ALL_CPU_MASK
;
185 *field
= GIC_TEST_ENABLED(irq
, cm
);
188 GIC_SET_ENABLED(irq
, cm
);
193 static void translate_pending(GICState
*s
, int irq
, int cpu
,
194 uint32_t *field
, bool to_kernel
)
196 int cm
= (irq
< GIC_INTERNAL
) ? (1 << cpu
) : ALL_CPU_MASK
;
199 *field
= gic_test_pending(s
, irq
, cm
);
202 GIC_SET_PENDING(irq
, cm
);
203 /* TODO: Capture is level-line is held high in the kernel */
208 static void translate_active(GICState
*s
, int irq
, int cpu
,
209 uint32_t *field
, bool to_kernel
)
211 int cm
= (irq
< GIC_INTERNAL
) ? (1 << cpu
) : ALL_CPU_MASK
;
214 *field
= GIC_TEST_ACTIVE(irq
, cm
);
217 GIC_SET_ACTIVE(irq
, cm
);
222 static void translate_trigger(GICState
*s
, int irq
, int cpu
,
223 uint32_t *field
, bool to_kernel
)
226 *field
= (GIC_TEST_EDGE_TRIGGER(irq
)) ? 0x2 : 0x0;
229 GIC_SET_EDGE_TRIGGER(irq
);
234 static void translate_priority(GICState
*s
, int irq
, int cpu
,
235 uint32_t *field
, bool to_kernel
)
238 *field
= GIC_GET_PRIORITY(irq
, cpu
) & 0xff;
240 gic_set_priority(s
, cpu
, irq
, *field
& 0xff);
244 static void translate_targets(GICState
*s
, int irq
, int cpu
,
245 uint32_t *field
, bool to_kernel
)
248 *field
= s
->irq_target
[irq
] & 0xff;
250 s
->irq_target
[irq
] = *field
& 0xff;
254 static void translate_sgisource(GICState
*s
, int irq
, int cpu
,
255 uint32_t *field
, bool to_kernel
)
258 *field
= s
->sgi_pending
[irq
][cpu
] & 0xff;
260 s
->sgi_pending
[irq
][cpu
] = *field
& 0xff;
264 /* Read a register group from the kernel VGIC */
265 static void kvm_dist_get(GICState
*s
, uint32_t offset
, int width
,
266 int maxirq
, vgic_translate_fn translate_fn
)
273 int regsz
= 32 / width
; /* irqs per kernel register */
276 for_each_irq_reg(i
, maxirq
, width
) {
279 while ((cpu
< s
->num_cpu
&& irq
< GIC_INTERNAL
) || cpu
== 0) {
280 kvm_gicd_access(s
, offset
, cpu
, ®
, false);
281 for (j
= 0; j
< regsz
; j
++) {
282 field
= extract32(reg
, j
* width
, width
);
283 translate_fn(s
, irq
+ j
, cpu
, &field
, false);
292 /* Write a register group to the kernel VGIC */
293 static void kvm_dist_put(GICState
*s
, uint32_t offset
, int width
,
294 int maxirq
, vgic_translate_fn translate_fn
)
301 int regsz
= 32 / width
; /* irqs per kernel register */
304 for_each_irq_reg(i
, maxirq
, width
) {
307 while ((cpu
< s
->num_cpu
&& irq
< GIC_INTERNAL
) || cpu
== 0) {
309 for (j
= 0; j
< regsz
; j
++) {
310 translate_fn(s
, irq
+ j
, cpu
, &field
, true);
311 reg
= deposit32(reg
, j
* width
, width
, field
);
313 kvm_gicd_access(s
, offset
, cpu
, ®
, true);
321 static void kvm_arm_gic_put(GICState
*s
)
329 if (!kvm_arm_gic_can_save_restore(s
)) {
330 DPRINTF("Cannot put kernel gic state, no kernel interface");
334 /* Note: We do the restore in a slightly different order than the save
335 * (where the order doesn't matter and is simply ordered according to the
336 * register offset values */
338 /*****************************************************************
342 /* s->enabled -> GICD_CTLR */
344 kvm_gicd_access(s
, 0x0, 0, ®
, true);
346 /* Sanity checking on GICD_TYPER and s->num_irq, s->num_cpu */
347 kvm_gicd_access(s
, 0x4, 0, ®
, false);
348 num_irq
= ((reg
& 0x1f) + 1) * 32;
349 num_cpu
= ((reg
& 0xe0) >> 5) + 1;
351 if (num_irq
< s
->num_irq
) {
352 fprintf(stderr
, "Restoring %u IRQs, but kernel supports max %d\n",
353 s
->num_irq
, num_irq
);
355 } else if (num_cpu
!= s
->num_cpu
) {
356 fprintf(stderr
, "Restoring %u CPU interfaces, kernel only has %d\n",
357 s
->num_cpu
, num_cpu
);
358 /* Did we not create the VCPUs in the kernel yet? */
362 /* TODO: Consider checking compatibility with the IIDR ? */
364 /* irq_state[n].enabled -> GICD_ISENABLERn */
365 kvm_dist_put(s
, 0x180, 1, s
->num_irq
, translate_clear
);
366 kvm_dist_put(s
, 0x100, 1, s
->num_irq
, translate_enabled
);
368 /* s->irq_target[irq] -> GICD_ITARGETSRn
369 * (restore targets before pending to ensure the pending state is set on
370 * the appropriate CPU interfaces in the kernel) */
371 kvm_dist_put(s
, 0x800, 8, s
->num_irq
, translate_targets
);
373 /* irq_state[n].pending + irq_state[n].level -> GICD_ISPENDRn */
374 kvm_dist_put(s
, 0x280, 1, s
->num_irq
, translate_clear
);
375 kvm_dist_put(s
, 0x200, 1, s
->num_irq
, translate_pending
);
377 /* irq_state[n].active -> GICD_ISACTIVERn */
378 kvm_dist_put(s
, 0x380, 1, s
->num_irq
, translate_clear
);
379 kvm_dist_put(s
, 0x300, 1, s
->num_irq
, translate_active
);
381 /* irq_state[n].trigger -> GICD_ICFRn */
382 kvm_dist_put(s
, 0xc00, 2, s
->num_irq
, translate_trigger
);
384 /* s->priorityX[irq] -> ICD_IPRIORITYRn */
385 kvm_dist_put(s
, 0x400, 8, s
->num_irq
, translate_priority
);
387 /* s->sgi_pending -> ICD_CPENDSGIRn */
388 kvm_dist_put(s
, 0xf10, 8, GIC_NR_SGIS
, translate_clear
);
389 kvm_dist_put(s
, 0xf20, 8, GIC_NR_SGIS
, translate_sgisource
);
392 /*****************************************************************
393 * CPU Interface(s) State
396 for (cpu
= 0; cpu
< s
->num_cpu
; cpu
++) {
397 /* s->cpu_enabled[cpu] -> GICC_CTLR */
398 reg
= s
->cpu_enabled
[cpu
];
399 kvm_gicc_access(s
, 0x00, cpu
, ®
, true);
401 /* s->priority_mask[cpu] -> GICC_PMR */
402 reg
= (s
->priority_mask
[cpu
] & 0xff);
403 kvm_gicc_access(s
, 0x04, cpu
, ®
, true);
405 /* s->bpr[cpu] -> GICC_BPR */
406 reg
= (s
->bpr
[cpu
] & 0x7);
407 kvm_gicc_access(s
, 0x08, cpu
, ®
, true);
409 /* s->abpr[cpu] -> GICC_ABPR */
410 reg
= (s
->abpr
[cpu
] & 0x7);
411 kvm_gicc_access(s
, 0x1c, cpu
, ®
, true);
413 /* s->apr[n][cpu] -> GICC_APRn */
414 for (i
= 0; i
< 4; i
++) {
415 reg
= s
->apr
[i
][cpu
];
416 kvm_gicc_access(s
, 0xd0 + i
* 4, cpu
, ®
, true);
421 static void kvm_arm_gic_get(GICState
*s
)
427 if (!kvm_arm_gic_can_save_restore(s
)) {
428 DPRINTF("Cannot get kernel gic state, no kernel interface");
432 /*****************************************************************
436 /* GICD_CTLR -> s->enabled */
437 kvm_gicd_access(s
, 0x0, 0, ®
, false);
438 s
->enabled
= reg
& 1;
440 /* Sanity checking on GICD_TYPER -> s->num_irq, s->num_cpu */
441 kvm_gicd_access(s
, 0x4, 0, ®
, false);
442 s
->num_irq
= ((reg
& 0x1f) + 1) * 32;
443 s
->num_cpu
= ((reg
& 0xe0) >> 5) + 1;
445 if (s
->num_irq
> GIC_MAXIRQ
) {
446 fprintf(stderr
, "Too many IRQs reported from the kernel: %d\n",
452 kvm_gicd_access(s
, 0x8, 0, ®
, false);
454 /* Verify no GROUP 1 interrupts configured in the kernel */
455 for_each_irq_reg(i
, s
->num_irq
, 1) {
456 kvm_gicd_access(s
, 0x80 + (i
* 4), 0, ®
, false);
458 fprintf(stderr
, "Unsupported GICD_IGROUPRn value: %08x\n",
464 /* Clear all the IRQ settings */
465 for (i
= 0; i
< s
->num_irq
; i
++) {
466 memset(&s
->irq_state
[i
], 0, sizeof(s
->irq_state
[0]));
469 /* GICD_ISENABLERn -> irq_state[n].enabled */
470 kvm_dist_get(s
, 0x100, 1, s
->num_irq
, translate_enabled
);
472 /* GICD_ISPENDRn -> irq_state[n].pending + irq_state[n].level */
473 kvm_dist_get(s
, 0x200, 1, s
->num_irq
, translate_pending
);
475 /* GICD_ISACTIVERn -> irq_state[n].active */
476 kvm_dist_get(s
, 0x300, 1, s
->num_irq
, translate_active
);
478 /* GICD_ICFRn -> irq_state[n].trigger */
479 kvm_dist_get(s
, 0xc00, 2, s
->num_irq
, translate_trigger
);
481 /* GICD_IPRIORITYRn -> s->priorityX[irq] */
482 kvm_dist_get(s
, 0x400, 8, s
->num_irq
, translate_priority
);
484 /* GICD_ITARGETSRn -> s->irq_target[irq] */
485 kvm_dist_get(s
, 0x800, 8, s
->num_irq
, translate_targets
);
487 /* GICD_CPENDSGIRn -> s->sgi_pending */
488 kvm_dist_get(s
, 0xf10, 8, GIC_NR_SGIS
, translate_sgisource
);
491 /*****************************************************************
492 * CPU Interface(s) State
495 for (cpu
= 0; cpu
< s
->num_cpu
; cpu
++) {
496 /* GICC_CTLR -> s->cpu_enabled[cpu] */
497 kvm_gicc_access(s
, 0x00, cpu
, ®
, false);
498 s
->cpu_enabled
[cpu
] = (reg
& 1);
500 /* GICC_PMR -> s->priority_mask[cpu] */
501 kvm_gicc_access(s
, 0x04, cpu
, ®
, false);
502 s
->priority_mask
[cpu
] = (reg
& 0xff);
504 /* GICC_BPR -> s->bpr[cpu] */
505 kvm_gicc_access(s
, 0x08, cpu
, ®
, false);
506 s
->bpr
[cpu
] = (reg
& 0x7);
508 /* GICC_ABPR -> s->abpr[cpu] */
509 kvm_gicc_access(s
, 0x1c, cpu
, ®
, false);
510 s
->abpr
[cpu
] = (reg
& 0x7);
512 /* GICC_APRn -> s->apr[n][cpu] */
513 for (i
= 0; i
< 4; i
++) {
514 kvm_gicc_access(s
, 0xd0 + i
* 4, cpu
, ®
, false);
515 s
->apr
[i
][cpu
] = reg
;
520 static void kvm_arm_gic_reset(DeviceState
*dev
)
522 GICState
*s
= ARM_GIC_COMMON(dev
);
523 KVMARMGICClass
*kgc
= KVM_ARM_GIC_GET_CLASS(s
);
525 kgc
->parent_reset(dev
);
529 static void kvm_arm_gic_realize(DeviceState
*dev
, Error
**errp
)
532 GICState
*s
= KVM_ARM_GIC(dev
);
533 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
534 KVMARMGICClass
*kgc
= KVM_ARM_GIC_GET_CLASS(s
);
535 Error
*local_err
= NULL
;
538 kgc
->parent_realize(dev
, &local_err
);
540 error_propagate(errp
, local_err
);
544 i
= s
->num_irq
- GIC_INTERNAL
;
545 /* For the GIC, also expose incoming GPIO lines for PPIs for each CPU.
546 * GPIO array layout is thus:
548 * [N..N+31] PPIs for CPU 0
549 * [N+32..N+63] PPIs for CPU 1
552 i
+= (GIC_INTERNAL
* s
->num_cpu
);
553 qdev_init_gpio_in(dev
, kvm_arm_gic_set_irq
, i
);
554 /* We never use our outbound IRQ lines but provide them so that
555 * we maintain the same interface as the non-KVM GIC.
557 for (i
= 0; i
< s
->num_cpu
; i
++) {
558 sysbus_init_irq(sbd
, &s
->parent_irq
[i
]);
561 /* Try to create the device via the device control API */
563 ret
= kvm_create_device(kvm_state
, KVM_DEV_TYPE_ARM_VGIC_V2
, false);
566 } else if (ret
!= -ENODEV
&& ret
!= -ENOTSUP
) {
567 error_setg_errno(errp
, -ret
, "error creating in-kernel VGIC");
571 if (kvm_gic_supports_attr(s
, KVM_DEV_ARM_VGIC_GRP_NR_IRQS
, 0)) {
572 uint32_t numirqs
= s
->num_irq
;
573 kvm_gic_access(s
, KVM_DEV_ARM_VGIC_GRP_NR_IRQS
, 0, 0, &numirqs
, 1);
577 memory_region_init_reservation(&s
->iomem
, OBJECT(s
),
578 "kvm-gic_dist", 0x1000);
579 sysbus_init_mmio(sbd
, &s
->iomem
);
580 kvm_arm_register_device(&s
->iomem
,
581 (KVM_ARM_DEVICE_VGIC_V2
<< KVM_ARM_DEVICE_ID_SHIFT
)
582 | KVM_VGIC_V2_ADDR_TYPE_DIST
,
583 KVM_DEV_ARM_VGIC_GRP_ADDR
,
584 KVM_VGIC_V2_ADDR_TYPE_DIST
,
586 /* CPU interface for current core. Unlike arm_gic, we don't
587 * provide the "interface for core #N" memory regions, because
588 * cores with a VGIC don't have those.
590 memory_region_init_reservation(&s
->cpuiomem
[0], OBJECT(s
),
591 "kvm-gic_cpu", 0x1000);
592 sysbus_init_mmio(sbd
, &s
->cpuiomem
[0]);
593 kvm_arm_register_device(&s
->cpuiomem
[0],
594 (KVM_ARM_DEVICE_VGIC_V2
<< KVM_ARM_DEVICE_ID_SHIFT
)
595 | KVM_VGIC_V2_ADDR_TYPE_CPU
,
596 KVM_DEV_ARM_VGIC_GRP_ADDR
,
597 KVM_VGIC_V2_ADDR_TYPE_CPU
,
601 static void kvm_arm_gic_class_init(ObjectClass
*klass
, void *data
)
603 DeviceClass
*dc
= DEVICE_CLASS(klass
);
604 ARMGICCommonClass
*agcc
= ARM_GIC_COMMON_CLASS(klass
);
605 KVMARMGICClass
*kgc
= KVM_ARM_GIC_CLASS(klass
);
607 agcc
->pre_save
= kvm_arm_gic_get
;
608 agcc
->post_load
= kvm_arm_gic_put
;
609 kgc
->parent_realize
= dc
->realize
;
610 kgc
->parent_reset
= dc
->reset
;
611 dc
->realize
= kvm_arm_gic_realize
;
612 dc
->reset
= kvm_arm_gic_reset
;
615 static const TypeInfo kvm_arm_gic_info
= {
616 .name
= TYPE_KVM_ARM_GIC
,
617 .parent
= TYPE_ARM_GIC_COMMON
,
618 .instance_size
= sizeof(GICState
),
619 .class_init
= kvm_arm_gic_class_init
,
620 .class_size
= sizeof(KVMARMGICClass
),
623 static void kvm_arm_gic_register_types(void)
625 type_register_static(&kvm_arm_gic_info
);
628 type_init(kvm_arm_gic_register_types
)