X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FIndustryStandard%2FAtapi.h;h=3d6e5120713baa2134b67ff012ca06bc6e6ab3de;hb=2096185d2a1babffa0d0541d71e67d7e3604e37d;hp=ff6cc593bb9a88fa65efbb941f5511eecc4218ab;hpb=373b5cf97cc650d2e81d4909ff5327b6ce0b6c26;p=mirror_edk2.git diff --git a/MdePkg/Include/IndustryStandard/Atapi.h b/MdePkg/Include/IndustryStandard/Atapi.h index ff6cc593bb..3d6e512071 100644 --- a/MdePkg/Include/IndustryStandard/Atapi.h +++ b/MdePkg/Include/IndustryStandard/Atapi.h @@ -1,219 +1,298 @@ /** @file - -This file contains just some basic definitions that are needed by drivers -that dealing with ATA/ATAPI interface. - - -Copyright (c) 2007, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + This file contains just some basic definitions that are needed by drivers + that dealing with ATA/ATAPI interface. + +Copyright (c) 2007 - 2012, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. +The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ -#ifndef _ATAPI_H -#define _ATAPI_H +#ifndef _ATAPI_H_ +#define _ATAPI_H_ #pragma pack(1) -// -// ATA_IDENTIFY_DATA is defined in ATA-5 -// +/// +/// ATA5_IDENTIFY_DATA is defined in ATA-5. +/// (This structure is provided mainly for backward-compatibility support. +/// Old drivers may reference fields that are marked "obsolete" in +/// ATA_IDENTIFY_DATA, which currently conforms to ATA-8.) +/// +typedef struct { + UINT16 config; ///< General Configuration. + UINT16 cylinders; ///< Number of Cylinders. + UINT16 reserved_2; + UINT16 heads; ///< Number of logical heads. + UINT16 vendor_data1; + UINT16 vendor_data2; + UINT16 sectors_per_track; + UINT16 vendor_specific_7_9[3]; + CHAR8 SerialNo[20]; ///< ASCII + UINT16 vendor_specific_20_21[2]; + UINT16 ecc_bytes_available; + CHAR8 FirmwareVer[8]; ///< ASCII + CHAR8 ModelName[40]; ///< ASCII + UINT16 multi_sector_cmd_max_sct_cnt; + UINT16 reserved_48; + UINT16 capabilities; + UINT16 reserved_50; + UINT16 pio_cycle_timing; + UINT16 reserved_52; + UINT16 field_validity; + UINT16 current_cylinders; + UINT16 current_heads; + UINT16 current_sectors; + UINT16 CurrentCapacityLsb; + UINT16 CurrentCapacityMsb; + UINT16 reserved_59; + UINT16 user_addressable_sectors_lo; + UINT16 user_addressable_sectors_hi; + UINT16 reserved_62; + UINT16 multi_word_dma_mode; + UINT16 advanced_pio_modes; + UINT16 min_multi_word_dma_cycle_time; + UINT16 rec_multi_word_dma_cycle_time; + UINT16 min_pio_cycle_time_without_flow_control; + UINT16 min_pio_cycle_time_with_flow_control; + UINT16 reserved_69_79[11]; + UINT16 major_version_no; + UINT16 minor_version_no; + UINT16 command_set_supported_82; ///< word 82 + UINT16 command_set_supported_83; ///< word 83 + UINT16 command_set_feature_extn; ///< word 84 + UINT16 command_set_feature_enb_85; ///< word 85 + UINT16 command_set_feature_enb_86; ///< word 86 + UINT16 command_set_feature_default; ///< word 87 + UINT16 ultra_dma_mode; ///< word 88 + UINT16 reserved_89_127[39]; + UINT16 security_status; + UINT16 vendor_data_129_159[31]; + UINT16 reserved_160_255[96]; +} ATA5_IDENTIFY_DATA; + +/// +/// ATA_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec +/// to define the data returned by an ATA device upon successful +/// completion of the ATA IDENTIFY_DEVICE command. +/// typedef struct { - UINT16 config; /* General Configuration */ - UINT16 cylinders; /* Number of Cylinders */ - UINT16 reserved_2; - UINT16 heads; /* Number of logical heads */ - UINT16 vendor_data1; - UINT16 vendoe_data2; - UINT16 sectors_per_track; - UINT16 vendor_specific_7_9[3]; - CHAR8 SerialNo[20]; /* ASCII */ - UINT16 vendor_specific_20_21[2]; - UINT16 ecc_bytes_available; - CHAR8 FirmwareVer[8]; /* ASCII */ - CHAR8 ModelName[40]; /* ASCII */ + UINT16 config; ///< General Configuration. + UINT16 obsolete_1; + UINT16 specific_config; ///< Specific Configuration. + UINT16 obsolete_3; + UINT16 retired_4_5[2]; + UINT16 obsolete_6; + UINT16 cfa_reserved_7_8[2]; + UINT16 retired_9; + CHAR8 SerialNo[20]; ///< word 10~19 + UINT16 retired_20_21[2]; + UINT16 obsolete_22; + CHAR8 FirmwareVer[8]; ///< word 23~26 + CHAR8 ModelName[40]; ///< word 27~46 UINT16 multi_sector_cmd_max_sct_cnt; - UINT16 reserved_48; - UINT16 capabilities; - UINT16 reserved_50; - UINT16 pio_cycle_timing; + UINT16 trusted_computing_support; + UINT16 capabilities_49; + UINT16 capabilities_50; + UINT16 obsolete_51_52[2]; + UINT16 field_validity; + UINT16 obsolete_54_58[5]; + UINT16 multi_sector_setting; + UINT16 user_addressable_sectors_lo; + UINT16 user_addressable_sectors_hi; + UINT16 obsolete_62; + UINT16 multi_word_dma_mode; + UINT16 advanced_pio_modes; + UINT16 min_multi_word_dma_cycle_time; + UINT16 rec_multi_word_dma_cycle_time; + UINT16 min_pio_cycle_time_without_flow_control; + UINT16 min_pio_cycle_time_with_flow_control; + UINT16 reserved_69_74[6]; + UINT16 queue_depth; + UINT16 reserved_76_79[4]; ///< Reserved for Serial ATA. + UINT16 major_version_no; + UINT16 minor_version_no; + UINT16 command_set_supported_82; ///< word 82 + UINT16 command_set_supported_83; ///< word 83 + UINT16 command_set_feature_extn; ///< word 84 + UINT16 command_set_feature_enb_85; ///< word 85 + UINT16 command_set_feature_enb_86; ///< word 86 + UINT16 command_set_feature_default; ///< word 87 + UINT16 ultra_dma_mode; ///< word 88 + UINT16 time_for_security_erase_unit; + UINT16 time_for_enhanced_security_erase_unit; + UINT16 advanced_power_management_level; + UINT16 master_password_identifier; + UINT16 hardware_configuration_test_result; + UINT16 acoustic_management_value; + UINT16 stream_minimum_request_size; + UINT16 streaming_transfer_time_for_dma; + UINT16 streaming_access_latency_for_dma_and_pio; + UINT16 streaming_performance_granularity[2]; ///< word 98~99 + UINT16 maximum_lba_for_48bit_addressing[4]; ///< word 100~103 + UINT16 streaming_transfer_time_for_pio; + UINT16 reserved_105; + UINT16 phy_logic_sector_support; ///< word 106 + UINT16 interseek_delay_for_iso7779; + UINT16 world_wide_name[4]; ///< word 108~111 + UINT16 reserved_for_128bit_wwn_112_115[4]; + UINT16 reserved_for_technical_report; + UINT16 logic_sector_size_lo; ///< word 117 + UINT16 logic_sector_size_hi; ///< word 118 + UINT16 features_and_command_sets_supported_ext; ///< word 119 + UINT16 features_and_command_sets_enabled_ext; ///< word 120 + UINT16 reserved_121_126[6]; + UINT16 obsolete_127; + UINT16 security_status; ///< word 128 + UINT16 vendor_specific_129_159[31]; + UINT16 cfa_power_mode; ///< word 160 + UINT16 reserved_for_compactflash_161_175[15]; + CHAR8 media_serial_number[60]; ///< word 176~205 + UINT16 sct_command_transport; ///< word 206 + UINT16 reserved_207_208[2]; + UINT16 alignment_logic_in_phy_blocks; ///< word 209 + UINT16 write_read_verify_sector_count_mode3[2]; ///< word 210~211 + UINT16 verify_sector_count_mode2[2]; + UINT16 nv_cache_capabilities; + UINT16 nv_cache_size_in_logical_block_lsw; ///< word 215 + UINT16 nv_cache_size_in_logical_block_msw; ///< word 216 + UINT16 nv_cache_read_speed; + UINT16 nv_cache_write_speed; + UINT16 nv_cache_options; ///< word 219 + UINT16 write_read_verify_mode; ///< word 220 + UINT16 reserved_221; + UINT16 transport_major_revision_number; + UINT16 transport_minor_revision_number; + UINT16 reserved_224_233[10]; + UINT16 min_number_per_download_microcode_mode3; ///< word 234 + UINT16 max_number_per_download_microcode_mode3; ///< word 235 + UINT16 reserved_236_254[19]; + UINT16 integrity_word; +} ATA_IDENTIFY_DATA; + +/// +/// ATAPI_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec +/// to define the data returned by an ATAPI device upon successful +/// completion of the ATA IDENTIFY_PACKET_DEVICE command. +/// +typedef struct { + UINT16 config; ///< General Configuration. + UINT16 reserved_1; + UINT16 specific_config; ///< Specific Configuration. + UINT16 reserved_3_9[7]; + CHAR8 SerialNo[20]; ///< word 10~19 + UINT16 reserved_20_22[3]; + CHAR8 FirmwareVer[8]; ///< word 23~26 + CHAR8 ModelName[40]; ///< word 27~46 + UINT16 reserved_47_48[2]; + UINT16 capabilities_49; + UINT16 capabilities_50; + UINT16 obsolete_51; UINT16 reserved_52; - UINT16 field_validity; - UINT16 current_cylinders; - UINT16 current_heads; - UINT16 current_sectors; - UINT16 CurrentCapacityLsb; - UINT16 CurrentCapacityMsb; - UINT16 reserved_59; - UINT16 user_addressable_sectors_lo; - UINT16 user_addressable_sectors_hi; - UINT16 reserved_62; - UINT16 multi_word_dma_mode; - UINT16 advanced_pio_modes; + UINT16 field_validity; ///< word 53 + UINT16 reserved_54_61[8]; + UINT16 dma_dir; + UINT16 multi_word_dma_mode; ///< word 63 + UINT16 advanced_pio_modes; ///< word 64 UINT16 min_multi_word_dma_cycle_time; UINT16 rec_multi_word_dma_cycle_time; UINT16 min_pio_cycle_time_without_flow_control; UINT16 min_pio_cycle_time_with_flow_control; - UINT16 reserved_69_79[11]; - UINT16 major_version_no; - UINT16 minor_version_no; - UINT16 command_set_supported_82; // word 82 - UINT16 command_set_supported_83; // word 83 - UINT16 command_set_feature_extn; // word 84 - UINT16 command_set_feature_enb_85; // word 85 - UINT16 command_set_feature_enb_86; // word 86 - UINT16 command_set_feature_default; // word 87 - UINT16 ultra_dma_mode; // word 88 - UINT16 reserved_89_127[39]; + UINT16 reserved_69_70[2]; + UINT16 obsolete_71_72[2]; + UINT16 reserved_73_74[2]; + UINT16 queue_depth; + UINT16 reserved_76_79[4]; + UINT16 major_version_no; ///< word 80 + UINT16 minor_version_no; ///< word 81 + UINT16 cmd_set_support_82; + UINT16 cmd_set_support_83; + UINT16 cmd_feature_support; + UINT16 cmd_feature_enable_85; + UINT16 cmd_feature_enable_86; + UINT16 cmd_feature_default; + UINT16 ultra_dma_select; + UINT16 time_required_for_sec_erase; ///< word 89 + UINT16 time_required_for_enhanced_sec_erase; ///< word 90 + UINT16 reserved_91; + UINT16 master_pwd_revison_code; + UINT16 hardware_reset_result; ///< word 93 + UINT16 current_auto_acoustic_mgmt_value; + UINT16 reserved_95_107[13]; + UINT16 world_wide_name[4]; ///< word 108~111 + UINT16 reserved_for_128bit_wwn_112_115[4]; + UINT16 reserved_116_124[9]; + UINT16 atapi_byte_count_0_behavior; ///< word 125 + UINT16 obsolete_126; + UINT16 removable_media_status_notification_support; UINT16 security_status; - UINT16 vendor_data_129_159[31]; - UINT16 reserved_160_255[96]; -} ATA_IDENTIFY_DATA; - -// -// ATAPI_IDENTIFY_DATA is defined in ATA-6 -// -typedef struct { - UINT16 config; // General Configuration - UINT16 obsolete_1; - UINT16 specific_config; - UINT16 obsolete_3; - UINT16 retired_4_5[2]; - UINT16 obsolete_6; - UINT16 cfa_reserved_7_8[2]; - UINT16 retired_9; - CHAR8 SerialNo[20]; // ASCII - UINT16 retired_20_21[2]; - UINT16 obsolete_22; - CHAR8 FirmwareVer[8]; // ASCII - CHAR8 ModelName[40]; // ASCII - UINT16 multi_sector_cmd_max_sct_cnt; - UINT16 reserved_48; - UINT16 capabilities_49; - UINT16 capabilities_50; - UINT16 obsolete_51_52[2]; - UINT16 field_validity; - UINT16 obsolete_54_58[5]; - UINT16 mutil_sector_setting; - UINT16 user_addressable_sectors_lo; - UINT16 user_addressable_sectors_hi; - UINT16 obsolete_62; - UINT16 multi_word_dma_mode; - UINT16 advanced_pio_modes; - UINT16 min_multi_word_dma_cycle_time; - UINT16 rec_multi_word_dma_cycle_time; - UINT16 min_pio_cycle_time_without_flow_control; - UINT16 min_pio_cycle_time_with_flow_control; - UINT16 reserved_69_74[6]; - UINT16 queue_depth; - UINT16 reserved_76_79[4]; - UINT16 major_version_no; - UINT16 minor_version_no; - UINT16 cmd_set_support_82; - UINT16 cmd_set_support_83; - UINT16 cmd_feature_support; - UINT16 cmd_feature_enable_85; - UINT16 cmd_feature_enable_86; - UINT16 cmd_feature_default; - UINT16 ultra_dma_select; - UINT16 time_required_for_sec_erase; - UINT16 time_required_for_enhanced_sec_erase; - UINT16 current_advanced_power_mgmt_value; - UINT16 master_pwd_revison_code; - UINT16 hardware_reset_result; - UINT16 current_auto_acoustic_mgmt_value; - UINT16 reserved_95_99[5]; - UINT16 max_user_lba_for_48bit_addr[4]; - UINT16 reserved_104_126[23]; - UINT16 removable_media_status_notification_support; - UINT16 security_status; - UINT16 vendor_data_129_159[31]; - UINT16 cfa_power_mode; - UINT16 cfa_reserved_161_175[15]; - UINT16 current_media_serial_no[30]; - UINT16 reserved_206_254[49]; - UINT16 integrity_word; + UINT16 reserved_129_160[32]; + UINT16 cfa_reserved_161_175[15]; + UINT16 reserved_176_254[79]; + UINT16 integrity_word; } ATAPI_IDENTIFY_DATA; +/// +/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 peripheral_type; UINT8 RMB; UINT8 version; UINT8 response_data_format; - UINT8 addnl_length; - UINT8 reserved_5; - UINT8 reserved_6; - UINT8 reserved_7; - UINT8 vendor_info[8]; - UINT8 product_id[12]; - UINT8 eeprom_product_code[4]; - UINT8 firmware_rev_level[4]; - UINT8 firmware_sub_rev_level[1]; - UINT8 reserved_37; - UINT8 reserved_38; - UINT8 reserved_39; - UINT8 max_capacity_hi; - UINT8 max_capacity_mid; - UINT8 max_capacity_lo; - UINT8 reserved_43_95[95 - 43 + 1]; - // - // Some more fields - // - UINT8 vendor_id[20]; - UINT8 eeprom_drive_sno[12]; -} ATAPI_INQUIRY_DATA; - -typedef struct { - UINT8 peripheral_type; - UINT8 RMB; - UINT8 version; - UINT8 response_data_format; - UINT8 addnl_length; + UINT8 addnl_length; ///< n - 4, Numbers of bytes following this one. UINT8 reserved_5; UINT8 reserved_6; UINT8 reserved_7; UINT8 vendor_info[8]; UINT8 product_id[16]; UINT8 product_revision_level[4]; - UINT8 vendor_specific[20]; - UINT8 reserved_56_95[40]; -} ATAPI_CDROM_INQUIRY_DATA; - + UINT8 vendor_specific_36_55[55 - 36 + 1]; + UINT8 reserved_56_95[95 - 56 + 1]; + /// + /// Vendor-specific parameters fields. The sizeof (ATAPI_INQUIRY_DATA) is 254 + /// since allocation_length is one byte in ATAPI_INQUIRY_CMD. + /// + UINT8 vendor_specific_96_253[253 - 96 + 1]; +} ATAPI_INQUIRY_DATA; +/// +/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 error_code : 7; UINT8 valid : 1; UINT8 reserved_1; UINT8 sense_key : 4; - UINT8 reserved_21 : 1; - UINT8 ILI : 1; - UINT8 reserved_22 : 2; + UINT8 reserved_2 : 1; + UINT8 Vendor_specifc_1 : 3; UINT8 vendor_specific_3; UINT8 vendor_specific_4; UINT8 vendor_specific_5; UINT8 vendor_specific_6; - UINT8 addnl_sense_length; // n - 7 + UINT8 addnl_sense_length; ///< n - 7 UINT8 vendor_specific_8; UINT8 vendor_specific_9; UINT8 vendor_specific_10; UINT8 vendor_specific_11; - UINT8 addnl_sense_code; // mandatory - UINT8 addnl_sense_code_qualifier; // mandatory - UINT8 field_replaceable_unit_code; // optional - UINT8 reserved_15; - UINT8 reserved_16; - UINT8 reserved_17; - // - // Followed by additional sense bytes. - // + UINT8 addnl_sense_code; ///< mandatory + UINT8 addnl_sense_code_qualifier; ///< mandatory + UINT8 field_replaceable_unit_code; ///< optional + UINT8 sense_key_specific_15 : 7; + UINT8 SKSV : 1; + UINT8 sense_key_specific_16; + UINT8 sense_key_specific_17; } ATAPI_REQUEST_SENSE_DATA; +/// +/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 LastLba3; UINT8 LastLba2; @@ -225,6 +304,10 @@ typedef struct { UINT8 BlockSize0; } ATAPI_READ_CAPACITY_DATA; +/// +/// Capacity List Header + Current/Maximum Capacity Descriptor, +/// defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 reserved_0; UINT8 reserved_1; @@ -241,10 +324,9 @@ typedef struct { UINT8 BlockSize0; } ATAPI_READ_FORMAT_CAPACITY_DATA; -// -// ATAPI Packet Command -// - +/// +/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 opcode; UINT8 reserved_1; @@ -260,11 +342,14 @@ typedef struct { UINT8 reserved_11; } ATAPI_TEST_UNIT_READY_CMD; +/// +/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 opcode; - UINT8 reserved_1 : 4; - UINT8 lun : 4; - UINT8 page_code; + UINT8 reserved_1 : 5; + UINT8 lun : 3; + UINT8 page_code; ///< defined in SFF8090i, V6 UINT8 reserved_3; UINT8 allocation_length; UINT8 reserved_5; @@ -276,10 +361,13 @@ typedef struct { UINT8 reserved_11; } ATAPI_INQUIRY_CMD; +/// +/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 opcode; - UINT8 reserved_1 : 4; - UINT8 lun : 4; + UINT8 reserved_1 : 5; + UINT8 lun : 3; UINT8 reserved_2; UINT8 reserved_3; UINT8 allocation_length; @@ -292,6 +380,9 @@ typedef struct { UINT8 reserved_11; } ATAPI_REQUEST_SENSE_CMD; +/// +/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 opcode; UINT8 reserved_1 : 5; @@ -308,9 +399,13 @@ typedef struct { UINT8 reserved_11; } ATAPI_READ10_CMD; +/// +/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 opcode; - UINT8 reserved_1; + UINT8 reserved_1 : 5; + UINT8 lun : 3; UINT8 reserved_2; UINT8 reserved_3; UINT8 reserved_4; @@ -323,27 +418,15 @@ typedef struct { UINT8 reserved_11; } ATAPI_READ_FORMAT_CAP_CMD; -typedef struct { - UINT8 peripheral_type; - UINT8 RMB; - UINT8 version; - UINT8 response_data_format; - UINT8 addnl_length; - UINT8 reserved_5; - UINT8 reserved_6; - UINT8 reserved_7; - UINT8 vendor_info[8]; - UINT8 product_id[12]; - UINT8 eeprom_product_code[4]; - UINT8 firmware_rev_level[4]; -} ATAPI_USB_INQUIRY_DATA; - +/// +/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification). +/// typedef struct { UINT8 opcode; - UINT8 reserved_1 : 4; - UINT8 lun : 4; - UINT8 page_code : 4; - UINT8 page_control : 4; + UINT8 reserved_1 : 5; + UINT8 lun : 3; + UINT8 page_code : 6; + UINT8 page_control : 2; UINT8 reserved_3; UINT8 reserved_4; UINT8 reserved_5; @@ -355,10 +438,10 @@ typedef struct { UINT8 reserved_11; } ATAPI_MODE_SENSE_CMD; -// -// ATAPI_PACKET_COMMAND is not defined in ATA specification. -// We add it here for the convenience for ATA/ATAPI module writer. -// +/// +/// ATAPI_PACKET_COMMAND is not defined in the ATA specification. +/// We add it here for the convenience of ATA/ATAPI module writers. +/// typedef union { UINT16 Data16[6]; ATAPI_TEST_UNIT_READY_CMD TestUnitReady; @@ -378,17 +461,29 @@ typedef union { // // ATA Packet Command Code // -#define ATA_CMD_SOFT_RESET 0x08 -#define ATA_CMD_PACKET 0xA0 -#define ATA_CMD_IDENTIFY_DEVICE 0xA1 -#define ATA_CMD_SERVICE 0xA2 -#define ATA_CMD_TEST_UNIT_READY 0x00 -#define ATA_CMD_REQUEST_SENSE 0x03 -#define ATA_CMD_INQUIRY 0x12 -#define ATA_CMD_READ_FORMAT_CAPACITY 0x23 -#define ATA_CMD_READ_CAPACITY 0x25 -#define ATA_CMD_READ_10 0x28 -#define ATA_CMD_WRITE_10 0x2A +#define ATA_CMD_SOFT_RESET 0x08 ///< defined from ATA-3 +#define ATA_CMD_PACKET 0xA0 ///< defined from ATA-3 +#define ATA_CMD_IDENTIFY_DEVICE 0xA1 ///< defined from ATA-3 +#define ATA_CMD_SERVICE 0xA2 ///< defined from ATA-3 +#define ATA_CMD_TEST_UNIT_READY 0x00 ///< defined from ATA-1 +#define ATA_CMD_REQUEST_SENSE 0x03 ///< defined from ATA-4 +#define ATA_CMD_INQUIRY 0x12 ///< defined in ATAPI Removable Rewritable Media Devcies +#define ATA_CMD_READ_FORMAT_CAPACITY 0x23 ///< defined in ATAPI Removable Rewritable Media Devcies +#define ATA_CMD_READ_CAPACITY 0x25 ///< defined in ATAPI Removable Rewritable Media Devcies +#define ATA_CMD_READ_10 0x28 ///< defined in ATAPI Removable Rewritable Media Devcies +#define ATA_CMD_WRITE_10 0x2A ///< defined in ATAPI Removable Rewritable Media Devcies +#define ATA_CMD_READ_12 0xA8 ///< defined in ATAPI Removable Rewritable Media Devcies +#define ATA_CMD_WRITE_12 0xAA ///< defined in ATAPI Removable Rewritable Media Devcies +#define ATA_CMD_START_STOP_UNIT 0x1B ///< defined in ATAPI Removable Rewritable Media Devcies +/// +/// Start/Stop and Eject Operations +/// +///@{ +#define ATA_CMD_SUBOP_STOP_DISC 0x00 ///< Stop the Disc +#define ATA_CMD_SUBOP_START_DISC 0x01 ///< Start the Disc and acquire the format type +#define ATA_CMD_SUBOP_EJECT_DISC 0x02 ///< Eject the Disc if possible +#define ATA_CMD_SUBOP_CLOSE_TRAY 0x03 ///< Load the Disc (Close Tray) +///@} // // ATA Commands Code @@ -397,94 +492,93 @@ typedef union { // // Class 1: PIO Data-In Commands // -#define ATA_CMD_IDENTIFY_DRIVE 0xec -#define ATA_CMD_READ_BUFFER 0xe4 -#define ATA_CMD_READ_SECTORS 0x20 -#define ATA_CMD_READ_SECTORS_WITH_RETRY 0x21 -#define ATA_CMD_READ_LONG 0x22 -#define ATA_CMD_READ_LONG_WITH_RETRY 0x23 -// -// Atapi6 enhanced commands -// -#define ATA_CMD_READ_SECTORS_EXT 0x24 - +#define ATA_CMD_IDENTIFY_DRIVE 0xec ///< defined from ATA-3 +#define ATA_CMD_READ_BUFFER 0xe4 ///< defined from ATA-1 +#define ATA_CMD_READ_SECTORS 0x20 ///< defined from ATA-1 +#define ATA_CMD_READ_SECTORS_WITH_RETRY 0x21 ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_READ_LONG 0x22 ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_READ_LONG_WITH_RETRY 0x23 ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_READ_SECTORS_EXT 0x24 ///< defined from ATA-6 // // Class 2: PIO Data-Out Commands // -#define ATA_CMD_FORMAT_TRACK 0x50 -#define ATA_CMD_WRITE_BUFFER 0xe8 -#define ATA_CMD_WRITE_SECTORS 0x30 -#define ATA_CMD_WRITE_SECTORS_WITH_RETRY 0x31 -#define ATA_CMD_WRITE_LONG 0x32 -#define ATA_CMD_WRITE_LONG_WITH_RETRY 0x33 -#define ATA_CMD_WRITE_VERIFY 0x3c -// -// Class 2 - Atapi6 enhanced commands -// -#define ATA_CMD_WRITE_SECTORS_EXT 0x34 +#define ATA_CMD_FORMAT_TRACK 0x50 ///< defined from ATA-1, obsoleted from ATA-4 +#define ATA_CMD_WRITE_BUFFER 0xe8 ///< defined from ATA-1 +#define ATA_CMD_WRITE_SECTORS 0x30 ///< defined from ATA-1 +#define ATA_CMD_WRITE_SECTORS_WITH_RETRY 0x31 ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_WRITE_LONG 0x32 ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_WRITE_LONG_WITH_RETRY 0x33 ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_WRITE_VERIFY 0x3c ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_WRITE_SECTORS_EXT 0x34 ///< defined from ATA-6 // // Class 3 No Data Command // -#define ATA_CMD_ACK_MEDIA_CHANGE 0xdb -#define ATA_CMD_BOOT_POST_BOOT 0xdc -#define ATA_CMD_BOOT_PRE_BOOT 0xdd -#define ATA_CMD_CHECK_POWER_MODE 0x98 -#define ATA_CMD_CHECK_POWER_MODE_ALIAS 0xe5 -#define ATA_CMD_DOOR_LOCK 0xde -#define ATA_CMD_DOOR_UNLOCK 0xdf -#define ATA_CMD_EXEC_DRIVE_DIAG 0x90 -#define ATA_CMD_IDLE_ALIAS 0x97 -#define ATA_CMD_IDLE 0xe3 -#define ATA_CMD_IDLE_IMMEDIATE 0x95 -#define ATA_CMD_IDLE_IMMEDIATE_ALIAS 0xe1 -#define ATA_CMD_INIT_DRIVE_PARAM 0x91 -#define ATA_CMD_RECALIBRATE 0x10 /* aliased to 1x */ -#define ATA_CMD_READ_DRIVE_STATE 0xe9 -#define ATA_CMD_SET_MULTIPLE_MODE 0xC6 -#define ATA_CMD_READ_VERIFY 0x40 -#define ATA_CMD_READ_VERIFY_WITH_RETRY 0x41 -#define ATA_CMD_SEEK 0x70 /* aliased to 7x */ -#define ATA_CMD_SET_FEATURES 0xef -#define ATA_CMD_STANDBY 0x96 -#define ATA_CMD_STANDBY_ALIAS 0xe2 -#define ATA_CMD_STANDBY_IMMEDIATE 0x94 -#define ATA_CMD_STANDBY_IMMEDIATE_ALIAS 0xe0 +#define ATA_CMD_ACK_MEDIA_CHANGE 0xdb ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_BOOT_POST_BOOT 0xdc ///< defined from ATA-1, obsoleted from ATA-3 +#define ATA_CMD_BOOT_PRE_BOOT 0xdd ///< defined from ATA-1, obsoleted from ATA-3 +#define ATA_CMD_CHECK_POWER_MODE 0x98 ///< defined from ATA-1, obsoleted from ATA-4 +#define ATA_CMD_CHECK_POWER_MODE_ALIAS 0xe5 ///< defined from ATA-1 +#define ATA_CMD_DOOR_LOCK 0xde ///< defined from ATA-1 +#define ATA_CMD_DOOR_UNLOCK 0xdf ///< defined from ATA-1 +#define ATA_CMD_EXEC_DRIVE_DIAG 0x90 ///< defined from ATA-1 +#define ATA_CMD_IDLE_ALIAS 0x97 ///< defined from ATA-1, obsoleted from ATA-4 +#define ATA_CMD_IDLE 0xe3 ///< defined from ATA-1 +#define ATA_CMD_IDLE_IMMEDIATE 0x95 ///< defined from ATA-1, obsoleted from ATA-4 +#define ATA_CMD_IDLE_IMMEDIATE_ALIAS 0xe1 ///< defined from ATA-1 +#define ATA_CMD_INIT_DRIVE_PARAM 0x91 ///< defined from ATA-1, obsoleted from ATA-6 +#define ATA_CMD_RECALIBRATE 0x10 ///< defined from ATA-1, obsoleted from ATA-4 +#define ATA_CMD_READ_DRIVE_STATE 0xe9 ///< defined from ATA-1, obsoleted from ATA-3 +#define ATA_CMD_SET_MULTIPLE_MODE 0xC6 ///< defined from ATA-2 +#define ATA_CMD_READ_VERIFY 0x40 ///< defined from ATA-1 +#define ATA_CMD_READ_VERIFY_WITH_RETRY 0x41 ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_SEEK 0x70 ///< defined from ATA-1 +#define ATA_CMD_SET_FEATURES 0xef ///< defined from ATA-1 +#define ATA_CMD_STANDBY 0x96 ///< defined from ATA-1, obsoleted from ATA-4 +#define ATA_CMD_STANDBY_ALIAS 0xe2 ///< defined from ATA-1 +#define ATA_CMD_STANDBY_IMMEDIATE 0x94 ///< defined from ATA-1, obsoleted from ATA-4 +#define ATA_CMD_STANDBY_IMMEDIATE_ALIAS 0xe0 ///< defined from ATA-1 // // S.M.A.R.T // -#define ATA_CMD_SMART 0xb0 -#define ATA_CONSTANT_C2 0xc2 -#define ATA_CONSTANT_4F 0x4f -#define ATA_SMART_ENABLE_OPERATION 0xd8 -#define ATA_SMART_RETURN_STATUS 0xda - +#define ATA_CMD_SMART 0xb0 ///< defined from ATA-3 +#define ATA_CONSTANT_C2 0xc2 ///< reserved +#define ATA_CONSTANT_4F 0x4f ///< reserved +#define ATA_SMART_ENABLE_OPERATION 0xd8 ///< reserved +#define ATA_SMART_RETURN_STATUS 0xda ///< defined from ATA-3 // // Class 4: DMA Command // -#define ATA_CMD_READ_DMA 0xc8 -#define ATA_CMD_READ_DMA_WITH_RETRY 0xc9 -#define ATA_CMD_READ_DMA_EXT 0x25 -#define ATA_CMD_WRITE_DMA 0xca -#define ATA_CMD_WRITE_DMA_WITH_RETRY 0xcb -#define ATA_CMD_WRITE_DMA_EXT 0x35 - - - -// -// default content of device control register, disable INT -// -#define ATA_DEFAULT_CTL (0x0a) // default content of device control register, disable INT +#define ATA_CMD_READ_DMA 0xc8 ///< defined from ATA-1 +#define ATA_CMD_READ_DMA_WITH_RETRY 0xc9 ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_READ_DMA_EXT 0x25 ///< defined from ATA-6 +#define ATA_CMD_WRITE_DMA 0xca ///< defined from ATA-1 +#define ATA_CMD_WRITE_DMA_WITH_RETRY 0xcb ///< defined from ATA-1, obsoleted from ATA- +#define ATA_CMD_WRITE_DMA_EXT 0x35 ///< defined from ATA-6 + +/// +/// Default content of device control register, disable INT, +/// Bit3 is set to 1 according ATA-1 +/// +#define ATA_DEFAULT_CTL (0x0a) +/// +/// Default context of Device/Head Register, +/// Bit7 and Bit5 are set to 1 for back-compatibilities. +/// #define ATA_DEFAULT_CMD (0xa0) #define ATAPI_MAX_BYTE_COUNT (0xfffe) +#define ATA_REQUEST_SENSE_ERROR (0x70) ///< defined in SFF-8070i + +// +// Sense Key, Additional Sense Codes and Additional Sense Code Qualifier +// defined in MultiMedia Commands (MMC, MMC-2) // -// Sense Key +// Sense Key // -#define ATA_REQUEST_SENSE_ERROR (0x70) #define ATA_SK_NO_SENSE (0x0) #define ATA_SK_RECOVERY_ERROR (0x1) #define ATA_SK_NOT_READY (0x2) @@ -516,7 +610,7 @@ typedef union { #define ATA_ASC_INVALID_FIELD (0x24) #define ATA_ASC_WRITE_PROTECTED (0x27) #define ATA_ASC_MEDIA_CHANGE (0x28) -#define ATA_ASC_RESET (0x29) /* Power On Reset or Bus Reset occurred */ +#define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred. #define ATA_ASC_ILLEGAL_FIELD (0x26) #define ATA_ASC_NO_MEDIA (0x3A) #define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64) @@ -527,34 +621,35 @@ typedef union { #define ATA_ASCQ_IN_PROGRESS (0x01) // -// Err Reg +// Error Register // -#define ATA_ERRREG_BBK BIT7 /* Bad block detected */ -#define ATA_ERRREG_UNC BIT6 /* Uncorrectable Data */ -#define ATA_ERRREG_MC BIT5 /* Media Change */ -#define ATA_ERRREG_IDNF BIT4 /* ID Not Found */ -#define ATA_ERRREG_MCR BIT3 /* Media Change Requested */ -#define ATA_ERRREG_ABRT BIT2 /* Aborted Command */ -#define ATA_ERRREG_TK0NF BIT1 /* Track 0 Not Found */ -#define ATA_ERRREG_AMNF BIT0 /* Address Mark Not Found */ +#define ATA_ERRREG_BBK BIT7 ///< Bad block detected defined from ATA-1, obsoleted from ATA-2 +#define ATA_ERRREG_UNC BIT6 ///< Uncorrectable Data defined from ATA-1, obsoleted from ATA-4 +#define ATA_ERRREG_MC BIT5 ///< Media Change defined from ATA-1, obsoleted from ATA-4 +#define ATA_ERRREG_IDNF BIT4 ///< ID Not Found defined from ATA-1, obsoleted from ATA-4 +#define ATA_ERRREG_MCR BIT3 ///< Media Change Requested defined from ATA-1, obsoleted from ATA-4 +#define ATA_ERRREG_ABRT BIT2 ///< Aborted Command defined from ATA-1 +#define ATA_ERRREG_TK0NF BIT1 ///< Track 0 Not Found defined from ATA-1, obsoleted from ATA-4 +#define ATA_ERRREG_AMNF BIT0 ///< Address Mark Not Found defined from ATA-1, obsoleted from ATA-4 // -// Status Reg +// Status Register // -#define ATA_STSREG_BSY BIT7 /* Controller Busy */ -#define ATA_STSREG_DRDY BIT6 /* Drive Ready */ -#define ATA_STSREG_DWF BIT5 /* Drive Write Fault */ -#define ATA_STSREG_DSC BIT4 /* Disk Seek Complete */ -#define ATA_STSREG_DRQ BIT3 /* Data Request */ -#define ATA_STSREG_CORR BIT2 /* Corrected Data */ -#define ATA_STSREG_IDX BIT1 /* Index */ -#define ATA_STSREG_ERR BIT0 /* Error */ +#define ATA_STSREG_BSY BIT7 ///< Controller Busy defined from ATA-1 +#define ATA_STSREG_DRDY BIT6 ///< Drive Ready defined from ATA-1 +#define ATA_STSREG_DWF BIT5 ///< Drive Write Fault defined from ATA-1, obsoleted from ATA-4 +#define ATA_STSREG_DF BIT5 ///< Drive Fault defined from ATA-6 +#define ATA_STSREG_DSC BIT4 ///< Disk Seek Complete defined from ATA-1, obsoleted from ATA-4 +#define ATA_STSREG_DRQ BIT3 ///< Data Request defined from ATA-1 +#define ATA_STSREG_CORR BIT2 ///< Corrected Data defined from ATA-1, obsoleted from ATA-4 +#define ATA_STSREG_IDX BIT1 ///< Index defined from ATA-1, obsoleted from ATA-4 +#define ATA_STSREG_ERR BIT0 ///< Error defined from ATA-1 // -// Device Control Reg +// Device Control Register // -#define ATA_CTLREG_SRST BIT2 /* Software Reset */ -#define ATA_CTLREG_IEN_L BIT1 /* Interrupt Enable #*/ +#define ATA_CTLREG_SRST BIT2 ///< Software Reset. +#define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #. #endif