VirtualBox

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

Last change on this file since 27084 was 26182, checked in by vboxsync, 15 years ago

UsbMsd: More hacking.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.2 KB
Line 
1/** @file
2 * VirtualBox - SCSI declarations. (DEV,+)
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#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 */
47typedef 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_STOP_PLAY_SCAN = 0x4e,
98 /** Synchronize Cache command. */
99 SCSI_SYNCHRONIZE_CACHE = 0x35,
100 SCSI_TEST_UNIT_READY = 0x00,
101 SCSI_VERIFY_10 = 0x2f,
102 /** Write(10) command. */
103 SCSI_WRITE_10 = 0x2a,
104 SCSI_WRITE_12 = 0xaa,
105 SCSI_WRITE_AND_VERIFY_10 = 0x2e,
106 SCSI_WRITE_BUFFER = 0x3b,
107
108 /** Mode Sekect(6) command */
109 SCSI_MODE_SELECT_6 = 0x15,
110 /** Mode Sense(6) command */
111 SCSI_MODE_SENSE_6 = 0x1a,
112 /** Report LUNs command. */
113 SCSI_REPORT_LUNS = 0xa0,
114 SCSI_REPORT_DENSITY = 0x44,
115 /** Rezero Unit command. Obsolete for ages now, but used by cdrecord. */
116 SCSI_REZERO_UNIT = 0x01,
117 SCSI_SERVICE_ACTION_IN_16 = 0x9e,
118 SCSI_READ_16 = 0x88,
119 SCSI_WRITE_16 = 0x8a,
120 SCSI_READ_6 = 0x08,
121 SCSI_WRITE_6 = 0x0a,
122 SCSI_LOG_SENSE = 0x4d
123} SCSICMD;
124
125/**
126 * Service action in opcoe identifiers
127 */
128typedef enum SCSISVCACTIONIN
129{
130 SCSI_SVC_ACTION_IN_READ_CAPACITY_16 = 0x10
131} SCSISVCACTIONIN;
132
133/* Mode page codes for mode sense/select commands. */
134#define SCSI_MODEPAGE_ERROR_RECOVERY 0x01
135#define SCSI_MODEPAGE_WRITE_PARAMETER 0x05
136#define SCSI_MODEPAGE_CD_STATUS 0x2a
137
138
139/* Page control codes. */
140#define SCSI_PAGECONTROL_CURRENT 0x00
141#define SCSI_PAGECONTROL_CHANGEABLE 0x01
142#define SCSI_PAGECONTROL_DEFAULT 0x02
143#define SCSI_PAGECONTROL_SAVED 0x03
144
145
146/* Status codes */
147#define SCSI_STATUS_OK 0x00
148#define SCSI_STATUS_CHECK_CONDITION 0x02
149#define SCSI_STATUS_CONDITION_MET 0x04
150#define SCSI_STATUS_BUSY 0x08
151#define SCSI_STATUS_INTERMEDIATE 0x10
152#define SCSI_STATUS_DATA_UNDEROVER_RUN 0x12
153#define SCSI_STATUS_INTERMEDIATE_CONDITION_MET 0x14
154#define SCSI_STATUS_RESERVATION_CONFLICT 0x18
155#define SCSI_STATUS_COMMAND_TERMINATED 0x22
156#define SCSI_STATUS_QUEUE_FULL 0x28
157#define SCSI_STATUS_ACA_ACTIVE 0x30
158#define SCSI_STATUS_TASK_ABORTED 0x40
159
160/* Sense data response codes - This is the first byte in the sense data */
161#define SCSI_SENSE_RESPONSE_CODE_CURR_FIXED 0x70
162#define SCSI_SENSE_RESPONSE_CODE_DEFERRED_FIXED 0x71
163#define SCSI_SENSE_RESPONSE_CODE_CURR_DESC 0x72
164#define SCSI_SENSE_RESPONSE_CODE_DEFERRED_DESC 0x73
165
166/* Sense keys */
167#define SCSI_SENSE_NONE 0
168#define SCSI_SENSE_RECOVERED_ERROR 1
169#define SCSI_SENSE_NOT_READY 2
170#define SCSI_SENSE_MEDIUM_ERROR 3
171#define SCSI_SENSE_HARDWARE_ERROR 4
172#define SCSI_SENSE_ILLEGAL_REQUEST 5
173#define SCSI_SENSE_UNIT_ATTENTION 6
174#define SCSI_SENSE_DATA_PROTECT 7
175#define SCSI_SENSE_BLANK_CHECK 8
176#define SCSI_SENSE_VENDOR_SPECIFIC 9
177#define SCSI_SENSE_COPY_ABORTED 10
178#define SCSI_SENSE_ABORTED_COMMAND 11
179#define SCSI_SENSE_VOLUME_OVERFLOW 13
180#define SCSI_SENSE_MISCOMPARE 14
181
182
183/* additional sense keys */
184#define SCSI_ASC_NONE 0x00
185#define SCSI_ASC_READ_ERROR 0x11
186#define SCSI_ASC_ILLEGAL_OPCODE 0x20
187#define SCSI_ASC_LOGICAL_BLOCK_OOR 0x21
188#define SCSI_ASC_INV_FIELD_IN_CMD_PACKET 0x24
189#define SCSI_ASC_MEDIUM_MAY_HAVE_CHANGED 0x28
190#define SCSI_ASC_MEDIUM_NOT_PRESENT 0x3a
191#define SCSI_ASC_SAVING_PARAMETERS_NOT_SUPPORTED 0x39
192#define SCSI_ASC_INVALID_MESSAGE 0x49
193#define SCSI_ASC_MEDIA_LOAD_OR_EJECT_FAILED 0x53
194#define SCSI_ASC_LOGICAL_UNIT_DOES_NOT_RESPOND_TO_SELECTION 0x00
195
196/** @name SCSI_INQUIRY
197 * @{
198 */
199#pragma pack(1)
200typedef struct SCSIINQUIRYCDB
201{
202 unsigned u8Cmd : 8;
203 unsigned fEVPD : 1;
204 unsigned u4Reserved : 4;
205 unsigned u3LUN : 3;
206 unsigned u8PageCode : 8;
207 unsigned u8Reserved : 8;
208 uint8_t cbAlloc;
209 uint8_t u8Control;
210} SCSIINQUIRYCDB;
211#pragma pack()
212AssertCompileSize(SCSIINQUIRYCDB, 6);
213typedef SCSIINQUIRYCDB *PSCSIINQUIRYCDB;
214typedef const SCSIINQUIRYCDB *PCSCSIINQUIRYCDB;
215
216#pragma pack(1)
217typedef struct SCSIINQUIRYDATA
218{
219 unsigned u5PeripheralDeviceType : 5; /**< 0x00 / 00 */
220 unsigned u3PeripheralQualifier : 3;
221 unsigned u6DeviceTypeModifier : 7; /**< 0x01 */
222 unsigned fRMB : 1;
223 unsigned u3AnsiVersion : 3; /**< 0x02 */
224 unsigned u3EcmaVersion : 3;
225 unsigned u2IsoVersion : 2;
226 unsigned u4ResponseDataFormat : 4; /**< 0x03 */
227 unsigned u2Reserved0 : 2;
228 unsigned fTrmlOP : 1;
229 unsigned fAEC : 1;
230 unsigned cbAdditional : 8; /**< 0x04 */
231 unsigned u8Reserved1 : 8; /**< 0x05 */
232 unsigned u8Reserved2 : 8; /**< 0x06 */
233 unsigned fSftRe : 1; /**< 0x07 */
234 unsigned fCmdQue : 1;
235 unsigned fReserved3 : 1;
236 unsigned fLinked : 1;
237 unsigned fSync : 1;
238 unsigned fWBus16 : 1;
239 unsigned fWBus32 : 1;
240 unsigned fRelAdr : 1;
241 int8_t achVendorId[8]; /**< 0x08 */
242 int8_t achProductId[16]; /**< 0x10 */
243 int8_t achProductLevel[4]; /**< 0x20 */
244 uint8_t abVendorSpecific[20]; /**< 0x24/36 - Optional it seems. */
245 uint8_t abReserved4[40];
246 uint8_t abVendorSpecificParameters[1]; /**< 0x60/96 - Variable size. */
247} SCSIINQUIRYDATA;
248#pragma pack()
249AssertCompileSize(SCSIINQUIRYDATA, 97);
250typedef SCSIINQUIRYDATA *PSCSIINQUIRYDATA;
251typedef const SCSIINQUIRYDATA *PCSCSIINQUIRYDATA;
252
253#define SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_CONNECTED 0x00
254#define SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_NOT_CONNECTED_BUT_SUPPORTED 0x01
255#define SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_NOT_CONNECTED_NOT_SUPPORTED 0x03
256
257#define SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_DIRECT_ACCESS 0x00
258#define SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_SEQUENTIAL_ACCESS 0x01
259#define SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_CD_DVD 0x05
260#define SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_UNKNOWN 0x1f
261
262/** @} */
263
264#if defined(IN_RING3) && (defined(LOG_ENABLED) || defined(RT_STRICT))
265const char * SCSICmdText(uint8_t uCmd);
266const char * SCSISenseText(uint8_t uSense);
267const char * SCSISenseExtText(uint8_t uASC, uint8_t uASCQ);
268#endif
269
270#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