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"
26 #include "vgic_common.h"
28 //#define DEBUG_GIC_KVM
31 static const int debug_gic_kvm
= 1;
33 static const int debug_gic_kvm
= 0;
36 #define DPRINTF(fmt, ...) do { \
37 if (debug_gic_kvm) { \
38 printf("arm_gic: " fmt , ## __VA_ARGS__); \
42 #define TYPE_KVM_ARM_GIC "kvm-arm-gic"
43 #define KVM_ARM_GIC(obj) \
44 OBJECT_CHECK(GICState, (obj), TYPE_KVM_ARM_GIC)
45 #define KVM_ARM_GIC_CLASS(klass) \
46 OBJECT_CLASS_CHECK(KVMARMGICClass, (klass), TYPE_KVM_ARM_GIC)
47 #define KVM_ARM_GIC_GET_CLASS(obj) \
48 OBJECT_GET_CLASS(KVMARMGICClass, (obj), TYPE_KVM_ARM_GIC)
50 typedef struct KVMARMGICClass
{
51 ARMGICCommonClass parent_class
;
52 DeviceRealize parent_realize
;
53 void (*parent_reset
)(DeviceState
*dev
);
56 void kvm_arm_gic_set_irq(uint32_t num_irq
, int irq
, int level
)
58 /* Meaning of the 'irq' parameter:
59 * [0..N-1] : external interrupts
60 * [N..N+31] : PPI (internal) interrupts for CPU 0
61 * [N+32..N+63] : PPI (internal interrupts for CPU 1
63 * Convert this to the kernel's desired encoding, which
64 * has separate fields in the irq number for type,
65 * CPU number and interrupt number.
67 int kvm_irq
, irqtype
, cpu
;
69 if (irq
< (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
-= (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 void kvm_arm_gicv2_set_irq(void *opaque
, int irq
, int level
)
92 GICState
*s
= (GICState
*)opaque
;
94 kvm_arm_gic_set_irq(s
->num_irq
, irq
, level
);
97 static bool kvm_arm_gic_can_save_restore(GICState
*s
)
99 return s
->dev_fd
>= 0;
102 #define KVM_VGIC_ATTR(offset, cpu) \
103 ((((uint64_t)(cpu) << KVM_DEV_ARM_VGIC_CPUID_SHIFT) & \
104 KVM_DEV_ARM_VGIC_CPUID_MASK) | \
105 (((uint64_t)(offset) << KVM_DEV_ARM_VGIC_OFFSET_SHIFT) & \
106 KVM_DEV_ARM_VGIC_OFFSET_MASK))
108 static void kvm_gicd_access(GICState
*s
, int offset
, int cpu
,
109 uint32_t *val
, bool write
)
111 kvm_device_access(s
->dev_fd
, KVM_DEV_ARM_VGIC_GRP_DIST_REGS
,
112 KVM_VGIC_ATTR(offset
, cpu
), val
, write
);
115 static void kvm_gicc_access(GICState
*s
, int offset
, int cpu
,
116 uint32_t *val
, bool write
)
118 kvm_device_access(s
->dev_fd
, KVM_DEV_ARM_VGIC_GRP_CPU_REGS
,
119 KVM_VGIC_ATTR(offset
, cpu
), val
, write
);
122 #define for_each_irq_reg(_ctr, _max_irq, _field_width) \
123 for (_ctr = 0; _ctr < ((_max_irq) / (32 / (_field_width))); _ctr++)
126 * Translate from the in-kernel field for an IRQ value to/from the qemu
129 typedef void (*vgic_translate_fn
)(GICState
*s
, int irq
, int cpu
,
130 uint32_t *field
, bool to_kernel
);
132 /* synthetic translate function used for clear/set registers to completely
133 * clear a setting using a clear-register before setting the remaining bits
134 * using a set-register */
135 static void translate_clear(GICState
*s
, int irq
, int cpu
,
136 uint32_t *field
, bool to_kernel
)
141 /* does not make sense: qemu model doesn't use set/clear regs */
146 static void translate_group(GICState
*s
, int irq
, int cpu
,
147 uint32_t *field
, bool to_kernel
)
149 int cm
= (irq
< GIC_INTERNAL
) ? (1 << cpu
) : ALL_CPU_MASK
;
152 *field
= GIC_TEST_GROUP(irq
, cm
);
155 GIC_SET_GROUP(irq
, cm
);
160 static void translate_enabled(GICState
*s
, int irq
, int cpu
,
161 uint32_t *field
, bool to_kernel
)
163 int cm
= (irq
< GIC_INTERNAL
) ? (1 << cpu
) : ALL_CPU_MASK
;
166 *field
= GIC_TEST_ENABLED(irq
, cm
);
169 GIC_SET_ENABLED(irq
, cm
);
174 static void translate_pending(GICState
*s
, int irq
, int cpu
,
175 uint32_t *field
, bool to_kernel
)
177 int cm
= (irq
< GIC_INTERNAL
) ? (1 << cpu
) : ALL_CPU_MASK
;
180 *field
= gic_test_pending(s
, irq
, cm
);
183 GIC_SET_PENDING(irq
, cm
);
184 /* TODO: Capture is level-line is held high in the kernel */
189 static void translate_active(GICState
*s
, int irq
, int cpu
,
190 uint32_t *field
, bool to_kernel
)
192 int cm
= (irq
< GIC_INTERNAL
) ? (1 << cpu
) : ALL_CPU_MASK
;
195 *field
= GIC_TEST_ACTIVE(irq
, cm
);
198 GIC_SET_ACTIVE(irq
, cm
);
203 static void translate_trigger(GICState
*s
, int irq
, int cpu
,
204 uint32_t *field
, bool to_kernel
)
207 *field
= (GIC_TEST_EDGE_TRIGGER(irq
)) ? 0x2 : 0x0;
210 GIC_SET_EDGE_TRIGGER(irq
);
215 static void translate_priority(GICState
*s
, int irq
, int cpu
,
216 uint32_t *field
, bool to_kernel
)
219 *field
= GIC_GET_PRIORITY(irq
, cpu
) & 0xff;
221 gic_set_priority(s
, cpu
, irq
, *field
& 0xff, MEMTXATTRS_UNSPECIFIED
);
225 static void translate_targets(GICState
*s
, int irq
, int cpu
,
226 uint32_t *field
, bool to_kernel
)
229 *field
= s
->irq_target
[irq
] & 0xff;
231 s
->irq_target
[irq
] = *field
& 0xff;
235 static void translate_sgisource(GICState
*s
, int irq
, int cpu
,
236 uint32_t *field
, bool to_kernel
)
239 *field
= s
->sgi_pending
[irq
][cpu
] & 0xff;
241 s
->sgi_pending
[irq
][cpu
] = *field
& 0xff;
245 /* Read a register group from the kernel VGIC */
246 static void kvm_dist_get(GICState
*s
, uint32_t offset
, int width
,
247 int maxirq
, vgic_translate_fn translate_fn
)
254 int regsz
= 32 / width
; /* irqs per kernel register */
257 for_each_irq_reg(i
, maxirq
, width
) {
260 while ((cpu
< s
->num_cpu
&& irq
< GIC_INTERNAL
) || cpu
== 0) {
261 kvm_gicd_access(s
, offset
, cpu
, ®
, false);
262 for (j
= 0; j
< regsz
; j
++) {
263 field
= extract32(reg
, j
* width
, width
);
264 translate_fn(s
, irq
+ j
, cpu
, &field
, false);
273 /* Write a register group to the kernel VGIC */
274 static void kvm_dist_put(GICState
*s
, uint32_t offset
, int width
,
275 int maxirq
, vgic_translate_fn translate_fn
)
282 int regsz
= 32 / width
; /* irqs per kernel register */
285 for_each_irq_reg(i
, maxirq
, width
) {
288 while ((cpu
< s
->num_cpu
&& irq
< GIC_INTERNAL
) || cpu
== 0) {
290 for (j
= 0; j
< regsz
; j
++) {
291 translate_fn(s
, irq
+ j
, cpu
, &field
, true);
292 reg
= deposit32(reg
, j
* width
, width
, field
);
294 kvm_gicd_access(s
, offset
, cpu
, ®
, true);
302 static void kvm_arm_gic_put(GICState
*s
)
310 if (!kvm_arm_gic_can_save_restore(s
)) {
311 DPRINTF("Cannot put kernel gic state, no kernel interface");
315 /* Note: We do the restore in a slightly different order than the save
316 * (where the order doesn't matter and is simply ordered according to the
317 * register offset values */
319 /*****************************************************************
323 /* s->ctlr -> GICD_CTLR */
325 kvm_gicd_access(s
, 0x0, 0, ®
, true);
327 /* Sanity checking on GICD_TYPER and s->num_irq, s->num_cpu */
328 kvm_gicd_access(s
, 0x4, 0, ®
, false);
329 num_irq
= ((reg
& 0x1f) + 1) * 32;
330 num_cpu
= ((reg
& 0xe0) >> 5) + 1;
332 if (num_irq
< s
->num_irq
) {
333 fprintf(stderr
, "Restoring %u IRQs, but kernel supports max %d\n",
334 s
->num_irq
, num_irq
);
336 } else if (num_cpu
!= s
->num_cpu
) {
337 fprintf(stderr
, "Restoring %u CPU interfaces, kernel only has %d\n",
338 s
->num_cpu
, num_cpu
);
339 /* Did we not create the VCPUs in the kernel yet? */
343 /* TODO: Consider checking compatibility with the IIDR ? */
345 /* irq_state[n].enabled -> GICD_ISENABLERn */
346 kvm_dist_put(s
, 0x180, 1, s
->num_irq
, translate_clear
);
347 kvm_dist_put(s
, 0x100, 1, s
->num_irq
, translate_enabled
);
349 /* irq_state[n].group -> GICD_IGROUPRn */
350 kvm_dist_put(s
, 0x80, 1, s
->num_irq
, translate_group
);
352 /* s->irq_target[irq] -> GICD_ITARGETSRn
353 * (restore targets before pending to ensure the pending state is set on
354 * the appropriate CPU interfaces in the kernel) */
355 kvm_dist_put(s
, 0x800, 8, s
->num_irq
, translate_targets
);
357 /* irq_state[n].trigger -> GICD_ICFGRn
358 * (restore configuration registers before pending IRQs so we treat
359 * level/edge correctly) */
360 kvm_dist_put(s
, 0xc00, 2, s
->num_irq
, translate_trigger
);
362 /* irq_state[n].pending + irq_state[n].level -> GICD_ISPENDRn */
363 kvm_dist_put(s
, 0x280, 1, s
->num_irq
, translate_clear
);
364 kvm_dist_put(s
, 0x200, 1, s
->num_irq
, translate_pending
);
366 /* irq_state[n].active -> GICD_ISACTIVERn */
367 kvm_dist_put(s
, 0x380, 1, s
->num_irq
, translate_clear
);
368 kvm_dist_put(s
, 0x300, 1, s
->num_irq
, translate_active
);
371 /* s->priorityX[irq] -> ICD_IPRIORITYRn */
372 kvm_dist_put(s
, 0x400, 8, s
->num_irq
, translate_priority
);
374 /* s->sgi_pending -> ICD_CPENDSGIRn */
375 kvm_dist_put(s
, 0xf10, 8, GIC_NR_SGIS
, translate_clear
);
376 kvm_dist_put(s
, 0xf20, 8, GIC_NR_SGIS
, translate_sgisource
);
379 /*****************************************************************
380 * CPU Interface(s) State
383 for (cpu
= 0; cpu
< s
->num_cpu
; cpu
++) {
384 /* s->cpu_ctlr[cpu] -> GICC_CTLR */
385 reg
= s
->cpu_ctlr
[cpu
];
386 kvm_gicc_access(s
, 0x00, cpu
, ®
, true);
388 /* s->priority_mask[cpu] -> GICC_PMR */
389 reg
= (s
->priority_mask
[cpu
] & 0xff);
390 kvm_gicc_access(s
, 0x04, cpu
, ®
, true);
392 /* s->bpr[cpu] -> GICC_BPR */
393 reg
= (s
->bpr
[cpu
] & 0x7);
394 kvm_gicc_access(s
, 0x08, cpu
, ®
, true);
396 /* s->abpr[cpu] -> GICC_ABPR */
397 reg
= (s
->abpr
[cpu
] & 0x7);
398 kvm_gicc_access(s
, 0x1c, cpu
, ®
, true);
400 /* s->apr[n][cpu] -> GICC_APRn */
401 for (i
= 0; i
< 4; i
++) {
402 reg
= s
->apr
[i
][cpu
];
403 kvm_gicc_access(s
, 0xd0 + i
* 4, cpu
, ®
, true);
408 static void kvm_arm_gic_get(GICState
*s
)
414 if (!kvm_arm_gic_can_save_restore(s
)) {
415 DPRINTF("Cannot get kernel gic state, no kernel interface");
419 /*****************************************************************
423 /* GICD_CTLR -> s->ctlr */
424 kvm_gicd_access(s
, 0x0, 0, ®
, false);
427 /* Sanity checking on GICD_TYPER -> s->num_irq, s->num_cpu */
428 kvm_gicd_access(s
, 0x4, 0, ®
, false);
429 s
->num_irq
= ((reg
& 0x1f) + 1) * 32;
430 s
->num_cpu
= ((reg
& 0xe0) >> 5) + 1;
432 if (s
->num_irq
> GIC_MAXIRQ
) {
433 fprintf(stderr
, "Too many IRQs reported from the kernel: %d\n",
439 kvm_gicd_access(s
, 0x8, 0, ®
, false);
441 /* Clear all the IRQ settings */
442 for (i
= 0; i
< s
->num_irq
; i
++) {
443 memset(&s
->irq_state
[i
], 0, sizeof(s
->irq_state
[0]));
446 /* GICD_IGROUPRn -> irq_state[n].group */
447 kvm_dist_get(s
, 0x80, 1, s
->num_irq
, translate_group
);
449 /* GICD_ISENABLERn -> irq_state[n].enabled */
450 kvm_dist_get(s
, 0x100, 1, s
->num_irq
, translate_enabled
);
452 /* GICD_ISPENDRn -> irq_state[n].pending + irq_state[n].level */
453 kvm_dist_get(s
, 0x200, 1, s
->num_irq
, translate_pending
);
455 /* GICD_ISACTIVERn -> irq_state[n].active */
456 kvm_dist_get(s
, 0x300, 1, s
->num_irq
, translate_active
);
458 /* GICD_ICFRn -> irq_state[n].trigger */
459 kvm_dist_get(s
, 0xc00, 2, s
->num_irq
, translate_trigger
);
461 /* GICD_IPRIORITYRn -> s->priorityX[irq] */
462 kvm_dist_get(s
, 0x400, 8, s
->num_irq
, translate_priority
);
464 /* GICD_ITARGETSRn -> s->irq_target[irq] */
465 kvm_dist_get(s
, 0x800, 8, s
->num_irq
, translate_targets
);
467 /* GICD_CPENDSGIRn -> s->sgi_pending */
468 kvm_dist_get(s
, 0xf10, 8, GIC_NR_SGIS
, translate_sgisource
);
471 /*****************************************************************
472 * CPU Interface(s) State
475 for (cpu
= 0; cpu
< s
->num_cpu
; cpu
++) {
476 /* GICC_CTLR -> s->cpu_ctlr[cpu] */
477 kvm_gicc_access(s
, 0x00, cpu
, ®
, false);
478 s
->cpu_ctlr
[cpu
] = reg
;
480 /* GICC_PMR -> s->priority_mask[cpu] */
481 kvm_gicc_access(s
, 0x04, cpu
, ®
, false);
482 s
->priority_mask
[cpu
] = (reg
& 0xff);
484 /* GICC_BPR -> s->bpr[cpu] */
485 kvm_gicc_access(s
, 0x08, cpu
, ®
, false);
486 s
->bpr
[cpu
] = (reg
& 0x7);
488 /* GICC_ABPR -> s->abpr[cpu] */
489 kvm_gicc_access(s
, 0x1c, cpu
, ®
, false);
490 s
->abpr
[cpu
] = (reg
& 0x7);
492 /* GICC_APRn -> s->apr[n][cpu] */
493 for (i
= 0; i
< 4; i
++) {
494 kvm_gicc_access(s
, 0xd0 + i
* 4, cpu
, ®
, false);
495 s
->apr
[i
][cpu
] = reg
;
500 static void kvm_arm_gic_reset(DeviceState
*dev
)
502 GICState
*s
= ARM_GIC_COMMON(dev
);
503 KVMARMGICClass
*kgc
= KVM_ARM_GIC_GET_CLASS(s
);
505 kgc
->parent_reset(dev
);
509 static void kvm_arm_gic_realize(DeviceState
*dev
, Error
**errp
)
512 GICState
*s
= KVM_ARM_GIC(dev
);
513 KVMARMGICClass
*kgc
= KVM_ARM_GIC_GET_CLASS(s
);
514 Error
*local_err
= NULL
;
517 kgc
->parent_realize(dev
, &local_err
);
519 error_propagate(errp
, local_err
);
523 if (s
->security_extn
) {
524 error_setg(errp
, "the in-kernel VGIC does not implement the "
525 "security extensions");
529 gic_init_irqs_and_mmio(s
, kvm_arm_gicv2_set_irq
, NULL
);
531 for (i
= 0; i
< s
->num_irq
- GIC_INTERNAL
; i
++) {
532 qemu_irq irq
= qdev_get_gpio_in(dev
, i
);
533 kvm_irqchip_set_qemuirq_gsi(kvm_state
, irq
, i
);
536 /* Try to create the device via the device control API */
538 ret
= kvm_create_device(kvm_state
, KVM_DEV_TYPE_ARM_VGIC_V2
, false);
542 /* Newstyle API is used, we may have attributes */
543 if (kvm_device_check_attr(s
->dev_fd
, KVM_DEV_ARM_VGIC_GRP_NR_IRQS
, 0)) {
544 uint32_t numirqs
= s
->num_irq
;
545 kvm_device_access(s
->dev_fd
, KVM_DEV_ARM_VGIC_GRP_NR_IRQS
, 0,
548 /* Tell the kernel to complete VGIC initialization now */
549 if (kvm_device_check_attr(s
->dev_fd
, KVM_DEV_ARM_VGIC_GRP_CTRL
,
550 KVM_DEV_ARM_VGIC_CTRL_INIT
)) {
551 kvm_device_access(s
->dev_fd
, KVM_DEV_ARM_VGIC_GRP_CTRL
,
552 KVM_DEV_ARM_VGIC_CTRL_INIT
, NULL
, true);
554 } else if (ret
!= -ENODEV
&& ret
!= -ENOTSUP
) {
555 error_setg_errno(errp
, -ret
, "error creating in-kernel VGIC");
560 kvm_arm_register_device(&s
->iomem
,
561 (KVM_ARM_DEVICE_VGIC_V2
<< KVM_ARM_DEVICE_ID_SHIFT
)
562 | KVM_VGIC_V2_ADDR_TYPE_DIST
,
563 KVM_DEV_ARM_VGIC_GRP_ADDR
,
564 KVM_VGIC_V2_ADDR_TYPE_DIST
,
566 /* CPU interface for current core. Unlike arm_gic, we don't
567 * provide the "interface for core #N" memory regions, because
568 * cores with a VGIC don't have those.
570 kvm_arm_register_device(&s
->cpuiomem
[0],
571 (KVM_ARM_DEVICE_VGIC_V2
<< KVM_ARM_DEVICE_ID_SHIFT
)
572 | KVM_VGIC_V2_ADDR_TYPE_CPU
,
573 KVM_DEV_ARM_VGIC_GRP_ADDR
,
574 KVM_VGIC_V2_ADDR_TYPE_CPU
,
578 static void kvm_arm_gic_class_init(ObjectClass
*klass
, void *data
)
580 DeviceClass
*dc
= DEVICE_CLASS(klass
);
581 ARMGICCommonClass
*agcc
= ARM_GIC_COMMON_CLASS(klass
);
582 KVMARMGICClass
*kgc
= KVM_ARM_GIC_CLASS(klass
);
584 agcc
->pre_save
= kvm_arm_gic_get
;
585 agcc
->post_load
= kvm_arm_gic_put
;
586 kgc
->parent_realize
= dc
->realize
;
587 kgc
->parent_reset
= dc
->reset
;
588 dc
->realize
= kvm_arm_gic_realize
;
589 dc
->reset
= kvm_arm_gic_reset
;
592 static const TypeInfo kvm_arm_gic_info
= {
593 .name
= TYPE_KVM_ARM_GIC
,
594 .parent
= TYPE_ARM_GIC_COMMON
,
595 .instance_size
= sizeof(GICState
),
596 .class_init
= kvm_arm_gic_class_init
,
597 .class_size
= sizeof(KVMARMGICClass
),
600 static void kvm_arm_gic_register_types(void)
602 type_register_static(&kvm_arm_gic_info
);
605 type_init(kvm_arm_gic_register_types
)