\r
A device handle for an IDE controller must contain an EFI_DEVICE_PATH_PROTOCOL.\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
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2007 - 2010, 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
@par Revision Reference:\r
This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r
- Volume 5: Standards\r
+ Volume 5: Standards.\r
\r
**/\r
\r
#ifndef _EFI_IDE_CONTROLLER_INIT_PROTOCOL_H_\r
#define _EFI_IDE_CONTROLLER_INIT_PROTOCOL_H_\r
\r
+#include <IndustryStandard/Atapi.h>\r
+\r
///\r
-/// Global ID for the EFI_IDE_CONTROLLER_INIT_PROTOCOL\r
+/// Global ID for the EFI_IDE_CONTROLLER_INIT_PROTOCOL.\r
///\r
#define EFI_IDE_CONTROLLER_INIT_PROTOCOL_GUID \\r
{ \\r
}\r
\r
///\r
-/// Forward declaration for EFI_IDE_CONTROLLER_INIT_PROTOCOL\r
+/// Forward declaration for EFI_IDE_CONTROLLER_INIT_PROTOCOL.\r
///\r
typedef struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL EFI_IDE_CONTROLLER_INIT_PROTOCOL;\r
\r
///\r
-/// The phase of the IDE Controller enumeration\r
+/// The phase of the IDE Controller enumeration.\r
///\r
typedef enum {\r
///\r
#define EFI_SATA_GEN2_SPEED 2\r
\r
///\r
-/// EFI_ATA_MODE structure\r
+/// EFI_ATA_MODE structure.\r
///\r
typedef struct {\r
BOOLEAN Valid; ///< TRUE if Mode is valid.\r
} EFI_ATA_EXTENDED_MODE;\r
\r
///\r
-/// EFI_ATA_COLLECTIVE_MODE structure\r
+/// EFI_ATA_COLLECTIVE_MODE structure.\r
///\r
typedef struct {\r
///\r
///\r
/// This field specifies the single word DMA mode. Single word DMA modes are defined\r
/// in the ATA/ATAPI specification, versions 1 and 2. Single word DMA support was\r
- /// obsoleted in the ATA/ATAPI specification, version 3; therefore, most devices and\r
+ /// obsoleted in the ATA/ATAPI specification, version 3. Therefore, most devices and\r
/// controllers will not support this transfer mode. The ATA/ATAPI specification defines\r
/// the enumeration. In other words, a value of 1 in this field means single word DMA\r
/// mode 1. The actual meaning of single word DMA mode 1 is governed by the ATA/\r
} EFI_ATA_COLLECTIVE_MODE;\r
\r
///\r
-/// EFI_ATA_IDENTIFY_DATA structure\r
+/// EFI_ATA_IDENTIFY_DATA & EFI_ATAPI_IDENTIFY_DATA structure\r
///\r
-/// This structure definition is not part of the protocol\r
-/// definition because the ATA/ATAPI Specification controls\r
-/// the definition of all the fields. The ATA/ATAPI\r
-/// Specification can obsolete old fields or redefine existing\r
-/// fields. This definition is provided here for reference only.\r
-///\r
-#pragma pack(1)\r
-typedef struct {\r
- UINT16 config; ///< General Configuration\r
- UINT16 cylinders; ///< Number of Cylinders\r
- UINT16 reserved_2;\r
- UINT16 heads; ///< Number of logical heads\r
- UINT16 vendor_data1;\r
- UINT16 vendor_data2;\r
- UINT16 sectors_per_track;\r
- UINT16 vendor_specific_7_9[3];\r
- CHAR8 SerialNo[20]; ///< ASCII\r
- UINT16 vendor_specific_20_21[2];\r
- UINT16 ecc_bytes_available;\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;\r
- UINT16 reserved_50;\r
- UINT16 pio_cycle_timing;\r
- UINT16 reserved_52;\r
- UINT16 field_validity;\r
- UINT16 current_cylinders;\r
- UINT16 current_heads;\r
- UINT16 current_sectors;\r
- UINT16 CurrentCapacityLsb;\r
- UINT16 CurrentCapacityMsb;\r
- UINT16 reserved_59;\r
- UINT16 user_addressable_sectors_lo;\r
- UINT16 user_addressable_sectors_hi;\r
- UINT16 reserved_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_79[11];\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 reserved_89_105[17];\r
- UINT16 phy_logic_sector_support; ///< word 106\r
- UINT16 reserved_107_116[10];\r
- UINT16 logic_sector_size_lo; ///< word 117\r
- UINT16 logic_sector_size_hi; ///< word 118\r
- UINT16 reserved_119_127[9];\r
- UINT16 security_status;\r
- UINT16 vendor_data_129_159[31];\r
- UINT16 reserved_160_208[49];\r
- UINT16 alignment_logic_in_phy_blocks; ///< word 209\r
- UINT16 reserved_210_255[46];\r
-} EFI_ATA_IDENTIFY_DATA;\r
-#pragma pack()\r
-\r
-///\r
-/// EFI_ATAPI_IDENTIFY_DATA structure\r
-///\r
-/// This structure definition is not part of the protocol\r
-/// definition because the ATA/ATAPI Specification controls\r
-/// the definition of all the fields. The ATA/ATAPI\r
-/// Specification can obsolete old fields or redefine existing\r
-/// fields. This definition is provided here for reference only.\r
-///\r
-#pragma pack(1)\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
-} EFI_ATAPI_IDENTIFY_DATA;\r
-#pragma pack()\r
+/// The definition of these two structures is not part of the protocol\r
+/// definition because the ATA/ATAPI Specification controls the definition\r
+/// of all the fields. The ATA/ATAPI Specification can obsolete old fields\r
+/// or redefine existing fields. \r
+typedef ATA_IDENTIFY_DATA EFI_ATA_IDENTIFY_DATA;\r
+typedef ATAPI_IDENTIFY_DATA EFI_ATAPI_IDENTIFY_DATA;\r
\r
///\r
/// This flag indicates whether the IDENTIFY data is a response from an ATA device\r
#define EFI_ATAPI_DEVICE_IDENTIFY_DATA 0x8000\r
\r
///\r
-/// EFI_IDENTIFY_DATA structure\r
+/// EFI_IDENTIFY_DATA structure.\r
///\r
typedef union {\r
///\r
For most of today's controllers, MaxDevices will either be 1 or 2. For SATA \r
controllers, this value will always be 1. SATA configurations can contain SATA \r
port multipliers. SATA port multipliers behave like SATA bridges and can support\r
- up to 16 devices on the other side. If an SATA port out of the IDE controller \r
+ up to 16 devices on the other side. If a SATA port out of the IDE controller \r
is connected to a port multiplier, MaxDevices will be set to the number of SATA \r
devices that the port multiplier supports. Because today's port multipliers \r
- support up to 15 SATA devices, this number can be as large as 15. The IDE bus \r
- driver is required to scan for the presence of port multipliers behind an SATA \r
+ support up to fifteen SATA devices, this number can be as large as fifteen. The IDE \r
+ bus driver is required to scan for the presence of port multipliers behind an SATA \r
controller and enumerate up to MaxDevices number of devices behind the port \r
multiplier. \r
\r
In this context, the devices behind a port multiplier constitute a channel. \r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Channel Zero-based channel number.\r
@param[out] Enabled TRUE if this channel is enabled. Disabled channels \r
are not scanned to see if any devices are present.\r
@param[out] MaxDevices The maximum number of IDE devices that the bus driver\r
can expect on this channel. For the ATA/ATAPI \r
specification, version 6, this number will either be \r
- 1 or 2. For Serial ATA (SATA) configurations with a \r
- port multiplier, this number can be as large as 15.\r
+ one or two. For Serial ATA (SATA) configurations with a \r
+ port multiplier, this number can be as large as fifteen.\r
\r
@retval EFI_SUCCESS Information was returned without any errors.\r
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
\r
More synchronization points may be added as required in the future. \r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Phase The phase during enumeration.\r
@param[in] Channel Zero-based channel number.\r
\r
EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a \r
given (Channel, Device) pair. \r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Channel Zero-based channel number.\r
@param[in] Device Zero-based device number on the Channel.\r
@param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command.\r
may inform the IDE controller driver to not use second-generation (Gen2) speeds \r
for a certain SATA drive.\r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel Zero-based channel number.\r
- @param[in] Device Zero-based device number on the Channel.\r
+ @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] Channel The zero-based channel number.\r
+ @param[in] Device The zero-based device number on the Channel.\r
@param[in] BadModes The modes that the device does not support and that\r
should be disqualified.\r
\r
\r
The IDE bus driver may collect timing information for various devices in any \r
order. The IDE bus driver is responsible for making sure that all the dependencies\r
- are satisfied; for example, the SupportedModes information for device A that \r
+ are satisfied. For example, the SupportedModes information for device A that \r
was previously returned may become stale after a call to \r
EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.\r
\r
also allow the IDE bus driver to stay with the speed that has been negotiated \r
by the physical layer.\r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel Zero-based channel number.\r
- @param[in] Device Zero-based device number on the Channel.\r
+ @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] Channel A zero-based channel number.\r
+ @param[in] Device A zero-based device number on the Channel.\r
@param[out] SupportedModes The optimum modes for the device.\r
\r
@retval EFI_SUCCESS SupportedModes was returned.\r
\r
///\r
/// Set to TRUE if the enumeration group includes all the channels that are\r
- /// produced by this controller. FALSE if an enumeration group consists of\r
+ /// produced by this controller. Set to FALSE if an enumeration group consists of\r
/// only one channel. \r
///\r
BOOLEAN EnumAll;\r
/// (PATA) controllers can support up to two channels. Advanced Host Controller \r
/// Interface (AHCI) Serial ATA (SATA) controllers can support up to 32 channels,\r
/// each of which can have up to one device. In the presence of a multiplier, \r
- /// each channel can have 15 devices.\r
+ /// each channel can have fifteen devices.\r
///\r
UINT8 ChannelCount;\r
};\r
projects / mirror_edk2.git / blobdiff