1 | /* $Id: VBoxSCSI.h 56292 2015-06-09 14:20:46Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * VBox storage devices - Simple SCSI interface for BIOS access.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2015 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 |
|
---|
18 | /** @page pg_drv_scsi Simple SCSI interface for BIOS access.
|
---|
19 | *
|
---|
20 | * This is a simple interface to access SCSI devices from the BIOS which is
|
---|
21 | * shared between the BusLogic and the LsiLogic SCSI host adapters to simplify
|
---|
22 | * the BIOS part.
|
---|
23 | *
|
---|
24 | * The first interface (if available) will be starting at port 0x430 and
|
---|
25 | * each will occupy 4 ports. The ports are used as described below:
|
---|
26 | *
|
---|
27 | * +--------+--------+----------+
|
---|
28 | * | Offset | Access | Purpose |
|
---|
29 | * +--------+--------+----------+
|
---|
30 | * | 0 | Write | Command |
|
---|
31 | * +--------+--------+----------+
|
---|
32 | * | 0 | Read | Status |
|
---|
33 | * +--------+--------+----------+
|
---|
34 | * | 1 | Write | Data in |
|
---|
35 | * +--------+--------+----------+
|
---|
36 | * | 1 | Read | Data out |
|
---|
37 | * +--------+--------+----------+
|
---|
38 | * | 2 | R/W | Detect |
|
---|
39 | * +--------+--------+----------+
|
---|
40 | * | 3 | Read | SCSI rc |
|
---|
41 | * +--------+--------+----------+
|
---|
42 | * | 3 | Write | Reset |
|
---|
43 | * +--------+--------+----------+
|
---|
44 | *
|
---|
45 | * The register at port 0 receives the SCSI CDB issued from the driver when
|
---|
46 | * writing to it but before writing the actual CDB the first write gives the
|
---|
47 | * size of the CDB in bytes.
|
---|
48 | *
|
---|
49 | * Reading the port at offset 0 gives status information about the adapter. If
|
---|
50 | * the busy bit is set the adapter is processing a previous issued request if it is
|
---|
51 | * cleared the command finished and the adapter can process another request.
|
---|
52 | * The driver has to poll this bit because the adapter will not assert an IRQ
|
---|
53 | * for simplicity reasons.
|
---|
54 | *
|
---|
55 | * The register at offset 2 is to detect if a host adapter is available. If the
|
---|
56 | * driver writes a value to this port and gets the same value after reading it
|
---|
57 | * again the adapter is available.
|
---|
58 | *
|
---|
59 | * Any write to the register at offset 3 causes the interface to be reset. A
|
---|
60 | * read returns the SCSI status code of the last operation.
|
---|
61 | *
|
---|
62 | * This part has no R0 or RC components.
|
---|
63 | */
|
---|
64 |
|
---|
65 | #ifndef ___Storage_VBoxSCSI_h
|
---|
66 | #define ___Storage_VBoxSCSI_h
|
---|
67 |
|
---|
68 | /*******************************************************************************
|
---|
69 | * Header Files *
|
---|
70 | *******************************************************************************/
|
---|
71 | //#define DEBUG
|
---|
72 | #include <VBox/vmm/pdmdev.h>
|
---|
73 | #include <VBox/scsi.h>
|
---|
74 |
|
---|
75 | typedef enum VBOXSCSISTATE
|
---|
76 | {
|
---|
77 | VBOXSCSISTATE_NO_COMMAND = 0x00,
|
---|
78 | VBOXSCSISTATE_READ_TXDIR = 0x01,
|
---|
79 | VBOXSCSISTATE_READ_CDB_SIZE_BUFHI = 0x02,
|
---|
80 | VBOXSCSISTATE_READ_BUFFER_SIZE_LSB = 0x03,
|
---|
81 | VBOXSCSISTATE_READ_BUFFER_SIZE_MID = 0x04,
|
---|
82 | VBOXSCSISTATE_READ_COMMAND = 0x05,
|
---|
83 | VBOXSCSISTATE_COMMAND_READY = 0x06
|
---|
84 | } VBOXSCSISTATE;
|
---|
85 |
|
---|
86 | #define VBOXSCSI_TXDIR_FROM_DEVICE 0
|
---|
87 | #define VBOXSCSI_TXDIR_TO_DEVICE 1
|
---|
88 |
|
---|
89 | /** Maximum CDB size the BIOS driver sends. */
|
---|
90 | #define VBOXSCSI_CDB_SIZE_MAX 10
|
---|
91 |
|
---|
92 | typedef struct VBOXSCSI
|
---|
93 | {
|
---|
94 | /** The identify register. */
|
---|
95 | uint8_t regIdentify;
|
---|
96 | /** The target device. */
|
---|
97 | uint8_t uTargetDevice;
|
---|
98 | /** Transfer direction. */
|
---|
99 | uint8_t uTxDir;
|
---|
100 | /** The size of the CDB we are issuing. */
|
---|
101 | uint8_t cbCDB;
|
---|
102 | /** The command to issue. */
|
---|
103 | uint8_t abCDB[12];
|
---|
104 | /** Current position in the array. */
|
---|
105 | uint8_t iCDB;
|
---|
106 |
|
---|
107 | #if HC_ARCH_BITS == 64
|
---|
108 | uint32_t Alignment0;
|
---|
109 | #endif
|
---|
110 |
|
---|
111 | /** Pointer to the buffer holding the data. */
|
---|
112 | R3PTRTYPE(uint8_t *) pbBuf;
|
---|
113 | /** Size of the buffer in bytes. */
|
---|
114 | uint32_t cbBuf;
|
---|
115 | /** Current position in the buffer (offBuf if you like). */
|
---|
116 | uint32_t iBuf;
|
---|
117 | /** The result code of last operation. */
|
---|
118 | int32_t rcCompletion;
|
---|
119 | #if HC_ARCH_BITS == 64
|
---|
120 | uint32_t Alignment1;
|
---|
121 | #endif
|
---|
122 | /** Flag whether a request is pending. */
|
---|
123 | volatile bool fBusy;
|
---|
124 | /** The state we are in when fetching a command from the BIOS. */
|
---|
125 | VBOXSCSISTATE enmState;
|
---|
126 | } VBOXSCSI, *PVBOXSCSI;
|
---|
127 |
|
---|
128 | #define VBOX_SCSI_BUSY RT_BIT(0)
|
---|
129 | #define VBOX_SCSI_ERROR RT_BIT(1)
|
---|
130 |
|
---|
131 | #ifdef IN_RING3
|
---|
132 | RT_C_DECLS_BEGIN
|
---|
133 | int vboxscsiInitialize(PVBOXSCSI pVBoxSCSI);
|
---|
134 | int vboxscsiReadRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint32_t *pu32Value);
|
---|
135 | int vboxscsiWriteRegister(PVBOXSCSI pVBoxSCSI, uint8_t iRegister, uint8_t uVal);
|
---|
136 | int vboxscsiSetupRequest(PVBOXSCSI pVBoxSCSI, PPDMSCSIREQUEST pScsiRequest, uint32_t *puTargetDevice);
|
---|
137 | int vboxscsiRequestFinished(PVBOXSCSI pVBoxSCSI, PPDMSCSIREQUEST pScsiRequest, int rcCompletion);
|
---|
138 | void vboxscsiSetRequestRedo(PVBOXSCSI pVBoxSCSI, PPDMSCSIREQUEST pScsiRequest);
|
---|
139 | int vboxscsiWriteString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
|
---|
140 | RTGCPTR *pGCPtrSrc, PRTGCUINTREG pcTransfer, unsigned cb);
|
---|
141 | int vboxscsiReadString(PPDMDEVINS pDevIns, PVBOXSCSI pVBoxSCSI, uint8_t iRegister,
|
---|
142 | RTGCPTR *pGCPtrDst, PRTGCUINTREG pcTransfer, unsigned cb);
|
---|
143 | RT_C_DECLS_END
|
---|
144 | #endif /* IN_RING3 */
|
---|
145 |
|
---|
146 | #endif /* !___Storage_VBoxSCSI_h */
|
---|
147 |
|
---|