1 | /** @file
|
---|
2 | Support for SCSI-2 standard
|
---|
3 |
|
---|
4 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
---|
5 | This program and the accompanying materials
|
---|
6 | are licensed and made available under the terms and conditions of the BSD License
|
---|
7 | which accompanies this distribution. The full text of the license may be found at
|
---|
8 | http://opensource.org/licenses/bsd-license.php
|
---|
9 |
|
---|
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
---|
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
---|
12 |
|
---|
13 | **/
|
---|
14 |
|
---|
15 | #ifndef __SCSI_H__
|
---|
16 | #define __SCSI_H__
|
---|
17 |
|
---|
18 | //
|
---|
19 | // SCSI command OP Code
|
---|
20 | //
|
---|
21 | //
|
---|
22 | // Commands for all device types
|
---|
23 | //
|
---|
24 | #define EFI_SCSI_OP_CHANGE_DEFINITION 0x40
|
---|
25 | #define EFI_SCSI_OP_COMPARE 0x39
|
---|
26 | #define EFI_SCSI_OP_COPY 0x18
|
---|
27 | #define EFI_SCSI_OP_COPY_VERIFY 0x3a
|
---|
28 | #define EFI_SCSI_OP_INQUIRY 0x12
|
---|
29 | #define EFI_SCSI_OP_LOG_SELECT 0x4c
|
---|
30 | #define EFI_SCSI_OP_LOG_SENSE 0x4d
|
---|
31 | #define EFI_SCSI_OP_MODE_SEL6 0x15
|
---|
32 | #define EFI_SCSI_OP_MODE_SEL10 0x55
|
---|
33 | #define EFI_SCSI_OP_MODE_SEN6 0x1a
|
---|
34 | #define EFI_SCSI_OP_MODE_SEN10 0x5a
|
---|
35 | #define EFI_SCSI_OP_READ_BUFFER 0x3c
|
---|
36 | #define EFI_SCSI_OP_RECEIVE_DIAG 0x1c
|
---|
37 | #define EFI_SCSI_OP_REQUEST_SENSE 0x03
|
---|
38 | #define EFI_SCSI_OP_SEND_DIAG 0x1d
|
---|
39 | #define EFI_SCSI_OP_TEST_UNIT_READY 0x00
|
---|
40 | #define EFI_SCSI_OP_WRITE_BUFF 0x3b
|
---|
41 |
|
---|
42 | //
|
---|
43 | // Additional commands for Direct Access Devices
|
---|
44 | //
|
---|
45 | #define EFI_SCSI_OP_FORMAT 0x04
|
---|
46 | #define EFI_SCSI_OP_LOCK_UN_CACHE 0x36
|
---|
47 | #define EFI_SCSI_OP_PREFETCH 0x34
|
---|
48 | #define EFI_SCSI_OP_MEDIA_REMOVAL 0x1e
|
---|
49 | #define EFI_SCSI_OP_READ6 0x08
|
---|
50 | #define EFI_SCSI_OP_READ10 0x28
|
---|
51 | #define EFI_SCSI_OP_READ16 0x88
|
---|
52 | #define EFI_SCSI_OP_READ_CAPACITY 0x25
|
---|
53 | #define EFI_SCSI_OP_READ_CAPACITY16 0x9e
|
---|
54 | #define EFI_SCSI_OP_READ_DEFECT 0x37
|
---|
55 | #define EFI_SCSI_OP_READ_LONG 0x3e
|
---|
56 | #define EFI_SCSI_OP_REASSIGN_BLK 0x07
|
---|
57 | #define EFI_SCSI_OP_RELEASE 0x17
|
---|
58 | #define EFI_SCSI_OP_REZERO 0x01
|
---|
59 | #define EFI_SCSI_OP_SEARCH_DATA_E 0x31
|
---|
60 | #define EFI_SCSI_OP_SEARCH_DATA_H 0x30
|
---|
61 | #define EFI_SCSI_OP_SEARCH_DATA_L 0x32
|
---|
62 | #define EFI_SCSI_OP_SEEK6 0x0b
|
---|
63 | #define EFI_SCSI_OP_SEEK10 0x2b
|
---|
64 | #define EFI_SCSI_OP_SEND_DIAG 0x1d
|
---|
65 | #define EFI_SCSI_OP_SET_LIMIT 0x33
|
---|
66 | #define EFI_SCSI_OP_START_STOP_UNIT 0x1b
|
---|
67 | #define EFI_SCSI_OP_SYNC_CACHE 0x35
|
---|
68 | #define EFI_SCSI_OP_VERIFY 0x2f
|
---|
69 | #define EFI_SCSI_OP_WRITE6 0x0a
|
---|
70 | #define EFI_SCSI_OP_WRITE10 0x2a
|
---|
71 | #define EFI_SCSI_OP_WRITE16 0x8a
|
---|
72 | #define EFI_SCSI_OP_WRITE_VERIFY 0x2e
|
---|
73 | #define EFI_SCSI_OP_WRITE_LONG 0x3f
|
---|
74 | #define EFI_SCSI_OP_WRITE_SAME 0x41
|
---|
75 |
|
---|
76 | //
|
---|
77 | // Additional commands for Sequential Access Devices
|
---|
78 | //
|
---|
79 | #define EFI_SCSI_OP_ERASE 0x19
|
---|
80 | #define EFI_SCSI_OP_LOAD_UNLOAD 0x1b
|
---|
81 | #define EFI_SCSI_OP_LOCATE 0x2b
|
---|
82 | #define EFI_SCSI_OP_READ_BLOCK_LIMIT 0x05
|
---|
83 | #define EFI_SCSI_OP_READ_POS 0x34
|
---|
84 | #define EFI_SCSI_OP_READ_REVERSE 0x0f
|
---|
85 | #define EFI_SCSI_OP_RECOVER_BUF_DATA 0x14
|
---|
86 | #define EFI_SCSI_OP_RESERVE_UNIT 0x16
|
---|
87 | #define EFI_SCSI_OP_REWIND 0x01
|
---|
88 | #define EFI_SCSI_OP_SPACE 0x11
|
---|
89 | #define EFI_SCSI_OP_VERIFY_TAPE 0x13
|
---|
90 | #define EFI_SCSI_OP_WRITE_FILEMARK 0x10
|
---|
91 |
|
---|
92 | //
|
---|
93 | // Additional commands for Printer Devices
|
---|
94 | //
|
---|
95 | #define EFI_SCSI_OP_PRINT 0x0a
|
---|
96 | #define EFI_SCSI_OP_SLEW_PRINT 0x0b
|
---|
97 | #define EFI_SCSI_OP_STOP_PRINT 0x1b
|
---|
98 | #define EFI_SCSI_OP_SYNC_BUFF 0x10
|
---|
99 |
|
---|
100 | //
|
---|
101 | // Additional commands for Processor Devices
|
---|
102 | //
|
---|
103 | #define EFI_SCSI_OP_RECEIVE 0x08
|
---|
104 | #define EFI_SCSI_OP_SEND 0x0a
|
---|
105 |
|
---|
106 | //
|
---|
107 | // Additional commands for Write-Once Devices
|
---|
108 | //
|
---|
109 | #define EFI_SCSI_OP_MEDIUM_SCAN 0x38
|
---|
110 | #define EFI_SCSI_OP_SEARCH_DAT_E10 0x31
|
---|
111 | #define EFI_SCSI_OP_SEARCH_DAT_E12 0xb1
|
---|
112 | #define EFI_SCSI_OP_SEARCH_DAT_H10 0x30
|
---|
113 | #define EFI_SCSI_OP_SEARCH_DAT_H12 0xb0
|
---|
114 | #define EFI_SCSI_OP_SEARCH_DAT_L10 0x32
|
---|
115 | #define EFI_SCSI_OP_SEARCH_DAT_L12 0xb2
|
---|
116 | #define EFI_SCSI_OP_SET_LIMIT10 0x33
|
---|
117 | #define EFI_SCSI_OP_SET_LIMIT12 0xb3
|
---|
118 | #define EFI_SCSI_OP_VERIFY10 0x2f
|
---|
119 | #define EFI_SCSI_OP_VERIFY12 0xaf
|
---|
120 | #define EFI_SCSI_OP_WRITE12 0xaa
|
---|
121 | #define EFI_SCSI_OP_WRITE_VERIFY10 0x2e
|
---|
122 | #define EFI_SCSI_OP_WRITE_VERIFY12 0xae
|
---|
123 |
|
---|
124 | //
|
---|
125 | // Additional commands for CD-ROM Devices
|
---|
126 | //
|
---|
127 | #define EFI_SCSI_OP_PLAY_AUD_10 0x45
|
---|
128 | #define EFI_SCSI_OP_PLAY_AUD_12 0xa5
|
---|
129 | #define EFI_SCSI_OP_PLAY_AUD_MSF 0x47
|
---|
130 | #define EFI_SCSI_OP_PLAY_AUD_TKIN 0x48
|
---|
131 | #define EFI_SCSI_OP_PLAY_TK_REL10 0x49
|
---|
132 | #define EFI_SCSI_OP_PLAY_TK_REL12 0xa9
|
---|
133 | #define EFI_SCSI_OP_READ_CD_CAPACITY 0x25
|
---|
134 | #define EFI_SCSI_OP_READ_HEADER 0x44
|
---|
135 | #define EFI_SCSI_OP_READ_SUB_CHANNEL 0x42
|
---|
136 | #define EFI_SCSI_OP_READ_TOC 0x43
|
---|
137 |
|
---|
138 | //
|
---|
139 | // Additional commands for Scanner Devices
|
---|
140 | //
|
---|
141 | #define EFI_SCSI_OP_GET_DATABUFF_STAT 0x34
|
---|
142 | #define EFI_SCSI_OP_GET_WINDOW 0x25
|
---|
143 | #define EFI_SCSI_OP_OBJECT_POS 0x31
|
---|
144 | #define EFI_SCSI_OP_SCAN 0x1b
|
---|
145 | #define EFI_SCSI_OP_SET_WINDOW 0x24
|
---|
146 |
|
---|
147 | //
|
---|
148 | // Additional commands for Optical Memory Devices
|
---|
149 | //
|
---|
150 | #define EFI_SCSI_OP_UPDATE_BLOCK 0x3d
|
---|
151 |
|
---|
152 | //
|
---|
153 | // Additional commands for Medium Changer Devices
|
---|
154 | //
|
---|
155 | #define EFI_SCSI_OP_EXCHANGE_MEDIUM 0xa6
|
---|
156 | #define EFI_SCSI_OP_INIT_ELEMENT_STAT 0x07
|
---|
157 | #define EFI_SCSI_OP_POS_TO_ELEMENT 0x2b
|
---|
158 | #define EFI_SCSI_OP_REQUEST_VE_ADDR 0xb5
|
---|
159 | #define EFI_SCSI_OP_SEND_VOL_TAG 0xb6
|
---|
160 |
|
---|
161 | //
|
---|
162 | // Additional commands for Communition Devices
|
---|
163 | //
|
---|
164 | #define EFI_SCSI_OP_GET_MESSAGE6 0x08
|
---|
165 | #define EFI_SCSI_OP_GET_MESSAGE10 0x28
|
---|
166 | #define EFI_SCSI_OP_GET_MESSAGE12 0xa8
|
---|
167 | #define EFI_SCSI_OP_SEND_MESSAGE6 0x0a
|
---|
168 | #define EFI_SCSI_OP_SEND_MESSAGE10 0x2a
|
---|
169 | #define EFI_SCSI_OP_SEND_MESSAGE12 0xaa
|
---|
170 |
|
---|
171 | //
|
---|
172 | // SCSI Data Transfer Direction
|
---|
173 | //
|
---|
174 | #define EFI_SCSI_DATA_IN 0
|
---|
175 | #define EFI_SCSI_DATA_OUT 1
|
---|
176 |
|
---|
177 | //
|
---|
178 | // Peripheral Device Type Definitions
|
---|
179 | //
|
---|
180 | #define EFI_SCSI_TYPE_DISK 0x00 ///< Direct-access device (e.g. magnetic disk)
|
---|
181 | #define EFI_SCSI_TYPE_TAPE 0x01 ///< Sequential-access device (e.g. magnetic tape)
|
---|
182 | #define EFI_SCSI_TYPE_PRINTER 0x02 ///< Printer device
|
---|
183 | #define EFI_SCSI_TYPE_PROCESSOR 0x03 ///< Processor device
|
---|
184 | #define EFI_SCSI_TYPE_WORM 0x04 ///< Write-once device (e.g. some optical disks)
|
---|
185 | #define EFI_SCSI_TYPE_CDROM 0x05 ///< CD-ROM device
|
---|
186 | #define EFI_SCSI_TYPE_SCANNER 0x06 ///< Scanner device
|
---|
187 | #define EFI_SCSI_TYPE_OPTICAL 0x07 ///< Optical memory device (e.g. some optical disks)
|
---|
188 | #define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08 ///< Medium changer device (e.g. jukeboxes)
|
---|
189 | #define EFI_SCSI_TYPE_COMMUNICATION 0x09 ///< Communications device
|
---|
190 | #define EFI_SCSI_TYPE_ASCIT8_1 0x0A ///< Defined by ASC IT8 (Graphic arts pre-press devices)
|
---|
191 | #define EFI_SCSI_TYPE_ASCIT8_2 0x0B ///< Defined by ASC IT8 (Graphic arts pre-press devices)
|
---|
192 | //
|
---|
193 | // 0Ch - 1Eh are reserved
|
---|
194 | //
|
---|
195 | #define EFI_SCSI_TYPE_UNKNOWN 0x1F ///< Unknown or no device type
|
---|
196 |
|
---|
197 | //
|
---|
198 | // Page Codes for INQUIRY command
|
---|
199 | //
|
---|
200 | #define EFI_SCSI_PAGE_CODE_SUPPORTED_VPD 0x00
|
---|
201 | #define EFI_SCSI_PAGE_CODE_BLOCK_LIMITS_VPD 0xB0
|
---|
202 |
|
---|
203 | #pragma pack(1)
|
---|
204 | ///
|
---|
205 | /// Standard INQUIRY data format
|
---|
206 | ///
|
---|
207 | typedef struct {
|
---|
208 | UINT8 Peripheral_Type : 5;
|
---|
209 | UINT8 Peripheral_Qualifier : 3;
|
---|
210 | UINT8 DeviceType_Modifier : 7;
|
---|
211 | UINT8 Rmb : 1;
|
---|
212 | UINT8 Version;
|
---|
213 | UINT8 Response_Data_Format;
|
---|
214 | UINT8 Addnl_Length;
|
---|
215 | UINT8 Reserved_5_95[95 - 5 + 1];
|
---|
216 | } EFI_SCSI_INQUIRY_DATA;
|
---|
217 |
|
---|
218 | ///
|
---|
219 | /// Supported VPD Pages VPD page
|
---|
220 | ///
|
---|
221 | typedef struct {
|
---|
222 | UINT8 Peripheral_Type : 5;
|
---|
223 | UINT8 Peripheral_Qualifier : 3;
|
---|
224 | UINT8 PageCode;
|
---|
225 | UINT8 PageLength2;
|
---|
226 | UINT8 PageLength1;
|
---|
227 | UINT8 SupportedVpdPageList[0x100];
|
---|
228 | } EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE;
|
---|
229 |
|
---|
230 | ///
|
---|
231 | /// Block Limits VPD page
|
---|
232 | ///
|
---|
233 | typedef struct {
|
---|
234 | UINT8 Peripheral_Type : 5;
|
---|
235 | UINT8 Peripheral_Qualifier : 3;
|
---|
236 | UINT8 PageCode;
|
---|
237 | UINT8 Reserved_2;
|
---|
238 | UINT8 PageLength;
|
---|
239 | UINT8 Reserved_4_5[2];
|
---|
240 | UINT8 OptimalTransferLengthGranularity2;
|
---|
241 | UINT8 OptimalTransferLengthGranularity1;
|
---|
242 | UINT8 MaximumTransferLength4;
|
---|
243 | UINT8 MaximumTransferLength3;
|
---|
244 | UINT8 MaximumTransferLength2;
|
---|
245 | UINT8 MaximumTransferLength1;
|
---|
246 | UINT8 OptimalTransferLength4;
|
---|
247 | UINT8 OptimalTransferLength3;
|
---|
248 | UINT8 OptimalTransferLength2;
|
---|
249 | UINT8 OptimalTransferLength1;
|
---|
250 | UINT8 MaximumPrefetchXdreadXdwriteTransferLength4;
|
---|
251 | UINT8 MaximumPrefetchXdreadXdwriteTransferLength3;
|
---|
252 | UINT8 MaximumPrefetchXdreadXdwriteTransferLength2;
|
---|
253 | UINT8 MaximumPrefetchXdreadXdwriteTransferLength1;
|
---|
254 | } EFI_SCSI_BLOCK_LIMITS_VPD_PAGE;
|
---|
255 |
|
---|
256 | ///
|
---|
257 | /// Error codes 70h and 71h sense data format
|
---|
258 | ///
|
---|
259 | typedef struct {
|
---|
260 | UINT8 Error_Code : 7;
|
---|
261 | UINT8 Valid : 1;
|
---|
262 | UINT8 Segment_Number;
|
---|
263 | UINT8 Sense_Key : 4;
|
---|
264 | UINT8 Reserved_21 : 1;
|
---|
265 | UINT8 Ili : 1;
|
---|
266 | UINT8 Reserved_22 : 2;
|
---|
267 | UINT8 Information_3_6[4];
|
---|
268 | UINT8 Addnl_Sense_Length; ///< Additional sense length (n-7)
|
---|
269 | UINT8 Vendor_Specific_8_11[4];
|
---|
270 | UINT8 Addnl_Sense_Code; ///< Additional sense code
|
---|
271 | UINT8 Addnl_Sense_Code_Qualifier; ///< Additional sense code qualifier
|
---|
272 | UINT8 Field_Replaceable_Unit_Code; ///< Field replaceable unit code
|
---|
273 | UINT8 Reserved_15_17[3];
|
---|
274 | } EFI_SCSI_SENSE_DATA;
|
---|
275 |
|
---|
276 | ///
|
---|
277 | /// SCSI Disk READ CAPACITY Data
|
---|
278 | ///
|
---|
279 | typedef struct {
|
---|
280 | UINT8 LastLba3;
|
---|
281 | UINT8 LastLba2;
|
---|
282 | UINT8 LastLba1;
|
---|
283 | UINT8 LastLba0;
|
---|
284 | UINT8 BlockSize3;
|
---|
285 | UINT8 BlockSize2;
|
---|
286 | UINT8 BlockSize1;
|
---|
287 | UINT8 BlockSize0;
|
---|
288 | } EFI_SCSI_DISK_CAPACITY_DATA;
|
---|
289 |
|
---|
290 | typedef struct {
|
---|
291 | UINT8 LastLba7;
|
---|
292 | UINT8 LastLba6;
|
---|
293 | UINT8 LastLba5;
|
---|
294 | UINT8 LastLba4;
|
---|
295 | UINT8 LastLba3;
|
---|
296 | UINT8 LastLba2;
|
---|
297 | UINT8 LastLba1;
|
---|
298 | UINT8 LastLba0;
|
---|
299 | UINT8 BlockSize3;
|
---|
300 | UINT8 BlockSize2;
|
---|
301 | UINT8 BlockSize1;
|
---|
302 | UINT8 BlockSize0;
|
---|
303 | UINT8 Protection;
|
---|
304 | UINT8 LogicPerPhysical;
|
---|
305 | UINT8 LowestAlignLogic2;
|
---|
306 | UINT8 LowestAlignLogic1;
|
---|
307 | UINT8 Reserved[16];
|
---|
308 | } EFI_SCSI_DISK_CAPACITY_DATA16;
|
---|
309 |
|
---|
310 |
|
---|
311 | #pragma pack()
|
---|
312 |
|
---|
313 | //
|
---|
314 | // Sense Key
|
---|
315 | //
|
---|
316 | #define EFI_SCSI_SK_NO_SENSE (0x0)
|
---|
317 | #define EFI_SCSI_SK_RECOVERY_ERROR (0x1)
|
---|
318 | #define EFI_SCSI_SK_NOT_READY (0x2)
|
---|
319 | #define EFI_SCSI_SK_MEDIUM_ERROR (0x3)
|
---|
320 | #define EFI_SCSI_SK_HARDWARE_ERROR (0x4)
|
---|
321 | #define EFI_SCSI_SK_ILLEGAL_REQUEST (0x5)
|
---|
322 | #define EFI_SCSI_SK_UNIT_ATTENTION (0x6)
|
---|
323 | #define EFI_SCSI_SK_DATA_PROTECT (0x7)
|
---|
324 | #define EFI_SCSI_SK_BLANK_CHECK (0x8)
|
---|
325 | #define EFI_SCSI_SK_VENDOR_SPECIFIC (0x9)
|
---|
326 | #define EFI_SCSI_SK_RESERVED_A (0xA)
|
---|
327 | #define EFI_SCSI_SK_ABORT (0xB)
|
---|
328 | #define EFI_SCSI_SK_RESERVED_C (0xC)
|
---|
329 | #define EFI_SCSI_SK_OVERFLOW (0xD)
|
---|
330 | #define EFI_SCSI_SK_MISCOMPARE (0xE)
|
---|
331 | #define EFI_SCSI_SK_RESERVED_F (0xF)
|
---|
332 |
|
---|
333 | //
|
---|
334 | // Additional Sense Codes and Sense Code Qualifiers.
|
---|
335 | // Only some frequently used additional sense codes and qualifiers are
|
---|
336 | // defined here. Please refer to SCSI standard for full value definition.
|
---|
337 | //
|
---|
338 | #define EFI_SCSI_ASC_NOT_READY (0x04)
|
---|
339 | #define EFI_SCSI_ASCQ_IN_PROGRESS (0x01)
|
---|
340 |
|
---|
341 | #define EFI_SCSI_ASC_MEDIA_ERR1 (0x10)
|
---|
342 | #define EFI_SCSI_ASC_MEDIA_ERR2 (0x11)
|
---|
343 | #define EFI_SCSI_ASC_MEDIA_ERR3 (0x14)
|
---|
344 | #define EFI_SCSI_ASC_MEDIA_ERR4 (0x30)
|
---|
345 | #define EFI_SCSI_ASC_MEDIA_UPSIDE_DOWN (0x06)
|
---|
346 | #define EFI_SCSI_ASC_INVALID_CMD (0x20)
|
---|
347 | #define EFI_SCSI_ASC_LBA_OUT_OF_RANGE (0x21)
|
---|
348 | #define EFI_SCSI_ASC_INVALID_FIELD (0x24)
|
---|
349 | #define EFI_SCSI_ASC_WRITE_PROTECTED (0x27)
|
---|
350 | #define EFI_SCSI_ASC_MEDIA_CHANGE (0x28)
|
---|
351 | #define EFI_SCSI_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred
|
---|
352 | #define EFI_SCSI_ASC_ILLEGAL_FIELD (0x26)
|
---|
353 | #define EFI_SCSI_ASC_NO_MEDIA (0x3A)
|
---|
354 | #define EFI_SCSI_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)
|
---|
355 |
|
---|
356 | #endif
|
---|