2 Support for SCSI-2 standard
4 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
13 // SCSI command OP Code
16 // Commands for all device types
18 #define EFI_SCSI_OP_CHANGE_DEFINITION 0x40
19 #define EFI_SCSI_OP_COMPARE 0x39
20 #define EFI_SCSI_OP_COPY 0x18
21 #define EFI_SCSI_OP_COPY_VERIFY 0x3a
22 #define EFI_SCSI_OP_INQUIRY 0x12
23 #define EFI_SCSI_OP_LOG_SELECT 0x4c
24 #define EFI_SCSI_OP_LOG_SENSE 0x4d
25 #define EFI_SCSI_OP_MODE_SEL6 0x15
26 #define EFI_SCSI_OP_MODE_SEL10 0x55
27 #define EFI_SCSI_OP_MODE_SEN6 0x1a
28 #define EFI_SCSI_OP_MODE_SEN10 0x5a
29 #define EFI_SCSI_OP_READ_BUFFER 0x3c
30 #define EFI_SCSI_OP_RECEIVE_DIAG 0x1c
31 #define EFI_SCSI_OP_REQUEST_SENSE 0x03
32 #define EFI_SCSI_OP_SEND_DIAG 0x1d
33 #define EFI_SCSI_OP_TEST_UNIT_READY 0x00
34 #define EFI_SCSI_OP_WRITE_BUFF 0x3b
37 // Additional commands for Direct Access Devices
39 #define EFI_SCSI_OP_FORMAT 0x04
40 #define EFI_SCSI_OP_LOCK_UN_CACHE 0x36
41 #define EFI_SCSI_OP_PREFETCH 0x34
42 #define EFI_SCSI_OP_MEDIA_REMOVAL 0x1e
43 #define EFI_SCSI_OP_READ6 0x08
44 #define EFI_SCSI_OP_READ10 0x28
45 #define EFI_SCSI_OP_READ16 0x88
46 #define EFI_SCSI_OP_READ_CAPACITY 0x25
47 #define EFI_SCSI_OP_READ_CAPACITY16 0x9e
48 #define EFI_SCSI_OP_READ_DEFECT 0x37
49 #define EFI_SCSI_OP_READ_LONG 0x3e
50 #define EFI_SCSI_OP_REASSIGN_BLK 0x07
51 #define EFI_SCSI_OP_RELEASE 0x17
52 #define EFI_SCSI_OP_REZERO 0x01
53 #define EFI_SCSI_OP_SEARCH_DATA_E 0x31
54 #define EFI_SCSI_OP_SEARCH_DATA_H 0x30
55 #define EFI_SCSI_OP_SEARCH_DATA_L 0x32
56 #define EFI_SCSI_OP_SEEK6 0x0b
57 #define EFI_SCSI_OP_SEEK10 0x2b
58 #define EFI_SCSI_OP_SEND_DIAG 0x1d
59 #define EFI_SCSI_OP_SET_LIMIT 0x33
60 #define EFI_SCSI_OP_START_STOP_UNIT 0x1b
61 #define EFI_SCSI_OP_SYNC_CACHE 0x35
62 #define EFI_SCSI_OP_VERIFY 0x2f
63 #define EFI_SCSI_OP_WRITE6 0x0a
64 #define EFI_SCSI_OP_WRITE10 0x2a
65 #define EFI_SCSI_OP_WRITE16 0x8a
66 #define EFI_SCSI_OP_WRITE_VERIFY 0x2e
67 #define EFI_SCSI_OP_WRITE_LONG 0x3f
68 #define EFI_SCSI_OP_WRITE_SAME 0x41
69 #define EFI_SCSI_OP_UNMAP 0x42
72 // Additional commands for Sequential Access Devices
74 #define EFI_SCSI_OP_ERASE 0x19
75 #define EFI_SCSI_OP_LOAD_UNLOAD 0x1b
76 #define EFI_SCSI_OP_LOCATE 0x2b
77 #define EFI_SCSI_OP_READ_BLOCK_LIMIT 0x05
78 #define EFI_SCSI_OP_READ_POS 0x34
79 #define EFI_SCSI_OP_READ_REVERSE 0x0f
80 #define EFI_SCSI_OP_RECOVER_BUF_DATA 0x14
81 #define EFI_SCSI_OP_RESERVE_UNIT 0x16
82 #define EFI_SCSI_OP_REWIND 0x01
83 #define EFI_SCSI_OP_SPACE 0x11
84 #define EFI_SCSI_OP_VERIFY_TAPE 0x13
85 #define EFI_SCSI_OP_WRITE_FILEMARK 0x10
88 // Additional commands for Printer Devices
90 #define EFI_SCSI_OP_PRINT 0x0a
91 #define EFI_SCSI_OP_SLEW_PRINT 0x0b
92 #define EFI_SCSI_OP_STOP_PRINT 0x1b
93 #define EFI_SCSI_OP_SYNC_BUFF 0x10
96 // Additional commands for Processor Devices
98 #define EFI_SCSI_OP_RECEIVE 0x08
99 #define EFI_SCSI_OP_SEND 0x0a
102 // Additional commands for Write-Once Devices
104 #define EFI_SCSI_OP_MEDIUM_SCAN 0x38
105 #define EFI_SCSI_OP_SEARCH_DAT_E10 0x31
106 #define EFI_SCSI_OP_SEARCH_DAT_E12 0xb1
107 #define EFI_SCSI_OP_SEARCH_DAT_H10 0x30
108 #define EFI_SCSI_OP_SEARCH_DAT_H12 0xb0
109 #define EFI_SCSI_OP_SEARCH_DAT_L10 0x32
110 #define EFI_SCSI_OP_SEARCH_DAT_L12 0xb2
111 #define EFI_SCSI_OP_SET_LIMIT10 0x33
112 #define EFI_SCSI_OP_SET_LIMIT12 0xb3
113 #define EFI_SCSI_OP_VERIFY10 0x2f
114 #define EFI_SCSI_OP_VERIFY12 0xaf
115 #define EFI_SCSI_OP_WRITE12 0xaa
116 #define EFI_SCSI_OP_WRITE_VERIFY10 0x2e
117 #define EFI_SCSI_OP_WRITE_VERIFY12 0xae
120 // Additional commands for CD-ROM Devices
122 #define EFI_SCSI_OP_PLAY_AUD_10 0x45
123 #define EFI_SCSI_OP_PLAY_AUD_12 0xa5
124 #define EFI_SCSI_OP_PLAY_AUD_MSF 0x47
125 #define EFI_SCSI_OP_PLAY_AUD_TKIN 0x48
126 #define EFI_SCSI_OP_PLAY_TK_REL10 0x49
127 #define EFI_SCSI_OP_PLAY_TK_REL12 0xa9
128 #define EFI_SCSI_OP_READ_CD_CAPACITY 0x25
129 #define EFI_SCSI_OP_READ_HEADER 0x44
130 #define EFI_SCSI_OP_READ_SUB_CHANNEL 0x42
131 #define EFI_SCSI_OP_READ_TOC 0x43
134 // Additional commands for Scanner Devices
136 #define EFI_SCSI_OP_GET_DATABUFF_STAT 0x34
137 #define EFI_SCSI_OP_GET_WINDOW 0x25
138 #define EFI_SCSI_OP_OBJECT_POS 0x31
139 #define EFI_SCSI_OP_SCAN 0x1b
140 #define EFI_SCSI_OP_SET_WINDOW 0x24
143 // Additional commands for Optical Memory Devices
145 #define EFI_SCSI_OP_UPDATE_BLOCK 0x3d
148 // Additional commands for Medium Changer Devices
150 #define EFI_SCSI_OP_EXCHANGE_MEDIUM 0xa6
151 #define EFI_SCSI_OP_INIT_ELEMENT_STAT 0x07
152 #define EFI_SCSI_OP_POS_TO_ELEMENT 0x2b
153 #define EFI_SCSI_OP_REQUEST_VE_ADDR 0xb5
154 #define EFI_SCSI_OP_SEND_VOL_TAG 0xb6
157 // Additional commands for Communition Devices
159 #define EFI_SCSI_OP_GET_MESSAGE6 0x08
160 #define EFI_SCSI_OP_GET_MESSAGE10 0x28
161 #define EFI_SCSI_OP_GET_MESSAGE12 0xa8
162 #define EFI_SCSI_OP_SEND_MESSAGE6 0x0a
163 #define EFI_SCSI_OP_SEND_MESSAGE10 0x2a
164 #define EFI_SCSI_OP_SEND_MESSAGE12 0xaa
167 // Additional commands for Secure Transactions
169 #define EFI_SCSI_OP_SECURITY_PROTOCOL_IN 0xa2
170 #define EFI_SCSI_OP_SECURITY_PROTOCOL_OUT 0xb5
173 // SCSI Data Transfer Direction
175 #define EFI_SCSI_DATA_IN 0
176 #define EFI_SCSI_DATA_OUT 1
179 // Peripheral Device Type Definitions
181 #define EFI_SCSI_TYPE_DISK 0x00 ///< Direct-access device (e.g. magnetic disk)
182 #define EFI_SCSI_TYPE_TAPE 0x01 ///< Sequential-access device (e.g. magnetic tape)
183 #define EFI_SCSI_TYPE_PRINTER 0x02 ///< Printer device
184 #define EFI_SCSI_TYPE_PROCESSOR 0x03 ///< Processor device
185 #define EFI_SCSI_TYPE_WORM 0x04 ///< Write-once device (e.g. some optical disks)
186 #define EFI_SCSI_TYPE_CDROM 0x05 ///< CD/DVD device
187 #define EFI_SCSI_TYPE_SCANNER 0x06 ///< Scanner device (obsolete)
188 #define EFI_SCSI_TYPE_OPTICAL 0x07 ///< Optical memory device (e.g. some optical disks)
189 #define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08 ///< Medium changer device (e.g. jukeboxes)
190 #define EFI_SCSI_TYPE_COMMUNICATION 0x09 ///< Communications device (obsolete)
191 #define EFI_SCSI_TYPE_ASCIT8_1 0x0A ///< Defined by ASC IT8 (Graphic arts pre-press devices)
192 #define EFI_SCSI_TYPE_ASCIT8_2 0x0B ///< Defined by ASC IT8 (Graphic arts pre-press devices)
193 #define EFI_SCSI_TYPE_RAID 0x0C ///< Storage array controller device (e.g., RAID)
194 #define EFI_SCSI_TYPE_SES 0x0D ///< Enclosure services device
195 #define EFI_SCSI_TYPE_RBC 0x0E ///< Simplified direct-access device (e.g., magnetic disk)
196 #define EFI_SCSI_TYPE_OCRW 0x0F ///< Optical card reader/writer device
197 #define EFI_SCSI_TYPE_BRIDGE 0x10 ///< Bridge Controller Commands
198 #define EFI_SCSI_TYPE_OSD 0x11 ///< Object-based Storage Device
199 #define EFI_SCSI_TYPE_AUTOMATION 0x12 ///< Automation/Drive Interface
200 #define EFI_SCSI_TYPE_SECURITYMANAGER 0x13 ///< Security manager device
201 #define EFI_SCSI_TYPE_RESERVED_LOW 0x14 ///< Reserved (low)
202 #define EFI_SCSI_TYPE_RESERVED_HIGH 0x1D ///< Reserved (high)
203 #define EFI_SCSI_TYPE_WLUN 0x1E ///< Well known logical unit
204 #define EFI_SCSI_TYPE_UNKNOWN 0x1F ///< Unknown or no device type
207 // Page Codes for INQUIRY command
209 #define EFI_SCSI_PAGE_CODE_SUPPORTED_VPD 0x00
210 #define EFI_SCSI_PAGE_CODE_BLOCK_LIMITS_VPD 0xB0
214 /// Standard INQUIRY data format
217 UINT8 Peripheral_Type
: 5;
218 UINT8 Peripheral_Qualifier
: 3;
219 UINT8 DeviceType_Modifier
: 7;
222 UINT8 Response_Data_Format
;
224 UINT8 Reserved_5_95
[95 - 5 + 1];
225 } EFI_SCSI_INQUIRY_DATA
;
228 /// Supported VPD Pages VPD page
231 UINT8 Peripheral_Type
: 5;
232 UINT8 Peripheral_Qualifier
: 3;
236 UINT8 SupportedVpdPageList
[0x100];
237 } EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE
;
240 /// Block Limits VPD page
243 UINT8 Peripheral_Type
: 5;
244 UINT8 Peripheral_Qualifier
: 3;
248 UINT8 WriteSameNonZero
: 1;
249 UINT8 Reserved_4
: 7;
250 UINT8 MaximumCompareAndWriteLength
;
251 UINT8 OptimalTransferLengthGranularity2
;
252 UINT8 OptimalTransferLengthGranularity1
;
253 UINT8 MaximumTransferLength4
;
254 UINT8 MaximumTransferLength3
;
255 UINT8 MaximumTransferLength2
;
256 UINT8 MaximumTransferLength1
;
257 UINT8 OptimalTransferLength4
;
258 UINT8 OptimalTransferLength3
;
259 UINT8 OptimalTransferLength2
;
260 UINT8 OptimalTransferLength1
;
261 UINT8 MaximumPrefetchXdreadXdwriteTransferLength4
;
262 UINT8 MaximumPrefetchXdreadXdwriteTransferLength3
;
263 UINT8 MaximumPrefetchXdreadXdwriteTransferLength2
;
264 UINT8 MaximumPrefetchXdreadXdwriteTransferLength1
;
265 UINT8 MaximumUnmapLbaCount4
;
266 UINT8 MaximumUnmapLbaCount3
;
267 UINT8 MaximumUnmapLbaCount2
;
268 UINT8 MaximumUnmapLbaCount1
;
269 UINT8 MaximumUnmapBlockDescriptorCount4
;
270 UINT8 MaximumUnmapBlockDescriptorCount3
;
271 UINT8 MaximumUnmapBlockDescriptorCount2
;
272 UINT8 MaximumUnmapBlockDescriptorCount1
;
273 UINT8 OptimalUnmapGranularity4
;
274 UINT8 OptimalUnmapGranularity3
;
275 UINT8 OptimalUnmapGranularity2
;
276 UINT8 OptimalUnmapGranularity1
;
277 UINT8 UnmapGranularityAlignment4
: 7;
278 UINT8 UnmapGranularityAlignmentValid
: 1;
279 UINT8 UnmapGranularityAlignment3
;
280 UINT8 UnmapGranularityAlignment2
;
281 UINT8 UnmapGranularityAlignment1
;
282 UINT8 MaximumWriteSameLength4
;
283 UINT8 MaximumWriteSameLength3
;
284 UINT8 MaximumWriteSameLength2
;
285 UINT8 MaximumWriteSameLength1
;
286 UINT8 MaximumAtomicTransferLength4
;
287 UINT8 MaximumAtomicTransferLength3
;
288 UINT8 MaximumAtomicTransferLength2
;
289 UINT8 MaximumAtomicTransferLength1
;
290 UINT8 AtomicAlignment4
;
291 UINT8 AtomicAlignment3
;
292 UINT8 AtomicAlignment2
;
293 UINT8 AtomicAlignment1
;
294 UINT8 AtomicTransferLengthGranularity4
;
295 UINT8 AtomicTransferLengthGranularity3
;
296 UINT8 AtomicTransferLengthGranularity2
;
297 UINT8 AtomicTransferLengthGranularity1
;
298 UINT8 MaximumAtomicTransferLengthWithAtomicBoundary4
;
299 UINT8 MaximumAtomicTransferLengthWithAtomicBoundary3
;
300 UINT8 MaximumAtomicTransferLengthWithAtomicBoundary2
;
301 UINT8 MaximumAtomicTransferLengthWithAtomicBoundary1
;
302 UINT8 MaximumAtomicBoundarySize4
;
303 UINT8 MaximumAtomicBoundarySize3
;
304 UINT8 MaximumAtomicBoundarySize2
;
305 UINT8 MaximumAtomicBoundarySize1
;
306 } EFI_SCSI_BLOCK_LIMITS_VPD_PAGE
;
309 /// Error codes 70h and 71h sense data format
312 UINT8 Error_Code
: 7;
314 UINT8 Segment_Number
;
316 UINT8 Reserved_21
: 1;
318 UINT8 Reserved_22
: 2;
319 UINT8 Information_3_6
[4];
320 UINT8 Addnl_Sense_Length
; ///< Additional sense length (n-7)
321 UINT8 Vendor_Specific_8_11
[4];
322 UINT8 Addnl_Sense_Code
; ///< Additional sense code
323 UINT8 Addnl_Sense_Code_Qualifier
; ///< Additional sense code qualifier
324 UINT8 Field_Replaceable_Unit_Code
; ///< Field replaceable unit code
325 UINT8 Reserved_15_17
[3];
326 } EFI_SCSI_SENSE_DATA
;
329 /// SCSI Disk READ CAPACITY Data
340 } EFI_SCSI_DISK_CAPACITY_DATA
;
356 UINT8 LogicPerPhysical
;
357 UINT8 LowestAlignLogic2
;
358 UINT8 LowestAlignLogic1
;
360 } EFI_SCSI_DISK_CAPACITY_DATA16
;
364 UINT16 BlkDespDataLen
;
366 } EFI_SCSI_DISK_UNMAP_PARAM_LIST_HEADER
;
372 } EFI_SCSI_DISK_UNMAP_BLOCK_DESP
;
380 #define EFI_SCSI_SK_NO_SENSE (0x0)
381 #define EFI_SCSI_SK_RECOVERY_ERROR (0x1)
382 #define EFI_SCSI_SK_NOT_READY (0x2)
383 #define EFI_SCSI_SK_MEDIUM_ERROR (0x3)
384 #define EFI_SCSI_SK_HARDWARE_ERROR (0x4)
385 #define EFI_SCSI_SK_ILLEGAL_REQUEST (0x5)
386 #define EFI_SCSI_SK_UNIT_ATTENTION (0x6)
387 #define EFI_SCSI_SK_DATA_PROTECT (0x7)
388 #define EFI_SCSI_SK_BLANK_CHECK (0x8)
389 #define EFI_SCSI_SK_VENDOR_SPECIFIC (0x9)
390 #define EFI_SCSI_SK_RESERVED_A (0xA)
391 #define EFI_SCSI_SK_ABORT (0xB)
392 #define EFI_SCSI_SK_RESERVED_C (0xC)
393 #define EFI_SCSI_SK_OVERFLOW (0xD)
394 #define EFI_SCSI_SK_MISCOMPARE (0xE)
395 #define EFI_SCSI_SK_RESERVED_F (0xF)
398 // Additional Sense Codes and Sense Code Qualifiers.
399 // Only some frequently used additional sense codes and qualifiers are
400 // defined here. Please refer to SCSI standard for full value definition.
402 #define EFI_SCSI_ASC_NOT_READY (0x04)
403 #define EFI_SCSI_ASCQ_IN_PROGRESS (0x01)
405 #define EFI_SCSI_ASC_MEDIA_ERR1 (0x10)
406 #define EFI_SCSI_ASC_MEDIA_ERR2 (0x11)
407 #define EFI_SCSI_ASC_MEDIA_ERR3 (0x14)
408 #define EFI_SCSI_ASC_MEDIA_ERR4 (0x30)
409 #define EFI_SCSI_ASC_MEDIA_UPSIDE_DOWN (0x06)
410 #define EFI_SCSI_ASC_INVALID_CMD (0x20)
411 #define EFI_SCSI_ASC_LBA_OUT_OF_RANGE (0x21)
412 #define EFI_SCSI_ASC_INVALID_FIELD (0x24)
413 #define EFI_SCSI_ASC_WRITE_PROTECTED (0x27)
414 #define EFI_SCSI_ASC_MEDIA_CHANGE (0x28)
415 #define EFI_SCSI_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred
416 #define EFI_SCSI_ASC_ILLEGAL_FIELD (0x26)
417 #define EFI_SCSI_ASC_NO_MEDIA (0x3A)
418 #define EFI_SCSI_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)