VirtualBox

source: vbox/trunk/include/VBox/vscsi.h@ 68920

Last change on this file since 68920 was 66955, checked in by vboxsync, 8 years ago

Devices/Storage/DrvSCSI,VSCSI: Support CD/DVD images with multiple tracks like for DevATA to bring the AHCI and SCSI controllers up to the same feature level
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.3 KB
Line 
1/* $Id: vscsi.h 66955 2017-05-18 15:57:16Z vboxsync $ */
2/** @file
3 * VBox storage drivers - Virtual SCSI driver
4 */
5
6/*
7 * Copyright (C) 2006-2016 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27#ifndef ___VBox_vscsi_h
28#define ___VBox_vscsi_h
29
30#include <VBox/cdefs.h>
31#include <VBox/types.h>
32#include <VBox/vdmedia.h>
33#include <iprt/sg.h>
34
35RT_C_DECLS_BEGIN
36
37#ifdef IN_RING0
38# error "There are no VBox VSCSI APIs available in Ring-0 Host Context!"
39#endif
40
41/** @defgroup grp_drv_vscsi Virtual VSCSI Driver
42 * @ingroup grp_devdrv
43 * @{
44 */
45/** @todo figure better grouping. */
46
47/** A virtual SCSI device handle */
48typedef struct VSCSIDEVICEINT *VSCSIDEVICE;
49/** A pointer to a virtual SCSI device handle. */
50typedef VSCSIDEVICE *PVSCSIDEVICE;
51/** A virtual SCSI LUN handle. */
52typedef struct VSCSILUNINT *VSCSILUN;
53/** A pointer to a virtual SCSI LUN handle. */
54typedef VSCSILUN *PVSCSILUN;
55/** A virtual SCSI request handle. */
56typedef struct VSCSIREQINT *VSCSIREQ;
57/** A pointer to a virtual SCSI request handle. */
58typedef VSCSIREQ *PVSCSIREQ;
59/** A SCSI I/O request handle. */
60typedef struct VSCSIIOREQINT *VSCSIIOREQ;
61/** A pointer to a SCSI I/O request handle. */
62typedef VSCSIIOREQ *PVSCSIIOREQ;
63
64/**
65 * Virtual SCSI I/O request transfer direction.
66 */
67typedef enum VSCSIIOREQTXDIR
68{
69 /** Invalid direction */
70 VSCSIIOREQTXDIR_INVALID = 0,
71 /** Read */
72 VSCSIIOREQTXDIR_READ,
73 /** Write */
74 VSCSIIOREQTXDIR_WRITE,
75 /** Flush */
76 VSCSIIOREQTXDIR_FLUSH,
77 /** Unmap */
78 VSCSIIOREQTXDIR_UNMAP,
79 /** 32bit hack */
80 VSCSIIOREQTXDIR_32BIT_HACK = 0x7fffffff
81} VSCSIIOREQTXDIR;
82/** Pointer to a SCSI LUN type */
83typedef VSCSIIOREQTXDIR *PVSCSIIOREQTXDIR;
84
85/**
86 * LUN types we support
87 */
88typedef enum VSCSILUNTYPE
89{
90 /** Invalid type */
91 VSCSILUNTYPE_INVALID = 0,
92 /** Hard disk (SBC) */
93 VSCSILUNTYPE_SBC,
94 /** CD/DVD drive (MMC) */
95 VSCSILUNTYPE_MMC,
96 /** Tape drive (SSC) */
97 VSCSILUNTYPE_SSC,
98 /** Last value to indicate an invalid device */
99 VSCSILUNTYPE_LAST,
100 /** 32bit hack */
101 VSCSILUNTYPE_32BIT_HACK = 0x7fffffff
102} VSCSILUNTYPE;
103/** Pointer to a SCSI LUN type */
104typedef VSCSILUNTYPE *PVSCSILUNTYPE;
105
106/** The LUN can handle the UNMAP command. */
107#define VSCSI_LUN_FEATURE_UNMAP RT_BIT(0)
108/** The LUN has a non rotational medium. */
109#define VSCSI_LUN_FEATURE_NON_ROTATIONAL RT_BIT(1)
110/** The medium of the LUN is readonly. */
111#define VSCSI_LUN_FEATURE_READONLY RT_BIT(2)
112
113/**
114 * Virtual SCSI LUN I/O Callback table.
115 */
116typedef struct VSCSILUNIOCALLBACKS
117{
118 /**
119 * Sets the size of the allocator specific memory for a I/O request.
120 *
121 * @returns VBox status code.
122 * @param hVScsiLun Virtual SCSI LUN handle.
123 * @param pvScsiLunUser Opaque user data which may be used to identify the
124 * medium.
125 * @param cbVScsiIoReqAlloc The size of the allocator specific memory in bytes.
126 * @thread EMT.
127 */
128 DECLR3CALLBACKMEMBER(int, pfnVScsiLunReqAllocSizeSet, (VSCSILUN hVScsiLun, void *pvScsiLunUser,
129 size_t cbVScsiIoReqAlloc));
130
131 /**
132 * Allocates a new I/O request.
133 *
134 * @returns VBox status code.
135 * @param hVScsiLun Virtual SCSI LUN handle.
136 * @param pvScsiLunUser Opaque user data which may be used to identify the
137 * medium.
138 * @param u64Tag A tag to assign to the request handle for identification later on.
139 * @param phVScsiIoReq Where to store the handle to the allocated I/O request on success.
140 * @thread Any thread.
141 */
142 DECLR3CALLBACKMEMBER(int, pfnVScsiLunReqAlloc, (VSCSILUN hVScsiLun, void *pvScsiLunUser,
143 uint64_t u64Tag, PVSCSIIOREQ phVScsiIoReq));
144
145 /**
146 * Frees a given I/O request.
147 *
148 * @returns VBox status code.
149 * @param hVScsiLun Virtual SCSI LUN handle.
150 * @param pvScsiLunUser Opaque user data which may be used to identify the
151 * medium.
152 * @param hVScsiIoReq The VSCSI I/O request to free.
153 * @thread Any thread.
154 */
155 DECLR3CALLBACKMEMBER(int, pfnVScsiLunReqFree, (VSCSILUN hVScsiLun, void *pvScsiLunUser, VSCSIIOREQ hVScsiIoReq));
156
157 /**
158 * Returns the number of regions for the medium.
159 *
160 * @returns Number of regions.
161 * @param hVScsiLun Virtual SCSI LUN handle.
162 * @param pvScsiLunUser Opaque user data which may be used to identify the
163 * medium.
164 */
165 DECLR3CALLBACKMEMBER(uint32_t, pfnVScsiLunMediumGetRegionCount,(VSCSILUN hVScsiLun, void *pvScsiLunUser));
166
167 /**
168 * Queries the properties for the given region.
169 *
170 * @returns VBox status code.
171 * @retval VERR_NOT_FOUND if the region index is not known.
172 * @param hVScsiLun Virtual SCSI LUN handle.
173 * @param pvScsiLunUser Opaque user data which may be used to identify the
174 * medium.
175 * @param uRegion The region index to query the properties of.
176 * @param pu64LbaStart Where to store the starting LBA for the region on success.
177 * @param pcBlocks Where to store the number of blocks for the region on success.
178 * @param pcbBlock Where to store the size of one block in bytes on success.
179 * @param penmDataForm WHere to store the data form for the region on success.
180 */
181 DECLR3CALLBACKMEMBER(int, pfnVScsiLunMediumQueryRegionProperties,(VSCSILUN hVScsiLun, void *pvScsiLunUser,
182 uint32_t uRegion, uint64_t *pu64LbaStart,
183 uint64_t *pcBlocks, uint64_t *pcbBlock,
184 PVDREGIONDATAFORM penmDataForm));
185
186 /**
187 * Queries the properties for the region covering the given LBA.
188 *
189 * @returns VBox status code.
190 * @retval VERR_NOT_FOUND if the region index is not known.
191 * @param hVScsiLun Virtual SCSI LUN handle.
192 * @param pvScsiLunUser Opaque user data which may be used to identify the
193 * medium.
194 * @param u64LbaStart Where to store the starting LBA for the region on success.
195 * @param puRegion Where to store the region number on success.
196 * @param pcBlocks Where to store the number of blocks left in this region starting from the given LBA.
197 * @param pcbBlock Where to store the size of one block in bytes on success.
198 * @param penmDataForm WHere to store the data form for the region on success.
199 */
200 DECLR3CALLBACKMEMBER(int, pfnVScsiLunMediumQueryRegionPropertiesForLba,(VSCSILUN hVScsiLun, void *pvScsiLunUser,
201 uint64_t u64LbaStart, uint32_t *puRegion,
202 uint64_t *pcBlocks, uint64_t *pcbBlock,
203 PVDREGIONDATAFORM penmDataForm));
204
205 /**
206 * Set the lock state of the underlying medium.
207 *
208 * @returns VBox status status code.
209 * @param hVScsiLun Virtual SCSI LUN handle.
210 * @param pvScsiLunUser Opaque user data which may be used to identify the
211 * medium.
212 * @param fLocked New lock state (locked/unlocked).
213 */
214 DECLR3CALLBACKMEMBER(int, pfnVScsiLunMediumSetLock,(VSCSILUN hVScsiLun, void *pvScsiLunUser, bool fLocked));
215
216 /**
217 * Eject the attached medium.
218 *
219 * @returns VBox status code.
220 * @param hVScsiLun Virtual SCSI LUN handle.
221 * @param pvScsiLunUser Opaque user data which may be used to identify the
222 * medium.
223 */
224 DECLR3CALLBACKMEMBER(int, pfnVScsiLunMediumEject, (VSCSILUN hVScsiLun, void *pvScsiLunUser));
225
226 /**
227 * Enqueue a read or write request from the medium.
228 *
229 * @returns VBox status status code.
230 * @param hVScsiLun Virtual SCSI LUN handle.
231 * @param pvScsiLunUser Opaque user data which may be used to identify the
232 * medium.
233 * @param hVScsiIoReq Virtual SCSI I/O request handle.
234 */
235 DECLR3CALLBACKMEMBER(int, pfnVScsiLunReqTransferEnqueue,(VSCSILUN hVScsiLun, void *pvScsiLunUser, VSCSIIOREQ hVScsiIoReq));
236
237 /**
238 * Returns flags of supported features.
239 *
240 * @returns VBox status status code.
241 * @param hVScsiLun Virtual SCSI LUN handle.
242 * @param pvScsiLunUser Opaque user data which may be used to identify the
243 * medium.
244 * @param pfFeatures Where to return the queried features.
245 */
246 DECLR3CALLBACKMEMBER(int, pfnVScsiLunGetFeatureFlags,(VSCSILUN hVScsiLun, void *pvScsiLunUser, uint64_t *pfFeatures));
247
248} VSCSILUNIOCALLBACKS;
249/** Pointer to a virtual SCSI LUN I/O callback table. */
250typedef VSCSILUNIOCALLBACKS *PVSCSILUNIOCALLBACKS;
251
252/**
253 * The virtual SCSI request completed callback.
254 */
255typedef DECLCALLBACK(void) FNVSCSIREQCOMPLETED(VSCSIDEVICE hVScsiDevice,
256 void *pvVScsiDeviceUser,
257 void *pvVScsiReqUser,
258 int rcScsiCode,
259 bool fRedoPossible,
260 int rcReq,
261 size_t cbXfer);
262/** Pointer to a virtual SCSI request completed callback. */
263typedef FNVSCSIREQCOMPLETED *PFNVSCSIREQCOMPLETED;
264
265/**
266 * Create a new empty SCSI device instance.
267 *
268 * @returns VBox status code.
269 * @param phVScsiDevice Where to store the SCSI device handle.
270 * @param pfnVScsiReqCompleted The method call after a request completed.
271 * @param pvVScsiDeviceUser Opaque user data given in the completion callback.
272 */
273VBOXDDU_DECL(int) VSCSIDeviceCreate(PVSCSIDEVICE phVScsiDevice,
274 PFNVSCSIREQCOMPLETED pfnVScsiReqCompleted,
275 void *pvVScsiDeviceUser);
276
277/**
278 * Destroy a SCSI device instance.
279 *
280 * @returns VBox status code.
281 * @param hVScsiDevice The SCSI device handle to destroy.
282 */
283VBOXDDU_DECL(int) VSCSIDeviceDestroy(VSCSIDEVICE hVScsiDevice);
284
285/**
286 * Attach a LUN to the SCSI device.
287 *
288 * @returns VBox status code.
289 * @param hVScsiDevice The SCSI device handle to add the LUN to.
290 * @param hVScsiLun The LUN handle to add.
291 * @param iLun The LUN number.
292 */
293VBOXDDU_DECL(int) VSCSIDeviceLunAttach(VSCSIDEVICE hVScsiDevice, VSCSILUN hVScsiLun, uint32_t iLun);
294
295/**
296 * Detach a LUN from the SCSI device.
297 *
298 * @returns VBox status code.
299 * @param hVScsiDevice The SCSI device handle to add the LUN to.
300 * @param iLun The LUN number to remove.
301 * @param phVScsiLun Where to store the detached LUN handle.
302 */
303VBOXDDU_DECL(int) VSCSIDeviceLunDetach(VSCSIDEVICE hVScsiDevice, uint32_t iLun,
304 PVSCSILUN phVScsiLun);
305
306/**
307 * Query the SCSI LUN type.
308 *
309 * @returns VBox status code.
310 * @param hVScsiDevice The SCSI device handle.
311 * @param iLun The LUN number to get.
312 * @param pEnmLunType Where to store the LUN type.
313 */
314VBOXDDU_DECL(int) VSCSIDeviceLunQueryType(VSCSIDEVICE hVScsiDevice, uint32_t iLun,
315 PVSCSILUNTYPE pEnmLunType);
316
317/**
318 * Enqueue a request to the SCSI device.
319 *
320 * @returns VBox status code.
321 * @param hVScsiDevice The SCSI device handle.
322 * @param hVScsiReq The SCSI request handle to enqueue.
323 */
324VBOXDDU_DECL(int) VSCSIDeviceReqEnqueue(VSCSIDEVICE hVScsiDevice, VSCSIREQ hVScsiReq);
325
326/**
327 * Allocate a new request handle.
328 *
329 * @returns VBox status code.
330 * @param hVScsiDevice The SCSI device handle.
331 * @param phVScsiReq Where to SCSI request handle.
332 * @param iLun The LUN the request is for.
333 * @param pbCDB The CDB for the request.
334 * @param cbCDB The size of the CDB in bytes.
335 * @param cbSGList Number of bytes the S/G list describes.
336 * @param cSGListEntries Number of S/G list entries.
337 * @param paSGList Pointer to the S/G list.
338 * @param pbSense Pointer to the sense buffer.
339 * @param cbSense Size of the sense buffer.
340 * @param pvVScsiReqUser Opqaue user data returned when the request completes.
341 */
342VBOXDDU_DECL(int) VSCSIDeviceReqCreate(VSCSIDEVICE hVScsiDevice, PVSCSIREQ phVScsiReq,
343 uint32_t iLun, uint8_t *pbCDB, size_t cbCDB,
344 size_t cbSGList, unsigned cSGListEntries,
345 PCRTSGSEG paSGList, uint8_t *pbSense,
346 size_t cbSense, void *pvVScsiReqUser);
347
348/**
349 * Create a new LUN.
350 *
351 * @returns VBox status code.
352 * @param phVScsiLun Where to store the SCSI LUN handle.
353 * @param enmLunType The Lun type.
354 * @param pVScsiLunIoCallbacks Pointer to the I/O callbacks to use for his LUN.
355 * @param pvVScsiLunUser Opaque user argument which
356 * is returned in the pvScsiLunUser parameter
357 * when the request completion callback is called.
358 */
359VBOXDDU_DECL(int) VSCSILunCreate(PVSCSILUN phVScsiLun, VSCSILUNTYPE enmLunType,
360 PVSCSILUNIOCALLBACKS pVScsiLunIoCallbacks,
361 void *pvVScsiLunUser);
362
363/**
364 * Destroy virtual SCSI LUN.
365 *
366 * @returns VBox status code.
367 * @param hVScsiLun The virtual SCSI LUN handle to destroy.
368 */
369VBOXDDU_DECL(int) VSCSILunDestroy(VSCSILUN hVScsiLun);
370
371/**
372 * Notify virtual SCSI LUN of medium being mounted.
373 *
374 * @returns VBox status code.
375 * @param hVScsiLun The virtual SCSI LUN handle to destroy.
376 */
377VBOXDDU_DECL(int) VSCSILunMountNotify(VSCSILUN hVScsiLun);
378
379/**
380 * Notify virtual SCSI LUN of medium being unmounted.
381 *
382 * @returns VBox status code.
383 * @param hVScsiLun The virtual SCSI LUN handle to destroy.
384 */
385VBOXDDU_DECL(int) VSCSILunUnmountNotify(VSCSILUN hVScsiLun);
386
387/**
388 * Notify a that a I/O request completed.
389 *
390 * @returns VBox status code.
391 * @param hVScsiIoReq The I/O request handle that completed.
392 * This is given when a I/O callback for
393 * the LUN is called by the virtual SCSI layer.
394 * @param rcIoReq The status code the I/O request completed with.
395 * @param fRedoPossible Flag whether it is possible to redo the request.
396 * If true setting any sense code will be omitted
397 * in case of an error to not alter the device state.
398 */
399VBOXDDU_DECL(int) VSCSIIoReqCompleted(VSCSIIOREQ hVScsiIoReq, int rcIoReq, bool fRedoPossible);
400
401/**
402 * Query the transfer direction of the I/O request.
403 *
404 * @returns Transfer direction.of the given I/O request
405 * @param hVScsiIoReq The SCSI I/O request handle.
406 */
407VBOXDDU_DECL(VSCSIIOREQTXDIR) VSCSIIoReqTxDirGet(VSCSIIOREQ hVScsiIoReq);
408
409/**
410 * Query I/O parameters.
411 *
412 * @returns VBox status code.
413 * @param hVScsiIoReq The SCSI I/O request handle.
414 * @param puOffset Where to store the start offset.
415 * @param pcbTransfer Where to store the amount of bytes to transfer.
416 * @param pcSeg Where to store the number of segments in the S/G list.
417 * @param pcbSeg Where to store the number of bytes the S/G list describes.
418 * @param ppaSeg Where to store the pointer to the S/G list.
419 */
420VBOXDDU_DECL(int) VSCSIIoReqParamsGet(VSCSIIOREQ hVScsiIoReq, uint64_t *puOffset,
421 size_t *pcbTransfer, unsigned *pcSeg,
422 size_t *pcbSeg, PCRTSGSEG *ppaSeg);
423
424/**
425 * Query unmap parameters.
426 *
427 * @returns VBox status code.
428 * @param hVScsiIoReq The SCSI I/O request handle.
429 * @param ppaRanges Where to store the pointer to the range array on success.
430 * @param pcRanges Where to store the number of ranges on success.
431 */
432VBOXDDU_DECL(int) VSCSIIoReqUnmapParamsGet(VSCSIIOREQ hVScsiIoReq, PCRTRANGE *ppaRanges,
433 unsigned *pcRanges);
434
435/** @} */
436RT_C_DECLS_END
437
438#endif /* ___VBox_vscsi_h */
439
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette