DevSerial.cpp revision 33d572ca3879de5387081d027519b6da5b9a10fb
248c89033c87fed7229aa29bbbc4f4698fb13687vboxsync * VBox serial device:
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Serial communication port driver
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Copyright (C) 2006 InnoTek Systemberatung GmbH
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * available from http://www.virtualbox.org. This file is free software;
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * General Public License as published by the Free Software Foundation,
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * If you received this file as part of a commercial VirtualBox
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * distribution, then only the terms of your commercial VirtualBox
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * license agreement apply instead of the previous paragraph.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * --------------------------------------------------------------------
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * This code is based on:
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * QEMU 16450 UART emulation
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync * Copyright (c) 2003-2004 Fabrice Bellard
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Permission is hereby granted, free of charge, to any person obtaining a copy
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * of this software and associated documentation files (the "Software"), to deal
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * in the Software without restriction, including without limitation the rights
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * copies of the Software, and to permit persons to whom the Software is
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * furnished to do so, subject to the following conditions:
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync * The above copyright notice and this permission notice shall be included in
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync * all copies or substantial portions of the Software.
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync * THE SOFTWARE.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync/*******************************************************************************
c89333d3e41e439ed9e74768000edc399d3e72e6vboxsync* Header Files *
c89333d3e41e439ed9e74768000edc399d3e72e6vboxsync*******************************************************************************/
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#undef VBOX_SERIAL_PCI /* The PCI variant has lots of problems: wrong IRQ line and wrong IO base assigned. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#endif /* VBOX_SERIAL_PCI */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_LCR_DLAB 0x80 /* Divisor latch access bit */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IER_MSI 0x08 /* Enable Modem status interrupt */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IER_RLSI 0x04 /* Enable receiver line status interrupt */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IER_THRI 0x02 /* Enable Transmitter holding register int. */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IER_RDI 0x01 /* Enable receiver data interrupt */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IIR_NO_INT 0x01 /* No interrupts pending */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IIR_ID 0x06 /* Mask for the interrupt ID */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IIR_MSI 0x00 /* Modem status interrupt */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IIR_THRI 0x02 /* Transmitter holding register empty */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IIR_RDI 0x04 /* Receiver data interrupt */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_IIR_RLSI 0x06 /* Receiver line status interrupt */
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync * These are the definitions for the Modem Control Register
750df3fe104e01cadbc3d5bd20243055d283d4e5vboxsync#define UART_MCR_LOOP 0x10 /* Enable loopback test mode */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * These are the definitions for the Modem Status Register
ffb50166c9adb4ae583b914d405197035cf890advboxsync#define UART_MSR_TERI 0x04 /* Trailing edge ring indicator */
ffb50166c9adb4ae583b914d405197035cf890advboxsync#define UART_MSR_ANY_DELTA 0x0F /* Any of the delta bits! */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#define UART_LSR_THRE 0x20 /* Transmit-hold-register empty */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#define UART_LSR_BI 0x10 /* Break interrupt indicator */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#define UART_LSR_FE 0x08 /* Frame error indicator */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#define UART_LSR_PE 0x04 /* Parity error indicator */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#define UART_LSR_OE 0x02 /* Overrun error indicator */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** Access critical section. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** Pointer to the device instance. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** The base interface. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** The character port interface. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** Pointer to the attached base driver. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** Pointer to the attached character driver. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* NOTE: this hidden state is necessary for tx irq generation as
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync it can be reset while reading iir */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#endif /* VBOX_SERIAL_PCI */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** Pointer to the device instance. */
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync#define PCIDEV_2_SERIALSTATE(pPciDev) ( (SerialState *)((uintptr_t)(pPciDev) - RT_OFFSETOF(SerialState, dev)) )
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync#endif /* VBOX_SERIAL_PCI */
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync#define PDMIBASE_2_SERIALSTATE(pInstance) ( (SerialState *)((uintptr_t)(pInterface) - RT_OFFSETOF(SerialState, IBase)) )
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync#define PDMICHARPORT_2_SERIALSTATE(pInstance) ( (SerialState *)((uintptr_t)(pInterface) - RT_OFFSETOF(SerialState, ICharPort)) )
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsyncPDMBOTHCBDECL(int) serialIOPortRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb);
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsyncPDMBOTHCBDECL(int) serialIOPortWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb);
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync if ((s->lsr & UART_LSR_DR) && (s->ier & UART_IER_RDI)) {
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync } else if (s->thr_ipending && (s->ier & UART_IER_THRI)) {
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync PDMDevHlpPCISetIrqNoWait(CTXSUFF(s->pDevIns), 0, 1);
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync#else /* !VBOX_SERIAL_PCI */
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync PDMDevHlpISASetIrqNoWait(CTXSUFF(s->pDevIns), s->irq, 1);
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync#endif /* !VBOX_SERIAL_PCI */
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync PDMDevHlpPCISetIrqNoWait(CTXSUFF(s->pDevIns), 0, 0);
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync#else /* !VBOX_SERIAL_PCI */
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync PDMDevHlpISASetIrqNoWait(CTXSUFF(s->pDevIns), s->irq, 0);
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync#endif /* !VBOX_SERIAL_PCI */
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsyncstatic void serial_update_parameters(SerialState *s)
11b175175a0ed424b8e8354acda681ad0adde0f8vboxsync if (s->divider == 0)
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync Log(("speed=%d parity=%c data=%d stop=%d\n", speed, parity, data_bits, stop_bits));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncstatic int serial_ioport_write(void *opaque, uint32_t addr, uint32_t val)
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync unsigned char ch;
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync LogFlow(("serial: write addr=0x%02x val=0x%02x\n", addr, val));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** @todo implement backpressure for writing (don't set interrupt
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * bits/line until the character is actually written). This way
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * EMT wouldn't block for writes taking longer than normal. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync int rc = s->pDrvChar->pfnWrite(s->pDrvChar, &ch, 1);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncstatic uint32_t serial_ioport_read(void *opaque, uint32_t addr, int *pRC)
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /* reset THR pending bit */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* in loopback, the modem output pins are connected to the
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync LogFlow(("serial: read addr=0x%02x val=0x%02x\n", addr, ret));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncstatic DECLCALLBACK(int) serialNotifyRead(PPDMICHARPORT pInterface, const void *pvBuf, size_t *pcbRead)
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SerialState *pData = PDMICHARPORT_2_SERIALSTATE(pInterface);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync PDMCritSectEnter(&pData->CritSect, VERR_PERMISSION_DENIED);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* If a character is still in the read queue, then wait for it to be emptied. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync PDMCritSectEnter(&pData->CritSect, VERR_PERMISSION_DENIED);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#endif /* IN_RING3 */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * Port I/O Handler for OUT operations.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @returns VBox status code.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * @param pDevIns The device instance.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param pvUser User argument.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param Port Port number used for the IN operation.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param u32 The value to output.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param cb The value size in bytes.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncPDMBOTHCBDECL(int) serialIOPortWrite(PPDMDEVINS pDevIns, void *pvUser,
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SerialState *pData = PDMINS2DATA(pDevIns, SerialState *);
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync rc = PDMCritSectEnter(&pData->CritSect, VINF_IOM_HC_IOPORT_WRITE);
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync Log(("%s: port %#06x val %#04x\n", __FUNCTION__, Port, u32));
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync AssertMsgFailed(("Port=%#x cb=%d u32=%#x\n", Port, cb, u32));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Port I/O Handler for IN operations.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @returns VBox status code.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param pDevIns The device instance.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param pvUser User argument.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param Port Port number used for the IN operation.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * @param u32 The value to output.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * @param cb The value size in bytes.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncPDMBOTHCBDECL(int) serialIOPortRead(PPDMDEVINS pDevIns, void *pvUser,
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SerialState *pData = PDMINS2DATA(pDevIns, SerialState *);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = PDMCritSectEnter(&pData->CritSect, VINF_IOM_HC_IOPORT_READ);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync Log(("%s: port %#06x val %#04x\n", __FUNCTION__, Port, *pu32));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Saves a state of the serial port device.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @returns VBox status code.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param pDevIns The device instance.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param pSSMHandle The handle to save the state to.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsyncstatic DECLCALLBACK(int) serialSaveExec(PPDMDEVINS pDevIns,
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync SerialState *pData = PDMINS2DATA(pDevIns, SerialState *);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync return SSMR3PutU32(pSSMHandle, ~0); /* sanity/terminator */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * Loads a saved serial port device state.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * @returns VBox status code.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param pDevIns The device instance.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * @param pSSMHandle The handle to the saved state.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * @param u32Version The data unit version number.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsyncstatic DECLCALLBACK(int) serialLoadExec(PPDMDEVINS pDevIns,
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SerialState *pData = PDMINS2DATA(pDevIns, SerialState *);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SSMR3GetS32(pSSMHandle, &pData->last_break_enable);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync if (u32 != ~0U)
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* Be careful with pointers in the structure; they are not preserved
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * in the saved state. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @copydoc FNPDMDEVRELOCATE
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncstatic DECLCALLBACK(void) serialRelocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta)
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SerialState *pData = PDMINS2DATA(pDevIns, SerialState *);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncstatic DECLCALLBACK(int) serialIOPortRegionMap(PPCIDEVICE pPciDev, /* unsigned */ int iRegion, RTGCPHYS GCPhysAddress, uint32_t cb, PCIADDRESSSPACE enmType)
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SerialState *pData = PCIDEV_2_SERIALSTATE(pPciDev);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync AssertMsg(RT_ALIGN(GCPhysAddress, 8) == GCPhysAddress, ("Expected 8 byte alignment. GCPhysAddress=%#x\n", GCPhysAddress));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync LogRel(("Serial#%d: mapping I/O at %#06x\n", pData->pDevIns->iInstance, pData->base));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Register our port IO handlers.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = PDMDevHlpIOPortRegister(pPciDev->pDevIns, (RTIOPORT)GCPhysAddress, 8, (void *)pData,
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync serial_io_write, serial_io_read, NULL, NULL, "SERIAL");
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#endif /* VBOX_SERIAL_PCI */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync/** @copyfrom PIBASE::pfnqueryInterface */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncstatic DECLCALLBACK(void *) serialQueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SerialState *pData = PDMIBASE_2_SERIALSTATE(pInterface);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Destruct a device instance.
c99b597540585068d22dde4c9f74730305f24097vboxsync * Most VM resources are freed by the VM. This callback is provided so that any non-VM
c99b597540585068d22dde4c9f74730305f24097vboxsync * resources can be freed correctly.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @returns VBox status.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param pDevIns The device instance data.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncstatic DECLCALLBACK(int) serialDestruct(PPDMDEVINS pDevIns)
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync SerialState *pData = PDMINS2DATA(pDevIns, SerialState *);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Construct a device instance for a VM.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @returns VBox status.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param pDevIns The device instance data.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * If the registration structure is needed, pDevIns->pDevReg points to it.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * @param iInstance Instance number. Use this to figure out which registers and such to use.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * The device number is also found in pDevIns->iInstance, but since it's
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * likely to be freqently used PDM passes it as parameter.
c99b597540585068d22dde4c9f74730305f24097vboxsync * @param pCfgHandle Configuration node handle for the device. Use this to obtain the configuration
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * of the device instance. It's also found in pDevIns->pCfgHandle, but like
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * iInstance it's expected to be used a bit in this function.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsyncstatic DECLCALLBACK(int) serialConstruct(PPDMDEVINS pDevIns,
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync SerialState *pData = PDMINS2DATA(pDevIns, SerialState*);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Validate configuration.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync if (!CFGMR3AreValuesValid(pCfgHandle, "IRQ\0IOBase\0"))
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = CFGMR3QueryBool(pCfgHandle, "GCEnabled", &pData->fGCEnabled);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync N_("Configuration error: Failed to get the \"GCEnabled\" value"));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = CFGMR3QueryBool(pCfgHandle, "R0Enabled", &pData->fR0Enabled);
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync N_("Configuration error: Failed to get the \"R0Enabled\" value"));
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /* IBase */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync pData->IBase.pfnQueryInterface = serialQueryInterface;
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /* ICharPort */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * Initialize critical section.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * This must of course be done before attaching drivers or anything else which can call us back..
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync RTStrPrintf(szName, sizeof(szName), "Serial#%d", iInstance);
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync rc = PDMDevHlpCritSectInit(pDevIns, &pData->CritSect, szName);
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync/** @todo r=bird: Check for VERR_CFGM_VALUE_NOT_FOUND and provide sensible defaults.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * Also do AssertMsgFailed(("Configuration error:....)) in the failure cases of CFGMR3Query*()
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * and CFGR3AreValuesValid() like we're doing in the other devices. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = CFGMR3QueryU16 (pCfgHandle, "IOBase", &io_base);
b8bb9c9f6b8ebfd0a7d6df0c0289f9fe80241750vboxsync Log(("serialConstruct instance %d iobase=%04x irq=%d\n", iInstance, io_base, irq_lvl));
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync pData->msr = UART_MSR_DCD | UART_MSR_DSR | UART_MSR_CTS;
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync pData->dev.config[0x09] = 0x01; /* Programming interface: 16450 */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync pData->dev.config[0x0a] = 0x00; /* Subclass: Serial controller */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync pData->dev.config[0x0b] = 0x07; /* Class: Communication controller */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync pData->dev.config[0x0e] = 0x00; /* Header type: standard */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync pData->dev.config[0x3c] = irq_lvl; /* preconfigure IRQ number (0 = autoconfig)*/
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * Register the PCI I/O ports.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = PDMDevHlpPCIIORegionRegister(pDevIns, 0, 8, PCI_ADDRESS_SPACE_IO, serialIOPortRegionMap);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#else /* !VBOX_SERIAL_PCI */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = PDMDevHlpIOPortRegister(pDevIns, io_base, 8, 0,
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = PDMDevHlpIOPortRegisterGC(pDevIns, io_base, 8, 0, "serialIOPortWrite",
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync rc = PDMDevHlpIOPortRegisterR0(pDevIns, io_base, 8, 0, "serialIOPortWrite",
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync#endif /* !VBOX_SERIAL_PCI */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* Attach the char driver and get the interfaces. For now no run-time
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * changes are supported. */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync rc = PDMDevHlpDriverAttach(pDevIns, 0, &pData->IBase, &pData->pDrvBase, "Serial Char");
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync pData->pDrvChar = (PDMICHAR *)pData->pDrvBase->pfnQueryInterface(pData->pDrvBase, PDMINTERFACE_CHAR);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync AssertMsgFailed(("Configuration error: instance %d has no char interface!\n", iInstance));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /** @todo provide read notification interface!!!! */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync AssertMsgFailed(("Serial%d: Failed to attach to char driver. rc=%Vrc\n", iInstance, rc));
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync N_("Serial device %d cannot attach to char driver\n"), iInstance);
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync * The device registration structure.
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* u32Version */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* szDeviceName */
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync /* szGCMod */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync "VBoxDDGC.gc",
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* szR0Mod */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync "VBoxDDR0.r0",
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pszDescription */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync "Serial Communication Port",
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* fFlags */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync PDM_DEVREG_FLAGS_HOST_BITS_DEFAULT | PDM_DEVREG_FLAGS_GUEST_BITS_DEFAULT | PDM_DEVREG_FLAGS_GC | PDM_DEVREG_FLAGS_R0,
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* fClass */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* cMaxInstances */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* cbInstance */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnConstruct */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnDestruct */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnRelocate */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnIOCtl */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnPowerOn */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnReset */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnSuspend */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnResume */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnAttach */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnDetach */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync /* pfnQueryInterface. */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#endif /* IN_RING3 */
553a2f0d8ef91a6dad8de4eef206ff093af53a5dvboxsync#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */