VirtualBox

source: vbox/trunk/include/VBox/scsi.h@ 9721

Last change on this file since 9721 was 8155, checked in by vboxsync, 17 years ago

The Big Sun Rebranding Header Change

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 20.9 KB
Line 
1/** @file
2 * VirtualBox - SCSI declarations.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___VBox_scsi_h
31#define ___VBox_scsi_h
32
33#include <iprt/assert.h>
34
35
36/**
37 * SCSI command opcode identifiers.
38 *
39 * SCSI-3, so far for CD/DVD Logical Units, from Table 49 of the MMC-3 draft standard.
40 */
41typedef enum SCSICMD
42{
43 SCSI_BLANK = 0xa1,
44 SCSI_CLOSE_TRACK_SESSION = 0x5b,
45 SCSI_ERASE_10 = 0x2c,
46 SCSI_FORMAT_UNIT = 0x04,
47 SCSI_GET_CONFIGURATION = 0x46,
48 SCSI_GET_EVENT_STATUS_NOTIFICATION = 0x4a,
49 SCSI_GET_PERFORMANCE = 0xac,
50 /** Inquiry command. */
51 SCSI_INQUIRY = 0x12,
52 SCSI_LOAD_UNLOAD_MEDIUM = 0xa6,
53 SCSI_MECHANISM_STATUS = 0xbd,
54 SCSI_MODE_SELECT_10 = 0x55,
55 SCSI_MODE_SENSE_10 = 0x5a,
56 SCSI_PAUSE_RESUME = 0x4b,
57 SCSI_PLAY_AUDIO_10 = 0x45,
58 SCSI_PLAY_AUDIO_12 = 0xa5,
59 SCSI_PLAY_AUDIO_MSF = 0x47,
60 SCSI_PREVENT_ALLOW_MEDIUM_REMOVAL = 0x1e,
61 /** Read(10) command. */
62 SCSI_READ_10 = 0x28,
63 SCSI_READ_12 = 0xa8,
64 SCSI_READ_BUFFER = 0x3c,
65 SCSI_READ_BUFFER_CAPACITY = 0x5c,
66 /** Read Capacity(6) command. */
67 SCSI_READ_CAPACITY = 0x25,
68 SCSI_READ_CD = 0xbe,
69 SCSI_READ_CD_MSF = 0xb9,
70 SCSI_READ_DISC_INFORMATION = 0x51,
71 SCSI_READ_DVD_STRUCTURE = 0xad,
72 SCSI_READ_FORMAT_CAPACITIES = 0x23,
73 SCSI_READ_SUBCHANNEL = 0x42,
74 SCSI_READ_TOC_PMA_ATIP = 0x43,
75 SCSI_READ_TRACK_INFORMATION = 0x52,
76 SCSI_REPAIR_TRACK = 0x58,
77 SCSI_REPORT_KEY = 0xa4,
78 SCSI_REQUEST_SENSE = 0x03,
79 SCSI_RESERVE_TRACK = 0x53,
80 SCSI_SCAN = 0xba,
81 SCSI_SEEK_10 = 0x2b,
82 SCSI_SEND_CUE_SHEET = 0x5d,
83 SCSI_SEND_DVD_STRUCTURE = 0xbf,
84 SCSI_SEND_EVENT = 0xa2,
85 SCSI_SEND_KEY = 0xa3,
86 SCSI_SEND_OPC_INFORMATION = 0x54,
87 SCSI_SET_CD_SPEED = 0xbb,
88 SCSI_SET_READ_AHEAD = 0xa7,
89 SCSI_SET_STREAMING = 0xb6,
90 SCSI_START_STOP_UNIT = 0x1b,
91 SCSI_STOP_PLAY_SCAN = 0x4e,
92 /** Synchronize Cache command. */
93 SCSI_SYNCHRONIZE_CACHE = 0x35,
94 SCSI_TEST_UNIT_READY = 0x00,
95 SCSI_VERIFY_10 = 0x2f,
96 /** Write(10) command. */
97 SCSI_WRITE_10 = 0x2a,
98 SCSI_WRITE_12 = 0xaa,
99 SCSI_WRITE_AND_VERIFY_10 = 0x2e,
100 SCSI_WRITE_BUFFER = 0x3b,
101
102 /** Mode Sense(6) command */
103 SCSI_MODE_SENSE_6 = 0x1a,
104 /** Report LUNs command. */
105 SCSI_REPORT_LUNS = 0xa0,
106 /** Rezero Unit command. Obsolete for ages now, but used by cdrecord. */
107 SCSI_REZERO_UNIT = 0x01
108} SCSICMD;
109
110#ifdef DEBUG
111static const char * const g_apszSCSICmdNames[256] =
112{
113 "TEST UNIT READY", /* 0x00 */
114 "REZERO UNIT", /* 0x01 */
115 "", /* 0x02 */
116 "REQUEST SENSE", /* 0x03 */
117 "FORMAT UNIT", /* 0x04 */
118 "READ BLOCK LIMITS", /* 0x05 */
119 "", /* 0x06 */
120 "REASSIGN BLOCKS", /* 0x07 */
121 "READ (6)", /* 0x08 */
122 "", /* 0x09 */
123 "WRITE (6)", /* 0x0a */
124 "SEEK (6)", /* 0x0b */
125 "", /* 0x0c */
126 "", /* 0x0d */
127 "", /* 0x0e */
128 "READ REVERSE (6)", /* 0x0f */
129 "READ FILEMARKS (6)", /* 0x10 */
130 "SPACE (6)", /* 0x11 */
131 "INQUIRY", /* 0x12 */
132 "VERIFY (6)", /* 0x13 */
133 "RECOVER BUFFERED DATA", /* 0x14 */
134 "MODE SELECT (6)", /* 0x15 */
135 "RESERVE (6)", /* 0x16 */
136 "RELEASE (6)", /* 0x17 */
137 "COPY", /* 0x18 */
138 "ERASE (6)", /* 0x19 */
139 "MODE SENSE (6)", /* 0x1a */
140 "START STOP UNIT", /* 0x1b */
141 "RECEIVE DIAGNOSTIC RESULTS", /* 0x1c */
142 "SEND DIAGNOSTIC", /* 0x1d */
143 "PREVENT ALLOW MEDIUM REMOVAL", /* 0x1e */
144 "", /* 0x1f */
145 "", /* 0x20 */
146 "", /* 0x21 */
147 "", /* 0x22 */
148 "READ FORMAT CAPACITIES", /* 0x23 */
149 "SET WINDOW", /* 0x24 */
150 "READ CAPACITY", /* 0x25 */
151 "", /* 0x26 */
152 "", /* 0x27 */
153 "READ (10)", /* 0x28 */
154 "READ GENERATION", /* 0x29 */
155 "WRITE (10)", /* 0x2a */
156 "SEEK (10)", /* 0x2b */
157 "ERASE (10)", /* 0x2c */
158 "READ UPDATED BLOCK", /* 0x2d */
159 "WRITE AND VERIFY (10)", /* 0x2e */
160 "VERIFY (10)", /* 0x2f */
161 "SEARCH DATA HIGH (10)", /* 0x30 */
162 "SEARCH DATA EQUAL (10)", /* 0x31 */
163 "SEARCH DATA LOW (10)", /* 0x32 */
164 "SET LIMITS (10)", /* 0x33 */
165 "PRE-FETCH (10)", /* 0x34 */
166 "SYNCHRONIZE CACHE (10)", /* 0x35 */
167 "LOCK UNLOCK CACHE (10)", /* 0x36 */
168 "READ DEFECT DATA (10)", /* 0x37 */
169 "MEDIUM SCAN", /* 0x38 */
170 "COMPARE", /* 0x39 */
171 "COPY AND VERIFY", /* 0x3a */
172 "WRITE BUFFER", /* 0x3b */
173 "READ BUFFER", /* 0x3c */
174 "UPDATE BLOCK", /* 0x3d */
175 "READ LONG (10)", /* 0x3e */
176 "WRITE LONG (10)", /* 0x3f */
177 "CHANGE DEFINITION", /* 0x40 */
178 "WRITE SAME (10)", /* 0x41 */
179 "READ SUBCHANNEL", /* 0x42 */
180 "READ TOC/PMA/ATIP", /* 0x43 */
181 "REPORT DENSITY SUPPORT", /* 0x44 */
182 "PLAY AUDIO (10)", /* 0x45 */
183 "GET CONFIGURATION", /* 0x46 */
184 "PLAY AUDIO MSF", /* 0x47 */
185 "", /* 0x48 */
186 "", /* 0x49 */
187 "GET EVENT STATUS NOTIFICATION", /* 0x4a */
188 "PAUSE/RESUME", /* 0x4b */
189 "LOG SELECT", /* 0x4c */
190 "LOG SENSE", /* 0x4d */
191 "STOP PLAY/SCAN", /* 0x4e */
192 "", /* 0x4f */
193 "XDWRITE (10)", /* 0x50 */
194 "READ DISC INFORMATION", /* 0x51 */
195 "READ TRACK INFORMATION", /* 0x52 */
196 "RESERVE TRACK", /* 0x53 */
197 "SEND OPC INFORMATION", /* 0x54 */
198 "MODE SELECT (10)", /* 0x55 */
199 "RESERVE (10)", /* 0x56 */
200 "RELEASE (10)", /* 0x57 */
201 "REPAIR TRACK", /* 0x58 */
202 "", /* 0x59 */
203 "MODE SENSE (10)", /* 0x5a */
204 "CLOSE TRACK/SESSION", /* 0x5b */
205 "READ BUFFER CAPACITY", /* 0x5c */
206 "SEND CUE SHEET", /* 0x5d */
207 "PERSISTENT RESERVE IN", /* 0x5e */
208 "PERSISTENT RESERVE OUT", /* 0x5f */
209 "", /* 0x60 */
210 "", /* 0x61 */
211 "", /* 0x62 */
212 "", /* 0x63 */
213 "", /* 0x64 */
214 "", /* 0x65 */
215 "", /* 0x66 */
216 "", /* 0x67 */
217 "", /* 0x68 */
218 "", /* 0x69 */
219 "", /* 0x6a */
220 "", /* 0x6b */
221 "", /* 0x6c */
222 "", /* 0x6d */
223 "", /* 0x6e */
224 "", /* 0x6f */
225 "", /* 0x70 */
226 "", /* 0x71 */
227 "", /* 0x72 */
228 "", /* 0x73 */
229 "", /* 0x74 */
230 "", /* 0x75 */
231 "", /* 0x76 */
232 "", /* 0x77 */
233 "", /* 0x78 */
234 "", /* 0x79 */
235 "", /* 0x7a */
236 "", /* 0x7b */
237 "", /* 0x7c */
238 "", /* 0x7d */
239 "", /* 0x7e */
240 "", /* 0x7f */
241 "WRITE FILEMARKS (16)", /* 0x80 */
242 "READ REVERSE (16)", /* 0x81 */
243 "REGENERATE (16)", /* 0x82 */
244 "EXTENDED COPY", /* 0x83 */
245 "RECEIVE COPY RESULTS", /* 0x84 */
246 "ATA COMMAND PASS THROUGH (16)", /* 0x85 */
247 "ACCESS CONTROL IN", /* 0x86 */
248 "ACCESS CONTROL OUT", /* 0x87 */
249 "READ (16)", /* 0x88 */
250 "", /* 0x89 */
251 "WRITE(16)", /* 0x8a */
252 "", /* 0x8b */
253 "READ ATTRIBUTE", /* 0x8c */
254 "WRITE ATTRIBUTE", /* 0x8d */
255 "WRITE AND VERIFY (16)", /* 0x8e */
256 "VERIFY (16)", /* 0x8f */
257 "PRE-FETCH (16)", /* 0x90 */
258 "SYNCHRONIZE CACHE (16)", /* 0x91 */
259 "LOCK UNLOCK CACHE (16)", /* 0x92 */
260 "WRITE SAME (16)", /* 0x93 */
261 "", /* 0x94 */
262 "", /* 0x95 */
263 "", /* 0x96 */
264 "", /* 0x97 */
265 "", /* 0x98 */
266 "", /* 0x99 */
267 "", /* 0x9a */
268 "", /* 0x9b */
269 "", /* 0x9c */
270 "", /* 0x9d */
271 "SERVICE ACTION IN (16)", /* 0x9e */
272 "SERVICE ACTION OUT (16)", /* 0x9f */
273 "REPORT LUNS", /* 0xa0 */
274 "BLANK", /* 0xa1 */
275 "SEND EVENT", /* 0xa2 */
276 "SEND KEY", /* 0xa3 */
277 "REPORT KEY", /* 0xa4 */
278 "PLAY AUDIO (12)", /* 0xa5 */
279 "LOAD/UNLOAD MEDIUM", /* 0xa6 */
280 "SET READ AHEAD", /* 0xa7 */
281 "READ (12)", /* 0xa8 */
282 "SERVICE ACTION OUT (12)", /* 0xa9 */
283 "WRITE (12)", /* 0xaa */
284 "SERVICE ACTION IN (12)", /* 0xab */
285 "GET PERFORMANCE", /* 0xac */
286 "READ DVD STRUCTURE", /* 0xad */
287 "WRITE AND VERIFY (12)", /* 0xae */
288 "VERIFY (12)", /* 0xaf */
289 "SEARCH DATA HIGH (12)", /* 0xb0 */
290 "SEARCH DATA EQUAL (12)", /* 0xb1 */
291 "SEARCH DATA LOW (12)", /* 0xb2 */
292 "SET LIMITS (12)", /* 0xb3 */
293 "READ ELEMENT STATUS ATTACHED", /* 0xb4 */
294 "REQUEST VOLUME ELEMENT ADDRESS", /* 0xb5 */
295 "SET STREAMING", /* 0xb6 */
296 "READ DEFECT DATA (12)", /* 0xb7 */
297 "READ ELEMENT STATUS", /* 0xb8 */
298 "READ CD MSF", /* 0xb9 */
299 "SCAN", /* 0xba */
300 "SET CD SPEED", /* 0xbb */
301 "SPARE (IN)", /* 0xbc */
302 "MECHANISM STATUS", /* 0xbd */
303 "READ CD", /* 0xbe */
304 "SEND DVD STRUCTURE", /* 0xbf */
305 "", /* 0xc0 */
306 "", /* 0xc1 */
307 "", /* 0xc2 */
308 "", /* 0xc3 */
309 "", /* 0xc4 */
310 "", /* 0xc5 */
311 "", /* 0xc6 */
312 "", /* 0xc7 */
313 "", /* 0xc8 */
314 "", /* 0xc9 */
315 "", /* 0xca */
316 "", /* 0xcb */
317 "", /* 0xcc */
318 "", /* 0xcd */
319 "", /* 0xce */
320 "", /* 0xcf */
321 "", /* 0xd0 */
322 "", /* 0xd1 */
323 "", /* 0xd2 */
324 "", /* 0xd3 */
325 "", /* 0xd4 */
326 "", /* 0xd5 */
327 "", /* 0xd6 */
328 "", /* 0xd7 */
329 "", /* 0xd8 */
330 "", /* 0xd9 */
331 "", /* 0xda */
332 "", /* 0xdb */
333 "", /* 0xdc */
334 "", /* 0xdd */
335 "", /* 0xde */
336 "", /* 0xdf */
337 "", /* 0xe0 */
338 "", /* 0xe1 */
339 "", /* 0xe2 */
340 "", /* 0xe3 */
341 "", /* 0xe4 */
342 "", /* 0xe5 */
343 "", /* 0xe6 */
344 "", /* 0xe7 */
345 "", /* 0xe8 */
346 "", /* 0xe9 */
347 "", /* 0xea */
348 "", /* 0xeb */
349 "", /* 0xec */
350 "", /* 0xed */
351 "", /* 0xee */
352 "", /* 0xef */
353 "", /* 0xf0 */
354 "", /* 0xf1 */
355 "", /* 0xf2 */
356 "", /* 0xf3 */
357 "", /* 0xf4 */
358 "", /* 0xf5 */
359 "", /* 0xf6 */
360 "", /* 0xf7 */
361 "", /* 0xf8 */
362 "", /* 0xf9 */
363 "", /* 0xfa */
364 "", /* 0xfb */
365 "", /* 0xfc */
366 "", /* 0xfd */
367 "", /* 0xfe */
368 "" /* 0xff */
369};
370#endif /* DEBUG */
371
372/* Mode page codes for mode sense/select commands. */
373#define SCSI_MODEPAGE_ERROR_RECOVERY 0x01
374#define SCSI_MODEPAGE_WRITE_PARAMETER 0x05
375#define SCSI_MODEPAGE_CD_STATUS 0x2a
376
377
378/* Page control codes. */
379#define SCSI_PAGECONTROL_CURRENT 0x00
380#define SCSI_PAGECONTROL_CHANGEABLE 0x01
381#define SCSI_PAGECONTROL_DEFAULT 0x02
382#define SCSI_PAGECONTROL_SAVED 0x03
383
384
385#define SCSI_SENSE_NONE 0
386#define SCSI_SENSE_NOT_READY 2
387#define SCSI_SENSE_MEDIUM_ERROR 3
388#define SCSI_SENSE_ILLEGAL_REQUEST 5
389#define SCSI_SENSE_UNIT_ATTENTION 6
390
391
392#define SCSI_ASC_NONE 0x00
393#define SCSI_ASC_READ_ERROR 0x11
394#define SCSI_ASC_ILLEGAL_OPCODE 0x20
395#define SCSI_ASC_LOGICAL_BLOCK_OOR 0x21
396#define SCSI_ASC_INV_FIELD_IN_CMD_PACKET 0x24
397#define SCSI_ASC_MEDIUM_MAY_HAVE_CHANGED 0x28
398#define SCSI_ASC_MEDIUM_NOT_PRESENT 0x3a
399#define SCSI_ASC_SAVING_PARAMETERS_NOT_SUPPORTED 0x39
400#define SCSI_ASC_MEDIA_LOAD_OR_EJECT_FAILED 0x53
401
402
403/** @name SCSI_INQUIRY
404 * @{
405 */
406#pragma pack(1)
407typedef struct SCSIINQUIRYCDB
408{
409 unsigned u8Cmd : 8;
410 unsigned fEVPD : 1;
411 unsigned u4Reserved : 4;
412 unsigned u3LUN : 3;
413 unsigned u8PageCode : 8;
414 unsigned u8Reserved : 8;
415 uint8_t cbAlloc;
416 uint8_t u8Control;
417} SCSIINQUIRYCDB;
418#pragma pack()
419AssertCompileSize(SCSIINQUIRYCDB, 6);
420typedef SCSIINQUIRYCDB *PSCSIINQUIRYCDB;
421typedef const SCSIINQUIRYCDB *PCSCSIINQUIRYCDB;
422
423#pragma pack(1)
424typedef struct SCSIINQUIRYDATA
425{
426 unsigned u5PeripherialDeviceType : 5; /**< 0x00 / 00 */
427 unsigned u3PeripherialQualifier : 3;
428 unsigned u6DeviceTypeModifier : 7; /**< 0x01 */
429 unsigned fRMB : 1;
430 unsigned u3AnsiVersion : 3; /**< 0x02 */
431 unsigned u3EcmaVersion : 3;
432 unsigned u2IsoVersion : 2;
433 unsigned u4ResponseDataFormat : 4; /**< 0x03 */
434 unsigned u2Reserved0 : 2;
435 unsigned fTrmlOP : 1;
436 unsigned fAEC : 1;
437 unsigned cbAdditional : 8; /**< 0x04 */
438 unsigned u8Reserved1 : 8; /**< 0x05 */
439 unsigned u8Reserved2 : 8; /**< 0x06 */
440 unsigned fSftRe : 1; /**< 0x07 */
441 unsigned fCmdQue : 1;
442 unsigned fReserved3 : 1;
443 unsigned fLinked : 1;
444 unsigned fSync : 1;
445 unsigned fWBus16 : 1;
446 unsigned fWBus32 : 1;
447 unsigned fRelAdr : 1;
448 int8_t achVendorId[8]; /**< 0x08 */
449 int8_t achProductId[16]; /**< 0x10 */
450 int8_t achProductLevel[4]; /**< 0x20 */
451 uint8_t abVendorSpecific[20]; /**< 0x24/36 - Optional it seems. */
452 uint8_t abReserved4[40];
453 uint8_t abVendorSpecificParameters[1]; /**< 0x60/96 - Variable size. */
454} SCSIINQUIRYDATA;
455#pragma pack()
456AssertCompileSize(SCSIINQUIRYDATA, 97);
457typedef SCSIINQUIRYDATA *PSCSIINQUIRYDATA;
458typedef const SCSIINQUIRYDATA *PCSCSIINQUIRYDATA;
459/** @} */
460
461#endif
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