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