2 This file contains just some basic definitions that are needed by drivers
3 that dealing with ATA/ATAPI interface.
5 Copyright (c) 2007 - 2009, 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
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.
22 /// ATA_IDENTIFY_DATA is defined in ATA-5
25 UINT16 config
; ///< General Configuration
26 UINT16 cylinders
; ///< Number of Cylinders
28 UINT16 heads
; ///< Number of logical heads
31 UINT16 sectors_per_track
;
32 UINT16 vendor_specific_7_9
[3];
33 CHAR8 SerialNo
[20]; ///< ASCII
34 UINT16 vendor_specific_20_21
[2];
35 UINT16 ecc_bytes_available
;
36 CHAR8 FirmwareVer
[8]; ///< ASCII
37 CHAR8 ModelName
[40]; ///< ASCII
38 UINT16 multi_sector_cmd_max_sct_cnt
;
42 UINT16 pio_cycle_timing
;
44 UINT16 field_validity
;
45 UINT16 current_cylinders
;
47 UINT16 current_sectors
;
48 UINT16 CurrentCapacityLsb
;
49 UINT16 CurrentCapacityMsb
;
51 UINT16 user_addressable_sectors_lo
;
52 UINT16 user_addressable_sectors_hi
;
54 UINT16 multi_word_dma_mode
;
55 UINT16 advanced_pio_modes
;
56 UINT16 min_multi_word_dma_cycle_time
;
57 UINT16 rec_multi_word_dma_cycle_time
;
58 UINT16 min_pio_cycle_time_without_flow_control
;
59 UINT16 min_pio_cycle_time_with_flow_control
;
60 UINT16 reserved_69_79
[11];
61 UINT16 major_version_no
;
62 UINT16 minor_version_no
;
63 UINT16 command_set_supported_82
; ///< word 82
64 UINT16 command_set_supported_83
; ///< word 83
65 UINT16 command_set_feature_extn
; ///< word 84
66 UINT16 command_set_feature_enb_85
; ///< word 85
67 UINT16 command_set_feature_enb_86
; ///< word 86
68 UINT16 command_set_feature_default
; ///< word 87
69 UINT16 ultra_dma_mode
; ///< word 88
70 UINT16 reserved_89_127
[39];
71 UINT16 security_status
;
72 UINT16 vendor_data_129_159
[31];
73 UINT16 reserved_160_255
[96];
77 /// ATAPI_IDENTIFY_DATA is defined in ATA-6
80 UINT16 config
; ///< General Configuration
82 UINT16 specific_config
;
84 UINT16 retired_4_5
[2];
86 UINT16 cfa_reserved_7_8
[2];
88 CHAR8 SerialNo
[20]; ///< ASCII
89 UINT16 retired_20_21
[2];
91 CHAR8 FirmwareVer
[8]; ///< ASCII
92 CHAR8 ModelName
[40]; ///< ASCII
93 UINT16 multi_sector_cmd_max_sct_cnt
;
95 UINT16 capabilities_49
;
96 UINT16 capabilities_50
;
97 UINT16 obsolete_51_52
[2];
98 UINT16 field_validity
;
99 UINT16 obsolete_54_58
[5];
100 UINT16 mutil_sector_setting
;
101 UINT16 user_addressable_sectors_lo
;
102 UINT16 user_addressable_sectors_hi
;
104 UINT16 multi_word_dma_mode
;
105 UINT16 advanced_pio_modes
;
106 UINT16 min_multi_word_dma_cycle_time
;
107 UINT16 rec_multi_word_dma_cycle_time
;
108 UINT16 min_pio_cycle_time_without_flow_control
;
109 UINT16 min_pio_cycle_time_with_flow_control
;
110 UINT16 reserved_69_74
[6];
112 UINT16 reserved_76_79
[4];
113 UINT16 major_version_no
;
114 UINT16 minor_version_no
;
115 UINT16 cmd_set_support_82
;
116 UINT16 cmd_set_support_83
;
117 UINT16 cmd_feature_support
;
118 UINT16 cmd_feature_enable_85
;
119 UINT16 cmd_feature_enable_86
;
120 UINT16 cmd_feature_default
;
121 UINT16 ultra_dma_select
;
122 UINT16 time_required_for_sec_erase
;
123 UINT16 time_required_for_enhanced_sec_erase
;
124 UINT16 current_advanced_power_mgmt_value
;
125 UINT16 master_pwd_revison_code
;
126 UINT16 hardware_reset_result
;
127 UINT16 current_auto_acoustic_mgmt_value
;
128 UINT16 reserved_95_99
[5];
129 UINT16 max_user_lba_for_48bit_addr
[4];
130 UINT16 reserved_104_126
[23];
131 UINT16 removable_media_status_notification_support
;
132 UINT16 security_status
;
133 UINT16 vendor_data_129_159
[31];
134 UINT16 cfa_power_mode
;
135 UINT16 cfa_reserved_161_175
[15];
136 UINT16 current_media_serial_no
[30];
137 UINT16 reserved_206_254
[49];
138 UINT16 integrity_word
;
139 } ATAPI_IDENTIFY_DATA
;
142 /// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
145 UINT8 peripheral_type
;
148 UINT8 response_data_format
;
149 UINT8 addnl_length
; ///< n - 4, Numbers of bytes following this one
153 UINT8 vendor_info
[8];
154 UINT8 product_id
[16];
155 UINT8 product_revision_level
[4];
156 UINT8 vendor_specific_36_55
[55 - 36 + 1];
157 UINT8 reserved_56_95
[95 - 56 + 1];
159 /// Vendor specific parameters fields, the sizeof (ATAPI_INQUIRY_DATA) is 254
160 /// since allocation_length is one byte in ATAPI_INQUIRY_CMD.
162 UINT8 vendor_specific_96_253
[253 - 96 + 1];
163 } ATAPI_INQUIRY_DATA
;
166 /// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
169 UINT8 error_code
: 7;
173 UINT8 reserved_2
: 1;
174 UINT8 Vendor_specifc_1
: 3;
175 UINT8 vendor_specific_3
;
176 UINT8 vendor_specific_4
;
177 UINT8 vendor_specific_5
;
178 UINT8 vendor_specific_6
;
179 UINT8 addnl_sense_length
; ///< n - 7
180 UINT8 vendor_specific_8
;
181 UINT8 vendor_specific_9
;
182 UINT8 vendor_specific_10
;
183 UINT8 vendor_specific_11
;
184 UINT8 addnl_sense_code
; ///< mandatory
185 UINT8 addnl_sense_code_qualifier
; ///< mandatory
186 UINT8 field_replaceable_unit_code
; ///< optional
187 UINT8 sense_key_specific_15
: 7;
189 UINT8 sense_key_specific_16
;
190 UINT8 sense_key_specific_17
;
191 } ATAPI_REQUEST_SENSE_DATA
;
194 /// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
205 } ATAPI_READ_CAPACITY_DATA
;
208 /// Capacity List Header + Current/Maximum Capacity Descriptor,
209 /// defined in SFF-8070i(ATAPI Removable Rewritable Specification)
215 UINT8 Capacity_Length
;
221 UINT8 reserved_9
: 6;
225 } ATAPI_READ_FORMAT_CAPACITY_DATA
;
228 /// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
243 } ATAPI_TEST_UNIT_READY_CMD
;
246 /// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
250 UINT8 reserved_1
: 5;
252 UINT8 page_code
; ///< defined in SFF8090i, V6
254 UINT8 allocation_length
;
265 /// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
269 UINT8 reserved_1
: 5;
273 UINT8 allocation_length
;
281 } ATAPI_REQUEST_SENSE_CMD
;
284 /// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
288 UINT8 reserved_1
: 5;
303 /// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
307 UINT8 reserved_1
: 5;
314 UINT8 allocation_length_hi
;
315 UINT8 allocation_length_lo
;
319 } ATAPI_READ_FORMAT_CAP_CMD
;
322 /// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
326 UINT8 reserved_1
: 5;
329 UINT8 page_control
: 2;
334 UINT8 parameter_list_length_hi
;
335 UINT8 parameter_list_length_lo
;
339 } ATAPI_MODE_SENSE_CMD
;
342 /// ATAPI_PACKET_COMMAND is not defined in ATA specification.
343 /// We add it here for the convenience for ATA/ATAPI module writer.
347 ATAPI_TEST_UNIT_READY_CMD TestUnitReady
;
348 ATAPI_READ10_CMD Read10
;
349 ATAPI_REQUEST_SENSE_CMD RequestSence
;
350 ATAPI_INQUIRY_CMD Inquiry
;
351 ATAPI_MODE_SENSE_CMD ModeSense
;
352 ATAPI_READ_FORMAT_CAP_CMD ReadFormatCapacity
;
353 } ATAPI_PACKET_COMMAND
;
358 #define ATAPI_MAX_DMA_EXT_CMD_SECTORS 0x10000
359 #define ATAPI_MAX_DMA_CMD_SECTORS 0x100
362 // ATA Packet Command Code
364 #define ATA_CMD_SOFT_RESET 0x08 ///< defined from ATA-3
365 #define ATA_CMD_PACKET 0xA0 ///< defined from ATA-3
366 #define ATA_CMD_IDENTIFY_DEVICE 0xA1 ///< defined from ATA-3
367 #define ATA_CMD_SERVICE 0xA2 ///< defined from ATA-3
368 #define ATA_CMD_TEST_UNIT_READY 0x00 ///< defined from ATA-1
369 #define ATA_CMD_REQUEST_SENSE 0x03 ///< defined from ATA-4
370 #define ATA_CMD_INQUIRY 0x12 ///< defined in ATAPI Removable Rewritable Media Devcies
371 #define ATA_CMD_READ_FORMAT_CAPACITY 0x23 ///< defined in ATAPI Removable Rewritable Media Devcies
372 #define ATA_CMD_READ_CAPACITY 0x25 ///< defined in ATAPI Removable Rewritable Media Devcies
373 #define ATA_CMD_READ_10 0x28 ///< defined in ATAPI Removable Rewritable Media Devcies
374 #define ATA_CMD_WRITE_10 0x2A ///< defined in ATAPI Removable Rewritable Media Devcies
381 // Class 1: PIO Data-In Commands
383 #define ATA_CMD_IDENTIFY_DRIVE 0xec ///< defined from ATA-3
384 #define ATA_CMD_READ_BUFFER 0xe4 ///< defined from ATA-1
385 #define ATA_CMD_READ_SECTORS 0x20 ///< defined from ATA-1
386 #define ATA_CMD_READ_SECTORS_WITH_RETRY 0x21 ///< defined from ATA-1, obsoleted from ATA-5
387 #define ATA_CMD_READ_LONG 0x22 ///< defined from ATA-1, obsoleted from ATA-5
388 #define ATA_CMD_READ_LONG_WITH_RETRY 0x23 ///< defined from ATA-1, obsoleted from ATA-5
389 #define ATA_CMD_READ_SECTORS_EXT 0x24 ///< defined from ATA-6
392 // Class 2: PIO Data-Out Commands
394 #define ATA_CMD_FORMAT_TRACK 0x50 ///< defined from ATA-1, obsoleted from ATA-4
395 #define ATA_CMD_WRITE_BUFFER 0xe8 ///< defined from ATA-1
396 #define ATA_CMD_WRITE_SECTORS 0x30 ///< defined from ATA-1
397 #define ATA_CMD_WRITE_SECTORS_WITH_RETRY 0x31 ///< defined from ATA-1, obsoleted from ATA-5
398 #define ATA_CMD_WRITE_LONG 0x32 ///< defined from ATA-1, obsoleted from ATA-5
399 #define ATA_CMD_WRITE_LONG_WITH_RETRY 0x33 ///< defined from ATA-1, obsoleted from ATA-5
400 #define ATA_CMD_WRITE_VERIFY 0x3c ///< defined from ATA-1, obsoleted from ATA-5
401 #define ATA_CMD_WRITE_SECTORS_EXT 0x34 ///< defined from ATA-6
404 // Class 3 No Data Command
406 #define ATA_CMD_ACK_MEDIA_CHANGE 0xdb ///< defined from ATA-1, obsoleted from ATA-5
407 #define ATA_CMD_BOOT_POST_BOOT 0xdc ///< defined from ATA-1, obsoleted from ATA-3
408 #define ATA_CMD_BOOT_PRE_BOOT 0xdd ///< defined from ATA-1, obsoleted from ATA-3
409 #define ATA_CMD_CHECK_POWER_MODE 0x98 ///< defined from ATA-1, obsoleted from ATA-4
410 #define ATA_CMD_CHECK_POWER_MODE_ALIAS 0xe5 ///< defined from ATA-1
411 #define ATA_CMD_DOOR_LOCK 0xde ///< defined from ATA-1
412 #define ATA_CMD_DOOR_UNLOCK 0xdf ///< defined from ATA-1
413 #define ATA_CMD_EXEC_DRIVE_DIAG 0x90 ///< defined from ATA-1
414 #define ATA_CMD_IDLE_ALIAS 0x97 ///< defined from ATA-1, obsoleted from ATA-4
415 #define ATA_CMD_IDLE 0xe3 ///< defined from ATA-1
416 #define ATA_CMD_IDLE_IMMEDIATE 0x95 ///< defined from ATA-1, obsoleted from ATA-4
417 #define ATA_CMD_IDLE_IMMEDIATE_ALIAS 0xe1 ///< defined from ATA-1
418 #define ATA_CMD_INIT_DRIVE_PARAM 0x91 ///< defined from ATA-1, obsoleted from ATA-6
419 #define ATA_CMD_RECALIBRATE 0x10 ///< defined from ATA-1, obsoleted from ATA-4
420 #define ATA_CMD_READ_DRIVE_STATE 0xe9 ///< defined from ATA-1, obsoleted from ATA-3
421 #define ATA_CMD_SET_MULTIPLE_MODE 0xC6 ///< defined from ATA-2
422 #define ATA_CMD_READ_VERIFY 0x40 ///< defined from ATA-1
423 #define ATA_CMD_READ_VERIFY_WITH_RETRY 0x41 ///< defined from ATA-1, obsoleted from ATA-5
424 #define ATA_CMD_SEEK 0x70 ///< defined from ATA-1
425 #define ATA_CMD_SET_FEATURES 0xef ///< defined from ATA-1
426 #define ATA_CMD_STANDBY 0x96 ///< defined from ATA-1, obsoleted from ATA-4
427 #define ATA_CMD_STANDBY_ALIAS 0xe2 ///< defined from ATA-1
428 #define ATA_CMD_STANDBY_IMMEDIATE 0x94 ///< defined from ATA-1, obsoleted from ATA-4
429 #define ATA_CMD_STANDBY_IMMEDIATE_ALIAS 0xe0 ///< defined from ATA-1
433 #define ATA_CMD_SMART 0xb0 ///< defined from ATA-3
434 #define ATA_CONSTANT_C2 0xc2 ///< reserved
435 #define ATA_CONSTANT_4F 0x4f ///< reserved
436 #define ATA_SMART_ENABLE_OPERATION 0xd8 ///< reserved
437 #define ATA_SMART_RETURN_STATUS 0xda ///< defined from ATA-3
440 // Class 4: DMA Command
442 #define ATA_CMD_READ_DMA 0xc8 ///< defined from ATA-1
443 #define ATA_CMD_READ_DMA_WITH_RETRY 0xc9 ///< defined from ATA-1, obsoleted from ATA-5
444 #define ATA_CMD_READ_DMA_EXT 0x25 ///< defined from ATA-6
445 #define ATA_CMD_WRITE_DMA 0xca ///< defined from ATA-1
446 #define ATA_CMD_WRITE_DMA_WITH_RETRY 0xcb ///< defined from ATA-1, obsoleted from ATA-
447 #define ATA_CMD_WRITE_DMA_EXT 0x35 ///< defined from ATA-6
450 /// default content of device control register, disable INT,
451 /// Bit3 is set to 1 according ATA-1
453 #define ATA_DEFAULT_CTL (0x0a)
455 /// default context of Device/Head Register,
456 /// Bit7 and Bit5 are set to 1 for back-compatibilities
458 #define ATA_DEFAULT_CMD (0xa0)
460 #define ATAPI_MAX_BYTE_COUNT (0xfffe)
462 #define ATA_REQUEST_SENSE_ERROR (0x70) ///< defined in SFF-8070i
465 // Sense Key, Additional Sense Codes and Additional Sense Code Qualifier
466 // defined in MultiMedia Commands (MMC, MMC-2)
470 #define ATA_SK_NO_SENSE (0x0)
471 #define ATA_SK_RECOVERY_ERROR (0x1)
472 #define ATA_SK_NOT_READY (0x2)
473 #define ATA_SK_MEDIUM_ERROR (0x3)
474 #define ATA_SK_HARDWARE_ERROR (0x4)
475 #define ATA_SK_ILLEGAL_REQUEST (0x5)
476 #define ATA_SK_UNIT_ATTENTION (0x6)
477 #define ATA_SK_DATA_PROTECT (0x7)
478 #define ATA_SK_BLANK_CHECK (0x8)
479 #define ATA_SK_VENDOR_SPECIFIC (0x9)
480 #define ATA_SK_RESERVED_A (0xA)
481 #define ATA_SK_ABORT (0xB)
482 #define ATA_SK_RESERVED_C (0xC)
483 #define ATA_SK_OVERFLOW (0xD)
484 #define ATA_SK_MISCOMPARE (0xE)
485 #define ATA_SK_RESERVED_F (0xF)
488 // Additional Sense Codes
490 #define ATA_ASC_NOT_READY (0x04)
491 #define ATA_ASC_MEDIA_ERR1 (0x10)
492 #define ATA_ASC_MEDIA_ERR2 (0x11)
493 #define ATA_ASC_MEDIA_ERR3 (0x14)
494 #define ATA_ASC_MEDIA_ERR4 (0x30)
495 #define ATA_ASC_MEDIA_UPSIDE_DOWN (0x06)
496 #define ATA_ASC_INVALID_CMD (0x20)
497 #define ATA_ASC_LBA_OUT_OF_RANGE (0x21)
498 #define ATA_ASC_INVALID_FIELD (0x24)
499 #define ATA_ASC_WRITE_PROTECTED (0x27)
500 #define ATA_ASC_MEDIA_CHANGE (0x28)
501 #define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred
502 #define ATA_ASC_ILLEGAL_FIELD (0x26)
503 #define ATA_ASC_NO_MEDIA (0x3A)
504 #define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)
507 // Additional Sense Code Qualifier
509 #define ATA_ASCQ_IN_PROGRESS (0x01)
514 #define ATA_ERRREG_BBK BIT7 ///< Bad block detected defined from ATA-1, obsoleted from ATA-2
515 #define ATA_ERRREG_UNC BIT6 ///< Uncorrectable Data defined from ATA-1, obsoleted from ATA-4
516 #define ATA_ERRREG_MC BIT5 ///< Media Change defined from ATA-1, obsoleted from ATA-4
517 #define ATA_ERRREG_IDNF BIT4 ///< ID Not Found defined from ATA-1, obsoleted from ATA-4
518 #define ATA_ERRREG_MCR BIT3 ///< Media Change Requested defined from ATA-1, obsoleted from ATA-4
519 #define ATA_ERRREG_ABRT BIT2 ///< Aborted Command defined from ATA-1
520 #define ATA_ERRREG_TK0NF BIT1 ///< Track 0 Not Found defined from ATA-1, obsoleted from ATA-4
521 #define ATA_ERRREG_AMNF BIT0 ///< Address Mark Not Found defined from ATA-1, obsoleted from ATA-4
526 #define ATA_STSREG_BSY BIT7 ///< Controller Busy defined from ATA-1
527 #define ATA_STSREG_DRDY BIT6 ///< Drive Ready defined from ATA-1
528 #define ATA_STSREG_DWF BIT5 ///< Drive Write Fault defined from ATA-1, obsoleted from ATA-4
529 #define ATA_STSREG_DF BIT5 ///< Drive Fault defined from ATA-6
530 #define ATA_STSREG_DSC BIT4 ///< Disk Seek Complete defined from ATA-1, obsoleted from ATA-4
531 #define ATA_STSREG_DRQ BIT3 ///< Data Request defined from ATA-1
532 #define ATA_STSREG_CORR BIT2 ///< Corrected Data defined from ATA-1, obsoleted from ATA-4
533 #define ATA_STSREG_IDX BIT1 ///< Index defined from ATA-1, obsoleted from ATA-4
534 #define ATA_STSREG_ERR BIT0 ///< Error defined from ATA-1
537 // Device Control Register
539 #define ATA_CTLREG_SRST BIT2 ///< Software Reset
540 #define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #