/* $Id: DevPIC.cpp 12977 2008-10-03 23:24:35Z vboxsync $ */ /** @file * DevPIC - Intel 8259 Programmable Interrupt Controller (PIC) Device. */ /* * Copyright (C) 2006-2007 Sun Microsystems, Inc. * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa * Clara, CA 95054 USA or visit http://www.sun.com if you need * additional information or have any questions. */ /******************************************************************************* * Header Files * *******************************************************************************/ #define LOG_GROUP LOG_GROUP_DEV_PIC #include #include #include #include #include "../Builtins.h" /******************************************************************************* * Defined Constants And Macros * *******************************************************************************/ /** @def PIC_LOCK * Acquires the PDM lock. This is a NOP if locking is disabled. */ /** @def PIC_UNLOCK * Releases the PDM lock. This is a NOP if locking is disabled. */ #define PIC_LOCK(pThis, rc) \ do { \ int rc2 = (pThis)->CTX_SUFF(pPicHlp)->pfnLock((pThis)->CTX_SUFF(pDevIns), rc); \ if (rc2 != VINF_SUCCESS) \ return rc2; \ } while (0) #define PIC_UNLOCK(pThis) \ (pThis)->CTX_SUFF(pPicHlp)->pfnUnlock((pThis)->CTX_SUFF(pDevIns)) #ifndef VBOX_DEVICE_STRUCT_TESTCASE /******************************************************************************* * Internal Functions * *******************************************************************************/ __BEGIN_DECLS PDMBOTHCBDECL(void) picSetIrq(PPDMDEVINS pDevIns, int iIrq, int iLevel); PDMBOTHCBDECL(int) picGetInterrupt(PPDMDEVINS pDevIns); PDMBOTHCBDECL(int) picIOPortRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb); PDMBOTHCBDECL(int) picIOPortWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb); PDMBOTHCBDECL(int) picIOPortElcrRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb); PDMBOTHCBDECL(int) picIOPortElcrWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb); __END_DECLS #endif /* !VBOX_DEVICE_STRUCT_TESTCASE */ /* * QEMU 8259 interrupt controller emulation * * Copyright (c) 2003-2004 Fabrice Bellard * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ /* debug PIC */ #define DEBUG_PIC /*#define DEBUG_IRQ_COUNT*/ typedef struct PicState { uint8_t last_irr; /* edge detection */ uint8_t irr; /* interrupt request register */ uint8_t imr; /* interrupt mask register */ uint8_t isr; /* interrupt service register */ uint8_t priority_add; /* highest irq priority */ uint8_t irq_base; uint8_t read_reg_select; uint8_t poll; uint8_t special_mask; uint8_t init_state; uint8_t auto_eoi; uint8_t rotate_on_auto_eoi; uint8_t special_fully_nested_mode; uint8_t init4; /* true if 4 byte init */ uint8_t elcr; /* PIIX edge/trigger selection*/ uint8_t elcr_mask; /** Pointer to the device instance, R3 Ptr. */ PPDMDEVINSR3 pDevInsR3; /** Pointer to the device instance, R0 Ptr. */ PPDMDEVINSR0 pDevInsR0; /** Pointer to the device instance, RC Ptr. */ PPDMDEVINSRC pDevInsRC; RTRCPTR Alignment0; /**< Structure size alignment. */ } PicState; /** * A PIC device instance data. */ typedef struct DEVPIC { /** The two interrupt controllers. */ PicState aPics[2]; /** Pointer to the device instance - R3 Ptr. */ PPDMDEVINSR3 pDevInsR3; /** Pointer to the PIC R3 helpers. */ PCPDMPICHLPR3 pPicHlpR3; /** Pointer to the device instance - R0 Ptr. */ PPDMDEVINSR0 pDevInsR0; /** Pointer to the PIC R0 helpers. */ PCPDMPICHLPR0 pPicHlpR0; /** Pointer to the device instance - RC Ptr. */ PPDMDEVINSRC pDevInsRC; /** Pointer to the PIC RC helpers. */ PCPDMPICHLPRC pPicHlpRC; #ifdef VBOX_WITH_STATISTICS STAMCOUNTER StatSetIrqGC; STAMCOUNTER StatSetIrqHC; STAMCOUNTER StatClearedActiveIRQ2; STAMCOUNTER StatClearedActiveMasterIRQ; STAMCOUNTER StatClearedActiveSlaveIRQ; #endif } DEVPIC, *PDEVPIC; #ifndef VBOX_DEVICE_STRUCT_TESTCASE #ifdef LOG_ENABLED static inline void DumpPICState(PicState *s, const char *szFn) { PDEVPIC pThis = PDMINS_2_DATA(s->CTX_SUFF(pDevIns), PDEVPIC); Log2(("%s: pic%d: elcr=%x last_irr=%x irr=%x imr=%x isr=%x irq_base=%x\n", szFn, (&pThis->aPics[0] == s) ? 0 : 1, s->elcr, s->last_irr, s->irr, s->imr, s->isr, s->irq_base)); } #else # define DumpPICState(pThis, szFn) do { } while (0) #endif /* set irq level. If an edge is detected, then the IRR is set to 1 */ static inline void pic_set_irq1(PicState *s, int irq, int level) { int mask; Log(("pic_set_irq1: irq=%d level=%d\n", irq, level)); mask = 1 << irq; if (s->elcr & mask) { /* level triggered */ if (level) { Log2(("pic_set_irq1(ls) irr=%d irrnew=%d\n", s->irr, s->irr | mask)); s->irr |= mask; s->last_irr |= mask; } else { Log2(("pic_set_irq1(lc) irr=%d irrnew=%d\n", s->irr, s->irr & ~mask)); s->irr &= ~mask; s->last_irr &= ~mask; } } else { /* edge triggered */ if (level) { if ((s->last_irr & mask) == 0) { Log2(("pic_set_irq1 irr=%x last_irr=%x\n", s->irr | mask, s->last_irr)); s->irr |= mask; } s->last_irr |= mask; } else { s->last_irr &= ~mask; } } DumpPICState(s, "pic_set_irq1"); } /* return the highest priority found in mask (highest = smallest number). Return 8 if no irq */ static inline int get_priority(PicState *s, int mask) { int priority; if (mask == 0) return 8; priority = 0; while ((mask & (1 << ((priority + s->priority_add) & 7))) == 0) priority++; return priority; } /* return the pic wanted interrupt. return -1 if none */ static int pic_get_irq(PicState *s) { PicState *pics = &(PDMINS_2_DATA(s->CTX_SUFF(pDevIns), PDEVPIC))->aPics[0]; int mask, cur_priority, priority; Log(("pic_get_irq%d: mask=%x\n", (s == pics) ? 0 : 1, s->irr & ~s->imr)); DumpPICState(s, "pic_get_irq"); mask = s->irr & ~s->imr; priority = get_priority(s, mask); Log(("pic_get_irq: priority=%x\n", priority)); if (priority == 8) return -1; /* compute current priority. If special fully nested mode on the master, the IRQ coming from the slave is not taken into account for the priority computation. */ mask = s->isr; if (s->special_fully_nested_mode && s == &pics[0]) mask &= ~(1 << 2); cur_priority = get_priority(s, mask); Log(("pic_get_irq%d: cur_priority=%x pending=%d\n", (s == pics) ? 0 : 1, cur_priority, (priority == 8) ? -1 : (priority + s->priority_add) & 7)); if (priority < cur_priority) { /* higher priority found: an irq should be generated */ return (priority + s->priority_add) & 7; } else { return -1; } } /* raise irq to CPU if necessary. must be called every time the active irq may change */ static int pic_update_irq(PDEVPIC pThis) { PicState *pics = &pThis->aPics[0]; int irq2, irq; /* first look at slave pic */ irq2 = pic_get_irq(&pics[1]); Log(("pic_update_irq irq2=%d\n", irq2)); if (irq2 >= 0) { /* if irq request by slave pic, signal master PIC */ pic_set_irq1(&pics[0], 2, 1); pic_set_irq1(&pics[0], 2, 0); } /* look at requested irq */ irq = pic_get_irq(&pics[0]); if (irq >= 0) { /* If irq 2 is pending on the master pic, then there must be one pending on the slave pic too! Otherwise we'll get * spurious slave interrupts in picGetInterrupt. */ if (irq != 2 || irq2 != -1) { #if defined(DEBUG_PIC) int i; for(i = 0; i < 2; i++) { Log(("pic%d: imr=%x irr=%x padd=%d\n", i, pics[i].imr, pics[i].irr, pics[i].priority_add)); } Log(("pic: cpu_interrupt\n")); #endif pThis->CTX_SUFF(pPicHlp)->pfnSetInterruptFF(pThis->CTX_SUFF(pDevIns)); } else { STAM_COUNTER_INC(&pThis->StatClearedActiveIRQ2); Log(("pic_update_irq: irq 2 is active, but no interrupt is pending on the slave pic!!\n")); /* Clear it here, so lower priority interrupts can still be dispatched. */ /* if this was the only pending irq, then we must clear the interrupt ff flag */ pThis->CTX_SUFF(pPicHlp)->pfnClearInterruptFF(pThis->CTX_SUFF(pDevIns)); /** @note Is this correct? */ pics[0].irr &= ~(1 << 2); /* Call ourselves again just in case other interrupts are pending */ return pic_update_irq(pThis); } } else { Log(("pic_update_irq: no interrupt is pending!!\n")); /* we must clear the interrupt ff flag */ pThis->CTX_SUFF(pPicHlp)->pfnClearInterruptFF(pThis->CTX_SUFF(pDevIns)); } return VINF_SUCCESS; } /** @note if an interrupt line state changes from unmasked to masked, then it must be deactivated when currently pending! */ static void pic_update_imr(PDEVPIC pThis, PicState *s, uint8_t val) { int irq, intno; PicState *pActivePIC; /* Query the current pending irq, if any. */ pActivePIC = &pThis->aPics[0]; intno = irq = pic_get_irq(pActivePIC); if (irq == 2) { pActivePIC = &pThis->aPics[1]; irq = pic_get_irq(pActivePIC); intno = irq + 8; } /* Update IMR */ s->imr = val; /* If an interrupt is pending and now masked, then clear the FF flag. */ if ( irq >= 0 && ((1 << irq) & ~pActivePIC->imr) == 0) { Log(("pic_update_imr: pic0: elcr=%x last_irr=%x irr=%x imr=%x isr=%x irq_base=%x\n", pThis->aPics[0].elcr, pThis->aPics[0].last_irr, pThis->aPics[0].irr, pThis->aPics[0].imr, pThis->aPics[0].isr, pThis->aPics[0].irq_base)); Log(("pic_update_imr: pic1: elcr=%x last_irr=%x irr=%x imr=%x isr=%x irq_base=%x\n", pThis->aPics[1].elcr, pThis->aPics[1].last_irr, pThis->aPics[1].irr, pThis->aPics[1].imr, pThis->aPics[1].isr, pThis->aPics[1].irq_base)); /* Clear pending IRQ 2 on master controller in case of slave interrupt. */ /** @todo Is this correct? */ if (intno > 7) { pThis->aPics[0].irr &= ~(1 << 2); STAM_COUNTER_INC(&pThis->StatClearedActiveSlaveIRQ); } else STAM_COUNTER_INC(&pThis->StatClearedActiveMasterIRQ); Log(("pic_update_imr: clear pending interrupt %d\n", intno)); pThis->CTX_SUFF(pPicHlp)->pfnClearInterruptFF(pThis->CTX_SUFF(pDevIns)); } } /** * Set the an IRQ. * * @param pDevIns Device instance of the PICs. * @param iIrq IRQ number to set. * @param iLevel IRQ level. */ PDMBOTHCBDECL(void) picSetIrq(PPDMDEVINS pDevIns, int iIrq, int iLevel) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); Assert(pThis->CTX_SUFF(pDevIns) == pDevIns); Assert(pThis->aPics[0].CTX_SUFF(pDevIns) == pDevIns); Assert(pThis->aPics[1].CTX_SUFF(pDevIns) == pDevIns); AssertMsg(iIrq < 16, ("iIrq=%d\n", iIrq)); Log(("picSetIrq %d %d\n", iIrq, iLevel)); DumpPICState(&pThis->aPics[0], "picSetIrq"); DumpPICState(&pThis->aPics[1], "picSetIrq"); STAM_COUNTER_INC(&pThis->CTXSUFF(StatSetIrq)); pic_set_irq1(&pThis->aPics[iIrq >> 3], iIrq & 7, iLevel & PDM_IRQ_LEVEL_HIGH); pic_update_irq(pThis); if ((iLevel & PDM_IRQ_LEVEL_FLIP_FLOP) == PDM_IRQ_LEVEL_FLIP_FLOP) { pic_set_irq1(&pThis->aPics[iIrq >> 3], iIrq & 7, 0); pic_update_irq(pThis); } } /* acknowledge interrupt 'irq' */ static inline void pic_intack(PicState *s, int irq) { if (s->auto_eoi) { if (s->rotate_on_auto_eoi) s->priority_add = (irq + 1) & 7; } else { s->isr |= (1 << irq); } /* We don't clear a level sensitive interrupt here */ if (!(s->elcr & (1 << irq))) { Log2(("pic_intack: irr=%x irrnew=%x\n", s->irr, s->irr & ~(1 << irq))); s->irr &= ~(1 << irq); } } /** * Get a pending interrupt. * * @returns Pending interrupt number. * @param pDevIns Device instance of the PICs. */ PDMBOTHCBDECL(int) picGetInterrupt(PPDMDEVINS pDevIns) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); int irq; int irq2; int intno; /* read the irq from the PIC */ DumpPICState(&pThis->aPics[0], "picGetInterrupt"); DumpPICState(&pThis->aPics[1], "picGetInterrupt"); irq = pic_get_irq(&pThis->aPics[0]); if (irq >= 0) { pic_intack(&pThis->aPics[0], irq); if (irq == 2) { irq2 = pic_get_irq(&pThis->aPics[1]); if (irq2 >= 0) { pic_intack(&pThis->aPics[1], irq2); } else { /* spurious IRQ on slave controller (impossible) */ AssertMsgFailed(("picGetInterrupt: spurious IRQ on slave controller\n")); irq2 = 7; } intno = pThis->aPics[1].irq_base + irq2; Log2(("picGetInterrupt1: %x base=%x irq=%x\n", intno, pThis->aPics[1].irq_base, irq2)); irq = irq2 + 8; } else { intno = pThis->aPics[0].irq_base + irq; Log2(("picGetInterrupt0: %x base=%x irq=%x\n", intno, pThis->aPics[0].irq_base, irq)); } } else { /* spurious IRQ on host controller (impossible) */ AssertMsgFailed(("picGetInterrupt: spurious IRQ on master controller\n")); irq = 7; intno = pThis->aPics[0].irq_base + irq; } pic_update_irq(pThis); Log(("picGetInterrupt: 0x%02x pending 0:%d 1:%d\n", intno, pic_get_irq(&pThis->aPics[0]), pic_get_irq(&pThis->aPics[1]))); return intno; } static void pic_reset(PicState *s) { PPDMDEVINSR3 pDevInsR3 = s->pDevInsR3; PPDMDEVINSR0 pDevInsR0 = s->pDevInsR0; PPDMDEVINSRC pDevInsRC = s->pDevInsRC; int elcr_mask = s->elcr_mask; int elcr = s->elcr; memset(s, 0, sizeof(PicState)); s->elcr = elcr; s->elcr_mask = elcr_mask; s->pDevInsRC = pDevInsRC; s->pDevInsR0 = pDevInsR0; s->pDevInsR3 = pDevInsR3; } static int pic_ioport_write(void *opaque, uint32_t addr, uint32_t val) { PicState *s = (PicState*)opaque; PDEVPIC pThis = PDMINS_2_DATA(s->CTX_SUFF(pDevIns), PDEVPIC); int rc = VINF_SUCCESS; int priority, cmd, irq; Log(("pic_write: addr=0x%02x val=0x%02x\n", addr, val)); addr &= 1; if (addr == 0) { if (val & 0x10) { /* init */ pic_reset(s); /* deassert a pending interrupt */ pThis->CTX_SUFF(pPicHlp)->pfnClearInterruptFF(pThis->CTX_SUFF(pDevIns)); s->init_state = 1; s->init4 = val & 1; if (val & 0x02) AssertReleaseMsgFailed(("single mode not supported")); if (val & 0x08) AssertReleaseMsgFailed(("level sensitive irq not supported")); } else if (val & 0x08) { if (val & 0x04) s->poll = 1; if (val & 0x02) s->read_reg_select = val & 1; if (val & 0x40) s->special_mask = (val >> 5) & 1; } else { cmd = val >> 5; switch(cmd) { case 0: case 4: s->rotate_on_auto_eoi = cmd >> 2; break; case 1: /* end of interrupt */ case 5: { priority = get_priority(s, s->isr); if (priority != 8) { irq = (priority + s->priority_add) & 7; Log(("pic_write: EOI prio=%d irq=%d\n", priority, irq)); s->isr &= ~(1 << irq); if (cmd == 5) s->priority_add = (irq + 1) & 7; rc = pic_update_irq(pThis); Assert(rc == VINF_SUCCESS); DumpPICState(s, "eoi"); } break; } case 3: { irq = val & 7; Log(("pic_write: EOI2 for irq %d\n", irq)); s->isr &= ~(1 << irq); rc = pic_update_irq(pThis); Assert(rc == VINF_SUCCESS); DumpPICState(s, "eoi2"); break; } case 6: { s->priority_add = (val + 1) & 7; Log(("pic_write: lowest priority %d (highest %d)\n", val & 7, s->priority_add)); rc = pic_update_irq(pThis); Assert(rc == VINF_SUCCESS); break; } case 7: { irq = val & 7; Log(("pic_write: EOI3 for irq %d\n", irq)); s->isr &= ~(1 << irq); s->priority_add = (irq + 1) & 7; rc = pic_update_irq(pThis); Assert(rc == VINF_SUCCESS); DumpPICState(s, "eoi3"); break; } default: /* no operation */ break; } } } else { switch(s->init_state) { case 0: { /* normal mode */ pic_update_imr(pThis, s, val); rc = pic_update_irq(pThis); Assert(rc == VINF_SUCCESS); break; } case 1: s->irq_base = val & 0xf8; s->init_state = 2; Log(("pic_write: set irq base to %x\n", s->irq_base)); break; case 2: if (s->init4) { s->init_state = 3; } else { s->init_state = 0; } break; case 3: s->special_fully_nested_mode = (val >> 4) & 1; s->auto_eoi = (val >> 1) & 1; s->init_state = 0; Log(("pic_write: special_fully_nested_mode=%d auto_eoi=%d\n", s->special_fully_nested_mode, s->auto_eoi)); break; } } return rc; } static uint32_t pic_poll_read (PicState *s, uint32_t addr1) { PDEVPIC pThis = PDMINS_2_DATA(s->CTX_SUFF(pDevIns), PDEVPIC); PicState *pics = &pThis->aPics[0]; int ret; ret = pic_get_irq(s); if (ret >= 0) { if (addr1 >> 7) { Log2(("pic_poll_read: clear slave irq (isr)\n")); pics[0].isr &= ~(1 << 2); pics[0].irr &= ~(1 << 2); } Log2(("pic_poll_read: clear irq %d (isr)\n", ret)); s->irr &= ~(1 << ret); s->isr &= ~(1 << ret); if (addr1 >> 7 || ret != 2) pic_update_irq(pThis); } else { ret = 0x07; pic_update_irq(pThis); } return ret; } static uint32_t pic_ioport_read(void *opaque, uint32_t addr1, int *pRC) { PicState *s = (PicState*)opaque; unsigned int addr; int ret; *pRC = VINF_SUCCESS; addr = addr1; addr &= 1; if (s->poll) { ret = pic_poll_read(s, addr1); s->poll = 0; } else { if (addr == 0) { if (s->read_reg_select) ret = s->isr; else ret = s->irr; } else { ret = s->imr; } } Log(("pic_read: addr=0x%02x val=0x%02x\n", addr1, ret)); return ret; } /* -=-=-=-=-=- wrappers / stuff -=-=-=-=-=- */ /** * Port I/O Handler for IN operations. * * @returns VBox status code. * * @param pDevIns The device instance. * @param pvUser User argument - pointer to the PIC in question. * @param uPort Port number used for the IN operation. * @param pu32 Where to store the result. * @param cb Number of bytes read. */ PDMBOTHCBDECL(int) picIOPortRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); uint32_t iPic = (uint32_t)(uintptr_t)pvUser; Assert(iPic == 0 || iPic == 1); if (cb == 1) { int rc; PIC_LOCK(pThis, VINF_IOM_HC_IOPORT_READ); *pu32 = pic_ioport_read(&pThis->aPics[iPic], Port, &rc); PIC_UNLOCK(pThis); return rc; } return VERR_IOM_IOPORT_UNUSED; } /** * Port I/O Handler for OUT operations. * * @returns VBox status code. * * @param pDevIns The device instance. * @param pvUser User argument - pointer to the PIC in question. * @param uPort Port number used for the IN operation. * @param u32 The value to output. * @param cb The value size in bytes. */ PDMBOTHCBDECL(int) picIOPortWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); uint32_t iPic = (uint32_t)(uintptr_t)pvUser; Assert(iPic == 0 || iPic == 1); if (cb == 1) { int rc; PIC_LOCK(pThis, VINF_IOM_HC_IOPORT_WRITE); rc = pic_ioport_write(&pThis->aPics[iPic], Port, u32); PIC_UNLOCK(pThis); return rc; } return VINF_SUCCESS; } /** * Port I/O Handler for IN operations. * * @returns VBox status code. * * @param pDevIns The device instance. * @param pvUser User argument - pointer to the PIC in question. * @param uPort Port number used for the IN operation. * @param pu32 Where to store the result. * @param cb Number of bytes read. */ PDMBOTHCBDECL(int) picIOPortElcrRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb) { if (cb == 1) { PicState *s = (PicState*)pvUser; PIC_LOCK(PDMINS_2_DATA(pDevIns, PDEVPIC), VINF_IOM_HC_IOPORT_READ); *pu32 = s->elcr; PIC_UNLOCK(PDMINS_2_DATA(pDevIns, PDEVPIC)); return VINF_SUCCESS; } return VERR_IOM_IOPORT_UNUSED; } /** * Port I/O Handler for OUT operations. * * @returns VBox status code. * * @param pDevIns The device instance. * @param pvUser User argument - pointer to the PIC in question. * @param uPort Port number used for the IN operation. * @param u32 The value to output. * @param cb The value size in bytes. */ PDMBOTHCBDECL(int) picIOPortElcrWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb) { if (cb == 1) { PicState *s = (PicState*)pvUser; PIC_LOCK(PDMINS_2_DATA(pDevIns, PDEVPIC), VINF_IOM_HC_IOPORT_WRITE); s->elcr = u32 & s->elcr_mask; PIC_UNLOCK(PDMINS_2_DATA(pDevIns, PDEVPIC)); } return VINF_SUCCESS; } #ifdef IN_RING3 #ifdef DEBUG /** * PIC status info callback. * * @param pDevIns The device instance. * @param pHlp The output helpers. * @param pszArgs The arguments. */ static DECLCALLBACK(void) picInfo(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); /* * Show info. */ for (int i=0;i<2;i++) { pHlp->pfnPrintf(pHlp, "PIC%d:\n", i); pHlp->pfnPrintf(pHlp, " last_irr = %02x\n", pThis->aPics[i].last_irr); pHlp->pfnPrintf(pHlp, " irr = %02x\n", pThis->aPics[i].irr); pHlp->pfnPrintf(pHlp, " imr = %02x\n", pThis->aPics[i].imr); pHlp->pfnPrintf(pHlp, " isr = %02x\n", pThis->aPics[i].isr); pHlp->pfnPrintf(pHlp, " priority_add = %02x\n", pThis->aPics[i].priority_add); pHlp->pfnPrintf(pHlp, " irq_base = %02x\n", pThis->aPics[i].irq_base); pHlp->pfnPrintf(pHlp, " read_reg_select = %02x\n", pThis->aPics[i].read_reg_select); pHlp->pfnPrintf(pHlp, " poll = %02x\n", pThis->aPics[i].poll); pHlp->pfnPrintf(pHlp, " special_mask = %02x\n", pThis->aPics[i].special_mask); pHlp->pfnPrintf(pHlp, " init_state = %02x\n", pThis->aPics[i].init_state); pHlp->pfnPrintf(pHlp, " auto_eoi = %02x\n", pThis->aPics[i].auto_eoi); pHlp->pfnPrintf(pHlp, " rotate_on_auto_eoi = %02x\n", pThis->aPics[i].rotate_on_auto_eoi); pHlp->pfnPrintf(pHlp, " special_fully_nested_mode = %02x\n", pThis->aPics[i].special_fully_nested_mode); pHlp->pfnPrintf(pHlp, " init4 = %02x\n", pThis->aPics[i].init4); pHlp->pfnPrintf(pHlp, " elcr = %02x\n", pThis->aPics[i].elcr); pHlp->pfnPrintf(pHlp, " elcr_mask = %02x\n", pThis->aPics[i].elcr_mask); } } #endif /* DEBUG */ /** * Saves a state of the programmable interrupt controller device. * * @returns VBox status code. * @param pDevIns The device instance. * @param pSSMHandle The handle to save the state to. */ static DECLCALLBACK(int) picSaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSMHandle) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); for (unsigned i = 0; i < RT_ELEMENTS(pThis->aPics); i++) { SSMR3PutU8(pSSMHandle, pThis->aPics[i].last_irr); SSMR3PutU8(pSSMHandle, pThis->aPics[i].irr); SSMR3PutU8(pSSMHandle, pThis->aPics[i].imr); SSMR3PutU8(pSSMHandle, pThis->aPics[i].isr); SSMR3PutU8(pSSMHandle, pThis->aPics[i].priority_add); SSMR3PutU8(pSSMHandle, pThis->aPics[i].irq_base); SSMR3PutU8(pSSMHandle, pThis->aPics[i].read_reg_select); SSMR3PutU8(pSSMHandle, pThis->aPics[i].poll); SSMR3PutU8(pSSMHandle, pThis->aPics[i].special_mask); SSMR3PutU8(pSSMHandle, pThis->aPics[i].init_state); SSMR3PutU8(pSSMHandle, pThis->aPics[i].auto_eoi); SSMR3PutU8(pSSMHandle, pThis->aPics[i].rotate_on_auto_eoi); SSMR3PutU8(pSSMHandle, pThis->aPics[i].special_fully_nested_mode); SSMR3PutU8(pSSMHandle, pThis->aPics[i].init4); SSMR3PutU8(pSSMHandle, pThis->aPics[i].elcr); } return VINF_SUCCESS; } /** * Loads a saved programmable interrupt controller device state. * * @returns VBox status code. * @param pDevIns The device instance. * @param pSSMHandle The handle to the saved state. * @param u32Version The data unit version number. */ static DECLCALLBACK(int) picLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSMHandle, uint32_t u32Version) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); if (u32Version != 1) return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION; for (unsigned i = 0; i < RT_ELEMENTS(pThis->aPics); i++) { SSMR3GetU8(pSSMHandle, &pThis->aPics[i].last_irr); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].irr); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].imr); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].isr); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].priority_add); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].irq_base); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].read_reg_select); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].poll); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].special_mask); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].init_state); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].auto_eoi); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].rotate_on_auto_eoi); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].special_fully_nested_mode); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].init4); SSMR3GetU8(pSSMHandle, &pThis->aPics[i].elcr); } return VINF_SUCCESS; } /* -=-=-=-=-=- real code -=-=-=-=-=- */ /** * Reset notification. * * @returns VBox status. * @param pDevIns The device instance data. */ static DECLCALLBACK(void) picReset(PPDMDEVINS pDevIns) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); unsigned i; LogFlow(("picReset:\n")); pThis->pPicHlpR3->pfnLock(pDevIns, VERR_INTERNAL_ERROR); for (i = 0; i < RT_ELEMENTS(pThis->aPics); i++) pic_reset(&pThis->aPics[i]); PIC_UNLOCK(pThis); } /** * @copydoc FNPDMDEVRELOCATE */ static DECLCALLBACK(void) picRelocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); unsigned i; pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns); pThis->pPicHlpRC = pThis->pPicHlpR3->pfnGetRCHelpers(pDevIns); for (i = 0; i < RT_ELEMENTS(pThis->aPics); i++) pThis->aPics[i].pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns); } /** * @copydoc FNPDMDEVCONSTRUCT */ static DECLCALLBACK(int) picConstruct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfgHandle) { PDEVPIC pThis = PDMINS_2_DATA(pDevIns, PDEVPIC); PDMPICREG PicReg; int rc; bool fGCEnabled; bool fR0Enabled; Assert(iInstance == 0); /* * Validate and read configuration. */ if (!CFGMR3AreValuesValid(pCfgHandle, "GCEnabled\0" "R0Enabled\0")) return VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES; rc = CFGMR3QueryBoolDef(pCfgHandle, "GCEnabled", &fGCEnabled, true); if (RT_FAILURE(rc)) return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: failed to read GCEnabled as boolean")); rc = CFGMR3QueryBoolDef(pCfgHandle, "R0Enabled", &fR0Enabled, true); if (RT_FAILURE(rc)) return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: failed to read R0Enabled as boolean")); Log(("DevPIC: fGCEnabled=%RTbool fR0Enabled=%RTbool\n", fGCEnabled, fR0Enabled)); /* * Init the data. */ Assert(RT_ELEMENTS(pThis->aPics) == 2); pThis->pDevInsR3 = pDevIns; pThis->pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns); pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns); pThis->aPics[0].elcr_mask = 0xf8; pThis->aPics[1].elcr_mask = 0xde; pThis->aPics[0].pDevInsR3 = pDevIns; pThis->aPics[1].pDevInsR3 = pDevIns; pThis->aPics[0].pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns); pThis->aPics[1].pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns); pThis->aPics[0].pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns); pThis->aPics[1].pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns); /* * Register us as the PIC with PDM. */ PicReg.u32Version = PDM_PICREG_VERSION; PicReg.pfnSetIrqR3 = picSetIrq; PicReg.pfnGetInterruptR3 = picGetInterrupt; if (fGCEnabled) { PicReg.pszSetIrqRC = "picSetIrq"; PicReg.pszGetInterruptRC = "picGetInterrupt"; } else { PicReg.pszSetIrqRC = NULL; PicReg.pszGetInterruptRC = NULL; } if (fR0Enabled) { PicReg.pszSetIrqR0 = "picSetIrq"; PicReg.pszGetInterruptR0 = "picGetInterrupt"; } else { PicReg.pszSetIrqR0 = NULL; PicReg.pszGetInterruptR0 = NULL; } Assert(pDevIns->pDevHlpR3->pfnPICRegister); rc = pDevIns->pDevHlpR3->pfnPICRegister(pDevIns, &PicReg, &pThis->pPicHlpR3); AssertLogRelMsgRCReturn(rc, ("PICRegister -> %Rrc\n", rc), rc); if (fGCEnabled) pThis->pPicHlpRC = pThis->pPicHlpR3->pfnGetRCHelpers(pDevIns); if (fR0Enabled) pThis->pPicHlpR0 = pThis->pPicHlpR3->pfnGetR0Helpers(pDevIns); /* * Register I/O ports and save state. */ rc = PDMDevHlpIOPortRegister(pDevIns, 0x20, 2, (void *)0, picIOPortWrite, picIOPortRead, NULL, NULL, "i8259 PIC #0"); if (RT_FAILURE(rc)) return rc; rc = PDMDevHlpIOPortRegister(pDevIns, 0xa0, 2, (void *)1, picIOPortWrite, picIOPortRead, NULL, NULL, "i8259 PIC #1"); if (RT_FAILURE(rc)) return rc; if (fGCEnabled) { rc = PDMDevHlpIOPortRegisterGC(pDevIns, 0x20, 2, 0, "picIOPortWrite", "picIOPortRead", NULL, NULL, "i8259 PIC #0"); if (RT_FAILURE(rc)) return rc; rc = PDMDevHlpIOPortRegisterGC(pDevIns, 0xa0, 2, 1, "picIOPortWrite", "picIOPortRead", NULL, NULL, "i8259 PIC #1"); if (RT_FAILURE(rc)) return rc; } if (fR0Enabled) { rc = PDMDevHlpIOPortRegisterR0(pDevIns, 0x20, 2, 0, "picIOPortWrite", "picIOPortRead", NULL, NULL, "i8259 PIC #0"); if (RT_FAILURE(rc)) return rc; rc = PDMDevHlpIOPortRegisterR0(pDevIns, 0xa0, 2, 1, "picIOPortWrite", "picIOPortRead", NULL, NULL, "i8259 PIC #1"); if (RT_FAILURE(rc)) return rc; } rc = PDMDevHlpIOPortRegister(pDevIns, 0x4d0, 1, &pThis->aPics[0], picIOPortElcrWrite, picIOPortElcrRead, NULL, NULL, "i8259 PIC #0 - elcr"); if (RT_FAILURE(rc)) return rc; rc = PDMDevHlpIOPortRegister(pDevIns, 0x4d1, 1, &pThis->aPics[1], picIOPortElcrWrite, picIOPortElcrRead, NULL, NULL, "i8259 PIC #1 - elcr"); if (RT_FAILURE(rc)) return rc; if (fGCEnabled) { RTRCPTR pDataRC = PDMINS_2_DATA_RCPTR(pDevIns); rc = PDMDevHlpIOPortRegisterGC(pDevIns, 0x4d0, 1, pDataRC + RT_OFFSETOF(DEVPIC, aPics[0]), "picIOPortElcrWrite", "picIOPortElcrRead", NULL, NULL, "i8259 PIC #0 - elcr"); if (RT_FAILURE(rc)) return rc; rc = PDMDevHlpIOPortRegisterGC(pDevIns, 0x4d1, 1, pDataRC + RT_OFFSETOF(DEVPIC, aPics[1]), "picIOPortElcrWrite", "picIOPortElcrRead", NULL, NULL, "i8259 PIC #1 - elcr"); if (RT_FAILURE(rc)) return rc; } if (fR0Enabled) { RTR0PTR pDataR0 = PDMINS_2_DATA_R0PTR(pDevIns); rc = PDMDevHlpIOPortRegisterR0(pDevIns, 0x4d0, 1, pDataR0 + RT_OFFSETOF(DEVPIC, aPics[0]), "picIOPortElcrWrite", "picIOPortElcrRead", NULL, NULL, "i8259 PIC #0 - elcr"); if (RT_FAILURE(rc)) return rc; rc = PDMDevHlpIOPortRegisterR0(pDevIns, 0x4d1, 1, pDataR0 + RT_OFFSETOF(DEVPIC, aPics[1]), "picIOPortElcrWrite", "picIOPortElcrRead", NULL, NULL, "i8259 PIC #1 - elcr"); if (RT_FAILURE(rc)) return rc; } rc = PDMDevHlpSSMRegister(pDevIns, pDevIns->pDevReg->szDeviceName, iInstance, 1 /* version */, sizeof(*pThis), NULL, picSaveExec, NULL, NULL, picLoadExec, NULL); if (RT_FAILURE(rc)) return rc; #ifdef DEBUG /* * Register the info item. */ PDMDevHlpDBGFInfoRegister(pDevIns, "pic", "PIC info.", picInfo); #endif /* * Initialize the device state. */ picReset(pDevIns); #ifdef VBOX_WITH_STATISTICS /* * Statistics. */ PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetIrqGC, STAMTYPE_COUNTER, "/PDM/PIC/SetIrqGC", STAMUNIT_OCCURENCES, "Number of PIC SetIrq calls in GC."); PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetIrqHC, STAMTYPE_COUNTER, "/PDM/PIC/SetIrqHC", STAMUNIT_OCCURENCES, "Number of PIC SetIrq calls in HC."); PDMDevHlpSTAMRegister(pDevIns, &pThis->StatClearedActiveIRQ2, STAMTYPE_COUNTER, "/PDM/PIC/Masked/ActiveIRQ2", STAMUNIT_OCCURENCES, "Number of cleared irq 2."); PDMDevHlpSTAMRegister(pDevIns, &pThis->StatClearedActiveMasterIRQ, STAMTYPE_COUNTER, "/PDM/PIC/Masked/ActiveMaster", STAMUNIT_OCCURENCES, "Number of cleared master irqs."); PDMDevHlpSTAMRegister(pDevIns, &pThis->StatClearedActiveSlaveIRQ, STAMTYPE_COUNTER, "/PDM/PIC/Masked/ActiveSlave", STAMUNIT_OCCURENCES, "Number of cleared slave irqs."); #endif return VINF_SUCCESS; } /** * The device registration structure. */ const PDMDEVREG g_DeviceI8259 = { /* u32Version */ PDM_DEVREG_VERSION, /* szDeviceName */ "i8259", /* szRCMod */ "VBoxDDGC.gc", /* szR0Mod */ "VBoxDDR0.r0", /* pszDescription */ "Intel 8259 Programmable Interrupt Controller (PIC) Device.", /* fFlags */ PDM_DEVREG_FLAGS_HOST_BITS_DEFAULT | PDM_DEVREG_FLAGS_GUEST_BITS_32_64 | PDM_DEVREG_FLAGS_PAE36 | PDM_DEVREG_FLAGS_RC | PDM_DEVREG_FLAGS_R0, /* fClass */ PDM_DEVREG_CLASS_PIC, /* cMaxInstances */ 1, /* cbInstance */ sizeof(DEVPIC), /* pfnConstruct */ picConstruct, /* pfnDestruct */ NULL, /* pfnRelocate */ picRelocate, /* pfnIOCtl */ NULL, /* pfnPowerOn */ NULL, /* pfnReset */ picReset, /* pfnSuspend */ NULL, /* pfnResume */ NULL, /* pfnAttach */ NULL, /* pfnDetach */ NULL, /* pfnQueryInterface. */ NULL, /* pfnInitComplete */ NULL, /* pfnPowerOff */ NULL, /* pfnSoftReset */ NULL, /* u32VersionEnd */ PDM_DEVREG_VERSION }; #endif /* IN_RING3 */ #endif /* !VBOX_DEVICE_STRUCT_TESTCASE */