]> git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/IndustryStandard/Atapi.h
clean up Atapi.h to follow ATA-ATAPI spec.
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Atapi.h
1 /** @file
2 This file contains just some basic definitions that are needed by drivers
3 that dealing with ATA/ATAPI interface.
4
5 Copyright (c) 2007 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #ifndef _ATAPI_H_
17 #define _ATAPI_H_
18
19 #pragma pack(1)
20
21
22 ///
23 /// ATAPI_IDENTIFY_DATA is defined in ATA-6
24 ///
25 typedef struct {
26 UINT16 config; ///< General Configuration
27 UINT16 obsolete_1;
28 UINT16 specific_config;
29 UINT16 obsolete_3;
30 UINT16 retired_4_5[2];
31 UINT16 obsolete_6;
32 UINT16 cfa_reserved_7_8[2];
33 UINT16 retired_9;
34 CHAR8 SerialNo[20]; ///< ASCII
35 UINT16 retired_20_21[2];
36 UINT16 obsolete_22;
37 CHAR8 FirmwareVer[8]; ///< ASCII
38 CHAR8 ModelName[40]; ///< ASCII
39 UINT16 multi_sector_cmd_max_sct_cnt;
40 UINT16 reserved_48;
41 UINT16 capabilities_49;
42 UINT16 capabilities_50;
43 UINT16 obsolete_51_52[2];
44 UINT16 field_validity;
45 UINT16 obsolete_54_58[5];
46 UINT16 mutil_sector_setting;
47 UINT16 user_addressable_sectors_lo;
48 UINT16 user_addressable_sectors_hi;
49 UINT16 obsolete_62;
50 UINT16 multi_word_dma_mode;
51 UINT16 advanced_pio_modes;
52 UINT16 min_multi_word_dma_cycle_time;
53 UINT16 rec_multi_word_dma_cycle_time;
54 UINT16 min_pio_cycle_time_without_flow_control;
55 UINT16 min_pio_cycle_time_with_flow_control;
56 UINT16 reserved_69_74[6];
57 UINT16 queue_depth;
58 UINT16 reserved_76_79[4];
59 UINT16 major_version_no;
60 UINT16 minor_version_no;
61 UINT16 cmd_set_support_82;
62 UINT16 cmd_set_support_83;
63 UINT16 cmd_feature_support;
64 UINT16 cmd_feature_enable_85;
65 UINT16 cmd_feature_enable_86;
66 UINT16 cmd_feature_default;
67 UINT16 ultra_dma_select;
68 UINT16 time_required_for_sec_erase;
69 UINT16 time_required_for_enhanced_sec_erase;
70 UINT16 current_advanced_power_mgmt_value;
71 UINT16 master_pwd_revison_code;
72 UINT16 hardware_reset_result;
73 UINT16 current_auto_acoustic_mgmt_value;
74 UINT16 reserved_95_99[5];
75 UINT16 max_user_lba_for_48bit_addr[4];
76 UINT16 reserved_104_126[23];
77 UINT16 removable_media_status_notification_support;
78 UINT16 security_status;
79 UINT16 vendor_data_129_159[31];
80 UINT16 cfa_power_mode;
81 UINT16 cfa_reserved_161_175[15];
82 UINT16 current_media_serial_no[30];
83 UINT16 reserved_206_254[49];
84 UINT16 integrity_word;
85 } ATAPI_IDENTIFY_DATA;
86
87 ///
88 /// the front of part is defined in ATAPI Removable Rewritable Specification
89 ///
90 typedef struct {
91 UINT8 peripheral_type;
92 UINT8 RMB;
93 UINT8 version;
94 UINT8 response_data_format;
95 UINT8 addnl_length;
96 UINT8 reserved_5;
97 UINT8 reserved_6;
98 UINT8 reserved_7;
99 UINT8 vendor_info[8];
100 UINT8 product_id[16];
101 UINT8 product_revision_level[4];
102 UINT8 vendor_specific_36_55[55 - 36 + 1];
103 UINT8 reserved_56_95[95 - 56 + 1];
104 ///
105 /// Some more fields, the sizeof (ATAPI_INQUIRY_DATA) is 255
106 /// since allocation_length is one byte in ATAPI_INQUIRY_CMD.
107 ///
108 UINT8 vendor_specific_96_255[254 - 96 + 1];
109 } ATAPI_INQUIRY_DATA;
110
111
112
113 typedef struct {
114 UINT8 error_code : 7;
115 UINT8 valid : 1;
116 UINT8 reserved_1;
117 UINT8 sense_key : 4;
118 UINT8 reserved_2 : 1;
119 UINT8 Vendor_specifc_1 : 3;
120 UINT8 vendor_specific_3;
121 UINT8 vendor_specific_4;
122 UINT8 vendor_specific_5;
123 UINT8 vendor_specific_6;
124 UINT8 addnl_sense_length; ///< n - 7
125 UINT8 vendor_specific_8;
126 UINT8 vendor_specific_9;
127 UINT8 vendor_specific_10;
128 UINT8 vendor_specific_11;
129 UINT8 addnl_sense_code; ///< mandatory
130 UINT8 addnl_sense_code_qualifier; ///< mandatory
131 UINT8 field_replaceable_unit_code; ///< optional
132 UINT8 sense_key_specific_15 : 7;
133 UINT8 SKSV : 1;
134 UINT8 sense_key_specific_16;
135 UINT8 sense_key_specific_17;
136 ///
137 /// Followed by additional sense bytes.
138 /// the sizeof (ATAPI_REQUEST_SENSE_DATA) is 255,
139 /// since allocation_length is one byte in ATAPI_INQUIRY_CMD.
140 ///
141 UINT8 additional_sense_bytes[254 - 18 + 1];
142 } ATAPI_REQUEST_SENSE_DATA;
143
144 ///
145 /// READ CAPACITY Data
146 ///
147 typedef struct {
148 UINT8 LastLba3;
149 UINT8 LastLba2;
150 UINT8 LastLba1;
151 UINT8 LastLba0;
152 UINT8 BlockSize3;
153 UINT8 BlockSize2;
154 UINT8 BlockSize1;
155 UINT8 BlockSize0;
156 } ATAPI_READ_CAPACITY_DATA;
157
158 ///
159 /// Capacity List Header + Current/Maximum Capacity Descriptor
160 ///
161 typedef struct {
162 UINT8 reserved_0;
163 UINT8 reserved_1;
164 UINT8 reserved_2;
165 UINT8 Capacity_Length;
166 UINT8 LastLba3;
167 UINT8 LastLba2;
168 UINT8 LastLba1;
169 UINT8 LastLba0;
170 UINT8 DesCode : 2;
171 UINT8 reserved_9 : 6;
172 UINT8 BlockSize2;
173 UINT8 BlockSize1;
174 UINT8 BlockSize0;
175 } ATAPI_READ_FORMAT_CAPACITY_DATA;
176
177 ///
178 /// Test Unit Ready Command
179 ///
180 typedef struct {
181 UINT8 opcode;
182 UINT8 reserved_1;
183 UINT8 reserved_2;
184 UINT8 reserved_3;
185 UINT8 reserved_4;
186 UINT8 reserved_5;
187 UINT8 reserved_6;
188 UINT8 reserved_7;
189 UINT8 reserved_8;
190 UINT8 reserved_9;
191 UINT8 reserved_10;
192 UINT8 reserved_11;
193 } ATAPI_TEST_UNIT_READY_CMD;
194
195 ///
196 /// INQUIRY Command
197 ///
198 typedef struct {
199 UINT8 opcode;
200 UINT8 reserved_1 : 5;
201 UINT8 lun : 3;
202 UINT8 page_code; ///< defined in SFF8090i, V6
203 UINT8 reserved_3;
204 UINT8 allocation_length;
205 UINT8 reserved_5;
206 UINT8 reserved_6;
207 UINT8 reserved_7;
208 UINT8 reserved_8;
209 UINT8 reserved_9;
210 UINT8 reserved_10;
211 UINT8 reserved_11;
212 } ATAPI_INQUIRY_CMD;
213
214 ///
215 /// REQUEST SENSE Command
216 ///
217 typedef struct {
218 UINT8 opcode;
219 UINT8 reserved_1 : 5;
220 UINT8 lun : 3;
221 UINT8 reserved_2;
222 UINT8 reserved_3;
223 UINT8 allocation_length;
224 UINT8 reserved_5;
225 UINT8 reserved_6;
226 UINT8 reserved_7;
227 UINT8 reserved_8;
228 UINT8 reserved_9;
229 UINT8 reserved_10;
230 UINT8 reserved_11;
231 } ATAPI_REQUEST_SENSE_CMD;
232
233 ///
234 /// READ (10) Command
235 ///
236 typedef struct {
237 UINT8 opcode;
238 UINT8 reserved_1 : 5;
239 UINT8 lun : 3;
240 UINT8 Lba0;
241 UINT8 Lba1;
242 UINT8 Lba2;
243 UINT8 Lba3;
244 UINT8 reserved_6;
245 UINT8 TranLen0;
246 UINT8 TranLen1;
247 UINT8 reserved_9;
248 UINT8 reserved_10;
249 UINT8 reserved_11;
250 } ATAPI_READ10_CMD;
251
252 ///
253 /// READ Format Capacity Command
254 ///
255 typedef struct {
256 UINT8 opcode;
257 UINT8 reserved_1 : 5;
258 UINT8 lun : 3;
259 UINT8 reserved_2;
260 UINT8 reserved_3;
261 UINT8 reserved_4;
262 UINT8 reserved_5;
263 UINT8 reserved_6;
264 UINT8 allocation_length_hi;
265 UINT8 allocation_length_lo;
266 UINT8 reserved_9;
267 UINT8 reserved_10;
268 UINT8 reserved_11;
269 } ATAPI_READ_FORMAT_CAP_CMD;
270
271 typedef struct {
272 UINT8 peripheral_type;
273 UINT8 RMB;
274 UINT8 version;
275 UINT8 response_data_format;
276 UINT8 addnl_length;
277 UINT8 reserved_5;
278 UINT8 reserved_6;
279 UINT8 reserved_7;
280 UINT8 vendor_info[8];
281 UINT8 product_id[12];
282 UINT8 eeprom_product_code[4];
283 UINT8 firmware_rev_level[4];
284 } ATAPI_USB_INQUIRY_DATA;
285
286 ///
287 /// MODE SENSE Command
288 ///
289 typedef struct {
290 UINT8 opcode;
291 UINT8 reserved_1 : 5;
292 UINT8 lun : 3;
293 UINT8 page_code : 6;
294 UINT8 page_control : 2;
295 UINT8 reserved_3;
296 UINT8 reserved_4;
297 UINT8 reserved_5;
298 UINT8 reserved_6;
299 UINT8 parameter_list_length_hi;
300 UINT8 parameter_list_length_lo;
301 UINT8 reserved_9;
302 UINT8 reserved_10;
303 UINT8 reserved_11;
304 } ATAPI_MODE_SENSE_CMD;
305
306 ///
307 /// ATAPI_PACKET_COMMAND is not defined in ATA specification.
308 /// We add it here for the convenience for ATA/ATAPI module writer.
309 ///
310 typedef union {
311 UINT16 Data16[6];
312 ATAPI_TEST_UNIT_READY_CMD TestUnitReady;
313 ATAPI_READ10_CMD Read10;
314 ATAPI_REQUEST_SENSE_CMD RequestSence;
315 ATAPI_INQUIRY_CMD Inquiry;
316 ATAPI_MODE_SENSE_CMD ModeSense;
317 ATAPI_READ_FORMAT_CAP_CMD ReadFormatCapacity;
318 } ATAPI_PACKET_COMMAND;
319
320 #pragma pack()
321
322
323 #define ATAPI_MAX_DMA_EXT_CMD_SECTORS 0x10000
324 #define ATAPI_MAX_DMA_CMD_SECTORS 0x100
325
326 //
327 // ATA Packet Command Code
328 //
329 #define ATA_CMD_SOFT_RESET 0x08 ///< defined in ATA-6
330 #define ATA_CMD_PACKET 0xA0 ///< defined in ATA-6
331 #define ATA_CMD_IDENTIFY_DEVICE 0xA1 ///< defined in ATA-6
332 #define ATA_CMD_SERVICE 0xA2 ///< defined in ATA-6
333 #define ATA_CMD_TEST_UNIT_READY 0x00 ///< defined in ATA-6
334 #define ATA_CMD_REQUEST_SENSE 0x03 ///< defined in ATA-6
335 #define ATA_CMD_INQUIRY 0x12 ///< defined in ATAPI Removable Rewritable Media Devcies
336 #define ATA_CMD_READ_FORMAT_CAPACITY 0x23 ///< defined in ATAPI Removable Rewritable Media Devcies
337 #define ATA_CMD_READ_CAPACITY 0x25 ///< defined in ATAPI Removable Rewritable Media Devcies
338 #define ATA_CMD_READ_10 0x28 ///< defined in ATAPI Removable Rewritable Media Devcies
339 #define ATA_CMD_WRITE_10 0x2A ///< defined in ATAPI Removable Rewritable Media Devcies
340
341 //
342 // ATA Commands Code
343 //
344
345 //
346 // Class 1: PIO Data-In Commands
347 //
348 #define ATA_CMD_IDENTIFY_DRIVE 0xec
349 #define ATA_CMD_READ_BUFFER 0xe4
350 #define ATA_CMD_READ_SECTORS 0x20 ///< defined in ATA-5
351 #define ATA_CMD_READ_SECTORS_WITH_RETRY 0x21 ///< defined in ATA-5
352 #define ATA_CMD_READ_LONG 0x22 ///< defined in ATA-5
353 #define ATA_CMD_READ_LONG_WITH_RETRY 0x23 ///< defined in ATA-5
354 #define ATA_CMD_READ_SECTORS_EXT 0x24 ///< defined in ATA-6
355
356
357 //
358 // Class 2: PIO Data-Out Commands
359 //
360 #define ATA_CMD_FORMAT_TRACK 0x50 ///< defined in ATA-3
361 #define ATA_CMD_WRITE_BUFFER 0xe8 ///< defined in ATA-6
362 #define ATA_CMD_WRITE_SECTORS 0x30 ///< defined in ATA-6
363 #define ATA_CMD_WRITE_SECTORS_WITH_RETRY 0x31 ///< defined in ATA-4
364 #define ATA_CMD_WRITE_LONG 0x32 ///< defined in ATA-3
365 #define ATA_CMD_WRITE_LONG_WITH_RETRY 0x33 ///< defined in ATA-3
366 #define ATA_CMD_WRITE_VERIFY 0x3c ///< defined in ATA-3
367 #define ATA_CMD_WRITE_SECTORS_EXT 0x34 ///< defined in ATA-6
368
369 //
370 // Class 3 No Data Command
371 //
372 #define ATA_CMD_ACK_MEDIA_CHANGE 0xdb ///< defined in ATA-2
373 #define ATA_CMD_BOOT_POST_BOOT 0xdc ///< defined in ATA-2
374 #define ATA_CMD_BOOT_PRE_BOOT 0xdd ///< defined in ATA-2
375 #define ATA_CMD_CHECK_POWER_MODE 0x98 ///< defined in ATA-3
376 #define ATA_CMD_CHECK_POWER_MODE_ALIAS 0xe5 ///< defined in ATA-6
377 #define ATA_CMD_DOOR_LOCK 0xde ///< defined in ATA-6
378 #define ATA_CMD_DOOR_UNLOCK 0xdf ///< defined in ATA-6
379 #define ATA_CMD_EXEC_DRIVE_DIAG 0x90 ///< defined in ATA-6
380 #define ATA_CMD_IDLE_ALIAS 0x97 ///< defined in ATA-3
381 #define ATA_CMD_IDLE 0xe3 ///< defined in ATA-6
382 #define ATA_CMD_IDLE_IMMEDIATE 0x95 ///< defined in ATA-3
383 #define ATA_CMD_IDLE_IMMEDIATE_ALIAS 0xe1 ///< defined in ATA-6
384 #define ATA_CMD_INIT_DRIVE_PARAM 0x91 ///< defined in ATA-5
385 #define ATA_CMD_RECALIBRATE 0x10 ///< defined in ATA-3
386 #define ATA_CMD_READ_DRIVE_STATE 0xe9 ///< defined in ATA-2
387 #define ATA_CMD_SET_MULTIPLE_MODE 0xC6 ///< defined in ATA-6
388 #define ATA_CMD_READ_VERIFY 0x40 ///< defined in ATA-6
389 #define ATA_CMD_READ_VERIFY_WITH_RETRY 0x41 ///< defined in ATA-4
390 #define ATA_CMD_SEEK 0x70 ///< defined in ATA-6
391 #define ATA_CMD_SET_FEATURES 0xef ///< defined in ATA-6
392 #define ATA_CMD_STANDBY 0x96 ///< defined in ATA-3
393 #define ATA_CMD_STANDBY_ALIAS 0xe2 ///< defined in ATA-6
394 #define ATA_CMD_STANDBY_IMMEDIATE 0x94 ///< defined in ATA-3
395 #define ATA_CMD_STANDBY_IMMEDIATE_ALIAS 0xe0 ///< defined in ATA-6
396 ///
397 /// S.M.A.R.T
398 ///
399 #define ATA_CMD_SMART 0xb0
400 #define ATA_CONSTANT_C2 0xc2
401 #define ATA_CONSTANT_4F 0x4f
402 #define ATA_SMART_ENABLE_OPERATION 0xd8
403 #define ATA_SMART_RETURN_STATUS 0xda
404
405
406 ///
407 /// Class 4: DMA Command
408 ///
409 #define ATA_CMD_READ_DMA 0xc8 ///< defined in ATA-6
410 #define ATA_CMD_READ_DMA_WITH_RETRY 0xc9 ///< defined in ATA-4
411 #define ATA_CMD_READ_DMA_EXT 0x25 ///< defined in ATA-6
412 #define ATA_CMD_WRITE_DMA 0xca ///< defined in ATA-6
413 #define ATA_CMD_WRITE_DMA_WITH_RETRY 0xcb ///< defined in ATA-4
414 #define ATA_CMD_WRITE_DMA_EXT 0x35 ///< defined in ATA-6
415
416
417
418 ///
419 /// default content of device control register, disable INT,
420 /// Bit3 is set to 1 according ATA-1
421 ///
422 #define ATA_DEFAULT_CTL (0x0a)
423 ///
424 /// default context of Device/Head Register,
425 /// Bit7 and Bit5 are set to 1 for back-compatibilities
426 ///
427 #define ATA_DEFAULT_CMD (0xa0)
428
429 #define ATAPI_MAX_BYTE_COUNT (0xfffe)
430
431 ///
432 /// Sense Key, Additional Sense Codes and Additional Sense Code Qualifier
433 /// defined in MultiMedia Commands (MMC, MMC-2)
434 ///
435 /// Sense Key
436 ///
437 #define ATA_SK_NO_SENSE (0x0)
438 #define ATA_SK_RECOVERY_ERROR (0x1)
439 #define ATA_SK_NOT_READY (0x2)
440 #define ATA_SK_MEDIUM_ERROR (0x3)
441 #define ATA_SK_HARDWARE_ERROR (0x4)
442 #define ATA_SK_ILLEGAL_REQUEST (0x5)
443 #define ATA_SK_UNIT_ATTENTION (0x6)
444 #define ATA_SK_DATA_PROTECT (0x7)
445 #define ATA_SK_BLANK_CHECK (0x8)
446 #define ATA_SK_VENDOR_SPECIFIC (0x9)
447 #define ATA_SK_RESERVED_A (0xA)
448 #define ATA_SK_ABORT (0xB)
449 #define ATA_SK_RESERVED_C (0xC)
450 #define ATA_SK_OVERFLOW (0xD)
451 #define ATA_SK_MISCOMPARE (0xE)
452 #define ATA_SK_RESERVED_F (0xF)
453
454 //
455 // Additional Sense Codes
456 //
457 #define ATA_ASC_NOT_READY (0x04)
458 #define ATA_ASC_MEDIA_ERR1 (0x10)
459 #define ATA_ASC_MEDIA_ERR2 (0x11)
460 #define ATA_ASC_MEDIA_ERR3 (0x14)
461 #define ATA_ASC_MEDIA_ERR4 (0x30)
462 #define ATA_ASC_MEDIA_UPSIDE_DOWN (0x06)
463 #define ATA_ASC_INVALID_CMD (0x20)
464 #define ATA_ASC_LBA_OUT_OF_RANGE (0x21)
465 #define ATA_ASC_INVALID_FIELD (0x24)
466 #define ATA_ASC_WRITE_PROTECTED (0x27)
467 #define ATA_ASC_MEDIA_CHANGE (0x28)
468 #define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred
469 #define ATA_ASC_ILLEGAL_FIELD (0x26)
470 #define ATA_ASC_NO_MEDIA (0x3A)
471 #define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)
472
473 //
474 // Additional Sense Code Qualifier
475 //
476 #define ATA_ASCQ_IN_PROGRESS (0x01)
477
478 ///
479 /// Error Register
480 ///
481 #define ATA_ERRREG_BBK BIT7 ///< Bad block detected defined in ATA-1
482 #define ATA_ERRREG_UNC BIT6 ///< Uncorrectable Data defined in ATA-3
483 #define ATA_ERRREG_MC BIT5 ///< Media Change defined in ATA-3
484 #define ATA_ERRREG_IDNF BIT4 ///< ID Not Found defined in ATA-3
485 #define ATA_ERRREG_MCR BIT3 ///< Media Change Requested defined in ATA-3
486 #define ATA_ERRREG_ABRT BIT2 ///< Aborted Command defined in ATA-6
487 #define ATA_ERRREG_TK0NF BIT1 ///< Track 0 Not Found defined in ATA-3
488 #define ATA_ERRREG_AMNF BIT0 ///< Address Mark Not Found defined in ATA-3
489
490 ///
491 /// Status Register
492 ///
493 #define ATA_STSREG_BSY BIT7 ///< Controller Busy defined in ATA-6
494 #define ATA_STSREG_DRDY BIT6 ///< Drive Ready defined in ATA-6
495 #define ATA_STSREG_DWF BIT5 ///< Drive Write Fault defined in ATA-6
496 #define ATA_STSREG_DSC BIT4 ///< Disk Seek Complete defined in ATA-3
497 #define ATA_STSREG_DRQ BIT3 ///< Data Request defined in ATA-6
498 #define ATA_STSREG_CORR BIT2 ///< Corrected Data defined in ATA-3
499 #define ATA_STSREG_IDX BIT1 ///< Index defined in ATA-3
500 #define ATA_STSREG_ERR BIT0 ///< Error defined in ATA-6
501
502 ///
503 /// Device Control Register
504 ///
505 #define ATA_CTLREG_SRST BIT2 ///< Software Reset
506 #define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #
507
508 #endif
509