a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * VBox storage drivers: Virtual SCSI driver
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2012 Oracle Corporation
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * available from http://www.virtualbox.org. This file is free software;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * General Public License (GPL) as published by the Free Software
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsync * The contents of this file may alternatively be used under the terms
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsync * of the Common Development and Distribution License Version 1.0
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsync * VirtualBox OSE distribution, in which case the provisions of the
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsync * CDDL are applicable instead of those of the GPL.
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsync * You may elect to license modified versions of this file under the
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsync * terms and conditions of either the GPL or the CDDL or both.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync# error "There are no VBox VSCSI APIs available in Ring-0 Host Context!"
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A virtual SCSI device handle */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A pointer to a virtual SCSI device handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A virtual SCSI LUN handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A pointer to a virtual SCSI LUN handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A virtual SCSI request handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A pointer to a virtual SCSI request handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A SCSI I/O request handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A pointer to a SCSI I/O request handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Virtual SCSI I/O request transfer direction.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Invalid direction */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Read */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Write */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Flush */
65697a26b524640b83828b715160c798c43a0424vboxsync /** Unmap */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** 32bit hack */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** Pointer to a SCSI LUN type */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * LUN types we support
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Invalid type */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Hard disk (SBC) */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** CD/DVD drive (MMC) */
8bdd3b77c61cfb4b0cb447f44b293f3a6624482cvboxsync /** Tape drive (SSC) */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Last value to indicate an invalid device */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** 32bit hack */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** Pointer to a SCSI LUN type */
65697a26b524640b83828b715160c798c43a0424vboxsync/** The LUN can handle the UNMAP command. */
65697a26b524640b83828b715160c798c43a0424vboxsync/** The LUN has a non rotational medium. */
6f76f373e9274aa29ec1485be3bfebafb670af0evboxsync/** The medium of the LUN is readonly. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Virtual SCSI LUN I/O Callback table.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Retrieve the size of the underlying medium.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiLun Virtual SCSI LUN handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pvScsiLunUser Opaque user data which may
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * be used to identify the medium.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pcbSize Where to store the size of the
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync DECLR3CALLBACKMEMBER(int, pfnVScsiLunMediumGetSize, (VSCSILUN hVScsiLun,
0b25f7d6154d525150acd6f23b6d1164c0b4f5aavboxsync * Retrieve the sector size of the underlying medium.
0b25f7d6154d525150acd6f23b6d1164c0b4f5aavboxsync * @returns VBox status status code.
0b25f7d6154d525150acd6f23b6d1164c0b4f5aavboxsync * @param hVScsiLun Virtual SCSI LUN handle.
0b25f7d6154d525150acd6f23b6d1164c0b4f5aavboxsync * @param pvScsiLunUser Opaque user data which may
0b25f7d6154d525150acd6f23b6d1164c0b4f5aavboxsync * be used to identify the medium.
0b25f7d6154d525150acd6f23b6d1164c0b4f5aavboxsync * @param pcbSectorSize Where to store the sector size of the
0b25f7d6154d525150acd6f23b6d1164c0b4f5aavboxsync DECLR3CALLBACKMEMBER(int, pfnVScsiLunMediumGetSectorSize, (VSCSILUN hVScsiLun,
62554cc79413e9831544784107fa348805cdb7ccvboxsync * Set the lock state of the underlying medium.
62554cc79413e9831544784107fa348805cdb7ccvboxsync * @returns VBox status status code.
62554cc79413e9831544784107fa348805cdb7ccvboxsync * @param hVScsiLun Virtual SCSI LUN handle.
62554cc79413e9831544784107fa348805cdb7ccvboxsync * @param pvScsiLunUser Opaque user data which may
62554cc79413e9831544784107fa348805cdb7ccvboxsync * be used to identify the medium.
62554cc79413e9831544784107fa348805cdb7ccvboxsync * @param fLocked New lock state (locked/unlocked).
62554cc79413e9831544784107fa348805cdb7ccvboxsync DECLR3CALLBACKMEMBER(int, pfnVScsiLunMediumSetLock, (VSCSILUN hVScsiLun,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Enqueue a read or write request from the medium.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiLun Virtual SCSI LUN handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pvScsiLunUser Opaque user data which may
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * be used to identify the medium.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiIoReq Virtual SCSI I/O request handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync DECLR3CALLBACKMEMBER(int, pfnVScsiLunReqTransferEnqueue, (VSCSILUN hVScsiLun,
65697a26b524640b83828b715160c798c43a0424vboxsync * Returns flags of supported features.
65697a26b524640b83828b715160c798c43a0424vboxsync * @returns VBox status status code.
65697a26b524640b83828b715160c798c43a0424vboxsync * @param hVScsiLun Virtual SCSI LUN handle.
65697a26b524640b83828b715160c798c43a0424vboxsync * @param pvScsiLunUser Opaque user data which may
65697a26b524640b83828b715160c798c43a0424vboxsync * be used to identify the medium.
65697a26b524640b83828b715160c798c43a0424vboxsync * @param hVScsiIoReq Virtual SCSI I/O request handle.
65697a26b524640b83828b715160c798c43a0424vboxsync DECLR3CALLBACKMEMBER(int, pfnVScsiLunGetFeatureFlags, (VSCSILUN hVScsiLun,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** Pointer to a virtual SCSI LUN I/O callback table. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * The virtual SCSI request completed callback.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef DECLCALLBACK(void) FNVSCSIREQCOMPLETED(VSCSIDEVICE hVScsiDevice,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** Pointer to a virtual SCSI request completed callback. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Create a new empty SCSI device instance.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param phVScsiDevice Where to store the SCSI device handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pfnVScsiReqCompleted The method call after a request completed.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pvVScsiDeviceUser Opaque user data given in the completion callback.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceCreate(PVSCSIDEVICE phVScsiDevice,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Destroy a SCSI device instance.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hScsiDevice The SCSI device handle to destroy.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceDestroy(VSCSIDEVICE hVScsiDevice);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Attach a LUN to the SCSI device.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hScsiDevice The SCSI device handle to add the LUN to.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hScsiLun The LUN handle to add.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param iLun The LUN number.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceLunAttach(VSCSIDEVICE hVScsiDevice, VSCSILUN hVScsiLun, uint32_t iLun);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Detach a LUN from the SCSI device.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiDevice The SCSI device handle to add the LUN to.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param iLun The LUN number to remove.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param phVScsiLun Where to store the detached LUN handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceLunDetach(VSCSIDEVICE hVScsiDevice, uint32_t iLun,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Return the SCSI LUN handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiDevice The SCSI device handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param iLun The LUN number to get.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param phVScsiLun Where to store the LUN handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceLunGet(VSCSIDEVICE hVScsiDevice, uint32_t iLun,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Enqueue a request to the SCSI device.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiDevice The SCSI device handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiReq The SCSI request handle to enqueue.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceReqEnqueue(VSCSIDEVICE hVScsiDevice, VSCSIREQ hVScsiReq);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Allocate a new request handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param phVScsiDevice The SCSI device handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param phVScsiReq Where to SCSI request handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param iLun The LUN the request is for.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pbCDB The CDB for the request.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param cbCDB The size of the CDB in bytes.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param cbSGList Number of bytes the S/G list describes.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param cSGListEntries Number of S/G list entries.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param paSGList Pointer to the S/G list.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pbSense Pointer to the sense buffer.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param cbSense Size of the sense buffer.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pvVScsiReqUser Opqaue user data returned when the request completes.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceReqCreate(VSCSIDEVICE hVScsiDevice, PVSCSIREQ phVScsiReq,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Create a new LUN.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param phVScsiLun Where to store the SCSI LUN handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param enmLunType The Lun type.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pVScsiLunIoCallbacks Pointer to the I/O callbacks to use for his LUN.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pvVScsiLunUser Opaque user argument which
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * is returned in the pvScsiLunUser parameter
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * when the request completion callback is called.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSILunCreate(PVSCSILUN phVScsiLun, VSCSILUNTYPE enmLunType,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Destroy virtual SCSI LUN.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * @param hVScsiLun The virtual SCSI LUN handle to destroy.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSILunDestroy(VSCSILUN hVScsiLun);
5cece736b63cc917f3781c8c7e46fd3ea98c4e20vboxsync * Notify virtual SCSI LUN of medium being mounted.
5cece736b63cc917f3781c8c7e46fd3ea98c4e20vboxsync * @returns VBox status code.
5cece736b63cc917f3781c8c7e46fd3ea98c4e20vboxsync * @param hVScsiLun The virtual SCSI LUN handle to destroy.
5cece736b63cc917f3781c8c7e46fd3ea98c4e20vboxsyncVBOXDDU_DECL(int) VSCSILunMountNotify(VSCSILUN hVScsiLun);
5cece736b63cc917f3781c8c7e46fd3ea98c4e20vboxsync * Notify virtual SCSI LUN of medium being unmounted.
5cece736b63cc917f3781c8c7e46fd3ea98c4e20vboxsync * @returns VBox status code.
5cece736b63cc917f3781c8c7e46fd3ea98c4e20vboxsync * @param hVScsiLun The virtual SCSI LUN handle to destroy.
5cece736b63cc917f3781c8c7e46fd3ea98c4e20vboxsyncVBOXDDU_DECL(int) VSCSILunUnmountNotify(VSCSILUN hVScsiLun);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Notify a that a I/O request completed.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiIoReq The I/O request handle that completed.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * This is given when a I/O callback for
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * the LUN is called by the virtual SCSI layer.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param rcIoReq The status code the I/O request completed with.
96a7e06717e2d7398642eadb5ebab1bf13fbe2dbvboxsync * @param fRedoPossible Flag whether it is possible to redo the request.
96a7e06717e2d7398642eadb5ebab1bf13fbe2dbvboxsync * If true setting any sense code will be omitted
96a7e06717e2d7398642eadb5ebab1bf13fbe2dbvboxsync * in case of an error to not alter the device state.
96a7e06717e2d7398642eadb5ebab1bf13fbe2dbvboxsyncVBOXDDU_DECL(int) VSCSIIoReqCompleted(VSCSIIOREQ hVScsiIoReq, int rcIoReq, bool fRedoPossible);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Query the transfer direction of the I/O request.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns Transfer direction.of the given I/O request
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiIoReq The SCSI I/O request handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(VSCSIIOREQTXDIR) VSCSIIoReqTxDirGet(VSCSIIOREQ hVScsiIoReq);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Query I/O parameters.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiIoReq The SCSI I/O request handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param puOffset Where to store the start offset.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pcbTransfer Where to store the amount of bytes to transfer.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pcSeg Where to store the number of segments in the S/G list.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param pcbSeg Where to store the number of bytes the S/G list describes.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param ppaSeg Where to store the pointer to the S/G list.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIIoReqParamsGet(VSCSIIOREQ hVScsiIoReq, uint64_t *puOffset,
65697a26b524640b83828b715160c798c43a0424vboxsync * Query unmap parameters.
65697a26b524640b83828b715160c798c43a0424vboxsync * @returns VBox status code.
65697a26b524640b83828b715160c798c43a0424vboxsync * @param hVScsiIoReq The SCSI I/O request handle.
65697a26b524640b83828b715160c798c43a0424vboxsync * @param ppaRanges Where to store the pointer to the range array on success.
65697a26b524640b83828b715160c798c43a0424vboxsync * @param pcRanges Where to store the number of ranges on success.
f4aad55f8addd816ef005845842a2418bbdc3ea2vboxsyncVBOXDDU_DECL(int) VSCSIIoReqUnmapParamsGet(VSCSIIOREQ hVScsiIoReq, PCRTRANGE *ppaRanges,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync#endif /* ___VBox_vscsi_h */