update the function header comment to comply with PI1.2 volume 5

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / IdeBusDxe / IdeBus.c

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
index bf094c0ffbf37d9181cd87080cbcbed1554b4d47..224b2cac8dc0c7cd59d53782efe44887ad3860ad 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
@@ -1247,17 +1247,17 @@ IDEBlkIoFlushBlocks (
 }\r
 \r
 /**\r
-  Return the results of the Inquiry command to a drive in InquiryData.\r
-  Data format of Inquiry data is defined by the Interface GUID.\r
+  This function is used by the IDE bus driver to get inquiry data. \r
+  Data format of Identify data is defined by the Interface GUID.\r
 \r
-  @param  This Protocol   Instance pointer.\r
-  @param  InquiryData     Results of Inquiry command to device\r
-  @param  InquiryDataSize Size of InquiryData in bytes.\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
+  @param  InquiryData           Pointer to a buffer for the inquiry data.\r
+  @param  InquiryDataSize       Pointer to the value for the inquiry data size.\r
 \r
-  @retval  EFI_SUCCESS          InquiryData valid\r
-  @retval  EFI_NOT_FOUND        Device does not support this data class\r
-  @retval  EFI_DEVICE_ERROR     Error reading InquiryData from device\r
-  @retval  EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough\r
+  @retval EFI_SUCCESS           The command was accepted without any errors.\r
+  @retval EFI_NOT_FOUND         Device does not support this data class \r
+  @retval EFI_DEVICE_ERROR      Error reading InquiryData from device \r
+  @retval EFI_BUFFER_TOO_SMALL  IntquiryDataSize not big enough \r
 \r
 **/\r
 EFI_STATUS\r
@@ -1288,17 +1288,17 @@ IDEDiskInfoInquiry (
 }\r
 \r
 /**\r
-  Return the results of the Identify command to a drive in IdentifyData.\r
+  This function is used by the IDE bus driver to get identify data. \r
   Data format of Identify data is defined by the Interface GUID.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  IdentifyData Results of Identify command to device\r
-  @param  IdentifyDataSize Size of IdentifyData in bytes.\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
+  @param  IdentifyData          Pointer to a buffer for the identify data.\r
+  @param  IdentifyDataSize      Pointer to the value for the identify data size.\r
 \r
-  @retval  EFI_SUCCESS IdentifyData valid\r
-  @retval  EFI_NOT_FOUND Device does not support this data class\r
-  @retval  EFI_DEVICE_ERROR Error reading IdentifyData from device\r
-  @retval  EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough\r
+  @retval EFI_SUCCESS           The command was accepted without any errors.\r
+  @retval EFI_NOT_FOUND         Device does not support this data class \r
+  @retval EFI_DEVICE_ERROR      Error reading IdentifyData from device \r
+  @retval EFI_BUFFER_TOO_SMALL  IdentifyDataSize not big enough \r
 \r
 **/\r
 EFI_STATUS\r
@@ -1329,18 +1329,18 @@ IDEDiskInfoIdentify (
 }\r
 \r
 /**\r
-  Return the results of the Request Sense command to a drive in SenseData.\r
+  This function is used by the IDE bus driver to get sense data. \r
   Data format of Sense data is defined by the Interface GUID.\r
 \r
-  @param  This            Protocol instance pointer.\r
-  @param  SenseData       Results of Request Sense command to device\r
-  @param  SenseDataSize   Size of SenseData in bytes.\r
-  @param  SenseDataNumber Type of SenseData\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
+  @param  SenseData             Pointer to the SenseData. \r
+  @param  SenseDataSize         Size of SenseData in bytes. \r
+  @param  SenseDataNumber       Pointer to the value for the identify data size.\r
 \r
-  @retval  EFI_SUCCESS          InquiryData valid\r
-  @retval  EFI_NOT_FOUND        Device does not support this data class\r
-  @retval  EFI_DEVICE_ERROR     Error reading InquiryData from device\r
-  @retval  EFI_BUFFER_TOO_SMALL SenseDataSize not big enough\r
+  @retval EFI_SUCCESS           The command was accepted without any errors.\r
+  @retval EFI_NOT_FOUND         Device does not support this data class \r
+  @retval EFI_DEVICE_ERROR      Error reading InquiryData from device \r
+  @retval EFI_BUFFER_TOO_SMALL  SenseDataSize not big enough \r
 \r
 **/\r
 EFI_STATUS\r
@@ -1356,15 +1356,14 @@ IDEDiskInfoSenseData (
 }\r
 \r
 /**\r
-  Return the results of the Request Sense command to a drive in SenseData.\r
-  Data format of Sense data is defined by the Interface GUID.\r
+  This function is used by the IDE bus driver to get controller information.\r
 \r
-  @param  This       Protocol instance pointer.\r
-  @param  IdeChannel Primary or Secondary\r
-  @param  IdeDevice  Master or Slave\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
+  @param  IdeChannel            Pointer to the Ide Channel number. Primary or secondary.\r
+  @param  IdeDevice             Pointer to the Ide Device number. Master or slave.\r
 \r
-  @retval  EFI_SUCCESS     IdeChannel and IdeDevice are valid\r
-  @retval  EFI_UNSUPPORTED This is not an IDE device\r
+  @retval EFI_SUCCESS           IdeChannel and IdeDevice are valid \r
+  @retval EFI_UNSUPPORTED       This is not an IDE device \r
 \r
 **/\r
 EFI_STATUS\r