1 | /** @file
|
---|
2 | * VirtualBox - SCSI declarations. (DEV,+)
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2006-2016 Oracle Corporation
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | */
|
---|
25 |
|
---|
26 | #ifndef ___VBox_scsi_h
|
---|
27 | #define ___VBox_scsi_h
|
---|
28 |
|
---|
29 | #include <iprt/assert.h>
|
---|
30 |
|
---|
31 | /**
|
---|
32 | * @todo: Remove when the splitting code was removed from DevATA.
|
---|
33 | * The limit doesn't belong here but is specific for each host platform.
|
---|
34 | */
|
---|
35 | #ifdef RT_OS_FREEBSD
|
---|
36 | /* The cam subsystem doesn't allow more */
|
---|
37 | # define SCSI_MAX_BUFFER_SIZE (64 * _1K)
|
---|
38 | #else
|
---|
39 | # define SCSI_MAX_BUFFER_SIZE (100 * _1K)
|
---|
40 | #endif
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * SCSI command opcode identifiers.
|
---|
44 | *
|
---|
45 | * SCSI-3, so far for CD/DVD Logical Units, from Table 49 of the MMC-3 draft standard.
|
---|
46 | */
|
---|
47 | typedef enum SCSICMD
|
---|
48 | {
|
---|
49 | SCSI_BLANK = 0xa1,
|
---|
50 | SCSI_CLOSE_TRACK_SESSION = 0x5b,
|
---|
51 | SCSI_ERASE_10 = 0x2c,
|
---|
52 | SCSI_FORMAT_UNIT = 0x04,
|
---|
53 | SCSI_GET_CONFIGURATION = 0x46,
|
---|
54 | SCSI_GET_EVENT_STATUS_NOTIFICATION = 0x4a,
|
---|
55 | SCSI_GET_PERFORMANCE = 0xac,
|
---|
56 | /** Inquiry command. */
|
---|
57 | SCSI_INQUIRY = 0x12,
|
---|
58 | SCSI_LOAD_UNLOAD_MEDIUM = 0xa6,
|
---|
59 | SCSI_MECHANISM_STATUS = 0xbd,
|
---|
60 | SCSI_MODE_SELECT_10 = 0x55,
|
---|
61 | SCSI_MODE_SENSE_10 = 0x5a,
|
---|
62 | SCSI_PAUSE_RESUME = 0x4b,
|
---|
63 | SCSI_PLAY_AUDIO_10 = 0x45,
|
---|
64 | SCSI_PLAY_AUDIO_12 = 0xa5,
|
---|
65 | SCSI_PLAY_AUDIO_MSF = 0x47,
|
---|
66 | SCSI_PREVENT_ALLOW_MEDIUM_REMOVAL = 0x1e,
|
---|
67 | /** Read(10) command. */
|
---|
68 | SCSI_READ_10 = 0x28,
|
---|
69 | SCSI_READ_12 = 0xa8,
|
---|
70 | SCSI_READ_BUFFER = 0x3c,
|
---|
71 | SCSI_READ_BUFFER_CAPACITY = 0x5c,
|
---|
72 | /** Read Capacity(6) command. */
|
---|
73 | SCSI_READ_CAPACITY = 0x25,
|
---|
74 | SCSI_READ_CD = 0xbe,
|
---|
75 | SCSI_READ_CD_MSF = 0xb9,
|
---|
76 | SCSI_READ_DISC_INFORMATION = 0x51,
|
---|
77 | SCSI_READ_DVD_STRUCTURE = 0xad,
|
---|
78 | SCSI_READ_FORMAT_CAPACITIES = 0x23,
|
---|
79 | SCSI_READ_SUBCHANNEL = 0x42,
|
---|
80 | SCSI_READ_TOC_PMA_ATIP = 0x43,
|
---|
81 | SCSI_READ_TRACK_INFORMATION = 0x52,
|
---|
82 | SCSI_REPAIR_TRACK = 0x58,
|
---|
83 | SCSI_REPORT_KEY = 0xa4,
|
---|
84 | SCSI_REQUEST_SENSE = 0x03,
|
---|
85 | SCSI_RESERVE_TRACK = 0x53,
|
---|
86 | SCSI_SCAN = 0xba,
|
---|
87 | SCSI_SEEK_10 = 0x2b,
|
---|
88 | SCSI_SEND_CUE_SHEET = 0x5d,
|
---|
89 | SCSI_SEND_DVD_STRUCTURE = 0xbf,
|
---|
90 | SCSI_SEND_EVENT = 0xa2,
|
---|
91 | SCSI_SEND_KEY = 0xa3,
|
---|
92 | SCSI_SEND_OPC_INFORMATION = 0x54,
|
---|
93 | SCSI_SET_CD_SPEED = 0xbb,
|
---|
94 | SCSI_SET_READ_AHEAD = 0xa7,
|
---|
95 | SCSI_SET_STREAMING = 0xb6,
|
---|
96 | SCSI_START_STOP_UNIT = 0x1b,
|
---|
97 | SCSI_LOAD_UNLOAD = 0x1b,
|
---|
98 | SCSI_STOP_PLAY_SCAN = 0x4e,
|
---|
99 | /** Synchronize Cache command. */
|
---|
100 | SCSI_SYNCHRONIZE_CACHE = 0x35,
|
---|
101 | SCSI_TEST_UNIT_READY = 0x00,
|
---|
102 | SCSI_VERIFY_10 = 0x2f,
|
---|
103 | /** Write(10) command. */
|
---|
104 | SCSI_WRITE_10 = 0x2a,
|
---|
105 | SCSI_WRITE_12 = 0xaa,
|
---|
106 | SCSI_WRITE_AND_VERIFY_10 = 0x2e,
|
---|
107 | SCSI_WRITE_BUFFER = 0x3b,
|
---|
108 |
|
---|
109 | /** Mode Sekect(6) command */
|
---|
110 | SCSI_MODE_SELECT_6 = 0x15,
|
---|
111 | /** Mode Sense(6) command */
|
---|
112 | SCSI_MODE_SENSE_6 = 0x1a,
|
---|
113 | /** Report LUNs command. */
|
---|
114 | SCSI_REPORT_LUNS = 0xa0,
|
---|
115 | SCSI_REPORT_DENSITY = 0x44,
|
---|
116 | /** Rezero Unit command. Obsolete for ages now, but used by cdrecord. */
|
---|
117 | SCSI_REZERO_UNIT = 0x01,
|
---|
118 | SCSI_REWIND = 0x01,
|
---|
119 | SCSI_SERVICE_ACTION_IN_16 = 0x9e,
|
---|
120 | SCSI_READ_16 = 0x88,
|
---|
121 | SCSI_WRITE_16 = 0x8a,
|
---|
122 | SCSI_READ_6 = 0x08,
|
---|
123 | SCSI_WRITE_6 = 0x0a,
|
---|
124 | SCSI_LOG_SENSE = 0x4d,
|
---|
125 | SCSI_UNMAP = 0x42,
|
---|
126 | SCSI_RESERVE_6 = 0x16,
|
---|
127 | SCSI_RELEASE_6 = 0x17,
|
---|
128 | SCSI_RESERVE_10 = 0x56,
|
---|
129 | SCSI_RELEASE_10 = 0x57,
|
---|
130 | SCSI_READ_BLOCK_LIMITS = 0x05,
|
---|
131 | SCSI_MAINTENANCE_IN = 0xa3
|
---|
132 | } SCSICMD;
|
---|
133 |
|
---|
134 | /**
|
---|
135 | * Service action in opcode identifiers
|
---|
136 | */
|
---|
137 | typedef enum SCSISVCACTIONIN
|
---|
138 | {
|
---|
139 | SCSI_SVC_ACTION_IN_READ_CAPACITY_16 = 0x10
|
---|
140 | } SCSISVCACTIONIN;
|
---|
141 |
|
---|
142 | /**
|
---|
143 | * Maintenance in opcode identifiers
|
---|
144 | */
|
---|
145 | typedef enum SCSIMAINTENANCEIN
|
---|
146 | {
|
---|
147 | SCSI_MAINTENANCE_IN_REPORT_SUPP_OPC = 0x0c
|
---|
148 | } SCSIMAINTENANCEIN;
|
---|
149 |
|
---|
150 | /* Mode page codes for mode sense/select commands. */
|
---|
151 | #define SCSI_MODEPAGE_ERROR_RECOVERY 0x01
|
---|
152 | #define SCSI_MODEPAGE_WRITE_PARAMETER 0x05
|
---|
153 | #define SCSI_MODEPAGE_CD_STATUS 0x2a
|
---|
154 |
|
---|
155 |
|
---|
156 | /* Page control codes. */
|
---|
157 | #define SCSI_PAGECONTROL_CURRENT 0x00
|
---|
158 | #define SCSI_PAGECONTROL_CHANGEABLE 0x01
|
---|
159 | #define SCSI_PAGECONTROL_DEFAULT 0x02
|
---|
160 | #define SCSI_PAGECONTROL_SAVED 0x03
|
---|
161 |
|
---|
162 |
|
---|
163 | /* Status codes */
|
---|
164 | #define SCSI_STATUS_OK 0x00
|
---|
165 | #define SCSI_STATUS_CHECK_CONDITION 0x02
|
---|
166 | #define SCSI_STATUS_CONDITION_MET 0x04
|
---|
167 | #define SCSI_STATUS_BUSY 0x08
|
---|
168 | #define SCSI_STATUS_INTERMEDIATE 0x10
|
---|
169 | #define SCSI_STATUS_DATA_UNDEROVER_RUN 0x12
|
---|
170 | #define SCSI_STATUS_INTERMEDIATE_CONDITION_MET 0x14
|
---|
171 | #define SCSI_STATUS_RESERVATION_CONFLICT 0x18
|
---|
172 | #define SCSI_STATUS_COMMAND_TERMINATED 0x22
|
---|
173 | #define SCSI_STATUS_QUEUE_FULL 0x28
|
---|
174 | #define SCSI_STATUS_ACA_ACTIVE 0x30
|
---|
175 | #define SCSI_STATUS_TASK_ABORTED 0x40
|
---|
176 |
|
---|
177 | /* Sense data response codes - This is the first byte in the sense data */
|
---|
178 | #define SCSI_SENSE_RESPONSE_CODE_CURR_FIXED 0x70
|
---|
179 | #define SCSI_SENSE_RESPONSE_CODE_DEFERRED_FIXED 0x71
|
---|
180 | #define SCSI_SENSE_RESPONSE_CODE_CURR_DESC 0x72
|
---|
181 | #define SCSI_SENSE_RESPONSE_CODE_DEFERRED_DESC 0x73
|
---|
182 |
|
---|
183 | /* Sense keys */
|
---|
184 | #define SCSI_SENSE_NONE 0
|
---|
185 | #define SCSI_SENSE_RECOVERED_ERROR 1
|
---|
186 | #define SCSI_SENSE_NOT_READY 2
|
---|
187 | #define SCSI_SENSE_MEDIUM_ERROR 3
|
---|
188 | #define SCSI_SENSE_HARDWARE_ERROR 4
|
---|
189 | #define SCSI_SENSE_ILLEGAL_REQUEST 5
|
---|
190 | #define SCSI_SENSE_UNIT_ATTENTION 6
|
---|
191 | #define SCSI_SENSE_DATA_PROTECT 7
|
---|
192 | #define SCSI_SENSE_BLANK_CHECK 8
|
---|
193 | #define SCSI_SENSE_VENDOR_SPECIFIC 9
|
---|
194 | #define SCSI_SENSE_COPY_ABORTED 10
|
---|
195 | #define SCSI_SENSE_ABORTED_COMMAND 11
|
---|
196 | #define SCSI_SENSE_VOLUME_OVERFLOW 13
|
---|
197 | #define SCSI_SENSE_MISCOMPARE 14
|
---|
198 |
|
---|
199 | /* Additional sense bit flags (to be ORed with sense key). */
|
---|
200 | #define SCSI_SENSE_FLAG_FILEMARK 0x80
|
---|
201 | #define SCSI_SENSE_FLAG_EOM 0x40
|
---|
202 | #define SCSI_SENSE_FLAG_ILI 0x20
|
---|
203 |
|
---|
204 | /* Additional sense keys */
|
---|
205 | #define SCSI_ASC_NONE 0x00
|
---|
206 | #define SCSI_ASC_WRITE_ERROR 0x0c
|
---|
207 | #define SCSI_ASC_READ_ERROR 0x11
|
---|
208 | #define SCSI_ASC_ILLEGAL_OPCODE 0x20
|
---|
209 | #define SCSI_ASC_LOGICAL_BLOCK_OOR 0x21
|
---|
210 | #define SCSI_ASC_INV_FIELD_IN_CMD_PACKET 0x24
|
---|
211 | #define SCSI_ASC_WRITE_PROTECTED 0x27
|
---|
212 | #define SCSI_ASC_MEDIUM_MAY_HAVE_CHANGED 0x28
|
---|
213 | #define SCSI_ASC_POWER_ON_RESET_BUS_DEVICE_RESET_OCCURRED 0x29
|
---|
214 | #define SCSI_ASC_MEDIUM_NOT_PRESENT 0x3a
|
---|
215 | #define SCSI_ASC_SAVING_PARAMETERS_NOT_SUPPORTED 0x39
|
---|
216 | #define SCSI_ASC_INVALID_MESSAGE 0x49
|
---|
217 | #define SCSI_ASC_MEDIA_LOAD_OR_EJECT_FAILED 0x53
|
---|
218 | #define SCSI_ASC_LOGICAL_UNIT_DOES_NOT_RESPOND_TO_SELECTION 0x00
|
---|
219 | #define SCSI_ASC_SYSTEM_RESOURCE_FAILURE 0x55
|
---|
220 |
|
---|
221 | /** Additional sense code qualifiers (ASCQ). */
|
---|
222 | /* NB: The ASC/ASCQ combination determines the full meaning. */
|
---|
223 | #define SCSI_ASCQ_SYSTEM_BUFFER_FULL 0x01
|
---|
224 | #define SCSI_ASCQ_POWER_ON_RESET_BUS_DEVICE_RESET_OCCURRED 0x00
|
---|
225 | #define SCSI_ASCQ_END_OF_DATA_DETECTED 0x05
|
---|
226 | #define SCSI_ASCQ_FILEMARK_DETECTED 0x01
|
---|
227 | #define SCSI_ASCQ_EOP_EOM_DETECTED 0x02
|
---|
228 | #define SCSI_ASCQ_SETMARK_DETECTED 0x03
|
---|
229 | #define SCSI_ASCQ_BOP_BOM_DETECTED 0x04
|
---|
230 |
|
---|
231 | /** @name SCSI_INQUIRY
|
---|
232 | * @{
|
---|
233 | */
|
---|
234 |
|
---|
235 | /** Length of the SCSI INQUIRY vendor identifier (without termination). */
|
---|
236 | #define SCSI_INQUIRY_VENDOR_ID_LENGTH 8
|
---|
237 | /** Length of the SCSI INQUIRY product identifier (without termination). */
|
---|
238 | #define SCSI_INQUIRY_PRODUCT_ID_LENGTH 16
|
---|
239 | /** Length of the SCSI INQUIRY revision identifier (without termination). */
|
---|
240 | #define SCSI_INQUIRY_REVISION_LENGTH 4
|
---|
241 |
|
---|
242 | #pragma pack(1)
|
---|
243 | typedef struct SCSIINQUIRYCDB
|
---|
244 | {
|
---|
245 | unsigned u8Cmd : 8;
|
---|
246 | unsigned fEVPD : 1;
|
---|
247 | unsigned u4Reserved : 4;
|
---|
248 | unsigned u3LUN : 3;
|
---|
249 | unsigned u8PageCode : 8;
|
---|
250 | unsigned u8Reserved : 8;
|
---|
251 | uint8_t cbAlloc;
|
---|
252 | uint8_t u8Control;
|
---|
253 | } SCSIINQUIRYCDB;
|
---|
254 | #pragma pack()
|
---|
255 | AssertCompileSize(SCSIINQUIRYCDB, 6);
|
---|
256 | typedef SCSIINQUIRYCDB *PSCSIINQUIRYCDB;
|
---|
257 | typedef const SCSIINQUIRYCDB *PCSCSIINQUIRYCDB;
|
---|
258 |
|
---|
259 | #pragma pack(1)
|
---|
260 | typedef struct SCSIINQUIRYDATA
|
---|
261 | {
|
---|
262 | unsigned u5PeripheralDeviceType : 5; /**< 0x00 / 00 */
|
---|
263 | unsigned u3PeripheralQualifier : 3;
|
---|
264 | unsigned u6DeviceTypeModifier : 7; /**< 0x01 */
|
---|
265 | unsigned fRMB : 1;
|
---|
266 | unsigned u3AnsiVersion : 3; /**< 0x02 */
|
---|
267 | unsigned u3EcmaVersion : 3;
|
---|
268 | unsigned u2IsoVersion : 2;
|
---|
269 | unsigned u4ResponseDataFormat : 4; /**< 0x03 */
|
---|
270 | unsigned u2Reserved0 : 2;
|
---|
271 | unsigned fTrmlOP : 1;
|
---|
272 | unsigned fAEC : 1;
|
---|
273 | unsigned cbAdditional : 8; /**< 0x04 */
|
---|
274 | unsigned u8Reserved1 : 8; /**< 0x05 */
|
---|
275 | unsigned u8Reserved2 : 8; /**< 0x06 */
|
---|
276 | unsigned fSftRe : 1; /**< 0x07 */
|
---|
277 | unsigned fCmdQue : 1;
|
---|
278 | unsigned fReserved3 : 1;
|
---|
279 | unsigned fLinked : 1;
|
---|
280 | unsigned fSync : 1;
|
---|
281 | unsigned fWBus16 : 1;
|
---|
282 | unsigned fWBus32 : 1;
|
---|
283 | unsigned fRelAdr : 1;
|
---|
284 | int8_t achVendorId[SCSI_INQUIRY_VENDOR_ID_LENGTH]; /**< 0x08 */
|
---|
285 | int8_t achProductId[SCSI_INQUIRY_PRODUCT_ID_LENGTH]; /**< 0x10 */
|
---|
286 | int8_t achProductLevel[SCSI_INQUIRY_REVISION_LENGTH]; /**< 0x20 */
|
---|
287 | uint8_t abVendorSpecific[20]; /**< 0x24/36 - Optional it seems. */
|
---|
288 | uint8_t abReserved4[40];
|
---|
289 | uint8_t abVendorSpecificParameters[1]; /**< 0x60/96 - Variable size. */
|
---|
290 | } SCSIINQUIRYDATA;
|
---|
291 | #pragma pack()
|
---|
292 | AssertCompileSize(SCSIINQUIRYDATA, 97);
|
---|
293 | typedef SCSIINQUIRYDATA *PSCSIINQUIRYDATA;
|
---|
294 | typedef const SCSIINQUIRYDATA *PCSCSIINQUIRYDATA;
|
---|
295 |
|
---|
296 | #define SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_CONNECTED 0x00
|
---|
297 | #define SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_NOT_CONNECTED_BUT_SUPPORTED 0x01
|
---|
298 | #define SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_NOT_CONNECTED_NOT_SUPPORTED 0x03
|
---|
299 |
|
---|
300 | #define SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_DIRECT_ACCESS 0x00
|
---|
301 | #define SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_SEQUENTIAL_ACCESS 0x01
|
---|
302 | #define SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_CD_DVD 0x05
|
---|
303 | #define SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_UNKNOWN 0x1f
|
---|
304 |
|
---|
305 | /** @} */
|
---|
306 |
|
---|
307 | #if defined(IN_RING3) && (defined(LOG_ENABLED) || defined(RT_STRICT))
|
---|
308 | const char * SCSICmdText(uint8_t uCmd);
|
---|
309 | const char * SCSISenseText(uint8_t uSense);
|
---|
310 | const char * SCSISenseExtText(uint8_t uASC, uint8_t uASCQ);
|
---|
311 | int SCSILogModePage(char *pszBuf, size_t cchBuffer, uint8_t *pbModePage,
|
---|
312 | size_t cbModePage);
|
---|
313 | int SCSILogCueSheet(char *pszBuf, size_t cchBuffer, uint8_t *pbCueSheet,
|
---|
314 | size_t cbCueSheet);
|
---|
315 | #endif
|
---|
316 |
|
---|
317 | #endif
|
---|