2 This file contains just some basic definitions that are needed by drivers
3 that dealing with ATA/ATAPI interface.
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
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 /// ATAPI_IDENTIFY_DATA is defined in ATA-6
25 UINT16 config
; ///< General Configuration
27 UINT16 specific_config
;
29 UINT16 retired_4_5
[2];
31 UINT16 cfa_reserved_7_8
[2];
33 CHAR8 SerialNo
[20]; ///< ASCII
34 UINT16 retired_20_21
[2];
36 CHAR8 FirmwareVer
[8]; ///< ASCII
37 CHAR8 ModelName
[40]; ///< ASCII
38 UINT16 multi_sector_cmd_max_sct_cnt
;
40 UINT16 capabilities_49
;
41 UINT16 capabilities_50
;
42 UINT16 obsolete_51_52
[2];
43 UINT16 field_validity
;
44 UINT16 obsolete_54_58
[5];
45 UINT16 mutil_sector_setting
;
46 UINT16 user_addressable_sectors_lo
;
47 UINT16 user_addressable_sectors_hi
;
49 UINT16 multi_word_dma_mode
;
50 UINT16 advanced_pio_modes
;
51 UINT16 min_multi_word_dma_cycle_time
;
52 UINT16 rec_multi_word_dma_cycle_time
;
53 UINT16 min_pio_cycle_time_without_flow_control
;
54 UINT16 min_pio_cycle_time_with_flow_control
;
55 UINT16 reserved_69_74
[6];
57 UINT16 reserved_76_79
[4];
58 UINT16 major_version_no
;
59 UINT16 minor_version_no
;
60 UINT16 cmd_set_support_82
;
61 UINT16 cmd_set_support_83
;
62 UINT16 cmd_feature_support
;
63 UINT16 cmd_feature_enable_85
;
64 UINT16 cmd_feature_enable_86
;
65 UINT16 cmd_feature_default
;
66 UINT16 ultra_dma_select
;
67 UINT16 time_required_for_sec_erase
;
68 UINT16 time_required_for_enhanced_sec_erase
;
69 UINT16 current_advanced_power_mgmt_value
;
70 UINT16 master_pwd_revison_code
;
71 UINT16 hardware_reset_result
;
72 UINT16 current_auto_acoustic_mgmt_value
;
73 UINT16 reserved_95_99
[5];
74 UINT16 max_user_lba_for_48bit_addr
[4];
75 UINT16 reserved_104_126
[23];
76 UINT16 removable_media_status_notification_support
;
77 UINT16 security_status
;
78 UINT16 vendor_data_129_159
[31];
79 UINT16 cfa_power_mode
;
80 UINT16 cfa_reserved_161_175
[15];
81 UINT16 current_media_serial_no
[30];
82 UINT16 reserved_206_254
[49];
83 UINT16 integrity_word
;
84 } ATAPI_IDENTIFY_DATA
;
87 /// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
90 UINT8 peripheral_type
;
93 UINT8 response_data_format
;
94 UINT8 addnl_length
; ///< n - 4, Numbers of bytes following this one
100 UINT8 product_revision_level
[4];
101 UINT8 vendor_specific_36_55
[55 - 36 + 1];
102 UINT8 reserved_56_95
[95 - 56 + 1];
104 /// Vendor specific parameters fields, the sizeof (ATAPI_INQUIRY_DATA) is 254
105 /// since allocation_length is one byte in ATAPI_INQUIRY_CMD.
107 UINT8 vendor_specific_96_253
[253 - 96 + 1];
108 } ATAPI_INQUIRY_DATA
;
111 /// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
114 UINT8 error_code
: 7;
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;
134 UINT8 sense_key_specific_16
;
135 UINT8 sense_key_specific_17
;
137 /// Followed by additional sense bytes.
138 /// the sizeof (ATAPI_REQUEST_SENSE_DATA) is 254,
139 /// since allocation_length is one byte in ATAPI_INQUIRY_CMD.
141 UINT8 additional_sense_bytes_18_253
[253 - 18 + 1];
142 } ATAPI_REQUEST_SENSE_DATA
;
145 /// The followings are defined in SFF-8070i(ATAPI Removable Rewritable Specification)
149 /// READ CAPACITY Data
160 } ATAPI_READ_CAPACITY_DATA
;
163 /// Capacity List Header + Current/Maximum Capacity Descriptor,
169 UINT8 Capacity_Length
;
175 UINT8 reserved_9
: 6;
179 } ATAPI_READ_FORMAT_CAPACITY_DATA
;
182 /// Test Unit Ready Command
197 } ATAPI_TEST_UNIT_READY_CMD
;
204 UINT8 reserved_1
: 5;
206 UINT8 page_code
; ///< defined in SFF8090i, V6
208 UINT8 allocation_length
;
219 /// REQUEST SENSE Command
223 UINT8 reserved_1
: 5;
227 UINT8 allocation_length
;
235 } ATAPI_REQUEST_SENSE_CMD
;
238 /// READ (10) Command
242 UINT8 reserved_1
: 5;
257 /// READ Format Capacity Command
261 UINT8 reserved_1
: 5;
268 UINT8 allocation_length_hi
;
269 UINT8 allocation_length_lo
;
273 } ATAPI_READ_FORMAT_CAP_CMD
;
276 /// MODE SENSE Command
280 UINT8 reserved_1
: 5;
283 UINT8 page_control
: 2;
288 UINT8 parameter_list_length_hi
;
289 UINT8 parameter_list_length_lo
;
293 } ATAPI_MODE_SENSE_CMD
;
296 /// ATAPI_PACKET_COMMAND is not defined in ATA specification.
297 /// We add it here for the convenience for ATA/ATAPI module writer.
301 ATAPI_TEST_UNIT_READY_CMD TestUnitReady
;
302 ATAPI_READ10_CMD Read10
;
303 ATAPI_REQUEST_SENSE_CMD RequestSence
;
304 ATAPI_INQUIRY_CMD Inquiry
;
305 ATAPI_MODE_SENSE_CMD ModeSense
;
306 ATAPI_READ_FORMAT_CAP_CMD ReadFormatCapacity
;
307 } ATAPI_PACKET_COMMAND
;
312 #define ATAPI_MAX_DMA_EXT_CMD_SECTORS 0x10000
313 #define ATAPI_MAX_DMA_CMD_SECTORS 0x100
316 // ATA Packet Command Code
318 #define ATA_CMD_SOFT_RESET 0x08 ///< defined in ATA-6
319 #define ATA_CMD_PACKET 0xA0 ///< defined in ATA-6
320 #define ATA_CMD_IDENTIFY_DEVICE 0xA1 ///< defined in ATA-6
321 #define ATA_CMD_SERVICE 0xA2 ///< defined in ATA-6
322 #define ATA_CMD_TEST_UNIT_READY 0x00 ///< defined in ATA-6
323 #define ATA_CMD_REQUEST_SENSE 0x03 ///< defined in ATA-6
324 #define ATA_CMD_INQUIRY 0x12 ///< defined in ATAPI Removable Rewritable Media Devcies
325 #define ATA_CMD_READ_FORMAT_CAPACITY 0x23 ///< defined in ATAPI Removable Rewritable Media Devcies
326 #define ATA_CMD_READ_CAPACITY 0x25 ///< defined in ATAPI Removable Rewritable Media Devcies
327 #define ATA_CMD_READ_10 0x28 ///< defined in ATAPI Removable Rewritable Media Devcies
328 #define ATA_CMD_WRITE_10 0x2A ///< defined in ATAPI Removable Rewritable Media Devcies
335 // Class 1: PIO Data-In Commands
337 #define ATA_CMD_IDENTIFY_DRIVE 0xec
338 #define ATA_CMD_READ_BUFFER 0xe4
339 #define ATA_CMD_READ_SECTORS 0x20 ///< defined in ATA-5
340 #define ATA_CMD_READ_SECTORS_WITH_RETRY 0x21 ///< defined in ATA-5
341 #define ATA_CMD_READ_LONG 0x22 ///< defined in ATA-5
342 #define ATA_CMD_READ_LONG_WITH_RETRY 0x23 ///< defined in ATA-5
343 #define ATA_CMD_READ_SECTORS_EXT 0x24 ///< defined in ATA-6
347 // Class 2: PIO Data-Out Commands
349 #define ATA_CMD_FORMAT_TRACK 0x50 ///< defined in ATA-3
350 #define ATA_CMD_WRITE_BUFFER 0xe8 ///< defined in ATA-6
351 #define ATA_CMD_WRITE_SECTORS 0x30 ///< defined in ATA-6
352 #define ATA_CMD_WRITE_SECTORS_WITH_RETRY 0x31 ///< defined in ATA-4
353 #define ATA_CMD_WRITE_LONG 0x32 ///< defined in ATA-3
354 #define ATA_CMD_WRITE_LONG_WITH_RETRY 0x33 ///< defined in ATA-3
355 #define ATA_CMD_WRITE_VERIFY 0x3c ///< defined in ATA-3
356 #define ATA_CMD_WRITE_SECTORS_EXT 0x34 ///< defined in ATA-6
359 // Class 3 No Data Command
361 #define ATA_CMD_ACK_MEDIA_CHANGE 0xdb ///< defined in ATA-2
362 #define ATA_CMD_BOOT_POST_BOOT 0xdc ///< defined in ATA-2
363 #define ATA_CMD_BOOT_PRE_BOOT 0xdd ///< defined in ATA-2
364 #define ATA_CMD_CHECK_POWER_MODE 0x98 ///< defined in ATA-3
365 #define ATA_CMD_CHECK_POWER_MODE_ALIAS 0xe5 ///< defined in ATA-6
366 #define ATA_CMD_DOOR_LOCK 0xde ///< defined in ATA-6
367 #define ATA_CMD_DOOR_UNLOCK 0xdf ///< defined in ATA-6
368 #define ATA_CMD_EXEC_DRIVE_DIAG 0x90 ///< defined in ATA-6
369 #define ATA_CMD_IDLE_ALIAS 0x97 ///< defined in ATA-3
370 #define ATA_CMD_IDLE 0xe3 ///< defined in ATA-6
371 #define ATA_CMD_IDLE_IMMEDIATE 0x95 ///< defined in ATA-3
372 #define ATA_CMD_IDLE_IMMEDIATE_ALIAS 0xe1 ///< defined in ATA-6
373 #define ATA_CMD_INIT_DRIVE_PARAM 0x91 ///< defined in ATA-5
374 #define ATA_CMD_RECALIBRATE 0x10 ///< defined in ATA-3
375 #define ATA_CMD_READ_DRIVE_STATE 0xe9 ///< defined in ATA-2
376 #define ATA_CMD_SET_MULTIPLE_MODE 0xC6 ///< defined in ATA-6
377 #define ATA_CMD_READ_VERIFY 0x40 ///< defined in ATA-6
378 #define ATA_CMD_READ_VERIFY_WITH_RETRY 0x41 ///< defined in ATA-4
379 #define ATA_CMD_SEEK 0x70 ///< defined in ATA-6
380 #define ATA_CMD_SET_FEATURES 0xef ///< defined in ATA-6
381 #define ATA_CMD_STANDBY 0x96 ///< defined in ATA-3
382 #define ATA_CMD_STANDBY_ALIAS 0xe2 ///< defined in ATA-6
383 #define ATA_CMD_STANDBY_IMMEDIATE 0x94 ///< defined in ATA-3
384 #define ATA_CMD_STANDBY_IMMEDIATE_ALIAS 0xe0 ///< defined in ATA-6
388 #define ATA_CMD_SMART 0xb0
389 #define ATA_CONSTANT_C2 0xc2
390 #define ATA_CONSTANT_4F 0x4f
391 #define ATA_SMART_ENABLE_OPERATION 0xd8
392 #define ATA_SMART_RETURN_STATUS 0xda
396 /// Class 4: DMA Command
398 #define ATA_CMD_READ_DMA 0xc8 ///< defined in ATA-6
399 #define ATA_CMD_READ_DMA_WITH_RETRY 0xc9 ///< defined in ATA-4
400 #define ATA_CMD_READ_DMA_EXT 0x25 ///< defined in ATA-6
401 #define ATA_CMD_WRITE_DMA 0xca ///< defined in ATA-6
402 #define ATA_CMD_WRITE_DMA_WITH_RETRY 0xcb ///< defined in ATA-4
403 #define ATA_CMD_WRITE_DMA_EXT 0x35 ///< defined in ATA-6
408 /// default content of device control register, disable INT,
409 /// Bit3 is set to 1 according ATA-1
411 #define ATA_DEFAULT_CTL (0x0a)
413 /// default context of Device/Head Register,
414 /// Bit7 and Bit5 are set to 1 for back-compatibilities
416 #define ATA_DEFAULT_CMD (0xa0)
418 #define ATAPI_MAX_BYTE_COUNT (0xfffe)
420 #define ATA_REQUEST_SENSE_ERROR (0x70) ///< defined in SFF-8070i
423 /// Sense Key, Additional Sense Codes and Additional Sense Code Qualifier
424 /// defined in MultiMedia Commands (MMC, MMC-2)
428 #define ATA_SK_NO_SENSE (0x0)
429 #define ATA_SK_RECOVERY_ERROR (0x1)
430 #define ATA_SK_NOT_READY (0x2)
431 #define ATA_SK_MEDIUM_ERROR (0x3)
432 #define ATA_SK_HARDWARE_ERROR (0x4)
433 #define ATA_SK_ILLEGAL_REQUEST (0x5)
434 #define ATA_SK_UNIT_ATTENTION (0x6)
435 #define ATA_SK_DATA_PROTECT (0x7)
436 #define ATA_SK_BLANK_CHECK (0x8)
437 #define ATA_SK_VENDOR_SPECIFIC (0x9)
438 #define ATA_SK_RESERVED_A (0xA)
439 #define ATA_SK_ABORT (0xB)
440 #define ATA_SK_RESERVED_C (0xC)
441 #define ATA_SK_OVERFLOW (0xD)
442 #define ATA_SK_MISCOMPARE (0xE)
443 #define ATA_SK_RESERVED_F (0xF)
446 /// Additional Sense Codes
448 #define ATA_ASC_NOT_READY (0x04)
449 #define ATA_ASC_MEDIA_ERR1 (0x10)
450 #define ATA_ASC_MEDIA_ERR2 (0x11)
451 #define ATA_ASC_MEDIA_ERR3 (0x14)
452 #define ATA_ASC_MEDIA_ERR4 (0x30)
453 #define ATA_ASC_MEDIA_UPSIDE_DOWN (0x06)
454 #define ATA_ASC_INVALID_CMD (0x20)
455 #define ATA_ASC_LBA_OUT_OF_RANGE (0x21)
456 #define ATA_ASC_INVALID_FIELD (0x24)
457 #define ATA_ASC_WRITE_PROTECTED (0x27)
458 #define ATA_ASC_MEDIA_CHANGE (0x28)
459 #define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred
460 #define ATA_ASC_ILLEGAL_FIELD (0x26)
461 #define ATA_ASC_NO_MEDIA (0x3A)
462 #define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)
465 // Additional Sense Code Qualifier
467 #define ATA_ASCQ_IN_PROGRESS (0x01)
472 #define ATA_ERRREG_BBK BIT7 ///< Bad block detected defined in ATA-1
473 #define ATA_ERRREG_UNC BIT6 ///< Uncorrectable Data defined in ATA-3
474 #define ATA_ERRREG_MC BIT5 ///< Media Change defined in ATA-3
475 #define ATA_ERRREG_IDNF BIT4 ///< ID Not Found defined in ATA-3
476 #define ATA_ERRREG_MCR BIT3 ///< Media Change Requested defined in ATA-3
477 #define ATA_ERRREG_ABRT BIT2 ///< Aborted Command defined in ATA-6
478 #define ATA_ERRREG_TK0NF BIT1 ///< Track 0 Not Found defined in ATA-3
479 #define ATA_ERRREG_AMNF BIT0 ///< Address Mark Not Found defined in ATA-3
484 #define ATA_STSREG_BSY BIT7 ///< Controller Busy defined in ATA-6
485 #define ATA_STSREG_DRDY BIT6 ///< Drive Ready defined in ATA-6
486 #define ATA_STSREG_DWF BIT5 ///< Drive Write Fault defined in ATA-6
487 #define ATA_STSREG_DSC BIT4 ///< Disk Seek Complete defined in ATA-3
488 #define ATA_STSREG_DRQ BIT3 ///< Data Request defined in ATA-6
489 #define ATA_STSREG_CORR BIT2 ///< Corrected Data defined in ATA-3
490 #define ATA_STSREG_IDX BIT1 ///< Index defined in ATA-3
491 #define ATA_STSREG_ERR BIT0 ///< Error defined in ATA-6
494 /// Device Control Register
496 #define ATA_CTLREG_SRST BIT2 ///< Software Reset
497 #define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #