VBoxSCSI.cpp revision 8b90eb0585fa16024709ca374c69f1eb5d5a5a7c
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * VBox storage devices:
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Simple SCSI interface for BIOS access
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Copyright (C) 2006-2009 Sun Microsystems, Inc.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * available from http://www.virtualbox.org. This file is free software;
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * you can redistribute it and/or modify it under the terms of the GNU
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * General Public License (GPL) as published by the Free Software
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * additional information or have any questions.
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync/*******************************************************************************
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync* Header Files *
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync*******************************************************************************/
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync//#define DEBUG
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync#define LOG_GROUP LOG_GROUP_DEV_BUSLOGIC /* @todo: Create extra group. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Initializes the state for the SCSI interface.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @returns VBox status code.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pVBoxSCSI Pointer to the unitialized SCSI state.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync memset(pVBoxSCSI->aCDB, 0, sizeof(pVBoxSCSI->aCDB));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Reads a register value.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @returns VBox status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pVBoxSCSI Pointer to the SCSI state.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param iRegister Index of the register to read.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pu32Value Where to store the content of the register.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncint vboxscsiReadRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint32_t *pu32Value)
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /* There is an I/O operation in progress.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Yield the execution thread to let the I/O thread make progress.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** The guest read the last byte from the data in buffer.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Clear everything and reset command buffer.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync memset(pVBoxSCSI->aCDB, 0, sizeof(pVBoxSCSI->aCDB));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync AssertMsgFailed(("Invalid register to read from %u\n", iRegister));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Writes to a register.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @returns VBox status code.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * VERR_MORE_DATA if a command is ready to be sent to the SCSI driver.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pVBoxSCSI Pointer to the SCSI state.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param iRegister Index of the register to write to.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param uVal Value to write.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncint vboxscsiWriteRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint8_t uVal)
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync if (pVBoxSCSI->enmState == VBOXSCSISTATE_NO_COMMAND)
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_TXDIR)
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_CDB_SIZE)
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync pVBoxSCSI->enmState = VBOXSCSISTATE_READ_BUFFER_SIZE_LOW;
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_BUFFER_SIZE_LOW)
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync pVBoxSCSI->enmState = VBOXSCSISTATE_READ_BUFFER_SIZE_HIGH;
044af0d1e6474076366759db86f101778c5f20ccvboxsync else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_BUFFER_SIZE_HIGH)
044af0d1e6474076366759db86f101778c5f20ccvboxsync else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_COMMAND)
044af0d1e6474076366759db86f101778c5f20ccvboxsync /* Check if we have all neccessary command data. */
044af0d1e6474076366759db86f101778c5f20ccvboxsync Log(("%s: Command ready for processing\n", __FUNCTION__));
044af0d1e6474076366759db86f101778c5f20ccvboxsync /* This is a write allocate buffer. */
044af0d1e6474076366759db86f101778c5f20ccvboxsync pVBoxSCSI->pBuf = (uint8_t *)RTMemAllocZ(pVBoxSCSI->cbBuf);
044af0d1e6474076366759db86f101778c5f20ccvboxsync /* This is a read from the device. */
044af0d1e6474076366759db86f101778c5f20ccvboxsync rc = VERR_MORE_DATA; /** @todo Better return value to indicate ready command? */
044af0d1e6474076366759db86f101778c5f20ccvboxsync AssertMsgFailed(("Invalid state %d\n", pVBoxSCSI->enmState));
044af0d1e6474076366759db86f101778c5f20ccvboxsync AssertMsg(pVBoxSCSI->enmState == VBOXSCSISTATE_COMMAND_READY, ("Invalid state\n"));
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync AssertMsgFailed(("Invalid register to write to %u\n", iRegister));
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Sets up a SCSI request which the owning SCSI device can process.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns VBox status code.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * @param pVBoxSCSI Pointer to the SCSI state.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param pScsiRequest Pointer to a scsi request to setup.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param puTargetDevice Where to store the target device ID.
044af0d1e6474076366759db86f101778c5f20ccvboxsyncint vboxscsiSetupRequest(PVBOXSCSI pVBoxSCSI, PPDMSCSIREQUEST pScsiRequest, uint32_t *puTargetDevice)
044af0d1e6474076366759db86f101778c5f20ccvboxsync LogFlowFunc(("pVBoxSCSI=%#p pScsiRequest=%#p puTargetDevice=%#p\n", pVBoxSCSI, pScsiRequest, puTargetDevice));
044af0d1e6474076366759db86f101778c5f20ccvboxsync AssertMsg(pVBoxSCSI->enmState == VBOXSCSISTATE_COMMAND_READY, ("Invalid state %u\n", pVBoxSCSI->enmState));
044af0d1e6474076366759db86f101778c5f20ccvboxsync if (pVBoxSCSI->uTxDir == VBOXSCSI_TXDIR_FROM_DEVICE)
044af0d1e6474076366759db86f101778c5f20ccvboxsync pVBoxSCSI->pBuf = (uint8_t *)RTMemAllocZ(pVBoxSCSI->cbBuf);
044af0d1e6474076366759db86f101778c5f20ccvboxsync /** Allocate scatter gather element. */
044af0d1e6474076366759db86f101778c5f20ccvboxsync pScsiRequest->paScatterGatherHead = (PPDMDATASEG)RTMemAllocZ(sizeof(PDMDATASEG) * 1); /* Only one element. */
044af0d1e6474076366759db86f101778c5f20ccvboxsync /** Allocate sense buffer. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync pScsiRequest->pbSenseBuffer = (uint8_t *)RTMemAllocZ(pScsiRequest->cbSenseBuffer);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync pScsiRequest->paScatterGatherHead[0].cbSeg = pVBoxSCSI->cbBuf;
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync pScsiRequest->paScatterGatherHead[0].pvSeg = pVBoxSCSI->pBuf;
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Notifies the device that a request finished and the incoming data
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * is ready at the incoming data port.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncint vboxscsiRequestFinished(PVBOXSCSI pVBoxSCSI, PPDMSCSIREQUEST pScsiRequest)
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync LogFlowFunc(("pVBoxSCSI=%#p pScsiRequest=%#p\n", pVBoxSCSI, pScsiRequest));
044af0d1e6474076366759db86f101778c5f20ccvboxsync memset(pVBoxSCSI->aCDB, 0, sizeof(pVBoxSCSI->aCDB));
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsyncint vboxscsiReadString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync RTGCPTR *pGCPtrDst, PRTGCUINTREG pcTransfer, unsigned cb)
044af0d1e6474076366759db86f101778c5f20ccvboxsync LogFlowFunc(("pDevIns=%#p pVBoxSCSI=%#p iRegister=%d cTransfer=%u cb=%u\n",
044af0d1e6474076366759db86f101778c5f20ccvboxsync /* Read string only valid for data in register. */
044af0d1e6474076366759db86f101778c5f20ccvboxsync AssertMsg(iRegister == 1, ("Hey only register 1 can be read from with string\n"));
044af0d1e6474076366759db86f101778c5f20ccvboxsync int rc = PGMPhysSimpleDirtyWriteGCPtr(PDMDevHlpGetVMCPU(pDevIns), GCDst, pVBoxSCSI->pBuf, cbTransfer);
044af0d1e6474076366759db86f101778c5f20ccvboxsync *pGCPtrDst = (RTGCPTR)((RTGCUINTPTR)GCDst + cbTransfer);
044af0d1e6474076366759db86f101778c5f20ccvboxsync memset(pVBoxSCSI->aCDB, 0, sizeof(pVBoxSCSI->aCDB));
044af0d1e6474076366759db86f101778c5f20ccvboxsyncint vboxscsiWriteString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
044af0d1e6474076366759db86f101778c5f20ccvboxsync RTGCPTR *pGCPtrSrc, PRTGCUINTREG pcTransfer, unsigned cb)
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /* Read string only valid for data in register. */
044af0d1e6474076366759db86f101778c5f20ccvboxsync AssertMsg(iRegister == 1, ("Hey only register 1 can be read from with string\n"));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync AssertMsg(cbTransfer == 512, ("Only 512 byte transfers are allowed\n"));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync int rc = PDMDevHlpPhysReadGCVirt(pDevIns, pVBoxSCSI->pBuf, GCSrc, cbTransfer);