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"
30 #include "qemu-common.h"
34 #include "qemu/timer.h"
35 #include "hw/ppc/xics.h"
36 #include "qemu/error-report.h"
37 #include "qapi/visitor.h"
38 #include "monitor/monitor.h"
39 #include "hw/intc/intc.h"
41 int xics_get_cpu_index_by_dt_id(int cpu_dt_id)
43 PowerPCCPU *cpu = ppc_get_vcpu_by_dt_id(cpu_dt_id);
46 return cpu->parent_obj.cpu_index;
52 void xics_cpu_destroy(XICSState *xics, PowerPCCPU *cpu)
54 CPUState *cs = CPU(cpu);
55 ICPState *ss = &xics->ss[cs->cpu_index];
57 assert(cs->cpu_index < xics->nr_servers);
64 void xics_cpu_setup(XICSState *xics, PowerPCCPU *cpu)
66 CPUState *cs = CPU(cpu);
67 CPUPPCState *env = &cpu->env;
68 ICPState *ss = &xics->ss[cs->cpu_index];
71 assert(cs->cpu_index < xics->nr_servers);
75 icpc = ICP_GET_CLASS(ss);
76 if (icpc->cpu_setup) {
77 icpc->cpu_setup(ss, cpu);
80 switch (PPC_INPUT(env)) {
81 case PPC_FLAGS_INPUT_POWER7:
82 ss->output = env->irq_inputs[POWER7_INPUT_INT];
85 case PPC_FLAGS_INPUT_970:
86 ss->output = env->irq_inputs[PPC970_INPUT_INT];
90 error_report("XICS interrupt controller does not support this CPU "
96 static void icp_pic_print_info(InterruptStatsProvider *obj,
99 ICPState *icp = ICP(obj);
100 int cpu_index = icp->cs ? icp->cs->cpu_index : -1;
105 monitor_printf(mon, "CPU %d XIRR=%08x (%p) PP=%02x MFRR=%02x\n",
106 cpu_index, icp->xirr, icp->xirr_owner,
107 icp->pending_priority, icp->mfrr);
110 static void ics_simple_pic_print_info(InterruptStatsProvider *obj,
113 ICSState *ics = ICS_SIMPLE(obj);
116 monitor_printf(mon, "ICS %4x..%4x %p\n",
117 ics->offset, ics->offset + ics->nr_irqs - 1, ics);
123 for (i = 0; i < ics->nr_irqs; i++) {
124 ICSIRQState *irq = ics->irqs + i;
126 if (!(irq->flags & XICS_FLAGS_IRQ_MASK)) {
129 monitor_printf(mon, " %4x %s %02x %02x\n",
131 (irq->flags & XICS_FLAGS_IRQ_LSI) ?
133 irq->priority, irq->status);
138 * XICS Common class - parent for emulated XICS and KVM-XICS
140 static void xics_common_reset(DeviceState *d)
142 XICSState *xics = XICS_COMMON(d);
145 for (i = 0; i < xics->nr_servers; i++) {
146 device_reset(DEVICE(&xics->ss[i]));
150 static void xics_common_class_init(ObjectClass *oc, void *data)
152 DeviceClass *dc = DEVICE_CLASS(oc);
154 dc->reset = xics_common_reset;
157 static const TypeInfo xics_common_info = {
158 .name = TYPE_XICS_COMMON,
159 .parent = TYPE_DEVICE,
160 .instance_size = sizeof(XICSState),
161 .class_size = sizeof(XICSStateClass),
162 .class_init = xics_common_class_init,
166 * ICP: Presentation layer
169 #define XISR_MASK 0x00ffffff
170 #define CPPR_MASK 0xff000000
172 #define XISR(ss) (((ss)->xirr) & XISR_MASK)
173 #define CPPR(ss) (((ss)->xirr) >> 24)
175 static void ics_reject(ICSState *ics, uint32_t nr)
177 ICSStateClass *k = ICS_BASE_GET_CLASS(ics);
184 void ics_resend(ICSState *ics)
186 ICSStateClass *k = ICS_BASE_GET_CLASS(ics);
193 static void ics_eoi(ICSState *ics, int nr)
195 ICSStateClass *k = ICS_BASE_GET_CLASS(ics);
202 static void icp_check_ipi(ICPState *ss)
204 if (XISR(ss) && (ss->pending_priority <= ss->mfrr)) {
208 trace_xics_icp_check_ipi(ss->cs->cpu_index, ss->mfrr);
210 if (XISR(ss) && ss->xirr_owner) {
211 ics_reject(ss->xirr_owner, XISR(ss));
214 ss->xirr = (ss->xirr & ~XISR_MASK) | XICS_IPI;
215 ss->pending_priority = ss->mfrr;
216 ss->xirr_owner = NULL;
217 qemu_irq_raise(ss->output);
220 void icp_resend(ICPState *ss)
222 XICSFabric *xi = ss->xics;
223 XICSFabricClass *xic = XICS_FABRIC_GET_CLASS(xi);
225 if (ss->mfrr < CPPR(ss)) {
232 void icp_set_cppr(ICPState *ss, uint8_t cppr)
238 ss->xirr = (ss->xirr & ~CPPR_MASK) | (cppr << 24);
240 if (cppr < old_cppr) {
241 if (XISR(ss) && (cppr <= ss->pending_priority)) {
243 ss->xirr &= ~XISR_MASK; /* Clear XISR */
244 ss->pending_priority = 0xff;
245 qemu_irq_lower(ss->output);
246 if (ss->xirr_owner) {
247 ics_reject(ss->xirr_owner, old_xisr);
248 ss->xirr_owner = NULL;
258 void icp_set_mfrr(ICPState *ss, uint8_t mfrr)
261 if (mfrr < CPPR(ss)) {
266 uint32_t icp_accept(ICPState *ss)
268 uint32_t xirr = ss->xirr;
270 qemu_irq_lower(ss->output);
271 ss->xirr = ss->pending_priority << 24;
272 ss->pending_priority = 0xff;
273 ss->xirr_owner = NULL;
275 trace_xics_icp_accept(xirr, ss->xirr);
280 uint32_t icp_ipoll(ICPState *ss, uint32_t *mfrr)
288 void icp_eoi(ICPState *ss, uint32_t xirr)
290 XICSFabric *xi = ss->xics;
291 XICSFabricClass *xic = XICS_FABRIC_GET_CLASS(xi);
295 /* Send EOI -> ICS */
296 ss->xirr = (ss->xirr & ~CPPR_MASK) | (xirr & CPPR_MASK);
297 trace_xics_icp_eoi(ss->cs->cpu_index, xirr, ss->xirr);
298 irq = xirr & XISR_MASK;
300 ics = xic->ics_get(xi, irq);
309 static void icp_irq(ICSState *ics, int server, int nr, uint8_t priority)
311 XICSState *xics = ics->xics;
312 ICPState *ss = xics->ss + server;
314 trace_xics_icp_irq(server, nr, priority);
316 if ((priority >= CPPR(ss))
317 || (XISR(ss) && (ss->pending_priority <= priority))) {
320 if (XISR(ss) && ss->xirr_owner) {
321 ics_reject(ss->xirr_owner, XISR(ss));
322 ss->xirr_owner = NULL;
324 ss->xirr = (ss->xirr & ~XISR_MASK) | (nr & XISR_MASK);
325 ss->xirr_owner = ics;
326 ss->pending_priority = priority;
327 trace_xics_icp_raise(ss->xirr, ss->pending_priority);
328 qemu_irq_raise(ss->output);
332 static void icp_dispatch_pre_save(void *opaque)
334 ICPState *ss = opaque;
335 ICPStateClass *info = ICP_GET_CLASS(ss);
337 if (info->pre_save) {
342 static int icp_dispatch_post_load(void *opaque, int version_id)
344 ICPState *ss = opaque;
345 ICPStateClass *info = ICP_GET_CLASS(ss);
347 if (info->post_load) {
348 return info->post_load(ss, version_id);
354 static const VMStateDescription vmstate_icp_server = {
355 .name = "icp/server",
357 .minimum_version_id = 1,
358 .pre_save = icp_dispatch_pre_save,
359 .post_load = icp_dispatch_post_load,
360 .fields = (VMStateField[]) {
362 VMSTATE_UINT32(xirr, ICPState),
363 VMSTATE_UINT8(pending_priority, ICPState),
364 VMSTATE_UINT8(mfrr, ICPState),
365 VMSTATE_END_OF_LIST()
369 static void icp_reset(DeviceState *dev)
371 ICPState *icp = ICP(dev);
374 icp->pending_priority = 0xff;
377 /* Make all outputs are deasserted */
378 qemu_set_irq(icp->output, 0);
381 static void icp_realize(DeviceState *dev, Error **errp)
383 ICPState *icp = ICP(dev);
387 obj = object_property_get_link(OBJECT(dev), "xics", &err);
389 error_setg(errp, "%s: required link 'xics' not found: %s",
390 __func__, error_get_pretty(err));
394 icp->xics = XICS_FABRIC(obj);
398 static void icp_class_init(ObjectClass *klass, void *data)
400 DeviceClass *dc = DEVICE_CLASS(klass);
401 InterruptStatsProviderClass *ic = INTERRUPT_STATS_PROVIDER_CLASS(klass);
403 dc->reset = icp_reset;
404 dc->vmsd = &vmstate_icp_server;
405 dc->realize = icp_realize;
406 ic->print_info = icp_pic_print_info;
409 static const TypeInfo icp_info = {
411 .parent = TYPE_DEVICE,
412 .instance_size = sizeof(ICPState),
413 .class_init = icp_class_init,
414 .class_size = sizeof(ICPStateClass),
415 .interfaces = (InterfaceInfo[]) {
416 { TYPE_INTERRUPT_STATS_PROVIDER },
424 static void ics_simple_resend_msi(ICSState *ics, int srcno)
426 ICSIRQState *irq = ics->irqs + srcno;
428 /* FIXME: filter by server#? */
429 if (irq->status & XICS_STATUS_REJECTED) {
430 irq->status &= ~XICS_STATUS_REJECTED;
431 if (irq->priority != 0xff) {
432 icp_irq(ics, irq->server, srcno + ics->offset, irq->priority);
437 static void ics_simple_resend_lsi(ICSState *ics, int srcno)
439 ICSIRQState *irq = ics->irqs + srcno;
441 if ((irq->priority != 0xff)
442 && (irq->status & XICS_STATUS_ASSERTED)
443 && !(irq->status & XICS_STATUS_SENT)) {
444 irq->status |= XICS_STATUS_SENT;
445 icp_irq(ics, irq->server, srcno + ics->offset, irq->priority);
449 static void ics_simple_set_irq_msi(ICSState *ics, int srcno, int val)
451 ICSIRQState *irq = ics->irqs + srcno;
453 trace_xics_ics_simple_set_irq_msi(srcno, srcno + ics->offset);
456 if (irq->priority == 0xff) {
457 irq->status |= XICS_STATUS_MASKED_PENDING;
458 trace_xics_masked_pending();
460 icp_irq(ics, irq->server, srcno + ics->offset, irq->priority);
465 static void ics_simple_set_irq_lsi(ICSState *ics, int srcno, int val)
467 ICSIRQState *irq = ics->irqs + srcno;
469 trace_xics_ics_simple_set_irq_lsi(srcno, srcno + ics->offset);
471 irq->status |= XICS_STATUS_ASSERTED;
473 irq->status &= ~XICS_STATUS_ASSERTED;
475 ics_simple_resend_lsi(ics, srcno);
478 static void ics_simple_set_irq(void *opaque, int srcno, int val)
480 ICSState *ics = (ICSState *)opaque;
482 if (ics->irqs[srcno].flags & XICS_FLAGS_IRQ_LSI) {
483 ics_simple_set_irq_lsi(ics, srcno, val);
485 ics_simple_set_irq_msi(ics, srcno, val);
489 static void ics_simple_write_xive_msi(ICSState *ics, int srcno)
491 ICSIRQState *irq = ics->irqs + srcno;
493 if (!(irq->status & XICS_STATUS_MASKED_PENDING)
494 || (irq->priority == 0xff)) {
498 irq->status &= ~XICS_STATUS_MASKED_PENDING;
499 icp_irq(ics, irq->server, srcno + ics->offset, irq->priority);
502 static void ics_simple_write_xive_lsi(ICSState *ics, int srcno)
504 ics_simple_resend_lsi(ics, srcno);
507 void ics_simple_write_xive(ICSState *ics, int srcno, int server,
508 uint8_t priority, uint8_t saved_priority)
510 ICSIRQState *irq = ics->irqs + srcno;
512 irq->server = server;
513 irq->priority = priority;
514 irq->saved_priority = saved_priority;
516 trace_xics_ics_simple_write_xive(ics->offset + srcno, srcno, server,
519 if (ics->irqs[srcno].flags & XICS_FLAGS_IRQ_LSI) {
520 ics_simple_write_xive_lsi(ics, srcno);
522 ics_simple_write_xive_msi(ics, srcno);
526 static void ics_simple_reject(ICSState *ics, uint32_t nr)
528 ICSIRQState *irq = ics->irqs + nr - ics->offset;
530 trace_xics_ics_simple_reject(nr, nr - ics->offset);
531 if (irq->flags & XICS_FLAGS_IRQ_MSI) {
532 irq->status |= XICS_STATUS_REJECTED;
533 } else if (irq->flags & XICS_FLAGS_IRQ_LSI) {
534 irq->status &= ~XICS_STATUS_SENT;
538 static void ics_simple_resend(ICSState *ics)
542 for (i = 0; i < ics->nr_irqs; i++) {
543 /* FIXME: filter by server#? */
544 if (ics->irqs[i].flags & XICS_FLAGS_IRQ_LSI) {
545 ics_simple_resend_lsi(ics, i);
547 ics_simple_resend_msi(ics, i);
552 static void ics_simple_eoi(ICSState *ics, uint32_t nr)
554 int srcno = nr - ics->offset;
555 ICSIRQState *irq = ics->irqs + srcno;
557 trace_xics_ics_simple_eoi(nr);
559 if (ics->irqs[srcno].flags & XICS_FLAGS_IRQ_LSI) {
560 irq->status &= ~XICS_STATUS_SENT;
564 static void ics_simple_reset(DeviceState *dev)
566 ICSState *ics = ICS_SIMPLE(dev);
568 uint8_t flags[ics->nr_irqs];
570 for (i = 0; i < ics->nr_irqs; i++) {
571 flags[i] = ics->irqs[i].flags;
574 memset(ics->irqs, 0, sizeof(ICSIRQState) * ics->nr_irqs);
576 for (i = 0; i < ics->nr_irqs; i++) {
577 ics->irqs[i].priority = 0xff;
578 ics->irqs[i].saved_priority = 0xff;
579 ics->irqs[i].flags = flags[i];
583 static int ics_simple_post_load(ICSState *ics, int version_id)
587 for (i = 0; i < ics->xics->nr_servers; i++) {
588 icp_resend(&ics->xics->ss[i]);
594 static void ics_simple_dispatch_pre_save(void *opaque)
596 ICSState *ics = opaque;
597 ICSStateClass *info = ICS_BASE_GET_CLASS(ics);
599 if (info->pre_save) {
604 static int ics_simple_dispatch_post_load(void *opaque, int version_id)
606 ICSState *ics = opaque;
607 ICSStateClass *info = ICS_BASE_GET_CLASS(ics);
609 if (info->post_load) {
610 return info->post_load(ics, version_id);
616 static const VMStateDescription vmstate_ics_simple_irq = {
619 .minimum_version_id = 1,
620 .fields = (VMStateField[]) {
621 VMSTATE_UINT32(server, ICSIRQState),
622 VMSTATE_UINT8(priority, ICSIRQState),
623 VMSTATE_UINT8(saved_priority, ICSIRQState),
624 VMSTATE_UINT8(status, ICSIRQState),
625 VMSTATE_UINT8(flags, ICSIRQState),
626 VMSTATE_END_OF_LIST()
630 static const VMStateDescription vmstate_ics_simple = {
633 .minimum_version_id = 1,
634 .pre_save = ics_simple_dispatch_pre_save,
635 .post_load = ics_simple_dispatch_post_load,
636 .fields = (VMStateField[]) {
638 VMSTATE_UINT32_EQUAL(nr_irqs, ICSState),
640 VMSTATE_STRUCT_VARRAY_POINTER_UINT32(irqs, ICSState, nr_irqs,
641 vmstate_ics_simple_irq,
643 VMSTATE_END_OF_LIST()
647 static void ics_simple_initfn(Object *obj)
649 ICSState *ics = ICS_SIMPLE(obj);
651 ics->offset = XICS_IRQ_BASE;
654 static void ics_simple_realize(DeviceState *dev, Error **errp)
656 ICSState *ics = ICS_SIMPLE(dev);
659 error_setg(errp, "Number of interrupts needs to be greater 0");
662 ics->irqs = g_malloc0(ics->nr_irqs * sizeof(ICSIRQState));
663 ics->qirqs = qemu_allocate_irqs(ics_simple_set_irq, ics, ics->nr_irqs);
666 static Property ics_simple_properties[] = {
667 DEFINE_PROP_UINT32("nr-irqs", ICSState, nr_irqs, 0),
668 DEFINE_PROP_END_OF_LIST(),
671 static void ics_simple_class_init(ObjectClass *klass, void *data)
673 DeviceClass *dc = DEVICE_CLASS(klass);
674 ICSStateClass *isc = ICS_BASE_CLASS(klass);
675 InterruptStatsProviderClass *ic = INTERRUPT_STATS_PROVIDER_CLASS(klass);
677 isc->realize = ics_simple_realize;
678 dc->props = ics_simple_properties;
679 dc->vmsd = &vmstate_ics_simple;
680 dc->reset = ics_simple_reset;
681 isc->post_load = ics_simple_post_load;
682 isc->reject = ics_simple_reject;
683 isc->resend = ics_simple_resend;
684 isc->eoi = ics_simple_eoi;
685 ic->print_info = ics_simple_pic_print_info;
688 static const TypeInfo ics_simple_info = {
689 .name = TYPE_ICS_SIMPLE,
690 .parent = TYPE_ICS_BASE,
691 .instance_size = sizeof(ICSState),
692 .class_init = ics_simple_class_init,
693 .class_size = sizeof(ICSStateClass),
694 .instance_init = ics_simple_initfn,
695 .interfaces = (InterfaceInfo[]) {
696 { TYPE_INTERRUPT_STATS_PROVIDER },
701 static void ics_base_realize(DeviceState *dev, Error **errp)
703 ICSStateClass *icsc = ICS_BASE_GET_CLASS(dev);
704 ICSState *ics = ICS_BASE(dev);
708 obj = object_property_get_link(OBJECT(dev), "xics", &err);
710 error_setg(errp, "%s: required link 'xics' not found: %s",
711 __func__, error_get_pretty(err));
714 ics->xics = XICS_COMMON(obj);
718 icsc->realize(dev, errp);
722 static void ics_base_class_init(ObjectClass *klass, void *data)
724 DeviceClass *dc = DEVICE_CLASS(klass);
726 dc->realize = ics_base_realize;
729 static const TypeInfo ics_base_info = {
730 .name = TYPE_ICS_BASE,
731 .parent = TYPE_DEVICE,
733 .instance_size = sizeof(ICSState),
734 .class_init = ics_base_class_init,
735 .class_size = sizeof(ICSStateClass),
738 static const TypeInfo xics_fabric_info = {
739 .name = TYPE_XICS_FABRIC,
740 .parent = TYPE_INTERFACE,
741 .class_size = sizeof(XICSFabricClass),
747 qemu_irq xics_get_qirq(XICSFabric *xi, int irq)
749 XICSFabricClass *xic = XICS_FABRIC_GET_CLASS(xi);
750 ICSState *ics = xic->ics_get(xi, irq);
753 return ics->qirqs[irq - ics->offset];
759 void ics_set_irq_type(ICSState *ics, int srcno, bool lsi)
761 assert(!(ics->irqs[srcno].flags & XICS_FLAGS_IRQ_MASK));
763 ics->irqs[srcno].flags |=
764 lsi ? XICS_FLAGS_IRQ_LSI : XICS_FLAGS_IRQ_MSI;
767 static void xics_register_types(void)
769 type_register_static(&xics_common_info);
770 type_register_static(&ics_simple_info);
771 type_register_static(&ics_base_info);
772 type_register_static(&icp_info);
773 type_register_static(&xics_fabric_info);
776 type_init(xics_register_types)