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
|
/* $Id: VBoxSCSI.h $ */
/** @file
* VBox storage devices - Simple SCSI interface for BIOS access.
*/
/*
* Copyright (C) 2006-2019 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.
*/
/** @page pg_drv_scsi Simple SCSI interface for BIOS access.
*
* This is a simple interface to access SCSI devices from the BIOS which is
* shared between the BusLogic and the LsiLogic SCSI host adapters to simplify
* the BIOS part.
*
* The first interface (if available) will be starting at port 0x430 and
* each will occupy 4 ports. The ports are used as described below:
*
* +--------+--------+----------+
* | Offset | Access | Purpose |
* +--------+--------+----------+
* | 0 | Write | Command |
* +--------+--------+----------+
* | 0 | Read | Status |
* +--------+--------+----------+
* | 1 | Write | Data in |
* +--------+--------+----------+
* | 1 | Read | Data out |
* +--------+--------+----------+
* | 2 | R/W | Detect |
* +--------+--------+----------+
* | 3 | Read | SCSI rc |
* +--------+--------+----------+
* | 3 | Write | Reset |
* +--------+--------+----------+
*
* The register at port 0 receives the SCSI CDB issued from the driver when
* writing to it but before writing the actual CDB the first write gives the
* size of the CDB in bytes.
*
* Reading the port at offset 0 gives status information about the adapter. If
* the busy bit is set the adapter is processing a previous issued request if it is
* cleared the command finished and the adapter can process another request.
* The driver has to poll this bit because the adapter will not assert an IRQ
* for simplicity reasons.
*
* The register at offset 2 is to detect if a host adapter is available. If the
* driver writes a value to this port and gets the same value after reading it
* again the adapter is available.
*
* Any write to the register at offset 3 causes the interface to be reset. A
* read returns the SCSI status code of the last operation.
*
* This part has no R0 or RC components.
*/
#ifndef VBOX_INCLUDED_SRC_Storage_VBoxSCSI_h
#define VBOX_INCLUDED_SRC_Storage_VBoxSCSI_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/*******************************************************************************
* Header Files *
*******************************************************************************/
//#define DEBUG
#include <VBox/vmm/pdmdev.h>
#include <VBox/vmm/pdmstorageifs.h>
#include <VBox/scsi.h>
typedef enum VBOXSCSISTATE
{
VBOXSCSISTATE_NO_COMMAND = 0x00,
VBOXSCSISTATE_READ_TXDIR = 0x01,
VBOXSCSISTATE_READ_CDB_SIZE_BUFHI = 0x02,
VBOXSCSISTATE_READ_BUFFER_SIZE_LSB = 0x03,
VBOXSCSISTATE_READ_BUFFER_SIZE_MID = 0x04,
VBOXSCSISTATE_READ_COMMAND = 0x05,
VBOXSCSISTATE_COMMAND_READY = 0x06
} VBOXSCSISTATE;
#define VBOXSCSI_TXDIR_FROM_DEVICE 0
#define VBOXSCSI_TXDIR_TO_DEVICE 1
/** Maximum CDB size the BIOS driver sends. */
#define VBOXSCSI_CDB_SIZE_MAX 16
typedef struct VBOXSCSI
{
/** The identify register. */
uint8_t regIdentify;
/** The target device. */
uint8_t uTargetDevice;
/** Transfer direction. */
uint8_t uTxDir;
/** The size of the CDB we are issuing. */
uint8_t cbCDB;
/** The command to issue. */
uint8_t abCDB[VBOXSCSI_CDB_SIZE_MAX + 4];
/** Current position in the array. */
uint8_t iCDB;
#if HC_ARCH_BITS == 64
uint32_t Alignment0;
#endif
/** Pointer to the buffer holding the data. */
R3PTRTYPE(uint8_t *) pbBuf;
/** Size of the buffer in bytes. */
uint32_t cbBuf;
/** The number of bytes left to read/write in the
* buffer. It is decremented when the guest (BIOS) accesses
* the buffer data. */
uint32_t cbBufLeft;
/** Current position in the buffer (offBuf if you like). */
uint32_t iBuf;
/** The result code of last operation. */
int32_t rcCompletion;
/** Flag whether a request is pending. */
volatile bool fBusy;
/** The state we are in when fetching a command from the BIOS. */
VBOXSCSISTATE enmState;
} VBOXSCSI, *PVBOXSCSI;
#define VBOX_SCSI_BUSY RT_BIT(0)
#define VBOX_SCSI_ERROR RT_BIT(1)
#ifdef IN_RING3
RT_C_DECLS_BEGIN
int vboxscsiInitialize(PVBOXSCSI pVBoxSCSI);
int vboxscsiReadRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint32_t *pu32Value);
int vboxscsiWriteRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint8_t uVal);
int vboxscsiSetupRequest(PVBOXSCSI pVBoxSCSI, uint32_t *puLun, uint8_t **ppbCdb, size_t *pcbCdb,
size_t *pcbBuf, uint32_t *puTargetDevice);
int vboxscsiRequestFinished(PVBOXSCSI pVBoxSCSI, int rcCompletion);
size_t vboxscsiCopyToBuf(PVBOXSCSI pVBoxSCSI, PRTSGBUF pSgBuf, size_t cbSkip, size_t cbCopy);
size_t vboxscsiCopyFromBuf(PVBOXSCSI pVBoxSCSI, PRTSGBUF pSgBuf, size_t cbSkip, size_t cbCopy);
void vboxscsiSetRequestRedo(PVBOXSCSI pVBoxSCSI);
int vboxscsiWriteString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
uint8_t const *pbSrc, uint32_t *pcTransfers, unsigned cb);
int vboxscsiReadString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
uint8_t *pbDst, uint32_t *pcTransfers, unsigned cb);
DECLHIDDEN(int) vboxscsiR3LoadExec(PVBOXSCSI pVBoxSCSI, PSSMHANDLE pSSM);
DECLHIDDEN(int) vboxscsiR3SaveExec(PVBOXSCSI pVBoxSCSI, PSSMHANDLE pSSM);
RT_C_DECLS_END
#endif /* IN_RING3 */
#endif /* !VBOX_INCLUDED_SRC_Storage_VBoxSCSI_h */
|
