2 * QEMU PowerPC pSeries Logical Partition (aka sPAPR) hardware System Emulator
4 * PAPR Virtualized Interrupt System, aka ICS/ICP aka xics
6 * Copyright (c) 2010,2011 David Gibson, IBM Corporation.
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
28 #include "qemu/osdep.h"
29 #include "qapi/error.h"
32 #include "qemu/timer.h"
33 #include "hw/ppc/xics.h"
34 #include "hw/qdev-properties.h"
35 #include "qemu/error-report.h"
36 #include "qemu/module.h"
37 #include "qapi/visitor.h"
38 #include "migration/vmstate.h"
39 #include "monitor/monitor.h"
40 #include "hw/intc/intc.h"
42 #include "sysemu/kvm.h"
43 #include "sysemu/reset.h"
45 void icp_pic_print_info(ICPState *icp, Monitor *mon)
49 /* Skip partially initialized vCPUs. This can happen on sPAPR when vCPUs
50 * are hot plugged or unplugged.
56 cpu_index = icp->cs ? icp->cs->cpu_index : -1;
62 if (kvm_irqchip_in_kernel()) {
63 icp_synchronize_state(icp);
66 monitor_printf(mon, "CPU %d XIRR=%08x (%p) PP=%02x MFRR=%02x\n",
67 cpu_index, icp->xirr, icp->xirr_owner,
68 icp->pending_priority, icp->mfrr);
71 void ics_pic_print_info(ICSState *ics, Monitor *mon)
75 monitor_printf(mon, "ICS %4x..%4x %p\n",
76 ics->offset, ics->offset + ics->nr_irqs - 1, ics);
82 if (kvm_irqchip_in_kernel()) {
83 ics_synchronize_state(ics);
86 for (i = 0; i < ics->nr_irqs; i++) {
87 ICSIRQState *irq = ics->irqs + i;
89 if (!(irq->flags & XICS_FLAGS_IRQ_MASK)) {
92 monitor_printf(mon, " %4x %s %02x %02x\n",
94 (irq->flags & XICS_FLAGS_IRQ_LSI) ?
96 irq->priority, irq->status);
101 * ICP: Presentation layer
104 #define XISR_MASK 0x00ffffff
105 #define CPPR_MASK 0xff000000
107 #define XISR(icp) (((icp)->xirr) & XISR_MASK)
108 #define CPPR(icp) (((icp)->xirr) >> 24)
110 static void ics_reject(ICSState *ics, uint32_t nr);
111 static void ics_eoi(ICSState *ics, uint32_t nr);
113 static void icp_check_ipi(ICPState *icp)
115 if (XISR(icp) && (icp->pending_priority <= icp->mfrr)) {
119 trace_xics_icp_check_ipi(icp->cs->cpu_index, icp->mfrr);
121 if (XISR(icp) && icp->xirr_owner) {
122 ics_reject(icp->xirr_owner, XISR(icp));
125 icp->xirr = (icp->xirr & ~XISR_MASK) | XICS_IPI;
126 icp->pending_priority = icp->mfrr;
127 icp->xirr_owner = NULL;
128 qemu_irq_raise(icp->output);
131 void icp_resend(ICPState *icp)
133 XICSFabric *xi = icp->xics;
134 XICSFabricClass *xic = XICS_FABRIC_GET_CLASS(xi);
136 if (icp->mfrr < CPPR(icp)) {
143 void icp_set_cppr(ICPState *icp, uint8_t cppr)
148 old_cppr = CPPR(icp);
149 icp->xirr = (icp->xirr & ~CPPR_MASK) | (cppr << 24);
151 if (cppr < old_cppr) {
152 if (XISR(icp) && (cppr <= icp->pending_priority)) {
153 old_xisr = XISR(icp);
154 icp->xirr &= ~XISR_MASK; /* Clear XISR */
155 icp->pending_priority = 0xff;
156 qemu_irq_lower(icp->output);
157 if (icp->xirr_owner) {
158 ics_reject(icp->xirr_owner, old_xisr);
159 icp->xirr_owner = NULL;
169 void icp_set_mfrr(ICPState *icp, uint8_t mfrr)
172 if (mfrr < CPPR(icp)) {
177 uint32_t icp_accept(ICPState *icp)
179 uint32_t xirr = icp->xirr;
181 qemu_irq_lower(icp->output);
182 icp->xirr = icp->pending_priority << 24;
183 icp->pending_priority = 0xff;
184 icp->xirr_owner = NULL;
186 trace_xics_icp_accept(xirr, icp->xirr);
191 uint32_t icp_ipoll(ICPState *icp, uint32_t *mfrr)
199 void icp_eoi(ICPState *icp, uint32_t xirr)
201 XICSFabric *xi = icp->xics;
202 XICSFabricClass *xic = XICS_FABRIC_GET_CLASS(xi);
206 /* Send EOI -> ICS */
207 icp->xirr = (icp->xirr & ~CPPR_MASK) | (xirr & CPPR_MASK);
208 trace_xics_icp_eoi(icp->cs->cpu_index, xirr, icp->xirr);
209 irq = xirr & XISR_MASK;
211 ics = xic->ics_get(xi, irq);
220 static void icp_irq(ICSState *ics, int server, int nr, uint8_t priority)
222 ICPState *icp = xics_icp_get(ics->xics, server);
224 trace_xics_icp_irq(server, nr, priority);
226 if ((priority >= CPPR(icp))
227 || (XISR(icp) && (icp->pending_priority <= priority))) {
230 if (XISR(icp) && icp->xirr_owner) {
231 ics_reject(icp->xirr_owner, XISR(icp));
232 icp->xirr_owner = NULL;
234 icp->xirr = (icp->xirr & ~XISR_MASK) | (nr & XISR_MASK);
235 icp->xirr_owner = ics;
236 icp->pending_priority = priority;
237 trace_xics_icp_raise(icp->xirr, icp->pending_priority);
238 qemu_irq_raise(icp->output);
242 static int icp_pre_save(void *opaque)
244 ICPState *icp = opaque;
246 if (kvm_irqchip_in_kernel()) {
247 icp_get_kvm_state(icp);
253 static int icp_post_load(void *opaque, int version_id)
255 ICPState *icp = opaque;
257 if (kvm_irqchip_in_kernel()) {
258 Error *local_err = NULL;
261 ret = icp_set_kvm_state(icp, &local_err);
263 error_report_err(local_err);
271 static const VMStateDescription vmstate_icp_server = {
272 .name = "icp/server",
274 .minimum_version_id = 1,
275 .pre_save = icp_pre_save,
276 .post_load = icp_post_load,
277 .fields = (VMStateField[]) {
279 VMSTATE_UINT32(xirr, ICPState),
280 VMSTATE_UINT8(pending_priority, ICPState),
281 VMSTATE_UINT8(mfrr, ICPState),
282 VMSTATE_END_OF_LIST()
286 void icp_reset(ICPState *icp)
289 icp->pending_priority = 0xff;
292 /* Make all outputs are deasserted */
293 qemu_set_irq(icp->output, 0);
295 if (kvm_irqchip_in_kernel()) {
296 Error *local_err = NULL;
298 icp_set_kvm_state(icp, &local_err);
300 error_report_err(local_err);
305 static void icp_realize(DeviceState *dev, Error **errp)
307 ICPState *icp = ICP(dev);
313 obj = object_property_get_link(OBJECT(dev), ICP_PROP_XICS, &err);
315 error_propagate_prepend(errp, err,
316 "required link '" ICP_PROP_XICS
321 icp->xics = XICS_FABRIC(obj);
323 obj = object_property_get_link(OBJECT(dev), ICP_PROP_CPU, &err);
325 error_propagate_prepend(errp, err,
326 "required link '" ICP_PROP_CPU
331 cpu = POWERPC_CPU(obj);
335 switch (PPC_INPUT(env)) {
336 case PPC_FLAGS_INPUT_POWER7:
337 icp->output = env->irq_inputs[POWER7_INPUT_INT];
339 case PPC_FLAGS_INPUT_POWER9: /* For SPAPR xics emulation */
340 icp->output = env->irq_inputs[POWER9_INPUT_INT];
343 case PPC_FLAGS_INPUT_970:
344 icp->output = env->irq_inputs[PPC970_INPUT_INT];
348 error_setg(errp, "XICS interrupt controller does not support this CPU bus model");
352 /* Connect the presenter to the VCPU (required for CPU hotplug) */
353 if (kvm_irqchip_in_kernel()) {
354 icp_kvm_realize(dev, &err);
356 error_propagate(errp, err);
361 vmstate_register(NULL, icp->cs->cpu_index, &vmstate_icp_server, icp);
364 static void icp_unrealize(DeviceState *dev, Error **errp)
366 ICPState *icp = ICP(dev);
368 vmstate_unregister(NULL, &vmstate_icp_server, icp);
371 static void icp_class_init(ObjectClass *klass, void *data)
373 DeviceClass *dc = DEVICE_CLASS(klass);
375 dc->realize = icp_realize;
376 dc->unrealize = icp_unrealize;
378 * Reason: part of XICS interrupt controller, needs to be wired up
381 dc->user_creatable = false;
384 static const TypeInfo icp_info = {
386 .parent = TYPE_DEVICE,
387 .instance_size = sizeof(ICPState),
388 .class_init = icp_class_init,
389 .class_size = sizeof(ICPStateClass),
392 Object *icp_create(Object *cpu, const char *type, XICSFabric *xi, Error **errp)
394 Error *local_err = NULL;
397 obj = object_new(type);
398 object_property_add_child(cpu, type, obj, &error_abort);
400 object_ref(OBJECT(xi));
401 object_property_add_const_link(obj, ICP_PROP_XICS, OBJECT(xi),
404 object_property_add_const_link(obj, ICP_PROP_CPU, cpu, &error_abort);
405 object_property_set_bool(obj, true, "realized", &local_err);
407 object_unparent(obj);
408 error_propagate(errp, local_err);
415 void icp_destroy(ICPState *icp)
417 Object *obj = OBJECT(icp);
419 object_unref(object_property_get_link(obj, ICP_PROP_CPU, &error_abort));
420 object_unref(object_property_get_link(obj, ICP_PROP_XICS, &error_abort));
421 object_unparent(obj);
427 static void ics_resend_msi(ICSState *ics, int srcno)
429 ICSIRQState *irq = ics->irqs + srcno;
431 /* FIXME: filter by server#? */
432 if (irq->status & XICS_STATUS_REJECTED) {
433 irq->status &= ~XICS_STATUS_REJECTED;
434 if (irq->priority != 0xff) {
435 icp_irq(ics, irq->server, srcno + ics->offset, irq->priority);
440 static void ics_resend_lsi(ICSState *ics, int srcno)
442 ICSIRQState *irq = ics->irqs + srcno;
444 if ((irq->priority != 0xff)
445 && (irq->status & XICS_STATUS_ASSERTED)
446 && !(irq->status & XICS_STATUS_SENT)) {
447 irq->status |= XICS_STATUS_SENT;
448 icp_irq(ics, irq->server, srcno + ics->offset, irq->priority);
452 static void ics_set_irq_msi(ICSState *ics, int srcno, int val)
454 ICSIRQState *irq = ics->irqs + srcno;
456 trace_xics_ics_set_irq_msi(srcno, srcno + ics->offset);
459 if (irq->priority == 0xff) {
460 irq->status |= XICS_STATUS_MASKED_PENDING;
461 trace_xics_masked_pending();
463 icp_irq(ics, irq->server, srcno + ics->offset, irq->priority);
468 static void ics_set_irq_lsi(ICSState *ics, int srcno, int val)
470 ICSIRQState *irq = ics->irqs + srcno;
472 trace_xics_ics_set_irq_lsi(srcno, srcno + ics->offset);
474 irq->status |= XICS_STATUS_ASSERTED;
476 irq->status &= ~XICS_STATUS_ASSERTED;
478 ics_resend_lsi(ics, srcno);
481 void ics_set_irq(void *opaque, int srcno, int val)
483 ICSState *ics = (ICSState *)opaque;
485 if (kvm_irqchip_in_kernel()) {
486 ics_kvm_set_irq(ics, srcno, val);
490 if (ics->irqs[srcno].flags & XICS_FLAGS_IRQ_LSI) {
491 ics_set_irq_lsi(ics, srcno, val);
493 ics_set_irq_msi(ics, srcno, val);
497 static void ics_write_xive_msi(ICSState *ics, int srcno)
499 ICSIRQState *irq = ics->irqs + srcno;
501 if (!(irq->status & XICS_STATUS_MASKED_PENDING)
502 || (irq->priority == 0xff)) {
506 irq->status &= ~XICS_STATUS_MASKED_PENDING;
507 icp_irq(ics, irq->server, srcno + ics->offset, irq->priority);
510 static void ics_write_xive_lsi(ICSState *ics, int srcno)
512 ics_resend_lsi(ics, srcno);
515 void ics_write_xive(ICSState *ics, int srcno, int server,
516 uint8_t priority, uint8_t saved_priority)
518 ICSIRQState *irq = ics->irqs + srcno;
520 irq->server = server;
521 irq->priority = priority;
522 irq->saved_priority = saved_priority;
524 trace_xics_ics_write_xive(ics->offset + srcno, srcno, server, priority);
526 if (ics->irqs[srcno].flags & XICS_FLAGS_IRQ_LSI) {
527 ics_write_xive_lsi(ics, srcno);
529 ics_write_xive_msi(ics, srcno);
533 static void ics_reject(ICSState *ics, uint32_t nr)
535 ICSIRQState *irq = ics->irqs + nr - ics->offset;
537 trace_xics_ics_reject(nr, nr - ics->offset);
538 if (irq->flags & XICS_FLAGS_IRQ_MSI) {
539 irq->status |= XICS_STATUS_REJECTED;
540 } else if (irq->flags & XICS_FLAGS_IRQ_LSI) {
541 irq->status &= ~XICS_STATUS_SENT;
545 void ics_resend(ICSState *ics)
549 for (i = 0; i < ics->nr_irqs; i++) {
550 /* FIXME: filter by server#? */
551 if (ics->irqs[i].flags & XICS_FLAGS_IRQ_LSI) {
552 ics_resend_lsi(ics, i);
554 ics_resend_msi(ics, i);
559 static void ics_eoi(ICSState *ics, uint32_t nr)
561 int srcno = nr - ics->offset;
562 ICSIRQState *irq = ics->irqs + srcno;
564 trace_xics_ics_eoi(nr);
566 if (ics->irqs[srcno].flags & XICS_FLAGS_IRQ_LSI) {
567 irq->status &= ~XICS_STATUS_SENT;
571 static void ics_reset_irq(ICSIRQState *irq)
573 irq->priority = 0xff;
574 irq->saved_priority = 0xff;
577 static void ics_reset(DeviceState *dev)
579 ICSState *ics = ICS(dev);
581 uint8_t flags[ics->nr_irqs];
583 for (i = 0; i < ics->nr_irqs; i++) {
584 flags[i] = ics->irqs[i].flags;
587 memset(ics->irqs, 0, sizeof(ICSIRQState) * ics->nr_irqs);
589 for (i = 0; i < ics->nr_irqs; i++) {
590 ics_reset_irq(ics->irqs + i);
591 ics->irqs[i].flags = flags[i];
594 if (kvm_irqchip_in_kernel()) {
595 Error *local_err = NULL;
597 ics_set_kvm_state(ICS(dev), &local_err);
599 error_report_err(local_err);
604 static void ics_reset_handler(void *dev)
609 static void ics_realize(DeviceState *dev, Error **errp)
611 ICSState *ics = ICS(dev);
612 Error *local_err = NULL;
615 obj = object_property_get_link(OBJECT(dev), ICS_PROP_XICS, &local_err);
617 error_propagate_prepend(errp, local_err,
618 "required link '" ICS_PROP_XICS
622 ics->xics = XICS_FABRIC(obj);
625 error_setg(errp, "Number of interrupts needs to be greater 0");
628 ics->irqs = g_malloc0(ics->nr_irqs * sizeof(ICSIRQState));
630 qemu_register_reset(ics_reset_handler, ics);
633 static void ics_instance_init(Object *obj)
635 ICSState *ics = ICS(obj);
637 ics->offset = XICS_IRQ_BASE;
640 static int ics_pre_save(void *opaque)
642 ICSState *ics = opaque;
644 if (kvm_irqchip_in_kernel()) {
645 ics_get_kvm_state(ics);
651 static int ics_post_load(void *opaque, int version_id)
653 ICSState *ics = opaque;
655 if (kvm_irqchip_in_kernel()) {
656 Error *local_err = NULL;
659 ret = ics_set_kvm_state(ics, &local_err);
661 error_report_err(local_err);
669 static const VMStateDescription vmstate_ics_irq = {
672 .minimum_version_id = 1,
673 .fields = (VMStateField[]) {
674 VMSTATE_UINT32(server, ICSIRQState),
675 VMSTATE_UINT8(priority, ICSIRQState),
676 VMSTATE_UINT8(saved_priority, ICSIRQState),
677 VMSTATE_UINT8(status, ICSIRQState),
678 VMSTATE_UINT8(flags, ICSIRQState),
679 VMSTATE_END_OF_LIST()
683 static const VMStateDescription vmstate_ics = {
686 .minimum_version_id = 1,
687 .pre_save = ics_pre_save,
688 .post_load = ics_post_load,
689 .fields = (VMStateField[]) {
691 VMSTATE_UINT32_EQUAL(nr_irqs, ICSState, NULL),
693 VMSTATE_STRUCT_VARRAY_POINTER_UINT32(irqs, ICSState, nr_irqs,
696 VMSTATE_END_OF_LIST()
700 static Property ics_properties[] = {
701 DEFINE_PROP_UINT32("nr-irqs", ICSState, nr_irqs, 0),
702 DEFINE_PROP_END_OF_LIST(),
705 static void ics_class_init(ObjectClass *klass, void *data)
707 DeviceClass *dc = DEVICE_CLASS(klass);
709 dc->realize = ics_realize;
710 dc->props = ics_properties;
711 dc->reset = ics_reset;
712 dc->vmsd = &vmstate_ics;
714 * Reason: part of XICS interrupt controller, needs to be wired up,
715 * e.g. by spapr_irq_init().
717 dc->user_creatable = false;
720 static const TypeInfo ics_info = {
722 .parent = TYPE_DEVICE,
723 .instance_size = sizeof(ICSState),
724 .instance_init = ics_instance_init,
725 .class_init = ics_class_init,
726 .class_size = sizeof(ICSStateClass),
729 static const TypeInfo xics_fabric_info = {
730 .name = TYPE_XICS_FABRIC,
731 .parent = TYPE_INTERFACE,
732 .class_size = sizeof(XICSFabricClass),
738 ICPState *xics_icp_get(XICSFabric *xi, int server)
740 XICSFabricClass *xic = XICS_FABRIC_GET_CLASS(xi);
742 return xic->icp_get(xi, server);
745 void ics_set_irq_type(ICSState *ics, int srcno, bool lsi)
747 assert(!(ics->irqs[srcno].flags & XICS_FLAGS_IRQ_MASK));
749 ics->irqs[srcno].flags |=
750 lsi ? XICS_FLAGS_IRQ_LSI : XICS_FLAGS_IRQ_MSI;
752 if (kvm_irqchip_in_kernel()) {
753 Error *local_err = NULL;
755 ics_reset_irq(ics->irqs + srcno);
756 ics_set_kvm_state_one(ics, srcno, &local_err);
758 error_report_err(local_err);
763 static void xics_register_types(void)
765 type_register_static(&ics_info);
766 type_register_static(&icp_info);
767 type_register_static(&xics_fabric_info);
770 type_init(xics_register_types)