This file contains just some basic definitions that are needed by drivers\r
that dealing with ATA/ATAPI interface.\r
\r
-Copyright (c) 2007 - 2009, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php. \r
+ \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
#pragma pack(1)\r
\r
///\r
-/// ATA_IDENTIFY_DATA is defined in ATA-5\r
+/// ATA5_IDENTIFY_DATA is defined in ATA-5.\r
+/// (This structure is provided mainly for backward-compatibility support.\r
+/// Old drivers may reference fields that are marked "obsolete" in \r
+/// ATA_IDENTIFY_DATA, which currently conforms to ATA-8.) \r
///\r
typedef struct { \r
- UINT16 config; ///< General Configuration \r
- UINT16 cylinders; ///< Number of Cylinders \r
+ UINT16 config; ///< General Configuration.\r
+ UINT16 cylinders; ///< Number of Cylinders.\r
UINT16 reserved_2; \r
- UINT16 heads; ///< Number of logical heads \r
+ UINT16 heads; ///< Number of logical heads. \r
UINT16 vendor_data1; \r
UINT16 vendor_data2; \r
UINT16 sectors_per_track; \r
UINT16 security_status; \r
UINT16 vendor_data_129_159[31]; \r
UINT16 reserved_160_255[96]; \r
+} ATA5_IDENTIFY_DATA;\r
+\r
+///\r
+/// ATA_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec\r
+/// to define the data returned by an ATA device upon successful\r
+/// completion of the ATA IDENTIFY_DEVICE command.\r
+///\r
+typedef struct {\r
+ UINT16 config; ///< General Configuration.\r
+ UINT16 obsolete_1;\r
+ UINT16 specific_config; ///< Specific Configuration.\r
+ UINT16 obsolete_3;\r
+ UINT16 retired_4_5[2]; \r
+ UINT16 obsolete_6;\r
+ UINT16 cfa_reserved_7_8[2];\r
+ UINT16 retired_9; \r
+ CHAR8 SerialNo[20]; ///< word 10~19\r
+ UINT16 retired_20_21[2]; \r
+ UINT16 obsolete_22; \r
+ CHAR8 FirmwareVer[8]; ///< word 23~26\r
+ CHAR8 ModelName[40]; ///< word 27~46\r
+ UINT16 multi_sector_cmd_max_sct_cnt;\r
+ UINT16 trusted_computing_support; \r
+ UINT16 capabilities_49;\r
+ UINT16 capabilities_50;\r
+ UINT16 obsolete_51_52[2]; \r
+ UINT16 field_validity; \r
+ UINT16 obsolete_54_58[5]; \r
+ UINT16 multi_sector_setting;\r
+ UINT16 user_addressable_sectors_lo; \r
+ UINT16 user_addressable_sectors_hi; \r
+ UINT16 obsolete_62; \r
+ UINT16 multi_word_dma_mode; \r
+ UINT16 advanced_pio_modes; \r
+ UINT16 min_multi_word_dma_cycle_time; \r
+ UINT16 rec_multi_word_dma_cycle_time; \r
+ UINT16 min_pio_cycle_time_without_flow_control; \r
+ UINT16 min_pio_cycle_time_with_flow_control; \r
+ UINT16 additional_supported; ///< word 69\r
+ UINT16 reserved_70;\r
+ UINT16 reserved_71_74[4]; ///< Reserved for IDENTIFY PACKET DEVICE cmd.\r
+ UINT16 queue_depth; \r
+ UINT16 serial_ata_capabilities;\r
+ UINT16 reserved_77; ///< Reserved for Serial ATA\r
+ UINT16 serial_ata_features_supported;\r
+ UINT16 serial_ata_features_enabled;\r
+ UINT16 major_version_no; \r
+ UINT16 minor_version_no; \r
+ UINT16 command_set_supported_82; ///< word 82\r
+ UINT16 command_set_supported_83; ///< word 83\r
+ UINT16 command_set_feature_extn; ///< word 84\r
+ UINT16 command_set_feature_enb_85; ///< word 85\r
+ UINT16 command_set_feature_enb_86; ///< word 86\r
+ UINT16 command_set_feature_default; ///< word 87\r
+ UINT16 ultra_dma_mode; ///< word 88 \r
+ UINT16 time_for_security_erase_unit; \r
+ UINT16 time_for_enhanced_security_erase_unit;\r
+ UINT16 advanced_power_management_level;\r
+ UINT16 master_password_identifier;\r
+ UINT16 hardware_configuration_test_result;\r
+ UINT16 obsolete_94;\r
+ UINT16 stream_minimum_request_size;\r
+ UINT16 streaming_transfer_time_for_dma;\r
+ UINT16 streaming_access_latency_for_dma_and_pio;\r
+ UINT16 streaming_performance_granularity[2]; ///< word 98~99\r
+ UINT16 maximum_lba_for_48bit_addressing[4]; ///< word 100~103\r
+ UINT16 streaming_transfer_time_for_pio;\r
+ UINT16 max_no_of_512byte_blocks_per_data_set_cmd;\r
+ UINT16 phy_logic_sector_support; ///< word 106\r
+ UINT16 interseek_delay_for_iso7779;\r
+ UINT16 world_wide_name[4]; ///< word 108~111\r
+ UINT16 reserved_for_128bit_wwn_112_115[4];\r
+ UINT16 reserved_for_technical_report;\r
+ UINT16 logic_sector_size_lo; ///< word 117\r
+ UINT16 logic_sector_size_hi; ///< word 118\r
+ UINT16 features_and_command_sets_supported_ext; ///< word 119\r
+ UINT16 features_and_command_sets_enabled_ext; ///< word 120\r
+ UINT16 reserved_121_126[6];\r
+ UINT16 obsolete_127;\r
+ UINT16 security_status; ///< word 128\r
+ UINT16 vendor_specific_129_159[31]; \r
+ UINT16 cfa_power_mode; ///< word 160\r
+ UINT16 reserved_for_compactflash_161_167[7];\r
+ UINT16 device_nominal_form_factor;\r
+ UINT16 is_data_set_cmd_supported;\r
+ CHAR8 additional_product_identifier[8];\r
+ UINT16 reserved_174_175[2];\r
+ CHAR8 media_serial_number[60]; ///< word 176~205\r
+ UINT16 sct_command_transport; ///< word 206\r
+ UINT16 reserved_207_208[2];\r
+ UINT16 alignment_logic_in_phy_blocks; ///< word 209\r
+ UINT16 write_read_verify_sector_count_mode3[2]; ///< word 210~211\r
+ UINT16 verify_sector_count_mode2[2];\r
+ UINT16 nv_cache_capabilities;\r
+ UINT16 nv_cache_size_in_logical_block_lsw; ///< word 215\r
+ UINT16 nv_cache_size_in_logical_block_msw; ///< word 216\r
+ UINT16 nominal_media_rotation_rate;\r
+ UINT16 reserved_218;\r
+ UINT16 nv_cache_options; ///< word 219\r
+ UINT16 write_read_verify_mode; ///< word 220\r
+ UINT16 reserved_221;\r
+ UINT16 transport_major_revision_number;\r
+ UINT16 transport_minor_revision_number;\r
+ UINT16 reserved_224_229[6];\r
+ UINT64 extended_no_of_addressable_sectors;\r
+ UINT16 min_number_per_download_microcode_mode3; ///< word 234\r
+ UINT16 max_number_per_download_microcode_mode3; ///< word 235\r
+ UINT16 reserved_236_254[19];\r
+ UINT16 integrity_word;\r
} ATA_IDENTIFY_DATA;\r
\r
///\r
-/// ATAPI_IDENTIFY_DATA is defined in ATA-6\r
+/// ATAPI_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec\r
+/// to define the data returned by an ATAPI device upon successful\r
+/// completion of the ATA IDENTIFY_PACKET_DEVICE command.\r
///\r
typedef struct {\r
- UINT16 config; ///< General Configuration\r
- UINT16 obsolete_1;\r
- UINT16 specific_config;\r
- UINT16 obsolete_3;\r
- UINT16 retired_4_5[2];\r
- UINT16 obsolete_6;\r
- UINT16 cfa_reserved_7_8[2];\r
- UINT16 retired_9;\r
- CHAR8 SerialNo[20]; ///< ASCII\r
- UINT16 retired_20_21[2];\r
- UINT16 obsolete_22;\r
- CHAR8 FirmwareVer[8]; ///< ASCII\r
- CHAR8 ModelName[40]; ///< ASCII\r
- UINT16 multi_sector_cmd_max_sct_cnt;\r
- UINT16 reserved_48;\r
- UINT16 capabilities_49;\r
- UINT16 capabilities_50;\r
- UINT16 obsolete_51_52[2];\r
- UINT16 field_validity;\r
- UINT16 obsolete_54_58[5];\r
- UINT16 mutil_sector_setting;\r
- UINT16 user_addressable_sectors_lo;\r
- UINT16 user_addressable_sectors_hi;\r
- UINT16 obsolete_62;\r
- UINT16 multi_word_dma_mode;\r
- UINT16 advanced_pio_modes;\r
- UINT16 min_multi_word_dma_cycle_time;\r
- UINT16 rec_multi_word_dma_cycle_time;\r
- UINT16 min_pio_cycle_time_without_flow_control;\r
- UINT16 min_pio_cycle_time_with_flow_control;\r
- UINT16 reserved_69_74[6];\r
- UINT16 queue_depth;\r
- UINT16 reserved_76_79[4];\r
- UINT16 major_version_no;\r
- UINT16 minor_version_no;\r
- UINT16 cmd_set_support_82;\r
- UINT16 cmd_set_support_83;\r
- UINT16 cmd_feature_support;\r
- UINT16 cmd_feature_enable_85;\r
- UINT16 cmd_feature_enable_86;\r
- UINT16 cmd_feature_default;\r
- UINT16 ultra_dma_select;\r
- UINT16 time_required_for_sec_erase;\r
- UINT16 time_required_for_enhanced_sec_erase;\r
- UINT16 current_advanced_power_mgmt_value;\r
- UINT16 master_pwd_revison_code;\r
- UINT16 hardware_reset_result;\r
- UINT16 current_auto_acoustic_mgmt_value;\r
- UINT16 reserved_95_99[5];\r
- UINT16 max_user_lba_for_48bit_addr[4];\r
- UINT16 reserved_104_126[23];\r
- UINT16 removable_media_status_notification_support;\r
- UINT16 security_status;\r
- UINT16 vendor_data_129_159[31];\r
- UINT16 cfa_power_mode;\r
- UINT16 cfa_reserved_161_175[15];\r
- UINT16 current_media_serial_no[30];\r
- UINT16 reserved_206_254[49];\r
- UINT16 integrity_word;\r
+ UINT16 config; ///< General Configuration.\r
+ UINT16 reserved_1;\r
+ UINT16 specific_config; ///< Specific Configuration.\r
+ UINT16 reserved_3_9[7];\r
+ CHAR8 SerialNo[20]; ///< word 10~19\r
+ UINT16 reserved_20_22[3];\r
+ CHAR8 FirmwareVer[8]; ///< word 23~26\r
+ CHAR8 ModelName[40]; ///< word 27~46\r
+ UINT16 reserved_47_48[2];\r
+ UINT16 capabilities_49;\r
+ UINT16 capabilities_50;\r
+ UINT16 obsolete_51;\r
+ UINT16 reserved_52;\r
+ UINT16 field_validity; ///< word 53\r
+ UINT16 reserved_54_61[8];\r
+ UINT16 dma_dir;\r
+ UINT16 multi_word_dma_mode; ///< word 63\r
+ UINT16 advanced_pio_modes; ///< word 64\r
+ UINT16 min_multi_word_dma_cycle_time;\r
+ UINT16 rec_multi_word_dma_cycle_time;\r
+ UINT16 min_pio_cycle_time_without_flow_control;\r
+ UINT16 min_pio_cycle_time_with_flow_control;\r
+ UINT16 reserved_69_70[2];\r
+ UINT16 obsolete_71_72[2];\r
+ UINT16 reserved_73_74[2];\r
+ UINT16 obsolete_75;\r
+ UINT16 serial_ata_capabilities;\r
+ UINT16 reserved_77; ///< Reserved for Serial ATA\r
+ UINT16 serial_ata_features_supported;\r
+ UINT16 serial_ata_features_enabled;\r
+ UINT16 major_version_no; ///< word 80\r
+ UINT16 minor_version_no; ///< word 81\r
+ UINT16 cmd_set_support_82;\r
+ UINT16 cmd_set_support_83;\r
+ UINT16 cmd_feature_support;\r
+ UINT16 cmd_feature_enable_85;\r
+ UINT16 cmd_feature_enable_86;\r
+ UINT16 cmd_feature_default;\r
+ UINT16 ultra_dma_select;\r
+ UINT16 time_required_for_sec_erase; ///< word 89\r
+ UINT16 time_required_for_enhanced_sec_erase; ///< word 90\r
+ UINT16 advanced_power_management_level;\r
+ UINT16 master_pwd_revison_code;\r
+ UINT16 hardware_reset_result; ///< word 93\r
+ UINT16 obsolete_94;\r
+ UINT16 reserved_95_107[13];\r
+ UINT16 world_wide_name[4]; ///< word 108~111\r
+ UINT16 reserved_for_128bit_wwn_112_115[4];\r
+ UINT16 reserved_116_118[3]; \r
+ UINT16 command_and_feature_sets_supported; ///< word 119\r
+ UINT16 command_and_feature_sets_supported_enabled;\r
+ UINT16 reserved_121_124[4];\r
+ UINT16 atapi_byte_count_0_behavior; ///< word 125\r
+ UINT16 obsolete_126_127[2];\r
+ UINT16 security_status;\r
+ UINT16 reserved_129_159[31];\r
+ UINT16 cfa_reserved_160_175[16];\r
+ UINT16 reserved_176_221[46];\r
+ UINT16 transport_major_version;\r
+ UINT16 transport_minor_version;\r
+ UINT16 reserved_224_254[31];\r
+ UINT16 integrity_word;\r
} ATAPI_IDENTIFY_DATA;\r
\r
+\r
///\r
-/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 peripheral_type;\r
UINT8 RMB;\r
UINT8 version;\r
UINT8 response_data_format;\r
- UINT8 addnl_length; ///< n - 4, Numbers of bytes following this one\r
+ UINT8 addnl_length; ///< n - 4, Numbers of bytes following this one.\r
UINT8 reserved_5;\r
UINT8 reserved_6;\r
UINT8 reserved_7;\r
UINT8 vendor_specific_36_55[55 - 36 + 1];\r
UINT8 reserved_56_95[95 - 56 + 1];\r
///\r
- /// Vendor specific parameters fields, the sizeof (ATAPI_INQUIRY_DATA) is 254\r
+ /// Vendor-specific parameters fields. The sizeof (ATAPI_INQUIRY_DATA) is 254\r
/// since allocation_length is one byte in ATAPI_INQUIRY_CMD.\r
///\r
UINT8 vendor_specific_96_253[253 - 96 + 1];\r
} ATAPI_INQUIRY_DATA;\r
\r
///\r
-/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 error_code : 7;\r
} ATAPI_REQUEST_SENSE_DATA;\r
\r
///\r
-/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 LastLba3;\r
\r
///\r
/// Capacity List Header + Current/Maximum Capacity Descriptor,\r
-/// defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 reserved_0;\r
} ATAPI_READ_FORMAT_CAPACITY_DATA;\r
\r
///\r
-/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_TEST_UNIT_READY_CMD;\r
\r
///\r
-/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_INQUIRY_CMD;\r
\r
///\r
-/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_REQUEST_SENSE_CMD;\r
\r
///\r
-/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_READ10_CMD;\r
\r
///\r
-/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_READ_FORMAT_CAP_CMD;\r
\r
///\r
-/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_MODE_SENSE_CMD;\r
\r
///\r
-/// ATAPI_PACKET_COMMAND is not defined in ATA specification.\r
-/// We add it here for the convenience for ATA/ATAPI module writer. \r
+/// ATAPI_PACKET_COMMAND is not defined in the ATA specification.\r
+/// We add it here for the convenience of ATA/ATAPI module writers. \r
///\r
typedef union {\r
UINT16 Data16[6];\r
#define ATA_CMD_READ_CAPACITY 0x25 ///< defined in ATAPI Removable Rewritable Media Devcies\r
#define ATA_CMD_READ_10 0x28 ///< defined in ATAPI Removable Rewritable Media Devcies\r
#define ATA_CMD_WRITE_10 0x2A ///< defined in ATAPI Removable Rewritable Media Devcies\r
+#define ATA_CMD_READ_12 0xA8 ///< defined in ATAPI Removable Rewritable Media Devcies\r
+#define ATA_CMD_WRITE_12 0xAA ///< defined in ATAPI Removable Rewritable Media Devcies\r
+#define ATA_CMD_START_STOP_UNIT 0x1B ///< defined in ATAPI Removable Rewritable Media Devcies\r
+///\r
+/// Start/Stop and Eject Operations\r
+///\r
+///@{\r
+#define ATA_CMD_SUBOP_STOP_DISC 0x00 ///< Stop the Disc\r
+#define ATA_CMD_SUBOP_START_DISC 0x01 ///< Start the Disc and acquire the format type\r
+#define ATA_CMD_SUBOP_EJECT_DISC 0x02 ///< Eject the Disc if possible\r
+#define ATA_CMD_SUBOP_CLOSE_TRAY 0x03 ///< Load the Disc (Close Tray)\r
+///@}\r
\r
//\r
// ATA Commands Code\r
#define ATA_CMD_WRITE_DMA_EXT 0x35 ///< defined from ATA-6\r
\r
///\r
-/// default content of device control register, disable INT,\r
+/// Default content of device control register, disable INT,\r
/// Bit3 is set to 1 according ATA-1\r
///\r
#define ATA_DEFAULT_CTL (0x0a) \r
///\r
-/// default context of Device/Head Register,\r
-/// Bit7 and Bit5 are set to 1 for back-compatibilities\r
+/// Default context of Device/Head Register,\r
+/// Bit7 and Bit5 are set to 1 for back-compatibilities.\r
///\r
#define ATA_DEFAULT_CMD (0xa0)\r
\r
#define ATA_ASC_INVALID_FIELD (0x24)\r
#define ATA_ASC_WRITE_PROTECTED (0x27)\r
#define ATA_ASC_MEDIA_CHANGE (0x28)\r
-#define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred\r
+#define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred.\r
#define ATA_ASC_ILLEGAL_FIELD (0x26)\r
#define ATA_ASC_NO_MEDIA (0x3A)\r
#define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)\r
//\r
// Device Control Register\r
//\r
-#define ATA_CTLREG_SRST BIT2 ///< Software Reset\r
-#define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #\r
+#define ATA_CTLREG_SRST BIT2 ///< Software Reset.\r
+#define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #.\r
\r
#endif\r
\r
projects / mirror_edk2.git / blobdiff