1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
|
/* $Id: VBoxSCSI.cpp $ */
/** @file
*
* VBox storage devices:
* Simple SCSI interface for BIOS access
*/
/*
* Copyright (C) 2006-2009 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
//#define DEBUG
#define LOG_GROUP LOG_GROUP_DEV_BUSLOGIC /* @todo: Create extra group. */
#if defined(IN_R0) || defined(IN_RC)
# error This device has no R0 or GC components
#endif
#include <VBox/vmm/pdmdev.h>
#include <VBox/vmm/pgm.h>
#include <iprt/asm.h>
#include <iprt/mem.h>
#include <iprt/thread.h>
#include <iprt/string.h>
#include "VBoxSCSI.h"
static void vboxscsiReset(PVBOXSCSI pVBoxSCSI)
{
pVBoxSCSI->regIdentify = 0;
pVBoxSCSI->cbCDB = 0;
memset(pVBoxSCSI->aCDB, 0, sizeof(pVBoxSCSI->aCDB));
pVBoxSCSI->iCDB = 0;
pVBoxSCSI->fBusy = false;
pVBoxSCSI->cbBuf = 0;
pVBoxSCSI->iBuf = 0;
if (pVBoxSCSI->pBuf)
RTMemFree(pVBoxSCSI->pBuf);
pVBoxSCSI->pBuf = NULL;
pVBoxSCSI->enmState = VBOXSCSISTATE_NO_COMMAND;
}
/**
* Initializes the state for the SCSI interface.
*
* @returns VBox status code.
* @param pVBoxSCSI Pointer to the unitialized SCSI state.
*/
int vboxscsiInitialize(PVBOXSCSI pVBoxSCSI)
{
pVBoxSCSI->pBuf = NULL;
vboxscsiReset(pVBoxSCSI);
return VINF_SUCCESS;
}
/**
* Reads a register value.
*
* @returns VBox status code.
* @param pVBoxSCSI Pointer to the SCSI state.
* @param iRegister Index of the register to read.
* @param pu32Value Where to store the content of the register.
*/
int vboxscsiReadRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint32_t *pu32Value)
{
uint8_t uVal = 0;
switch (iRegister)
{
case 0:
{
if (ASMAtomicReadBool(&pVBoxSCSI->fBusy) == true)
{
uVal |= VBOX_SCSI_BUSY;
/* There is an I/O operation in progress.
* Yield the execution thread to let the I/O thread make progress.
*/
RTThreadYield();
}
else
uVal &= ~VBOX_SCSI_BUSY;
break;
}
case 1:
{
if (pVBoxSCSI->cbBuf > 0)
{
AssertMsg(pVBoxSCSI->pBuf, ("pBuf is NULL\n"));
uVal = pVBoxSCSI->pBuf[pVBoxSCSI->iBuf];
pVBoxSCSI->iBuf++;
pVBoxSCSI->cbBuf--;
if (pVBoxSCSI->cbBuf == 0)
{
/** The guest read the last byte from the data in buffer.
* Clear everything and reset command buffer.
*/
RTMemFree(pVBoxSCSI->pBuf);
pVBoxSCSI->pBuf = NULL;
pVBoxSCSI->cbCDB = 0;
pVBoxSCSI->iCDB = 0;
pVBoxSCSI->iBuf = 0;
pVBoxSCSI->uTargetDevice = 0;
pVBoxSCSI->enmState = VBOXSCSISTATE_NO_COMMAND;
memset(pVBoxSCSI->aCDB, 0, sizeof(pVBoxSCSI->aCDB));
}
}
break;
}
case 2:
{
uVal = pVBoxSCSI->regIdentify;
break;
}
default:
AssertMsgFailed(("Invalid register to read from %u\n", iRegister));
}
*pu32Value = uVal;
return VINF_SUCCESS;
}
/**
* Writes to a register.
*
* @returns VBox status code.
* VERR_MORE_DATA if a command is ready to be sent to the SCSI driver.
* @param pVBoxSCSI Pointer to the SCSI state.
* @param iRegister Index of the register to write to.
* @param uVal Value to write.
*/
int vboxscsiWriteRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint8_t uVal)
{
int rc = VINF_SUCCESS;
switch (iRegister)
{
case 0:
{
if (pVBoxSCSI->enmState == VBOXSCSISTATE_NO_COMMAND)
{
pVBoxSCSI->enmState = VBOXSCSISTATE_READ_TXDIR;
pVBoxSCSI->uTargetDevice = uVal;
}
else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_TXDIR)
{
if (uVal != VBOXSCSI_TXDIR_FROM_DEVICE && uVal != VBOXSCSI_TXDIR_TO_DEVICE)
vboxscsiReset(pVBoxSCSI);
else
{
pVBoxSCSI->enmState = VBOXSCSISTATE_READ_CDB_SIZE;
pVBoxSCSI->uTxDir = uVal;
}
}
else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_CDB_SIZE)
{
if (uVal > VBOXSCSI_CDB_SIZE_MAX)
vboxscsiReset(pVBoxSCSI);
else
{
pVBoxSCSI->enmState = VBOXSCSISTATE_READ_BUFFER_SIZE_LOW;
pVBoxSCSI->cbCDB = uVal;
}
}
else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_BUFFER_SIZE_LOW)
{
pVBoxSCSI->enmState = VBOXSCSISTATE_READ_BUFFER_SIZE_HIGH;
pVBoxSCSI->cbBuf = uVal;
}
else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_BUFFER_SIZE_HIGH)
{
pVBoxSCSI->enmState = VBOXSCSISTATE_READ_COMMAND;
pVBoxSCSI->cbBuf |= (((uint16_t)uVal) << 8);
}
else if (pVBoxSCSI->enmState == VBOXSCSISTATE_READ_COMMAND)
{
pVBoxSCSI->aCDB[pVBoxSCSI->iCDB] = uVal;
pVBoxSCSI->iCDB++;
/* Check if we have all necessary command data. */
if (pVBoxSCSI->iCDB == pVBoxSCSI->cbCDB)
{
Log(("%s: Command ready for processing\n", __FUNCTION__));
pVBoxSCSI->enmState = VBOXSCSISTATE_COMMAND_READY;
if (pVBoxSCSI->uTxDir == VBOXSCSI_TXDIR_TO_DEVICE)
{
/* This is a write allocate buffer. */
pVBoxSCSI->pBuf = (uint8_t *)RTMemAllocZ(pVBoxSCSI->cbBuf);
if (!pVBoxSCSI->pBuf)
return VERR_NO_MEMORY;
}
else
{
/* This is a read from the device. */
ASMAtomicXchgBool(&pVBoxSCSI->fBusy, true);
rc = VERR_MORE_DATA; /** @todo Better return value to indicate ready command? */
}
}
}
else
AssertMsgFailed(("Invalid state %d\n", pVBoxSCSI->enmState));
break;
}
case 1:
{
if ( pVBoxSCSI->enmState != VBOXSCSISTATE_COMMAND_READY
|| pVBoxSCSI->uTxDir != VBOXSCSI_TXDIR_TO_DEVICE)
{
/* Reset the state */
vboxscsiReset(pVBoxSCSI);
}
else
{
pVBoxSCSI->pBuf[pVBoxSCSI->iBuf++] = uVal;
if (pVBoxSCSI->iBuf == pVBoxSCSI->cbBuf)
{
rc = VERR_MORE_DATA;
ASMAtomicXchgBool(&pVBoxSCSI->fBusy, true);
}
}
break;
}
case 2:
{
pVBoxSCSI->regIdentify = uVal;
break;
}
case 3:
{
/* Reset */
vboxscsiReset(pVBoxSCSI);
break;
}
default:
AssertMsgFailed(("Invalid register to write to %u\n", iRegister));
}
return rc;
}
/**
* Sets up a SCSI request which the owning SCSI device can process.
*
* @returns VBox status code.
* @param pVBoxSCSI Pointer to the SCSI state.
* @param pScsiRequest Pointer to a scsi request to setup.
* @param puTargetDevice Where to store the target device ID.
*/
int vboxscsiSetupRequest(PVBOXSCSI pVBoxSCSI, PPDMSCSIREQUEST pScsiRequest, uint32_t *puTargetDevice)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pVBoxSCSI=%#p pScsiRequest=%#p puTargetDevice=%#p\n", pVBoxSCSI, pScsiRequest, puTargetDevice));
AssertMsg(pVBoxSCSI->enmState == VBOXSCSISTATE_COMMAND_READY, ("Invalid state %u\n", pVBoxSCSI->enmState));
if (pVBoxSCSI->uTxDir == VBOXSCSI_TXDIR_FROM_DEVICE)
{
if (pVBoxSCSI->pBuf)
RTMemFree(pVBoxSCSI->pBuf);
pVBoxSCSI->pBuf = (uint8_t *)RTMemAllocZ(pVBoxSCSI->cbBuf);
if (!pVBoxSCSI->pBuf)
return VERR_NO_MEMORY;
}
/* Allocate scatter gather element. */
pScsiRequest->paScatterGatherHead = (PRTSGSEG)RTMemAllocZ(sizeof(RTSGSEG) * 1); /* Only one element. */
if (!pScsiRequest->paScatterGatherHead)
{
RTMemFree(pVBoxSCSI->pBuf);
pVBoxSCSI->pBuf = NULL;
return VERR_NO_MEMORY;
}
/* Allocate sense buffer. */
pScsiRequest->cbSenseBuffer = 18;
pScsiRequest->pbSenseBuffer = (uint8_t *)RTMemAllocZ(pScsiRequest->cbSenseBuffer);
pScsiRequest->cbCDB = pVBoxSCSI->cbCDB;
pScsiRequest->pbCDB = pVBoxSCSI->aCDB;
pScsiRequest->uLogicalUnit = 0;
pScsiRequest->cbScatterGather = pVBoxSCSI->cbBuf;
pScsiRequest->cScatterGatherEntries = 1;
pScsiRequest->paScatterGatherHead[0].cbSeg = pVBoxSCSI->cbBuf;
pScsiRequest->paScatterGatherHead[0].pvSeg = pVBoxSCSI->pBuf;
*puTargetDevice = pVBoxSCSI->uTargetDevice;
return rc;
}
/**
* Notifies the device that a request finished and the incoming data
* is ready at the incoming data port.
*/
int vboxscsiRequestFinished(PVBOXSCSI pVBoxSCSI, PPDMSCSIREQUEST pScsiRequest)
{
LogFlowFunc(("pVBoxSCSI=%#p pScsiRequest=%#p\n", pVBoxSCSI, pScsiRequest));
RTMemFree(pScsiRequest->paScatterGatherHead);
RTMemFree(pScsiRequest->pbSenseBuffer);
if (pVBoxSCSI->uTxDir == VBOXSCSI_TXDIR_TO_DEVICE)
{
if (pVBoxSCSI->pBuf)
RTMemFree(pVBoxSCSI->pBuf);
pVBoxSCSI->pBuf = NULL;
pVBoxSCSI->cbBuf = 0;
pVBoxSCSI->cbCDB = 0;
pVBoxSCSI->iCDB = 0;
pVBoxSCSI->iBuf = 0;
pVBoxSCSI->uTargetDevice = 0;
pVBoxSCSI->enmState = VBOXSCSISTATE_NO_COMMAND;
memset(pVBoxSCSI->aCDB, 0, sizeof(pVBoxSCSI->aCDB));
}
ASMAtomicXchgBool(&pVBoxSCSI->fBusy, false);
return VINF_SUCCESS;
}
int vboxscsiReadString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
RTGCPTR *pGCPtrDst, PRTGCUINTREG pcTransfer, unsigned cb)
{
RTGCPTR GCDst = *pGCPtrDst;
uint32_t cbTransfer = *pcTransfer * cb;
LogFlowFunc(("pDevIns=%#p pVBoxSCSI=%#p iRegister=%d cTransfer=%u cb=%u\n",
pDevIns, pVBoxSCSI, iRegister, *pcTransfer, cb));
/* Read string only valid for data in register. */
AssertMsg(iRegister == 1, ("Hey only register 1 can be read from with string\n"));
Assert(pVBoxSCSI->pBuf);
int rc = PGMPhysSimpleDirtyWriteGCPtr(PDMDevHlpGetVMCPU(pDevIns), GCDst, pVBoxSCSI->pBuf, cbTransfer);
AssertRC(rc);
*pGCPtrDst = (RTGCPTR)((RTGCUINTPTR)GCDst + cbTransfer);
*pcTransfer = 0;
RTMemFree(pVBoxSCSI->pBuf);
pVBoxSCSI->pBuf = NULL;
pVBoxSCSI->cbBuf = 0;
pVBoxSCSI->cbCDB = 0;
pVBoxSCSI->iCDB = 0;
pVBoxSCSI->iBuf = 0;
pVBoxSCSI->uTargetDevice = 0;
pVBoxSCSI->enmState = VBOXSCSISTATE_NO_COMMAND;
memset(pVBoxSCSI->aCDB, 0, sizeof(pVBoxSCSI->aCDB));
return rc;
}
int vboxscsiWriteString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
RTGCPTR *pGCPtrSrc, PRTGCUINTREG pcTransfer, unsigned cb)
{
RTGCPTR GCSrc = *pGCPtrSrc;
uint32_t cbTransfer = *pcTransfer * cb;
/* Write string only valid for data in/out register. */
AssertMsg(iRegister == 1, ("Hey only register 1 can be written to with string\n"));
Assert(cbTransfer == pVBoxSCSI->cbBuf);
if (cbTransfer > pVBoxSCSI->cbBuf)
cbTransfer = pVBoxSCSI->cbBuf; /* Ignore excess data (not supposed to happen). */
int rc = PDMDevHlpPhysReadGCVirt(pDevIns, pVBoxSCSI->pBuf, GCSrc, cbTransfer);
AssertRC(rc);
*pGCPtrSrc = (RTGCPTR)((RTGCUINTPTR)GCSrc + cbTransfer);
*pcTransfer = 0;
ASMAtomicXchgBool(&pVBoxSCSI->fBusy, true);
return VERR_MORE_DATA;
}
void vboxscsiSetRequestRedo(PVBOXSCSI pVBoxSCSI, PPDMSCSIREQUEST pScsiRequest)
{
AssertMsg(pVBoxSCSI->fBusy, ("No request to redo\n"));
RTMemFree(pScsiRequest->paScatterGatherHead);
RTMemFree(pScsiRequest->pbSenseBuffer);
if (pVBoxSCSI->uTxDir == VBOXSCSI_TXDIR_FROM_DEVICE)
{
AssertPtr(pVBoxSCSI->pBuf);
}
}
|