1) Modify ScsiIo protocol according to UEFI specification
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Scsi.h
CommitLineData
a7ed1e2e 1/** @file\r
2 support for SCSI-2 standard\r
3\r
4 Copyright (c) 2006, Intel Corporation \r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
a7ed1e2e 13**/\r
14\r
842f5579
A
15#ifndef __SCSI_H__\r
16#define __SCSI_H__\r
a7ed1e2e 17\r
18//\r
19// SCSI command OP Code\r
20//\r
21//\r
22// Commands for all device types\r
23//\r
24#define EFI_SCSI_OP_CHANGE_DEFINITION 0x40\r
25#define EFI_SCSI_OP_COMPARE 0x39\r
26#define EFI_SCSI_OP_COPY 0x18\r
27#define EFI_SCSI_OP_COPY_VERIFY 0x3a\r
28#define EFI_SCSI_OP_INQUIRY 0x12\r
29#define EFI_SCSI_OP_LOG_SELECT 0x4c\r
30#define EFI_SCSI_OP_LOG_SENSE 0x4d\r
31#define EFI_SCSI_OP_MODE_SEL6 0x15\r
32#define EFI_SCSI_OP_MODE_SEL10 0x55\r
33#define EFI_SCSI_OP_MODE_SEN6 0x1a\r
34#define EFI_SCSI_OP_MODE_SEN10 0x5a\r
35#define EFI_SCSI_OP_READ_BUFFER 0x3c\r
36#define EFI_SCSI_OP_REQUEST_SENSE 0x03\r
37#define EFI_SCSI_OP_SEND_DIAG 0x1d\r
38#define EFI_SCSI_OP_TEST_UNIT_READY 0x00\r
39#define EFI_SCSI_OP_WRITE_BUFF 0x3b\r
40\r
41//\r
42// Commands unique to Direct Access Devices\r
43//\r
44#define EFI_SCSI_OP_COMPARE 0x39\r
45#define EFI_SCSI_OP_FORMAT 0x04\r
46#define EFI_SCSI_OP_LOCK_UN_CACHE 0x36\r
47#define EFI_SCSI_OP_PREFETCH 0x34\r
48#define EFI_SCSI_OP_MEDIA_REMOVAL 0x1e\r
49#define EFI_SCSI_OP_READ6 0x08\r
50#define EFI_SCSI_OP_READ10 0x28\r
51#define EFI_SCSI_OP_READ_CAPACITY 0x25\r
52#define EFI_SCSI_OP_READ_DEFECT 0x37\r
53#define EFI_SCSI_OP_READ_LONG 0x3e\r
54#define EFI_SCSI_OP_REASSIGN_BLK 0x07\r
55#define EFI_SCSI_OP_RECEIVE_DIAG 0x1c\r
56#define EFI_SCSI_OP_RELEASE 0x17\r
57#define EFI_SCSI_OP_REZERO 0x01\r
58#define EFI_SCSI_OP_SEARCH_DATA_E 0x31\r
59#define EFI_SCSI_OP_SEARCH_DATA_H 0x30\r
60#define EFI_SCSI_OP_SEARCH_DATA_L 0x32\r
61#define EFI_SCSI_OP_SEEK6 0x0b\r
62#define EFI_SCSI_OP_SEEK10 0x2b\r
63#define EFI_SCSI_OP_SEND_DIAG 0x1d\r
64#define EFI_SCSI_OP_SET_LIMIT 0x33\r
65#define EFI_SCSI_OP_START_STOP_UNIT 0x1b\r
66#define EFI_SCSI_OP_SYNC_CACHE 0x35\r
67#define EFI_SCSI_OP_VERIFY 0x2f\r
68#define EFI_SCSI_OP_WRITE6 0x0a\r
69#define EFI_SCSI_OP_WRITE10 0x2a\r
70#define EFI_SCSI_OP_WRITE_VERIFY 0x2e\r
71#define EFI_SCSI_OP_WRITE_LONG 0x3f\r
72#define EFI_SCSI_OP_WRITE_SAME 0x41\r
73\r
74//\r
75// Commands unique to Sequential Access Devices\r
76//\r
77#define EFI_SCSI_OP_ERASE 0x19\r
78#define EFI_SCSI_OP_LOAD_UNLOAD 0x1b\r
79#define EFI_SCSI_OP_LOCATE 0x2b\r
80#define EFI_SCSI_OP_READ_BLOCK_LIMIT 0x05\r
81#define EFI_SCSI_OP_READ_POS 0x34\r
82#define EFI_SCSI_OP_READ_REVERSE 0x0f\r
83#define EFI_SCSI_OP_RECOVER_BUF_DATA 0x14\r
84#define EFI_SCSI_OP_RESERVE_UNIT 0x16\r
85#define EFI_SCSI_OP_REWIND 0x01\r
86#define EFI_SCSI_OP_SPACE 0x11\r
87#define EFI_SCSI_OP_VERIFY_TAPE 0x13\r
88#define EFI_SCSI_OP_WRITE_FILEMARK 0x10\r
89\r
90//\r
91// Commands unique to Printer Devices\r
92//\r
93#define EFI_SCSI_OP_PRINT 0x0a\r
94#define EFI_SCSI_OP_SLEW_PRINT 0x0b\r
95#define EFI_SCSI_OP_STOP_PRINT 0x1b\r
96#define EFI_SCSI_OP_SYNC_BUFF 0x10\r
97\r
98//\r
99// Commands unique to Processor Devices\r
100//\r
101#define EFI_SCSI_OP_RECEIVE 0x08\r
102#define EFI_SCSI_OP_SEND 0x0a\r
103\r
104//\r
105// Commands unique to Write-Once Devices\r
106//\r
107#define EFI_SCSI_OP_MEDIUM_SCAN 0x38\r
108#define EFI_SCSI_OP_SEARCH_DAT_E10 0x31\r
109#define EFI_SCSI_OP_SEARCH_DAT_E12 0xb1\r
110#define EFI_SCSI_OP_SEARCH_DAT_H10 0x30\r
111#define EFI_SCSI_OP_SEARCH_DAT_H12 0xb0\r
112#define EFI_SCSI_OP_SEARCH_DAT_L10 0x32\r
113#define EFI_SCSI_OP_SEARCH_DAT_L12 0xb2\r
114#define EFI_SCSI_OP_SET_LIMIT10 0x33\r
115#define EFI_SCSI_OP_SET_LIMIT12 0xb3\r
116#define EFI_SCSI_OP_VERIFY10 0x2f\r
117#define EFI_SCSI_OP_VERIFY12 0xaf\r
118#define EFI_SCSI_OP_WRITE12 0xaa\r
119#define EFI_SCSI_OP_WRITE_VERIFY10 0x2e\r
120#define EFI_SCSI_OP_WRITE_VERIFY12 0xae\r
121\r
122//\r
123// Commands unique to CD-ROM Devices\r
124//\r
125#define EFI_SCSI_OP_PLAY_AUD_10 0x45\r
126#define EFI_SCSI_OP_PLAY_AUD_12 0xa5\r
127#define EFI_SCSI_OP_PLAY_AUD_MSF 0x47\r
128#define EFI_SCSI_OP_PLAY_AUD_TKIN 0x48\r
129#define EFI_SCSI_OP_PLAY_TK_REL10 0x49\r
130#define EFI_SCSI_OP_PLAY_TK_REL12 0xa9\r
131#define EFI_SCSI_OP_READ_CD_CAPACITY 0x25\r
132#define EFI_SCSI_OP_READ_HEADER 0x44\r
133#define EFI_SCSI_OP_READ_SUB_CHANNEL 0x42\r
134#define EFI_SCSI_OP_READ_TOC 0x43\r
135\r
136//\r
137// Commands unique to Scanner Devices\r
138//\r
139#define EFI_SCSI_OP_GET_DATABUFF_STAT 0x34\r
140#define EFI_SCSI_OP_GET_WINDOW 0x25\r
141#define EFI_SCSI_OP_OBJECT_POS 0x31\r
142#define EFI_SCSI_OP_SCAN 0x1b\r
143#define EFI_SCSI_OP_SET_WINDOW 0x24\r
144\r
145//\r
146// Commands unique to Optical Memory Devices\r
147//\r
148#define EFI_SCSI_OP_UPDATE_BLOCK 0x3d\r
149\r
150//\r
151// Commands unique to Medium Changer Devices\r
152//\r
153#define EFI_SCSI_OP_EXCHANGE_MEDIUM 0xa6\r
154#define EFI_SCSI_OP_INIT_ELEMENT_STAT 0x07\r
155#define EFI_SCSI_OP_POS_TO_ELEMENT 0x2b\r
156#define EFI_SCSI_OP_REQUEST_VE_ADDR 0xb5\r
157#define EFI_SCSI_OP_SEND_VOL_TAG 0xb6\r
158\r
159//\r
160// Commands unique to Communition Devices\r
161//\r
162#define EFI_SCSI_OP_GET_MESSAGE6 0x08\r
163#define EFI_SCSI_OP_GET_MESSAGE10 0x28\r
164#define EFI_SCSI_OP_GET_MESSAGE12 0xa8\r
165#define EFI_SCSI_OP_SEND_MESSAGE6 0x0a\r
166#define EFI_SCSI_OP_SEND_MESSAGE10 0x2a\r
167#define EFI_SCSI_OP_SEND_MESSAGE12 0xaa\r
168\r
169//\r
170// SCSI Data Transfer Direction\r
171//\r
172#define EFI_SCSI_DATA_IN 0\r
173#define EFI_SCSI_DATA_OUT 1\r
174\r
175//\r
176// Peripheral Device Type Definitions\r
177//\r
178#define EFI_SCSI_TYPE_DISK 0x00 // Disk device\r
179#define EFI_SCSI_TYPE_TAPE 0x01 // Tape device\r
180#define EFI_SCSI_TYPE_PRINTER 0x02 // Printer\r
181#define EFI_SCSI_TYPE_PROCESSOR 0x03 // Processor\r
182#define EFI_SCSI_TYPE_WORM 0x04 // Write-once read-multiple\r
183#define EFI_SCSI_TYPE_CDROM 0x05 // CD-ROM device\r
184#define EFI_SCSI_TYPE_SCANNER 0x06 // Scanner device\r
185#define EFI_SCSI_TYPE_OPTICAL 0x07 // Optical memory device\r
186#define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08 // Medium Changer device\r
187#define EFI_SCSI_TYPE_COMMUNICATION 0x09 // Communications device\r
188#define EFI_SCSI_TYPE_RESERVED_LOW 0x0A // Reserved (low)\r
189#define EFI_SCSI_TYPE_RESERVED_HIGH 0x1E // Reserved (high)\r
190#define EFI_SCSI_TYPE_UNKNOWN 0x1F // Unknown or no device type\r
191#pragma pack(1)\r
192//\r
193// Data structures for scsi command use\r
194//\r
195typedef struct {\r
196 UINT8 Peripheral_Type : 5;\r
197 UINT8 Peripheral_Qualifier : 3;\r
198 UINT8 DeviceType_Modifier : 7;\r
199 UINT8 RMB : 1;\r
200 UINT8 Version;\r
201 UINT8 Response_Data_Format;\r
202 UINT8 Addnl_Length;\r
203 UINT8 Reserved_5_95[95 - 5 + 1];\r
204} EFI_SCSI_INQUIRY_DATA;\r
205\r
206typedef struct {\r
207 UINT8 Error_Code : 7;\r
208 UINT8 Valid : 1;\r
209 UINT8 Segment_Number;\r
210 UINT8 Sense_Key : 4;\r
211 UINT8 Reserved_21 : 1;\r
212 UINT8 ILI : 1;\r
213 UINT8 Reserved_22 : 2;\r
214 UINT8 Information_3_6[4];\r
215 UINT8 Addnl_Sense_Length; // n - 7\r
216 UINT8 Vendor_Specific_8_11[4];\r
217 UINT8 Addnl_Sense_Code; // mandatory\r
218 UINT8 Addnl_Sense_Code_Qualifier; // mandatory\r
219 UINT8 Field_Replaceable_Unit_Code; // optional\r
220 UINT8 Reserved_15_17[3];\r
221} EFI_SCSI_SENSE_DATA;\r
222\r
223typedef struct {\r
224 UINT8 LastLba3;\r
225 UINT8 LastLba2;\r
226 UINT8 LastLba1;\r
227 UINT8 LastLba0;\r
228 UINT8 BlockSize3;\r
229 UINT8 BlockSize2;\r
230 UINT8 BlockSize1;\r
231 UINT8 BlockSize0;\r
232} EFI_SCSI_DISK_CAPACITY_DATA;\r
233\r
234#pragma pack()\r
235//\r
236// Sense Key\r
237//\r
238#define EFI_SCSI_REQUEST_SENSE_ERROR (0x70)\r
239#define EFI_SCSI_SK_NO_SENSE (0x0)\r
240#define EFI_SCSI_SK_RECOVERY_ERROR (0x1)\r
241#define EFI_SCSI_SK_NOT_READY (0x2)\r
242#define EFI_SCSI_SK_MEDIUM_ERROR (0x3)\r
243#define EFI_SCSI_SK_HARDWARE_ERROR (0x4)\r
244#define EFI_SCSI_SK_ILLEGAL_REQUEST (0x5)\r
245#define EFI_SCSI_SK_UNIT_ATTENTION (0x6)\r
246#define EFI_SCSI_SK_DATA_PROTECT (0x7)\r
247#define EFI_SCSI_SK_BLANK_CHECK (0x8)\r
248#define EFI_SCSI_SK_VENDOR_SPECIFIC (0x9)\r
249#define EFI_SCSI_SK_RESERVED_A (0xA)\r
250#define EFI_SCSI_SK_ABORT (0xB)\r
251#define EFI_SCSI_SK_RESERVED_C (0xC)\r
252#define EFI_SCSI_SK_OVERFLOW (0xD)\r
253#define EFI_SCSI_SK_MISCOMPARE (0xE)\r
254#define EFI_SCSI_SK_RESERVED_F (0xF)\r
255\r
256//\r
257// Additional Sense Codes\r
258//\r
259#define EFI_SCSI_ASC_NOT_READY (0x04)\r
260#define EFI_SCSI_ASC_MEDIA_ERR1 (0x10)\r
261#define EFI_SCSI_ASC_MEDIA_ERR2 (0x11)\r
262#define EFI_SCSI_ASC_MEDIA_ERR3 (0x14)\r
263#define EFI_SCSI_ASC_MEDIA_ERR4 (0x30)\r
264#define EFI_SCSI_ASC_MEDIA_UPSIDE_DOWN (0x06)\r
265#define EFI_SCSI_ASC_INVALID_CMD (0x20)\r
266#define EFI_SCSI_ASC_LBA_OUT_OF_RANGE (0x21)\r
267#define EFI_SCSI_ASC_INVALID_FIELD (0x24)\r
268#define EFI_SCSI_ASC_WRITE_PROTECTED (0x27)\r
269#define EFI_SCSI_ASC_MEDIA_CHANGE (0x28)\r
270#define EFI_SCSI_ASC_RESET (0x29) /* Power On Reset or Bus Reset occurred */\r
271#define EFI_SCSI_ASC_ILLEGAL_FIELD (0x26)\r
272#define EFI_SCSI_ASC_NO_MEDIA (0x3A)\r
273#define EFI_SCSI_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)\r
274\r
275//\r
276// Additional Sense Code Qualifier\r
277//\r
278#define EFI_SCSI_ASCQ_IN_PROGRESS (0x01)\r
279\r
a02e796b 280//\r
281// Max bytes needed to represent ID of a SCSI device\r
282//\r
283#define EFI_SCSI_TARGET_MAX_BYTES (0x10)\r
284\r
a7ed1e2e 285#endif\r