vscsi.h revision 6f76f373e9274aa29ec1485be3bfebafb670af0e
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/* $Id$ */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** @file
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * VBox storage drivers: Virtual SCSI driver
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/*
65697a26b524640b83828b715160c798c43a0424vboxsync * Copyright (C) 2006-2011 Oracle Corporation
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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 *
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 */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync#ifndef ___VBox_vscsi_h
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync#define ___VBox_vscsi_h
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync#include <VBox/cdefs.h>
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync#include <VBox/types.h>
a9f41cb889f53e8407561a6155052c441eb0fc5fvboxsync#include <iprt/sg.h>
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncRT_C_DECLS_BEGIN
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync#ifdef IN_RING0
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync# error "There are no VBox VSCSI APIs available in Ring-0 Host Context!"
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync#endif
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A virtual SCSI device handle */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef struct VSCSIDEVICEINT *VSCSIDEVICE;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A pointer to a virtual SCSI device handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef VSCSIDEVICE *PVSCSIDEVICE;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A virtual SCSI LUN handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef struct VSCSILUNINT *VSCSILUN;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A pointer to a virtual SCSI LUN handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef VSCSILUN *PVSCSILUN;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A virtual SCSI request handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef struct VSCSIREQINT *VSCSIREQ;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A pointer to a virtual SCSI request handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef VSCSIREQ *PVSCSIREQ;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A SCSI I/O request handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef struct VSCSIIOREQINT *VSCSIIOREQ;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** A pointer to a SCSI I/O request handle. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef VSCSIIOREQ *PVSCSIIOREQ;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Virtual SCSI I/O request transfer direction.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef enum VSCSIIOREQTXDIR
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync{
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Invalid direction */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSIIOREQTXDIR_INVALID = 0,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Read */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSIIOREQTXDIR_READ,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Write */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSIIOREQTXDIR_WRITE,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Flush */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSIIOREQTXDIR_FLUSH,
65697a26b524640b83828b715160c798c43a0424vboxsync /** Unmap */
65697a26b524640b83828b715160c798c43a0424vboxsync VSCSIIOREQTXDIR_UNMAP,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** 32bit hack */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSIIOREQTXDIR_32BIT_HACK = 0x7fffffff
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync} VSCSIIOREQTXDIR;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** Pointer to a SCSI LUN type */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef VSCSIIOREQTXDIR *PVSCSIIOREQTXDIR;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * LUN types we support
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef enum VSCSILUNTYPE
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync{
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Invalid type */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSILUNTYPE_INVALID = 0,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Hard disk (SBC) */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSILUNTYPE_SBC,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** CD/DVD drive (MMC) */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSILUNTYPE_MMC,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** Last value to indicate an invalid device */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSILUNTYPE_LAST,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /** 32bit hack */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSILUNTYPE_32BIT_HACK = 0x7fffffff
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync} VSCSILUNTYPE;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** Pointer to a SCSI LUN type */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef VSCSILUNTYPE *PVSCSILUNTYPE;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
65697a26b524640b83828b715160c798c43a0424vboxsync/** The LUN can handle the UNMAP command. */
65697a26b524640b83828b715160c798c43a0424vboxsync#define VSCSI_LUN_FEATURE_UNMAP RT_BIT(0)
65697a26b524640b83828b715160c798c43a0424vboxsync/** The LUN has a non rotational medium. */
65697a26b524640b83828b715160c798c43a0424vboxsync#define VSCSI_LUN_FEATURE_NON_ROTATIONAL RT_BIT(1)
6f76f373e9274aa29ec1485be3bfebafb670af0evboxsync/** The medium of the LUN is readonly. */
6f76f373e9274aa29ec1485be3bfebafb670af0evboxsync#define VSCSI_LUN_FEATURE_READONLY RT_BIT(2)
65697a26b524640b83828b715160c798c43a0424vboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Virtual SCSI LUN I/O Callback table.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef struct VSCSILUNIOCALLBACKS
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync{
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Retrieve the size of the underlying medium.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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 * medium.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync DECLR3CALLBACKMEMBER(int, pfnVScsiLunMediumGetSize, (VSCSILUN hVScsiLun,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync void *pvScsiLunUser,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync uint64_t *pcbSize));
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync /**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Enqueue a read or write request from the medium.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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 */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync DECLR3CALLBACKMEMBER(int, pfnVScsiLunReqTransferEnqueue, (VSCSILUN hVScsiLun,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync void *pvScsiLunUser,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync VSCSIIOREQ hVScsiIoReq));
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
65697a26b524640b83828b715160c798c43a0424vboxsync /**
65697a26b524640b83828b715160c798c43a0424vboxsync * Returns flags of supported features.
65697a26b524640b83828b715160c798c43a0424vboxsync *
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 */
65697a26b524640b83828b715160c798c43a0424vboxsync DECLR3CALLBACKMEMBER(int, pfnVScsiLunGetFeatureFlags, (VSCSILUN hVScsiLun,
65697a26b524640b83828b715160c798c43a0424vboxsync void *pvScsiLunUser,
65697a26b524640b83828b715160c798c43a0424vboxsync uint64_t *pfFeatures));
65697a26b524640b83828b715160c798c43a0424vboxsync
65697a26b524640b83828b715160c798c43a0424vboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync} VSCSILUNIOCALLBACKS;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** Pointer to a virtual SCSI LUN I/O callback table. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef VSCSILUNIOCALLBACKS *PVSCSILUNIOCALLBACKS;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * The virtual SCSI request completed callback.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef DECLCALLBACK(void) FNVSCSIREQCOMPLETED(VSCSIDEVICE hVScsiDevice,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync void *pvVScsiDeviceUser,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync void *pvVScsiReqUser,
96a7e06717e2d7398642eadb5ebab1bf13fbe2dbvboxsync int rcScsiCode,
96a7e06717e2d7398642eadb5ebab1bf13fbe2dbvboxsync bool fRedoPossible,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync int rcReq);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/** Pointer to a virtual SCSI request completed callback. */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsynctypedef FNVSCSIREQCOMPLETED *PFNVSCSIREQCOMPLETED;
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Create a new empty SCSI device instance.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceCreate(PVSCSIDEVICE phVScsiDevice,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync PFNVSCSIREQCOMPLETED pfnVScsiReqCompleted,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync void *pvVScsiDeviceUser);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Destroy a SCSI device instance.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hScsiDevice The SCSI device handle to destroy.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceDestroy(VSCSIDEVICE hVScsiDevice);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Attach a LUN to the SCSI device.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceLunAttach(VSCSIDEVICE hVScsiDevice, VSCSILUN hVScsiLun, uint32_t iLun);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Detach a LUN from the SCSI device.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceLunDetach(VSCSIDEVICE hVScsiDevice, uint32_t iLun,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync PVSCSILUN phVScsiLun);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Return the SCSI LUN handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceLunGet(VSCSIDEVICE hVScsiDevice, uint32_t iLun,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync PVSCSILUN phVScsiLun);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Enqueue a request to the SCSI device.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiDevice The SCSI device handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiReq The SCSI request handle to enqueue.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceReqEnqueue(VSCSIDEVICE hVScsiDevice, VSCSIREQ hVScsiReq);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Allocate a new request handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIDeviceReqCreate(VSCSIDEVICE hVScsiDevice, PVSCSIREQ phVScsiReq,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync uint32_t iLun, uint8_t *pbCDB, size_t cbCDB,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync size_t cbSGList, unsigned cSGListEntries,
a9f41cb889f53e8407561a6155052c441eb0fc5fvboxsync PCRTSGSEG paSGList, uint8_t *pbSense,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync size_t cbSense, void *pvVScsiReqUser);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Create a new LUN.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSILunCreate(PVSCSILUN phVScsiLun, VSCSILUNTYPE enmLunType,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync PVSCSILUNIOCALLBACKS pVScsiLunIoCallbacks,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync void *pvVScsiLunUser);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Destroy virtual SCSI LUN.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns VBox status code.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * @param hVScsiLun The virtual SCSI LUN handle to destroy.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSILunDestroy(VSCSILUN hVScsiLun);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Notify a that a I/O request completed.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
96a7e06717e2d7398642eadb5ebab1bf13fbe2dbvboxsyncVBOXDDU_DECL(int) VSCSIIoReqCompleted(VSCSIIOREQ hVScsiIoReq, int rcIoReq, bool fRedoPossible);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Query the transfer direction of the I/O request.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @returns Transfer direction.of the given I/O request
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * @param hVScsiIoReq The SCSI I/O request handle.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(VSCSIIOREQTXDIR) VSCSIIoReqTxDirGet(VSCSIIOREQ hVScsiIoReq);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync/**
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync * Query I/O parameters.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync *
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.
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncVBOXDDU_DECL(int) VSCSIIoReqParamsGet(VSCSIIOREQ hVScsiIoReq, uint64_t *puOffset,
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync size_t *pcbTransfer, unsigned *pcSeg,
a9f41cb889f53e8407561a6155052c441eb0fc5fvboxsync size_t *pcbSeg, PCRTSGSEG *ppaSeg);
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
65697a26b524640b83828b715160c798c43a0424vboxsync/**
65697a26b524640b83828b715160c798c43a0424vboxsync * Query unmap parameters.
65697a26b524640b83828b715160c798c43a0424vboxsync *
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.
65697a26b524640b83828b715160c798c43a0424vboxsync */
f4aad55f8addd816ef005845842a2418bbdc3ea2vboxsyncVBOXDDU_DECL(int) VSCSIIoReqUnmapParamsGet(VSCSIIOREQ hVScsiIoReq, PCRTRANGE *ppaRanges,
65697a26b524640b83828b715160c798c43a0424vboxsync unsigned *pcRanges);
65697a26b524640b83828b715160c798c43a0424vboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsyncRT_C_DECLS_END
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync#endif /* ___VBox_vscsi_h */
a4ba1fc5788b1fb4c078587d5f55936e1b83098dvboxsync